Merge branch 'add-esp32-s3-support' into add-freenove-board-support

Author: argetlam-coder

.github/ISSUE_TEMPLATE/bug_report.yaml renamed to .github/ISSUE_TEMPLATE/1_bug_report.yaml

@@ -115,9 +115,9 @@
     labeled:
       issue:
           body: |
-            See [Digital Digits](https://jomjol.github.io/neural-network-digital-counter-readout) resp. [Analogue Pointers](https://jomjol.github.io/neural-network-analog-needle-readout) for an overview of all trained data.
+            See [Digits](https://jomjol.github.io/neural-network-digital-counter-readout) resp. [Analogue Pointers](https://jomjol.github.io/neural-network-analog-needle-readout) for an overview of all trained data.
             If your type is not contained it can be added to our training material, see [here](https://jomjol.github.io/AI-on-the-edge-device-docs/collect-new-images/).
       discussion:
           body: |
-            See [Digital Digits](https://jomjol.github.io/neural-network-digital-counter-readout) resp. [Analogue Pointers](https://jomjol.github.io/neural-network-analog-needle-readout) for an overview of all trained data.
+            See [Digits](https://jomjol.github.io/neural-network-digital-counter-readout) resp. [Analogue Pointers](https://jomjol.github.io/neural-network-analog-needle-readout) for an overview of all trained data.
             If your type is not contained it can be added to our training material, see [here](https://jomjol.github.io/AI-on-the-edge-device-docs/collect-new-images/).

.github/ISSUE_TEMPLATE/feature.yaml renamed to .github/ISSUE_TEMPLATE/2_feature.yaml

@@ -53,6 +53,7 @@ jobs:
           ./code/.pio/build/esp32cam/partitions.bin
           ./code/.pio/build/esp32cam/bootloader.bin
           ./html/*
+          ./demo/*
         key: generated-files-${{ github.run_id }}
         restore-keys: generated-files # This matches above key as it is only used as a prefix. it the restores the nearest cache, see https://github.com/restore-keys:/blob/main/tips-and-workarounds.md#update-a-cache          
 
@@ -87,6 +88,11 @@ jobs:
         echo "Replacing variables..."
         cd html; find . -type f -exec sed -i 's/$COMMIT_HASH/${{ steps.vars.outputs.sha_short }}/g' {} \;
 
+    - name: Prepare Demo mode files
+      run: |
+        rm -rf ./demo
+        mkdir demo
+        cp -r ./sd-card/demo/* ./demo/
 
 #########################################################################################
 ## Pack for Update
@@ -97,6 +103,7 @@ jobs:
     #  - /firmware.bin
     #  - (optional) /html/* (inkl. subfolders)
     #  - (optional) /config/*.tfl
+    #  - (optional) /demo/*
     runs-on: ubuntu-latest
     needs: build
 
@@ -111,6 +118,7 @@ jobs:
           ./code/.pio/build/esp32cam/partitions.bin
           ./code/.pio/build/esp32cam/bootloader.bin
           ./html/*
+          ./demo/*
         key: generated-files-${{ github.run_id }}
         restore-keys: generated-files # This matches above key as it is only used as a prefix. it the restores the nearest cache, see https://github.com/restore-keys:/blob/main/tips-and-workarounds.md#update-a-cache
 
@@ -135,6 +143,9 @@ jobs:
 
     - name: Add Web UI to update
       run: cp -r ./html ./update/
+      
+    - name: Add Demo mode files to update
+      run: cp -r ./demo ./update/
 
     - name: Add CNN to update
       run: |
@@ -158,6 +169,7 @@ jobs:
     # remote_setup__version.zip file with following content:
     #  - /firmware.bin
     #  - /html/* (inkl. subfolders)
+    #  - /demo/*
     #  - /config/*
     runs-on: ubuntu-latest
     needs: build
@@ -173,6 +185,7 @@ jobs:
           ./code/.pio/build/esp32cam/partitions.bin
           ./code/.pio/build/esp32cam/bootloader.bin
           ./html/*
+          ./demo/*
         key: generated-files-${{ github.run_id }}
         restore-keys: generated-files # This matches above key as it is only used as a prefix. it the restores the nearest cache, see https://github.com/restore-keys:/blob/main/tips-and-workarounds.md#update-a-cache
 
@@ -197,6 +210,9 @@ jobs:
     - name: Add Web UI to remote_setup
       run: cp -r ./html ./remote_setup/
 
+    - name: Add Demo mode files to update
+      run: cp -r ./demo ./update/
+
     - name: Add whole config folder to remote_setup
       run: |
         rm -rf ./remote_setup/config/
@@ -229,6 +245,7 @@ jobs:
           ./code/.pio/build/esp32cam/partitions.bin
           ./code/.pio/build/esp32cam/bootloader.bin
           ./html/*
+          ./demo/*
         key: generated-files-${{ github.run_id }}
         restore-keys: generated-files # This matches above key as it is only used as a prefix. it the restores the nearest cache, see https://github.com/restore-keys:/blob/main/tips-and-workarounds.md#update-a-cache
 
@@ -257,7 +274,9 @@ jobs:
         cp -f "./code/.pio/build/esp32cam/bootloader.bin" "manual_setup/bootloader.bin"
         cp -f "./code/.pio/build/esp32cam/partitions.bin" "manual_setup/partitions.bin"
         rm -rf ./sd-card/html
+        rm -rf ./sd-card/demo
         cp -r ./html ./sd-card/ # Overwrite the Web UI with the preprocessed files
+        cp -r ./demo ./sd-card/
         cd sd-card; zip -r ../manual_setup/sd-card.zip *; cd ..
         cd ./manual_setup
 
@@ -271,7 +290,7 @@ jobs:
 #########################################################################################
 ## Prepare and create release
 #########################################################################################
-  release: 
+  prepare-release: 
     runs-on: ubuntu-latest
     needs: [pack-for-update, pack-for-manual_setup, pack-for-remote_setup]
     if: startsWith(github.ref, 'refs/tags/') 
@@ -331,34 +350,30 @@ jobs:
 
     # extract the version used in next step
     - id: get_version
-      if: startsWith(github.ref, 'refs/tags/') 
-      uses: Simply007/get-version-action@v2
+      uses: drewg13/get-version-action@98dda2a47a257e202c2e6c2ed2e6072ec23f448e
 
 #    # the changelog [unreleased] will now be changed to the release version
 #    - name: Update changelog
 #      uses: thomaseizinger/keep-a-changelog-new-release@v1
-#      if: startsWith(github.ref, 'refs/tags/') 
 #      with:
 #        changelogPath: Changelog.md
 #        version: ${{ steps.get_version.outputs.version-without-v }}
 
 #    # the release notes will be extracted from changelog 
 #    - name: Extract release notes
 #      id: extract-release-notes
-#      if: startsWith(github.ref, 'refs/tags/') 
 #      uses: ffurrer2/extract-release-notes@v1
 #      with:
 #          changelog_file: Changelog.md
 
     # Releases should only be created on master by tagging the last commit.
     # all artifacts in firmware folder pushed to the release
     - name: Release
-      uses: softprops/action-gh-release@v1
+      uses: softprops/action-gh-release@v2.0.8
       # Note:
       # If you get the error "Resource not accessible by integration",
       # The access rights are not sufficient, see
       # https://github.com/softprops/action-gh-release/issues/232#issuecomment-1131379440
-      if: startsWith(github.ref, 'refs/tags/')
       with:
         name:  ${{ steps.get_version.outputs.version-without-v }}
         body: ${{ steps.extract-release-notes.outputs.release_notes }}
@@ -367,7 +382,6 @@ jobs:
 
 #    # Commit&Push Changelog to master branch. Must be manually merged back to rolling
 #    - name: Commit changes and push changes
-#      if: startsWith(github.ref, 'refs/tags/') 
 #      run: |
 #        git config user.name github-actions
 #        git config user.email [email protected]
@@ -380,8 +394,9 @@ jobs:
 ## Update the Web Installer on a release
 #########################################################################################
 # Make sure to also update update-webinstaller.yml!
-  update-web-installer:    
-    needs: [release]
+  update-web-installer:
+    if: github.event_name == 'release' && github.event.action == 'published' # Only run on release but not on prerelease
+    needs: [prepare-release]
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}

.github/ISSUE_TEMPLATE/training.yaml renamed to .github/ISSUE_TEMPLATE/3_training.yaml

@@ -0,0 +1,21 @@
+# This updates the Contributors list in the README.md
+# it only gets run on:
+#  - Manually triggered
+
+name: Manually update contributors list
+
+on:
+  workflow_dispatch: # Run on manual trigger
+
+jobs:
+  manually-update-contributors-list: 
+    runs-on: ubuntu-latest
+    name: A job to automatically update the contributors list in the README.md
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+        - name: Contribute List
+          uses: akhilmhdh/[email protected]
+          env:
+              GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}