Bringing in copy of button library as starting point

Author: lewispg228

ISSUE_TEMPLATE.md

@@ -0,0 +1,18 @@
+### Subject of the issue
+Describe your issue here.
+
+### Your workbench
+* What development board or microcontroller are you using?
+* What version of hardware or breakout board are you using? 
+* How is the breakout board wired to your microcontroller?
+* How is everything being powered?
+* Are there any additional details that may help us help you?
+
+### Steps to reproduce
+Tell us how to reproduce this issue. Please post stripped down example code demonstrating your issue.
+
+### Expected behavior
+Tell us what should happen
+
+### Actual behavior
+Tell us what happens instead

LICENSE.md

@@ -0,0 +1,55 @@
+SparkFun License Information
+============================
+
+SparkFun uses two different licenses for our files — one for hardware and one for code.
+
+Hardware
+---------
+
+**SparkFun hardware is released under [Creative Commons Share-alike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/).**
+
+Note: This is a human-readable summary of (and not a substitute for) the [license](http://creativecommons.org/licenses/by-sa/4.0/legalcode).
+
+You are free to:
+
+Share — copy and redistribute the material in any medium or format
+Adapt — remix, transform, and build upon the material
+for any purpose, even commercially.
+The licensor cannot revoke these freedoms as long as you follow the license terms.
+Under the following terms:
+
+Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
+ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.
+No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.
+Notices:
+
+You do not have to comply with the license for elements of the material in the public domain or where your use is permitted by an applicable exception or limitation.
+No warranties are given. The license may not give you all of the permissions necessary for your intended use. For example, other rights such as publicity, privacy, or moral rights may limit how you use the material.
+
+
+Code
+--------
+
+**SparkFun code, firmware, and software is released under the MIT License(http://opensource.org/licenses/MIT).**
+
+The MIT License (MIT)
+
+Copyright (c) 2016 SparkFun Electronics
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,2 +1,75 @@
-# SparkFun_Qwiic_Buzzer_Arduino_Library
-Arduino Library for the SparkFun Qwiic Buzzer
+SparkFun Qwiic Button Arduino Library [![Build Status](https://travis-ci.org/sparkfun/SparkFun_Qwiic_Button_Arduino_Library.svg?branch=master)](https://travis-ci.org/sparkfun/SparkFun_Qwiic_Button_Arduino_Library)
+========================================
+<table class="table table-hover table-striped table-bordered">
+  <tr align="center">
+   <td><a href="https://www.sparkfun.com/products/15932"><img src="https://cdn.sparkfun.com/assets/parts/1/4/5/7/3/15932-SparkFun_Qwiic_Button_-_Red-01.jpg"></a></td>
+   <td><a href="https://www.sparkfun.com/products/15931"><img src="https://cdn.sparkfun.com/assets/parts/1/4/5/7/2/15931-SparkFun_Qwiic_Button_Breakout-01.jpg"></a></td>
+   <td><a href="https://www.sparkfun.com/products/15591"><img src="https://cdn.sparkfun.com//assets/parts/1/4/1/9/8/15591-Qwiic_Arcade_-_Red-01a.jpg"></a></td>
+   <td><a href="https://www.sparkfun.com/products/15592"><img src="https://cdn.sparkfun.com//assets/parts/1/4/1/9/9/15592-Qwiic_Arcade_-_Blue-01a.jpg"></a></td>
+   <td><a href="https://www.sparkfun.com/products/15586"><img src="https://cdn.sparkfun.com//assets/parts/1/4/1/9/2/15586-Qwiic_Switch__without_microswitch_-01a.jpg"></a></td>
+  </tr>
+  <tr align="center">
+    <td><a href="https://www.sparkfun.com/products/15932">SparkFun Qwiic Button - Red (BOB-15932)</a></td>
+    <td><a href="https://www.sparkfun.com/products/15931">SparkFun Qwiic Button Breakout (BOB-15931)</a></td>
+    <td><a href="https://www.sparkfun.com/products/15591">SparkFun Qwiic Arcade - Red (SPX-15591)</a></td>
+    <td><a href="https://www.sparkfun.com/products/15592">SparkFun Qwiic Arcade - Blue (SPX-15592)</a></td>
+    <td><a href="https://www.sparkfun.com/products/15586">SparkFun Qwiic Switch (SPX-15586)</a></td>
+  </tr>
+</table>
+
+
+This library allows the user to:
+
+* Determine whether or not the button/switch is pressed 
+* Set the brightness of the onboard LED
+* Configure the onboard LED's "breathing" effect
+* Use button-based interrupts
+* Adjust the device's I<sup>2</sup>C address
+
+
+Repository Contents
+-------------------
+
+* **/examples** - Example sketches for the library (.ino). Run these from the Arduino IDE. 
+* **/src** - Source files for the library (.cpp, .h).
+* **keywords.txt** - Keywords from this library that will be highlighted in the Arduino IDE. 
+* **library.properties** - General library properties for the Arduino package manager. 
+
+Documentation
+--------------
+
+* **[Installing an Arduino Library Guide](https://learn.sparkfun.com/tutorials/installing-an-arduino-library)** - Basic information on how to install an Arduino library.
+* **[Product Repository](https://github.com/sparkfun/Qwiic_Button)** - Main repository (including hardware files) for the SparkFun Qwiic Button Breakout Board.
+* **[Product Repository](https://github.com/sparkfunX/Qwiic_Switch)** - Main repository (including hardware files) for the SparkFun Qwiic Switch.
+* **[Product Repository](https://github.com/sparkfunX/Qwiic_Button)** - Main repository (including hardware files) for the SparkFun Qwiic Button.
+
+Products that use this Library 
+---------------------------------
+
+* [*BOB-15932*](https://www.sparkfun.com/products/15932) - SparkFun Red Version with red LED pushbutton
+* [*BOB-16842*](https://www.sparkfun.com/products/16842) - SparkFun Red Version with green LED pushbutton
+* [*BOB-15931*](https://www.sparkfun.com/products/15931) - SparkFun Red Version without button
+* [*SPX-15584*](https://www.sparkfun.com/products/15584) - Original SparkX version of the Qwiic Button (Red LED)
+* [*SPX-15585*](https://www.sparkfun.com/products/15585) - Original SparkX version of the Qwiic Button (Blue LED)
+* [*SPX-15591*](https://www.sparkfun.com/products/15591) - Original SparkX version of the Qwiic Button (Arcade Red Pushbutton)
+* [*SPX-15592*](https://www.sparkfun.com/products/15592) - Original SparkX version of the Qwiic Button (Arcade Blue Pushbutton)
+* [*SPX-15586*](https://www.sparkfun.com/products/15586) - Original SparkX version of the Qwiic Button
+
+Version History
+---------------
+
+* [v1.0.1](https://github.com/sparkfun/SparkFun_Qwiic_Button_Arduino_Library/releases/tag/v1.0.1) - Arduino Library Specification Compliance
+* [v1.0.0](https://github.com/sparkfun/SparkFun_Qwiic_Button_Arduino_Library/releases/tag/v1.0.0) - Initial Public release.
+
+License Information
+-------------------
+
+This product is _**open source**_! 
+
+Please review the LICENSE.md file for license information. 
+
+If you have any questions or concerns on licensing, please contact techsupport@sparkfun.com.
+
+Distributed as-is; no warranty is given.
+
+- Your friends at SparkFun.

examples/Example1_PrintButtonStatus/Example1_PrintButtonStatus.ino

@@ -0,0 +1,43 @@
+/******************************************************************************
+  Checks whether the button is pressed, and then prints its status over serial!
+
+  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!
+
+  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.
+******************************************************************************/
+
+#include <SparkFun_Qwiic_Button.h>
+QwiicButton button;
+
+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() == 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/Example2_LightWhenPressed/Example2_LightWhenPressed.ino

@@ -0,0 +1,50 @@
+/******************************************************************************
+  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
+
+  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.
+
+  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);
+  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.");
+
+  //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
+}

examples/Example3_PulseWhenPressed/Example3_PulseWhenPressed.ino

@@ -0,0 +1,51 @@
+/******************************************************************************
+  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
+
+  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.
+
+  Distributed as-is; no warranty is given.
+******************************************************************************/
+
+#include <SparkFun_Qwiic_Button.h>
+QwiicButton button;
+//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
+}

examples/Example4_QueueUsage/Example4_QueueUsage.ino

@@ -0,0 +1,81 @@
+/******************************************************************************
+Shows how to use the FIFO Queue on the Qwiic Button
+
+Fischer Moseley @ SparkFun Electronics
+Original Creation Date: July 29, 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!
+
+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.
+******************************************************************************/
+
+#include <SparkFun_Qwiic_Button.h>
+QwiicButton button;
+
+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(){
+    if(button.isPressedQueueEmpty() == false) { //if the queue of pressed events is not empty
+        //then print the time since the last and first button press
+        Serial.print(button.timeSinceLastPress()/1000.0);
+        Serial.print("s since the button was last pressed   ");
+        Serial.print(button.timeSinceFirstPress()/1000.0);
+        Serial.print("s since the button was first pressed   ");
+    }
+    //if the queue of pressed events is empty, just print that the queue is empty!
+    else {
+        Serial.print("ButtonPressed Queue is empty! ");
+    } 
+
+    if(button.isClickedQueueEmpty() == false) { //if the queue of clicked events is not empty
+        //then print the time since the last and first button click
+        Serial.print(button.timeSinceLastClick()/1000.0);
+        Serial.print("s since the button was last clicked   ");
+        Serial.print(button.timeSinceFirstClick()/1000.0);
+        Serial.print("s since the button was first clicked");
+    }
+    //if the queue of clicked events is empty, just print that the queue is empty!
+    else {
+        Serial.print("  ButtonClicked Queue is empty!");
+    }
+
+    Serial.println(); //print a new line to not clutter up the serial monitor
+
+    if(Serial.available()) { //if the user sent a character
+        
+        uint8_t data = Serial.read();
+        if(data == 'p' || data == 'P') { //if the character is p or P, then pop a value off of the pressed Queue
+            long pressedPopped = button.popPressedQueue();
+            Serial.print("Popped from PressedQueue: ");
+            Serial.println(pressedPopped/1000.0);
+            // Wait before continuing on
+            delay(3000);
+        }
+
+        if(data == 'c' || data == 'C') { //if the character is c or C, then pop a value off of the pressed Queue
+            long clickedPopped = button.popClickedQueue();
+            Serial.print("Popped from Clicked Queue: ");
+            Serial.println(clickedPopped/1000.0);
+            // Wait before continuing on 
+            delay(3000);
+        }
+    }
+    delay(20); //let's not hammer too hard on the I2C bus
+}