Module prop 

Property identifiers.

Constants

ADVERT_INTERVAL

Seconds between unsolicited advertisements (PROP_ADVERT_INTERVAL) — UINT32, 0 to send none. An advertisement carries the signed node identity and goes out with no flood hops and no source route, so it reaches the neighbours that can hear the device directly and stops there. The accepted range is [MIN_AUTO_ANNOUNCE_INTERVAL_S] to [MAX_AUTO_ANNOUNCE_INTERVAL_S], and the value is a floor rather than a period: the device scatters each send later by up to a quarter of it. Requires CAP_ADVERT.

ALERT

Locate-alert state (PROP_ALERT) — what the device is currently doing to draw attention to where it physically is. Volatile: never saved, unaffected by CMD_RST, ALERT_NONE after every reset. Requires CAP_ALERT.

BATTERY

Battery status snapshot (PROP_BATTERY).

BEACON_INTERVAL

Seconds between unsolicited beacons (PROP_BEACON_INTERVAL) — UINT32, 0 to send none. A beacon carries no payload and goes out with a flood budget and the trace-route and trace-signal options, so what it announces is the path back to the device rather than who the device is. Same range and same scatter as ADVERT_INTERVAL. Requires CAP_ADVERT.

BLE_BOND_COUNT

How many Bluetooth bonds the device is holding (PROP_BLE_BOND_COUNT) — UINT8, read-only. Requires CAP_BLE; a device whose bonds it cannot manage answers STATUS_PROP_NOT_FOUND.

BLE_ENABLED

Whether the device is reachable over Bluetooth (PROP_BLE_ENABLED) — BOOL, default 1. Requires CAP_BLE.

BLE_LINK

How far the Bluetooth transport has got with whoever is on the other end of it (PROP_BLE_LINK) — UINT8, read-only, one of crate::ble::BleLinkState. Requires CAP_BLE.

BLE_PAIRING

Whether a pairing window is open (PROP_BLE_PAIRING) — BOOL, read-write. Requires CAP_BLE; a device that does not manage its own bonds answers STATUS_PROP_NOT_FOUND.

BLE_PAIRING_PIN

Persisted, write-only BLE pairing passkey (PROP_BLE_PAIRING_PIN).

CAPS

Supported capability list (PROP_CAPS).

DEV_ADMINS

Nodes authorized to manage this device over the mesh (PROP_DEV_ADMINS) — a multiple-value property whose items are 32-octet Ed25519 public keys, reported verbatim. An empty list disables node management. Requires CAP_ADMIN.

DEV_CHANNEL_KEYS

Device identity channel keys (PROP_DEV_CHANNEL_KEYS).

DEV_DISCOVERABLE

Whether the device identity answers Identity Requests (PROP_DEV_DISCOVERABLE) — BOOL, default 1. Requires CAP_DEV_IDENTITY.

DEV_KEY

Device identity public key (PROP_DEV_KEY).

DEV_MODEL

Hardware model name (PROP_DEV_MODEL) — what the board is, where DEV_VERSION is what it runs. Optional and ungated: a device that cannot name its own hardware refuses the get.

DEV_NAME

Human-readable device name (PROP_DEV_NAME).

DEV_PEERS

Device identity peer list (PROP_DEV_PEERS).

DEV_PRIVATE_KEY

Device identity private key, write-only (PROP_DEV_PRIVATE_KEY).

DEV_VERSION

device firmware version string (PROP_DEV_VERSION).

GNSS_ALTITUDE

Altitude of the last fix (PROP_GNSS_ALTITUDE) — INT32_LE meters above the WGS-84 ellipsoid, matching the units of node identity option 2. Empty when there is no fix. Requires CAP_GNSS.

GNSS_ENABLED

Whether the GNSS receiver is powered (PROP_GNSS_ENABLED) — BOOL, default 0. Off means the lowest power state the receiver reaches; a board whose receiver RTC is the board’s only clock keeps that domain alive regardless. Requires CAP_GNSS.

GNSS_FIX

Fix quality (PROP_GNSS_FIX) — UINT8, 0 none, 1 two-dimensional, 2 three-dimensional. Reads 0 while the receiver is disabled. Requires CAP_GNSS.

GNSS_IDENT_PRECISION

Precision the advertised location is clamped to (PROP_GNSS_IDENT_PRECISION) — UINT8 1–7, default 5. Requires CAP_GNSS.

GNSS_IDENT_UPDATE

Whether position fixes update the advertised node identity (PROP_GNSS_IDENT_UPDATE) — BOOL, default 0. Requires CAP_GNSS.

GNSS_LOCATION

Last position fix (PROP_GNSS_LOCATION) — 0–7 octets in the variable-precision interleaved format. Empty means no fix has been obtained this power cycle. Requires CAP_GNSS.

GNSS_PRECISION

Estimated horizontal accuracy of the last fix (PROP_GNSS_PRECISION) — UINT16_LE decimeters. An estimate derived from the receiver’s dilution of precision, not a measured error bound. Empty when there is no fix. Requires CAP_GNSS.

GNSS_SATELLITES

Satellite counts (PROP_GNSS_SATELLITES) — UINT8 satellites used in the solution, optionally followed by UINT8 satellites in view. Reads 0 while the receiver is disabled. Requires CAP_GNSS.

GNSS_TIME_TRUST

Whether receiver-derived time may set the wall clock (PROP_GNSS_TIME_TRUST) — BOOL, default 1. Cleared, neither a fix nor a receiver-RTC read touches PROP_TIME, which leaves a manually-set clock proof against a jammed or spoofed sky. Position reporting is unaffected. Requires CAP_GNSS.

HOST_AUTO_ACK

Acknowledgement-delegation enable (PROP_HOST_AUTO_ACK).

HOST_CHANNEL_KEYS

Host channel keys (PROP_HOST_CHANNEL_KEYS).

HOST_KEY

Tethered host identity public key (PROP_HOST_KEY).

HOST_PEER_KEYS

Host pairwise peer keys (PROP_HOST_PEER_KEYS).

HOST_RX_FILTERS

Host receive filter table (PROP_HOST_RX_FILTERS).

HOST_RX_QUEUE_CAPACITY

Inbound queue capacity in frames (PROP_HOST_RX_QUEUE_CAPACITY).

HOST_RX_QUEUE_COUNT

Frames currently queued (PROP_HOST_RX_QUEUE_COUNT).

HOST_RX_QUEUE_DROPPED

Cumulative frames dropped from the queue (PROP_HOST_RX_QUEUE_DROPPED).

IDENT

The device identity’s complete signed node-identity blob (PROP_IDENT), served through a deferred signing effect.

IDENT_ALTITUDE

Altitude the device identity advertises (PROP_IDENT_ALTITUDE) — a minimal-length signed integer (see crate::sint) of meters above the WGS-84 ellipsoid, or empty. Advertised only alongside a location. Same writability rule as IDENT_LOCATION; requires CAP_IDENT.

IDENT_LOCATION

Location the device identity advertises (PROP_IDENT_LOCATION) — 0–7 octets in the variable-precision interleaved format, empty to advertise none. The value carries its own precision, so a location entered by hand needs no separate precision setting.

IDENT_MOBILE

Whether the device identity advertises the MOB capability bit (PROP_IDENT_MOBILE) — mobile versus fixed, which is orthogonal to tethered versus standalone.

IDENT_ROLE

Advertised ROLE byte of the device identity (PROP_IDENT_ROLE). Empty means “derive it from what the device is actually doing”.

ILLUMINANCE

Ambient illuminance (PROP_ILLUMINANCE) — UINT32_LE millilux. Millilux rather than lux because the interesting region for an indicator that should not be intrusive at night is below one lux. Sampled when read; empty when the sensor could not be read. A board reports its clamped maximum above the sensor’s saturation point rather than extrapolating past it. Requires CAP_ILLUMINANCE.

INTERFACE_TYPE

Interface type discriminator (PROP_INTERFACE_TYPE).

LAST_STATUS

Status of the last operation (PROP_LAST_STATUS).

MAC_BACKHAUL

Carry the host on a point-to-point link to the device’s own node instead of the shared medium (PROP_MAC_BACKHAUL). Session-scoped.

MAC_PROMISCUOUS

Deliver all received frames, bypassing host receive filtering (PROP_MAC_PROMISCUOUS). Session-scoped.

MAC_REPEATER_DEFAULT_REGION

Region code inserted into untagged flood packets (PROP_MAC_REPEATER_DEFAULT_REGION) — one 2-octet code, or empty to never tag.

MAC_REPEATER_ENABLED

Autonomous MAC-layer repeater/forwarding enable (PROP_MAC_REPEATER_ENABLED).

MAC_REPEATER_MIN_RSSI

Minimum received RSSI in dBm for flood forwarding (PROP_MAC_REPEATER_MIN_RSSI) — INT16, or empty for no threshold.

MAC_REPEATER_MIN_SNR

Minimum received SNR in whole dB for flood forwarding (PROP_MAC_REPEATER_MIN_SNR) — INT8, or empty for no threshold.

MAC_REPEATER_REGIONS

Regions the device identity flood-forwards for (PROP_MAC_REPEATER_REGIONS) — multiple-value, each item 1 to 24 octets of UTF-8 naming a region in its string form, empty for “forward regardless of region code”. The device derives the 2-octet forwarding codes itself; the strings are what it advertises, since a hash-derived code names nothing.

PHY_DUTY_LIMIT

Duty-cycle limit (PROP_PHY_DUTY_LIMIT).

PHY_DUTY_NOW

Transmit duty usage over the past hour (PROP_PHY_DUTY_NOW).

PHY_ENABLED

PHY enabled flag (PROP_PHY_ENABLED).

PHY_FREQ

Frequency in kHz (PROP_PHY_FREQ).

PHY_LORA_BW

LoRa bandwidth in Hz (PROP_PHY_LORA_BW).

PHY_LORA_CR

LoRa coding rate (PROP_PHY_LORA_CR).

PHY_LORA_SF

LoRa spreading factor (PROP_PHY_LORA_SF).

PHY_LORA_SW

LoRa sync word, SX126x-style 16-bit (PROP_PHY_LORA_SW).

PHY_MTU

Maximum STR_PHY_RAW data size in octets (PROP_PHY_MTU).

PHY_RSSI

Current RSSI in dBm (PROP_PHY_RSSI).

PHY_TX_POWER

TX power in dBm (PROP_PHY_TX_POWER).

PROTOCOL_VERSION

Protocol major/minor version (PROP_PROTOCOL_VERSION).

SAVED

Whether a saved snapshot exists (PROP_SAVED).

STARTUP_BEACON

Whether the device emits one beacon once it comes up (PROP_STARTUP_BEACON) — BOOL, default 1. Requires CAP_ADVERT.

STAT_FORWARDED

Receptions this node chose to repeat (PROP_STAT_FORWARDED) — UINT32_LE, counted at the decision rather than at the transmit, so a repeat the channel never let out is counted here and not in STAT_TX_PACKETS. Requires CAP_STATS and CAP_REPEATER.

STAT_FORWARD_CANCELLED

Queued repeats dropped after the destination’s acknowledgement was overheard (PROP_STAT_FORWARD_CANCELLED) — UINT32_LE. Airtime this node did not have to spend. Requires CAP_STATS and CAP_REPEATER.

STAT_FORWARD_DROPPED

Receptions this node would have repeated and declined under the operator’s forwarding policy (PROP_STAT_FORWARD_DROPPED) — UINT32_LE: an exhausted flood budget, a signal below the configured minimum RSSI or SNR, or a region the repeater does not serve. Duplicates and traffic addressed to this device are not policy decisions and are not counted. Requires CAP_STATS and CAP_REPEATER.

STAT_RX_ACCEPTED

Receptions the device’s own node acted on (PROP_STAT_RX_ACCEPTED) — UINT32_LE. Frames addressed to an attached host’s identity are that host’s business and are not counted here. Requires CAP_STATS and CAP_REPEATER.

STAT_RX_BAD_CRC

Receptions the radio rejected on CRC (PROP_STAT_RX_BAD_CRC) — UINT32_LE. These never reach the MAC: the bytes are unusable and the frame is dropped where it was demodulated. A count that climbs with a quiet packet count is interference or a marginal link. Requires CAP_STATS.

STAT_RX_NON_UMSH

Receptions that passed CRC but are not UMSH packets (PROP_STAT_RX_NON_UMSH) — UINT32_LE. The test is the first octet’s protocol version and reserved bits, so a truncated UMSH frame still counts as UMSH; this is somebody else’s traffic on the same sync word. Requires CAP_STATS.

STAT_RX_PACKETS

Receptions off the air that are UMSH packets (PROP_STAT_RX_PACKETS) — UINT32_LE, counted whoever they were addressed to. Requires CAP_STATS.

STAT_TX_CHANNEL_BUSY

Transmits the channel-activity check held back (PROP_STAT_TX_CHANNEL_BUSY) — UINT32_LE. Counted per attempt, so one frame that retries several times before it airs is counted several times here and once in STAT_TX_PACKETS. Requires CAP_STATS.

STAT_TX_PACKETS

Frames that reached the air (PROP_STAT_TX_PACKETS) — UINT32_LE, counted for every client of the radio, the attached host included. Requires CAP_STATS. See crate::stats for what the counters share: they wrap, they are not saved, CMD_RST does not touch them, and the only value a write may carry is zero.

TIME

Wall-clock time (PROP_TIME) — UINT32_LE seconds since the Unix epoch, or empty when the device does not know what time it is. Unsigned, so the encoding is wrap-free into 2106. Requires CAP_TIME.

TZ_OFFSET

Local time-zone offset from UTC (PROP_TZ_OFFSET) — INT16_LE minutes, default 0. Unlike PROP_TIME this always has a value: where the device is configured to be is known even when what time it is is not. Requires CAP_TIME.

UPTIME

Seconds since the device booted (PROP_UPTIME). Optional and ungated, like DEV_MODEL: a device with no monotonic clock to answer from refuses the get. Reads next to LAST_STATUS, which says why the device last reset — this says how long ago.