cleanup, re-org of byte order logic -move helpers into a namespace, made Arduino like consts for order types

Author: gigapod

src/SparkFun_Toolkit.h

@@ -31,7 +31,6 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 // Arduino Libraries.
 
 // Just include the toolkit headers
-
-#include <sfeTk/sfeToolkit.h>
 #include "sfeTkArdI2C.h"
-#include "sfeTkArdSPI.h"
+#include "sfeTkArdSPI.h"
+#include "sfeTkArduino.h"

src/sfeTk/sfeToolkit.cpp

@@ -23,13 +23,13 @@ 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 "sfeToolkit.h"
-#include <stdint.h>
+#include <cstdint>
 
 /**
  * @brief C function - Runtime check for system byte order
  */
-sfeTKByteOrder_t systemByteOrder(void)
+sfeTKByteOrder sfeToolkit::systemByteOrder(void)
 {
     uint16_t i = 1;
-    return *((uint8_t *)&i) == 0 ? SFETK_BIG_ENDIAN : SFETK_LITTLE_ENDIAN;
+    return *((uint8_t *)&i) == 0 ? sfeTKByteOrder::BigEndian : sfeTKByteOrder::LittleEndian;
 }

src/sfeTk/sfeToolkit.h

@@ -31,22 +31,18 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
 #include "sfeTkError.h"
 
-/**
-    @brief The byte order of the system
-*/
-typedef enum
+// byte order types/enum
+enum class sfeTKByteOrder : uint8_t
 {
-    SFETK_BIG_ENDIAN = 0x01,
-    SFETK_LITTLE_ENDIAN = 0x00
-} sfeTKByteOrder_t;
+    BigEndian = 0x01,
+    LittleEndian = 0x02
+};
 
-// Export our byte order function as a C function
-#ifdef __cplusplus
-extern "C"
+// Use a namespace for the toolkit "utilities and helpers"
+namespace sfeToolkit
 {
-#endif
-    // Runtime check for system byte order
-    sfeTKByteOrder_t systemByteOrder(void);
-#ifdef __cplusplus
-}
-#endif
+
+// Function to determine the byte order of the system
+sfeTKByteOrder systemByteOrder(void);
+
+}; // namespace sfeToolkit

src/sfeTkArdI2C.cpp

@@ -223,7 +223,7 @@ sfeTkError_t sfeTkArdI2C::writeRegister16Region(uint16_t devReg, const uint8_t *
 sfeTkError_t sfeTkArdI2C::writeRegister16Region16(uint16_t devReg, const uint16_t *data, size_t length)
 {
     // if the system byte order is the same as the desired order, just send the buffer
-    if (systemByteOrder() == _byteOrder)
+    if (sfeToolkit::systemByteOrder() == _byteOrder)
         return writeRegisterRegionAddress((uint8_t *)&devReg, 2, (uint8_t *)data, length * 2);
 
     // okay, we need to swap
@@ -389,13 +389,13 @@ sfeTkError_t sfeTkArdI2C::readRegister16Region(uint16_t devReg, uint8_t *data, s
 sfeTkError_t sfeTkArdI2C::readRegister16Region16(uint16_t devReg, uint16_t *data, size_t numBytes, size_t &readBytes)
 {
     // if the system byte order is the same as the desired order, flip the address
-    if (systemByteOrder() != _byteOrder)
+    if (sfeToolkit::systemByteOrder() != _byteOrder)
         devReg = ((devReg << 8) & 0xff00) | ((devReg >> 8) & 0x00ff);
 
     sfeTkError_t status = readRegisterRegionAnyAddress((uint8_t *)&devReg, 2, (uint8_t *)data, numBytes * 2, readBytes);
 
     // Do we need to flip the byte order?
-    if (status == kSTkErrOk && systemByteOrder() != _byteOrder)
+    if (status == kSTkErrOk && sfeToolkit::systemByteOrder() != _byteOrder)
     {
         for (size_t i = 0; i < numBytes; i++)
             data[i] = ((data[i] << 8) & 0xff00) | ((data[i] >> 8) & 0x00ff);

src/sfeTkArdI2C.h

@@ -31,6 +31,7 @@ over Inter-Integrated Circuit (I2C) in Arduino
 #include <Wire.h>
 
 // Include our platform I2C interface definition.
+#include "sfeTkArduino.h"
 #include <sfeTk/sfeTkII2C.h>
 
 /**
@@ -44,7 +45,7 @@ class sfeTkArdI2C : public sfeTkII2C
     @brief Constructor
     */
 
-    sfeTkArdI2C(void) : _i2cPort(nullptr), _bufferChunkSize{kDefaultBufferChunk}, _byteOrder{SFETK_LITTLE_ENDIAN}
+    sfeTkArdI2C(void) : _i2cPort(nullptr), _bufferChunkSize{kDefaultBufferChunk}, _byteOrder{SFTK_LSBFIRST}
     {
     }
     /**
@@ -295,8 +296,10 @@ class sfeTkArdI2C : public sfeTkII2C
     /**
      * @brief Set the byte order for multi-byte data transfers
      *
+     * @param order The byte order to set - set to either SFTK_MSBFIRST or SFTK_LSBFIRST. The default is SFTK_LSBFIRST
+     *
      */
-    void setByteOrder(sfeTKByteOrder_t order)
+    void setByteOrder(sfeTKByteOrder order)
     {
         _byteOrder = order;
     }
@@ -321,5 +324,5 @@ class sfeTkArdI2C : public sfeTkII2C
     size_t _bufferChunkSize;
 
     /** flag to manage byte swapping */
-    sfeTKByteOrder_t _byteOrder;
+    sfeTKByteOrder _byteOrder;
 };

src/sfeTkArdSPI.h

@@ -27,6 +27,7 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 #pragma once
 
+#include "sfeTkArduino.h"
 #include <SPI.h>
 #include <sfeTk/sfeTkISPI.h>
 

src/sfeTkArduino.h

@@ -0,0 +1,39 @@
+
+/*
+@brief sfeTkArduino.h
+
+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.
+
+*/
+
+#pragma once
+
+// Purpose:
+//
+// "Arduino-ized" value of toolkit values constants"
+
+// Just include the toolkit headers
+
+#include <sfeTk/sfeToolkit.h>
+
+// Arduino-ize our byte order types
+
+const sfeTKByteOrder SFTK_MSBFIRST = sfeTKByteOrder::BigEndian;
+const sfeTKByteOrder SFTK_LSBFIRST = sfeTKByteOrder::LittleEndian;