updates and cleanup

-included toolkit in SparkFun_Qwiic_Buzzer_Arduino_Library.h
-Changed I2C constructor from () to {}
-changeAddress is now setAddress
-function order now the same between header and source files.

Author: lewispg228

examples/Example_05_ChangeI2CAddress/Example_05_ChangeI2CAddress.ino

@@ -55,7 +55,7 @@ void setup() {
           Serial.print("Attempting to set device address to 0x");
           Serial.println(newAddress, HEX);
 
-          if (buzzer.changeAddress(newAddress) == true) {
+          if (buzzer.setAddress(newAddress) == true) {
             Serial.println("Device address set succeeded!");
           }
 

keywords.txt

@@ -12,7 +12,7 @@ QwiicBuzzer					        KEYWORD1
 
 begin						        KEYWORD2
 isConnected					        KEYWORD2
-changeAddress   			        KEYWORD2
+setAddress   			        KEYWORD2
 getAddress   			            KEYWORD2
 buzzerConfig   				        KEYWORD2
 off  					            KEYWORD2

src/SparkFun_Qwiic_Buzzer_Arduino_Library.h

@@ -25,6 +25,7 @@
 
 #pragma once
 
+#include <SparkFun_Toolkit.h>
 #include "sfeQwiicBuzzer.h"
 
 class QwiicBuzzer : public sfeQwiicBuzzerArdI2C

src/sfeQwiicBuzzer.cpp

@@ -42,32 +42,6 @@ sfeTkError_t sfeQwiicBuzzerArdI2C::isConnected()
     return _theBus->ping();
 }
 
-sfeTkError_t sfeQwiicBuzzerArdI2C::changeAddress(const uint8_t &address)
-{
-    if (address < 0x08 || address > 0x77)
-    {
-        Serial.println("Address out of legal range");
-        return kSTkErrFail; //error immediately if the address is out of legal range
-    }
-
-    sfeTkError_t err = _theBus->writeRegisterByte(kSfeQwiicBuzzerRegI2cAddress, address);
-
-    // Check whether the write was successful
-    if (err != kSTkErrOk)
-        return err;
-
-    // Update the address in the bus
-    _theBus->setAddress(address);
-
-    // Done!
-    return kSTkErrOk;
-}
-
-uint8_t sfeQwiicBuzzerArdI2C::getAddress()
-{
-    return _theBus->address();
-}
-
 sfeTkError_t sfeQwiicBuzzerArdI2C::buzzerConfig(uint16_t toneFrequency, uint16_t duration, uint8_t volume)
 {
     // All of the necessary configuration register address are in sequencial order
@@ -99,16 +73,6 @@ sfeTkError_t sfeQwiicBuzzerArdI2C::buzzerConfig(uint16_t toneFrequency, uint16_t
     return _theBus->writeRegisterRegion(kSfeQwiicBuzzerRegToneFrequencyMsb, data, dataLength);
 }
 
-sfeTkError_t sfeQwiicBuzzerArdI2C::setBuzzerActiveReg()
-{
-    return _theBus->writeRegisterByte(kSfeQwiicBuzzerRegActive, 0x01);
-}
-
-sfeTkError_t sfeQwiicBuzzerArdI2C::clearBuzzerActiveReg()
-{
-    return _theBus->writeRegisterByte(kSfeQwiicBuzzerRegActive, 0x00);
-}
-
 sfeTkError_t sfeQwiicBuzzerArdI2C::on(uint16_t toneFrequency, uint16_t duration, uint8_t volume)
 {
     sfeTkError_t err = buzzerConfig(toneFrequency, duration, volume);
@@ -128,6 +92,42 @@ sfeTkError_t sfeQwiicBuzzerArdI2C::saveSettings()
     return _theBus->writeRegisterByte(kSfeQwiicBuzzerRegSaveSettings, 0x01);
 }
 
+sfeTkError_t sfeQwiicBuzzerArdI2C::setBuzzerActiveReg()
+{
+    return _theBus->writeRegisterByte(kSfeQwiicBuzzerRegActive, 0x01);
+}
+
+sfeTkError_t sfeQwiicBuzzerArdI2C::clearBuzzerActiveReg()
+{
+    return _theBus->writeRegisterByte(kSfeQwiicBuzzerRegActive, 0x00);
+}
+
+sfeTkError_t sfeQwiicBuzzerArdI2C::setAddress(const uint8_t &address)
+{
+    if (address < 0x08 || address > 0x77)
+    {
+        Serial.println("Address out of legal range");
+        return kSTkErrFail; //error immediately if the address is out of legal range
+    }
+
+    sfeTkError_t err = _theBus->writeRegisterByte(kSfeQwiicBuzzerRegI2cAddress, address);
+
+    // Check whether the write was successful
+    if (err != kSTkErrOk)
+        return err;
+
+    // Update the address in the bus
+    _theBus->setAddress(address);
+
+    // Done!
+    return kSTkErrOk;
+}
+
+uint8_t sfeQwiicBuzzerArdI2C::getAddress()
+{
+    return _theBus->address();
+}
+
 /*------------------------- Sound Effects ---------------- */
 
 void sfeQwiicBuzzerArdI2C::playSoundEffect(uint8_t soundEffectNumber, uint8_t volume)

src/sfeQwiicBuzzer.h

@@ -37,7 +37,7 @@ class sfeQwiicBuzzerArdI2C
 {
     public:
         /// @brief Default constructor
-        sfeQwiicBuzzerArdI2C() : _theBus(nullptr)
+        sfeQwiicBuzzerArdI2C() : _theBus{nullptr}
         {
         }
 
@@ -80,6 +80,15 @@ class sfeQwiicBuzzerArdI2C
         /// @return 0 for succuss, negative for errors, positive for warnings    
         sfeTkError_t clearBuzzerActiveReg();    
 
+        /// @brief Changes the I2C address of the Qwiic Buzzer
+        /// @param address New address, must be in the range 0x20 to 0x2F
+        /// @return 0 for succuss, negative for errors, positive for warnings
+        sfeTkError_t setAddress(const uint8_t &address);
+
+        /// @brief Gets the current I2C address of the Qwiic Buzzer
+        /// @return The current I2C address, 7-bit unshifted
+        uint8_t getAddress();
+        
         /// @brief Plays one of the sound effects included in this library
         /// @param soundEffectNumber The sound effect you with to play
         /// @param volume Volume (4 settings; 0=off, 1=quiet... 4=loudest)
@@ -125,15 +134,6 @@ class sfeQwiicBuzzerArdI2C
         /// @param volume Volume (4 settings; 0=off, 1=quiet... 4=loudest)
         void soundEffect9(uint8_t volume);    
 
-        /// @brief Changes the I2C address of the Qwiic Buzzer
-        /// @param address New address, must be in the range 0x20 to 0x2F
-        /// @return 0 for succuss, negative for errors, positive for warnings
-        sfeTkError_t changeAddress(const uint8_t &address);
-
-        /// @brief Gets the current I2C address of the Qwiic Buzzer
-        /// @return The current I2C address, 7-bit unshifted
-        uint8_t getAddress();
-
     protected:
         sfeTkII2C *_theBus;
 };