mavlink_msg_v2_extension.h 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305
  1. #pragma once
  2. // MESSAGE V2_EXTENSION PACKING
  3. #define MAVLINK_MSG_ID_V2_EXTENSION 248
  4. typedef struct __mavlink_v2_extension_t {
  5. uint16_t message_type; /*< A code that identifies the software component that understands this message (analogous to USB device classes or mime type strings). If this code is less than 32768, it is considered a 'registered' protocol extension and the corresponding entry should be added to https://github.com/mavlink/mavlink/definition_files/extension_message_ids.xml. Software creators can register blocks of message IDs as needed (useful for GCS specific metadata, etc...). Message_types greater than 32767 are considered local experiments and should not be checked in to any widely distributed codebase.*/
  6. uint8_t target_network; /*< Network ID (0 for broadcast)*/
  7. uint8_t target_system; /*< System ID (0 for broadcast)*/
  8. uint8_t target_component; /*< Component ID (0 for broadcast)*/
  9. uint8_t payload[249]; /*< Variable length payload. The length must be encoded in the payload as part of the message_type protocol, e.g. by including the length as payload data, or by terminating the payload data with a non-zero marker. This is required in order to reconstruct zero-terminated payloads that are (or otherwise would be) trimmed by MAVLink 2 empty-byte truncation. The entire content of the payload block is opaque unless you understand the encoding message_type. The particular encoding used can be extension specific and might not always be documented as part of the MAVLink specification.*/
  10. } mavlink_v2_extension_t;
  11. #define MAVLINK_MSG_ID_V2_EXTENSION_LEN 254
  12. #define MAVLINK_MSG_ID_V2_EXTENSION_MIN_LEN 254
  13. #define MAVLINK_MSG_ID_248_LEN 254
  14. #define MAVLINK_MSG_ID_248_MIN_LEN 254
  15. #define MAVLINK_MSG_ID_V2_EXTENSION_CRC 8
  16. #define MAVLINK_MSG_ID_248_CRC 8
  17. #define MAVLINK_MSG_V2_EXTENSION_FIELD_PAYLOAD_LEN 249
  18. #if MAVLINK_COMMAND_24BIT
  19. #define MAVLINK_MESSAGE_INFO_V2_EXTENSION { \
  20. 248, \
  21. "V2_EXTENSION", \
  22. 5, \
  23. { { "target_network", NULL, MAVLINK_TYPE_UINT8_T, 0, 2, offsetof(mavlink_v2_extension_t, target_network) }, \
  24. { "target_system", NULL, MAVLINK_TYPE_UINT8_T, 0, 3, offsetof(mavlink_v2_extension_t, target_system) }, \
  25. { "target_component", NULL, MAVLINK_TYPE_UINT8_T, 0, 4, offsetof(mavlink_v2_extension_t, target_component) }, \
  26. { "message_type", NULL, MAVLINK_TYPE_UINT16_T, 0, 0, offsetof(mavlink_v2_extension_t, message_type) }, \
  27. { "payload", NULL, MAVLINK_TYPE_UINT8_T, 249, 5, offsetof(mavlink_v2_extension_t, payload) }, \
  28. } \
  29. }
  30. #else
  31. #define MAVLINK_MESSAGE_INFO_V2_EXTENSION { \
  32. "V2_EXTENSION", \
  33. 5, \
  34. { { "target_network", NULL, MAVLINK_TYPE_UINT8_T, 0, 2, offsetof(mavlink_v2_extension_t, target_network) }, \
  35. { "target_system", NULL, MAVLINK_TYPE_UINT8_T, 0, 3, offsetof(mavlink_v2_extension_t, target_system) }, \
  36. { "target_component", NULL, MAVLINK_TYPE_UINT8_T, 0, 4, offsetof(mavlink_v2_extension_t, target_component) }, \
  37. { "message_type", NULL, MAVLINK_TYPE_UINT16_T, 0, 0, offsetof(mavlink_v2_extension_t, message_type) }, \
  38. { "payload", NULL, MAVLINK_TYPE_UINT8_T, 249, 5, offsetof(mavlink_v2_extension_t, payload) }, \
  39. } \
  40. }
  41. #endif
  42. /**
  43. * @brief Pack a v2_extension message
  44. * @param system_id ID of this system
  45. * @param component_id ID of this component (e.g. 200 for IMU)
  46. * @param msg The MAVLink message to compress the data into
  47. *
  48. * @param target_network Network ID (0 for broadcast)
  49. * @param target_system System ID (0 for broadcast)
  50. * @param target_component Component ID (0 for broadcast)
  51. * @param message_type A code that identifies the software component that understands this message (analogous to USB device classes or mime type strings). If this code is less than 32768, it is considered a 'registered' protocol extension and the corresponding entry should be added to https://github.com/mavlink/mavlink/definition_files/extension_message_ids.xml. Software creators can register blocks of message IDs as needed (useful for GCS specific metadata, etc...). Message_types greater than 32767 are considered local experiments and should not be checked in to any widely distributed codebase.
  52. * @param payload Variable length payload. The length must be encoded in the payload as part of the message_type protocol, e.g. by including the length as payload data, or by terminating the payload data with a non-zero marker. This is required in order to reconstruct zero-terminated payloads that are (or otherwise would be) trimmed by MAVLink 2 empty-byte truncation. The entire content of the payload block is opaque unless you understand the encoding message_type. The particular encoding used can be extension specific and might not always be documented as part of the MAVLink specification.
  53. * @return length of the message in bytes (excluding serial stream start sign)
  54. */
  55. static inline uint16_t mavlink_msg_v2_extension_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
  56. uint8_t target_network, uint8_t target_system, uint8_t target_component, uint16_t message_type, const uint8_t *payload)
  57. {
  58. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  59. char buf[MAVLINK_MSG_ID_V2_EXTENSION_LEN];
  60. _mav_put_uint16_t(buf, 0, message_type);
  61. _mav_put_uint8_t(buf, 2, target_network);
  62. _mav_put_uint8_t(buf, 3, target_system);
  63. _mav_put_uint8_t(buf, 4, target_component);
  64. _mav_put_uint8_t_array(buf, 5, payload, 249);
  65. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_V2_EXTENSION_LEN);
  66. #else
  67. mavlink_v2_extension_t packet;
  68. packet.message_type = message_type;
  69. packet.target_network = target_network;
  70. packet.target_system = target_system;
  71. packet.target_component = target_component;
  72. mav_array_memcpy(packet.payload, payload, sizeof(uint8_t)*249);
  73. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_V2_EXTENSION_LEN);
  74. #endif
  75. msg->msgid = MAVLINK_MSG_ID_V2_EXTENSION;
  76. return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_V2_EXTENSION_MIN_LEN, MAVLINK_MSG_ID_V2_EXTENSION_LEN, MAVLINK_MSG_ID_V2_EXTENSION_CRC);
  77. }
  78. /**
  79. * @brief Pack a v2_extension message on a channel
  80. * @param system_id ID of this system
  81. * @param component_id ID of this component (e.g. 200 for IMU)
  82. * @param chan The MAVLink channel this message will be sent over
  83. * @param msg The MAVLink message to compress the data into
  84. * @param target_network Network ID (0 for broadcast)
  85. * @param target_system System ID (0 for broadcast)
  86. * @param target_component Component ID (0 for broadcast)
  87. * @param message_type A code that identifies the software component that understands this message (analogous to USB device classes or mime type strings). If this code is less than 32768, it is considered a 'registered' protocol extension and the corresponding entry should be added to https://github.com/mavlink/mavlink/definition_files/extension_message_ids.xml. Software creators can register blocks of message IDs as needed (useful for GCS specific metadata, etc...). Message_types greater than 32767 are considered local experiments and should not be checked in to any widely distributed codebase.
  88. * @param payload Variable length payload. The length must be encoded in the payload as part of the message_type protocol, e.g. by including the length as payload data, or by terminating the payload data with a non-zero marker. This is required in order to reconstruct zero-terminated payloads that are (or otherwise would be) trimmed by MAVLink 2 empty-byte truncation. The entire content of the payload block is opaque unless you understand the encoding message_type. The particular encoding used can be extension specific and might not always be documented as part of the MAVLink specification.
  89. * @return length of the message in bytes (excluding serial stream start sign)
  90. */
  91. static inline uint16_t mavlink_msg_v2_extension_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
  92. mavlink_message_t* msg,
  93. uint8_t target_network,uint8_t target_system,uint8_t target_component,uint16_t message_type,const uint8_t *payload)
  94. {
  95. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  96. char buf[MAVLINK_MSG_ID_V2_EXTENSION_LEN];
  97. _mav_put_uint16_t(buf, 0, message_type);
  98. _mav_put_uint8_t(buf, 2, target_network);
  99. _mav_put_uint8_t(buf, 3, target_system);
  100. _mav_put_uint8_t(buf, 4, target_component);
  101. _mav_put_uint8_t_array(buf, 5, payload, 249);
  102. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_V2_EXTENSION_LEN);
  103. #else
  104. mavlink_v2_extension_t packet;
  105. packet.message_type = message_type;
  106. packet.target_network = target_network;
  107. packet.target_system = target_system;
  108. packet.target_component = target_component;
  109. mav_array_memcpy(packet.payload, payload, sizeof(uint8_t)*249);
  110. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_V2_EXTENSION_LEN);
  111. #endif
  112. msg->msgid = MAVLINK_MSG_ID_V2_EXTENSION;
  113. return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_V2_EXTENSION_MIN_LEN, MAVLINK_MSG_ID_V2_EXTENSION_LEN, MAVLINK_MSG_ID_V2_EXTENSION_CRC);
  114. }
  115. /**
  116. * @brief Encode a v2_extension struct
  117. *
  118. * @param system_id ID of this system
  119. * @param component_id ID of this component (e.g. 200 for IMU)
  120. * @param msg The MAVLink message to compress the data into
  121. * @param v2_extension C-struct to read the message contents from
  122. */
  123. static inline uint16_t mavlink_msg_v2_extension_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_v2_extension_t* v2_extension)
  124. {
  125. return mavlink_msg_v2_extension_pack(system_id, component_id, msg, v2_extension->target_network, v2_extension->target_system, v2_extension->target_component, v2_extension->message_type, v2_extension->payload);
  126. }
  127. /**
  128. * @brief Encode a v2_extension struct on a channel
  129. *
  130. * @param system_id ID of this system
  131. * @param component_id ID of this component (e.g. 200 for IMU)
  132. * @param chan The MAVLink channel this message will be sent over
  133. * @param msg The MAVLink message to compress the data into
  134. * @param v2_extension C-struct to read the message contents from
  135. */
  136. static inline uint16_t mavlink_msg_v2_extension_encode_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const mavlink_v2_extension_t* v2_extension)
  137. {
  138. return mavlink_msg_v2_extension_pack_chan(system_id, component_id, chan, msg, v2_extension->target_network, v2_extension->target_system, v2_extension->target_component, v2_extension->message_type, v2_extension->payload);
  139. }
  140. /**
  141. * @brief Send a v2_extension message
  142. * @param chan MAVLink channel to send the message
  143. *
  144. * @param target_network Network ID (0 for broadcast)
  145. * @param target_system System ID (0 for broadcast)
  146. * @param target_component Component ID (0 for broadcast)
  147. * @param message_type A code that identifies the software component that understands this message (analogous to USB device classes or mime type strings). If this code is less than 32768, it is considered a 'registered' protocol extension and the corresponding entry should be added to https://github.com/mavlink/mavlink/definition_files/extension_message_ids.xml. Software creators can register blocks of message IDs as needed (useful for GCS specific metadata, etc...). Message_types greater than 32767 are considered local experiments and should not be checked in to any widely distributed codebase.
  148. * @param payload Variable length payload. The length must be encoded in the payload as part of the message_type protocol, e.g. by including the length as payload data, or by terminating the payload data with a non-zero marker. This is required in order to reconstruct zero-terminated payloads that are (or otherwise would be) trimmed by MAVLink 2 empty-byte truncation. The entire content of the payload block is opaque unless you understand the encoding message_type. The particular encoding used can be extension specific and might not always be documented as part of the MAVLink specification.
  149. */
  150. #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
  151. static inline void mavlink_msg_v2_extension_send(mavlink_channel_t chan, uint8_t target_network, uint8_t target_system, uint8_t target_component, uint16_t message_type, const uint8_t *payload)
  152. {
  153. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  154. char buf[MAVLINK_MSG_ID_V2_EXTENSION_LEN];
  155. _mav_put_uint16_t(buf, 0, message_type);
  156. _mav_put_uint8_t(buf, 2, target_network);
  157. _mav_put_uint8_t(buf, 3, target_system);
  158. _mav_put_uint8_t(buf, 4, target_component);
  159. _mav_put_uint8_t_array(buf, 5, payload, 249);
  160. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_V2_EXTENSION, buf, MAVLINK_MSG_ID_V2_EXTENSION_MIN_LEN, MAVLINK_MSG_ID_V2_EXTENSION_LEN, MAVLINK_MSG_ID_V2_EXTENSION_CRC);
  161. #else
  162. mavlink_v2_extension_t packet;
  163. packet.message_type = message_type;
  164. packet.target_network = target_network;
  165. packet.target_system = target_system;
  166. packet.target_component = target_component;
  167. mav_array_memcpy(packet.payload, payload, sizeof(uint8_t)*249);
  168. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_V2_EXTENSION, (const char *)&packet, MAVLINK_MSG_ID_V2_EXTENSION_MIN_LEN, MAVLINK_MSG_ID_V2_EXTENSION_LEN, MAVLINK_MSG_ID_V2_EXTENSION_CRC);
  169. #endif
  170. }
  171. /**
  172. * @brief Send a v2_extension message
  173. * @param chan MAVLink channel to send the message
  174. * @param struct The MAVLink struct to serialize
  175. */
  176. static inline void mavlink_msg_v2_extension_send_struct(mavlink_channel_t chan, const mavlink_v2_extension_t* v2_extension)
  177. {
  178. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  179. mavlink_msg_v2_extension_send(chan, v2_extension->target_network, v2_extension->target_system, v2_extension->target_component, v2_extension->message_type, v2_extension->payload);
  180. #else
  181. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_V2_EXTENSION, (const char *)v2_extension, MAVLINK_MSG_ID_V2_EXTENSION_MIN_LEN, MAVLINK_MSG_ID_V2_EXTENSION_LEN, MAVLINK_MSG_ID_V2_EXTENSION_CRC);
  182. #endif
  183. }
  184. #if MAVLINK_MSG_ID_V2_EXTENSION_LEN <= MAVLINK_MAX_PAYLOAD_LEN
  185. /*
  186. This variant of _send() can be used to save stack space by re-using
  187. memory from the receive buffer. The caller provides a
  188. mavlink_message_t which is the size of a full mavlink message. This
  189. is usually the receive buffer for the channel, and allows a reply to an
  190. incoming message with minimum stack space usage.
  191. */
  192. static inline void mavlink_msg_v2_extension_send_buf(mavlink_message_t *msgbuf, mavlink_channel_t chan, uint8_t target_network, uint8_t target_system, uint8_t target_component, uint16_t message_type, const uint8_t *payload)
  193. {
  194. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  195. char *buf = (char *)msgbuf;
  196. _mav_put_uint16_t(buf, 0, message_type);
  197. _mav_put_uint8_t(buf, 2, target_network);
  198. _mav_put_uint8_t(buf, 3, target_system);
  199. _mav_put_uint8_t(buf, 4, target_component);
  200. _mav_put_uint8_t_array(buf, 5, payload, 249);
  201. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_V2_EXTENSION, buf, MAVLINK_MSG_ID_V2_EXTENSION_MIN_LEN, MAVLINK_MSG_ID_V2_EXTENSION_LEN, MAVLINK_MSG_ID_V2_EXTENSION_CRC);
  202. #else
  203. mavlink_v2_extension_t *packet = (mavlink_v2_extension_t *)msgbuf;
  204. packet->message_type = message_type;
  205. packet->target_network = target_network;
  206. packet->target_system = target_system;
  207. packet->target_component = target_component;
  208. mav_array_memcpy(packet->payload, payload, sizeof(uint8_t)*249);
  209. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_V2_EXTENSION, (const char *)packet, MAVLINK_MSG_ID_V2_EXTENSION_MIN_LEN, MAVLINK_MSG_ID_V2_EXTENSION_LEN, MAVLINK_MSG_ID_V2_EXTENSION_CRC);
  210. #endif
  211. }
  212. #endif
  213. #endif
  214. // MESSAGE V2_EXTENSION UNPACKING
  215. /**
  216. * @brief Get field target_network from v2_extension message
  217. *
  218. * @return Network ID (0 for broadcast)
  219. */
  220. static inline uint8_t mavlink_msg_v2_extension_get_target_network(const mavlink_message_t* msg)
  221. {
  222. return _MAV_RETURN_uint8_t(msg, 2);
  223. }
  224. /**
  225. * @brief Get field target_system from v2_extension message
  226. *
  227. * @return System ID (0 for broadcast)
  228. */
  229. static inline uint8_t mavlink_msg_v2_extension_get_target_system(const mavlink_message_t* msg)
  230. {
  231. return _MAV_RETURN_uint8_t(msg, 3);
  232. }
  233. /**
  234. * @brief Get field target_component from v2_extension message
  235. *
  236. * @return Component ID (0 for broadcast)
  237. */
  238. static inline uint8_t mavlink_msg_v2_extension_get_target_component(const mavlink_message_t* msg)
  239. {
  240. return _MAV_RETURN_uint8_t(msg, 4);
  241. }
  242. /**
  243. * @brief Get field message_type from v2_extension message
  244. *
  245. * @return A code that identifies the software component that understands this message (analogous to USB device classes or mime type strings). If this code is less than 32768, it is considered a 'registered' protocol extension and the corresponding entry should be added to https://github.com/mavlink/mavlink/definition_files/extension_message_ids.xml. Software creators can register blocks of message IDs as needed (useful for GCS specific metadata, etc...). Message_types greater than 32767 are considered local experiments and should not be checked in to any widely distributed codebase.
  246. */
  247. static inline uint16_t mavlink_msg_v2_extension_get_message_type(const mavlink_message_t* msg)
  248. {
  249. return _MAV_RETURN_uint16_t(msg, 0);
  250. }
  251. /**
  252. * @brief Get field payload from v2_extension message
  253. *
  254. * @return Variable length payload. The length must be encoded in the payload as part of the message_type protocol, e.g. by including the length as payload data, or by terminating the payload data with a non-zero marker. This is required in order to reconstruct zero-terminated payloads that are (or otherwise would be) trimmed by MAVLink 2 empty-byte truncation. The entire content of the payload block is opaque unless you understand the encoding message_type. The particular encoding used can be extension specific and might not always be documented as part of the MAVLink specification.
  255. */
  256. static inline uint16_t mavlink_msg_v2_extension_get_payload(const mavlink_message_t* msg, uint8_t *payload)
  257. {
  258. return _MAV_RETURN_uint8_t_array(msg, payload, 249, 5);
  259. }
  260. /**
  261. * @brief Decode a v2_extension message into a struct
  262. *
  263. * @param msg The message to decode
  264. * @param v2_extension C-struct to decode the message contents into
  265. */
  266. static inline void mavlink_msg_v2_extension_decode(const mavlink_message_t* msg, mavlink_v2_extension_t* v2_extension)
  267. {
  268. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  269. v2_extension->message_type = mavlink_msg_v2_extension_get_message_type(msg);
  270. v2_extension->target_network = mavlink_msg_v2_extension_get_target_network(msg);
  271. v2_extension->target_system = mavlink_msg_v2_extension_get_target_system(msg);
  272. v2_extension->target_component = mavlink_msg_v2_extension_get_target_component(msg);
  273. mavlink_msg_v2_extension_get_payload(msg, v2_extension->payload);
  274. #else
  275. uint8_t len = msg->len < MAVLINK_MSG_ID_V2_EXTENSION_LEN? msg->len : MAVLINK_MSG_ID_V2_EXTENSION_LEN;
  276. memset(v2_extension, 0, MAVLINK_MSG_ID_V2_EXTENSION_LEN);
  277. memcpy(v2_extension, _MAV_PAYLOAD(msg), len);
  278. #endif
  279. }