Merge remote-tracking branch 'origin/dev'

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,32 +1,32 @@
 ---
-name: Problem Report
+name: Problem Report/Change Request
 about: Create a Report to help us improve
 ---
 
-<!-- Thanks for reporting a problem for this project. READ THIS FIRST:
+<!-- Thanks for reporting an issue for this project. READ THIS FIRST:
 
-Please DO NOT OPEN AN ISSUE if your EMS-ESP version is not the latest from the dev branch, please update your device before submitting your issue. Your problem might already be solved. The latest precompiled binaries of EMS-ESP can be downloaded from https://github.com/emsesp/EMS-ESP32/releases/tag/latest
+Please DO NOT OPEN AN ISSUE if your EMS-ESP version is not the latest from the dev branch, please update your device before submitting your issue. Your issue might already be solved. The latest precompiled binaries of EMS-ESP can be downloaded from https://github.com/emsesp/EMS-ESP32/releases/tag/latest
 
 Please take a few minutes to complete the requested information below.
 
 -->
 
-### PROBLEM DESCRIPTION
+### DESCRIPTION
 
-_A clear and concise description of what the problem is._
+_A clear and concise description of what the problem is or the change requested._
 
 ### REQUESTED INFORMATION
 
 _Make sure your have performed every step and checked the applicable boxes before submitting your issue. Thank you!_
 
-- [ ] Searched the problem in [issues](https://github.com/emsesp/EMS-ESP32/issues)
-- [ ] Searched the problem in [discussions](https://github.com/emsesp/EMS-ESP32/discussions)
-- [ ] Searched the problem in the [docs](https://emsesp.github.io/docs/Troubleshooting/)
-- [ ] Searched the problem in the [chat](https://discord.gg/3J3GgnzpyT)
-- [ ] Provide the output of http://ems-esp.local/api/system :
+- [ ] Searched the issue in [issues](https://github.com/emsesp/EMS-ESP32/issues)
+- [ ] Searched the issue in [discussions](https://github.com/emsesp/EMS-ESP32/discussions)
+- [ ] Searched the issue in the [docs](https://emsesp.org/Troubleshooting/)
+- [ ] Searched the issue in the [chat](https://discord.gg/3J3GgnzpyT)
+- [ ] Provide the System information in the area below, taken from `http://<IP>/api/system`
 
-```lua
-  System information output here:
+```json
+  Paste System information here....
 
 
 ```
@@ -41,10 +41,10 @@ _A clear and concise description of what you expected to happen._
 
 ### SCREENSHOTS
 
-_If applicable, add screenshots to help explain your problem._
+_If applicable, add screenshots to help explain your issue._
 
 ### ADDITIONAL CONTEXT
 
-_Add any other context about the problem here._
+_Add any other context about the issue here._
 
-**(Please, remember to close the issue when the problem has been addressed)**
+**(Please remember to close the issue when it has been addressed)**

.github/ISSUE_TEMPLATE/config.yml

@@ -1,7 +1,7 @@
 blank_issues_enabled: false
 contact_links:
   - name: EMS-ESP Docs
-    url: https://emsesp.github.io/docs/
+    url: https://emsesp.org
     about: All the information related to EMS-ESP.
   - name: EMS-ESP Discussions and Support
     url: https://github.com/emsesp/EMS-ESP32/discussions

.github/workflows/github-releases-to-discord.yml

@@ -11,7 +11,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-      - name: Github Releases To Discord
+
+      - name: GitHub Releases To Discord
         uses: SethCohen/[email protected]
         with:
           webhook_url: ${{ secrets.WEBHOOK_URL }}

.github/workflows/pre_release.yml

@@ -10,17 +10,24 @@ jobs:
   pre-release:
     name: 'Automatic pre-release build'
     runs-on: ubuntu-latest
-
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v4
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Enable Corepack
+        run: corepack enable
+
+      - name: Install python 3.11
+        uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-      - uses: actions/setup-node@v3
+
+      - name: Install Node.js 20
+        uses: actions/setup-node@v4
         with:
-          node-version: '18'
+          node-version: '20.x'
 
-      - name: Get EMS-ESP source code and version
+      - name: Get EMS-ESP version
         id: build_info
         run: |
           version=`grep -E '^#define EMSESP_APP_VERSION' ./src/version.h | awk -F'"' '{print $2}'`
@@ -40,21 +47,13 @@ jobs:
           yarn build
           yarn webUI
 
-      - name: Build firmware
-        run: |
-          platformio run -e ci
-
-      - name: Build S3 firmware
-        run: |
-          platformio run -e ci_s3
-
-      - name: Build E32V2 firmware
+      - name: Build all PIO target environments from default_envs
         run: |
-          platformio run -e ci_16M
+          platformio run
 
-      - name: Create a GH Release
+      - name: Create GitHub Release
         id: 'automatic_releases'
-        uses: 'marvinpinto/action-automatic-releases@latest'
+        uses: emsesp/action-automatic-releases@v1.0.0
         with:
           repo_token: '${{ secrets.GITHUB_TOKEN }}'
           title: Development Build v${{steps.build_info.outputs.VERSION}}

.github/workflows/sonar_check.yml

@@ -1,30 +1,34 @@
+# see https://github.com/marketplace/actions/sonarcloud-scan-for-c-and-c#usage
 name: Sonar Check
+
 on:
   push:
     branches:
       - dev
-  pull_request:
-    types: [opened, synchronize, reopened]
+  # pull_request:
+  #   types: [opened, synchronize, reopened]
+
 jobs:
   build:
     name: Build and analyze
+    if: github.repository == 'emsesp/EMS-ESP32'
     runs-on: ubuntu-latest
-    # if: github.repository_owner == 'emsesp'
-    # if: github.repository == 'emsesp/EMS-ESP32'
     env:
       BUILD_WRAPPER_OUT_DIR: bw-output
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout repository
+        uses: actions/checkout@v4
         with:
-          fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
+          fetch-depth: 0
+
       - name: Install sonar-scanner and build-wrapper
         uses: SonarSource/sonarcloud-github-c-cpp@v2
+
       - name: Run build-wrapper
-        run: |
-          build-wrapper-linux-x86-64 --out-dir ${{ env.BUILD_WRAPPER_OUT_DIR }} make all
+        run:  build-wrapper-linux-x86-64 --out-dir ${{ env.BUILD_WRAPPER_OUT_DIR }} make all
+
       - name: Run sonar-scanner
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
-        run: |
-          sonar-scanner --define sonar.cfamily.build-wrapper-output="${{ env.BUILD_WRAPPER_OUT_DIR }}"
+        run: sonar-scanner --define sonar.cfamily.compile-commands="${{ env.BUILD_WRAPPER_OUT_DIR }}/compile_commands.json"

.github/workflows/tagged_release.yml

@@ -1,6 +1,7 @@
 name: 'tagged-release'
 
 on:
+  workflow_dispatch:
   push:
     tags:
       - 'v*'
@@ -9,22 +10,27 @@ jobs:
   tagged-release:
     name: 'Tagged Release'
     runs-on: ubuntu-latest
-
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v4
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Enable Corepack
+        run: corepack enable
+
+      - name: Install python 3.11
+        uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-      - uses: actions/setup-node@v3
+
+      - name: Install Node.js 20
+        uses: actions/setup-node@v4
         with:
-          node-version: '18'
+          node-version: '20.x'
 
       - name: Install PlatformIO
         run: |
           python -m pip install --upgrade pip
           pip install -U platformio
-          platformio upgrade
-          pio pkg update
 
       - name: Build WebUI
         run: |
@@ -35,16 +41,12 @@ jobs:
           yarn build
           yarn webUI
 
-      - name: Build firmware
-        run: |
-          platformio run -e ci
-
-      - name: Build S3 firmware
+      - name: Build all PIO target environments from default_envs
         run: |
-          platformio run -e ci_s3
+          platformio run
 
-      - name: Release
-        uses: 'marvinpinto/action-automatic-releases@latest'
+      - name: Create GitHub Release
+        uses: emsesp/action-automatic-releases@v1.0.0
         with:
           repo_token: '${{ secrets.GITHUB_TOKEN }}'
           prerelease: false

.github/workflows/test_release.yml

@@ -10,27 +10,26 @@ jobs:
   pre-release:
     name: 'Automatic test-release build'
     runs-on: ubuntu-latest
-
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v4
+      - name: Enable Corepack
+        run: corepack enable
+      - uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-      - uses: actions/setup-node@v3
+      - name: Use Node.js 20.x
+        uses: actions/setup-node@v4
         with:
-          node-version: '18'
-
+          node-version: '20.x'
       - name: Get EMS-ESP source code and version
         id: build_info
         run: |
           version=`grep -E '^#define EMSESP_APP_VERSION' ./src/version.h | awk -F'"' '{print $2}'`
           echo "VERSION=$version" >> $GITHUB_OUTPUT
-
       - name: Install PlatformIO
         run: |
           python -m pip install --upgrade pip
           pip install -U platformio
-
       - name: Build WebUI
         run: |
           cd interface
@@ -39,18 +38,12 @@ jobs:
           sed -i "s/= 'pl'/= 'en'/" ./src/i18n/i18n-util.ts
           yarn build
           yarn webUI
-
-      - name: Build firmware
-        run: |
-          platformio run -e ci
-
-      - name: Build S3 firmware
+      - name: Build all target environments from default_envs
         run: |
-          platformio run -e ci_s3
-
-      - name: Create a GH Release
+          platformio run
+      - name: Create GitHub Release
         id: 'automatic_releases'
-        uses: 'marvinpinto/action-automatic-releases@latest'
+        uses: emsesp/action-automatic-releases@v1.0.0
         with:
           repo_token: '${{ secrets.GITHUB_TOKEN }}'
           title: Test Build v${{steps.build_info.outputs.VERSION}}

.gitignore

@@ -1,5 +1,8 @@
 # vscode
-.vscode/*
+.vscode/c_cpp_properties.json
+.vscode/extensions.json
+.vscode/launch.json
+.vscode/settings.json
 
 # c++ compiling
 .clang_complete
@@ -27,21 +30,16 @@ stats.html
 *.sln
 *.sw?
 .pnp.*
-.yarn/*
+*/.yarn/*
 !.yarn/patches
 !.yarn/plugins
 !.yarn/releases
 !.yarn/sdks
 !.yarn/versions
 yarn.lock
-interface/analyse.html
+analyse.html
 interface/vite.config.ts.timestamp*
-
-# scripts
-test.sh
-scripts/run.sh
-scripts/__pycache__
-scripts/stackdmp.txt
+*.local
 
 # i18n generated files
 interface/src/i18n/i18n-react.tsx
@@ -50,11 +48,27 @@ interface/src/i18n/i18n-util.ts
 interface/src/i18n/i18n-util.sync.ts
 interface/src/i18n/i18n-util.async.ts
 
+# scripts
+test.sh
+scripts/run.sh
+scripts/__pycache__
+scripts/stackdmp.txt
+
 # sonar
 .scannerwork/
 sonar/
 bw-output/
 
-# testing
+# standalone executable for testing
 emsesp
+interface/tsconfig.tsbuildinfo
+
+# python virtual environment
+venv/
+
+# cspell
+words-found-verbose.txt
 
+# sonarlint
+compile_commands.json
+package.json

.prettierignore

@@ -0,0 +1,6 @@
+*/node_modules/
+build/
+dist/*
+interface/src/i18n/*
+
+.typesafe-i18n.json

.prettierrc

@@ -1,8 +1,13 @@
 {
+  "plugins": ["@trivago/prettier-plugin-sort-imports"],
   "trailingComma": "none",
   "tabWidth": 2,
   "semi": true,
   "singleQuote": true,
-  "printWidth": 120,
-  "bracketSpacing": true
-}
+  "printWidth": 85,
+  "bracketSpacing": true,
+  "importOrder": ["^react", "^@mui/(.*)$", "^api*/(.*)$", "<THIRD_PARTY_MODULES>", "^[./]"],
+  "importOrderSeparation": true,
+  "importOrderSortSpecifiers": true,
+  "importOrderGroupNamespaceSpecifiers": true
+} 

.sonarlint/connectedMode.json

@@ -0,0 +1,4 @@
+{
+    "sonarCloudOrganization": "emsesp",
+    "projectKey": "emsesp_EMS-ESP32"
+}