Add scheduled telemetry history packets
This commit is contained in:
1 parent
c0aeb8fc3a
commit
8ffafddd6a
7 files changed
+588
-7
No files matched your search
@@ -69,7 +69,7 @@ fix, no WiFi connection, an inactive bridge, or an nRF52 bootloader without
|
||||
| Statistics | [`stats-radio`](cli_commands.md#radio-stats---noise-floor-last-rssisnr-airtime-receive-errors) | Local serial | Serial | Serial | Serial |
|
||||
| Statistics | [`stats-radio-diag`](#stats-radio-diag) | Local serial | Serial | Serial | Serial |
|
||||
| Statistics | [`stats-packets`](cli_commands.md#packet-stats---packet-counters-received-sent) | Local serial | Serial | Serial | Serial |
|
||||
| Statistics | [`get telemetry.temp/volt/gps`; `set telemetry.gps`](cli_commands.md#read-repeater-telemetry-history) | Non-STM32 repeater; remote access requires administrator | Yes | Yes | Yes |
|
||||
| Statistics | [`get telemetry.temp/volt`; optional GPS history; `get/set telemetry.tx`](cli_commands.md#read-repeater-telemetry-history) | Non-STM32 repeater; GPS commands require a GPS provider; remote access requires administrator | Yes | Yes | Yes |
|
||||
| Logging | [`log start`; `log stop`; `log erase`](cli_commands.md#logging) | Storage-backed roles retain data; other roles can return empty data | Yes | Yes | Yes |
|
||||
| Logging | [`log`](cli_commands.md#print-the-captured-log-to-the-serial-terminal) | Local serial | Serial | Serial | Serial |
|
||||
| Radio | [`get radio`; `set radio ...`](cli_commands.md#view-or-change-this-nodes-radio-parameters) | All text CLI roles | Yes | Yes | Yes |
|
||||
@@ -225,7 +225,7 @@ fix, no WiFi connection, an inactive bridge, or an nRF52 bootloader without
|
||||
| Statistics | [`stats-radio`](cli_commands.md#radio-stats---noise-floor-last-rssisnr-airtime-receive-errors) | Local serial | Serial | Serial | Serial | No | No | Serial | Serial |
|
||||
| Statistics | [`stats-radio-diag`](#stats-radio-diag) | Local serial | Serial | Serial | Serial | No | No | Serial | Serial |
|
||||
| Statistics | [`stats-packets`](cli_commands.md#packet-stats---packet-counters-received-sent) | Local serial | Serial | Serial | Serial | No | No | Serial | Serial |
|
||||
| Statistics | [`get telemetry.temp/volt/gps`; `set telemetry.gps`](cli_commands.md#read-repeater-telemetry-history) | Non-STM32 repeater; remote access requires administrator | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
|
||||
| Statistics | [`get telemetry.temp/volt`; optional GPS history; `get/set telemetry.tx`](cli_commands.md#read-repeater-telemetry-history) | Non-STM32 repeater; GPS commands require a GPS provider; remote access requires administrator | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
|
||||
| Logging | [`log start`; `log stop`; `log erase`](cli_commands.md#logging) | Storage-backed roles retain data | Yes | Yes | Yes | No | No | Yes | Yes |
|
||||
| Logging | [`log`](cli_commands.md#print-the-captured-log-to-the-serial-terminal) | Local serial | Serial | Serial | Serial | No | No | Serial | Serial |
|
||||
| Radio | [`get radio`; `set radio ...`](cli_commands.md#view-or-change-this-nodes-radio-parameters) | All text CLI roles | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
|
||||
|
||||
+56
-4
@@ -306,10 +306,11 @@ refresh is already in flight, the scope pass is queued behind it.
|
||||
### Read repeater telemetry history
|
||||
|
||||
Repeater firmware records one UTC-aligned sample every 30 minutes. Temperature
|
||||
and battery voltage retain 336 samples (seven rolling days). GPS retains three
|
||||
days by default. Sensor builds with an onboard GPS provider request a seven-day
|
||||
default at startup. The history and any runtime retention change are held in
|
||||
RAM and reset after a reboot.
|
||||
and battery voltage retain 336 samples (seven rolling days). GPS-capable builds
|
||||
retain three GPS days by default and request a seven-day default at startup.
|
||||
Builds without a GPS provider omit the GPS history commands to conserve flash.
|
||||
The history and any runtime retention change are held in RAM and reset after a
|
||||
reboot.
|
||||
|
||||
The feature is omitted from flash-constrained STM32 repeater images.
|
||||
|
||||
@@ -319,6 +320,10 @@ The feature is omitted from flash-constrained STM32 repeater images.
|
||||
- `get telemetry.volt [page]`
|
||||
- `get telemetry.gps [page]`
|
||||
- `set telemetry.gps <days>`
|
||||
- `get telemetry.tx`
|
||||
- `set telemetry.tx <off|direct|path>`
|
||||
- `set telemetry.tx schedule <off|1-30d>`
|
||||
- `send telemetry.tx now`
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -331,6 +336,12 @@ The feature is omitted from flash-constrained STM32 repeater images.
|
||||
needed to leave at least 2048 bytes free and replies with the days and pages
|
||||
actually available. For example, a request can return
|
||||
`OK - telemetry.gps days=18 pages=36 requested=30`.
|
||||
- `direct`: Send the binary temperature and voltage snapshots zero-hop to a
|
||||
neighboring MQTT observer.
|
||||
- `path`: A comma-separated direct route using the same one-, two-, or
|
||||
three-byte hop hashes accepted by `set outpath`.
|
||||
- `schedule`: Automatic interval in whole days. The default is `2d`; `off`
|
||||
retains the configured direct path for manual test sends.
|
||||
|
||||
Local serial and remote administrator CLI sessions can read the history.
|
||||
Collection uses the MCU temperature, battery voltage, and an already-valid
|
||||
@@ -345,6 +356,47 @@ Use the browser-based [Telemetry history decoder](telemetry_decoder.md) to
|
||||
turn a reply into a timestamped table or downloadable CSV without uploading
|
||||
the data.
|
||||
|
||||
`telemetry.tx` is disabled by default. Its schedule and direct path are stored
|
||||
across reboots. Configuring `direct` or a routed path enables the default `2d`
|
||||
schedule; `set telemetry.tx schedule` changes it from one through 30 days or
|
||||
turns it off. An automatic run waits until 165 half-hour positions are
|
||||
available, then sends one maximum-size temperature packet and one maximum-size
|
||||
voltage packet. GPS is never included in this raw transmission. The history
|
||||
remains boot-local, so the first scheduled pair after a reboot needs about
|
||||
82.5 hours to fill. On the default two-day interval, each 82.5-hour packet
|
||||
overlaps the previous packet by 34.5 hours. A queue failure is retried after
|
||||
30 minutes only for the packet that did not queue; successfully queued packets
|
||||
are not duplicated.
|
||||
|
||||
`send telemetry.tx now` is an administrator-only test action. It immediately
|
||||
queues one temperature and one voltage direct packet over the configured path,
|
||||
using all currently available positions up to 165. It works while the schedule
|
||||
is off and does not move the next scheduled send time. RAW_CUSTOM direct
|
||||
packets do not enter the normal encrypted direct-message retry mechanism.
|
||||
|
||||
Full snapshots are 184-byte RAW_CUSTOM payloads. Manual tests can be shorter
|
||||
while history fills. Both formats are binary, not Base64 and not encrypted:
|
||||
|
||||
| Bytes | Meaning |
|
||||
|---|---|
|
||||
| `0`-`3` | ASCII magic `TTB1` for temperature or `TVB1` for voltage |
|
||||
| `4`-`11` | First eight bytes of the repeater public key |
|
||||
| `12`-`15` | First sample UTC epoch, unsigned 32-bit little-endian |
|
||||
| `16`-`17` | Sample interval in minutes, unsigned 16-bit little-endian (`30`) |
|
||||
| `18` | Sample count (`1`-`165`) |
|
||||
| `19` onward | Oldest-to-newest encoded samples for the selected series |
|
||||
|
||||
Temperature codes reserve `0` for no reading, `1` for below `-50 C`, and `2`
|
||||
for above `+77 C`. Codes `3` through `130` represent exact whole degrees from
|
||||
`-50 C` through `+77 C`; decode them as `code - 53`. Voltage codes use the
|
||||
same encoding as the paged voltage payload documented below.
|
||||
|
||||
Match bytes `4`-`11` to the first 16 hex characters of the repeater public key
|
||||
shown by its advert or `get public.key`. This compact identifier is useful for
|
||||
association but is not authenticated and can be spoofed. An MQTT observer can
|
||||
upload the received raw packet to LetsMesh Analyzer `/packets`; its packet hex
|
||||
contains the direct-route header and path followed by this payload.
|
||||
|
||||
Temperature payload (`0x11`, 61 bytes):
|
||||
|
||||
| Bytes | Meaning |
|
||||
|
||||
@@ -75,7 +75,7 @@ set flood.retry.ignore none
|
||||
|
||||
| Setting | What it does | How to use | Example |
|
||||
| --- | --- | --- | --- |
|
||||
| `telemetry.temp`, `telemetry.volt`, `telemetry.gps` | Records 30-minute whole-degree MCU temperature and battery samples for seven days. GPS defaults to three days, or requests seven days at startup on onboard-GPS sensor builds. Runtime GPS retention can be `1`-`30` days and is reduced if needed to retain 2 KB of free memory. Pages are 1-based and newest first. History and runtime sizing reset on reboot. | `get telemetry.temp [page]`, `get telemetry.volt [page]`, `get telemetry.gps [page]`, `set telemetry.gps <1-30>` | `set telemetry.gps 30` |
|
||||
| `telemetry.temp`, `telemetry.volt`, `telemetry.gps` | Records 30-minute MCU temperature and battery samples for seven days. GPS-capable builds retain GPS separately for authenticated paging. `telemetry.tx` sends one temperature RAW_CUSTOM packet and one voltage packet over a configured direct path, on a persistent 1-30 day schedule (default two days) or immediately for testing; GPS is never included. Scheduled packets contain 165 points. History resets on reboot. | `get telemetry.temp [page]`, `get telemetry.volt [page]`, `get telemetry.gps [page]`, `set telemetry.gps <1-30>`, `get telemetry.tx`, `set telemetry.tx <off|direct|path>`, `set telemetry.tx schedule <off|1-30d>`, `send telemetry.tx now` | `set telemetry.tx A1B2,C3D4` |
|
||||
| `battery.alert` | Sends opt-in, region-scoped low-battery warnings to `#repeaters` after 30 minutes of uptime. | `get battery.alert`, `get battery.alert.region`, `set battery.alert on [region]`, `set battery.alert off` | `set battery.alert on sea` |
|
||||
| `battery.alert.low` | Warning threshold percentage. Must be greater than `battery.alert.critical`. | `get battery.alert.low`, `set battery.alert.low <1-100>` | `set battery.alert.low 20` |
|
||||
| `battery.alert.critical` | Critical threshold percentage. Critical and warning alerts use the same 12-hour resend cooldown. | `get battery.alert.critical`, `set battery.alert.critical <0-99>` | `set battery.alert.critical 10` |
|
||||
|
||||
Reference in new issue
Block a user