Final updates for version 2.0.0

Fixing/adding comments in examples. Update keywords.txt and header file with new library functions.

Author: makin-stuff

examples/Example6_WireSettings/Example6_WireSettings.ino

@@ -21,10 +21,11 @@ QwiicButton button;
 void setup() {
   Serial.begin(115200);
   Serial.println("Qwiic button examples");
+  Wire1.setClock(400000); //set I2C communication to 400kHz
   Wire1.begin(); //Compilation will fail here if your platform doesn't have multiple I2C ports
 
   //check if button will acknowledge over I2C
-  if (button.begin() == false) {
+  if (button.begin(0x6F, Wire1) == false) {
     Serial.println("Device did not acknowledge! Freezing.");
     while(1);
   }

examples/Example7_2Buttons/Example7_2Buttons.ino

@@ -28,10 +28,12 @@ void setup() {
   Wire.begin(); //Join I2C bus
 
   //check if the buttons will acknowledge over I2C
+  //connect to Qwiic button at address 0x5B
   if (button1.begin(0x5B) == false){
     Serial.println("Button 1 did not acknowledge! Freezing.");
     while(1);
   }
+  //connect to Qwiic button at default address, 0x6F
   if (button2.begin() == false) {
     Serial.println("Button 2 did not acknowledge! Freezing.");
     while(1);

examples/Example8_ExtInterrupt/Example8_ExtInterrupt.ino

@@ -25,7 +25,6 @@ void setup() {
   Serial.begin(115200);
   Serial.println("Qwiic button examples");
 
-  //  while(1);
   Wire.begin(); //Join I2C bus
 
   //intialize interrupt pin

keywords.txt

@@ -26,8 +26,8 @@ enablePressedInterrupt  KEYWORD2
 disablePressedInterrupt KEYWORD2
 enableClickedInterrupt  KEYWORD2
 disableClickedInterrupt KEYWORD2
-interruptTriggered  KEYWORD2
-clearInterrupt  KEYWORD2
+available  KEYWORD2
+clearEventBits  KEYWORD2
 resetInterruptConfig    KEYWORD2
 isPressedQueueFull  KEYWORD2
 isPressedQueueEmpty KEYWORD2

src/SparkFun_Qwiic_Button.cpp

@@ -298,6 +298,7 @@ uint8_t QwiicButton::readSingleRegister(Qwiic_Button_Register reg)
     {
         return _i2cPort->read();
     }
+    return 0;
 }
 
 uint16_t QwiicButton::readDoubleRegister(Qwiic_Button_Register reg)
@@ -314,6 +315,7 @@ uint16_t QwiicButton::readDoubleRegister(Qwiic_Button_Register reg)
         data |= (_i2cPort->read() << 8);
         return data;
     }
+    return 0;
 }
 
 unsigned long QwiicButton::readQuadRegister(Qwiic_Button_Register reg)

src/SparkFun_Qwiic_Button.h

@@ -57,11 +57,9 @@ class QwiicButton
     uint8_t disablePressedInterrupt(); //When called, the interrupt will no longer be configured to trigger when the button is pressed. If enableClickedInterrupt() has also been called, then the interrupt will still trigger on the button click.
     uint8_t enableClickedInterrupt();  //When called, the interrupt will be configured to trigger when the button is clicked. If enablePressedInterrupt() has also been called, then the interrupt will trigger on either a push or a click.
     uint8_t disableClickedInterrupt(); //When called, the interrupt will no longer be configured to trigger when the button is clicked. If enablePressedInterrupt() has also been called, then the interrupt will still trigger on the button press.
-    bool interruptTriggered();         //Returns true if the interrupt has been triggered, false otherwise.
-    uint8_t clearInterrupt();          //Clears the interrupt flag on the button. Also resets the INT pin to whatever it's resting state is.
-    bool available();
-    uint8_t clearEventBits();
-    uint8_t resetInterruptConfig(); //Resets the interrupt configuration back to defaults.
+    bool available();                  //Returns the eventAvailable bit
+    uint8_t clearEventBits();          //Sets isPressed, hasBeenClicked, and eventAvailable to zero
+    uint8_t resetInterruptConfig();    //Resets the interrupt configuration back to defaults.
 
     //Queue manipulation
     bool isPressedQueueFull();           //Returns true if the queue of button press timestamps is full, and false otherwise.