chore(docs): simplify end-user guides and align web panel docs with current UI

Этот коммит содержится в:
Jared Dohrman
2026-04-10 23:08:51 +10:00
родитель 328a0ecf6f
Коммит 3db8b96d6f
6 изменённых файлов: 25 добавлений и 10 удалений
Двоичный файл не отображается.

До

Ширина:  |  Высота:  |  Размер: 320 KiB

После

Ширина:  |  Высота:  |  Размер: 394 KiB

+2 -1
Просмотреть файл
@@ -13,7 +13,8 @@ These commands are available on `*_repeater_mqtt` firmware targets.
- `get mqtt.status`
- shows WiFi, NTP, IATA, endpoint status, status publishing state, and TX state
- `get mqtt.statuscfg`
- shows whether periodic status messages are enabled
- shows whether periodic status messages are enabled as a simple `on` or `off` value
- most users can just use `get mqtt.status`
- `get mqtt.iata`
- shows the IATA/location code used in MQTT topics
- `set mqtt.iata <code>`
+6 -3
Просмотреть файл
@@ -3,17 +3,20 @@
MeshCore-EastMesh keeps the upstream MeshCore firmware intact and adds an EastMesh layer on top for:
- `repeater_mqtt` builds with native WiFi, MQTT, and the optional local web panel
- `companion_radio_wifi` builds for WiFi-connected companion devices
- `companion_radio_wifi` builds for Wi-Fi-connected companion devices
- EastMesh-specific release automation and versioning on top of upstream MeshCore releases
## Start Here
## End User Guides
- [Download and Flash Releases](./releases.md)
- [Migration From xJARiD/MeshCore](./migration.md)
- [Use the Repeater Web Panel](./web-panel.md)
- [Build Locally With uv](./local-builds.md)
- [Custom CLI Commands](./custom-cli.md)
## Developer Notes
- [Build Locally With uv](./local-builds.md)
## Current Scope
This docs site only covers the EastMesh-specific pieces in this repository.
+3 -4
Просмотреть файл
@@ -54,7 +54,6 @@ Confirm the repeater is up and connected with:
- `get wifi.status`
- `get mqtt.status`
- `get mqtt.statuscfg`
## Validate In The Web Console
@@ -79,7 +78,7 @@ Notes:
Some MQTT CLI commands from the previous firmware do not apply in EastMesh and should not be migrated.
The previous firmware stored its MQTT bridge settings in a different place and shape than EastMesh does now. In the old firmware, `MQTTBridge` used legacy node preferences for items such as broker host, port, analyzers, TX enable, owner key, email, and IATA. In EastMesh, the current Wi-Fi and MQTT uplink settings are stored separately in `/mqtt_prefs`.
EastMesh stores its current Wi-Fi and MQTT uplink settings separately from the older firmware, so older broker and analyzer settings do not carry forward in a useful way. After flashing, re-enter the settings you still use now, rather than expecting the old MQTT bridge configuration to map across.
These previous MQTT CLI commands no longer apply in EastMesh:
@@ -90,7 +89,7 @@ These previous MQTT CLI commands no longer apply in EastMesh:
- `get mqtt.analyzer.eu`
- `get mqtt.config.valid`
If you flash without erase first, older legacy values may still remain in flash in the background. The important point is that EastMesh does not use those old MQTT bridge values for its current uplink configuration, so users should not expect them to carry forward or have any effect.
If you flash without erase first, some old values may still remain in flash in the background. The important point is that EastMesh does not use those old MQTT bridge values for its current uplink configuration, so users should not expect them to carry forward or have any effect.
## Recommended Migration Flow
@@ -100,7 +99,7 @@ If you flash without erase first, older legacy values may still remain in flash
4. Optionally set `mqtt.owner` and `mqtt.email`.
5. If you previously had TX publishing disabled, set `mqtt.tx off`.
6. Reboot the repeater.
7. Verify with `get wifi.status`, `get mqtt.status`, and `get mqtt.statuscfg`.
7. Verify with `get wifi.status` and `get mqtt.status`.
8. Optionally confirm local web access with `set web on`, `get web.status`, and `https://<IP_ADDRESS>/`.
## Related Docs
+4 -2
Просмотреть файл
@@ -61,9 +61,11 @@ Recommended usage:
Typical first steps after flashing:
- set radio parameters
- set WiFi credentials
- set `wifi.ssid`
- set `wifi.pwd`
- set `mqtt.iata`
- confirm `get mqtt.status`
- optionally set `mqtt.owner` and `mqtt.email`
- optionally enable `letsmesh-eu` or `letsmesh-us`
## Companion WiFi Notes
+10
Просмотреть файл
@@ -125,9 +125,19 @@ This section includes:
- owner public key
- `mqtt.email`
- owner contact email
- MQTT server toggles
- `eastmesh-au`
- `letsmesh-eu`
- `letsmesh-us`
`MEL` is used as the default dropdown option until the repeater's saved value is loaded.
Notes:
- the current MQTT server states are loaded when the page opens
- you can toggle each MQTT server on or off from this panel
- if all three servers are enabled at once, the panel shows a warning recommending two at most
## Stats
Press `Get Stats` to load the dashboard.