ModeCompleted.msg: document nav_state (#22544)

This commit is contained in:
Federico Ciresola 2024-01-08 11:32:41 +01:00 committed by GitHub
parent 3d5c2ef6c4
commit 20129e63fa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,4 +1,5 @@
# Mode completion result, published by an active mode. # Mode completion result, published by an active mode.
# The possible values of nav_state are defined in the VehicleStatus msg.
# Note that this is not always published (e.g. when a user switches modes or on # Note that this is not always published (e.g. when a user switches modes or on
# failsafe activation) # failsafe activation)
uint64 timestamp # time since system start (microseconds) uint64 timestamp # time since system start (microseconds)
@ -10,5 +11,5 @@ uint8 RESULT_FAILURE_OTHER = 100 # Mode failed (generic error)
uint8 result # One of RESULT_* uint8 result # One of RESULT_*
uint8 nav_state # Source mode uint8 nav_state # Source mode (values in VehicleStatus)