more button to buzzer naming stuff

Author: lewispg228

README.md

@@ -14,10 +14,8 @@ UPDATE WHAT DOES THIS LIBRARY DO!?! =)
 
 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
+* Turn the buzzer on and off directly
+* Optionally, set the frequency, duration, and volume of the sound
 * Adjust the device's I<sup>2</sup>C address
 
 -->

examples/Example5_ChangeI2CAddress/Example5_ChangeI2CAddress.ino

@@ -1,6 +1,6 @@
 /******************************************************************************
-  A configurator for changing the I2C address on the Qwiic Button/Switch that walks
-  the user through finding the address of their button, and then changing it!
+  A configurator for changing the I2C address on the Qwiic Buzzer that walks
+  the user through finding the address of their buzzer, and then changing it!
 
   Fischer Moseley @ SparkFun Electronics
   Original Creation Date: July 30, 2019
@@ -9,30 +9,29 @@
   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.
+  Attach the Qwiic Buzzer to your Redboard via Qwiic Cable
+  Open and interact with serial monitor at 115200 baud.
 
   Distributed as-is; no warranty is given.
 ******************************************************************************/
 
-#include <SparkFun_Qwiic_Button.h>
-QwiicButton button;
+#include <SparkFun_Qwiic_Buzzer_Arduino_Library.h>
+QwiicBuzzer buzzer;
 
 void setup() {
   Serial.begin(115200);
-  Serial.println("Qwiic button examples");
+  Serial.println("Qwiic Buzzer example - I2C Address Change");
   Wire.begin(); //Join I2C bus
 
-  //check if button will acknowledge over I2C
-  if (button.begin() == false) {
+  //check if device will acknowledge over I2C
+  if (buzzer.begin() == false) {
     Serial.println("Device did not acknowledge! Running scanner.");
   }
   else{
     Serial.println("Device acknowledged!");
 
     Serial.println();
-    Serial.println("Enter a new I2C address for the Qwiic Button/Switch to use!");
+    Serial.println("Enter a new I2C address for the Qwiic Buzzer to use!");
     Serial.println("Don't use the 0x prefix. For instance, if you wanted to");
     Serial.println("change the address to 0x5B, you would enter 5B and press enter.");
     Serial.println();
@@ -56,7 +55,7 @@ void setup() {
           Serial.print("Attempting to set device address to 0x");
           Serial.println(newAddress, HEX);
 
-          if (button.setI2Caddress(newAddress) == true) {
+          if (buzzer.setI2Caddress(newAddress) == true) {
             Serial.println("Device address set succeeded!");
           }
 
@@ -66,7 +65,7 @@ void setup() {
 
           delay(100); //give the hardware time to do whatever configuration it needs to do
 
-          if (button.isConnected()) {
+          if (buzzer.isConnected()) {
             Serial.println("Device will acknowledge on new I2C address!");
           }
 
@@ -89,7 +88,7 @@ void setup() {
 }
 
 void loop() {
-  //if no I2C device found or Qwiic button correctly set to new address, 
+  //if no I2C device found or Qwiic Buzzer correctly set to new address, 
   //scan for available I2C devices
   byte error, address;
   int nDevices;

examples/Example_02_Buzz_Frequency/Example_02_Buzz_Frequency.ino

@@ -10,7 +10,7 @@
   By Pete Lewis @ SparkFun Electronics
   December 2023
 
-  Based on code orginally written by Fischer Moseley @ SparkFun Electronics
+  Based on code originally written by 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
@@ -30,7 +30,7 @@ void setup() {
   Serial.println("Qwiic Buzzer Example_02_Buzz_Frequency");
   Wire.begin(); //Join I2C bus
 
-  //check if button will acknowledge over I2C
+  //check if buzzer will acknowledge over I2C
   if (buzzer.begin() == false) {
     Serial.println("Device did not acknowledge! Freezing.");
     while (1);

keywords.txt

@@ -1,10 +1,10 @@
 ######################################################################
-# Syntax Coloring Map for SparkFun Qwiic Button/Switch Arduino Library           #
+# Syntax Coloring Map for SparkFun Qwiic Buzzer Arduino Library           #
 ######################################################################
 # Class
 ######################################################################
 
-QwiicButton					KEYWORD1
+QwiicBuzzer					KEYWORD1
 
 ######################################################################
 # Methods and Functions
@@ -18,27 +18,7 @@ getDeviceType   			KEYWORD2
 getFirmwareVersion  		KEYWORD2
 setI2Caddress   			KEYWORD2
 getI2Caddress   			KEYWORD2
-isPressed   				KEYWORD2
-hasBeenClicked  			KEYWORD2
-getDebounceTime 			KEYWORD2
-setDebounceTime 			KEYWORD2
-enablePressedInterrupt  	KEYWORD2
-disablePressedInterrupt 	KEYWORD2
-enableClickedInterrupt  	KEYWORD2
-disableClickedInterrupt 	KEYWORD2
-available  					KEYWORD2
-clearEventBits  			KEYWORD2
-resetInterruptConfig    	KEYWORD2
-isPressedQueueFull  		KEYWORD2
-isPressedQueueEmpty 		KEYWORD2
-timeSinceLastPress  		KEYWORD2
-timeSinceFirstPress 		KEYWORD2
-popPressedQueue 			KEYWORD2
-isClickedQueueFull  		KEYWORD2
-isClickedQueueEmpty 		KEYWORD2
-timeSinceLastClick  		KEYWORD2
-timeSinceFirstClick 		KEYWORD2
-popClickedQueue 			KEYWORD2
 BUZZERconfig   				KEYWORD2
-LEDoff  					KEYWORD2
-LEDon   					KEYWORD2
+off  					KEYWORD2
+on   					KEYWORD2
+saveSettings   					KEYWORD2

library.properties

@@ -1,9 +1,9 @@
-name=SparkFun Qwiic Button and Qwiic Switch Library
-version=2.0.6
+name=SparkFun Qwiic Buzzer Library
+version=0.0.1
 author=SparkFun Electronics <techsupport@sparkfun.com>
-maintainer=Fischer Moseley <fischer.moseley@sparkfun.com>
-sentence=Communicates and configures the SparkFun Qwiic Button and Switch.
-paragraph=This library allows the user to see the button status, configure the built-in LED, set up interrupts, change I2C addresses, and interface with the onboard button queues.
-category=Sensors
-url=https://sparkfun.com/products/15584
+maintainer=SparkFun Electronics <support@sparkfun.com>
+sentence=Communicates and configures the SparkFun Qwiic Buzzer
+paragraph=This library allows the user to control the buzzer frequency/duration, and change its I2C addresses.
+category=Outputs
+url=https://sparkfun.com/products/24474
 architectures=*

src/SparkFun_Qwiic_Buzzer_Arduino_Library.cpp

@@ -1,16 +1,20 @@
 /******************************************************************************
-SparkFun_Qwiic_Button.cpp
-SparkFun Qwiic Button/Switch Library Source File
+SparkFun_Qwiic_Buzzer_Arduino_Library.cpp
+SparkFun Qwiic Buzzer Library Source File
+
+by Pete Lewis @SparkFun Electronics
+Jan 2024
+
+Based on original source code written by
 Fischer Moseley @ SparkFun Electronics
 Original Creation Date: July 24, 2019
 
-This file implements the QwiicButton class, prototyped in SparkFun_Qwiic_Button.h
+This file implements the QwiicBuzzer class, prototyped in SparkFun_Qwiic_Buzzer_Arduino_Library.h
 
 Development environment specifics:
-	IDE: Arduino 1.8.9
+	IDE: Arduino 2.2.1
 	Hardware Platform: Arduino Uno/SparkFun Redboard
-	Qwiic Button Version: 1.0.0
-    Qwiic Switch Version: 1.0.0
+	Qwiic Buzzer Version: v10
 
 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!
@@ -48,29 +52,29 @@ bool QwiicBuzzer::isConnected()
 
 uint8_t QwiicBuzzer::deviceID()
 {
-    return readSingleRegister(SFE_QWIIC_BUTTON_ID); //read and return the value in the ID register
+    return readSingleRegister(SFE_QWIIC_BUZZER_ID); //read and return the value in the ID register
 }
 
 bool QwiicBuzzer::checkDeviceID()
 {
-    return (deviceID() == SFE_QWIIC_BUTTON_DEV_ID); //Return true if the device ID matches
+    return (deviceID() == SFE_QWIIC_BUZZER_DEV_ID); //Return true if the device ID matches
 }
 
 uint8_t QwiicBuzzer::getDeviceType()
 {
     if (isConnected())
     { //only try to get the device ID if the device will acknowledge
         uint8_t id = deviceID();
-        if (id == SFE_QWIIC_BUTTON_DEV_ID)
+        if (id == SFE_QWIIC_BUZZER_DEV_ID)
             return 1;
     }
     return 0;
 }
 
 uint16_t QwiicBuzzer::getFirmwareVersion()
 {
-    uint16_t version = (readSingleRegister(SFE_QWIIC_BUTTON_FIRMWARE_MAJOR)) << 8;
-    version |= readSingleRegister(SFE_QWIIC_BUTTON_FIRMWARE_MINOR);
+    uint16_t version = (readSingleRegister(SFE_QWIIC_BUZZER_FIRMWARE_MAJOR)) << 8;
+    version |= readSingleRegister(SFE_QWIIC_BUZZER_FIRMWARE_MINOR);
     return version;
 }
 
@@ -82,7 +86,7 @@ bool QwiicBuzzer::setI2Caddress(uint8_t address)
         return 1; //error immediately if the address is out of legal range
     }
 
-    bool success = writeSingleRegister(SFE_QWIIC_BUTTON_I2C_ADDRESS, address);
+    bool success = writeSingleRegister(SFE_QWIIC_BUZZER_I2C_ADDRESS, address);
 
     if (success == true)
     {
@@ -131,16 +135,6 @@ bool QwiicBuzzer::BUZZERconfig(uint16_t toneFrequency, uint16_t duration, uint8_
     return success;
 }
 
-bool QwiicBuzzer::LEDoff()
-{
-    return BUZZERconfig(0, 0, 0);
-}
-
-bool QwiicBuzzer::LEDon(uint8_t brightness)
-{
-    return BUZZERconfig(brightness, 0, 0);
-}
-
 bool QwiicBuzzer::on(uint16_t toneFrequency, uint16_t duration, uint8_t volume)
 {
     return BUZZERconfig(toneFrequency, duration, volume);
@@ -168,7 +162,7 @@ bool QwiicBuzzer::clearBuzzerActiveReg()
 
 /*------------------------- Internal I2C Abstraction ---------------- */
 
-uint8_t QwiicBuzzer::readSingleRegister(Qwiic_Button_Register reg)
+uint8_t QwiicBuzzer::readSingleRegister(Qwiic_Buzzer_Register reg)
 {
     _i2cPort->beginTransmission(_deviceAddress);
     _i2cPort->write(reg);
@@ -183,7 +177,7 @@ uint8_t QwiicBuzzer::readSingleRegister(Qwiic_Button_Register reg)
     return 0;
 }
 
-uint16_t QwiicBuzzer::readDoubleRegister(Qwiic_Button_Register reg)
+uint16_t QwiicBuzzer::readDoubleRegister(Qwiic_Buzzer_Register reg)
 { //little endian
     _i2cPort->beginTransmission(_deviceAddress);
     _i2cPort->write(reg);
@@ -200,7 +194,7 @@ uint16_t QwiicBuzzer::readDoubleRegister(Qwiic_Button_Register reg)
     return 0;
 }
 
-unsigned long QwiicBuzzer::readQuadRegister(Qwiic_Button_Register reg)
+unsigned long QwiicBuzzer::readQuadRegister(Qwiic_Buzzer_Register reg)
 {
     _i2cPort->beginTransmission(_deviceAddress);
     _i2cPort->write(reg);
@@ -225,7 +219,7 @@ unsigned long QwiicBuzzer::readQuadRegister(Qwiic_Button_Register reg)
     return data.integer;
 }
 
-bool QwiicBuzzer::writeSingleRegister(Qwiic_Button_Register reg, uint8_t data)
+bool QwiicBuzzer::writeSingleRegister(Qwiic_Buzzer_Register reg, uint8_t data)
 {
     _i2cPort->beginTransmission(_deviceAddress);
     _i2cPort->write(reg);
@@ -235,7 +229,7 @@ bool QwiicBuzzer::writeSingleRegister(Qwiic_Button_Register reg, uint8_t data)
     return false;
 }
 
-bool QwiicBuzzer::writeDoubleRegister(Qwiic_Button_Register reg, uint16_t data)
+bool QwiicBuzzer::writeDoubleRegister(Qwiic_Buzzer_Register reg, uint16_t data)
 {
     _i2cPort->beginTransmission(_deviceAddress);
     _i2cPort->write(reg);
@@ -246,7 +240,7 @@ bool QwiicBuzzer::writeDoubleRegister(Qwiic_Button_Register reg, uint16_t data)
     return false;
 }
 
-uint8_t QwiicBuzzer::writeSingleRegisterWithReadback(Qwiic_Button_Register reg, uint8_t data)
+uint8_t QwiicBuzzer::writeSingleRegisterWithReadback(Qwiic_Buzzer_Register reg, uint8_t data)
 {
     if (writeSingleRegister(reg, data))
         return 1;
@@ -255,7 +249,7 @@ uint8_t QwiicBuzzer::writeSingleRegisterWithReadback(Qwiic_Button_Register reg,
     return 0;
 }
 
-uint16_t QwiicBuzzer::writeDoubleRegisterWithReadback(Qwiic_Button_Register reg, uint16_t data)
+uint16_t QwiicBuzzer::writeDoubleRegisterWithReadback(Qwiic_Buzzer_Register reg, uint16_t data)
 {
     if (writeDoubleRegister(reg, data))
         return 1;