Skip to content

Commit 7bdb2dc

Browse files
peterbarkertridge
authored andcommitted
common.xml: description and unit fixes
1 parent cfa5f9b commit 7bdb2dc

1 file changed

Lines changed: 9 additions & 8 deletions

File tree

message_definitions/v1.0/common.xml

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1564,9 +1564,9 @@
15641564
<param index="2">Empty</param>
15651565
<param index="3">Empty</param>
15661566
<param index="4">Empty</param>
1567-
<param index="5" label="Pitch Offset">Pitch offset from next waypoint, positive pitching up</param>
1568-
<param index="6" label="Roll Offset">Roll offset from next waypoint, positive rolling to the right</param>
1569-
<param index="7" label="Yaw Offset">Yaw offset from next waypoint, positive yawing to the right</param>
1567+
<param index="5" label="Pitch Offset" units="deg">Pitch offset from next waypoint, positive pitching up</param>
1568+
<param index="6" label="Roll Offset" units="deg">Roll offset from next waypoint, positive rolling to the right</param>
1569+
<param index="7" label="Yaw Offset" units="deg">Yaw offset from next waypoint, positive yawing to the right</param>
15701570
</entry>
15711571
<entry value="197" name="MAV_CMD_DO_SET_ROI_NONE" hasLocation="false" isDestination="false">
15721572
<description>Cancels any previous ROI command returning the vehicle/sensors to default flight characteristics. This can then be used by the vehicle's control system to control the vehicle attitude and the attitude of various sensors such as cameras.</description>
@@ -2285,7 +2285,7 @@
22852285
<entry value="3001" name="MAV_CMD_ARM_AUTHORIZATION_REQUEST" hasLocation="false" isDestination="false">
22862286
<description>Request authorization to arm the vehicle to a external entity, the arm authorizer is responsible to request all data that is needs from the vehicle before authorize or deny the request.
22872287
If approved the COMMAND_ACK message progress field should be set with period of time that this authorization is valid in seconds.
2288-
If the authorization is denied COMMAND_ACK.result_param2 should be set with one of the reasons in ARM_AUTH_DENIED_REASON.
2288+
If the authorization is denied COMMAND_ACK.result_param2 should be set with one of the reasons in MAV_ARM_AUTH_DENIED_REASON.
22892289
</description>
22902290
<param index="1" label="System ID" minValue="0" maxValue="255" increment="1">Vehicle system id, this way ground station can request arm authorization on behalf of any vehicle</param>
22912291
</entry>
@@ -2626,7 +2626,7 @@
26262626
</entry>
26272627
<!-- END of user range (31000 to 31999) -->
26282628
<entry value="32000" name="MAV_CMD_CAN_FORWARD" hasLocation="false" isDestination="false">
2629-
<description>Request forwarding of CAN packets from the given CAN bus to this component via this mavlink channel. CAN Frames are sent using CAN_FRAME and CANFD_FRAME messages</description>
2629+
<description>Request forwarding of CAN packets from the given CAN bus to this component via this MAVLink channel. CAN Frames are sent using CAN_FRAME and CANFD_FRAME messages</description>
26302630
<param index="1" label="bus">Bus number (0 to disable forwarding, 1 for first bus, 2 for 2nd bus, 3 for 3rd bus).</param>
26312631
<param index="2">Empty.</param>
26322632
<param index="3">Empty.</param>
@@ -3874,6 +3874,7 @@
38743874
</entry>
38753875
</enum>
38763876
<enum name="MAV_ARM_AUTH_DENIED_REASON">
3877+
<description>Reasons for denying an authorization request made with MAV_CMD_ARM_AUTHORIZATION_REQUEST. If the COMMAND_ACK result is MAV_RESULT_DENIED, this is used to set the reason in the result_param2 field.</description>
38773878
<entry value="0" name="MAV_ARM_AUTH_DENIED_REASON_GENERIC">
38783879
<description>Not a specific reason</description>
38793880
</entry>
@@ -4768,7 +4769,7 @@
47684769
<entry value="2" name="CAN_FILTER_REMOVE"/>
47694770
</enum>
47704771
<enum name="MAV_FTP_ERR">
4771-
<description>MAV FTP error codes (https://mavlink.io/en/services/ftp.html)</description>
4772+
<description>MAV FTP error codes (may be used in FILE_TRANSFER_PROTOCOL). See https://mavlink.io/en/services/ftp.html.</description>
47724773
<entry value="0" name="MAV_FTP_ERR_NONE">
47734774
<description>None: No error</description>
47744775
</entry>
@@ -4805,7 +4806,7 @@
48054806
</entry>
48064807
</enum>
48074808
<enum name="MAV_FTP_OPCODE">
4808-
<description>MAV FTP opcodes: https://mavlink.io/en/services/ftp.html</description>
4809+
<description>MAV FTP opcodes (may be used in FILE_TRANSFER_PROTOCOL). See https://mavlink.io/en/services/ftp.html.</description>
48094810
<entry value="0" name="MAV_FTP_OPCODE_NONE">
48104811
<description>None. Ignored, always ACKed</description>
48114812
</entry>
@@ -5040,7 +5041,7 @@
50405041
<field type="uint32_t" name="onboard_control_sensors_enabled" enum="MAV_SYS_STATUS_SENSOR" print_format="0x%04x">Bitmap showing which onboard controllers and sensors are enabled: Value of 0: not enabled. Value of 1: enabled.</field>
50415042
<field type="uint32_t" name="onboard_control_sensors_health" enum="MAV_SYS_STATUS_SENSOR" print_format="0x%04x">Bitmap showing which onboard controllers and sensors have an error (or are operational). Value of 0: error. Value of 1: healthy.</field>
50425043
<field type="uint16_t" name="load" units="d%">Maximum usage in percent of the mainloop time. Values: [0-1000] - should always be below 1000</field>
5043-
<field type="uint16_t" name="voltage_battery" units="mV">Battery voltage, UINT16_MAX: Voltage not sent by autopilot</field>
5044+
<field type="uint16_t" name="voltage_battery" units="mV" invalid="UINT16_MAX">Battery voltage, UINT16_MAX: Voltage not sent by autopilot</field>
50445045
<field type="int16_t" name="current_battery" units="cA" invalid="-1">Battery current, -1: Current not sent by autopilot</field>
50455046
<field type="int8_t" name="battery_remaining" units="%" invalid="-1">Battery energy remaining, -1: Battery remaining energy not sent by autopilot</field>
50465047
<field type="uint16_t" name="drop_rate_comm" units="c%">Communication drop rate, (UART, I2C, SPI, CAN), dropped packets on all links (packets that were corrupted on reception on the MAV)</field>

0 commit comments

Comments
 (0)