Merge pull request #2 from sparkfun/dev_toolkit

Review

Author: lewispg228

examples/Example_01_Buzz/Example_01_Buzz.ino

@@ -8,11 +8,11 @@
   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
-  local, and you've found our code helpful, please buy us a round!
+  SparkFun code, firmware, and software is released under the MIT License.
+	Please see LICENSE.md for further details.
 
   Hardware Connections:
   Connect QWIIC cable from Arduino to Qwiic Buzzer
@@ -28,12 +28,12 @@ void setup() {
   Serial.println("Qwiic Buzzer Example_01_Buzz");
   Wire.begin(); //Join I2C bus
 
-  //check if buzzer will acknowledge over I2C
+  //check if buzzer will connect over I2C
   if (buzzer.begin() == false) {
-    Serial.println("Device did not acknowledge! Freezing.");
+    Serial.println("Device did not connect! Freezing.");
     while (1);
   }
-  Serial.println("Buzzer acknowledged.");
+  Serial.println("Buzzer connected.");
 }
 
 void loop() {

examples/Example_02_Buzz_Frequency/Example_02_Buzz_Frequency.ino

@@ -13,8 +13,8 @@
   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
-  local, and you've found our code helpful, please buy us a round!
+  SparkFun code, firmware, and software is released under the MIT License.
+	Please see LICENSE.md for further details.
 
   Hardware Connections:
   Connect QWIIC cable from Arduino to Qwiic Buzzer
@@ -30,22 +30,26 @@ void setup() {
   Serial.println("Qwiic Buzzer Example_02_Buzz_Frequency");
   Wire.begin(); //Join I2C bus
 
-  //check if buzzer will acknowledge over I2C
+  //check if buzzer will connect over I2C
   if (buzzer.begin() == false) {
-    Serial.println("Device did not acknowledge! Freezing.");
+    Serial.println("Device did not connect! Freezing.");
     while (1);
   }
-  Serial.println("Buzzer acknowledged.");
+  Serial.println("Buzzer connected.");
 }
 
 void loop() {
-  buzzer.on(2730); // resonant frequency is 2.73KHz
+  // Configure with desired settings
+  // Resonant frequency is 2.73KHz
+  buzzer.configureBuzzer(SFE_QWIIC_BUZZER_RESONANT_FREQUENCY); 
+  buzzer.on(); 
   delay(100);
 
   buzzer.off();
   delay(1000);
 
-  buzzer.on(1000); // try out 1KHz for fun
+  buzzer.configureBuzzer(1000); // set frequency to 1KHz
+  buzzer.on(); 
   delay(100);
 
   buzzer.off();

examples/Example_03_Buzz_Duration/Example_03_Buzz_Duration.ino

@@ -13,8 +13,8 @@
   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
-  local, and you've found our code helpful, please buy us a round!
+  SparkFun code, firmware, and software is released under the MIT License.
+	Please see LICENSE.md for further details.
 
   Hardware Connections:
   Connect QWIIC cable from Arduino to Qwiic Buzzer
@@ -30,19 +30,21 @@ void setup() {
   Serial.println("Qwiic Buzzer Example_03_Buzz_Duration");
   Wire.begin(); //Join I2C bus
 
-  //check if buzzer will acknowledge over I2C
+  //check if buzzer will connect over I2C
   if (buzzer.begin() == false) {
-    Serial.println("Device did not acknowledge! Freezing.");
+    Serial.println("Device did not connect! Freezing.");
     while (1);
   }
-  Serial.println("Buzzer acknowledged.");
+  Serial.println("Buzzer connected.");
 }
 
 void loop() {
-  buzzer.on(2730, 100); // frequency: 2.73KHz, duration: 100ms
+  buzzer.configureBuzzer(2730, 100); // frequency: 2.73KHz, duration: 100ms
+  buzzer.on();
   delay(1000);
 
-  buzzer.on(1000, 500); // frequency: 1K, duration: 500ms
+  buzzer.configureBuzzer(1000, 500); // frequency: 1K, duration: 500ms
+  buzzer.on();
   delay(1000);
 
   // Note, we dont' have to call buzzer.off(), because it will automatically turn

examples/Example_04_Buzz_Volume/Example_04_Buzz_Volume.ino

@@ -3,10 +3,10 @@
 
   This example shows how to control the buzzer to sound at different volumes.
 
-  Note, the "on()" function accepts three arguments, and you must send all three
+  Note, the "configureBuzzer()" function accepts three arguments, and you must send all three
   in order to access the volume control.
 
-  on(frequency, duration, volume);
+  configureBuzzer(frequency, duration, volume);
 
   It turns the buzzer on and off.
   Much like the classic "blink LED sketch" this will buzz
@@ -18,8 +18,8 @@
   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
-  local, and you've found our code helpful, please buy us a round!
+  SparkFun code, firmware, and software is released under the MIT License.
+	Please see LICENSE.md for further details.
 
   Hardware Connections:
   Connect QWIIC cable from Arduino to Qwiic Buzzer
@@ -35,29 +35,33 @@ void setup() {
   Serial.println("Qwiic Buzzer Example_04_Buzz_Volume");
   Wire.begin(); //Join I2C bus
 
-  //check if buzzer will acknowledge over I2C
+  //check if buzzer will connect over I2C
   if (buzzer.begin() == false) {
-    Serial.println("Device did not acknowledge! Freezing.");
+    Serial.println("Device did not connect! Freezing.");
     while (1);
   }
-  Serial.println("Buzzer acknowledged.");
+  Serial.println("Buzzer connected.");
 }
 
 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.configureBuzzer(2730, 100, SFE_QWIIC_BUZZER_VOLUME_MIN); // frequency: 2.73KHz, duration: 100ms, volume: MIN
+  buzzer.on();
   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.configureBuzzer(2730, 100, SFE_QWIIC_BUZZER_VOLUME_LOW); // frequency: 2.73KHz, duration: 100ms, volume: LOW
+  buzzer.on();
   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.configureBuzzer(2730, 100, SFE_QWIIC_BUZZER_VOLUME_MID); // frequency: 2.73KHz, duration: 100ms, volume: MID
+  buzzer.on();
   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.configureBuzzer(2730, 100, SFE_QWIIC_BUZZER_VOLUME_MAX); // frequency: 2.73KHz, duration: 100ms, volume: MAX
+  buzzer.on();
   delay(1000);
 
   // Note, we dont' have to use buzzer.off(), because it will automatically turn

examples/Example_05_ChangeI2CAddress/Example_05_ChangeI2CAddress.ino

@@ -5,8 +5,8 @@
   Fischer Moseley @ SparkFun Electronics
   Original Creation Date: July 30, 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!
+  SparkFun code, firmware, and software is released under the MIT License.
+	Please see LICENSE.md for further details.
 
   Hardware Connections:
   Attach the Qwiic Buzzer to your Redboard via Qwiic Cable
@@ -18,17 +18,20 @@
 #include <SparkFun_Qwiic_Buzzer_Arduino_Library.h>
 QwiicBuzzer buzzer;
 
+// The default address is 0x34, change this if your buzzer currently has a different address!
+uint8_t initialAddress = SFE_QWIIC_BUZZER_DEFAULT_ADDRESS;
+
 void setup() {
   Serial.begin(115200);
   Serial.println("Qwiic Buzzer example - I2C Address Change");
   Wire.begin(); //Join I2C bus
 
-  //check if device will acknowledge over I2C
-  if (buzzer.begin(0x5B) == false) {
-    Serial.println("Device did not acknowledge! Running scanner.");
+  //check if device will connect over I2C
+  if (buzzer.begin(initialAddress) == false) {
+    Serial.println("Device did not connect! Running scanner.");
   }
   else{
-    Serial.println("Device acknowledged!");
+    Serial.println("Device connected!");
 
     Serial.println();
     Serial.println("Enter a new I2C address for the Qwiic Buzzer to use!");
@@ -51,11 +54,11 @@ void setup() {
 
       if (success) {
         if (newAddress > 0x08 && newAddress < 0x77) {
-          Serial.println("Character recieved, and device address is valid!");
+          Serial.println("Character received, and device address is valid!");
           Serial.print("Attempting to set device address to 0x");
           Serial.println(newAddress, HEX);
 
-          if (buzzer.setI2Caddress(newAddress) == true) {
+          if (buzzer.setAddress(newAddress) == true) {
             Serial.println("Device address set succeeded!");
           }
 
@@ -66,16 +69,16 @@ void setup() {
           delay(100); //give the hardware time to do whatever configuration it needs to do
 
           if (buzzer.isConnected()) {
-            Serial.println("Device will acknowledge on new I2C address!");
+            Serial.println("Device will connect on new I2C address!");
           }
 
           else {
-            Serial.println("Device will not acknowledge on new I2C address.");
+            Serial.println("Device will not connect on new I2C address.");
           }
         }
 
         else {
-          Serial.println("Address out of range! Try an adress between 0x08 and 0x77");
+          Serial.println("Address out of range! Try an address between 0x08 and 0x77");
         }
       }
 
@@ -99,7 +102,7 @@ void loop() {
   for (address = 1; address < 127; address++ )
   {
     // The i2c_scanner uses the return value of
-    // the Write.endTransmisstion to see if
+    // the Write.endTransmission to see if
     // a device did acknowledge to the address.
     Wire.beginTransmission(address);
     error = Wire.endTransmission();

examples/Example_06_SaveSettings/Example_06_SaveSettings.ino

@@ -23,17 +23,17 @@
   Qwiic buzzer up. Then you can use the TRIGGER header to cause the buzzer to 
   buzz at your saved settings.
 
-  Note, the "on()" function accepts three arguments:
-  on(frequency, duration, volume);
+  Note, the "configureBuzzer()" function accepts three arguments:
+  configureBuzzer(frequency, duration, volume);
 
   By Pete Lewis @ SparkFun Electronics
   December 2023
 
   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
-  local, and you've found our code helpful, please buy us a round!
+  SparkFun code, firmware, and software is released under the MIT License.
+	Please see LICENSE.md for further details.
 
   Hardware Connections:
   Connect QWIIC cable from Arduino to Qwiic Buzzer
@@ -49,23 +49,24 @@ void setup() {
   Serial.println("Qwiic Buzzer Example_06_SaveSettings");
   Wire.begin(); //Join I2C bus
 
-  //check if buzzer will acknowledge over I2C
+  //check if buzzer will connect over I2C
   if (buzzer.begin() == false) {
-    Serial.println("Device did not acknowledge! Freezing.");
+    Serial.println("Device did not connect! Freezing.");
     while (1);
   }
-  Serial.println("Buzzer acknowledged.");
+  Serial.println("Buzzer connected.");
 
   Serial.println("Buzzing at 1K, volume 3");
 
   // Comment/Un-Comment the following "buzzer.on()" example lines to try different settings:
 
   // "MOMENTARY" SETUP
-  buzzer.on(1000, 0, 3); // frequency: 1KHz, duration: 0 (aka forever), volume: 3
+  buzzer.configureBuzzer(1000, 0, SFE_QWIIC_BUZZER_VOLUME_MID); // frequency: 1KHz, duration: 0 (aka forever), volume: MID
 
   // "ONE-SHOT" Setup (aka adding in a duration amount).
-  // buzzer.on(1000, 100, 3); // frequency: 1KHz, duration: 100ms, volume: 3
+  // buzzer.configureBuzzer(1000, 100, SFE_QWIIC_BUZZER_VOLUME_MID); // frequency: 1KHz, duration: 100ms, volume: MID
 
+  buzzer.on();
   delay(1000);
 
   Serial.println("Buzzer OFF");

examples/Example_07_Melody/Example_07_Melody.ino

@@ -6,11 +6,15 @@
   By Pete Lewis @ SparkFun Electronics
   December 2023
 
+  Based on original source code written by Tom Igeo in Jan 2010:
+  https://www.arduino.cc/en/Tutorial/BuiltInExamples/toneMelody
+  http://www.arduino.cc/en/Tutorial/Tone
+
   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
-  local, and you've found our code helpful, please buy us a round!
+  SparkFun code, firmware, and software is released under the MIT License.
+	Please see LICENSE.md for further details.
 
   Hardware Connections:
   Connect QWIIC cable from Arduino to Qwiic Buzzer
@@ -23,28 +27,32 @@ QwiicBuzzer buzzer;
 
 // notes in the melody:
 int melody[] = {
-  NOTE_C4, NOTE_G3, NOTE_G3, NOTE_A3, NOTE_G3, 0, NOTE_B3, NOTE_C4
+  SFE_QWIIC_BUZZER_NOTE_C4, 
+  SFE_QWIIC_BUZZER_NOTE_G3, 
+  SFE_QWIIC_BUZZER_NOTE_G3, 
+  SFE_QWIIC_BUZZER_NOTE_A3, 
+  SFE_QWIIC_BUZZER_NOTE_G3, 
+  SFE_QWIIC_BUZZER_NOTE_REST,  // silence (aka "rest")
+  SFE_QWIIC_BUZZER_NOTE_B3, 
+  SFE_QWIIC_BUZZER_NOTE_C4
 };
 
 // note durations: 4 = quarter note, 8 = eighth note, etc.:
 int noteDurations[] = {
   4, 8, 8, 4, 4, 4, 4, 4
 };
 
-#define BUZZER_VOLUME 4 // loudest!!
-//#define BUZZER_VOLUME 3 // pretty good volume for most things
-
 void setup() {
   Serial.begin(115200);
   Serial.println("Qwiic Buzzer Example_07_Buzz_Melody");
   Wire.begin(); //Join I2C bus
 
-  //check if buzzer will acknowledge over I2C
+  //check if buzzer will connect over I2C
   if (buzzer.begin() == false) {
-    Serial.println("Device did not acknowledge! Freezing.");
+    Serial.println("Device did not connect! Freezing.");
     while (1);
   }
-  Serial.println("Buzzer acknowledged.");
+  Serial.println("Buzzer connected.");
 
   Serial.println("Buzzing Melody now...");
   play_melody();
@@ -63,13 +71,12 @@ void play_melody()
     // to calculate the note duration, take one second divided by the note type.
     //e.g. quarter note = 1000 / 4, eighth note = 1000/8, etc.
     int noteDuration = 1000 / noteDurations[thisNote];
-    buzzer.on(melody[thisNote], noteDuration, BUZZER_VOLUME);
+    buzzer.configureBuzzer(melody[thisNote], noteDuration, SFE_QWIIC_BUZZER_VOLUME_MAX);
+    buzzer.on();
 
     // to distinguish the notes, set a minimum time between them.
     // the note's duration + 30% seems to work well:
     int pauseBetweenNotes = noteDuration * 1.30;
     delay(pauseBetweenNotes);
-    // stop the tone playing:
-    buzzer.off();
   }
 }