dandri/HaloKeymind
1
0
Fork 0
mirror of https://github.com/mikecarper/MeshCore.git synced 2026-07-24 17:01:07 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f12e1b2deaf15a8996ff1adc6daabd3e97cda3df
HaloKeymind/docs/cli_commands.md
T

74 KiB
Raw Blame History

CLI Commands

This document provides an overview of CLI commands that can be sent to MeshCore Repeaters, Room Servers and Sensors.

Navigation

Operational

Reboot the node

Usage:

  • reboot

Note: No reply is sent.

Power-off the node

Usage:

  • poweroff, or
  • shutdown

Note: No reply is sent.

Enter the UF2 bootloader (nRF52 only)

Usage:

  • uf2reset

Serial Only: Yes

Note: Reboots directly into the UF2 bootloader on supported nRF52 boards.

Reset the clock and reboot

Usage:

  • clkreboot

Note: No reply is sent.

Sync the clock with the remote device

Usage:

  • clock sync

Display current time in UTC

Usage:

  • clock

Set the time to a specific timestamp

Usage:

  • time <epoch_seconds>

Parameters:

  • epoch_seconds: Unix epoch time

Send a flood advert

Usage:

  • advert

Send a zero-hop advert

Usage:

  • advert.zerohop

Start or stop an Over-The-Air (OTA) firmware update

Usage:

  • start ota
  • stop ota

Erase/Factory Reset

Usage:

  • erase

Serial Only: Yes

Warning: This is destructive!

Neighbors (Repeater Only)

List nearby neighbors

Usage:

  • neighbors

Note: The output of this command is limited to the 8 most recent adverts.

Note: Each line is encoded as {pubkey-prefix}:{timestamp}:{snr*4}

Remove a neighbor

Usage:

  • neighbor.remove <pubkey_prefix>

Parameters:

  • pubkey_prefix: The public key of the node to remove from the neighbors list

Discover zero hop neighbors

Usage:

  • discover.neighbors

Statistics

Clear Stats

Usage: clear stats

System Stats - Battery, Uptime, Queue Length and Debug Flags

Usage:

  • stats-core

Serial Only: Yes

Radio Stats - Noise floor, Last RSSI/SNR, Airtime, Receive errors

Usage: stats-radio

Serial Only: Yes

Packet stats - Packet counters: Received, Sent

Usage: stats-packets

Serial Only: Yes

Logging

Begin capture of rx log to node storage

Usage: log start

End capture of rx log to node storage

Usage: log stop

Erase captured log

Usage: log erase

Print the captured log to the serial terminal

Usage: log

Serial Only: Yes

Info

Get the Version

Usage: ver

Show the hardware name

Usage: board

Configuration

Radio

View or change this node's radio parameters

Usage:

  • get radio
  • set radio <freq>,<bw>,<sf>,<cr>

Parameters:

  • freq: Frequency in MHz
  • bw: Bandwidth in kHz. Most targets allow 7.8, 10.4, 15.6, 20.8, 31.25, 41.7, 62.5, 125, 250, 500. LR1110 targets allow 62.5, 125, 250, 500.
  • sf: Spreading factor (5-12)
  • cr: Coding rate (5-8)

Set by build flag: LORA_FREQ, LORA_BW, LORA_SF, LORA_CR

Default: 869.525,250,11,5

Note: Requires reboot to apply

View or change this node's transmit power

Usage:

  • get tx
  • set tx <dbm>

Parameters:

  • dbm: Power level in dBm (1-22)

Set by build flag: LORA_TX_POWER

Default: Varies by board

Notes: This setting only controls the power level of the LoRa chip. Some nodes have an additional power amplifier stage which increases the total output. Refer to the node's manual for the correct setting to use. Setting a value too high may violate the laws in your country.

Change the radio parameters for a set duration

Usage:

  • tempradio <freq>,<bw>,<sf>,<cr>,<timeout_mins>

Parameters:

  • freq: Frequency in MHz (150-2500)
  • bw: Bandwidth in kHz (same allowed values as set radio)
  • sf: Spreading factor (5-12)
  • cr: Coding rate (5-8)
  • timeout_mins: Duration in minutes (must be > 0)

Note: This is not saved to preferences and will clear on reboot

Schedule radio parameter changes

Usage:

  • set radioat <freq>,<bw>,<sf>,<cr>,<start_time>
  • get radioat [n|all]
  • del radioat [n|all]
  • set tempradioat <freq>,<bw>,<sf>,<cr>,<start_time>,<end_time>
  • get tempradioat [n|all]
  • del tempradioat [n|all]

Parameters:

  • freq: Frequency in MHz (150-2500)
  • bw: Bandwidth in kHz (same allowed values as set radio)
  • sf: Spreading factor (5-12)
  • cr: Coding rate (5-8)
  • start_time: Unix epoch time when the setting starts
  • end_time: Unix epoch time when a temporary setting reverts
  • n: Scheduled entry number from get radioat or get tempradioat

Notes:

  • get radioat and get tempradioat list all entries when n is omitted.
  • del radioat and del tempradioat delete all entries when n is omitted.
  • Each queue supports 3 entries. Scheduled entries are not saved across reboot.
  • radioat saves the new radio preferences when it fires. tempradioat applies temporarily, then reverts to the saved radio preferences.

View or change this node's frequency

Usage:

  • get freq
  • set freq <frequency>

Parameters:

  • frequency: Frequency in MHz

Default: 869.525

Note: Requires reboot to apply Serial Only: set freq <frequency>

View or change this node's rx boosted gain mode (SX12xx and LR1110, v1.14.1+)

Usage:

  • get radio.rxgain
  • set radio.rxgain <state>

Parameters:

  • state: on|off

Default: on

Temporary Note: If you upgraded from an older version to 1.14.1 without erasing flash, this setting is off because of #2118

View or change the LoRa FEM receive-path gain state on supported boards

Usage:

  • get radio.fem.rxgain
  • set radio.fem.rxgain <state>

Parameters:

  • state: on|off

Notes:

  • This controls the external LoRa FEM receive-path LNA where the board supports it.
  • This is separate from radio.rxgain, which controls the radio chip receive gain mode.

System

View or change this node's name

Usage:

  • get name
  • set name <name>

Parameters:

  • name: Node name

Set by build flag: ADVERT_NAME

Default: Varies by board

Note: Max length varies. If a location is set, the max length is 24 bytes; 32 otherwise. Emoji and unicode characters may take more than one byte.

View or change this node's latitude

Usage:

  • get lat
  • set lat <degrees>

Set by build flag: ADVERT_LAT

Default: 0

Parameters:

  • degrees: Latitude in degrees

View or change this node's longitude

Usage:

  • get lon
  • set lon <degrees>

Set by build flag: ADVERT_LON

Default: 0

Parameters:

  • degrees: Longitude in degrees

View or change this node's identity (Private Key)

Usage:

  • get prv.key
  • set prv.key <private_key>

Parameters:

  • private_key: Private key in hex format (64 hex characters)

Serial Only:

  • get prv.key: Yes
  • set prv.key: No

Note: Requires reboot to take effect after setting

Change this node's admin password

Usage:

  • password <new_password>

Parameters:

  • new_password: New admin password

Set by build flag: ADMIN_PASSWORD

Default: password

Note: Command reply echoes the updated password for confirmation.

Note: Any node using this password will be added to the admin ACL list.

View or change this node's guest password

Usage:

  • get guest.password
  • set guest.password <password>

Parameters:

  • password: Guest password

Set by build flag: ROOM_PASSWORD (Room Server only)

Default: <blank>

View or change this node's owner info

Usage:

  • get owner.info
  • set owner.info <text>

Parameters:

  • text: Owner information text

Default: <blank>

Note: | characters are translated to newlines

Note: Requires firmware 1.12+

Fine-tune the battery reading

Usage:

  • get adc.multiplier
  • set adc.multiplier <value>

Parameters:

  • value: ADC multiplier (0.0-10.0)

Default: 0.0 (value defined by board)

Note: Returns "Error: unsupported by this board" if hardware doesn't support it

Send a repeater flood text

Usage:

  • send text.flood <message>

Parameters:

  • message: Text to send to the shared #repeaters flood channel, prefixed with this node's name. Any : in the node name is sent as ; so the prefix delimiter stays unambiguous.

Example:

send text.flood checking ridge link

View or change battery alert state

Usage:

  • get battery.alert
  • get battery.alert.region
  • set battery.alert on [region]
  • set battery.alert off

Parameters:

  • region: Optional named region scope. When omitted, the repeater selects the single deepest (most narrow) named region in the configured hierarchy. If multiple regions tie for deepest, specify one explicitly.

Defaults:

  • battery.alert: off
  • battery.alert.region: <unset>

Notes:

  • Enabling fails until at least one usable named region is defined. Alerts are never sent as unscoped floods. If the selected region is later removed, alerts stop until battery alerts are enabled again with a valid region.
  • Region hierarchy edits are not persistent until region save is run. After region def west pnw wa w-wa sea, run region save before enabling the alert if the hierarchy must survive a reboot.
  • A region must have a usable transport key. Public named regions derive one automatically; a private region without an available key is rejected.
  • The first alert is suppressed until the repeater has been up for at least 30 minutes. After that, the repeater checks every 30 minutes and sends low-battery warnings to the #repeaters channel in the selected region.
  • Once an alert finishes transmitting, another battery alert is suppressed for at least 12 hours. A queue rejection, stale-queue drop, or radio send failure does not start the cooldown. Battery recovery or toggling alerts off and back on does not bypass a completed alert's cooldown during the same boot.
  • With region def west pnw wa w-wa sea, set battery.alert on selects sea; set battery.alert on w-wa overrides that default.
  • get battery.alert.region returns the selected scope, for example > sea.
  • The battery check never requests a wake earlier than its 30-minute deadline. If the normal loop is already awake when that deadline has elapsed, the check is effectively free of an additional wake. Time in light/event sleep counts toward the startup delay, and a pending alert keeps the repeater awake until the packet is handled.

View or change battery alert thresholds

Usage:

  • get battery.alert.low
  • set battery.alert.low <1-100>
  • get battery.alert.critical
  • set battery.alert.critical <0-99>

Defaults:

  • battery.alert.low: 20
  • battery.alert.critical: 10

Note: The low threshold must be greater than the critical threshold. Alerts at or below the critical threshold use CRITICAL BATTERY in the message; both severities use the same 12-hour resend cooldown.

Enable or disable the RX inactivity watchdog (Repeater Only)

Usage:

  • get rx.watchdog
  • set rx.watchdog on
  • set rx.watchdog off

Default: off

Notes:

  • When enabled, the first check is due after a full 12-hour observation window. The repeater then checks roughly every 12 hours and reboots if it has not successfully received a radio packet during the preceding 12 hours.
  • Enabling the watchdog starts a new 12-hour observation window. Rebooting also starts a new window, so a quiet mesh can reboot no more often than once every 12 hours.
  • The check reuses the radio driver's existing last-receive timestamp. It does not poll, sample, or wake the radio or CPU. A due check waits for the next normal loop/wake, so its actual cadence can drift around the 12-hour target. With RX power saving enabled, packets received during normal listening windows count as activity; the watchdog does not alter the RX/sleep timing.

Estimate and correct repeater time after startup

Usage:

  • get clock.sync
  • get clock.sync.status
  • get clock.sync.mesh
  • set clock.sync.mesh <on|off>
  • get clock.sync.internet
  • set clock.sync.internet <on|off>
  • get clock.sync.drift
  • set clock.sync.drift <30-86400>
  • get clock.sync.samples
  • set clock.sync.samples <3-16>

Defaults:

  • clock.sync.mesh: off
  • clock.sync.internet: off
  • clock.sync.drift: 3600 seconds
  • clock.sync.samples: 9

When either source is enabled, the repeater makes its first clock-bootstrap attempt after 30 minutes of uptime. A successful estimate changes the RTC only when the absolute difference is greater than clock.sync.drift; correction can move the clock forward or backward. A valid estimate within the threshold completes the one-time check without changing the clock. If no source is available yet, the repeater retries every 30 minutes.

clock.sync.mesh collects signature-verified advert timestamps and MAC-valid, decrypted Public-channel plain-text timestamps, but only after the packet passes every forwarding filter. Sources are deduplicated by advert public key or case-insensitive Public-channel display name. Every fresh sample must also have a different full received path; all direct, zero-hop receptions count as the same empty path. This prevents repeated packets or multiple names arriving over one route from increasing the vote count.

At least the configured number of distinct fresh paths (nine by default) and a strict majority of all fresh samples must fall within ten minutes of the median. The effective quorum is therefore the larger of clock.sync.samples and half the fresh sample count plus one. For example, a 9-vs-7 split can succeed but an 8-vs-8 split cannot. The median is used. clock.sync.samples accepts 3 through 16; samples older than two hours are ignored. Status reports collecting when fewer than the configured number of paths exist, and no consensus when enough paths exist but the effective quorum does not agree.

A timestamp is eligible for a clock-sync sample only when it falls between the UTC build epoch embedded by build.sh and that time plus ten calendar years. Direct developer builds that bypass build.sh fall back to the compiler timestamp. Validation happens before a slot is selected or written, so an advert or Public-channel timestamp outside that window is not recorded as a clock sample.

Before voting, the node advances each packet timestamp by an estimated transit time. The estimate sums the radio airtime at the original packet length and at each progressively longer relay length, plus the expected midpoint of the random flood-forward delay at every prior hop. The normal elapsed time since the radio recorded local receipt is then added when consensus is evaluated, so local signature/decryption/filter processing time is included too. This is better than using hop count alone because LoRa airtime changes with packet length and radio settings. Transit compensation is capped at the ten-minute consensus window. It cannot know sender queueing, channel contention, or a remote relay's non-matching txdelay, so the consensus window and median still absorb residual error.

If a clock sync or time <epoch> CLI command successfully sets the clock, or a GPS provider writes a valid GPS time, LoRa-derived clock collection and correction are suppressed for the rest of that boot. Turning clock.sync.mesh off and back on does not clear this safety latch; only a reboot does. get clock.sync.mesh and get clock.sync.status report whether CLI or GPS time caused the suppression. On a WiFi MQTT build, a successful NTP sync is authoritative and also suppresses LoRa correction for the rest of that boot. Source selection starts fresh after a reboot, so LoRa remains the fallback when NTP cannot obtain internet time during that boot.

Public-channel display names are not authenticated and can be spoofed. Received path hashes are also truncated, unauthenticated routing hints; requiring unique paths prevents ordinary duplicate-route inflation but is not a cryptographic identity check. Signed adverts authenticate the advert contents but do not prove that the advertising node's own clock is correct. Mesh time is therefore a consensus estimate, not an authoritative time service.

clock.sync.internet is available on WiFi MQTT repeater-observer builds. Its 30-minute query runs on the MQTT/WiFi task and is read-only until the repeater applies the configured drift test. On other repeater builds, the preference can be stored but status reports that internet time is unavailable. MQTT builds retain their existing startup NTP behavior required for MQTT/TLS/JWT operation; this setting controls the additional delayed drift check. Startup NTP is always preferred when it succeeds, regardless of this setting.

Changing any clock.sync.* setting starts a new attempt for the current boot. Settings are persistent in /clock_sync.

A backward correction is intentionally allowed, but peers that already recorded a later timestamp from this node may temporarily reject its lower timestamps as replays until corrected time passes the previously observed value.

Example:

set clock.sync.drift 1800
set clock.sync.samples 9
set clock.sync.mesh on
set clock.sync.internet on
get clock.sync.status

View this node's public key

Usage: get public.key

View this node's firmware version

Usage: ver

View this node's configured role

Usage: get role

View or change this node's power saving flag (Repeater Only)

Usage:

  • powersaving
  • powersaving on
  • powersaving off

Parameters:

  • on: enable power saving
  • off: disable power saving

Default: off

Note: When enabled, device enters sleep mode between radio transmissions. Enabling is refused from the local serial console or while an active USB serial data connection is detected; USB power alone does not block power saving.

Routing

View or change this node's repeat flag

Usage:

  • get repeat
  • set repeat <state>

Parameters:

  • state: on|off

Default: flood.channel.data on; flood.channel.data.hops h=all

View or change this node's advert path hash size

Usage:

  • get path.hash.mode
  • set path.hash.mode <value>

Parameters:

  • value: Path hash size (0-2)
    • 0: 1 Byte hash size (256 unique ids)[64 max flood]
    • 1: 2 Byte hash size (65,536 unique ids)[32 max flood]
    • 2: 3 Byte hash size (16,777,216 unique ids)[21 max flood]
    • 3: DO NOT USE (Reserved)

Default: 0

Note: the 'path.hash.mode' sets the low-level ID/hash encoding size used when the repeater adverts. This setting has no impact on what packet ID/hash size this repeater forwards, all sizes should be forwarded on firmware >= 1.14. This feature was added in firmware 1.14

Temporary Note: adverts with ID/hash sizes of 2 or 3 bytes may have limited flood propagation in your network while this feature is new as v1.13.0 firmware and older will drop packets with multibyte path ID/hashes as only 1-byte hashes are supported. Consider your install base of firmware >=1.14 has reached a criticality for effective network flooding before implementing higher ID/hash sizes.

View or change this node's loop detection

Usage:

  • get loop.detect
  • set loop.detect <state>

Parameters:

  • state:
    • off: no loop detection is performed
    • minimal: packets are dropped if repeater's ID/hash appears 4 or more times (1-byte), 2 or more (2-byte), 1 or more (3-byte)
    • moderate: packets are dropped if repeater's ID/hash appears 2 or more times (1-byte), 1 or more (2-byte), 1 or more (3-byte)
    • strict: packets are dropped if repeater's ID/hash appears 1 or more times (1-byte), 1 or more (2-byte), 1 or more (3-byte)

Default: off

Note: When it is enabled, repeaters will now reject flood packets which look like they are in a loop. This has been happening recently in some meshes when there is just a single 'bad' repeater firmware out there (probably some forked or custom firmware). If the payload is messed with, then forwarded, the same packet ends up causing a packet storm, repeated up to the max 64 hops. This feature was added in firmware 1.14

Example: If preference is loop.detect minimal, and a 1-byte path size packet is received, the repeater will see if its own ID/hash is already in the path. If it's already encoded 4 times, it will reject the packet. If the packet uses 2-byte path size, and repeater's own ID/hash is already encoded 2 times, it rejects. If the packet uses 3-byte path size, and the repeater's own ID/hash is already encoded 1 time, it rejects.

View or change the retransmit delay factor for flood traffic

Usage:

  • get txdelay
  • set txdelay <value>

Parameters:

  • value: Transmit delay factor (0-2)

Default: 0.5

Note: When multiple nearby repeaters all hear the same flood packet, each waits a random amount of time before retransmitting to avoid simultaneous collisions. This factor scales the size of that random window. Higher values reduce collision risk at the cost of added latency. 0 disables the window entirely.

View or change the retransmit delay factor for direct traffic

Usage:

  • get direct.txdelay
  • set direct.txdelay <value>

Parameters:

  • value: Direct transmit delay factor (0-2)

Default: 0.2

Note: Same collision-avoidance random window as txdelay, but applied to direct (non-flood, routed) traffic. The default is lower because direct packets are addressed to a specific next hop, so far fewer nodes compete to retransmit them.

[Experimental] View or change the processing delay for received traffic

Usage:

  • get rxdelay
  • set rxdelay <value>

Parameters:

  • value: Receive delay base (0-20)

Default: 0.0

Note: When enabled, repeaters that received a flood packet with a weak signal are held in a delay queue before processing, while those that received it with a strong signal process it immediately. This gives strong-signal paths forwarding priority. By the time weak-signal nodes process their copy, the packet may have already propagated and will be suppressed as a duplicate, reducing redundant retransmissions.

View or change the duty cycle limit

Usage:

  • get dutycycle
  • set dutycycle <value>

Parameters:

  • value: Duty cycle percentage (1-100)

Default: 50% (equivalent to airtime factor 1.0)

Examples:

  • set dutycycle 100 — no duty cycle limit
  • set dutycycle 50 — 50% duty cycle (default)
  • set dutycycle 10 — 10% duty cycle
  • set dutycycle 1 — 1% duty cycle (strictest EU requirement)

Note: Added in firmware v1.15.0

View or change the airtime factor (duty cycle limit)

Deprecated as of firmware v1.15.0. Use get/set dutycycle instead.

Usage:

  • get af
  • set af <value>

Parameters:

  • value: Airtime factor (0-9). After each transmission, the repeater enforces a silent period of approximately the on-air transmission time multiplied by the value. This results in a long-term duty cycle of roughly 1 divided by (1 plus the value). For example:
    • af = 1 → ~50% duty
    • af = 2 → ~33% duty
    • af = 3 → ~25% duty
    • af = 9 → ~10% duty You are responsible for choosing a value that is appropriate for your jurisdiction and channel plan (for example EU 868 Mhz 10% duty cycle regulation).

Default: 1.0

View or change the local interference threshold

Usage:

  • get int.thresh
  • set int.thresh <value>

Parameters:

  • value: Interference threshold value

Default: 0.0

Enable or disable hardware Channel Activity Detection (CAD)

Usage:

  • get cad
  • set cad <on|off>

Description: When enabled, the radio performs a hardware Channel Activity Detection scan before transmitting and defers if the channel is busy. Runs independently of int.thresh — either, both, or none may be active.

Parameters:

  • on|off: Enable or disable hardware CAD

Default: off

View or change the AGC Reset Interval

Usage:

  • get agc.reset.interval
  • set agc.reset.interval <value>

Parameters:

  • value: Interval in seconds rounded down to a multiple of 4 (17 becomes 16). 0 to disable.

Default: 0.0

View or change the radio watchdog interval

Usage:

  • get radio.watchdog
  • set radio.watchdog <minutes>

Parameters:

  • minutes: 0 to disable, or 1-120 minutes

Default: 5

Note: On quiet meshes, increasing this can reduce false recoveries when no traffic is expected.

Enable or disable Multi-Acks support

Usage:

  • get multi.acks
  • set multi.acks <state>

Parameters:

  • state: 0 (disable) or 1 (enable)

Default: 0

View or change the flood advert interval

Usage:

  • get flood.advert.interval
  • set flood.advert.interval <hours>

Parameters:

  • hours: Interval in hours (3-168)

Default: 12 (Repeater) - 0 (Sensor)

View or change the zero-hop advert interval

Usage:

  • get advert.interval
  • set advert.interval <minutes>

Parameters:

  • minutes: Interval in minutes rounded down to the nearest multiple of 2 (61 becomes 60) (60-240)

Default: 0

Limit the number of hops for a flood message

Usage:

  • get flood.max
  • set flood.max <value>

Parameters:

  • value: Maximum flood hop count (0-64)

Default: 64

Limit the number of hops for an unscoped flood message

Usage:

  • get flood.max.unscoped
  • set flood.max.unscoped <value>

Parameters:

  • value: Maximum flood hop count (0-64) for a packet without a scope (no region set)

Default: 0xFF - indicates it hasn't been set, will track flood.max until it is.

Note: An alternative to region denyf *, setting flood.max.unscoped to a lower value such as 3 would allow for local unscoped messages to propagate, while preventing noisy neighbors from flooding a local region.

Limit the number of hops for an advert flood message

Usage:

  • get flood.max.advert
  • set flood.max.advert <value>

Parameters:

  • value: Maximum flood hop count (0-64) for an advert packet

Default: 8

Forward flood group data packets on repeaters

Usage:

  • get flood.channel.data
  • get flood.channel.data.hops
  • set flood.channel.data <on|off>
  • set flood.channel.data.hops <all|1-7>

Parameters:

  • on: Retransmit received flood GRP_DATA channel packets.
  • off: Do not retransmit received flood GRP_DATA channel packets.
  • all: When flood.channel.data is off, block GRP_DATA at any received flood hop count.
  • 1-7: When flood.channel.data is off, repeat GRP_DATA at this hop count or lower and block longer paths.

Default: flood.channel.data on; flood.channel.data.hops h=all

Forwarding behavior: Repeater firmware only. The repeater still receives and logs the packet when logging is enabled; this only blocks retransmission. This is checked before flood.channel.block and applies to flood GRP_DATA packets regardless of channel key. Flood group text (GRP_TXT) is unaffected by this setting.

flood.channel.data.hops is separate from flood.channel.block.hops. flood.channel.block.hops does not restrict unkeyed GRP_DATA packets. With the default flood.channel.data on, GRP_DATA repeats normally even when flood.channel.block.hops is set for keyed channel blocks.

get flood.channel.data includes the active hop gate as h=all or h>N.

Block selected flood channel packets on repeaters

Usage:

  • get flood.channel.block
  • get flood.channel.block.<n>
  • get flood.channel.block <name|8_hex_prefix>
  • get flood.channel.block.hops
  • set flood.channel.block <key> <name> [h=<all|1-7|default>]
  • set flood.channel.block.<n> <key> <name> [h=<all|1-7|default>]
  • set flood.channel.block #channel [h=<all|1-7|default>]
  • set flood.channel.block.<n> #channel [h=<all|1-7|default>]
  • set flood.channel.block.hops <all|1-7>
  • del flood.channel.block.<n>
  • del flood.channel.block <name|8_hex_prefix>

Parameters:

  • n: Slot number from 1 to 15.
  • key: 128-bit or 256-bit channel key as hex.
  • #channel: Public hashtag channel name; derives the 128-bit channel key from the hashtag and is stored as the row name.
  • name: Local label for hex-key rows. Not needed for #channel; extra text after #channel is ignored unless it is a hop setting.
  • 8_hex_prefix: First 4 bytes of the derived channel hash, shown by single-entry get.
  • all: Block matching flood channel packets at any received flood hop count.
  • 1-7: Maximum received flood path hash count to repeat. Matching packets over this hop count are blocked.
  • default: Row inherits the global flood.channel.block.hops setting.

Slot behavior: Without .n, set flood.channel.block updates an existing row with the same derived channel prefix or name, otherwise it uses the next empty slot. If all 15 slots are full, the command fails. With .n, the command writes that slot.

Default row: Repeater firmware seeds a new block list with #wardriving h=4 in slot 1. This is a normal row, so it can be changed with set flood.channel.block #wardriving h=<all|1-7|default> or removed with del flood.channel.block #wardriving. Once the block list has been saved, the firmware uses the saved list and does not recreate the default after deletion. Restore the exact seeded row with:

set flood.channel.block.1 #wardriving h=4

This explicitly writes slot 1. Omit .1 to update an existing wardriving row or use the first empty slot instead.

Forwarding behavior: Repeater firmware only. This only affects received flood GRP_TXT and GRP_DATA channel packets. The repeater still receives and logs the packet, but it does not retransmit it when a configured block entry can validate/decode it. If flood.channel.data is off, GRP_DATA packets are checked against the separate flood.channel.data.hops gate before this per-channel check runs.

Hop gate: flood.channel.block.hops defaults to all, which preserves the original behavior. When set to N from 1 to 7, block rows that inherit the global setting only block packets whose received flood path hash count is greater than N; packets at N hops or lower can still repeat. For example, set flood.channel.block.hops 1 repeats zero-hop and one-hop matches but blocks two-hop and longer matches.

Each block row can override the global hop gate with h=<all|1-7|default>. For example, the seeded #wardriving h=4 row blocks #wardriving matches above four hops, while set flood.channel.block #bot h=7 blocks #bot matches above seven hops. Use h=default to make the row inherit the global setting again.

get flood.channel.block includes the global default first, then adds per-row overrides as /h>N or /h=all; inherited rows do not show a suffix. Single-row get replies include that row's stored hop mode as h=def, h=all, or h>N. List replies truncate displayed row names only when the full list would exceed the remote-management response limit.

Matching behavior: Each block entry stores the first 4 bytes of the derived channel hash for display and lookup. Current group packets carry only the first channel-hash byte, so that byte is used as a cheap prefilter. Only entries whose first hash byte matches the packet try MAC/decrypt with their stored key. If multiple blocked channels share the same first byte, the repeater tries each matching key until one validates; the packet is blocked only after a successful MAC/decrypt.

Examples:

set flood.channel.block #test
set flood.channel.block.2 9cd8fcf22a47333b591d96a2b848b73f #test
set flood.channel.block.hops 3
set flood.channel.block #wardriving h=4
set flood.channel.block #bot h=7
get flood.channel.block
get flood.channel.block.hops
get flood.channel.block #test
del flood.channel.block.2

Force a transport scope onto unscoped floods

Usage:

  • get flood.channel.scope
  • get flood.channel.scope.<n>
  • set flood.channel.scope <channel|txt:*|login:*|other:*> <region>
  • set flood.channel.scope.<n> <channel|txt:*|login:*|other:*> <region>
  • del flood.channel.scope.<n>
  • del flood.channel.scope all

Parameters:

  • n: Slot number within the table compiled for the target. Roomy ESP32 builds provide 1-255; DRAM-tight classic ESP32 LoRa-OTA repeaters and nRF52/other normal constrained builds provide 1-31; very-tight STM32WL repeaters provide 1-15; the no-PSRAM LilyGo T-LoRa V2.1 repeater/observer provides 1-4.
  • channel: public, a public #channel, or a 128/256-bit channel key in hex.
  • txt:*: Unauthenticated fallback for otherwise-unmatched GRP_TXT and GRP_DATA. Plain * is an alias for txt:*.
  • login:*: Type-based wildcard for the remote-login/admin family: REQ, RESPONSE, TXT_MSG, ANON_REQ, and PATH (0x00, 0x01, 0x02, 0x07, and 0x08). It classifies the outer type; a transit repeater cannot authenticate whether a packet is actually part of a login session.
  • other:*: Type-based wildcard for every remaining flood payload type except TRACE, including ACK, advert, multipart, control, OTA, reserved types, and raw custom. TRACE is deliberately exempt from forced-scope wildcards.
  • region: Existing named region with a usable transport key. A unique region name prefix is accepted; wildcard region * is not a scope target.

Default: No forced scopes.

Remote ACL permission 4 (region/scope manager) can use all get, set, and del flood.channel.scope forms. Filter managers and other non-admin roles cannot change this table.

Without .n, set updates the row for the same exact channel key or wildcard class, otherwise it uses the first empty slot. With .n, it replaces that slot. The three wildcard classes are independent and consume one slot each. get flood.channel.scope reports active/total slot counts; use the numbered form for row detail. Keyed rows are displayed by the first four bytes of their derived channel hash because channel secrets are never returned.

This acts on received, unscoped ROUTE_TYPE_FLOOD packets. For GRP_TXT and GRP_DATA, all exact channel-key rows are tried first and must validate the packet MAC/decryption. A row whose target region is missing or unusable is skipped; later exact rows and then txt:* are tried. Exact keyed rows with a usable target therefore beat txt:* regardless of slot number. login:* and other:* select their non-overlapping outer-type families without decrypting the payload. Duplicate rows within the same class are permitted with numbered slots; the lowest usable slot wins.

Standard traceroute is direct-routed and is therefore outside this flood-only table. A custom flood-form TRACE is also left unchanged: no wildcard adds a scope, an existing transport code is preserved, and region/unknown-code gates do not block it.

On a match, the repeater changes the route to ROUTE_TYPE_TRANSPORT_FLOOD, computes transport code 0 from the selected region key and packet payload, and leaves transport code 1 as zero. This occurs before region enforcement, forwarding filters, and the seen-packet lookup. Already-scoped packets and direct routes are never rewritten. The rewritten packet is no longer subject to flood.max.unscoped, but remains subject to normal payload handling, flood.max, region allow/deny, flood.filter, flood.channel.block, loop detection, and moderation. Assigning a scope does not make a packet type forwardable if the core would otherwise reject it.

If a row's target region has been removed or has no usable key, the repeater tries the next applicable row. For group packets this means later authenticated exact rows followed by txt:*; wildcard duplicates likewise fall through to the next usable slot. The packet remains unscoped only when no usable mapping exists.

LoRa OTA remains functional when other:* is configured. OTA packets are given that region's transport code, but the OTA handler still accepts and re-floods them during the temporary-radio window. The target region must allow flooding. The OTA core itself is dormant outside that window; no default flood filter row is needed for that behavior. Forced scope does not make OTA operate outside the window.

Capacity cost: Each slot uses 36 bytes of runtime RAM and persistent storage, plus a 5-byte file header. The four-slot minimum uses 144 bytes RAM and a 149-byte file; it has room for the three wildcard classes plus one exact channel mapping. Very-tight 15-slot builds use 540 bytes RAM and a 545-byte file. The 31-slot table uses 1,116 bytes RAM and a 1,121-byte file. Roomy ESP32 builds use a 255-slot table: 9,180 bytes RAM and a 9,185-byte file. Classic ESP32 LoRa-OTA builds that cannot afford that RAM use 31 slots instead. The existing region table still permits 32 named regions, so a 255-slot channel table may reuse targets but cannot name more than 32 distinct configured region scopes.

Duplicate behavior: Mesh dedup hashes payload type and payload bytes; it does not hash route type, transport codes, or the ordinary flood path. Adding a transport scope therefore does not create a new duplicate identity. If the same payload later arrives scoped, unscoped, or through a different region, it is still the same seen packet. TRACE is the exception only in that its encoded path_len byte is also hashed.

While equivalent non-TRACE flood copies are waiting in rxdelay, the normal receive-quality timing still selects the packet to process, but that winner receives a scope from the queued scoped copies with the same dedupe identity. If the copies carry different locally allowed scopes, the scope from the shortest received path wins. Unknown and denied transport codes are not candidates and therefore cannot overwrite an unscoped winner. With equal path lengths, the deeper child region wins because it is narrower. A remaining tie keeps queue order. The winner's own path, SNR reading, and scheduled time are not changed, and an already-scoped winner may have its code replaced by the better queued scope.

The comparison is deferred until dequeue so each copy retains its original scope and path for arbitration. It can only use copies still present in rxdelay; it cannot replace a packet that already won the dedupe race. TRACE is excluded from scope arbitration entirely, so rxdelay never adds or replaces a trace transport code.

Examples:

region put west
region save
set flood.channel.scope #local west
set flood.channel.scope.2 txt:* west
set flood.channel.scope.3 login:* west
set flood.channel.scope.4 other:* west
get flood.channel.scope
get flood.channel.scope.1
del flood.channel.scope.2

Filter flood packets by payload type and hop

For setup guidance, interactions with the existing forwarding controls, and worked moderation examples, see Repeater Flood Filtering and Moderation.

Usage:

  • get flood.filter
  • get flood.filter.<n>
  • set flood.filter <type> [hops] [suspend=tempradio]
  • set flood.filter.<n> <type> [hops] [suspend=tempradio]
  • del flood.filter.<n>
  • del flood.filter all

Parameters:

  • n: Rule slot from 1 to 16.
  • type: Payload type name, full PAYLOAD_TYPE_* name, decimal value 0-15, hexadecimal value 0x00-0x0F, or any.
  • hops: Optional; omitted means all.
    • N: Block only at received hop count N.
    • N+: Block at received hop count N and higher.
    • N-M: Block the inclusive received-hop range.
    • all: Block at every received hop count (0-63).
    • 0+, all, and an omitted hop expression are equivalent. The CLI displays the saved range as all.
  • suspend=tempradio: Optional. Skip this row only while the temporary radio is actually active.

The payload names follow the MeshCore packet-format allocation:

Value Short name Full name
0x00 req PAYLOAD_TYPE_REQ
0x01 response PAYLOAD_TYPE_RESPONSE
0x02 txt_msg PAYLOAD_TYPE_TXT_MSG
0x03 ack PAYLOAD_TYPE_ACK
0x04 advert PAYLOAD_TYPE_ADVERT
0x05 grp_txt PAYLOAD_TYPE_GRP_TXT
0x06 grp_data PAYLOAD_TYPE_GRP_DATA
0x07 anon_req PAYLOAD_TYPE_ANON_REQ
0x08 path PAYLOAD_TYPE_PATH
0x09 trace PAYLOAD_TYPE_TRACE
0x0A multipart PAYLOAD_TYPE_MULTIPART
0x0B control PAYLOAD_TYPE_CONTROL
0x0C ota PAYLOAD_TYPE_OTA (this fork's LoRa OTA extension; reserved upstream)
0x0D 13 reserved
0x0E 14 reserved
0x0F raw_custom PAYLOAD_TYPE_RAW_CUSTOM

Route scope: Rules are evaluated only for the two flood route values: ROUTE_TYPE_TRANSPORT_FLOOD (0x00, flood plus transport codes) and ROUTE_TYPE_FLOOD (0x01, unscoped flood). Direct routes 0x02 and 0x03 are never affected.

Behavior: A match prevents retransmission by this repeater. The packet is still received and can still be logged. Rules are persistent and the table is empty by default. While the temporary radio is active, only rows explicitly marked suspend=tempradio are skipped. tempradio is a radio state, not an OTA mode; normal payload types can also use the temporary channel. Other rows remain in force. A malformed persisted table fails open (no general rules are applied).

Remote-admin protection: flood.filter cannot block anon_req, path, or response at received hop counts 0-6; those login-capable types become filterable at hop 7. Flood txt_msg cannot be blocked at hops 0-4 and becomes filterable at hop 5. req, ack, and multipart ACK have no special protection. Transit repeaters cannot decrypt these packets to distinguish an admin exchange from ordinary peer traffic, so each floor necessarily covers all flood packets of that outer type. These exceptions apply only to flood.filter; repeat, flood.max*, region, loop-detection, and other forwarding gates remain authoritative.

Without .n, set returns an identical existing rule, including its suspension setting, or uses the first empty slot. With .n, it replaces that slot. get flood.filter gives a compact list. Use get flood.filter.<n> for full details, including suspend=tempradio.

Standard traceroute is direct-routed and therefore outside flood.filter entirely. For a custom flood-form trace, catch-all any rows are deliberately ignored; only a deliberately explicit set flood.filter trace ... row can match it.

Examples:

set flood.filter grp_data 4+
set flood.filter.2 PAYLOAD_TYPE_ADVERT 6+
set flood.filter ota 2-4
set flood.filter grp_data all suspend=tempradio
set flood.filter any 12+
get flood.filter
get flood.filter.2
del flood.filter.2

Moderate flood group text by channel, sender, and source path

Usage:

  • get flood.moderation
  • get flood.moderation.<n>
  • set flood.moderation <channel> <sender> <action> [action...]
  • set flood.moderation.<n> <channel> <sender> <action> [action...]
  • del flood.moderation.<n>
  • del flood.moderation all

Parameters:

  • n: Moderation slot from 1 to 16.
  • channel:
    • public: Built-in Public channel.
    • #channel: Derive the well-known hashtag-channel key.
    • A 128-bit or 256-bit channel key in hex, for any other/private channel.
  • sender: Exact group-text display name. Matching is ASCII case-insensitive. Quote names containing spaces, for example "Field User".
  • drop: Do not forward matching messages. Equivalent to rate=0/min.
  • rate=X/min: Forward at most X matching messages per 60-second local window. This option requires an exact sender rather than *.
  • hops=N: Do not forward a matching message whose received flood path count is N or higher. hops=all removes this constraint.
  • path=H1[,H2,H3]: Match the start of the flood path. One to three hashes are accepted; every hash must have the same 1-, 2-, or 3-byte width.
  • path=*: Match any source path (the default).

At least one of drop, rate=X/min, or hops=N is required. Rate and hop limits can be combined. Rate counters are local to this repeater and rule, use a 60-second window beginning with the first matching message, and reset on reboot.

Decode and identity behavior: Moderation applies only to flood PAYLOAD_TYPE_GRP_TXT. The repeater first checks the packet's channel-hash byte, then validates and decrypts with the configured key. It extracts the text before the first : from the standard <sender>: <message> plaintext. The channel key is stored locally but is never printed by get.

The group-text sender is an unverified display name, not a public key. It can be spoofed. Combining it with the first one to three path hashes makes a more useful moderation signal, but path hashes are truncated and are not proof of the originating user. A path-qualified rule begins matching only after the packet contains all configured starting hops; it cannot identify a first hop on a zero-hop packet.

As with general filtering, matching messages are still received/logged; only retransmission is denied. There are no moderation rules by default.

Examples:

set flood.moderation public "Noisy User" rate=5/min
set flood.moderation #local bot drop path=A1B2C3,D4E5F6
set flood.moderation.3 00112233445566778899AABBCCDDEEFF alice rate=10/min hops=4 path=71CE82
get flood.moderation
get flood.moderation.3
del flood.moderation.3

ACL

Add, update or remove permissions for a companion

Usage:

  • setperm <pubkey> <permissions>

Parameters:

  • pubkey: Companion public key
  • permissions:
    • 0: Guest
    • 1: Read-only
    • 2: Read-write
    • 3: Admin
    • 4: Region/scope manager (repeater delegated region and forced-scope management)
    • 5: Filter manager (repeater delegated forwarding-filter management)

Filter manager scope: Permission 5 can use an explicit allowlist of non-secret operational/filter status commands and can change the forwarding controls repeat, loop.detect, flood.max*, flood.channel.data*, flood.channel.block*, flood.filter*, and flood.moderation*. It cannot read guest, WiFi, MQTT, bridge, or other credentials, and it cannot change regions, ACL entries, radio settings, or other admin configuration. Permission 4 is limited to region commands, flood.channel.scope*, and the same non-secret status allowlist. Both delegated manager roles are protected from least-recently-active ACL eviction like administrators.

Note: Removes the entry when permissions is omitted

View the current ACL

Usage:

  • get acl

Serial Only: Yes

View or change this room server's 'read-only' flag

Usage:

  • get allow.read.only
  • set allow.read.only <state>

Parameters:

  • state: on (enable) or off (disable)

Default: off

Region Management (v1.10.+)

Bulk-load region lists

Usage:

  • region load
  • region load <name> [flood_flag]

Parameters:

  • name: A name of a region. * represents the wildcard region

Note: flood_flag: Optional F to allow flooding

Note: Indentation creates parent-child relationships (max 8 levels)

Note: region load with an empty name will not work remotely (it's interactive)

Save any changes to regions made since reboot

Usage:

  • region save

Allow a region

Usage:

  • region allowf <name>

Parameters:

  • name: Region name (or * for wildcard)

Note: Setting on wildcard * allows packets without region transport codes

Block a region

Usage:

  • region denyf <name>

Parameters:

  • name: Region name (or * for wildcard)

Note: Setting on wildcard * drops packets without region transport codes

Show information for a region

Usage:

  • region get <name>

Parameters:

  • name: Region name (or * for wildcard)

View or change the home region for this node

Usage:

  • region home
  • region home <name>

Parameters:

  • name: Region name

View or change the default scope region for this node

Usage:

  • region default
  • region default {name|<null>}

Parameters:

  • name: Region name, or to reset/clear

Create a new region

Usage:

  • region put <name> [parent_name]

Parameters:

  • name: Region name
  • parent_name: Parent region name (optional, defaults to wildcard)

Note: In firmware v1.15.0 and later, region put enables flooding for that region by default (you do not need a separate region allowf <name> after each put). On v1.14.0 and earlier, new regions may still require region allowf for flooding—see region allowf.

Define region hierarchy (single line)

Usage:

  • region def <token> [<token> ...]

Parameters (tokens): Space-separated. A logical cursor starts at the wildcard *.

  • name — Create name as a child of the current cursor (equivalent to region put name with the cursor as parent). Cursor moves to name.
  • name|jump (or name,jump) — Create name as a child of the current cursor, then move the cursor to jump (must already exist on the node, or have been created earlier in this command). jump is not the parent of name; use this form to pop back up and start another branch.

Behavior: Each created region defaults to flood-allowed (same as region put). The reply is the resulting region tree (same format as bare region); review it before running region save to persist. The command is transactional: invalid names, unknown or ambiguous jumps, table overflow, and hierarchy cycles return Err - ... without changing the existing tree.

Existing regions: region def does not clear the existing tree — if a name already exists, its parent is updated to the current cursor; otherwise a new region is created. To start from scratch, region remove the unwanted regions first.

Limits: Repeater serial accepts one line up to 160 characters. For larger trees, split across multiple region def commands; the cursor resets to * between commands, so lead the next command with child|ancestor to reposition. Each token splits at most once on | — region def a|b|c|d is not a flat-list shorthand; see the flat-list example below.

Example — linear chain (each token becomes a child of the previous):

region def a b c d e
region save

Example — branched tree (equivalent to region put a, region put b a, region put c b, region put d c, region put e b, region put f e):

region def a b c d|b e f
region save

Example — transactional error:

region def a b c|nope d

The reply is Err - unknown or ambiguous jump: nope. The existing tree is unchanged; re-run with a corrected jump.

Example — flat list (each region a child of *). Use |* after each token to pop the cursor back to the root before the next token:

region def a|* b|* c|* d|* e|* f
region save

Remove a region

Usage:

  • region remove <name>

Parameters:

  • name: Region name

Note: Must remove all child regions before the region can be removed

View all regions

Usage:

  • region list <filter>

Serial Only: Yes

Parameters:

  • filter: allowed|denied

Note: Requires firmware 1.12+

Dump all defined regions and flood permissions

Usage:

  • region

Serial Only: For firmware older than 1.12.0

Region Examples

Example 1: Using F Flag with Named Public Region

region load
#Europe F
<blank line to end region load>
region save

Explanation:

  • Creates a region named #Europe with flooding enabled
  • Packets from this region will be flooded to other nodes

Example 2: Using Wildcard with F Flag

region load 
* F
<blank line to end region load>
region save

Explanation:

  • Creates a wildcard region * with flooding enabled
  • Enables flooding for all regions automatically
  • Applies only to packets without transport codes

Example 3: Using Wildcard Without F Flag

region load 
*
<blank line to end region load>
region save

Explanation:

  • Creates a wildcard region * without flooding
  • This region exists but doesn't affect packet distribution
  • Used as a default/empty region

Example 4: Nested Public Region with F Flag

region load 
#Europe F
  #UK
    #London
    #Manchester
  #France
    #Paris
    #Lyon
<blank line to end region load>
region save

Explanation:

  • Creates #Europe region with flooding enabled
  • Adds nested child regions (#UK, #France)
  • All nested regions inherit the flooding flag from parent

Example 5: Wildcard with Nested Public Regions

region load 
* F
  #NorthAmerica
    #USA
      #NewYork
      #California
    #Canada
      #Ontario
      #Quebec
<blank line to end region load>
region save

Explanation:

  • Creates wildcard region * with flooding enabled
  • Adds nested #NorthAmerica hierarchy
  • Enables flooding for all child regions automatically
  • Useful for global networks with specific regional rules

Direct Retry

Direct retry resends direct-routed packets when the downstream echo is not heard. It applies to direct messages, ACK packets, multipart packets carrying ACK payloads, and TRACE packets.

The shared state, count, base, and step controls work on repeater, room-server, and sensor firmware. Recent-repeater/SNR controls are repeater-only because the other roles do not keep the repeater reachability table they require.

View or change direct retry state

Usage:

  • get direct.retry
  • set direct.retry <state>

Parameters:

  • state: on|off

Default: on

Notes:

  • New installs and older preference files without direct retry settings default to on with the rooftop preset.

Examples:

get direct.retry
set direct.retry on
set direct.retry off

View or change direct retry heard-table gate

Usage:

  • get direct.retry.heard
  • set direct.retry.heard <state>

Parameters:

  • state: on|off

Default: on

Note: This command is repeater-only. When enabled, the recent repeater table is the direct retry eligibility gate. Prefixes missing from the table are assumed reachable; prefixes in the table below the active SNR gate are blocked.

Examples:

get direct.retry.heard
set direct.retry.heard on
set direct.retry.heard off

View or apply a retry preset

Usage:

  • get retry.preset
  • set retry.preset <preset>

Parameters:

  • preset: infra|rooftop|mobile

Notes:

  • Applies shared direct retry and flood retry defaults.
  • infra: fewer, slower retries for stable fixed infrastructure.
  • rooftop: default long retry window for weak rooftop links.
  • mobile: long retry count with shorter spacing for moving or changing links; flood retry count is 15.
  • Changing direct.retry.count, direct.retry.base, direct.retry.step, direct.retry.margin, flood.retry.count, flood.retry.path, or flood.retry.group.path makes the preset report as custom.

Examples:

get retry.preset
set retry.preset infra
set retry.preset rooftop
set retry.preset mobile

Flood Retry

Flood retry resends flood-routed packets when the same packet is not heard from another qualifying repeater.

The count, path, group-data path, and advert controls work on repeater, room-server, and sensor firmware. Flood forwarding must also be enabled for retries to run. Prefix, ignore, bridge, and bucket controls are repeater-only.

View or change flood retry count

Usage:

  • get flood.retry.count
  • set flood.retry.count <count>

Parameters:

  • count: Base retry attempts after the original send, from 0 to 15. 0 disables flood retry.

Note: Actual attempts are capped at 15. Path count 0 flood retries use count * 2; path count 1 retries use count * 1.5, rounded up; path count 2 and higher use the configured base count. Setting count to 0 immediately removes queued and future flood retries; a packet already transmitting is allowed to finish.

Defaults:

  • infra: 1
  • rooftop: 3
  • mobile: 15

Examples:

get flood.retry.count
set flood.retry.count 0
set flood.retry.count 15

View or change flood retry path gate

Usage:

  • get flood.retry.path
  • set flood.retry.path <count|off>

Parameters:

  • count: Maximum flood path hash count eligible for retry, from 0 to 63.
  • off: Disable the path-length gate.

Defaults:

  • infra: 1
  • rooftop: 2
  • mobile: 1

Examples:

get flood.retry.path
set flood.retry.path 1
set flood.retry.path off

View or change the group-data flood retry path gate

Usage:

  • get flood.retry.group.path
  • set flood.retry.group.path <count|off>

Parameters:

  • count: Maximum flood path hash count eligible for retry for group data packets (PAYLOAD_TYPE_GRP_DATA/type 6), from 0 to 63.
  • off: Disable only the group-data-specific gate. The general flood.retry.path gate still applies.

Default: 1 for infra, rooftop, and mobile presets.

Note: The stricter of flood.retry.path and flood.retry.group.path is used. A value of 1 allows retry sequences at path counts 0 and 1; group data at path count 2 or higher is still forwarded normally but does not start a flood retry sequence. A value of 0 allows retries only at the originating sender.

Setting flood.retry.path to 0 also sets flood.retry.group.path to off because the general zero-hop gate is already stricter. While the general gate remains 0, attempts to set the group-data gate keep it off. Applying a named retry preset restores the group-data default of 1.

Examples:

get flood.retry.group.path
set flood.retry.group.path 1
set flood.retry.group.path off

View or change flood retry advert handling

Usage:

  • get flood.retry.advert
  • set flood.retry.advert <on|off>

Parameters:

  • on: Retry node advert floods.
  • off: Do not retry node advert floods.

Default: off

Examples:

get flood.retry.advert
set flood.retry.advert off

View or change flood retry target prefixes

Usage:

  • get flood.retry.prefixes
  • set flood.retry.prefixes <prefixes|none|off>

Parameters:

  • prefixes: Comma-separated 3-byte path hash prefixes, up to 8 entries.
  • none or off: Clear the list.

Note: When set, non-bridge flood retry only accepts same-packet echoes whose last hop matches one of these prefixes. When unset, any non-ignored last hop can cancel the retry.

Examples:

get flood.retry.prefixes
set flood.retry.prefixes A58296,860CCA,425E5C
set flood.retry.prefixes none

View or change flood retry ignored prefixes

Usage:

  • get flood.retry.ignore
  • set flood.retry.ignore <prefixes|none|off>

Parameters:

  • prefixes: Comma-separated 3-byte path hash prefixes, up to 8 entries.
  • none or off: Clear the list.

Note: Non-bridge flood retry does not cancel on same-packet echoes whose last hop matches this list. Bridge mode also excludes these prefixes from bucket and other hits.

Examples:

get flood.retry.ignore
set flood.retry.ignore 71CE82,C7618C
set flood.retry.ignore none

View or change flood retry bridge mode

Usage:

  • get flood.retry.bridge
  • set flood.retry.bridge <on|off>

Note: Bridge mode retries until each configured fresh bucket, plus the non-source other bucket, has been heard or the retry count is exhausted. If prefixes in different buckets share their first byte, configuration commands return a warning because a 1-byte path cannot distinguish those buckets. The configuration remains valid: an ambiguous source is treated as belonging to every matching source bucket, and an ambiguous echo credits every matching target bucket so it cannot force retry exhaustion.

Flood retry timing retains its fixed maximum-frame plus 20 packet-airtime wait, then adds a random 0-200% of one additional packet airtime on every attempt. This de-synchronizes repeaters that may have missed the same echo while capping the added wait at two frames.

Only one active retry sequence is kept for a given logical flood packet. An identical flood can still transmit normally, but it does not create a second sequence of extra attempts. Retry state is released if a queued packet is evicted, and the final echo window retains metadata without reserving a packet-pool entry.

Bridge reachability learned from earlier hops in a successful echo is cached separately from recent.repeater. Only the final RF hop updates recent.repeater and its SNR, so indirect path entries cannot affect direct-retry SNR gating or coding-rate selection.

Examples:

get flood.retry.bridge
set flood.retry.bridge on

View or change flood retry bridge buckets

Usage:

  • get flood.retry.bucket.<n>
  • set flood.retry.bucket <n> <prefixes|none|off>

Parameters:

  • n: Bucket number from 1 to 6.
  • prefixes: Comma-separated 3-byte path hash prefixes, up to 17 entries per bucket.
  • none or off: Clear the bucket.

Examples:

get flood.retry.bucket.1
set flood.retry.bucket 1 71CE82,C7618C
set flood.retry.bucket 2 none

View or change direct retry count

Usage:

  • get direct.retry.count
  • set direct.retry.count <count>

Parameters:

  • count: Maximum retry attempts after the original send, from 1 to 15.

Default: 15 with the rooftop preset

Note: Direct-routed type 2 text packets always use 21 retry attempts in the shared retry logic, regardless of this setting or the repeater short-path cap.

Examples:

get direct.retry.count
set direct.retry.count 1
set direct.retry.count 4
set direct.retry.count 15

View or change direct retry base delay

Usage:

  • get direct.retry.base
  • set direct.retry.base <ms>

Parameters:

  • ms: First retry wait in milliseconds, from 10 to 5000.

Default: 175 with the rooftop preset

Explanation:

  • The first retry waits for base + packet-length add-on + random forwarding jitter after the preceding transmission completes.
  • TRACE and ANON_REQ/type 7 packets use a 3x line-time add-on. TXT_MSG/type 2 packets use 7x. Other direct retry packets use 6x.
  • Room-server and sensor firmware use this configured base with the same packet-type add-ons.
  • Larger values reduce channel pressure and give slow repeaters more time.
  • Smaller values recover faster but create tighter retry bursts.

Examples:

get direct.retry.base
set direct.retry.base 175
set direct.retry.base 275
set direct.retry.base 500

View or change direct retry step delay

Usage:

  • get direct.retry.step
  • set direct.retry.step <ms>

Parameters:

  • ms: Extra milliseconds added for each subsequent retry, from 0 to 5000.

Default: 100 with the rooftop preset

Explanation:

  • Retry delay is base + packet-length add-on + random forwarding jitter + attempt_index * step.
  • TRACE and ANON_REQ/type 7 packets use a 3x packet-length add-on. TXT_MSG/type 2 packets use 7x. Other direct retry packets use 6x.
  • Room-server and sensor firmware use this configured step with the same packet-type add-ons.
  • With base=175 and step=100, the fixed portion is 175, 275, 375, 475 ms, and so on, before the packet-length add-on and random jitter.
  • step=0 keeps every retry at the same delay.
  • Larger steps spread retries over time and are safer on busy channels.

Examples:

get direct.retry.step
set direct.retry.step 0
set direct.retry.step 50
set direct.retry.step 100
set direct.retry.step 250

View or change direct retry SNR margin

Usage:

  • get direct.retry.margin
  • set direct.retry.margin <snr_db>

Parameters:

  • snr_db: Extra SNR margin above the SF receive floor, from 0 to 40.

Default: 5.00 with the rooftop preset

Notes:

  • This command is repeater-only.
  • Unknown repeaters are still retried.
  • Known repeaters below the receive floor plus this margin are skipped.
  • Failed attempts lower the recent repeater SNR estimate by 0.25 dB.

Examples:

get direct.retry.margin
set direct.retry.margin 0
set direct.retry.margin 2.5
set direct.retry.margin 5
set direct.retry.margin 10

View or change adaptive direct retry coding rate

Usage:

  • get direct.retry.cr
  • set direct.retry.cr off
  • set direct.retry.cr on (room-server and sensor)
  • set direct.retry.cr <cr4_min>,<cr5_min>,<cr7_min>,<cr8_max>

Parameters:

  • cr4_min: Minimum SNR in dB to retry at CR4.
  • cr5_min: Minimum SNR in dB to retry at CR5.
  • cr7_min: Minimum SNR in dB to retry at CR7.
  • cr8_max: Maximum SNR in dB that forces CR8.

Default: 10.00,7.50,2.50,2.50

Explanation:

  • Higher SNR uses faster coding rates.
  • Lower SNR uses more robust coding rates.
  • Repeater retry attempts escalate from the adaptive starting CR. CR4 starts as CR4, CR5, CR7, CR7, then CR8. CR5 starts as CR5, CR7, CR7, then CR8. CR7 gets two attempts, then CR8.
  • Repeater adaptive CR selection intentionally skips CR6.
  • Non-repeater retry packets start at the current radio CR and follow the same escalation pattern, clamped at CR8. With the normal CR5 radio setting this is CR5, CR7, CR7, then CR8.
  • Room-server and sensor firmware accept on or off; numeric SNR thresholds are repeater-only because those roles do not keep recent-repeater SNR data.
  • off disables per-packet retry CR overrides and uses the current radio CR.
  • Direct path retry packets sent at CR4 or CR5 temporarily use a shorter 16-symbol preamble, then restore the radio's default preamble.
  • Unknown repeaters start at +3.00 dB for adaptive CR selection.
  • A failed unknown repeater is seeded at +2.75 dB.
  • Each later failure lowers the SNR estimate by 0.25 dB.

Examples:

get direct.retry.cr
set direct.retry.cr off
set direct.retry.cr on
set direct.retry.cr 10.0,7.5,2.5,2.5
set direct.retry.cr 12.0,8.0,4.0,1.0
set direct.retry.cr 8.0,5.0,1.5,0
set direct.retry.cr 6.0,3.0,0,-2.0
set direct.retry.cr 20.0,12.0,6.0,2.0
set direct.retry.cr 4.0,2.0,0,-4.0

Example profiles:

  • Conservative weak-link profile:
set direct.retry.cr 12.0,8.0,4.0,1.0
  • Balanced rooftop profile:
set direct.retry.cr 10.0,7.5,2.5,2.5
  • Faster strong-link profile:
set direct.retry.cr 6.0,3.0,0,-2.0
  • Very cautious noisy-link profile:
set direct.retry.cr 20.0,12.0,6.0,2.0

View, seed, or clear the recent repeater table

Usage:

  • get recent.repeater
  • get recent.repeater <page>
  • get recent.repeaters <page>
  • set recent.repeater <prefix> [snr_db]
  • clear recent.repeater

Parameters:

  • prefix: Repeater path-hash prefix as hex.
  • snr_db: Optional SNR in dB. If omitted or invalid, defaults to 3.0.
  • page: 1-based result page.

Note: These commands are repeater-only.

Output order:

  • get recent.repeater lists 3-byte prefixes first, then 2-byte prefixes, then 1-byte prefixes.
  • Within each prefix length, entries are sorted from highest SNR to lowest SNR.

SNR details:

  • Recent repeater SNR is stored internally in quarter-dB units.
  • Heard repeater samples update an existing table entry with a weighted blend: 75% existing SNR and 25% new heard SNR, rounded up.
  • Direct retry success also feeds the heard echo SNR back into the same weighted table.
  • Direct retry failure is not weighted: each final echo-timeout failure lowers that repeater's SNR by 0.25 dB.
  • Unknown repeaters start at +3.00 dB for adaptive CR selection.
  • If an unknown repeater fails, it is seeded into the table at +2.75 dB.
  • set recent.repeater <prefix> [snr_db] seeds a missing prefix or adds another weighted sample for an existing prefix.
  • Successful set recent.repeater replies include the stored prefix and SNR, for example OK - set A1B2C3 at 3.0 SNR.
  • Entries strictly older than 24 hours are removed during a sweep every three hours, so an entry can remain for at most approximately 27 hours.

Examples:

get recent.repeater
get recent.repeater 2
set recent.repeater A1B2C3 8.5
set recent.repeater 71CE82 -3.25
set recent.repeater A1B2C3
clear recent.repeater

GPS (When GPS support is compiled in)

View or change GPS state

Usage:

  • gps
  • gps <state>

Parameters:

  • state: on|off

Default: off

Note: Output format:

  • off when the GPS hardware is disabled
  • on, {active|deactivated}, {fix|no fix}, {sat count} sats when the GPS hardware is enabled

Sync this node's clock with GPS time

Usage:

  • gps sync

Set this node's location based on the GPS coordinates

Usage:

  • gps setloc

View or change the GPS advert policy

Usage:

  • gps advert
  • gps advert <policy>

Parameters:

  • policy: none|share|prefs
    • none: don't include location in adverts
    • share: share gps location (from SensorManager)
    • prefs: location stored in node's lat and lon settings

Default: prefs

Sensors (When sensor support is compiled in)

View or change telemetry access mode

Usage:

  • get telemetry.access
  • set telemetry.access <mode>

Parameters:

  • mode: all|acl
    • all: allow telemetry requests using the requester-provided telemetry mask
    • acl: require ACL read-only or higher for telemetry, including GPS

Default: all

Note: all matches the previous sensor telemetry behavior.

View the list of sensors on this node

Usage: sensor list [start]

Parameters:

  • start: Optional starting index (defaults to 0)

Note: Output format: <var_name>=<value>\n

View or change the value of a sensor

Usage:

  • sensor get <key>
  • sensor set <key> <value>

Parameters:

  • key: Sensor setting name
  • value: The value to set the sensor to

Bridge (When bridge support is compiled in)

View the compiled bridge type

Usage: get bridge.type

View or change the bridge enabled flag

Usage:

  • get bridge.enabled
  • set bridge.enabled <state>

Parameters:

  • state: on|off

Default: off

Add a delay to packets routed through this bridge

Usage:

  • get bridge.delay
  • set bridge.delay <ms>

Parameters:

  • ms: Delay in milliseconds (0-10000)

Default: 500

View or change the source of packets bridged to the external interface

Usage:

  • get bridge.source
  • set bridge.source <source>

Parameters:

  • source:
    • logRx: bridges received packets
    • logTx: bridges transmitted packets

Default: logTx

Note: For MQTT bridges, use mqtt.rx and mqtt.tx instead of bridge.source. These provide independent per-direction control and support both RX and TX simultaneously. bridge.source still works as a convenience alias for MQTT (setting bridge.source rx sets mqtt.rx on + mqtt.tx off, and vice versa), but mqtt.rx/mqtt.tx are preferred.

View or change MQTT RX packet uplinking

Usage:

  • get mqtt.rx
  • set mqtt.rx <on|off>

Parameters:

  • on: uplink received (RX) packets to MQTT brokers
  • off: disable RX packet uplinking

Default: on

View or change MQTT TX packet uplinking

Usage:

  • get mqtt.tx
  • set mqtt.tx <on|off|advert>

Parameters:

  • on: uplink all transmitted (TX) packets to MQTT brokers
  • advert: uplink only this node's own advert packets (self-originated advertisements only — forwarded adverts from other nodes are filtered out)
  • off: disable TX packet uplinking

Default: advert

Note: mqtt.rx and mqtt.tx take effect immediately — no restart required. Both can be enabled simultaneously.

View or change the NTP server (MQTT observer only)

Usage:

  • get mqtt.ntp
  • set mqtt.ntp <hostname>
  • set mqtt.ntp none

Description: Sets the primary NTP server used for clock sync (required for JWT MQTT auth). On set, the device attempts an immediate sync of the just-configured server (primary only, so a typo fails fast) when WiFi is connected and the MQTT bridge is running.

Fallbacks: If the primary fails, the firmware tries pool.ntp.org, time.google.com, time.cloudflare.com, time.aws.com, and time.nist.gov in order (skipping duplicates).

Default: pool.ntp.org (when unset or none)

Diagnose NTP server connectivity (MQTT observer only)

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.

  • 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.

View or change the speed of the bridge (RS-232 only)

Usage:

  • get bridge.baud
  • set bridge.baud <rate>

Parameters:

  • rate: Baud rate (9600, 19200, 38400, 57600, or 115200)

Default: 115200

View or change the channel used for bridging (ESPNow only)

Usage:

  • get bridge.channel
  • set bridge.channel <channel>

Parameters:

  • channel: Channel number (1-14)

Set the ESP-Now secret

Usage:

  • get bridge.secret
  • set bridge.secret <secret>

Parameters:

  • secret: ESP-NOW bridge secret, 1-15 characters

Default: Varies by board

View the bootloader version (nRF52 only)

Usage: get bootloader.ver

View power management support

Usage: get pwrmgt.support

View the current power source

Usage: get pwrmgt.source

Note: Returns an error on boards without power management support.

View the boot reset and shutdown reasons

Usage: get pwrmgt.bootreason

Note: Returns an error on boards without power management support.

View the boot voltage

Usage: get pwrmgt.bootmv

Note: Returns an error on boards without power management support.

Reference in New Issue View Git Blame Copy Permalink