Merge pull request #34 from sparkfun/add_writeWord_writeBlock

Add writeWord writeBlock

Author: edspark

src/sfeTk/sfeTkIBus.h

@@ -87,14 +87,32 @@ class sfeTkIBus
 {
   public:
     /**--------------------------------------------------------------------------
-     *  @brief Write a single byte to the device*
+     *  @brief Send a single byte to the device*
      *  @param data Data to write.
      *
      *  @retval sfeTkError_t -  kSTkErrOk on successful execution.
      *
      */
     virtual sfeTkError_t writeByte(uint8_t data) = 0;
 
+    /**--------------------------------------------------------------------------
+     *  @brief Send a word to the device. 
+     *  @param data Data to write.
+     *
+     *  @retval sfeTkError_t -  kSTkErrOk on successful execution.
+     *
+     */
+    virtual sfeTkError_t writeWord(uint16_t data) = 0;
+
+    /**--------------------------------------------------------------------------
+     *  @brief Send an array of data to the device.
+     *  @param data Data to write.
+     *
+     *  @retval sfeTkError_t -  kSTkErrOk on successful execution.
+     *
+     */
+    virtual sfeTkError_t writeRegion(const uint8_t *data, size_t length) = 0;
+
     /**--------------------------------------------------------------------------
      *  @brief Write a single byte to the given register
      *

src/sfeTkArdI2C.cpp

@@ -22,6 +22,8 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
 
 #include "sfeTkArdI2C.h"
+#include <cstddef>
+#include <cstdint>
 
 //---------------------------------------------------------------------------------
 // init()
@@ -87,7 +89,7 @@ sfeTkError_t sfeTkArdI2C::ping()
 //---------------------------------------------------------------------------------
 // writeByte()
 //
-// Writes a single byte to the device.
+// Writes a single byte to the device, without indexing to a register.
 //
 // Returns true on success, false on failure
 //
@@ -102,6 +104,33 @@ sfeTkError_t sfeTkArdI2C::writeByte(uint8_t dataToWrite)
     return _i2cPort->endTransmission() == 0 ? kSTkErrOk : kSTkErrFail;
 }
 
+//---------------------------------------------------------------------------------
+// writeWord()
+//
+// Writes a word to the device, without indexing to a register.
+//
+// Returns true on success, false on failure
+//
+sfeTkError_t sfeTkArdI2C::writeWord(uint16_t dataToWrite)
+{
+    if (!_i2cPort)
+        return kSTkErrBusNotInit;
+
+    return writeRegion((uint8_t *)&dataToWrite, sizeof(uint16_t));
+}
+
+//---------------------------------------------------------------------------------
+// writeRegion()
+//
+// Writes a word to the device, without indexing to a register.
+//
+// Returns true on success, false on failure
+//
+sfeTkError_t sfeTkArdI2C::writeRegion(const uint8_t *data, size_t length)
+{
+    return writeRegisterRegionAddress(nullptr, 0, data, length) == 0 ? kSTkErrOk : kSTkErrFail;
+}
+
 //---------------------------------------------------------------------------------
 // writeRegisterByte()
 //
@@ -152,7 +181,10 @@ sfeTkError_t sfeTkArdI2C::writeRegisterRegionAddress(uint8_t *devReg, size_t reg
         return kSTkErrBusNotInit;
 
     _i2cPort->beginTransmission(address());
-    _i2cPort->write(devReg, regLength);
+
+    if(devReg != nullptr && regLength > 0)
+        _i2cPort->write(devReg, regLength);
+
     _i2cPort->write(data, (int)length);
 
     return _i2cPort->endTransmission() ? kSTkErrFail : kSTkErrOk;
@@ -183,7 +215,7 @@ sfeTkError_t sfeTkArdI2C::writeRegister16Region(uint16_t devReg, const uint8_t *
     return writeRegisterRegionAddress((uint8_t *)&devReg, 2, data, length);
 }
 
-//---------------------------------------------------------------------------------
+
 
 /**
  * @brief Reads an array of bytes to a register on the target address. Supports any address size

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 writeRegion(const uint8_t *data, size_t length);
+
     /**
         @brief Write a single byte to the given register
         @note sfeTkIBus interface method

src/sfeTkArdSPI.cpp

@@ -82,7 +82,7 @@ sfeTkError_t sfeTkArdSPI::init(bool bInit)
 }
 
 //---------------------------------------------------------------------------------
-// writeRegisterByte()
+// writeByte()
 //
 // Writes a single byte to the device.
 //
@@ -108,6 +108,46 @@ sfeTkError_t sfeTkArdSPI::writeByte(uint8_t dataToWrite)
     return kSTkErrOk;
 }
 
+//---------------------------------------------------------------------------------
+// writeWord()
+//
+// Writes a word to the device without indexing to a register.
+//
+// Returns kSTkErrOk on success
+//
+sfeTkError_t sfeTkArdSPI::writeWord(uint16_t dataToWrite)
+{
+    return writeRegion((uint8_t *)&dataToWrite, sizeof(uint8_t)) > 0;
+}
+
+
+//---------------------------------------------------------------------------------
+// writeRegion()
+//
+// Writes an array of data to the device without indexing to a register.
+//
+// Returns kSTkErrOk on success
+//
+sfeTkError_t sfeTkArdSPI::writeRegion(const uint8_t *dataToWrite, size_t length)
+{
+
+    if (!_spiPort)
+        return kSTkErrBusNotInit;
+
+    _spiPort->beginTransaction(_sfeSPISettings);
+    // Signal communication start
+    digitalWrite(cs(), LOW);
+
+    for (size_t i = 0; i < length; i++)
+        _spiPort->transfer(*dataToWrite++);
+
+    // End communication
+    digitalWrite(cs(), HIGH);
+    _spiPort->endTransaction();
+
+    return kSTkErrOk;
+}
+
 //---------------------------------------------------------------------------------
 // writeRegisterByte()
 //
@@ -164,6 +204,7 @@ sfeTkError_t sfeTkArdSPI::writeRegisterRegion(uint8_t devReg, const uint8_t *dat
 
     // Signal communication start
     digitalWrite(cs(), LOW);
+
     _spiPort->transfer(devReg);
 
     for (size_t i = 0; i < length; i++)
@@ -278,4 +319,4 @@ sfeTkError_t sfeTkArdSPI::readRegister16Region(uint16_t devReg, uint8_t *data, s
     readBytes = numBytes;
 
     return kSTkErrOk;
-}
+}

src/sfeTkArdSPI.h

@@ -115,6 +115,25 @@ class sfeTkArdSPI : public sfeTkISPI
     */
     sfeTkError_t writeByte(uint8_t data);
 
+    /**
+        @brief Write a word to the device without indexing to a register.
+
+        @param data Data to write.
+
+        @retval sfeTkError_t - kSTkErrOk on success
+    */
+    sfeTkError_t writeWord(uint16_t data);
+
+    /**
+        @brief Write an array of data to the device without indexing to a register.
+
+        @param data Data to write
+        @param length Length of Data
+
+        @retval sfeTkError_t - kSTkErrOk on success
+    */
+    sfeTkError_t writeRegion(const uint8_t *data, size_t length);
+
     /**
         @brief Write a single byte to the given register