mavlink_msg_encapsulated_data.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278
  1. #pragma once
  2. // MESSAGE ENCAPSULATED_DATA PACKING
  3. #define MAVLINK_MSG_ID_ENCAPSULATED_DATA 131
  4. typedef struct __mavlink_encapsulated_data_t {
  5. uint16_t seqnr; /*< sequence number (starting with 0 on every transmission)*/
  6. uint8_t data[253]; /*< image data bytes*/
  7. } mavlink_encapsulated_data_t;
  8. #define MAVLINK_MSG_ID_ENCAPSULATED_DATA_LEN 255
  9. #define MAVLINK_MSG_ID_ENCAPSULATED_DATA_MIN_LEN 255
  10. #define MAVLINK_MSG_ID_131_LEN 255
  11. #define MAVLINK_MSG_ID_131_MIN_LEN 255
  12. #define MAVLINK_MSG_ID_ENCAPSULATED_DATA_CRC 223
  13. #define MAVLINK_MSG_ID_131_CRC 223
  14. #define MAVLINK_MSG_ENCAPSULATED_DATA_FIELD_DATA_LEN 253
  15. #if MAVLINK_COMMAND_24BIT
  16. #define MAVLINK_MESSAGE_INFO_ENCAPSULATED_DATA { \
  17. 131, \
  18. "ENCAPSULATED_DATA", \
  19. 2, \
  20. { { "seqnr", NULL, MAVLINK_TYPE_UINT16_T, 0, 0, offsetof(mavlink_encapsulated_data_t, seqnr) }, \
  21. { "data", NULL, MAVLINK_TYPE_UINT8_T, 253, 2, offsetof(mavlink_encapsulated_data_t, data) }, \
  22. } \
  23. }
  24. #else
  25. #define MAVLINK_MESSAGE_INFO_ENCAPSULATED_DATA { \
  26. "ENCAPSULATED_DATA", \
  27. 2, \
  28. { { "seqnr", NULL, MAVLINK_TYPE_UINT16_T, 0, 0, offsetof(mavlink_encapsulated_data_t, seqnr) }, \
  29. { "data", NULL, MAVLINK_TYPE_UINT8_T, 253, 2, offsetof(mavlink_encapsulated_data_t, data) }, \
  30. } \
  31. }
  32. #endif
  33. /**
  34. * @brief Pack a encapsulated_data message
  35. * @param system_id ID of this system
  36. * @param component_id ID of this component (e.g. 200 for IMU)
  37. * @param msg The MAVLink message to compress the data into
  38. *
  39. * @param seqnr sequence number (starting with 0 on every transmission)
  40. * @param data image data bytes
  41. * @return length of the message in bytes (excluding serial stream start sign)
  42. */
  43. static inline uint16_t mavlink_msg_encapsulated_data_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
  44. uint16_t seqnr, const uint8_t *data)
  45. {
  46. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  47. char buf[MAVLINK_MSG_ID_ENCAPSULATED_DATA_LEN];
  48. _mav_put_uint16_t(buf, 0, seqnr);
  49. _mav_put_uint8_t_array(buf, 2, data, 253);
  50. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_ENCAPSULATED_DATA_LEN);
  51. #else
  52. mavlink_encapsulated_data_t packet;
  53. packet.seqnr = seqnr;
  54. mav_array_memcpy(packet.data, data, sizeof(uint8_t)*253);
  55. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_ENCAPSULATED_DATA_LEN);
  56. #endif
  57. msg->msgid = MAVLINK_MSG_ID_ENCAPSULATED_DATA;
  58. return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_ENCAPSULATED_DATA_MIN_LEN, MAVLINK_MSG_ID_ENCAPSULATED_DATA_LEN, MAVLINK_MSG_ID_ENCAPSULATED_DATA_CRC);
  59. }
  60. /**
  61. * @brief Pack a encapsulated_data message
  62. * @param system_id ID of this system
  63. * @param component_id ID of this component (e.g. 200 for IMU)
  64. * @param status MAVLink status structure
  65. * @param msg The MAVLink message to compress the data into
  66. *
  67. * @param seqnr sequence number (starting with 0 on every transmission)
  68. * @param data image data bytes
  69. * @return length of the message in bytes (excluding serial stream start sign)
  70. */
  71. static inline uint16_t mavlink_msg_encapsulated_data_pack_status(uint8_t system_id, uint8_t component_id, mavlink_status_t *_status, mavlink_message_t* msg,
  72. uint16_t seqnr, const uint8_t *data)
  73. {
  74. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  75. char buf[MAVLINK_MSG_ID_ENCAPSULATED_DATA_LEN];
  76. _mav_put_uint16_t(buf, 0, seqnr);
  77. _mav_put_uint8_t_array(buf, 2, data, 253);
  78. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_ENCAPSULATED_DATA_LEN);
  79. #else
  80. mavlink_encapsulated_data_t packet;
  81. packet.seqnr = seqnr;
  82. mav_array_memcpy(packet.data, data, sizeof(uint8_t)*253);
  83. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_ENCAPSULATED_DATA_LEN);
  84. #endif
  85. msg->msgid = MAVLINK_MSG_ID_ENCAPSULATED_DATA;
  86. #if MAVLINK_CRC_EXTRA
  87. return mavlink_finalize_message_buffer(msg, system_id, component_id, _status, MAVLINK_MSG_ID_ENCAPSULATED_DATA_MIN_LEN, MAVLINK_MSG_ID_ENCAPSULATED_DATA_LEN, MAVLINK_MSG_ID_ENCAPSULATED_DATA_CRC);
  88. #else
  89. return mavlink_finalize_message_buffer(msg, system_id, component_id, _status, MAVLINK_MSG_ID_ENCAPSULATED_DATA_MIN_LEN, MAVLINK_MSG_ID_ENCAPSULATED_DATA_LEN);
  90. #endif
  91. }
  92. /**
  93. * @brief Pack a encapsulated_data message on a channel
  94. * @param system_id ID of this system
  95. * @param component_id ID of this component (e.g. 200 for IMU)
  96. * @param chan The MAVLink channel this message will be sent over
  97. * @param msg The MAVLink message to compress the data into
  98. * @param seqnr sequence number (starting with 0 on every transmission)
  99. * @param data image data bytes
  100. * @return length of the message in bytes (excluding serial stream start sign)
  101. */
  102. static inline uint16_t mavlink_msg_encapsulated_data_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
  103. mavlink_message_t* msg,
  104. uint16_t seqnr,const uint8_t *data)
  105. {
  106. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  107. char buf[MAVLINK_MSG_ID_ENCAPSULATED_DATA_LEN];
  108. _mav_put_uint16_t(buf, 0, seqnr);
  109. _mav_put_uint8_t_array(buf, 2, data, 253);
  110. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_ENCAPSULATED_DATA_LEN);
  111. #else
  112. mavlink_encapsulated_data_t packet;
  113. packet.seqnr = seqnr;
  114. mav_array_memcpy(packet.data, data, sizeof(uint8_t)*253);
  115. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_ENCAPSULATED_DATA_LEN);
  116. #endif
  117. msg->msgid = MAVLINK_MSG_ID_ENCAPSULATED_DATA;
  118. return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_ENCAPSULATED_DATA_MIN_LEN, MAVLINK_MSG_ID_ENCAPSULATED_DATA_LEN, MAVLINK_MSG_ID_ENCAPSULATED_DATA_CRC);
  119. }
  120. /**
  121. * @brief Encode a encapsulated_data struct
  122. *
  123. * @param system_id ID of this system
  124. * @param component_id ID of this component (e.g. 200 for IMU)
  125. * @param msg The MAVLink message to compress the data into
  126. * @param encapsulated_data C-struct to read the message contents from
  127. */
  128. static inline uint16_t mavlink_msg_encapsulated_data_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_encapsulated_data_t* encapsulated_data)
  129. {
  130. return mavlink_msg_encapsulated_data_pack(system_id, component_id, msg, encapsulated_data->seqnr, encapsulated_data->data);
  131. }
  132. /**
  133. * @brief Encode a encapsulated_data struct on a channel
  134. *
  135. * @param system_id ID of this system
  136. * @param component_id ID of this component (e.g. 200 for IMU)
  137. * @param chan The MAVLink channel this message will be sent over
  138. * @param msg The MAVLink message to compress the data into
  139. * @param encapsulated_data C-struct to read the message contents from
  140. */
  141. static inline uint16_t mavlink_msg_encapsulated_data_encode_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const mavlink_encapsulated_data_t* encapsulated_data)
  142. {
  143. return mavlink_msg_encapsulated_data_pack_chan(system_id, component_id, chan, msg, encapsulated_data->seqnr, encapsulated_data->data);
  144. }
  145. /**
  146. * @brief Encode a encapsulated_data struct with provided status structure
  147. *
  148. * @param system_id ID of this system
  149. * @param component_id ID of this component (e.g. 200 for IMU)
  150. * @param status MAVLink status structure
  151. * @param msg The MAVLink message to compress the data into
  152. * @param encapsulated_data C-struct to read the message contents from
  153. */
  154. static inline uint16_t mavlink_msg_encapsulated_data_encode_status(uint8_t system_id, uint8_t component_id, mavlink_status_t* _status, mavlink_message_t* msg, const mavlink_encapsulated_data_t* encapsulated_data)
  155. {
  156. return mavlink_msg_encapsulated_data_pack_status(system_id, component_id, _status, msg, encapsulated_data->seqnr, encapsulated_data->data);
  157. }
  158. /**
  159. * @brief Send a encapsulated_data message
  160. * @param chan MAVLink channel to send the message
  161. *
  162. * @param seqnr sequence number (starting with 0 on every transmission)
  163. * @param data image data bytes
  164. */
  165. #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
  166. static inline void mavlink_msg_encapsulated_data_send(mavlink_channel_t chan, uint16_t seqnr, const uint8_t *data)
  167. {
  168. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  169. char buf[MAVLINK_MSG_ID_ENCAPSULATED_DATA_LEN];
  170. _mav_put_uint16_t(buf, 0, seqnr);
  171. _mav_put_uint8_t_array(buf, 2, data, 253);
  172. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_ENCAPSULATED_DATA, buf, MAVLINK_MSG_ID_ENCAPSULATED_DATA_MIN_LEN, MAVLINK_MSG_ID_ENCAPSULATED_DATA_LEN, MAVLINK_MSG_ID_ENCAPSULATED_DATA_CRC);
  173. #else
  174. mavlink_encapsulated_data_t packet;
  175. packet.seqnr = seqnr;
  176. mav_array_memcpy(packet.data, data, sizeof(uint8_t)*253);
  177. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_ENCAPSULATED_DATA, (const char *)&packet, MAVLINK_MSG_ID_ENCAPSULATED_DATA_MIN_LEN, MAVLINK_MSG_ID_ENCAPSULATED_DATA_LEN, MAVLINK_MSG_ID_ENCAPSULATED_DATA_CRC);
  178. #endif
  179. }
  180. /**
  181. * @brief Send a encapsulated_data message
  182. * @param chan MAVLink channel to send the message
  183. * @param struct The MAVLink struct to serialize
  184. */
  185. static inline void mavlink_msg_encapsulated_data_send_struct(mavlink_channel_t chan, const mavlink_encapsulated_data_t* encapsulated_data)
  186. {
  187. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  188. mavlink_msg_encapsulated_data_send(chan, encapsulated_data->seqnr, encapsulated_data->data);
  189. #else
  190. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_ENCAPSULATED_DATA, (const char *)encapsulated_data, MAVLINK_MSG_ID_ENCAPSULATED_DATA_MIN_LEN, MAVLINK_MSG_ID_ENCAPSULATED_DATA_LEN, MAVLINK_MSG_ID_ENCAPSULATED_DATA_CRC);
  191. #endif
  192. }
  193. #if MAVLINK_MSG_ID_ENCAPSULATED_DATA_LEN <= MAVLINK_MAX_PAYLOAD_LEN
  194. /*
  195. This variant of _send() can be used to save stack space by re-using
  196. memory from the receive buffer. The caller provides a
  197. mavlink_message_t which is the size of a full mavlink message. This
  198. is usually the receive buffer for the channel, and allows a reply to an
  199. incoming message with minimum stack space usage.
  200. */
  201. static inline void mavlink_msg_encapsulated_data_send_buf(mavlink_message_t *msgbuf, mavlink_channel_t chan, uint16_t seqnr, const uint8_t *data)
  202. {
  203. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  204. char *buf = (char *)msgbuf;
  205. _mav_put_uint16_t(buf, 0, seqnr);
  206. _mav_put_uint8_t_array(buf, 2, data, 253);
  207. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_ENCAPSULATED_DATA, buf, MAVLINK_MSG_ID_ENCAPSULATED_DATA_MIN_LEN, MAVLINK_MSG_ID_ENCAPSULATED_DATA_LEN, MAVLINK_MSG_ID_ENCAPSULATED_DATA_CRC);
  208. #else
  209. mavlink_encapsulated_data_t *packet = (mavlink_encapsulated_data_t *)msgbuf;
  210. packet->seqnr = seqnr;
  211. mav_array_memcpy(packet->data, data, sizeof(uint8_t)*253);
  212. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_ENCAPSULATED_DATA, (const char *)packet, MAVLINK_MSG_ID_ENCAPSULATED_DATA_MIN_LEN, MAVLINK_MSG_ID_ENCAPSULATED_DATA_LEN, MAVLINK_MSG_ID_ENCAPSULATED_DATA_CRC);
  213. #endif
  214. }
  215. #endif
  216. #endif
  217. // MESSAGE ENCAPSULATED_DATA UNPACKING
  218. /**
  219. * @brief Get field seqnr from encapsulated_data message
  220. *
  221. * @return sequence number (starting with 0 on every transmission)
  222. */
  223. static inline uint16_t mavlink_msg_encapsulated_data_get_seqnr(const mavlink_message_t* msg)
  224. {
  225. return _MAV_RETURN_uint16_t(msg, 0);
  226. }
  227. /**
  228. * @brief Get field data from encapsulated_data message
  229. *
  230. * @return image data bytes
  231. */
  232. static inline uint16_t mavlink_msg_encapsulated_data_get_data(const mavlink_message_t* msg, uint8_t *data)
  233. {
  234. return _MAV_RETURN_uint8_t_array(msg, data, 253, 2);
  235. }
  236. /**
  237. * @brief Decode a encapsulated_data message into a struct
  238. *
  239. * @param msg The message to decode
  240. * @param encapsulated_data C-struct to decode the message contents into
  241. */
  242. static inline void mavlink_msg_encapsulated_data_decode(const mavlink_message_t* msg, mavlink_encapsulated_data_t* encapsulated_data)
  243. {
  244. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  245. encapsulated_data->seqnr = mavlink_msg_encapsulated_data_get_seqnr(msg);
  246. mavlink_msg_encapsulated_data_get_data(msg, encapsulated_data->data);
  247. #else
  248. uint8_t len = msg->len < MAVLINK_MSG_ID_ENCAPSULATED_DATA_LEN? msg->len : MAVLINK_MSG_ID_ENCAPSULATED_DATA_LEN;
  249. memset(encapsulated_data, 0, MAVLINK_MSG_ID_ENCAPSULATED_DATA_LEN);
  250. memcpy(encapsulated_data, _MAV_PAYLOAD(msg), len);
  251. #endif
  252. }