diff --git a/.github/workflows/compile-sketch.yml b/.github/workflows/compile-sketch.yml index 86fcf45..8d482f5 100644 --- a/.github/workflows/compile-sketch.yml +++ b/.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 diff --git a/README.md b/README.md index f9bbb5a..439875f 100644 --- a/README.md +++ b/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. diff --git a/docs/images/rm_img_01.png b/docs/images/rm_img_01.png new file mode 100644 index 0000000..4574766 Binary files /dev/null and b/docs/images/rm_img_01.png differ diff --git a/docs/images/rm_img_02.png b/docs/images/rm_img_02.png new file mode 100644 index 0000000..0a73c98 Binary files /dev/null and b/docs/images/rm_img_02.png differ diff --git a/docs/images/rm_img_03.png b/docs/images/rm_img_03.png new file mode 100644 index 0000000..082da78 Binary files /dev/null and b/docs/images/rm_img_03.png differ diff --git a/tests/test_bus01/test_bus01.ino b/examples/Example_01_TestCompile/Example_01_TestCompile.ino similarity index 100% rename from tests/test_bus01/test_bus01.ino rename to examples/Example_01_TestCompile/Example_01_TestCompile.ino diff --git a/src/sfTkArdUART.h b/src/sfTkArdUART.h index abcd617..9f9657c 100644 --- a/src/sfTkArdUART.h +++ b/src/sfTkArdUART.h @@ -13,7 +13,6 @@ #pragma once -#include #include #include @@ -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.