diff --git a/example/updater/README.md b/example/updater/README.md new file mode 100644 index 0000000..741e1dd --- /dev/null +++ b/example/updater/README.md @@ -0,0 +1,27 @@ +# Example: Updater + +A simple example of an updater client wich can: + +- Configure a ReachRS module to use the given WiFi network +- Check for updates then reboot to "ReachView" mode + +## Usage + +1. Boot your ReachRS module in "Updater" mode. You can see a documentation on how to reset your device [here](https://forge.cadoles.com/Pyxis/orion/wiki/FlashIt). + +2. Launch the example in `configure-wifi` phase and provides WiFi network informations. + ```shell + go run example/updater/main.go \ + -phase 'configure-wifi'\ + -host ''\ + -password ''\ + -security '' + ``` +3. The device will switch to the provided WiFi network, as you should do. +4. Launch the example in `update-then-reboot` phase. + ```shell + go run example/updater/main.go \ + -phase 'update-and-reboot'\ + -host '