diff --git a/book/src/assets/booster-command-save-example.png b/book/src/assets/booster-command-save-example.png new file mode 100644 index 00000000..763f25eb Binary files /dev/null and b/book/src/assets/booster-command-save-example.png differ diff --git a/book/src/assets/booster-settings-example.png b/book/src/assets/booster-settings-example.png index 946b88ef..7744ecd9 100644 Binary files a/book/src/assets/booster-settings-example.png and b/book/src/assets/booster-settings-example.png differ diff --git a/book/src/assets/booster-telemetry-example.png b/book/src/assets/booster-telemetry-example.png index 88fba82d..15dccba4 100644 Binary files a/book/src/assets/booster-telemetry-example.png and b/book/src/assets/booster-telemetry-example.png differ diff --git a/book/src/network-interface.md b/book/src/network-interface.md index 7bcebd2f..52d8e8b7 100644 --- a/book/src/network-interface.md +++ b/book/src/network-interface.md @@ -9,7 +9,7 @@ device by default(e.g. `12-34-56-78-90-ab`). The ID is configurable via the USB Please refer to [Stabilizer's documentation](https://quartiq.de/stabilizer/setup.html#mqtt-broker) for instructions on getting MQTT configured. -We recommend using [`mqtt-explorer`](http://mqtt-explorer.com/) to view telemetry and run-time +We recommend using [MQTTX](https://mqttx.app/) to view telemetry and run-time settings. ## Measurement Units @@ -27,7 +27,7 @@ connected channels. Telemetry is transmitted in human-readable JSON format for l ![Sample Booster Telemtry Topics](assets/booster-telemetry-example.png) -_Figure 1_: Example display of Booster telemetry on all 8 channels reported via MQTT Explorer. +_Figure 1_: Example display of Booster telemetry on all 8 channels reported via MQTTX. ## Settings @@ -43,7 +43,16 @@ settings are incompatible. ![Sample Booster Settings](assets/booster-settings-example.png) -_Figure 2_: Example display of Booster settings tree reported via MQTT Explorer. +_Figure 2_: Example display of Booster settings tree reported via MQTTX. + +For saving settings via MQTT, the `/command/save` topic is used. The payload should be a JSON +containing the channel ID, e.g. `{"channel": "Zero"}`. Additionally, a response topic must be set, +e.g. `/response`, to receive the response code from the device, otherwise the save command +is not executed. + +![Sample Command Save](assets/booster-command-save-example.png) + +_Figure 3_: Example display of saving settings for channel zero via MQTTX. ## Control