Expand description
The ULCP session state machine.
Structs§
- Alert
Config - How this board serves
PROP_ALERT. - Battery
Fields - Which battery measurements the platform is capable of reporting
through
PROP_BATTERY. Fixed for the life of a session: these bits bound the field-flags octet of every snapshot. - Gnss
Config - That this board has a GNSS receiver (
CAP_GNSS). - Radio
Settings - Radio configuration owned by the session and pushed to the radio
via
Effect::ApplyRadio. - Session
- Session
Config - Fixed properties of the device this session runs on.
- Time
Config - That this board keeps a wall clock (
CAP_TIME).
Enums§
- Effect
- A radio side effect for the caller to execute.
- Identity
Source - A staged
PROP_DEV_PRIVATE_KEYprovisioning request (seeEffect::ProvisionIdentity). - Saved
Status - What
PROP_SAVEDreports about the stored snapshot. - Snapshot
Error - Why a stored snapshot payload was rejected. Rejection is never
silent: the boot path walks back a generation and reports through
PROP_SAVED(spec §Saved State). - TxOutcome
- Physical-radio outcome of the transmit started by
Effect::StartTransmit, reported viaSession::on_tx_result. - TxPower
- Transmit power selection for one pending transmit.
Constants§
- DEFAULT_
IDENT_ PRECISION - Post-reset value of
PROP_GNSS_IDENT_PRECISION: a ~38 × 19 m cell, fine enough to place a node on a street and coarse enough not to place it in a room. - MAX_
CHANNEL_ KEYS - Maximum number of
PROP_HOST_CHANNEL_KEYSentries. - MAX_
DEVICE_ NAME_ LEN - Maximum UTF-8 byte length of
PROP_DEV_NAME. - MAX_
DEV_ PEERS - Maximum number of
PROP_DEV_PEERSentries. - MAX_
IDENT_ PRECISION - Largest
PROP_GNSS_IDENT_PRECISION, matching the location encoding’s own maximum. - MAX_MTU
- Largest radio payload the session can carry (SX126x-class limit).
- MAX_
PEER_ KEYS - Maximum number of
PROP_HOST_PEER_KEYSentries. - MAX_
REPEATER_ REGIONS - Maximum number of
PROP_MAC_REPEATER_REGIONSentries. Matches the MAC’s own repeater region capacity, so any value this session accepts fits the forwarding policy it ends up configuring. - MAX_
RX_ FILTERS - Maximum number of explicit
PROP_HOST_RX_FILTERSentries. - PRIVATE_
KEY_ LEN - Ed25519 private keys are 32 octets, like public keys.
- RX_
QUEUE_ CAPACITY PROP_HOST_RX_QUEUE_CAPACITY: the fixed size of the inbound queue.- SNAPSHOT_
MAX - Largest encoded snapshot the session produces (see
Session::encode_snapshot); sized for every table at capacity with headroom for future properties.