Module command

Module command 

Source
Expand description

The command tree.

One clap Subcommand enum serves four surfaces: the one-shot argv grammar, the REPL line grammar, --help at every level, and the completion tree the REPL’s tab handler walks.

Modules§

advert
advert: what the device announces without being asked (PROP_ADVERT_INTERVAL, PROP_BEACON_INTERVAL, PROP_STARTUP_BEACON).
capture
capture: listen on the device’s radio, decode what it hears, and optionally write a Wireshark-compatible file.
discover
discover: who else is out there.
duty
duty: report or bound the combined duty-cycle budget.
gnss
gnss: report the receiver’s state, switch it on or off, and set the policy for what is done with a fix (PROP_GNSS_*).
info
info: what the device says about itself, in as few exchanges as it can be asked in.
lifecycle
State lifecycle and one-off device settings: save, restore, clear, reset, factory-reset, pin, ble, identity, name, and alert.
manage
manage: administering another device over the mesh.
message
send and listen: text messages to and from this tool’s own identity.
phy
phy: report or set the radio’s enable state and LoRa parameters.
ping
ping: reachability and path quality, measured over the mesh.
props
Properties by name, and their values in a form a person can read and type.
repeater
repeater: report or set autonomous forwarding (PROP_MAC_REPEATER_*).
routes_cmd
routes: what this tool has learned about reaching other nodes.
tables
dev-channel / dev-peer / dev-admin: the device identity’s own key tables.
time
time: read, set, or clear the device’s wall clock (PROP_TIME, PROP_TZ_OFFSET).
values
FromStr-backed value parsers for the command tree.

Enums§

Command
DefaultOp

Functions§

ble_scan 🔒
decode_u16 🔒
decode_u32 🔒
default 🔒
duty_percent 🔒
Percentage of the hour a raw 0-65535 duty figure represents.
format_duration 🔒
A span of seconds at human scale, to at most two units: 45s, 20m, 1h30m, 12d6h.
persist
Finish a mutating command: persist by default, or report the live-only state under --no-save.