diff --git a/docs/actions.png b/docs/actions.png new file mode 100644 index 0000000..b4d7619 Binary files /dev/null and b/docs/actions.png differ diff --git a/docs/inital-setup.md b/docs/initial-setup.md similarity index 100% rename from docs/inital-setup.md rename to docs/initial-setup.md diff --git a/docs/nav.yml b/docs/nav.yml index 881b770..cfdefc0 100644 --- a/docs/nav.yml +++ b/docs/nav.yml @@ -6,7 +6,7 @@ nav: - Getting Started: - index.md - Installation.md - - inital-setup.md + - initial-setup.md - Hardware-Compatibility.md - Best-Practice.md - FAQs.md diff --git a/docs/ota.md b/docs/ota.md index b58471c..5f6b19d 100644 --- a/docs/ota.md +++ b/docs/ota.md @@ -1,42 +1,13 @@ # Over-The-Air (OTA) Update - -You can do an OTA (over-the-air) update via the graphical user interface. +You can do an OTA (over-the-air) update via the Web Interface. Grab the firmware from the * [Releases page](https://github.com/jomjol/AI-on-the-edge-device/releases) (Stable, tested versions), or the - * [Automatically build development branch](https://github.com/jomjol/AI-on-the-edge-device/actions?query=branch%3Arolling) (experimental, untested versions). Please have a look on [](https://github.com/jomjol/AI-on-the-edge-device/wiki/Install-a-rolling-%28unstable%29-release) first! + * [Automatically build development branch](https://github.com/jomjol/AI-on-the-edge-device/actions?query=branch%3Arolling) (experimental, untested versions). Please inform yourself on [Living on the Edge](../rolling-installation) first! -You need: -* firmware.bin -* html.zip +## Update Procedure +1. Create a backup of your configuration. Either use the Backup/Restore function of your device for this (menu `System > Backup/Restore`) or back the files manually up using the File Server (menu `File Server`, folder `config`). It is recommended to at least save the config file `config.ini`! +1. Head to the menu `System > OTA Update` and follow the instructions there. -### **General remark:** - -- It is always recommended to upload both files, as they are coupled to each other -- If you make a major update, it might be needed to modify the `config.ini` as it's syntax or context has changed -- It is recommended to make a **backup** of the `/config` directory, minimum of the `config.ini`. - - - -### Access to the update page: - -The graphical OTA update can be accessed in the menue "System": - -* - - -### Update - -* - -Just follow the steps 1 to 5 to perform the update: - -1. Select (a) and upload (b) the file `firmware.bin` -2. Flash the firmware -3. Select (a) and upload (b) the file `html.zip` -4. Update the html-files -5. Reboot - - - -**After the reboot with a major change it is recommended to check the configuration settings and save them again** \ No newline at end of file +If you do an update between major versions, it might be needed to modify the config file `config.ini` as it's syntax or context has changed. +To do so, go to the menu `Settings > Configuration` (after the update completed and the device restarted) and check if it warns you about an unset parameter. diff --git a/docs/rolling-installation.md b/docs/rolling-installation.md index 9793c1d..9158e3d 100644 --- a/docs/rolling-installation.md +++ b/docs/rolling-installation.md @@ -1,10 +1,17 @@ -# Living on the edge -The branch [rolling](https://github.com/jomjol/AI-on-the-edge-device/tree/rolling) contains the latest version of the Firmware and the Web Interface. It might already contain a fix for your issue. But it is work in progress, don't expect it to work stable or be an improvement for your AI-on-the-edge-device! Also it might break the [OTA Update](../ota) and thus require manual flashing over USB! +# Living on the Edge -## You still want to try it? +The [Github repository](https://github.com/jomjol/AI-on-the-edge-device) contains multiple branches: -Grab the latest `rolling` build from [Github Actions](https://github.com/jomjol/AI-on-the-edge-device/actions/workflows/build.yaml?query=branch%3Arolling) Page and proceed as following: + - The [master](https://github.com/jomjol/AI-on-the-edge-device/tree/master) branch contains the same firmware version as provided on the [release page](https://github.com/jomjol/AI-on-the-edge-device/releases). + - The [rolling](https://github.com/jomjol/AI-on-the-edge-device/tree/rolling) branch contains the **latest** version of the Firmware and the Web Interface. It might already contain a fix for your issue. But it is work in progress, don't expect it to work stable or be an improvement for your AI-on-the-edge-device! Also it might break the [OTA Update](../ota) and thus require manual flashing over USB! + - Any other branch is used to develop a feature or fix, only use them when you know what it is about! -1. Pick the most top successful (green) build. -2. Download the `AI-on-the-edge-device__update__rolling_*.zip` -5. Flash the zip file using the [OTA Update](../ota) page of your device. \ No newline at end of file +## I still want to try it + +Ok, then grab the latest `rolling` build from [Github Actions](https://github.com/jomjol/AI-on-the-edge-device/actions/workflows/build.yaml?query=branch%3Arolling) Page and proceed as following: + +1. Pick the most top successful (green) build: + ![](actions.png) +2. Scroll down and download the `AI-on-the-edge-device__update__*.zip`: + ![](update-artifact.png) +5. Flash the zip file using the [OTA Update](../ota) page of your device. diff --git a/docs/update-artifact.png b/docs/update-artifact.png new file mode 100644 index 0000000..a6e1222 Binary files /dev/null and b/docs/update-artifact.png differ