docs(docs): ConfigOverrides.msg to uorb doc standard (#28658)

This commit is contained in:
Hamish Willee authored and GitHub committed 2026-11-06 06:08:32 +11:00
1 parent 37b5378d85
commit d5a77d8fce
1 file changed
+14 -10
+14 -10
View File
@@ -1,20 +1,24 @@
# Configurable overrides by (external) modes or mode executors
# Configuration overrides from external modes or mode executors
#
# An external mode or mode executor requests overrides on config_overrides_request, identifying itself with source_type and source_id.
# Commander stores them for that mode or executor and echoes the request on config_overrides_confirm as acknowledgement.
# Commander publishes the overrides in effect on config_overrides: those of the current mode, with those of the executor in charge applied on top.
uint32 MESSAGE_VERSION = 1
uint64 timestamp # time since system start (microseconds)
uint64 timestamp # [us] Time since system start
bool disable_auto_disarm # Prevent the drone from automatically disarming after landing (if configured)
bool disable_auto_disarm # Prevent the drone from automatically disarming after landing (if configured)
bool defer_failsafes # Defer all failsafes that can be deferred (until the flag is cleared)
int16 defer_failsafes_timeout_s # Maximum time a failsafe can be deferred. 0 = system default, -1 = no timeout
bool disable_auto_set_home # Prevent the drone from automatically setting the home position on arm or takeoff
bool defer_failsafes # Defer all deferrable failsafes (until the flag is cleared)
int16 defer_failsafes_timeout_s # [s] [@invalid -1 No timeout] Maximum time a failsafe can be deferred. 0 = system default.
bool disable_auto_set_home # Prevent the drone from automatically setting the home position on arm or takeoff
int8 SOURCE_TYPE_MODE = 0
int8 SOURCE_TYPE_MODE_EXECUTOR = 1
int8 source_type
int8 source_type # [@enum SOURCE_TYPE] Origin of this override
int8 SOURCE_TYPE_MODE = 0 # Override originates from a mode
int8 SOURCE_TYPE_MODE_EXECUTOR = 1 # Override originates from a mode executor
uint8 source_id # ID depending on source_type
uint8 source_id # [-] ID assigned at registration (RegisterExtComponentReply): mode_id for SOURCE_TYPE_MODE, mode_executor_id for SOURCE_TYPE_MODE_EXECUTOR
uint8 ORB_QUEUE_LENGTH = 4