Firmware Version read example

Author: lewispg228

examples/Example_09_FirmwareVersion/Example_09_FirmwareVersion.ino

@@ -0,0 +1,71 @@
+/******************************************************************************
+  Example_09_FirmwareVersion
+
+  This example shows how to read the firmware version from the Qwiic Buzzer
+
+  By Pete Lewis @ SparkFun Electronics
+  December 2023
+
+  Based on code orginally written by Fischer Moseley @ SparkFun Electronics
+  Original Creation Date: June 28, 2019
+
+  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
+
+  Distributed as-is; no warranty is given.
+******************************************************************************/
+
+#include <SparkFun_Qwiic_Buzzer_Arduino_Library.h>
+QwiicBuzzer buzzer;
+
+// variables to store the firmware version (major and Minor), 
+// read back from the Qwiic Buzzer
+uint8_t firmwareVersionMajor;
+uint8_t firmwareVersionMinor;
+
+sfeTkError_t err; // used for checking for errors
+
+void setup() {
+  Serial.begin(115200);
+  Serial.println("Qwiic Buzzer Example_09_FirmwareVersion");
+  Wire.begin(); //Join I2C bus
+
+  //check if buzzer will connect over I2C
+  if (buzzer.begin() == false) {
+    Serial.println("Device did not connect! Freezing.");
+    while (1);
+  }
+  Serial.println("Buzzer connected.");
+
+  err = buzzer.firmwareVersionMajor(firmwareVersionMajor);
+
+  // Check whether the firmware read was successful
+  if (err != kSTkErrOk)
+  {
+    Serial.println("Could not read firmware version Major. Freezing.");
+    while (1);
+  }
+
+  err = buzzer.firmwareVersionMinor(firmwareVersionMinor);
+
+  // Check whether the firmware read was successful
+  if (err != kSTkErrOk)
+  {
+    Serial.println("Could not read firmware version Minor. Freezing.");
+    while (1);
+  }  
+  
+  Serial.println("Firmware Version read successfully!");
+
+  Serial.print("Firmware Version Major: ");
+  Serial.println(firmwareVersionMajor);
+  Serial.print("Firmware Version Minor: ");
+  Serial.println(firmwareVersionMinor);
+}
+
+void loop() {
+// do nothing here
+}

keywords.txt

@@ -14,6 +14,8 @@ begin						        KEYWORD2
 isConnected					        KEYWORD2
 setAddress   			            KEYWORD2
 address   			                KEYWORD2
+firmwareVersionMajor                KEYWORD2
+firmwareVersionMinor                KEYWORD2
 configureBuzzer   				    KEYWORD2
 on  					            KEYWORD2
 off   					            KEYWORD2

src/sfeQwiicBuzzer.cpp

@@ -63,6 +63,16 @@ sfeTkError_t sfeQwiicBuzzer::deviceId(uint8_t &deviceId)
     return _theBus->readRegisterByte(kSfeQwiicBuzzerRegId, deviceId);
 }
 
+sfeTkError_t sfeQwiicBuzzer::firmwareVersionMajor(uint8_t &versionMajor)
+{
+    return _theBus->readRegisterByte(kSfeQwiicBuzzerRegFirmwareMajor, versionMajor);
+}
+
+sfeTkError_t sfeQwiicBuzzer::firmwareVersionMinor(uint8_t &versionMinor)
+{
+    return _theBus->readRegisterByte(kSfeQwiicBuzzerRegFirmwareMinor, versionMinor);
+}
+
 sfeTkError_t sfeQwiicBuzzer::configureBuzzer(const uint16_t toneFrequency, const uint16_t duration, const uint8_t volume)
 {
     // All of the necessary configuration register address are in sequencial order

src/sfeQwiicBuzzer.h

@@ -62,6 +62,16 @@ class sfeQwiicBuzzer
         /// @return 0 for succuss, negative for errors, positive for warnings
         sfeTkError_t deviceId(uint8_t &deviceId);        
 
+        /// @brief Reads the Firmware Version Major of the Qwiic Buzzer
+        /// @param versionMajor Variable where the read results will be stored
+        /// @return 0 for succuss, negative for errors, positive for warnings
+        sfeTkError_t firmwareVersionMajor(uint8_t &versionMajor);      
+
+        /// @brief Reads the Firmware Version Minor of the Qwiic Buzzer
+        /// @param versionMinor Variable where the read results will be stored
+        /// @return 0 for succuss, negative for errors, positive for warnings
+        sfeTkError_t firmwareVersionMinor(uint8_t &versionMinor);                  
+
         /// @brief Configures the Qwiic Buzzer without causing the buzzer to buzz.
         /// This allows configuration in silence (before you may want to buzz).
         /// It is also useful in combination with saveSettings(), and then later