correctly using enum for registers

Author: lewispg228

examples/Example_08_Sound_Effects/Example_08_Sound_Effects.ino

@@ -76,7 +76,7 @@
 #include <SparkFun_Qwiic_Buzzer_Arduino_Library.h>
 QwiicBuzzer buzzer;
 
-#define BUZZER_VOLUME 4 // loudest!!
+#define BUZZER_VOLUME 4 // loudest!!     
 //#define BUZZER_VOLUME 3 // pretty good volume for most things
 sfeTkError_t err; // used for checking for errors
 

src/sfeQwiicBuzzer.h

@@ -109,7 +109,7 @@ class sfeQwiicBuzzer
     /// @param soundEffectNumber The sound effect you with to play
     /// @param volume Volume (4 settings; 0=off, 1=quiet... 4=loudest)
     /// @return 0 for succuss, negative for errors, positive for warnings
-    sfeTkError_t playSoundEffect(const uint8_t &soundEffectNumber, const uint8_t &volume);
+    sfeTkError_t playSoundEffect(const uint8_t soundEffectNumber, const uint8_t volume);
 
   private:
     /// @brief Plays sound effect 0 (aka "Siren")
@@ -118,15 +118,15 @@ class sfeQwiicBuzzer
     /// single "up and down" cycle.
     /// @param volume Volume (4 settings; 0=off, 1=quiet... 4=loudest)
     /// @return 0 for succuss, negative for errors, positive for warnings
-    sfeTkError_t soundEffect0(const uint8_t &volume);
+    sfeTkError_t soundEffect0(const uint8_t volume);
 
     /// @brief Plays sound effect 1 (aka "3 Fast Sirens")
     /// Intended to sound like a siren, starting at a low frequency, and then
     /// increasing rapidly up and then back down. This sound effect does this
     /// cycle of "up and down" three times rapidly.
     /// @param volume Volume (4 settings; 0=off, 1=quiet... 4=loudest)
     /// @return 0 for succuss, negative for errors, positive for warnings
-    sfeTkError_t soundEffect1(const uint8_t &volume);
+    sfeTkError_t soundEffect1(const uint8_t volume);
 
     /// @brief Plays sound effect 2 (aka "robot saying 'Yes'")
     /// Intended to sound like a robot saying the word "yes".
@@ -135,7 +135,7 @@ class sfeQwiicBuzzer
     /// sound to any question you may ask your buzzing robot.
     /// @param volume Volume (4 settings; 0=off, 1=quiet... 4=loudest)
     /// @return 0 for succuss, negative for errors, positive for warnings
-    sfeTkError_t soundEffect2(const uint8_t &volume);
+    sfeTkError_t soundEffect2(const uint8_t volume);
 
     /// @brief Plays sound effect 3 (aka "robot yelling 'YES!'" - faster)
     /// Intended to sound like a robot saying the word "yes".
@@ -145,7 +145,7 @@ class sfeQwiicBuzzer
     /// is done more quickly, it can add enthusiasm to the buzzing sound.
     /// @param volume Volume (4 settings; 0=off, 1=quiet... 4=loudest)
     /// @return 0 for succuss, negative for errors, positive for warnings
-    sfeTkError_t soundEffect3(const uint8_t &volume);
+    sfeTkError_t soundEffect3(const uint8_t volume);
 
     /// @brief Plays sound effect 4 (aka "robot saying 'No'")
     /// Intended to sound like a robot saying the word "no".
@@ -154,7 +154,7 @@ class sfeQwiicBuzzer
     /// sound to any question you may ask your buzzing robot.
     /// @param volume Volume (4 settings; 0=off, 1=quiet... 4=loudest)
     /// @return 0 for succuss, negative for errors, positive for warnings
-    sfeTkError_t soundEffect4(const uint8_t &volume);
+    sfeTkError_t soundEffect4(const uint8_t volume);
 
     /// @brief Plays sound effect 5 (aka "robot yelling 'NO!'" - faster)
     /// Intended to sound like a robot saying the word "no".
@@ -164,33 +164,33 @@ class sfeQwiicBuzzer
     /// is done more quickly, it can add enthusiasm to the buzzing sound.
     /// @param volume Volume (4 settings; 0=off, 1=quiet... 4=loudest)
     /// @return 0 for succuss, negative for errors, positive for warnings
-    sfeTkError_t soundEffect5(const uint8_t &volume);
+    sfeTkError_t soundEffect5(const uint8_t volume);
 
     /// @brief Plays sound effect 6 (aka "Laughing Robot")
     /// Intended to sound like your robot is laughing at you.
     /// @param volume Volume (4 settings; 0=off, 1=quiet... 4=loudest)
     /// @return 0 for succuss, negative for errors, positive for warnings
-    sfeTkError_t soundEffect6(const uint8_t &volume);
+    sfeTkError_t soundEffect6(const uint8_t volume);
 
     /// @brief Plays sound effect 7 (aka "Laughing Robot Faster")
     /// Intended to sound like your robot is laughing at you. As this sound
     /// is done more quickly, it can add enthusiasm to the buzzing sound.
     /// @param volume Volume (4 settings; 0=off, 1=quiet... 4=loudest)
     /// @return 0 for succuss, negative for errors, positive for warnings
-    sfeTkError_t soundEffect7(const uint8_t &volume);
+    sfeTkError_t soundEffect7(const uint8_t volume);
 
     /// @brief Plays sound effect 8 (aka "Crying Robot")
     /// Intended to sound like a robot is crying and sad.
     /// @param volume Volume (4 settings; 0=off, 1=quiet... 4=loudest)
     /// @return 0 for succuss, negative for errors, positive for warnings
-    sfeTkError_t soundEffect8(const uint8_t &volume);
+    sfeTkError_t soundEffect8(const uint8_t volume);
 
     /// @brief Plays sound effect 9 (aka "Crying Robot Faster")
     /// Intended to sound like a robot is crying and sad. As this sound
     /// is done more quickly, it can add enthusiasm to the buzzing sound.
     /// @param volume Volume (4 settings; 0=off, 1=quiet... 4=loudest)
     /// @return 0 for succuss, negative for errors, positive for warnings
-    sfeTkError_t soundEffect9(const uint8_t &volume);
+    sfeTkError_t soundEffect9(const uint8_t volume);
 
   protected:
     sfeTkII2C *_theBus;

src/sfeQwiicBuzzerRegisters.h

@@ -32,14 +32,14 @@
 enum Qwiic_Buzzer_Register : uint8_t
 {
     kSfeQwiicBuzzerRegId = 0x00,
-    kSfeQwiicBuzzerRegFirmwareMinor = 0x01,
-    kSfeQwiicBuzzerRegFirmwareMajor = 0x02,
-    kSfeQwiicBuzzerRegToneFrequencyMsb = 0x03,
-    kSfeQwiicBuzzerRegToneFrequencyLsb = 0x04,
-    kSfeQwiicBuzzerRegVolume = 0x05,
-    kSfeQwiicBuzzerRegDurationMsb = 0x06,
-    kSfeQwiicBuzzerRegDurationLsb = 0x07,
-    kSfeQwiicBuzzerRegActive = 0x08,
-    kSfeQwiicBuzzerRegSaveSettings = 0x09,
-    kSfeQwiicBuzzerRegI2cAddress = 0x0A,
+    kSfeQwiicBuzzerRegFirmwareMinor,
+    kSfeQwiicBuzzerRegFirmwareMajor,
+    kSfeQwiicBuzzerRegToneFrequencyMsb,
+    kSfeQwiicBuzzerRegToneFrequencyLsb,
+    kSfeQwiicBuzzerRegVolume,
+    kSfeQwiicBuzzerRegDurationMsb,
+    kSfeQwiicBuzzerRegDurationLsb,
+    kSfeQwiicBuzzerRegActive,
+    kSfeQwiicBuzzerRegSaveSettings,
+    kSfeQwiicBuzzerRegI2cAddress,
 };