This repository has been archived on 2024-08-02. You can view files and clone it, but cannot push or open issues or pull requests.
orion/cmd/updater/README.md

28 lines
880 B
Markdown
Raw Normal View History

2018-09-20 11:22:03 +02:00
# 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 cmd/updater/main.go \
2018-09-20 11:22:03 +02:00
-phase 'configure-wifi'\
-host '<DEVICE_IP_ADDRESS'\
-ssid '<WIFI_SSID>'\
-password '<WIFI_PASSWORD>'\
-security '<WIFI_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 cmd/updater/main.go \
2018-09-20 11:22:03 +02:00
-phase 'update-and-reboot'\
-host '<DEVICE_IP_ADDRESS'
```