volume options as macros

Author: lewispg228

examples/Example_04_Buzz_Volume/Example_04_Buzz_Volume.ino

@@ -44,20 +44,20 @@ void setup() {
 }
 
 void loop() {
-  Serial.println("Volume: Quietest (1)");
-  buzzer.on(2730, 100, 1); // frequency: 2.73KHz, duration: 100ms, volume: 1
+  Serial.println("Volume: MIN (1)");
+  buzzer.on(2730, 100, SFE_QWIIC_BUZZER_VOLUME_MIN); // frequency: 2.73KHz, duration: 100ms, volume: MIN
   delay(1000);
 
-  Serial.println("Volume: Mid-low (2)");
-  buzzer.on(2730, 100, 2); // frequency: 2.73KHz, duration: 100ms, volume: 2
+  Serial.println("Volume: LOW (2)");
+  buzzer.on(2730, 100, SFE_QWIIC_BUZZER_VOLUME_LOW); // frequency: 2.73KHz, duration: 100ms, volume: LOW
   delay(1000);
 
-  Serial.println("Volume: Mid-high (3)");
-  buzzer.on(2730, 100, 3); // frequency: 2.73KHz, duration: 100ms, volume: 3
+  Serial.println("Volume: MID (3)");
+  buzzer.on(2730, 100, SFE_QWIIC_BUZZER_VOLUME_MID); // frequency: 2.73KHz, duration: 100ms, volume: MID
   delay(1000);
 
-  Serial.println("Volume: Loudest (4)");
-  buzzer.on(2730, 100, 4); // frequency: 2.73KHz, duration: 100ms, volume: 4
+  Serial.println("Volume: MAX (4)");
+  buzzer.on(2730, 100, SFE_QWIIC_BUZZER_VOLUME_MAX); // frequency: 2.73KHz, duration: 100ms, volume: MAX
   delay(1000);
 
   // Note, we dont' have to use buzzer.off(), because it will automatically turn

examples/Example_05_ChangeI2CAddress/Example_05_ChangeI2CAddress.ino

@@ -19,7 +19,7 @@
 QwiicBuzzer buzzer;
 
 // The default address is 0x34, change this if your buzzer currently has a different address!
-uint8_t initialAddress = kQwiicBuzzerDefaultAddress;
+uint8_t initialAddress = kSfeQwiicBuzzerDefaultAddress;
 
 void setup() {
   Serial.begin(115200);

keywords.txt

@@ -23,7 +23,7 @@ saveSettings   				        KEYWORD2
 # Constants
 #########################################################
 
-kQwiicBuzzerDefaultAddress          LITERAL1
+kSfeQwiicBuzzerDefaultAddress          LITERAL1
 kSfeQwiicBuzzerRegId                LITERAL1
 kSfeQwiicBuzzerRegFirmwareMinor     LITERAL1
 kSfeQwiicBuzzerRegFirmwareMajor     LITERAL1
@@ -35,6 +35,11 @@ kSfeQwiicBuzzerRegDurationLsb	    LITERAL1
 kSfeQwiicBuzzerRegActive	        LITERAL1
 kSfeQwiicBuzzerRegSaveSettings	    LITERAL1 
 kSfeQwiicBuzzerRegI2cAddress	    LITERAL1
+SFE_QWIIC_BUZZER_VOLUME_OFF	        LITERAL1
+SFE_QWIIC_BUZZER_VOLUME_MIN	        LITERAL1
+SFE_QWIIC_BUZZER_VOLUME_LOW	        LITERAL1
+SFE_QWIIC_BUZZER_VOLUME_MID	        LITERAL1
+SFE_QWIIC_BUZZER_VOLUME_MAX	        LITERAL1
 
 kSfeQwiicBuzzerNoteB0	            LITERAL1
 kSfeQwiicBuzzerNoteC1	            LITERAL1

src/SparkFun_Qwiic_Buzzer_Arduino_Library.h

@@ -35,7 +35,7 @@ class QwiicBuzzer : public sfeQwiicBuzzer
         /// @param address I2C device address to use for the sensor
         /// @param wirePort Wire port to use for I2C communication
         /// @return True if successful, false otherwise
-        bool begin(uint8_t address = kQwiicBuzzerDefaultAddress, TwoWire &wirePort = Wire)
+        bool begin(uint8_t address = kSfeQwiicBuzzerDefaultAddress, TwoWire &wirePort = Wire)
         {
             // Setup Arudino I2C bus
             _theI2CBus.init(wirePort, address);

src/sfeQwiicBuzzer.h

@@ -31,8 +31,13 @@
 #include "sfeQwiicBuzzerRegisters.h"
 #include "sfeQwiicBuzzerPitches.h"
 
-const uint8_t kQwiicBuzzerDefaultAddress = 0x34;
+const uint8_t kSfeQwiicBuzzerDefaultAddress = 0x34;
 const uint16_t kSfeQwiicBuzzerResonantFrequency = 2730;
+#define SFE_QWIIC_BUZZER_VOLUME_OFF = 0;
+#define SFE_QWIIC_BUZZER_VOLUME_MIN = 1;
+#define SFE_QWIIC_BUZZER_VOLUME_LOW = 2;
+#define SFE_QWIIC_BUZZER_VOLUME_MID = 3;
+#define SFE_QWIIC_BUZZER_VOLUME_MAX = 4;
 
 class sfeQwiicBuzzer
 {