device ID

-deviceId will read device ID from qwiic buzzer
-also added in a check into the begin function

Author: lewispg228

keywords.txt

@@ -25,6 +25,7 @@ playSoundEffect                     KEYWORD2
 #########################################################
 
 SFE_QWIIC_BUZZER_DEFAULT_ADDRESS    LITERAL1
+SFE_QWIIC_BUZZER_DEVICE_ID          LITERAL1
 kSfeQwiicBuzzerRegId                LITERAL1
 kSfeQwiicBuzzerRegFirmwareMinor     LITERAL1
 kSfeQwiicBuzzerRegFirmwareMajor     LITERAL1

src/sfeQwiicBuzzer.cpp

@@ -32,8 +32,24 @@ sfeTkError_t sfeQwiicBuzzer::begin(sfeTkII2C *theBus)
     // Set bus pointer
     _theBus = theBus;
 
-    // Just check if the device is connected, no other setup is needed
-    return isConnected();
+    sfeTkError_t err;
+    err = isConnected();
+    // Check whether the ping was successful
+    if (err != kSTkErrOk)
+        return err;
+
+    uint8_t readDeviceId;
+    err = deviceId(readDeviceId);
+    // Check whether the read was successful
+    if (err != kSTkErrOk)
+        return err;
+
+    // check that device ID matches
+    if (readDeviceId != SFE_QWIIC_BUZZER_DEVICE_ID)
+        return kSTkErrFail;
+
+    // Done!
+    return kSTkErrOk;
 }
 
 sfeTkError_t sfeQwiicBuzzer::isConnected()
@@ -42,6 +58,11 @@ sfeTkError_t sfeQwiicBuzzer::isConnected()
     return _theBus->ping();
 }
 
+sfeTkError_t sfeQwiicBuzzer::deviceId(uint8_t &deviceId)
+{
+    return _theBus->readRegisterByte(kSfeQwiicBuzzerRegId, deviceId);
+}
+
 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

@@ -32,6 +32,7 @@
 #include "sfeQwiicBuzzerPitches.h"
 
 #define SFE_QWIIC_BUZZER_DEFAULT_ADDRESS 0x34
+#define SFE_QWIIC_BUZZER_DEVICE_ID 0x5E
 #define SFE_QWIIC_BUZZER_RESONANT_FREQUENCY 2730
 #define SFE_QWIIC_BUZZER_VOLUME_OFF 0
 #define SFE_QWIIC_BUZZER_VOLUME_MIN 1
@@ -56,6 +57,11 @@ class sfeQwiicBuzzer
         /// @return 0 for succuss, negative for errors, positive for warnings
         sfeTkError_t isConnected();
 
+        /// @brief Reads the Device ID of the Qwiic Buzzer
+        /// @param deviceId uint8_t variable where the read results will be stored
+        /// @return 0 for succuss, negative for errors, positive for warnings
+        sfeTkError_t deviceId(uint8_t &deviceId);        
+
         /// @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