refactor of design

Author: gigapod

src/SparkFun_Toolkit.h

@@ -29,5 +29,5 @@ SOFTWARE.
 
 // Just include the toolkit headers
 
-#include "sfeTkBusI2C.h"
-#include "sfeTkBusSPI.h"
+#include "sfeTkArdI2C.h"
+#include "sfeTkArdSPI.h"

src/sfeTk/sfeTkIBus.h

@@ -27,26 +27,26 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 #include <cstdint>
 
-class sfeTkBus
+class sfeTkIBus
 {
   public:
+    /// @brief Write a single byte to the given register
     ///
-    /// @brief A simple ping of the device at the given address.
-    /// @param devAddr Address/Pin of the device
+    /// @param devReg The device's register's address.
+    /// @param data Data to write.
     ///
-    /// @retval bool - true on success, false on failure
+    /// @retval bool -  true on successful execution.
     ///
-    virtual bool ping(uint8_t devAddr) = 0;
+    virtual bool writeRegisterByte(uint8_t devReg, uint8_t data) = 0;
 
-    /// @brief Write a single byte to the given register
+    /// @brief Write a single word (16 bit) to the given register
     ///
-    /// @param devAddr The device's address/pin -- depending on implementation
     /// @param devReg The device's register's address.
     /// @param data Data to write.
     ///
     /// @retval bool -  true on successful execution.
     ///
-    virtual bool writeRegisterByte(uint8_t devAddr, uint8_t devReg, uint8_t data) = 0;
+    virtual bool writeRegisterWord(uint8_t devReg, uint16_t data) = 0;
 
     /// @brief Writes a number of bytes starting at the given register's address.
     ///
@@ -56,7 +56,25 @@ class sfeTkBus
     ///
     /// @retval int returns the number of bytes written, < 0 on error
     ///
-    virtual int writeRegisterRegion(uint8_t devAddr, uint8_t devReg, const uint8_t *data, uint16_t length) = 0;
+    virtual int writeRegisterRegion(uint8_t devReg, const uint8_t *data, uint16_t length) = 0;
+
+    /// @brief Read a single byte from the given register
+    ///
+    /// @param devReg The device's register's address.
+    /// @param data Data to read.
+    ///
+    /// @retval bool -  true on successful execution.
+    ///
+    virtual bool readRegisterByte(uint8_t devReg, uint8_t &data) = 0;
+
+    /// @brief Read a single word (16 bit) from the given register
+    ///
+    /// @param devReg The device's register's address.
+    /// @param data Data to read.
+    ///
+    /// @retval bool -  true on successful execution.
+    ///
+    virtual bool readRegisterWord(uint8_t devReg, uint16_t &data) = 0;
 
     /// @brief Reads a block of data from the given register.
     ///
@@ -66,7 +84,7 @@ class sfeTkBus
     ///
     /// @retval int returns 0 on success, or error code
     ///
-    virtual int readRegisterRegion(uint8_t addr, uint8_t reg, uint8_t *data, uint16_t numBytes) = 0;
+    virtual int readRegisterRegion(uint8_t reg, uint8_t *data, uint16_t numBytes) = 0;
 };
 
 //};

src/sfeTk/sfeTkII2C.h

@@ -0,0 +1,71 @@
+
+// sfeTkII2C.h
+//
+// Defines the I2C communication bus interface for the SparkFun Electronics Toolkit
+/*
+
+The MIT License (MIT)
+
+Copyright (c) 2022 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.
+*/
+
+#pragma once
+
+#include "sfeTkIBus.h"
+
+class sfeTkI2C : public sfeTkIBus
+{
+  public:
+    sfeTkI2C() : _address{kNoAddress}
+    {
+    }
+    sfeTkI2C(uint8_t addr) : _address{addr}
+    {
+    }
+
+    ///
+    /// @brief A simple ping of the device at the set address
+    ///
+    /// @retval bool - true on success, false on failure
+    ///
+    virtual bool ping() = 0;
+
+    /// @brief setter for the I2C address
+    ///
+    /// @param devAddr The device's address
+    ///
+    virtual void setAddress(uint8_t devAddr)
+    {
+        _address = devAddr;
+    }
+
+    /// @brief getter for the I2C address
+    ///
+    /// @retval uint8_t returns the address for the device
+    ///
+    virtual uint8_t address(void)
+    {
+        return _address;
+    }
+
+    static constexpr uint8_t kNoAddress = 0;
+
+  private:
+    uint8_t _address;
+};
+
+//};

src/sfeTk/sfeTkISPI.h

@@ -0,0 +1,61 @@
+
+// sfeTkISPI.h
+//
+// Defines the SPI communication bus interface for the SparkFun Electronics Toolkit
+/*
+
+The MIT License (MIT)
+
+Copyright (c) 2022 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.
+*/
+
+#pragma once
+
+#include "sfeTkIBus.h"
+
+class sfeTkSPI : public sfeTkIBus
+{
+  public:
+    sfeTkI2C() : _csPin{kNoCSPin}
+    {
+    }
+
+    /// @brief setter for the CS Pin
+    ///
+    /// @param devCS The device's CS Pin
+    ///
+    virtual void setCS(uint8_t devCS)
+    {
+        _cs = devCS;
+    }
+
+    /// @brief getter for the cs pin
+    ///
+    /// @retval uint8_t returns the CS pin for the device
+    ///
+    virtual uint8_t cs(void)
+    {
+        return _cs;
+    }
+
+    static constexpr uint8_t kNoCSPin = 0;
+
+  private:
+    uint8_t _cs;
+};
+
+//};