update web installer

.github/workflows/build.yaml → .github/workflows/build.yml

@@ -380,7 +380,7 @@ jobs:
 #########################################################################################
 ## Update the Web Installer on a release
 #########################################################################################
-# This is the same as in the update-webinstaller.yml
+# Make sure to also update update-webinstaller.yml!
   update-web-installer:    
     needs: [release]
     environment:
@@ -408,12 +408,14 @@ jobs:
       
     - name: Add binary to Web Installer and update manifest
       run: |
+        echo "Updating Web installer to use firmware from ${{ steps.last_release.outputs.tag_name }}..."
         rm -f docs/binary/firmware.bin
         wget https://github.com/jomjol/AI-on-the-edge-device/releases/download/${{ steps.last_release.outputs.tag_name }}/AI-on-the-edge-device__update__${{ steps.last_release.outputs.tag_name }}.zip
         unzip AI-on-the-edge-device__update__${{ steps.last_release.outputs.tag_name }}.zip
         cp -f firmware.bin docs/binary/firmware.bin
-        cp -f docs/manifest_template.json docs/manifest.json
-        sed -i 's/VERSION/${{ steps.last_release.outputs.tag_name }}/g' docs/manifest.json
+        echo "Updating index and manifest file..."
+        sed -i 's/$VERSION/${{ steps.last_release.outputs.tag_name }}/g' docs/index.html
+        sed -i 's/$VERSION/${{ steps.last_release.outputs.tag_name }}/g' docs/manifest.json
     - name: Setup Pages
       uses: actions/configure-pages@v2
 

.github/workflows/manual-update-webinstaller.yml

@@ -1,7 +1,7 @@
 # This updates the Web Installer with the files from the docs folder and the binary of the latest release
 # it only gets run on:
-#  - Changes to the docs folder in the `rolling` branch
-#  - On a release
+#  - Manually triggered
+# Make sure to also update the lower part of build.yml!
 
 name: Manual Web Installer Update
 
@@ -45,8 +45,9 @@ jobs:
         wget https://github.com/jomjol/AI-on-the-edge-device/releases/download/${{ steps.last_release.outputs.tag_name }}/AI-on-the-edge-device__update__${{ steps.last_release.outputs.tag_name }}.zip
         unzip AI-on-the-edge-device__update__${{ steps.last_release.outputs.tag_name }}.zip
         cp -f firmware.bin docs/binary/firmware.bin
-        echo "Updating manifest file..."
-        sed -i 's/VERSION/${{ steps.last_release.outputs.tag_name }}/g' docs/manifest.json
+        echo "Updating index and manifest file..."
+        sed -i 's/$VERSION/${{ steps.last_release.outputs.tag_name }}/g' docs/index.html
+        sed -i 's/$VERSION/${{ steps.last_release.outputs.tag_name }}/g' docs/manifest.json
 
     - name: Setup Pages
       uses: actions/configure-pages@v2

docs/index.html

@@ -18,14 +18,15 @@
 
       For further information about AI-on-the-edge-device please go to <a href=https://github.com/jomjol/AI-on-the-edge-device target=_blank>https://github.com/jomjol/AI-on-the-edge-device</a>.</p>
       
-      <p>Notes:</p>
+      <h2>Notes:</h2>
       <ul>
-         <li>For the installation, make sure to switch the ESP32 to Bootloader mode!</li>
+         <li>The Webinstall will install the latest firmware (Version $VERSION).</li>
+         <li>For the installation, make sure to switch the ESP32 to Bootloader mode by keeping the <b>FLASH</b> button pressed while the <b>RESET</b> button gets relesed. if there is no <b>FLASH</b> button, you need to pull <b>GPIO0</b> low!</li>
          <li>After the installation, a manual reset might be required!</li>
-         <li>Please note that not all web browsers and operating systems support the necessary USB access!</li>
+         <li>Please note that not all web browsers and operating systems support the necessary USB access needed for this Webinstaller!</li>
          <li>Check the <a href=https://jomjol.github.io/AI-on-the-edge-device-docs/Installation target=_blank>documentation</a> for additional information.</li>
-         <li>The SD card must still be set up separately. This can be done manually or using the new <b>Remote Setup</b>. See the <a href=https://jomjol.github.io/AI-on-the-edge-device-docs/Installation/#3-sd-card target=_blank>documentation</a> for further instructions!</li>
-         
+         <li>The SD card can be setup automatically after the firmware got installed. See <a href=https://jomjol.github.io/AI-on-the-edge-device-docs/Installation/#remote-setup-using-the-built-in-access-point>jomjol.github.io/AI-on-the-edge-device-docs/Installation</a> for details. For this to work, the SD card must be FAT formated (which is the default on a new SD card).
+            Alternatively the SD card still can be setup manually, see the <a href=https://jomjol.github.io/AI-on-the-edge-device-docs/Installation/#3-sd-card target=_blank>documentation</a> for details!</li>
       </ul>
             
       <p><esp-web-install-button manifest="manifest.json"></esp-web-install-button></p>

docs/manifest.json

@@ -1,6 +1,6 @@
 {
   "name": "AI-on-the-edge",
-  "version": "VERSION",
+  "version": "$VERSION",
   "funding_url": "https://www.paypal.com/donate?hosted_button_id=8TRSVYNYKDSWL",
   "new_install_prompt_erase": false,
   "builds": [