Fixes to comments and some formatting

Author: edspark

examples/Example1_BasicReadings/Example1_BasicReadings.ino

@@ -28,7 +28,7 @@ void setup()
 {
   // Start serial
   Serial.begin(115200);
-  Serial.println("Ultrasonic Distance Sensor Example 1 - Basic Distance Sensing");
+  Serial.println("Ultrasonic Distance Sensor Example 1 - Basic Readings");
 
   Wire.begin();
 

examples/Example4_ChangeAddress/Example4_ChangeAddress.ino

@@ -20,6 +20,8 @@
 QwiicUltrasonic myUltrasonic;
 // If you're using the older version of the Ultrasonic Distance
 // sensor, then uncomment the line below and comment out the line above.
+// You can check the version in copper by the "R" on the front of the board.
+// Newer versions are >v10 and older versions simply do not have a version number.
 //QwiicUltrasonic myUltrasonic(kQwiicUltrasonicFWOld);
 
 // Here we set the device address. Note that an older version of the Qwiic

src/sfeQwiicUltrasonic.cpp

@@ -19,9 +19,8 @@ sfeTkError_t sfeQwiicUltrasonic::begin(sfeTkII2C *theBus)
         return kSTkErrFail;
 
     // Check the device address
-    if(_fwVersion == kQwiicUltrasonicFWOld)
+    if (_fwVersion == kQwiicUltrasonicFWOld)
     {
-
         if (theBus->address() < kQwiicUltrasonicMinAddress || theBus->address() > kQwiicUltrasonicMaxAddress)
         {
             // An older version of the firmware used 0x00 as the default address.
@@ -70,7 +69,7 @@ sfeTkError_t sfeQwiicUltrasonic::changeAddress(uint8_t &address)
 
     sfeTkError_t err;
 
-    if(_fwVersion == kQwiicUltrasonicFWOld)
+    if (_fwVersion == kQwiicUltrasonicFWOld)
     {
         // Old firmware only supports a limited range of addresses.
         if (address < kQwiicUltrasonicMinAddress || address > kQwiicUltrasonicMaxAddress)
@@ -79,7 +78,7 @@ sfeTkError_t sfeQwiicUltrasonic::changeAddress(uint8_t &address)
         // Write the new address to the device. The first bit must be set to 1
         err = _theBus->writeByte(address | 0x80);
     }
-    else if(_fwVersion == kQwiicUltrasonicFWLatest)
+    else if (_fwVersion == kQwiicUltrasonicFWLatest)
     {
         size_t numBytes = 2;
         // Latest firmware versions supports all of the available I2C addresses.
@@ -90,13 +89,14 @@ sfeTkError_t sfeQwiicUltrasonic::changeAddress(uint8_t &address)
         address <<= 1;
         const uint8_t toWrite[2] = {kUltrasonicAddressChangeCommand, address};
 
-        //Write the new address to the device
+        // Write the new address to the device
         err = _theBus->writeRegion(toWrite, numBytes);
     }
-    else {
-        //There was some error setting the version in the constructor
-        //return an error.
-        return kSTkErrOk;
+    else
+    {
+        // There was some error setting the version in the constructor
+        // return an error.
+        return kSTkErrFail;
     }
 
     // Check whether the write was successful

src/sfeQwiicUltrasonic.h

@@ -12,12 +12,15 @@
 #pragma once
 
 #include "SparkFun_Toolkit.h"
+#include <cstdint>
 
 // Available I2C addresses of the Qwiic Ultrasonic
 const uint8_t kQwiicUltrasonicDefaultAddress = 0x2F;
 
-const uint8_t kQwiicUltrasonicFWLatest = 0x01;
-const uint8_t kQwiicUltrasonicFWOld = 0x10;
+// Firmware versions. The later hardware version is v10 and so the "latest" here
+// refers to that. The previous version is randomnly given the value v01.
+const uint8_t kQwiicUltrasonicFWLatest = 0x10;
+const uint8_t kQwiicUltrasonicFWOld = 0x01;
 
 // These addresses are the min and max (respectively) of valid I2C addresses that can
 // be used for the newest revision of the Qwiic Ultrasonic sensor.
@@ -35,15 +38,17 @@ class sfeQwiicUltrasonic
 {
   public:
     /// @brief Default constructor
+    ///
     sfeQwiicUltrasonic() : _theBus(nullptr), _fwVersion(kQwiicUltrasonicFWLatest)
     {
     }
 
-    /// @brief Default constructor
-   sfeQwiicUltrasonic(const uint8_t fwVersion) : _theBus(nullptr), _fwVersion(fwVersion)
-   {
-   }
-
+    /// @brief Alternate constructor
+    /// @param fwVersion Firmware version of the Qwiic Ultrasonic Sensor. If using an older version
+    ///         of the sensor, the list of available I2C addresses differs.
+    sfeQwiicUltrasonic(const uint8_t fwVersion) : _theBus(nullptr), _fwVersion(fwVersion)
+    {
+    }
 
     /// @brief Begins the Qwiic Ultrasonic sensor
     /// @param theBus I2C bus to use for communication