Add configurable repeater telemetry history
This commit is contained in:
1 parent
bb348ac83c
commit
3ba0fb1847
8 files changed
+1334
No files matched your search
@@ -69,6 +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 |
|
||||
| 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 |
|
||||
@@ -224,6 +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 |
|
||||
| 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 |
|
||||
|
||||
@@ -303,6 +303,101 @@ 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.
|
||||
|
||||
The feature is omitted from flash-constrained STM32 repeater images.
|
||||
|
||||
**Usage:**
|
||||
|
||||
- `get telemetry.temp [page]`
|
||||
- `get telemetry.volt [page]`
|
||||
- `get telemetry.gps [page]`
|
||||
- `set telemetry.gps <days>`
|
||||
|
||||
**Parameters:**
|
||||
|
||||
- `page`: Page `1` is always newest. Temperature and voltage pages each hold
|
||||
24 hours and accept `1`-`7`. GPS pages each hold 12 hours and accept `1`
|
||||
through twice the current GPS retention in days. Omitting the page selects
|
||||
page `1`.
|
||||
- `days`: Requested GPS retention from `1` through `30` days. Retention above
|
||||
three days uses heap memory. The allocator reduces the requested value as
|
||||
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`.
|
||||
|
||||
Local serial and remote administrator CLI sessions can read the history.
|
||||
Collection uses the MCU temperature, battery voltage, and an already-valid
|
||||
onboard GPS fix. It does not wake GPS, so an off, sleeping, or unfixed GPS
|
||||
produces a missing location sample without changing its power-saving schedule.
|
||||
|
||||
Replies contain `> ` followed by standard padded Base64. After decoding, all
|
||||
multi-byte integers are little-endian. Packed fields are written most
|
||||
significant bit first, oldest sample first.
|
||||
|
||||
Temperature payload (`0x11`, 61 bytes):
|
||||
|
||||
| Bytes | Meaning |
|
||||
|---|---|
|
||||
| `0` | Format/type `0x11` |
|
||||
| `1`-`4` | First sample UTC epoch, unsigned 32-bit |
|
||||
| `5` | Sample interval in minutes (`30`) |
|
||||
| `6` | Sample count (`48`) |
|
||||
| `7`-`18` | 48 packed 2-bit temperature statuses |
|
||||
| `19`-`60` | 48 packed 7-bit temperatures |
|
||||
|
||||
Temperature status codes are `0` none, `1` value, `2` below range, and `3`
|
||||
above range. For status `1`, the 7-bit temperature is an exact whole-degree
|
||||
integer from `-50 C` through `+77 C`; decode it as `code - 50`. Low values use
|
||||
code `0`, and high values use code `127`. The separate status map is required
|
||||
because 7 bits contain exactly 128 codes, leaving no spare code for none, low,
|
||||
or high when the complete range is represented at 1 C resolution. No
|
||||
fractional temperature is stored or transmitted.
|
||||
|
||||
Voltage payload (`0x12`, 55 bytes):
|
||||
|
||||
| Bytes | Meaning |
|
||||
|---|---|
|
||||
| `0` | Format/type `0x12` |
|
||||
| `1`-`4` | First sample UTC epoch, unsigned 32-bit |
|
||||
| `5` | Sample interval in minutes (`30`) |
|
||||
| `6` | Sample count (`48`) |
|
||||
| `7`-`54` | 48 8-bit voltage codes |
|
||||
|
||||
Voltage codes reserve `0` for no reading, `1` for below `1.88 V`, and `255`
|
||||
for above `4.40 V`. Codes `2`-`254` represent `1.88 V` through `4.40 V` in
|
||||
`0.01 V` steps; decode millivolts as `1880 + (code - 2) * 10`.
|
||||
|
||||
GPS payload (`0x13`, 101 bytes):
|
||||
|
||||
| Bytes | Meaning |
|
||||
|---|---|
|
||||
| `0` | Format/type `0x13` |
|
||||
| `1`-`4` | First sample UTC epoch, unsigned 32-bit |
|
||||
| `5` | Sample interval in minutes (`30`) |
|
||||
| `6` | Sample count (`24`) |
|
||||
| `7`-`10` | Page origin latitude in signed degrees times `10^7` |
|
||||
| `11`-`14` | Page origin longitude in signed degrees times `10^7` |
|
||||
| `15` | Origin sample index, or `255` when the page has no GPS fix |
|
||||
| `16` | Flags; bit 0 means at least one differential was clipped |
|
||||
| `17`-`100` | 24 records: signed 14-bit north then signed 14-bit east |
|
||||
|
||||
GPS differentials use signed 14-bit two's-complement values at 10-meter
|
||||
resolution and are applied to the preceding decoded valid point. The origin
|
||||
sample begins at the header coordinates. A no-fix slot encodes `0,0` and does
|
||||
not advance the reference; a stationary valid fix also quantizes to `0,0`.
|
||||
When a page has no fixes, its origin is `0,0`, origin index is `255`, and all
|
||||
differentials are `0,0`. Values outside `-8192` through `8191` are clipped and
|
||||
set flag bit 0.
|
||||
|
||||
---
|
||||
|
||||
## Logging
|
||||
|
||||
Builds compiled with `MESH_PACKET_LOGGING` emit one `RAW:` line for every
|
||||
|
||||
@@ -75,6 +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` |
|
||||
| `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