naming patter refactor sfeTk to sfTk ...etc; not tested

Author: gigapod

src/SparkFun_Toolkit.h

@@ -31,6 +31,6 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 // Arduino Libraries.
 
 // Just include the toolkit headers
-#include "sfeTkArdI2C.h"
-#include "sfeTkArdSPI.h"
-#include "sfeTkArduino.h"
+#include "sfTkArdI2C.h"
+#include "sfTkArdSPI.h"
+#include "sfTkArduino.h"

src/sfeTk/sfeTkError.h renamed to src/sfTk/sfTkError.h

@@ -45,20 +45,20 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  *    subsystem header files.
  *
  */
-typedef int32_t sfeTkError_t;
+typedef int32_t sfTkError_t;
 
 // General errors
 
 /**
  * @brief General error code for a failure. Note all errors are negative.
  */
-const sfeTkError_t kSTkErrFail = -1; // general fail
+const sfTkError_t ksfkErrFail = -1; // general fail
 /**
  * @brief The error code value for success. This is always 0.
  */
-const sfeTkError_t kSTkErrOk = 0; // success
+const sfTkError_t ksfTkErrOk = 0; // success
 
 /**
  * @brief A base value for bus errors. All bus errors are greater than this value, in the 1000 range
  */
-const sfeTkError_t kSTkErrBaseBus = 0x1000;
+const sfTkError_t ksfTkErrBaseBus = 0x1000;

src/sfeTk/sfeTkIBus.h renamed to src/sfTk/sfTkIBus.h

@@ -1,7 +1,7 @@
 
-// sfeTkIBus.h
+// sfTkIBus.h
 //
-// Defines the communication bus interface for the SparkFun Electronics Toolkit -> sfeTk
+// Defines the communication bus interface for the SparkFun Electronics Toolkit -> sfTk
 /*
 
 The MIT License (MIT)
@@ -27,7 +27,7 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 #pragma once
 
-#include "sfeToolkit.h"
+#include "sfToolkit.h"
 #include <stddef.h>
 
 /**
@@ -39,42 +39,42 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 /**
  * @brief Error code for when a bus system is not initalized.
  */
-const sfeTkError_t kSTkErrBusNotInit = kSTkErrFail * (kSTkErrBaseBus + 1);
+const sfTkError_t ksfTkErrBusNotInit = ksfTkErrFail * (ksfTkErrBaseBus + 1);
 
 /**
  * @brief Returned when a bus system times out.
  */
-const sfeTkError_t kSTkErrBusTimeout = kSTkErrFail * (kSTkErrBaseBus + 2);
+const sfTkError_t ksfTkErrBusTimeout = ksfTkErrFail * (ksfTkErrBaseBus + 2);
 
 /**
  * @brief Returned when a bus system does not respond.
  */
-const sfeTkError_t kSTkErrBusNoResponse = kSTkErrFail * (kSTkErrBaseBus + 3);
+const sfTkError_t ksfTkErrBusNoResponse = ksfTkErrFail * (ksfTkErrBaseBus + 3);
 
 /**
  * @brief Returned when the data to be sent is too long or received is too short.
  */
-const sfeTkError_t kSTkErrBusDataTooLong = kSTkErrFail * (kSTkErrBaseBus + 4);
+const sfTkError_t ksfTkErrBusDataTooLong = ksfTkErrFail * (ksfTkErrBaseBus + 4);
 
 /**
  * @brief Returned when the bus settings are null, invalid or on set/initialised
  */
-const sfeTkError_t kSTkErrBusNullSettings = kSTkErrFail * (kSTkErrBaseBus + 5);
+const sfTkError_t ksfTkErrBusNullSettings = ksfTkErrFail * (ksfTkErrBaseBus + 5);
 
 /**
  * @brief Returned when the buffer is null or invalid.
  */
-const sfeTkError_t kSTkErrBusNullBuffer = kSTkErrFail * (kSTkErrBaseBus + 6);
+const sfTkError_t ksfTkErrBusNullBuffer = ksfTkErrFail * (ksfTkErrBaseBus + 6);
 
 /**
  * @brief Returned when the bus is under read. Warning
  */
-const sfeTkError_t kSTkErrBusUnderRead = kSTkErrBaseBus + 7;
+const sfTkError_t ksfTkErrBusUnderRead = ksfTkErrBaseBus + 7;
 
 /**
  * @brief Returned when the bus is not enabled. Warning
  */
-const sfeTkError_t kSTkErrBusNotEnabled = kSTkErrBaseBus + 8;
+const sfTkError_t ksfTkErrBusNotEnabled = ksfTkErrBaseBus + 8;
 
 /**
  * @brief Interface that defines the communication bus for the SparkFun Electronics Toolkit.
@@ -83,56 +83,56 @@ const sfeTkError_t kSTkErrBusNotEnabled = kSTkErrBaseBus + 8;
  * bus implementations will extend this interface to provide the necessary functionality for the
  * desired bus type.
  */
-class sfeTkIBus
+class sfTkIBus
 {
   public:
     /**
      * @brief Constructor
      */
-    sfeTkIBus() {
+    sfTkIBus() {
         _byteOrder = sftk_system_byteorder();
     }
     /**--------------------------------------------------------------------------
      *  @brief Send a single byte to the device*
      *  @param data Data to write.
      *
-     *  @retval sfeTkError_t -  kSTkErrOk on successful execution.
+     *  @retval sfTkError_t -  ksfTkErrOk on successful execution.
      *
      */
-    virtual sfeTkError_t writeByte(uint8_t data) = 0;
+    virtual sfTkError_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.
+     *  @retval sfTkError_t -  ksfTkErrOk on successful execution.
      *
      */
-    virtual sfeTkError_t writeWord(uint16_t data) = 0;
+    virtual sfTkError_t writeWord(uint16_t data) = 0;
 
     /**--------------------------------------------------------------------------
      *  @brief Send an array of data to the device.
      *  @param data Data to write.
      *  @param length - length of data.
      *
-     *  @retval sfeTkError_t -  kSTkErrOk on successful execution.
+     *  @retval sfTkError_t -  ksfTkErrOk on successful execution.
      *
      */
-    virtual sfeTkError_t writeRegion(const uint8_t *data, size_t length) = 0;
+    virtual sfTkError_t writeRegion(const uint8_t *data, size_t length) = 0;
 
     /**--------------------------------------------------------------------------
      *  @brief Write a single byte to the given register
      *
      *   @param devReg The device's register's address.
      *   @param data Data to write.
      *
-     *   @retval sfeTkError_t -  kSTkErrOk on successful execution.
+     *   @retval sfTkError_t -  ksfTkErrOk on successful execution.
      *
      */
-    virtual sfeTkError_t writeRegisterByte(uint8_t devReg, uint8_t data) = 0;
+    virtual sfTkError_t writeRegisterByte(uint8_t devReg, uint8_t data) = 0;
 
     // Overload version
-    sfeTkError_t writeRegister(uint8_t devReg, uint8_t data)
+    sfTkError_t writeRegister(uint8_t devReg, uint8_t data)
     {
         return writeRegisterByte(devReg, data);
     }
@@ -143,13 +143,13 @@ class sfeTkIBus
      *   @param devReg The device's register's address.
      *   @param data Data to write.
      *
-     *   @retval sfeTkError_t -  kSTkErrOk on successful execution.
+     *   @retval sfTkError_t -  ksfTkErrOk on successful execution.
      *
      */
-    virtual sfeTkError_t writeRegisterWord(uint8_t devReg, uint16_t data) = 0;
+    virtual sfTkError_t writeRegisterWord(uint8_t devReg, uint16_t data) = 0;
 
     // Overload version
-    sfeTkError_t writeRegister(uint8_t devReg, uint16_t data)
+    sfTkError_t writeRegister(uint8_t devReg, uint16_t data)
     {
         return writeRegisterWord(devReg, data);
     }
@@ -161,13 +161,13 @@ class sfeTkIBus
      *  @param data Data to write.
      *  @param length - length of data
      *
-     *   @retval sfeTkError_t kSTkErrOk on successful execution
+     *   @retval sfTkError_t ksfTkErrOk on successful execution
      *
      */
-    virtual sfeTkError_t writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length) = 0;
+    virtual sfTkError_t writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length) = 0;
 
     // Overload version
-    sfeTkError_t writeRegister(uint8_t devReg, const uint8_t *data, size_t length)
+    sfTkError_t writeRegister(uint8_t devReg, const uint8_t *data, size_t length)
     {
         return writeRegisterRegion(devReg, data, length);
     }
@@ -179,13 +179,13 @@ class sfeTkIBus
      *  @param data Data to write.
      *  @param length - length of data
      *
-     *   @retval sfeTkError_t kSTkErrOk on successful execution
+     *   @retval sfTkError_t ksfTkErrOk on successful execution
      *
      */
-    virtual sfeTkError_t writeRegister16Region(uint16_t devReg, const uint8_t *data, size_t length) = 0;
+    virtual sfTkError_t writeRegister16Region(uint16_t devReg, const uint8_t *data, size_t length) = 0;
 
     // Overload version
-    sfeTkError_t writeRegister(uint16_t devReg, const uint8_t *data, size_t length)
+    sfTkError_t writeRegister(uint16_t devReg, const uint8_t *data, size_t length)
     {
         return writeRegister16Region(devReg, data, length);
     }
@@ -197,13 +197,13 @@ class sfeTkIBus
      *  @param data Data to write.
      *  @param length - length of data
      *
-     *   @retval sfeTkError_t kSTkErrOk on successful execution
+     *   @retval sfTkError_t ksfTkErrOk on successful execution
      *
      */
-    virtual sfeTkError_t writeRegister16Region16(uint16_t devReg, const uint16_t *data, size_t length) = 0;
+    virtual sfTkError_t writeRegister16Region16(uint16_t devReg, const uint16_t *data, size_t length) = 0;
 
     // Overload version
-    sfeTkError_t writeRegister(uint16_t devReg, const uint16_t *data, size_t length)
+    sfTkError_t writeRegister(uint16_t devReg, const uint16_t *data, size_t length)
     {
         return writeRegister16Region16(devReg, data, length);
     }
@@ -213,13 +213,13 @@ class sfeTkIBus
      *  @param devReg The device's register's address.
      *  @param data Data to read.
      *
-     *   @retval sfeTkError_t -  kSTkErrOk on successful execution.
+     *   @retval sfTkError_t -  ksfTkErrOk on successful execution.
      *
      */
-    virtual sfeTkError_t readRegisterByte(uint8_t devReg, uint8_t &data) = 0;
+    virtual sfTkError_t readRegisterByte(uint8_t devReg, uint8_t &data) = 0;
 
     // Overload version
-    sfeTkError_t readRegister(uint8_t devReg, uint8_t &data)
+    sfTkError_t readRegister(uint8_t devReg, uint8_t &data)
     {
         return readRegisterByte(devReg, data);
     }
@@ -230,12 +230,12 @@ class sfeTkIBus
      *   @param devReg The device's register's address.
      *   @param data Data to read.
      *
-     *   @retval sfeTkError_t -  kSTkErrOk on successful execution.
+     *   @retval sfTkError_t -  ksfTkErrOk on successful execution.
      */
-    virtual sfeTkError_t readRegisterWord(uint8_t devReg, uint16_t &data) = 0;
+    virtual sfTkError_t readRegisterWord(uint8_t devReg, uint16_t &data) = 0;
 
     // Overload version
-    sfeTkError_t readRegister(uint8_t devReg, uint16_t &data)
+    sfTkError_t readRegister(uint8_t devReg, uint16_t &data)
     {
         return readRegisterWord(devReg, data);
     }
@@ -248,13 +248,13 @@ class sfeTkIBus
      *   @param numBytes - length of data
      *   @param[out] readBytes - number of bytes read
      *
-     *   @retval int returns kSTkErrOk on success, or kSTkErrFail code
+     *   @retval int returns ksfTkErrOk on success, or ksfTkErrFail code
      *
      */
-    virtual sfeTkError_t readRegisterRegion(uint8_t reg, uint8_t *data, size_t numBytes, size_t &readBytes) = 0;
+    virtual sfTkError_t readRegisterRegion(uint8_t reg, uint8_t *data, size_t numBytes, size_t &readBytes) = 0;
 
     // Overload version
-    sfeTkError_t readRegister(uint8_t reg, uint8_t *data, size_t numBytes, size_t &readBytes)
+    sfTkError_t readRegister(uint8_t reg, uint8_t *data, size_t numBytes, size_t &readBytes)
     {
         return readRegisterRegion(reg, data, numBytes, readBytes);
     }
@@ -267,13 +267,13 @@ class sfeTkIBus
      *   @param numBytes - length of data
      *   @param[out] readBytes - number of bytes read
      *
-     *   @retval int returns kSTkErrOk on success, or kSTkErrFail code
+     *   @retval int returns ksfTkErrOk on success, or ksfTkErrFail code
      *
      */
-    virtual sfeTkError_t readRegister16Region(uint16_t reg, uint8_t *data, size_t numBytes, size_t &readBytes) = 0;
+    virtual sfTkError_t readRegister16Region(uint16_t reg, uint8_t *data, size_t numBytes, size_t &readBytes) = 0;
 
     // Overload version
-    sfeTkError_t readRegister(uint16_t reg, uint8_t *data, size_t numBytes, size_t &readBytes)
+    sfTkError_t readRegister(uint16_t reg, uint8_t *data, size_t numBytes, size_t &readBytes)
     {
         return readRegister16Region(reg, data, numBytes, readBytes);
     }
@@ -285,13 +285,13 @@ class sfeTkIBus
      *   @param numBytes - length of data
      *   @param[out] readBytes - number of bytes read
      *
-     *   @retval int returns kSTkErrOk on success, or kSTkErrFail code
+     *   @retval int returns ksfTkErrOk on success, or ksfTkErrFail code
      *
      */
-    virtual sfeTkError_t readRegister16Region16(uint16_t reg, uint16_t *data, size_t numBytes, size_t &readBytes) = 0;
+    virtual sfTkError_t readRegister16Region16(uint16_t reg, uint16_t *data, size_t numBytes, size_t &readBytes) = 0;
 
     // Overload version
-    sfeTkError_t readRegister(uint16_t reg, uint16_t *data, size_t numBytes, size_t &readBytes)
+    sfTkError_t readRegister(uint16_t reg, uint16_t *data, size_t numBytes, size_t &readBytes)
     {
         return readRegister16Region16(reg, data, numBytes, readBytes);
     }
@@ -306,7 +306,7 @@ class sfeTkIBus
      * @param order The byte order to set - set to either SFTK_MSBFIRST or SFTK_LSBFIRST. The default is SFTK_LSBFIRST
      *
      */
-    void setByteOrder(sfeTKByteOrder order)
+    void setByteOrder(sfTkByteOrder order)
     {
         _byteOrder = order;
     }
@@ -316,13 +316,13 @@ class sfeTkIBus
      *
      * @retval The current byte order
      */
-    sfeTKByteOrder byteOrder(void)
+    sfTkByteOrder byteOrder(void)
     {
         return _byteOrder;
     }
 
   protected:
     /** flag to manage byte swapping */
-    sfeTKByteOrder _byteOrder;
+    sfTkByteOrder _byteOrder;
 };