Merge branch 'develop' into main

italocjs · Apr 8, 2024 · de9b1eb · de9b1eb
2 parents 0c66d8a + ffd1d91
commit de9b1eb
Show file tree

Hide file tree

Showing 56 changed files with 9,636 additions and 9,387 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -1,3 +1,3 @@
-*.css linguist-detectable=false
-*.html linguist-detectable=false
-*.js linguist-detectable=false
+*.css linguist-detectable=false
+*.html linguist-detectable=false
+*.js linguist-detectable=false
diff --git a/.github/workflows/make_doxygen.yml b/.github/workflows/make_doxygen.yml
@@ -1,31 +1,31 @@
-name: make_doxygen
-
-on:
-  push:
-    branches: [ main ]
-  pull_request:
-    branches: [ main, develop ]
-    types: [ opened, edited, synchronize]
-
-permissions:
-  contents: write # needed for the Doxygen action
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v2
-
-    - name: Doxygen Action
-      uses: mattnotmitt/doxygen-action@v1.1.0
-      with:
-        # Path to Doxyfile
-        doxyfile-path: "Doxyfile" # default is ./Doxyfile
-        working-directory: "app/" # default is .
-
-    - name: Deploy
-      if: github.event_name == 'push' && github.ref == 'refs/heads/main'
-      uses: peaceiris/actions-gh-pages@v3
-      with:
-        github_token: ${{ secrets.GITHUB_TOKEN }}
+name: make_doxygen
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main, develop ]
+    types: [ opened, edited, synchronize]
+
+permissions:
+  contents: write # needed for the Doxygen action
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Doxygen Action
+      uses: mattnotmitt/doxygen-action@v1.1.0
+      with:
+        # Path to Doxyfile
+        doxyfile-path: "Doxyfile" # default is ./Doxyfile
+        working-directory: "app/" # default is .
+
+    - name: Deploy
+      if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
         publish_dir: ./app/doxygen_out/html/
diff --git a/.github/workflows/make_tests.yml b/.github/workflows/make_tests.yml
@@ -1,52 +1,52 @@
-name: make_tests
-
-on:
-  push:
-    branches: [ main ]
-  pull_request:
-    branches: [ main, develop ]
-    types: [ opened, edited, synchronize]
-    # types: [ opened, edited]
-
-jobs:
-  native_tasks:
-    name: Native environment checks
-    runs-on: ubuntu-latest
-    container: italocjs/track_env:latest #update here if you change the base environment or anything in platformio.ini, make sure to build and upload image too!
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/cache@v3
-        with:
-          path: |
-            /root/.platformio/.cache
-          key: ${{ runner.os }}-pio   
-
-      - name: Native build
-        run: cd app/ && pio run -e native
-
-      - name: Native test
-        run: cd app/ && pio test -e native
-
-  esp32dev_tasks:
-    name: ESP32DEV environment checks
-    runs-on: ubuntu-latest
-    container: italocjs/track_env:latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/cache@v3
-        with:
-          path: |
-            /root/.platformio/.cache
-          key: ${{ runner.os }}-pio   
-
-      - name: esp32dev remote test
-        env: 
-          PLATFORMIO_AUTH_TOKEN: ${{ secrets.PLATFORMIO_AUTH_TOKEN }}
-          ESP32: true
-        run: cd app/ && pio remote --agent raspberrypi test -e esp32dev --upload-port /dev/ttyUSB0
-
-      - name: esp32dev build and flash remote
-        env: 
-          PLATFORMIO_AUTH_TOKEN: ${{ secrets.PLATFORMIO_AUTH_TOKEN }}
-          ESP32: true
+name: make_tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main, develop ]
+    types: [ opened, edited, synchronize]
+    # types: [ opened, edited]
+
+jobs:
+  native_tasks:
+    name: Native environment checks
+    runs-on: ubuntu-latest
+    container: italocjs/track_env:latest #update here if you change the base environment or anything in platformio.ini, make sure to build and upload image too!
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/cache@v3
+        with:
+          path: |
+            /root/.platformio/.cache
+          key: ${{ runner.os }}-pio   
+
+      - name: Native build
+        run: cd app/ && pio run -e native
+
+      - name: Native test
+        run: cd app/ && pio test -e native
+
+  esp32dev_tasks:
+    name: ESP32DEV environment checks
+    runs-on: ubuntu-latest
+    container: italocjs/track_env:latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/cache@v3
+        with:
+          path: |
+            /root/.platformio/.cache
+          key: ${{ runner.os }}-pio   
+
+      - name: esp32dev remote test
+        env: 
+          PLATFORMIO_AUTH_TOKEN: ${{ secrets.PLATFORMIO_AUTH_TOKEN }}
+          ESP32: true
+        run: cd app/ && pio remote --agent raspberrypi test -e esp32dev --upload-port /dev/ttyUSB0
+
+      - name: esp32dev build and flash remote
+        env: 
+          PLATFORMIO_AUTH_TOKEN: ${{ secrets.PLATFORMIO_AUTH_TOKEN }}
+          ESP32: true
         run: cd app/ && pio remote --agent raspberrypi run -e esp32dev -t upload --upload-port /dev/ttyUSB0
diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,7 @@
 # Ignore cache folder, we dont want uploading it to the repo
 .pio/
 .platformio/
-.vscode/
+# .vscode/ #do NOT ignore this folder, task buttons require them
 
 # ignoring doxygen_out, as it generate too many files.  We could improve it by compacting it somehow, or maybe using another documentation engine 
 app/doxygen_out/

diff --git a/.vscode/c_cpp_properties.json b/.vscode/c_cpp_properties.json
@@ -0,0 +1,48 @@
+//
+// !!! WARNING !!! AUTO-GENERATED FILE!
+// PLEASE DO NOT MODIFY IT AND USE "platformio.ini":
+// https://docs.platformio.org/page/projectconf/section_env_build.html#build-flags
+//
+{
+    "configurations": [
+        {
+            "name": "PlatformIO",
+            "includePath": [
+                "C:/github/esp32_italoenv/app/include",
+                "C:/github/esp32_italoenv/app/src",
+                "C:/github/esp32_italoenv/app/lib/sample_interface",
+                "C:/github/esp32_italoenv/app/.pio/libdeps/native/googletest",
+                "C:/github/esp32_italoenv/app/.pio/libdeps/native/googletest/googlemock",
+                "C:/github/esp32_italoenv/app/.pio/libdeps/native/googletest/googlemock/include",
+                "C:/github/esp32_italoenv/app/.pio/libdeps/native/googletest/googletest",
+                "C:/github/esp32_italoenv/app/.pio/libdeps/native/googletest/googletest/include",
+                ""
+            ],
+            "browse": {
+                "limitSymbolsToIncludedHeaders": true,
+                "path": [
+                    "C:/github/esp32_italoenv/app/include",
+                    "C:/github/esp32_italoenv/app/src",
+                    "C:/github/esp32_italoenv/app/lib/sample_interface",
+                    "C:/github/esp32_italoenv/app/.pio/libdeps/native/googletest",
+                    "C:/github/esp32_italoenv/app/.pio/libdeps/native/googletest/googlemock",
+                    "C:/github/esp32_italoenv/app/.pio/libdeps/native/googletest/googlemock/include",
+                    "C:/github/esp32_italoenv/app/.pio/libdeps/native/googletest/googletest",
+                    "C:/github/esp32_italoenv/app/.pio/libdeps/native/googletest/googletest/include",
+                    ""
+                ]
+            },
+            "defines": [
+                "PLATFORMIO=60114",
+                "MY_PROJECT_VERSION=10",
+                ""
+            ],
+            "cppStandard": "c++11",
+            "compilerPath": "C:/msys64/ucrt64/bin/gcc.exe",
+            "compilerArgs": [
+                ""
+            ]
+        }
+    ],
+    "version": 4
+}
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -0,0 +1,11 @@
+{
+    // See http://go.microsoft.com/fwlink/?LinkId=827846
+    // for the documentation about the extensions.json format
+    "recommendations": [
+        "platformio.platformio-ide",
+        "spencerwmiles.vscode-task-buttons"
+    ],
+    "unwantedRecommendations": [
+        "ms-vscode.cpptools-extension-pack"
+    ]
+}
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -0,0 +1,44 @@
+// AUTOMATICALLY GENERATED FILE. PLEASE DO NOT MODIFY IT MANUALLY
+//
+// PlatformIO Debugging Solution
+//
+// Documentation: https://docs.platformio.org/en/latest/plus/debugging.html
+// Configuration: https://docs.platformio.org/en/latest/projectconf/sections/env/options/debug/index.html
+
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "platformio-debug",
+            "request": "launch",
+            "name": "PIO Debug",
+            "executable": "C:/github/esp32_italoenv/app/.pio/build/native/program.exe",
+            "projectEnvName": "native",
+            "toolchainBinDir": "C:/msys64/ucrt64/bin",
+            "internalConsoleOptions": "openOnSessionStart",
+            "preLaunchTask": {
+                "type": "PlatformIO",
+                "task": "Pre-Debug"
+            }
+        },
+        {
+            "type": "platformio-debug",
+            "request": "launch",
+            "name": "PIO Debug (skip Pre-Debug)",
+            "executable": "C:/github/esp32_italoenv/app/.pio/build/native/program.exe",
+            "projectEnvName": "native",
+            "toolchainBinDir": "C:/msys64/ucrt64/bin",
+            "internalConsoleOptions": "openOnSessionStart"
+        },
+        {
+            "type": "platformio-debug",
+            "request": "launch",
+            "name": "PIO Debug (without uploading)",
+            "executable": "C:/github/esp32_italoenv/app/.pio/build/native/program.exe",
+            "projectEnvName": "native",
+            "toolchainBinDir": "C:/msys64/ucrt64/bin",
+            "internalConsoleOptions": "openOnSessionStart",
+            "loadMode": "manual"
+        }
+    ]
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,60 @@
+{
+    "VsCodeTaskButtons.showCounter": false,
+    "VsCodeTaskButtons.tasks": [
+        {
+            "label": "$(terminal) Build",
+            "task": "native_build",
+            "tooltip": "Build native code"
+        },
+        {
+            "label": "$(terminal) Run",
+            "task": "native_run",
+            "tooltip": "Build and run native code"
+        },        
+        {
+            "label": "$(terminal) Test",
+            "task": "native_test",
+            "tooltip": "Perform test on native code"
+        },        
+        {
+            "label": "$(chip) Build",
+            "task": "esp32dev_build",
+            "tooltip": "Build esp32dev code"
+        },
+        {
+            "label": "$(flame) Flash",
+            "task": "esp32dev_flash",
+            "tooltip": "Flash esp32dev code to the device"
+        },
+        {
+            "label": "$(flame) Test",
+            "task": "esp32dev_test",
+            "tooltip": "Flash ESP32 test to the device"
+        },
+        {
+            "label": "$(terminal) Monitor",
+            "task": "local_monitor",
+            "tooltip": "Monitor serial port at a specific port with decoding tools"
+        },
+        {
+            "label": "$(flame)$(cloud-upload) flash remote",
+            "task": "esp32dev_flash_remote",
+            "tooltip": "Flash esp32dev code to the remote device"
+        },
+        {
+            "label": "$(flame)$(cloud-upload) test remote",
+            "task": "esp32dev_test_remote",
+            "tooltip": "Perform test on esp32dev code to the remote device"
+        },
+        {
+            "label": "$(terminal)$(cloud) Monitor Remote",
+            "task": "remote_monitor",
+            "tooltip": "Open the serial port monitor with decoding tools"
+        },
+        {
+            "label": "$(book) Update docs",
+            "task": "generate_doxygen",
+            "tooltip": "Update the /app doxygen documentation"
+        },
+    ]
+}