Module cap

Module cap 

Source
Expand description

Capability codes advertised via PROP_CAPS.

Constants§

ADMIN
CAP_ADMIN — the device can be managed over the mesh by the nodes listed in PROP_DEV_ADMINS. Requires CAP_DEV_IDENTITY, since an administrator addresses the device identity, and CAP_CMD_MULTI, so an administrator may rely on the multi-property commands.
ADVERT
CAP_ADVERT — the device announces itself on a schedule of its own (PROP_ADVERT_INTERVAL, PROP_BEACON_INTERVAL, PROP_STARTUP_BEACON). Requires CAP_DEV_IDENTITY, since what an advertisement carries is the device identity.
ALERT
CAP_ALERT — the device has some means of making itself physically conspicuous on demand (PROP_ALERT). It says nothing about which means, so a host must not assume audibility.
BATTERY
CAP_BATTERY
BLE
CAP_BLE — the device has a Bluetooth transport whose reachability it can turn on and off (PROP_BLE_ENABLED, PROP_BLE_LINK). It says nothing about the stack underneath, and in particular does not promise that clearing PROP_BLE_ENABLED powers a radio down.
CMD_MULTI
CAP_CMD_MULTI — the device accepts CMD_PROP_MULTI_GET and CMD_PROP_MULTI_SET and answers them with CMD_PROP_ARE.
DEV_IDENTITY
CAP_DEV_IDENTITY
DEV_NAME
CAP_DEV_NAME
GNSS
CAP_GNSS — a GNSS receiver is fitted, so the positioning properties exist and the wall clock has a source that can set itself. Requires CAP_TIME.
HOST_AUTO_ACK
CAP_HOST_AUTO_ACK (requires CAP_HOST_KEYS and CAP_HOST_RX_QUEUE)
HOST_FILTER
CAP_HOST_FILTER
HOST_KEYS
CAP_HOST_KEYS (requires CAP_HOST_FILTER)
HOST_RX_QUEUE
CAP_HOST_RX_QUEUE (requires CAP_HOST_FILTER)
IDENT
CAP_IDENT — the device serves and configures its own advertised node identity (PROP_IDENT, PROP_IDENT_ROLE, PROP_IDENT_MOBILE). Requires CAP_DEV_IDENTITY.
ILLUMINANCE
CAP_ILLUMINANCE — an ambient light sensor is fitted, so PROP_ILLUMINANCE reads a measurement rather than nothing.
MAC_BACKHAUL
CAP_MAC_BACKHAUL — the device can carry the host on a point-to-point link to its own node (PROP_MAC_BACKHAUL). Requires CAP_REPEATER: without a repeater there is nothing on the far side of that link to carry the host’s traffic onward.
PHY_DUTY_LIMIT
CAP_PHY_DUTY_LIMIT
PHY_LORA
CAP_PHY_LORA
REBOOT
CAP_REBOOT — the device can restart its hardware on command (CMD_REBOOT). A device that cannot — one whose ULCP session is a process rather than a board — leaves this out and answers the command STATUS_UNIMPLEMENTED.
REPEATER
CAP_REPEATER — the device can act as an autonomous mesh repeater (PROP_MAC_REPEATER_ENABLED). Requires CAP_DEV_IDENTITY.
SAVE
CAP_SAVE
STATS
CAP_STATS — the device keeps traffic counters and will report them (PROP_STAT_*). The forwarding counters additionally require REPEATER: a session with no node of its own behind it never repeats anything, and reporting zero forwards would read as a repeater that has done nothing rather than as no repeater at all.
TIME
CAP_TIME — the device keeps a wall clock (PROP_TIME, PROP_TZ_OFFSET). It says nothing about where the time comes from or whether it survives a power cycle.
WRITABLE_RAW_STREAM
CAP_WRITABLE_RAW_STREAM