Merge pull request #6 from J-Rios/callbacks

CLI Support Handle Commands by Callbacks

Author: J-Rios

.github/workflows/build_avr.yml

@@ -29,3 +29,6 @@ jobs:
         cd examples/avr/basic_usage/build
         make clean
         make build DEVICE=atmega328p F_CPU=16000000L
+        cd examples/avr/basic_usage_callbacks/build
+        make clean
+        make build DEVICE=atmega328p F_CPU=16000000L

.github/workflows/build_linux.yml

@@ -29,3 +29,6 @@ jobs:
         cd examples/linux/basic_usage/build
         make clean
         make build
+        cd examples/linux/basic_usage_callbacks/build
+        make clean
+        make build

.github/workflows/build_pio_arduino.yml

@@ -11,7 +11,10 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        example: [examples/arduino/basic_usage/src/main.cpp]
+        example: [
+          examples/arduino/basic_usage/src/main.cpp,
+          examples/arduino/basic_usage_callbacks/src/main.cpp
+        ]
 
     steps:
     - uses: actions/checkout@v2
@@ -33,6 +36,6 @@ jobs:
         python -m pip install --upgrade pip
         pip install --upgrade platformio
     - name: Run PlatformIO
-      run: pio ci --project-conf="examples/arduino/basic_usage/platformio.ini"
+      run: pio ci --project-conf="examples/arduino/platformio.ini"
       env:
         PLATFORMIO_CI_SRC: ${{ matrix.example }}

.github/workflows/build_pio_espidf.yml

@@ -11,7 +11,10 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        example: [examples/espidf/basic_usage/src/main.cpp]
+        example: [
+          examples/espidf/basic_usage/src/main.cpp,
+          examples/espidf/basic_usage_callbacks/src/main.cpp
+        ]
 
     steps:
     - uses: actions/checkout@v2

.gitmodules

@@ -19,7 +19,7 @@ default_envs = arduino_esp32            ; Build ESP32 with Arduino Framework
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 
 [env]
-lib_deps = minbasecli@1.1.1
+lib_deps = minbasecli@1.2.0
 
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 

examples/arduino/basic_usage/platformio.ini

@@ -1,5 +1,5 @@
 /**
- * @file    examples/arduino/basic_usage/basic_usage.ino
+ * @file    examples/arduino/basic_usage/src/basic_usage.ino
  * @author  Jose Miguel Rios Rubio <jrios.github@gmail.com>
  * @date    02-04-2022
  * @version 1.0.1
@@ -98,8 +98,8 @@ void loop()
         {
             Cli.printf("Available Commands:\n");
             Cli.printf("  help - Current info.\n");
-            Cli.printf("  led [on/off] - Turn LED ON or OFF\n");
-            Cli.printf("  version - Shows current firmware version\n");
+            Cli.printf("  led [on/off] - Turn LED ON or OFF.\n");
+            Cli.printf("  version - Shows current firmware version.\n");
         }
         else if(strcmp(cli_read.cmd, "led") == 0)
         {

examples/arduino/basic_usage/src/main.cpp

@@ -0,0 +1,5 @@
+.pio
+.vscode/.browse.c_cpp.db*
+.vscode/c_cpp_properties.json
+.vscode/launch.json
+.vscode/ipch

examples/arduino/basic_usage_callbacks/.gitignore

@@ -0,0 +1,39 @@
+
+This directory is intended for project header files.
+
+A header file is a file containing C declarations and macro definitions
+to be shared between several project source files. You request the use of a
+header file in your project source file (C, C++, etc) located in `src` folder
+by including it, with the C preprocessing directive `#include'.
+
+```src/main.c
+
+#include "header.h"
+
+int main (void)
+{
+ ...
+}
+```
+
+Including a header file produces the same results as copying the header file
+into each source file that needs it. Such copying would be time-consuming
+and error-prone. With a header file, the related declarations appear
+in only one place. If they need to be changed, they can be changed in one
+place, and programs that include the header file will automatically use the
+new version when next recompiled. The header file eliminates the labor of
+finding and changing all the copies as well as the risk that a failure to
+find one copy will result in inconsistencies within a program.
+
+In C, the usual convention is to give header files names that end with `.h'.
+It is most portable to use only letters, digits, dashes, and underscores in
+header file names, and at most one dot.
+
+Read more about using header files in official GCC documentation:
+
+* Include Syntax
+* Include Operation
+* Once-Only Headers
+* Computed Includes
+
+https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html

examples/arduino/basic_usage_callbacks/include/README

@@ -0,0 +1,46 @@
+
+This directory is intended for project specific (private) libraries.
+PlatformIO will compile them to static libraries and link into executable file.
+
+The source code of each library should be placed in a an own separate directory
+("lib/your_library_name/[here are source files]").
+
+For example, see a structure of the following two libraries `Foo` and `Bar`:
+
+|--lib
+|  |
+|  |--Bar
+|  |  |--docs
+|  |  |--examples
+|  |  |--src
+|  |     |- Bar.c
+|  |     |- Bar.h
+|  |  |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html
+|  |
+|  |--Foo
+|  |  |- Foo.c
+|  |  |- Foo.h
+|  |
+|  |- README --> THIS FILE
+|
+|- platformio.ini
+|--src
+   |- main.c
+
+and a contents of `src/main.c`:
+```
+#include <Foo.h>
+#include <Bar.h>
+
+int main (void)
+{
+  ...
+}
+
+```
+
+PlatformIO Library Dependency Finder will find automatically dependent
+libraries scanning project source files.
+
+More information about PlatformIO Library Dependency Finder
+- https://docs.platformio.org/page/librarymanager/ldf.html