Skip to content

Don't suggest outdated MQTT client without MQTT 5 support. #485

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
reitermarkus wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Don't suggest outdated MQTT client without MQTT 5 support. #485

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ee04697
Don't suggest outdated MQTT client without MQTT 5 support.
reitermarkus Mar 7, 2025
13cc3d7
Add example for saving settings via MQTT.
reitermarkus Mar 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added book/src/assets/booster-command-save-example.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified book/src/assets/booster-settings-example.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified book/src/assets/booster-telemetry-example.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 12 additions & 3 deletions book/src/network-interface.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Copy Markdown
Member

@jordens jordens Mar 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Certainly not. MQTTX doesn't do any plotting. It's strictly worse than MQTT-Explorer for those tasks!

settings.

## Measurement Units
Expand All @@ -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

Expand All @@ -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 `<prefix>/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. `<prefix>/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

Expand Down