Cleaning up examples

Names and redundant versions

Author: makin-stuff

examples/Example1_PrintButtonStatus/Example1_PrintButtonStatus.ino

@@ -1,50 +1,43 @@
 /******************************************************************************
-Checks whether the button is pressed, and then prints its status over serial!
+  Checks whether the button is pressed, and then prints its status over serial!
 
-Fischer Moseley @ SparkFun Electronics
-Original Creation Date: June 28, 2019
+  Fischer Moseley @ SparkFun Electronics
+  Original Creation Date: June 28, 2019
 
-This code is Lemonadeware; if you see me (or any other SparkFun employee) at the
-local, and you've found our code helpful, please buy us a round!
+  This code is Lemonadeware; if you see me (or any other SparkFun employee) at the
+  local, and you've found our code helpful, please buy us a round!
 
-Hardware Connections:
-Attach the Qwiic Shield to your Arduino/Photon/ESP32 or other
-Plug the button into the shield
-Print it to the serial monitor at 115200 baud.
+  Hardware Connections:
+  Attach the Qwiic Shield to your Arduino/Photon/ESP32 or other
+  Plug the button into the shield
+  Print it to the serial monitor at 115200 baud.
 
-Distributed as-is; no warranty is given.
+  Distributed as-is; no warranty is given.
 ******************************************************************************/
 
 #include <SparkFun_Qwiic_Button.h>
 QwiicButton button;
 
-void setup(){
-    Serial.begin(115200);
-    Wire.begin(); //Join I2C bus
-    Wire.setClock(400000); //Set I2C clock speed to 400kHz
-    button.begin(DEFAULT_BUTTON_ADDRESS); // Initialize our button! Set to DEFAULT_SWITCH_ADDRESS if you're using a
-                                          // switch, or whatever the I2C address of your device is
-
-    //check if button will acknowledge over I2C
-    if(button.isConnected()){
-        Serial.println("Device will acknowledge!");
-    }
-
-    else {
-        Serial.println("Device did not acknowledge! Freezing.");
-        while(1);
-    }
+void setup() {
+  Serial.begin(115200);
+  Serial.println("Qwiic button examples");
+  Wire.begin(); //Join I2C bus
+
+  //check if button will acknowledge over I2C
+  if (button.begin() == false) {
+    Serial.println("Device did not acknowledge! Freezing.");
+    while (1);
+  }
+  Serial.println("Button acknowledged.");
 }
 
-void loop(){
-    //check if button is pressed, and tell us if it is!
-    if(button.isPressed()){
-        Serial.println("The button is pressed!");
-    }
-
-    else {
-        Serial.println("The button is not pressed.");
-    }
-    
-    delay(20); //Don't hammer too hard on the I2C bus
-}
+void loop() {
+  //check if button is pressed, and tell us if it is!
+  if (button.isPressed() == true) {
+    Serial.println("The button is pressed!");
+    while (button.isPressed() == true)
+      delay(10);  //wait for user to stop pressing
+    Serial.println("The button is not pressed!");
+  }
+  delay(20); //Don't hammer too hard on the I2C bus
+}

examples/Example1_PrintButtonStatus_newFirmware/Example1_PrintButtonStatus_newFirmware.ino

@@ -1,55 +1,50 @@
 /******************************************************************************
-Turns on the Button's built in LED when pressed, and prints status over Serial!
+  Turns on the Button's built in LED when pressed, and prints status over Serial!
 
-Fischer Moseley @ SparkFun Electronics
-Original Creation Date: July 24, 2019
+  Fischer Moseley @ SparkFun Electronics
+  Original Creation Date: July 24, 2019
 
-This code is Lemonadeware; if you see me (or any other SparkFun employee) at the
-local, and you've found our code helpful, please buy us a round!
+  This code is Lemonadeware; if you see me (or any other SparkFun employee) at the
+  local, and you've found our code helpful, please buy us a round!
 
-Hardware Connections:
-Attach the Qwiic Shield to your Arduino/Photon/ESP32 or other
-Plug the button into the shield
-Print it to the serial monitor at 115200 baud.
+  Hardware Connections:
+  Attach the Qwiic Shield to your Arduino/Photon/ESP32 or other
+  Plug the button into the shield
+  Print it to the serial monitor at 115200 baud.
 
-Distributed as-is; no warranty is given.
+  Distributed as-is; no warranty is given.
 ******************************************************************************/
 
 #include <SparkFun_Qwiic_Button.h>
 QwiicButton button;
 uint8_t brightness = 100;   //The brightness to set the LED to when the button is pushed
                             //Can be any value between 0 (off) and 255 (max)
 
-void setup(){
-    Serial.begin(115200);
-    Wire.begin(); //Join I2C bus
-    Wire.setClock(400000); //Set the I2C clock speed to 400kHz
-    button.begin(DEFAULT_BUTTON_ADDRESS); // Initialize our button! Set to DEFAULT_SWITCH_ADDRESS if you're using a
-                                          // switch, or whatever the I2C address of your device is
+void setup() {
+  Serial.begin(115200);
+  Serial.println("Qwiic button examples");
+  Wire.begin(); //Join I2C bus
 
-    //check if button will acknowledge over I2C
-    if(button.isConnected()){
-        Serial.println("Device will acknowledge!");
-    }
+  //check if button will acknowledge over I2C
+  if (button.begin() == false) {
+    Serial.println("Device did not acknowledge! Freezing.");
+    while (1);
+  }
+  Serial.println("Button acknowledged.");
 
-    else {
-        Serial.println("Device did not acknowledge! Freezing.");
-        while(1);
-    }
+  //Start with the LED off
+  button.LEDoff();
+}
 
+void loop() {
+  //check if button is pressed, and tell us if it is!
+  if (button.isPressed() == true) {
+    Serial.println("The button is pressed!");
+    button.LEDon(brightness);
+    while(button.isPressed() == true)
+      delay(10);  //wait for user to stop pressing
+    Serial.println("The button is not pressed.");
     button.LEDoff();
+  }
+  delay(20); //Don't hammer too hard on the I2C bus
 }
-
-void loop(){
-    //check if button is pressed, and tell us if it is!
-    if(button.isPressed()){
-        Serial.println("The button is pressed!");
-        button.LEDon(brightness);
-    }
-
-    else {
-        Serial.println("The button is not pressed.");
-        button.LEDoff();
-    }
-    delay(20); //Don't hammer too hard on the I2C bus
-}

examples/Example2_LightWhenPressed/Example2_LightWhenPressed.ino

@@ -1,59 +1,51 @@
 /******************************************************************************
-Checks whether the button is pressed, and light it up if it is! Also prints
-status to the serial monitor.
+  Checks whether the button is pressed, and light it up if it is! Also prints
+  status to the serial monitor.
 
-Fischer Moseley @ SparkFun Electronics
-Original Creation Date: July 24, 2019
+  Fischer Moseley @ SparkFun Electronics
+  Original Creation Date: July 24, 2019
 
-This code is Lemonadeware; if you see me (or any other SparkFun employee) at the
-local, and you've found our code helpful, please buy us a round!
+  This code is Lemonadeware; if you see me (or any other SparkFun employee) at the
+  local, and you've found our code helpful, please buy us a round!
 
-Hardware Connections:
-Attach the Qwiic Shield to your Arduino/Photon/ESP32 or other
-Plug the button into the shield
-Print it to the serial monitor at 115200 baud.
+  Hardware Connections:
+  Attach the Qwiic Shield to your Arduino/Photon/ESP32 or other
+  Plug the button into the shield
+  Print it to the serial monitor at 115200 baud.
 
-Distributed as-is; no warranty is given.
+  Distributed as-is; no warranty is given.
 ******************************************************************************/
 
 #include <SparkFun_Qwiic_Button.h>
 QwiicButton button;
-uint8_t brightness = 170;   //The maximum brightness of the pulsing LED. Can be between 0 (min) and 255 (max)
-uint16_t cycleTime = 500;   //The total time for the pulse to take. Set to a bigger number for a slower pulse, or a smaller number for a faster pulse
-uint16_t offTime = 500;     //The total time to stay off between pulses. Set to 0 to be pulsing continuously.
-
-
-void setup(){
-    Serial.begin(115200);
-    Wire.begin(); //Join I2C bus
-    Wire.setClock(400000); //Set I2C clock to 400kHz
-    button.begin(DEFAULT_BUTTON_ADDRESS); // Initialize our button! Set to DEFAULT_SWITCH_ADDRESS if you're using a
-                                          // switch, or whatever the I2C address of your device is
-
-    //check if button will acknowledge over I2C
-    if(button.isConnected()){
-        Serial.println("Device will acknowledge!");
-    }
-
-    else {
-        Serial.println("Device did not acknowledge! Freezing.");
-        while(1);
-    }
+//Define LED characteristics
+uint8_t brightness = 250;   //The maximum brightness of the pulsing LED. Can be between 0 (min) and 255 (max)
+uint16_t cycleTime = 1000;   //The total time for the pulse to take. Set to a bigger number for a slower pulse, or a smaller number for a faster pulse
+uint16_t offTime = 200;     //The total time to stay off between pulses. Set to 0 to be pulsing continuously.
+
+void setup() {
+  Serial.begin(115200);
+  Serial.println("Qwiic button examples");
+  Wire.begin(); //Join I2C bus
+
+  //check if button will acknowledge over I2C
+  if (button.begin() == false) {
+    Serial.println("Device did not acknowledge! Freezing.");
+    while (1);
+  }
+  Serial.println("Button acknowledged.");
+  button.LEDoff();  //start with the LED off
+}
 
+void loop() {
+  //check if button is pressed, and tell us if it is!
+  if (button.isPressed() == true) {
+    Serial.println("The button is pressed!");
+    button.LEDconfig(brightness, cycleTime, offTime);
+    while (button.isPressed() == true)
+      delay(10);  //wait for user to stop pressing
+    Serial.println("The button is not pressed.");
     button.LEDoff();
+  }
+  delay(20); //let's not hammer too hard on the I2C bus
 }
-
-void loop(){
-    //check if button is pressed, and tell us if it is!
-    if(button.isPressed()){
-        Serial.println("The button is pressed!");
-        button.LEDconfig(brightness, 1, cycleTime, offTime);
-    }
-
-    else {
-        Serial.println("The button is not pressed.");
-        button.LEDoff();
-    }
-    
-    delay(20); //let's not hammer too hard on the I2C bus
-}