From cc885674a7810aa446d59c1630dcaf2747843433 Mon Sep 17 00:00:00 2001 From: Blake Latchford Date: Fri, 6 Nov 2026 20:46:07 -0500 Subject: [PATCH] docs: describe stats-core output and its error flags Document the stats-core output fields and decode the `errors` bitmask (shown as "Debug flags" in the app), from the ERR_EVENT_* flags in Dispatcher.h, and note that the flags stay set until reboot or `clear stats`. Fixes #3039 Co-Authored-By: Claude Opus 5.5 --- docs/cli_commands.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/cli_commands.md b/docs/cli_commands.md index 9fde4d436..f41a304a3 100644 --- a/docs/cli_commands.md +++ b/docs/cli_commands.md @@ -142,6 +142,18 @@ This document provides an overview of CLI commands that can be sent to MeshCore **Serial Only:** Yes +**Note:** Output format: `{"battery_mv":,"uptime_secs":,"errors":,"queue_len":}` + +**Note:** `errors` is a bitmask shown as "Debug flags" in the app's repeater status. + +| Value | Flag | Meaning | +|-------|------|---------| +| 1 | `ERR_EVENT_FULL` | A packet failed to send because the memory pool was full. | +| 2 | `ERR_EVENT_CAD_TIMEOUT` | After waiting 4 seconds for a gap, a packet was transmitted into a busy network. | +| 4 | `ERR_EVENT_STARTRX_TIMEOUT` | The radio was out of receive mode for more than 8 seconds. | + +Flags stay set until the node reboots or `clear stats` is run. + --- ### Radio Stats - Noise floor, Last RSSI/SNR, Airtime, Receive errors