Skip to content

Commit

Permalink
MAV_RESULT: Clarify exactly what the possible results mean (mavlink#1253
Browse files Browse the repository at this point in the history
)

# Conflicts:
#	message_definitions/v1.0/common.xml
  • Loading branch information
hamishwillee authored and tridge committed Dec 22, 2019
1 parent 7e01a27 commit 8585d8c
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions message_definitions/v1.0/common.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2308,21 +2308,24 @@
</entry>
</enum>
<enum name="MAV_RESULT">
<description>result from a mavlink command</description>
<description>Result from a MAVLink command (MAV_CMD)</description>
<entry value="0" name="MAV_RESULT_ACCEPTED">
<description>Command ACCEPTED and EXECUTED</description>
<description>Command is valid (is supported and has valid parameters), and was executed.</description>
</entry>
<entry value="1" name="MAV_RESULT_TEMPORARILY_REJECTED">
<description>Command TEMPORARY REJECTED/DENIED</description>
<description>Command is valid, but cannot be executed at this time. This is used to indicate a problem that should be fixed just by waiting (e.g. a state machine is busy, can't arm because have not got GPS lock, etc.). Retrying later should work.</description>
</entry>
<entry value="2" name="MAV_RESULT_DENIED">
<description>Command PERMANENTLY DENIED</description>
<description>Command is invalid (is supported but has invalid parameters). Retrying same command and parameters will not work.</description>
</entry>
<entry value="3" name="MAV_RESULT_UNSUPPORTED">
<description>Command UNKNOWN/UNSUPPORTED</description>
<description>Command is not supported (unknown).</description>
</entry>
<entry value="4" name="MAV_RESULT_FAILED">
<description>Command executed, but failed</description>
<description>Command is valid, but execution has failed. This is used to indicate any non-temporary or unexpected problem, i.e. any problem that must be fixed before the command can succeed/be retried. For example, attempting to write a file when out of memory, attempting to arm when sensors are not calibrated, etc.</description>
</entry>
<entry value="5" name="MAV_RESULT_IN_PROGRESS">
<description>Command is valid and is being executed. This will be followed by further progress updates, i.e. the component may send further COMMAND_ACK messages with result MAV_RESULT_IN_PROGRESS (at a rate decided by the implementation), and must terminate by sending a COMMAND_ACK message with final result of the operation. The COMMAND_ACK.progress field can be used to indicate the progress of the operation. There is no need for the sender to retry the command, but if done during execution, the component will return MAV_RESULT_IN_PROGRESS with an updated progress.</description>
</entry>
</enum>
<enum name="MAV_MISSION_RESULT">
Expand Down

0 comments on commit 8585d8c

Please sign in to comment.