mavlink_msg_command_ack.h 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338
  1. #pragma once
  2. // MESSAGE COMMAND_ACK PACKING
  3. #define MAVLINK_MSG_ID_COMMAND_ACK 77
  4. typedef struct __mavlink_command_ack_t {
  5. uint16_t command; /*< Command ID (of acknowledged command).*/
  6. uint8_t result; /*< Result of command.*/
  7. uint8_t progress; /*< [%] The progress percentage when result is MAV_RESULT_IN_PROGRESS. Values: [0-100], or UINT8_MAX if the progress is unknown.*/
  8. int32_t result_param2; /*< Additional result information. Can be set with a command-specific enum containing command-specific error reasons for why the command might be denied. If used, the associated enum must be documented in the corresponding MAV_CMD (this enum should have a 0 value to indicate "unused" or "unknown").*/
  9. uint8_t target_system; /*< System ID of the target recipient. This is the ID of the system that sent the command for which this COMMAND_ACK is an acknowledgement.*/
  10. uint8_t target_component; /*< Component ID of the target recipient. This is the ID of the system that sent the command for which this COMMAND_ACK is an acknowledgement.*/
  11. } mavlink_command_ack_t;
  12. #define MAVLINK_MSG_ID_COMMAND_ACK_LEN 10
  13. #define MAVLINK_MSG_ID_COMMAND_ACK_MIN_LEN 3
  14. #define MAVLINK_MSG_ID_77_LEN 10
  15. #define MAVLINK_MSG_ID_77_MIN_LEN 3
  16. #define MAVLINK_MSG_ID_COMMAND_ACK_CRC 143
  17. #define MAVLINK_MSG_ID_77_CRC 143
  18. #if MAVLINK_COMMAND_24BIT
  19. #define MAVLINK_MESSAGE_INFO_COMMAND_ACK { \
  20. 77, \
  21. "COMMAND_ACK", \
  22. 6, \
  23. { { "command", NULL, MAVLINK_TYPE_UINT16_T, 0, 0, offsetof(mavlink_command_ack_t, command) }, \
  24. { "result", NULL, MAVLINK_TYPE_UINT8_T, 0, 2, offsetof(mavlink_command_ack_t, result) }, \
  25. { "progress", NULL, MAVLINK_TYPE_UINT8_T, 0, 3, offsetof(mavlink_command_ack_t, progress) }, \
  26. { "result_param2", NULL, MAVLINK_TYPE_INT32_T, 0, 4, offsetof(mavlink_command_ack_t, result_param2) }, \
  27. { "target_system", NULL, MAVLINK_TYPE_UINT8_T, 0, 8, offsetof(mavlink_command_ack_t, target_system) }, \
  28. { "target_component", NULL, MAVLINK_TYPE_UINT8_T, 0, 9, offsetof(mavlink_command_ack_t, target_component) }, \
  29. } \
  30. }
  31. #else
  32. #define MAVLINK_MESSAGE_INFO_COMMAND_ACK { \
  33. "COMMAND_ACK", \
  34. 6, \
  35. { { "command", NULL, MAVLINK_TYPE_UINT16_T, 0, 0, offsetof(mavlink_command_ack_t, command) }, \
  36. { "result", NULL, MAVLINK_TYPE_UINT8_T, 0, 2, offsetof(mavlink_command_ack_t, result) }, \
  37. { "progress", NULL, MAVLINK_TYPE_UINT8_T, 0, 3, offsetof(mavlink_command_ack_t, progress) }, \
  38. { "result_param2", NULL, MAVLINK_TYPE_INT32_T, 0, 4, offsetof(mavlink_command_ack_t, result_param2) }, \
  39. { "target_system", NULL, MAVLINK_TYPE_UINT8_T, 0, 8, offsetof(mavlink_command_ack_t, target_system) }, \
  40. { "target_component", NULL, MAVLINK_TYPE_UINT8_T, 0, 9, offsetof(mavlink_command_ack_t, target_component) }, \
  41. } \
  42. }
  43. #endif
  44. /**
  45. * @brief Pack a command_ack message
  46. * @param system_id ID of this system
  47. * @param component_id ID of this component (e.g. 200 for IMU)
  48. * @param msg The MAVLink message to compress the data into
  49. *
  50. * @param command Command ID (of acknowledged command).
  51. * @param result Result of command.
  52. * @param progress [%] The progress percentage when result is MAV_RESULT_IN_PROGRESS. Values: [0-100], or UINT8_MAX if the progress is unknown.
  53. * @param result_param2 Additional result information. Can be set with a command-specific enum containing command-specific error reasons for why the command might be denied. If used, the associated enum must be documented in the corresponding MAV_CMD (this enum should have a 0 value to indicate "unused" or "unknown").
  54. * @param target_system System ID of the target recipient. This is the ID of the system that sent the command for which this COMMAND_ACK is an acknowledgement.
  55. * @param target_component Component ID of the target recipient. This is the ID of the system that sent the command for which this COMMAND_ACK is an acknowledgement.
  56. * @return length of the message in bytes (excluding serial stream start sign)
  57. */
  58. static inline uint16_t mavlink_msg_command_ack_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
  59. uint16_t command, uint8_t result, uint8_t progress, int32_t result_param2, uint8_t target_system, uint8_t target_component)
  60. {
  61. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  62. char buf[MAVLINK_MSG_ID_COMMAND_ACK_LEN];
  63. _mav_put_uint16_t(buf, 0, command);
  64. _mav_put_uint8_t(buf, 2, result);
  65. _mav_put_uint8_t(buf, 3, progress);
  66. _mav_put_int32_t(buf, 4, result_param2);
  67. _mav_put_uint8_t(buf, 8, target_system);
  68. _mav_put_uint8_t(buf, 9, target_component);
  69. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_COMMAND_ACK_LEN);
  70. #else
  71. mavlink_command_ack_t packet;
  72. packet.command = command;
  73. packet.result = result;
  74. packet.progress = progress;
  75. packet.result_param2 = result_param2;
  76. packet.target_system = target_system;
  77. packet.target_component = target_component;
  78. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_COMMAND_ACK_LEN);
  79. #endif
  80. msg->msgid = MAVLINK_MSG_ID_COMMAND_ACK;
  81. return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_COMMAND_ACK_MIN_LEN, MAVLINK_MSG_ID_COMMAND_ACK_LEN, MAVLINK_MSG_ID_COMMAND_ACK_CRC);
  82. }
  83. /**
  84. * @brief Pack a command_ack message on a channel
  85. * @param system_id ID of this system
  86. * @param component_id ID of this component (e.g. 200 for IMU)
  87. * @param chan The MAVLink channel this message will be sent over
  88. * @param msg The MAVLink message to compress the data into
  89. * @param command Command ID (of acknowledged command).
  90. * @param result Result of command.
  91. * @param progress [%] The progress percentage when result is MAV_RESULT_IN_PROGRESS. Values: [0-100], or UINT8_MAX if the progress is unknown.
  92. * @param result_param2 Additional result information. Can be set with a command-specific enum containing command-specific error reasons for why the command might be denied. If used, the associated enum must be documented in the corresponding MAV_CMD (this enum should have a 0 value to indicate "unused" or "unknown").
  93. * @param target_system System ID of the target recipient. This is the ID of the system that sent the command for which this COMMAND_ACK is an acknowledgement.
  94. * @param target_component Component ID of the target recipient. This is the ID of the system that sent the command for which this COMMAND_ACK is an acknowledgement.
  95. * @return length of the message in bytes (excluding serial stream start sign)
  96. */
  97. static inline uint16_t mavlink_msg_command_ack_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
  98. mavlink_message_t* msg,
  99. uint16_t command,uint8_t result,uint8_t progress,int32_t result_param2,uint8_t target_system,uint8_t target_component)
  100. {
  101. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  102. char buf[MAVLINK_MSG_ID_COMMAND_ACK_LEN];
  103. _mav_put_uint16_t(buf, 0, command);
  104. _mav_put_uint8_t(buf, 2, result);
  105. _mav_put_uint8_t(buf, 3, progress);
  106. _mav_put_int32_t(buf, 4, result_param2);
  107. _mav_put_uint8_t(buf, 8, target_system);
  108. _mav_put_uint8_t(buf, 9, target_component);
  109. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_COMMAND_ACK_LEN);
  110. #else
  111. mavlink_command_ack_t packet;
  112. packet.command = command;
  113. packet.result = result;
  114. packet.progress = progress;
  115. packet.result_param2 = result_param2;
  116. packet.target_system = target_system;
  117. packet.target_component = target_component;
  118. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_COMMAND_ACK_LEN);
  119. #endif
  120. msg->msgid = MAVLINK_MSG_ID_COMMAND_ACK;
  121. return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_COMMAND_ACK_MIN_LEN, MAVLINK_MSG_ID_COMMAND_ACK_LEN, MAVLINK_MSG_ID_COMMAND_ACK_CRC);
  122. }
  123. /**
  124. * @brief Encode a command_ack struct
  125. *
  126. * @param system_id ID of this system
  127. * @param component_id ID of this component (e.g. 200 for IMU)
  128. * @param msg The MAVLink message to compress the data into
  129. * @param command_ack C-struct to read the message contents from
  130. */
  131. static inline uint16_t mavlink_msg_command_ack_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_command_ack_t* command_ack)
  132. {
  133. return mavlink_msg_command_ack_pack(system_id, component_id, msg, command_ack->command, command_ack->result, command_ack->progress, command_ack->result_param2, command_ack->target_system, command_ack->target_component);
  134. }
  135. /**
  136. * @brief Encode a command_ack struct on a channel
  137. *
  138. * @param system_id ID of this system
  139. * @param component_id ID of this component (e.g. 200 for IMU)
  140. * @param chan The MAVLink channel this message will be sent over
  141. * @param msg The MAVLink message to compress the data into
  142. * @param command_ack C-struct to read the message contents from
  143. */
  144. static inline uint16_t mavlink_msg_command_ack_encode_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const mavlink_command_ack_t* command_ack)
  145. {
  146. return mavlink_msg_command_ack_pack_chan(system_id, component_id, chan, msg, command_ack->command, command_ack->result, command_ack->progress, command_ack->result_param2, command_ack->target_system, command_ack->target_component);
  147. }
  148. /**
  149. * @brief Send a command_ack message
  150. * @param chan MAVLink channel to send the message
  151. *
  152. * @param command Command ID (of acknowledged command).
  153. * @param result Result of command.
  154. * @param progress [%] The progress percentage when result is MAV_RESULT_IN_PROGRESS. Values: [0-100], or UINT8_MAX if the progress is unknown.
  155. * @param result_param2 Additional result information. Can be set with a command-specific enum containing command-specific error reasons for why the command might be denied. If used, the associated enum must be documented in the corresponding MAV_CMD (this enum should have a 0 value to indicate "unused" or "unknown").
  156. * @param target_system System ID of the target recipient. This is the ID of the system that sent the command for which this COMMAND_ACK is an acknowledgement.
  157. * @param target_component Component ID of the target recipient. This is the ID of the system that sent the command for which this COMMAND_ACK is an acknowledgement.
  158. */
  159. #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
  160. static inline void mavlink_msg_command_ack_send(mavlink_channel_t chan, uint16_t command, uint8_t result, uint8_t progress, int32_t result_param2, uint8_t target_system, uint8_t target_component)
  161. {
  162. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  163. char buf[MAVLINK_MSG_ID_COMMAND_ACK_LEN];
  164. _mav_put_uint16_t(buf, 0, command);
  165. _mav_put_uint8_t(buf, 2, result);
  166. _mav_put_uint8_t(buf, 3, progress);
  167. _mav_put_int32_t(buf, 4, result_param2);
  168. _mav_put_uint8_t(buf, 8, target_system);
  169. _mav_put_uint8_t(buf, 9, target_component);
  170. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_COMMAND_ACK, buf, MAVLINK_MSG_ID_COMMAND_ACK_MIN_LEN, MAVLINK_MSG_ID_COMMAND_ACK_LEN, MAVLINK_MSG_ID_COMMAND_ACK_CRC);
  171. #else
  172. mavlink_command_ack_t packet;
  173. packet.command = command;
  174. packet.result = result;
  175. packet.progress = progress;
  176. packet.result_param2 = result_param2;
  177. packet.target_system = target_system;
  178. packet.target_component = target_component;
  179. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_COMMAND_ACK, (const char *)&packet, MAVLINK_MSG_ID_COMMAND_ACK_MIN_LEN, MAVLINK_MSG_ID_COMMAND_ACK_LEN, MAVLINK_MSG_ID_COMMAND_ACK_CRC);
  180. #endif
  181. }
  182. /**
  183. * @brief Send a command_ack message
  184. * @param chan MAVLink channel to send the message
  185. * @param struct The MAVLink struct to serialize
  186. */
  187. static inline void mavlink_msg_command_ack_send_struct(mavlink_channel_t chan, const mavlink_command_ack_t* command_ack)
  188. {
  189. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  190. mavlink_msg_command_ack_send(chan, command_ack->command, command_ack->result, command_ack->progress, command_ack->result_param2, command_ack->target_system, command_ack->target_component);
  191. #else
  192. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_COMMAND_ACK, (const char *)command_ack, MAVLINK_MSG_ID_COMMAND_ACK_MIN_LEN, MAVLINK_MSG_ID_COMMAND_ACK_LEN, MAVLINK_MSG_ID_COMMAND_ACK_CRC);
  193. #endif
  194. }
  195. #if MAVLINK_MSG_ID_COMMAND_ACK_LEN <= MAVLINK_MAX_PAYLOAD_LEN
  196. /*
  197. This variant of _send() can be used to save stack space by re-using
  198. memory from the receive buffer. The caller provides a
  199. mavlink_message_t which is the size of a full mavlink message. This
  200. is usually the receive buffer for the channel, and allows a reply to an
  201. incoming message with minimum stack space usage.
  202. */
  203. static inline void mavlink_msg_command_ack_send_buf(mavlink_message_t *msgbuf, mavlink_channel_t chan, uint16_t command, uint8_t result, uint8_t progress, int32_t result_param2, uint8_t target_system, uint8_t target_component)
  204. {
  205. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  206. char *buf = (char *)msgbuf;
  207. _mav_put_uint16_t(buf, 0, command);
  208. _mav_put_uint8_t(buf, 2, result);
  209. _mav_put_uint8_t(buf, 3, progress);
  210. _mav_put_int32_t(buf, 4, result_param2);
  211. _mav_put_uint8_t(buf, 8, target_system);
  212. _mav_put_uint8_t(buf, 9, target_component);
  213. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_COMMAND_ACK, buf, MAVLINK_MSG_ID_COMMAND_ACK_MIN_LEN, MAVLINK_MSG_ID_COMMAND_ACK_LEN, MAVLINK_MSG_ID_COMMAND_ACK_CRC);
  214. #else
  215. mavlink_command_ack_t *packet = (mavlink_command_ack_t *)msgbuf;
  216. packet->command = command;
  217. packet->result = result;
  218. packet->progress = progress;
  219. packet->result_param2 = result_param2;
  220. packet->target_system = target_system;
  221. packet->target_component = target_component;
  222. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_COMMAND_ACK, (const char *)packet, MAVLINK_MSG_ID_COMMAND_ACK_MIN_LEN, MAVLINK_MSG_ID_COMMAND_ACK_LEN, MAVLINK_MSG_ID_COMMAND_ACK_CRC);
  223. #endif
  224. }
  225. #endif
  226. #endif
  227. // MESSAGE COMMAND_ACK UNPACKING
  228. /**
  229. * @brief Get field command from command_ack message
  230. *
  231. * @return Command ID (of acknowledged command).
  232. */
  233. static inline uint16_t mavlink_msg_command_ack_get_command(const mavlink_message_t* msg)
  234. {
  235. return _MAV_RETURN_uint16_t(msg, 0);
  236. }
  237. /**
  238. * @brief Get field result from command_ack message
  239. *
  240. * @return Result of command.
  241. */
  242. static inline uint8_t mavlink_msg_command_ack_get_result(const mavlink_message_t* msg)
  243. {
  244. return _MAV_RETURN_uint8_t(msg, 2);
  245. }
  246. /**
  247. * @brief Get field progress from command_ack message
  248. *
  249. * @return [%] The progress percentage when result is MAV_RESULT_IN_PROGRESS. Values: [0-100], or UINT8_MAX if the progress is unknown.
  250. */
  251. static inline uint8_t mavlink_msg_command_ack_get_progress(const mavlink_message_t* msg)
  252. {
  253. return _MAV_RETURN_uint8_t(msg, 3);
  254. }
  255. /**
  256. * @brief Get field result_param2 from command_ack message
  257. *
  258. * @return Additional result information. Can be set with a command-specific enum containing command-specific error reasons for why the command might be denied. If used, the associated enum must be documented in the corresponding MAV_CMD (this enum should have a 0 value to indicate "unused" or "unknown").
  259. */
  260. static inline int32_t mavlink_msg_command_ack_get_result_param2(const mavlink_message_t* msg)
  261. {
  262. return _MAV_RETURN_int32_t(msg, 4);
  263. }
  264. /**
  265. * @brief Get field target_system from command_ack message
  266. *
  267. * @return System ID of the target recipient. This is the ID of the system that sent the command for which this COMMAND_ACK is an acknowledgement.
  268. */
  269. static inline uint8_t mavlink_msg_command_ack_get_target_system(const mavlink_message_t* msg)
  270. {
  271. return _MAV_RETURN_uint8_t(msg, 8);
  272. }
  273. /**
  274. * @brief Get field target_component from command_ack message
  275. *
  276. * @return Component ID of the target recipient. This is the ID of the system that sent the command for which this COMMAND_ACK is an acknowledgement.
  277. */
  278. static inline uint8_t mavlink_msg_command_ack_get_target_component(const mavlink_message_t* msg)
  279. {
  280. return _MAV_RETURN_uint8_t(msg, 9);
  281. }
  282. /**
  283. * @brief Decode a command_ack message into a struct
  284. *
  285. * @param msg The message to decode
  286. * @param command_ack C-struct to decode the message contents into
  287. */
  288. static inline void mavlink_msg_command_ack_decode(const mavlink_message_t* msg, mavlink_command_ack_t* command_ack)
  289. {
  290. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  291. command_ack->command = mavlink_msg_command_ack_get_command(msg);
  292. command_ack->result = mavlink_msg_command_ack_get_result(msg);
  293. command_ack->progress = mavlink_msg_command_ack_get_progress(msg);
  294. command_ack->result_param2 = mavlink_msg_command_ack_get_result_param2(msg);
  295. command_ack->target_system = mavlink_msg_command_ack_get_target_system(msg);
  296. command_ack->target_component = mavlink_msg_command_ack_get_target_component(msg);
  297. #else
  298. uint8_t len = msg->len < MAVLINK_MSG_ID_COMMAND_ACK_LEN? msg->len : MAVLINK_MSG_ID_COMMAND_ACK_LEN;
  299. memset(command_ack, 0, MAVLINK_MSG_ID_COMMAND_ACK_LEN);
  300. memcpy(command_ack, _MAV_PAYLOAD(msg), len);
  301. #endif
  302. }