updated OTA and rolling page

This commit is contained in:
CaCO3
2023-01-22 21:21:34 +01:00
parent d88399d14a
commit c8e79e9a1b
6 changed files with 22 additions and 44 deletions

BIN
docs/actions.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 106 KiB

View File

@@ -6,7 +6,7 @@ nav:
- Getting Started: - Getting Started:
- index.md - index.md
- Installation.md - Installation.md
- inital-setup.md - initial-setup.md
- Hardware-Compatibility.md - Hardware-Compatibility.md
- Best-Practice.md - Best-Practice.md
- FAQs.md - FAQs.md

View File

@@ -1,42 +1,13 @@
# Over-The-Air (OTA) Update # Over-The-Air (OTA) Update
You can do an OTA (over-the-air) update via the Web Interface.
You can do an OTA (over-the-air) update via the graphical user interface.
Grab the firmware from the Grab the firmware from the
* [Releases page](https://github.com/jomjol/AI-on-the-edge-device/releases) (Stable, tested versions), or 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: ## Update Procedure
* firmware.bin 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`!
* html.zip 1. Head to the menu `System > OTA Update` and follow the instructions there.
### **General remark:** 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.
- 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":
* <img src="https://raw.githubusercontent.com/jomjol/ai-on-the-edge-device/master/images/ota-update-menue.jpg" width="600" align="middle">
### Update
* <img src="https://raw.githubusercontent.com/jomjol/ai-on-the-edge-device/master/images/ota-update-details.jpg" width="600" align="middle">
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**

View File

@@ -1,10 +1,17 @@
# Living on the edge # 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!
## 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. ## I still want to try it
2. Download the `AI-on-the-edge-device__update__rolling_*.zip`
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. 5. Flash the zip file using the [OTA Update](../ota) page of your device.

BIN
docs/update-artifact.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 133 KiB