docs(cli): describe the queued OTA check and NTP diagnostic

Both commands now return immediately and are polled by repeating them.
Documents the cached result windows and the new `get mqtt.runtime`.
This commit is contained in:
agessaman committed 2026-09-21 16:06:24 -07:00
1 parent 629bee3aa0
commit fbc82ae22c
3 files changed
+12 -5

No files matched your search

+8 -2
View File
@@ -1279,12 +1279,14 @@ region save
**Usage:**
- `get mqtt.ntp.diag`
**Description:** Probes every configured NTP server (the custom primary, if set, plus the built-in fallbacks) and reports whether each responds. This is a pure connectivity diagnostic — it does **not** change the system clock.
**Description:** Queues a probe of every configured NTP server and returns immediately. Repeat the command to poll. Completed results include the request ID and age and are cached for 30 seconds; a later call queues a new probe. This diagnostic does **not** change the system clock.
- **Serial console:** prints a detailed table with each server's reported UTC time (or `FAIL`).
- **Over LoRa:** returns a compact `<server> ok|fail` list, one per line.
Requires WiFi connected and the MQTT bridge running.
Requires a connected network and the MQTT bridge running.
`get mqtt.runtime` reports the worker sample sequence and age, desired/applied configuration revisions, and lost SDK event count. Applied configuration does not imply a successful broker connection.
---
@@ -1374,3 +1376,7 @@ Ethernet support is available on RAK4631 boards with a RAK13800 (W5100S) Etherne
- Connect with any TCP client (e.g. `nc`, PuTTY) to access the same CLI available over serial.
---
### Observer OTA checks
`ota check` queues a manifest check and returns immediately. Repeat it for the result, which is cached for 60 seconds and includes an ID and age. If `ota update` returns a queued/running check, repeat `ota update` after the check finishes to request flashing. A pending check never starts an update. Actual updates retain the deferred bridge-stop barrier and revalidate the manifest before flashing.