mavlink_msg_command_cancel.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263
  1. #pragma once
  2. // MESSAGE COMMAND_CANCEL PACKING
  3. #define MAVLINK_MSG_ID_COMMAND_CANCEL 80
  4. typedef struct __mavlink_command_cancel_t {
  5. uint16_t command; /*< Command ID (of command to cancel).*/
  6. uint8_t target_system; /*< System executing long running command. Should not be broadcast (0).*/
  7. uint8_t target_component; /*< Component executing long running command.*/
  8. } mavlink_command_cancel_t;
  9. #define MAVLINK_MSG_ID_COMMAND_CANCEL_LEN 4
  10. #define MAVLINK_MSG_ID_COMMAND_CANCEL_MIN_LEN 4
  11. #define MAVLINK_MSG_ID_80_LEN 4
  12. #define MAVLINK_MSG_ID_80_MIN_LEN 4
  13. #define MAVLINK_MSG_ID_COMMAND_CANCEL_CRC 14
  14. #define MAVLINK_MSG_ID_80_CRC 14
  15. #if MAVLINK_COMMAND_24BIT
  16. #define MAVLINK_MESSAGE_INFO_COMMAND_CANCEL { \
  17. 80, \
  18. "COMMAND_CANCEL", \
  19. 3, \
  20. { { "target_system", NULL, MAVLINK_TYPE_UINT8_T, 0, 2, offsetof(mavlink_command_cancel_t, target_system) }, \
  21. { "target_component", NULL, MAVLINK_TYPE_UINT8_T, 0, 3, offsetof(mavlink_command_cancel_t, target_component) }, \
  22. { "command", NULL, MAVLINK_TYPE_UINT16_T, 0, 0, offsetof(mavlink_command_cancel_t, command) }, \
  23. } \
  24. }
  25. #else
  26. #define MAVLINK_MESSAGE_INFO_COMMAND_CANCEL { \
  27. "COMMAND_CANCEL", \
  28. 3, \
  29. { { "target_system", NULL, MAVLINK_TYPE_UINT8_T, 0, 2, offsetof(mavlink_command_cancel_t, target_system) }, \
  30. { "target_component", NULL, MAVLINK_TYPE_UINT8_T, 0, 3, offsetof(mavlink_command_cancel_t, target_component) }, \
  31. { "command", NULL, MAVLINK_TYPE_UINT16_T, 0, 0, offsetof(mavlink_command_cancel_t, command) }, \
  32. } \
  33. }
  34. #endif
  35. /**
  36. * @brief Pack a command_cancel message
  37. * @param system_id ID of this system
  38. * @param component_id ID of this component (e.g. 200 for IMU)
  39. * @param msg The MAVLink message to compress the data into
  40. *
  41. * @param target_system System executing long running command. Should not be broadcast (0).
  42. * @param target_component Component executing long running command.
  43. * @param command Command ID (of command to cancel).
  44. * @return length of the message in bytes (excluding serial stream start sign)
  45. */
  46. static inline uint16_t mavlink_msg_command_cancel_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
  47. uint8_t target_system, uint8_t target_component, uint16_t command)
  48. {
  49. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  50. char buf[MAVLINK_MSG_ID_COMMAND_CANCEL_LEN];
  51. _mav_put_uint16_t(buf, 0, command);
  52. _mav_put_uint8_t(buf, 2, target_system);
  53. _mav_put_uint8_t(buf, 3, target_component);
  54. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_COMMAND_CANCEL_LEN);
  55. #else
  56. mavlink_command_cancel_t packet;
  57. packet.command = command;
  58. packet.target_system = target_system;
  59. packet.target_component = target_component;
  60. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_COMMAND_CANCEL_LEN);
  61. #endif
  62. msg->msgid = MAVLINK_MSG_ID_COMMAND_CANCEL;
  63. return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_COMMAND_CANCEL_MIN_LEN, MAVLINK_MSG_ID_COMMAND_CANCEL_LEN, MAVLINK_MSG_ID_COMMAND_CANCEL_CRC);
  64. }
  65. /**
  66. * @brief Pack a command_cancel message on a channel
  67. * @param system_id ID of this system
  68. * @param component_id ID of this component (e.g. 200 for IMU)
  69. * @param chan The MAVLink channel this message will be sent over
  70. * @param msg The MAVLink message to compress the data into
  71. * @param target_system System executing long running command. Should not be broadcast (0).
  72. * @param target_component Component executing long running command.
  73. * @param command Command ID (of command to cancel).
  74. * @return length of the message in bytes (excluding serial stream start sign)
  75. */
  76. static inline uint16_t mavlink_msg_command_cancel_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
  77. mavlink_message_t* msg,
  78. uint8_t target_system,uint8_t target_component,uint16_t command)
  79. {
  80. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  81. char buf[MAVLINK_MSG_ID_COMMAND_CANCEL_LEN];
  82. _mav_put_uint16_t(buf, 0, command);
  83. _mav_put_uint8_t(buf, 2, target_system);
  84. _mav_put_uint8_t(buf, 3, target_component);
  85. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_COMMAND_CANCEL_LEN);
  86. #else
  87. mavlink_command_cancel_t packet;
  88. packet.command = command;
  89. packet.target_system = target_system;
  90. packet.target_component = target_component;
  91. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_COMMAND_CANCEL_LEN);
  92. #endif
  93. msg->msgid = MAVLINK_MSG_ID_COMMAND_CANCEL;
  94. return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_COMMAND_CANCEL_MIN_LEN, MAVLINK_MSG_ID_COMMAND_CANCEL_LEN, MAVLINK_MSG_ID_COMMAND_CANCEL_CRC);
  95. }
  96. /**
  97. * @brief Encode a command_cancel struct
  98. *
  99. * @param system_id ID of this system
  100. * @param component_id ID of this component (e.g. 200 for IMU)
  101. * @param msg The MAVLink message to compress the data into
  102. * @param command_cancel C-struct to read the message contents from
  103. */
  104. static inline uint16_t mavlink_msg_command_cancel_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_command_cancel_t* command_cancel)
  105. {
  106. return mavlink_msg_command_cancel_pack(system_id, component_id, msg, command_cancel->target_system, command_cancel->target_component, command_cancel->command);
  107. }
  108. /**
  109. * @brief Encode a command_cancel struct on a channel
  110. *
  111. * @param system_id ID of this system
  112. * @param component_id ID of this component (e.g. 200 for IMU)
  113. * @param chan The MAVLink channel this message will be sent over
  114. * @param msg The MAVLink message to compress the data into
  115. * @param command_cancel C-struct to read the message contents from
  116. */
  117. static inline uint16_t mavlink_msg_command_cancel_encode_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const mavlink_command_cancel_t* command_cancel)
  118. {
  119. return mavlink_msg_command_cancel_pack_chan(system_id, component_id, chan, msg, command_cancel->target_system, command_cancel->target_component, command_cancel->command);
  120. }
  121. /**
  122. * @brief Send a command_cancel message
  123. * @param chan MAVLink channel to send the message
  124. *
  125. * @param target_system System executing long running command. Should not be broadcast (0).
  126. * @param target_component Component executing long running command.
  127. * @param command Command ID (of command to cancel).
  128. */
  129. #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
  130. static inline void mavlink_msg_command_cancel_send(mavlink_channel_t chan, uint8_t target_system, uint8_t target_component, uint16_t command)
  131. {
  132. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  133. char buf[MAVLINK_MSG_ID_COMMAND_CANCEL_LEN];
  134. _mav_put_uint16_t(buf, 0, command);
  135. _mav_put_uint8_t(buf, 2, target_system);
  136. _mav_put_uint8_t(buf, 3, target_component);
  137. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_COMMAND_CANCEL, buf, MAVLINK_MSG_ID_COMMAND_CANCEL_MIN_LEN, MAVLINK_MSG_ID_COMMAND_CANCEL_LEN, MAVLINK_MSG_ID_COMMAND_CANCEL_CRC);
  138. #else
  139. mavlink_command_cancel_t packet;
  140. packet.command = command;
  141. packet.target_system = target_system;
  142. packet.target_component = target_component;
  143. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_COMMAND_CANCEL, (const char *)&packet, MAVLINK_MSG_ID_COMMAND_CANCEL_MIN_LEN, MAVLINK_MSG_ID_COMMAND_CANCEL_LEN, MAVLINK_MSG_ID_COMMAND_CANCEL_CRC);
  144. #endif
  145. }
  146. /**
  147. * @brief Send a command_cancel message
  148. * @param chan MAVLink channel to send the message
  149. * @param struct The MAVLink struct to serialize
  150. */
  151. static inline void mavlink_msg_command_cancel_send_struct(mavlink_channel_t chan, const mavlink_command_cancel_t* command_cancel)
  152. {
  153. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  154. mavlink_msg_command_cancel_send(chan, command_cancel->target_system, command_cancel->target_component, command_cancel->command);
  155. #else
  156. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_COMMAND_CANCEL, (const char *)command_cancel, MAVLINK_MSG_ID_COMMAND_CANCEL_MIN_LEN, MAVLINK_MSG_ID_COMMAND_CANCEL_LEN, MAVLINK_MSG_ID_COMMAND_CANCEL_CRC);
  157. #endif
  158. }
  159. #if MAVLINK_MSG_ID_COMMAND_CANCEL_LEN <= MAVLINK_MAX_PAYLOAD_LEN
  160. /*
  161. This variant of _send() can be used to save stack space by re-using
  162. memory from the receive buffer. The caller provides a
  163. mavlink_message_t which is the size of a full mavlink message. This
  164. is usually the receive buffer for the channel, and allows a reply to an
  165. incoming message with minimum stack space usage.
  166. */
  167. static inline void mavlink_msg_command_cancel_send_buf(mavlink_message_t *msgbuf, mavlink_channel_t chan, uint8_t target_system, uint8_t target_component, uint16_t command)
  168. {
  169. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  170. char *buf = (char *)msgbuf;
  171. _mav_put_uint16_t(buf, 0, command);
  172. _mav_put_uint8_t(buf, 2, target_system);
  173. _mav_put_uint8_t(buf, 3, target_component);
  174. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_COMMAND_CANCEL, buf, MAVLINK_MSG_ID_COMMAND_CANCEL_MIN_LEN, MAVLINK_MSG_ID_COMMAND_CANCEL_LEN, MAVLINK_MSG_ID_COMMAND_CANCEL_CRC);
  175. #else
  176. mavlink_command_cancel_t *packet = (mavlink_command_cancel_t *)msgbuf;
  177. packet->command = command;
  178. packet->target_system = target_system;
  179. packet->target_component = target_component;
  180. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_COMMAND_CANCEL, (const char *)packet, MAVLINK_MSG_ID_COMMAND_CANCEL_MIN_LEN, MAVLINK_MSG_ID_COMMAND_CANCEL_LEN, MAVLINK_MSG_ID_COMMAND_CANCEL_CRC);
  181. #endif
  182. }
  183. #endif
  184. #endif
  185. // MESSAGE COMMAND_CANCEL UNPACKING
  186. /**
  187. * @brief Get field target_system from command_cancel message
  188. *
  189. * @return System executing long running command. Should not be broadcast (0).
  190. */
  191. static inline uint8_t mavlink_msg_command_cancel_get_target_system(const mavlink_message_t* msg)
  192. {
  193. return _MAV_RETURN_uint8_t(msg, 2);
  194. }
  195. /**
  196. * @brief Get field target_component from command_cancel message
  197. *
  198. * @return Component executing long running command.
  199. */
  200. static inline uint8_t mavlink_msg_command_cancel_get_target_component(const mavlink_message_t* msg)
  201. {
  202. return _MAV_RETURN_uint8_t(msg, 3);
  203. }
  204. /**
  205. * @brief Get field command from command_cancel message
  206. *
  207. * @return Command ID (of command to cancel).
  208. */
  209. static inline uint16_t mavlink_msg_command_cancel_get_command(const mavlink_message_t* msg)
  210. {
  211. return _MAV_RETURN_uint16_t(msg, 0);
  212. }
  213. /**
  214. * @brief Decode a command_cancel message into a struct
  215. *
  216. * @param msg The message to decode
  217. * @param command_cancel C-struct to decode the message contents into
  218. */
  219. static inline void mavlink_msg_command_cancel_decode(const mavlink_message_t* msg, mavlink_command_cancel_t* command_cancel)
  220. {
  221. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  222. command_cancel->command = mavlink_msg_command_cancel_get_command(msg);
  223. command_cancel->target_system = mavlink_msg_command_cancel_get_target_system(msg);
  224. command_cancel->target_component = mavlink_msg_command_cancel_get_target_component(msg);
  225. #else
  226. uint8_t len = msg->len < MAVLINK_MSG_ID_COMMAND_CANCEL_LEN? msg->len : MAVLINK_MSG_ID_COMMAND_CANCEL_LEN;
  227. memset(command_cancel, 0, MAVLINK_MSG_ID_COMMAND_CANCEL_LEN);
  228. memcpy(command_cancel, _MAV_PAYLOAD(msg), len);
  229. #endif
  230. }