Merge pull request #46 from sparkfun/main

Pulling changes in main back to feature.

Author: SFE-Brudnerd

.github/workflows/compile-sketch.yml

@@ -101,7 +101,7 @@ jobs:
           libraries: |
             - source-path: ./
           sketch-paths: |
-            - tests
+            - examples/Example_01_TestCompile
           enable-warnings-report: true
           enable-deltas-report: true
           verbose: true

README.md

@@ -33,52 +33,15 @@ The SparkFun Toolkit provides a single implementation of common functionality us
 
 Implemented using C++, the SparkFun toolkit follows a simple two layered approach in it's design: A core foundational layer, and a platform specific layer. 
 
-```mermaid
----
-title: General Architecture Structure
----
-classDiagram
-    class CoreToolkit["Core Toolkit Interfaces"] 
-    class PlatformOne["Platform Implementation"]
-    CoreToolkit <|-- PlatformOne
+![Core Architecture](docs/images/rm_img_01.png)
 
-```
-And as additional plaforms are added, they also implement/inherit from the SparkFun Toolkit Core.
-```mermaid
----
-title: Multi-Platform Structure
----
-classDiagram
-    class CoreToolkit["Core Toolkit Interfaces"]
-    class PlatformOne["Platform One"]
-    class PlatformTwo["Platform Two"]
-
-    CoreToolkit <|-- PlatformOne
-    CoreToolkit <|-- PlatformTwo
-```
+And as additional platforms are added, they also implement/inherit from the SparkFun Toolkit Core.
 
-When using the SparkFun Toolkit, the intent is for the implementation to follow the same pattern: A platform independent layer that works with the SparkFun Toolkit core, and a platform specific layer that utilizes the SparkFun Toolkit platform specific implementation. 
+![Multi-Platform Structure](docs/images/rm_img_02.png)
 
-```mermaid
----
-title: Application Structure
----
-classDiagram
-    direction TD
-    note for ApplicationCore "Application Logic"
-    class ApplicationCore["Application Core"]
-    class CoreToolkit["Core Toolkit Interfaces"] 
-
-    note for CoreToolkit "SparkFun Toolkit"
-    class ApplicationPlatform["Application Platform"]
-    style ApplicationPlatform fill:#909090
-    class PlatformOne["Platform Implementation"]
-    style PlatformOne fill:#909090
-    
-    CoreToolkit <|-- PlatformOne
-    ApplicationCore <--> Application Platform
+When using the SparkFun Toolkit, the intent is for the implementation to follow the same pattern: A platform independent layer that works with the SparkFun Toolkit core, and a platform specific layer that utilizes the SparkFun Toolkit platform specific implementation. 
 
-```
+![Application Structure](docs/images/rm_img_03.png)
 
 If/when the application is moved to another platform, just the platform specific logic needs implementation. 
 

docs/images/rm_img_01.png

@@ -13,7 +13,6 @@
 
 #pragma once
 
-#include <cstddef>
 #include <memory>
 
 #include <Arduino.h>
@@ -138,7 +137,7 @@ class sfTkArdUART : public sfTkIUART
      *
      * @retval ksftkErrOk on successful execution.
      */
-    sfTkError_t init(arduino::HardwareSerial &hwSerial, UARTConfig_t config, bool bInit = false);
+    sfTkError_t init(arduino::HardwareSerial &hwSerial, sfTkIUART::UARTConfig_t &config, bool bInit = false);
 
     /**
      * @brief Write `len` bytes to the UART TX buffer.