Uses the new writeBlock method, changes type for changeAddress function so that I can shift the address within

Author: edspark

examples/Example3_ChangeAddress/Example3_ChangeAddress.ino

@@ -25,7 +25,9 @@ QwiicUltrasonic myUltrasonic;
 // Example 2 to change the address to the new default.
 uint8_t deviceAddress = kQwiicUltrasonicDefaultAddress; // 0x2F
 // uint8_t deviceAddress = 0x00;
-const uint8_t NEW_ADDR = 0x1E;
+
+// New addres is 7-bit unshifted.
+uint8_t NEW_ADDR = 0x1E;
 
 void setup()
 {

src/sfeQwiicUltrasonic.cpp

@@ -1,9 +1,9 @@
-/* SparkFun Ulrasonic Distance Sensor 
- * 
- * Product: 
+/* SparkFun Ulrasonic Distance Sensor
+ *
+ * Product:
  *  *  SparkFun Qwiic Ultrasonic Distance Sensor - HC-SR04 (SEN-1XXXX)
  *  *  https://www.sparkfun.com/1XXXX
- * 
+ *
  * SPDX-License-Identifier: MIT
  *
  * Copyright (c) 2024 SparkFun Electronics
@@ -80,16 +80,20 @@ sfeTkError_t sfeQwiicUltrasonic::getTriggeredDistance(uint16_t &distance)
     return kSTkErrOk;
 }
 
-sfeTkError_t sfeQwiicUltrasonic::changeAddress(const uint8_t &address)
+sfeTkError_t sfeQwiicUltrasonic::changeAddress(uint8_t &address)
 {
     // Check whether the address is valid
     sfeTkError_t err;
+    size_t numBytes = 2;
+    address <<= 1;
+    const uint8_t toWrite[2] = {kUltrasonicAddressChangeCommand, address};
 
     if (address < kQwiicUltrasonicMinAddress || address > kQwiicUltrasonicMaxAddress)
         return kSTkErrFail;
 
     // Write the new address to the device. The first bit must be set to 1
-    err = _theBus->writeRegisterByte(kUltrasonicAddressChangeCommand, (address<< 1));
+    // err = _theBus->writeRegisterByte(kUltrasonicAddressChangeCommand, (address<< 1));
+    err = _theBus->writeBlock(toWrite, numBytes);
 
     // Check whether the write was successful
     if (err != kSTkErrOk)

src/sfeQwiicUltrasonic.h

@@ -52,7 +52,7 @@ class sfeQwiicUltrasonic
     /// @brief Changes the I2C address of the Qwiic Ultrasonic sensor
     /// @param address New address, must be in the range 0x20 to 0x2F
     /// @return 0 for succuss, negative for errors, positive for warnings
-    sfeTkError_t changeAddress(const uint8_t &address);
+    sfeTkError_t changeAddress(uint8_t &address);
 
     /// @brief Gets the current I2C address being used by the library for the Qwiic Ultrasonic sensor
     /// @return The current I2C address, 7-bit unshifted

src/sfeTk/sfeTkIBus.h

@@ -95,6 +95,24 @@ class sfeTkIBus
      */
     virtual sfeTkError_t writeByte(uint8_t data) = 0;
 
+    /**--------------------------------------------------------------------------
+     *  @brief Write a single byte to the device*
+     *  @param data Data to write.
+     *
+     *  @retval sfeTkError_t -  kSTkErrOk on successful execution.
+     *
+     */
+    virtual sfeTkError_t writeWord(uint16_t data) = 0;
+
+    /**--------------------------------------------------------------------------
+     *  @brief Write a single byte to the device*
+     *  @param data Data to write.
+     *
+     *  @retval sfeTkError_t -  kSTkErrOk on successful execution.
+     *
+     */
+    virtual sfeTkError_t writeBlock(const uint8_t *data, size_t length) = 0;
+
     /**--------------------------------------------------------------------------
      *  @brief Write a single byte to the given register
      *

src/sfeTkArdI2C.cpp

@@ -1,8 +1,28 @@
 /*
 sfeTkArdI2C.cpp
+The MIT License (MIT)
+
+Copyright (c) 2023 SparkFun Electronics
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions: The
+above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED
+"AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
+NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
 */
 
 #include "sfeTkArdI2C.h"
+#include <cstdint>
 
 //---------------------------------------------------------------------------------
 // init()
@@ -68,7 +88,7 @@ sfeTkError_t sfeTkArdI2C::ping()
 //---------------------------------------------------------------------------------
 // writeByte()
 //
-// Writes a single byte to the device.
+// Sends a single byte to the device.
 //
 // Returns true on success, false on failure
 //
@@ -83,6 +103,41 @@ sfeTkError_t sfeTkArdI2C::writeByte(uint8_t dataToWrite)
     return _i2cPort->endTransmission() == 0 ? kSTkErrOk : kSTkErrFail;
 }
 
+//---------------------------------------------------------------------------------
+// writeWord()
+//
+// Sends a word to the device.
+//
+// Returns true on success, false on failure
+//
+sfeTkError_t sfeTkArdI2C::writeWord(uint16_t dataToWrite)
+{
+    if (!_i2cPort)
+        return kSTkErrBusNotInit;
+
+    return writeBlock((uint8_t *)&dataToWrite, sizeof(uint16_t));
+}
+
+//---------------------------------------------------------------------------------
+// writeBlock()
+//
+// Sends an array of data to the device.
+//
+// Returns true on success, false on failure
+//
+sfeTkError_t sfeTkArdI2C::writeBlock(const uint8_t *data, size_t length)
+{
+    int nData = 0; 
+    if (!_i2cPort)
+        return kSTkErrBusNotInit;
+
+    // do the Arduino I2C work
+    _i2cPort->beginTransmission(address());
+    _i2cPort->write(data, (int)length);
+
+    return _i2cPort->endTransmission() == 0 ? kSTkErrOk : kSTkErrFail;
+}
+
 //---------------------------------------------------------------------------------
 // writeRegisterByte()
 //

src/sfeTkArdI2C.h

@@ -109,7 +109,7 @@ class sfeTkArdI2C : public sfeTkII2C
     sfeTkError_t ping();
 
     /**
-        @brief Write a single byte to the device
+        @brief Sends a single byte to the device
         @note sfeTkIBus interface method
 
         @param data Data to write.
@@ -118,6 +118,26 @@ class sfeTkArdI2C : public sfeTkII2C
     */
     sfeTkError_t writeByte(uint8_t data);
 
+    /**
+        @brief Sends a word to the device.
+        @note sfeTkIBus interface method
+
+        @param data Data to write.
+
+        @retval returns  kStkErrOk on success
+    */
+    sfeTkError_t writeWord(uint16_t data);
+
+    /**
+        @brief Sends a block of data to the device.
+        @note sfeTkIBus interface method
+
+        @param data Data to write.
+
+        @retval returns  kStkErrOk on success
+    */
+    sfeTkError_t writeBlock(const uint8_t *data, size_t length);
+
     /**
         @brief Write a single byte to the given register
         @note sfeTkIBus interface method