Skip to main content

Module paths

Module paths 

Source
Expand description

Generated runtime path registry.

Every sidecar and socket file the agent’s services share, named once, with the run-directory resolver and each sidecar’s freshness window. Source: contracts.toml; run ados-capabilities-codegen.

Structs§

SidecarPath
One registered state sidecar.
SocketPath
One registered Unix socket.

Constants§

API_INTERNAL_SOCK
AP_GUARD_JSON
AUX_CMD_SOCK
AUX_RPC_RESPONSES_SOCK
BIND_STATE_JSON
BOARD_JSON
BUTTONS_SOCK
CAMERAS_DISCOVERED_JSON
CAMERA_STATE_JSON
CAMERA_STATE_MAX_AGE_MS
CAMERA_USB_RECOVERY_JSON
CAMERA_USB_RECOVERY_MAX_AGE_MS
CAPTURE_STORAGE_JSON
CAPTURE_STORAGE_MAX_AGE_MS
CLOCK_JSON
CLOCK_MAX_AGE_MS
CLOUD_LINK_JSON
CLOUD_PUBLISH_SOCK
CRSF_CMD_SOCK
CRSF_STATS_JSON
CRSF_STATS_MAX_AGE_MS
FC_IDENTITY_JSON
FLEET_HERO_JSON
GNSS_CMD_SOCK
GNSS_JSON
GNSS_MAX_AGE_MS
GPIO_CMD_SOCK
GPIO_OUTPUT_JSON
GROUNDLINK_CMD_SOCK
GROUND_STATION_INPUT_JSON
HID_CMD_SOCK
HOP_SUPERVISOR_JSON
HOP_SUPERVISOR_MAX_AGE_MS
JANITOR_JSON
LCD_FB_STATS_JSON
LCD_FB_STATS_MAX_AGE_MS
LCD_LATENCY_JSON
LCD_LATENCY_MAX_AGE_MS
LCD_PAGE_REQUEST_JSON
LCD_PLUGIN_PAGE_JSON
LCD_PLUGIN_TAP_JSON
LCD_STATE_JSON
LINKED_PEERS_JSON
LINK_FEEDBACK_JSON
LOGD_PUSH_REQUEST_JSON
LOGD_PUSH_RESULT_JSON
LOGD_QUERY_SOCK
LOGD_SOCK
LORA_BEACONS_JSON
LORA_BEACONS_MAX_AGE_MS
LORA_JSON
LORA_MAX_AGE_MS
MAVLINK_INGEST_SOCK
MAVLINK_ROUTER_JSON
MAVLINK_ROUTER_MAX_AGE_MS
MAVLINK_SOCK
MESH_STATE_JSON
MESH_STATE_MAX_AGE_MS
MGMT_FAILOVER_JSON
MGMT_FAILOVER_MAX_AGE_MS
MGMT_LINK_JSON
MGMT_LINK_MAX_AGE_MS
MSP_SOCK
OFFLOAD_LINK_JSON
PAIRING_SOCK
PEER_PRESENCE_JSON
PEER_PRESENCE_MAX_AGE_MS
PIC_SOCK
PIC_STATE_JSON
PLUGIN_LOOPBACK_GUARD_JSON
PLUGIN_STATE_MAX_AGE_MS
RADIO_AUX_SOCK
RADIO_CMD_SOCK
RELAYED_STATUS_JSON
RELAYED_STATUS_MAX_AGE_MS
RUN_DIR_DEFAULT
The run directory when ADOS_RUN_DIR is unset or empty.
RUN_DIR_ENV
The environment variable that relocates the run directory.
SENSORHUB_JSON
SENSORHUB_MAX_AGE_MS
SENSORS_JSON
SENSORS_MAX_AGE_MS
SENSOR_BUS_SOCK
SIDECARS
Every registered sidecar.
SOCKETS
Every registered socket.
STATE_SOCK
SUPERVISOR_SOCK
SWARM_SOCK
TUNNEL_CONFIG_CMD_SOCK
TUNNEL_CONFIG_JSON
TUNNEL_CONFIG_MAX_AGE_MS
USB_REHOME_JSON
USB_REHOME_MAX_AGE_MS
VIDEO_CMD_SOCK
VIDEO_ENCODER_SOCK
VIDEO_PROFILE_JSON
VIDEO_STREAMS_JSON
VIDEO_STREAMS_MAX_AGE_MS
VISION_SOCK
WFB_CMD_SOCK
WFB_FAILOVER_JSON
WFB_FAILOVER_MAX_AGE_MS
WFB_PAIR_PROOF_JSON
WFB_RECEIVER_JSON
WFB_RECEIVER_MAX_AGE_MS
WFB_RELAY_JSON
WFB_RELAY_MAX_AGE_MS
WFB_STATS_JSON
WFB_STATS_MAX_AGE_MS
WIFI_CMD_SOCK
WIFI_POWERSAVE_JSON
WIFI_POWERSAVE_MAX_AGE_MS

Functions§

max_age
The freshness window of a registered sidecar, or None when the id is not registered or the sidecar has no window.
resolve
Resolve a registry path: a /run/ados/... path moves under run_dir, any other absolute path is returned as registered.
run_dir
The run directory: ADOS_RUN_DIR when set and non-empty, else RUN_DIR_DEFAULT.
run_path
The resolved path of a registered sidecar or socket id. An id with no registry row is taken as a file name under run_dir, so an unregistered sentinel or journal (uplink-active, mesh-events.jsonl) resolves the same way.
sidecar
The registered sidecar with this id.
socket
The registered socket with this id.