Make UARTConfig_t a member variable struct.

Author: SFE-Brudnerd

src/sfTk/sfTkIUART.h

@@ -28,7 +28,8 @@ typedef enum _sfTkUARTParity
     kUARTParitySpace        = 0x5ul
 } sfTkUARTParity_t;
 
-inline const char* parityToString(sfTkUARTParity_t parity) {
+inline const char* parityToString(sfTkUARTParity_t parity) 
+{
     static const char* parityArray[] = {"Even", "Odd", "None", "Mark", "Space"};
 
     // if the parity is out of bounds, return "Unknown"
@@ -46,7 +47,8 @@ typedef enum _sfTkUARTStopBits
     kUARTStopBitsTwo        = 0x30ul
 } sfTkUARTStopBits_t;
 
-inline const char* stopBitsToString(sfTkUARTStopBits_t stopBits) {
+inline const char* stopBitsToString(sfTkUARTStopBits_t stopBits) 
+{
     static const char* stopBitsArray[] = {"One", "OneAndHalf", "Two"};
 
     // Return "Unknown" if index is out of bounds (less than 0 or greater than 2)
@@ -65,7 +67,8 @@ typedef enum _sfTkUARTDataBits
     kUARTDataBitsEight      = 0x400ul,
 } sfTkUARTDataBits_t;
 
-inline const uint8_t dataBitsToValue(sfTkUARTDataBits_t dataBits) {
+inline const uint8_t dataBitsToValue(sfTkUARTDataBits_t dataBits) 
+{
     static const uint8_t dataBitsArray[] = {5, 6, 7, 8};
 
     // Check if data bits are within valid range
@@ -76,17 +79,17 @@ inline const uint8_t dataBitsToValue(sfTkUARTDataBits_t dataBits) {
     return dataBitsArray[(((uint16_t)dataBits) >> 8) - 1];
 }
 
-typedef struct _sfTkUARTConfig
-{
-    uint32_t baudRate;
-    sfTkUARTDataBits_t dataBits;
-    sfTkUARTParity_t parity;
-    sfTkUARTStopBits_t stopBits;
-} sfTkUARTConfig_t;
-
 class sfTkIUART : public sfTkISerial
 {
 public:
+
+    typedef struct _UARTConfig
+    {
+        uint32_t baudRate;
+        sfTkUARTDataBits_t dataBits;
+        sfTkUARTParity_t parity;
+        sfTkUARTStopBits_t stopBits;
+    } UARTConfig_t;
     /**
      * @brief Default constructor for the UART bus
      * 
@@ -101,7 +104,7 @@ class sfTkIUART : public sfTkISerial
      * 
      * @param config
      */
-    sfTkIUART(sfTkUARTConfig_t config) : _config(config)
+    sfTkIUART(UARTConfig_t config) : _config(config)
     {
     }
 
@@ -235,7 +238,7 @@ class sfTkIUART : public sfTkISerial
      * 
      * @return sfTkUARTConfig_t 
      */
-    virtual sfTkUARTConfig_t config(void) const
+    virtual UARTConfig_t config(void) const
     {
         return _config;
     }
@@ -266,5 +269,5 @@ class sfTkIUART : public sfTkISerial
 
 protected:
     /** The internal storage of the UART config */
-    sfTkUARTConfig_t _config;
+    UARTConfig_t _config;
 };

src/sfTkArdUART.cpp

@@ -20,7 +20,7 @@
 #include "sfTk/sfTkISerial.h"
 #include "sfTk/sfTkIUART.h"
 
-sfTkError_t sfTkArdUART::init(arduino::HardwareSerial &hwSerial, sfTkUARTConfig_t config, bool bInit)
+sfTkError_t sfTkArdUART::init(arduino::HardwareSerial &hwSerial, sfTkIUART::UARTConfig_t config, bool bInit)
 {
     _hwSerial = &hwSerial; // set the serial port
 
@@ -54,7 +54,7 @@ sfTkError_t sfTkArdUART::init(uint32_t baudRate, bool bInit)
     return setBaudRate(baudRate); // set the baud rate
 }
 
-sfTkError_t sfTkArdUART::init(sfTkUARTConfig_t config, bool bInit)
+sfTkError_t sfTkArdUART::init(sfTkIUART::UARTConfig_t config, bool bInit)
 {
     // if we don't have a port already, use the default Arduino Serial.
     if(!_hwSerial)

src/sfTkArdUART.h

@@ -58,7 +58,7 @@ class sfTkArdUART : public sfTkIUART
      * 
      * @param config The UART configuration settings.
      */
-    sfTkArdUART(sfTkUARTConfig_t config) : sfTkIUART(config), _hwSerial{nullptr}
+    sfTkArdUART(UARTConfig_t config) : sfTkIUART(config), _hwSerial{nullptr}
     {
     }
 
@@ -114,7 +114,7 @@ class sfTkArdUART : public sfTkIUART
      * 
      * @param config The UART configuration settings.
      */
-    sfTkError_t init(sfTkUARTConfig_t config, bool bInit = false);
+    sfTkError_t init(UARTConfig_t config, bool bInit = false);
 
     /**
      * @brief Method sets up the required UART settings.
@@ -136,7 +136,7 @@ class sfTkArdUART : public sfTkIUART
      * 
      * @retval ksftkErrOk on successful execution.
      */
-    sfTkError_t init(arduino::HardwareSerial &hwSerial, sfTkUARTConfig_t config, bool bInit = false);
+    sfTkError_t init(arduino::HardwareSerial &hwSerial, UARTConfig_t config, bool bInit = false);
 
     /**
      * @brief Write `len` bytes to the UART TX buffer.
@@ -407,7 +407,7 @@ class sfTkArdUARTBus : public sfTkISerialBus
      * 
      * @param config The configuration to set
      */
-    sfTkError_t init(sfTkUARTConfig_t config, bool bInit = false)
+    sfTkError_t init(sfTkIUART::UARTConfig_t config, bool bInit = false)
     {
         if(!_uartPort)
             _uartPort = std::make_unique<sfTkArdUART>();
@@ -436,7 +436,7 @@ class sfTkArdUARTBus : public sfTkISerialBus
      * @param bInit This flag tracks whether the bus has been initialized.
      * @return sfTkError_t ksfTkErrOk on successful execution.
      */
-    sfTkError_t init(sfTkArdUART &uartPort, sfTkUARTConfig_t config, bool bInit = false)
+    sfTkError_t init(sfTkArdUART &uartPort, sfTkIUART::UARTConfig_t config, bool bInit = false)
     {
         _uartPort = std::make_unique<sfTkArdUART>(uartPort);
         return _uartPort->init(config, bInit);
@@ -477,7 +477,7 @@ class sfTkArdUARTBus : public sfTkISerialBus
      * @param bInit This flag tracks whether the bus has been initialized.
      * @return sfTkError_t ksfTkErrOk on successful execution.
      */
-    sfTkError_t init(arduino::HardwareSerial &hwSerial, sfTkUARTConfig_t config, bool bInit = false)
+    sfTkError_t init(arduino::HardwareSerial &hwSerial, sfTkIUART::UARTConfig_t config, bool bInit = false)
     {
         _uartPort = std::make_unique<sfTkArdUART>(hwSerial);
         return _uartPort->init(config, bInit);

tests/test_uart/test_uart.ino

@@ -59,7 +59,7 @@ void test1() {
 
 void test2() {
   myUART.println("Test 2: Get UART parameters.");
-  sfTkUARTConfig_t config = myUART.config();
+  sfTkIUART::UARTConfig_t config = myUART.config();
   myUART.print("Baud rate: ");
   myUART.println(config.baudRate);
   myUART.print("Data bits: ");
@@ -84,12 +84,12 @@ void test3() {
   }
 
   // Get initial configuration
-  sfTkUARTConfig_t initialConfig = myExtUART.config();
+  sfTkIUART::UARTConfig_t initialConfig = myExtUART.config();
   myUART.println("Initial UART configuration:");
   printUARTConfig(initialConfig);
 
   // Test different configurations
-  sfTkUARTConfig_t testConfigs[] = {
+  sfTkIUART::UARTConfig_t testConfigs[] = {
       // Test config 1: 9600 baud, 7 bits, odd parity, 2 stop bits
       {9600, kUARTDataBitsSeven, kUARTParityOdd, kUARTStopBitsTwo},
       // Test config 2: 57600 baud, 8 bits, even parity, 1 stop bit
@@ -233,7 +233,7 @@ void waitForButtonPress()
 }
 
 // Helper function to print UART configuration
-void printUARTConfig(const sfTkUARTConfig_t& config) {
+void printUARTConfig(const sfTkIUART::UARTConfig_t& config) {
     myUART.print("  Baud Rate: ");
     myUART.println(config.baudRate);
     myUART.print("  Data Bits: ");