/Modules/MAVLink/common/mavlink_msg_encapsulated_data.h

https://gitlab.com/krucios/Astraeus_FW · C Header · 229 lines · 133 code · 22 blank · 74 comment · 6 complexity · cddd030882005564416819919b53625e MD5 · raw file

  1. // MESSAGE ENCAPSULATED_DATA PACKING
  2. #define MAVLINK_MSG_ID_ENCAPSULATED_DATA 131
  3. MAVPACKED(
  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 on a channel
  62. * @param system_id ID of this system
  63. * @param component_id ID of this component (e.g. 200 for IMU)
  64. * @param chan The MAVLink channel this message will be sent over
  65. * @param msg The MAVLink message to compress the data into
  66. * @param seqnr sequence number (starting with 0 on every transmission)
  67. * @param data image data bytes
  68. * @return length of the message in bytes (excluding serial stream start sign)
  69. */
  70. static inline uint16_t mavlink_msg_encapsulated_data_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
  71. 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. 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);
  87. }
  88. /**
  89. * @brief Encode a encapsulated_data struct
  90. *
  91. * @param system_id ID of this system
  92. * @param component_id ID of this component (e.g. 200 for IMU)
  93. * @param msg The MAVLink message to compress the data into
  94. * @param encapsulated_data C-struct to read the message contents from
  95. */
  96. 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)
  97. {
  98. return mavlink_msg_encapsulated_data_pack(system_id, component_id, msg, encapsulated_data->seqnr, encapsulated_data->data);
  99. }
  100. /**
  101. * @brief Encode a encapsulated_data struct on a channel
  102. *
  103. * @param system_id ID of this system
  104. * @param component_id ID of this component (e.g. 200 for IMU)
  105. * @param chan The MAVLink channel this message will be sent over
  106. * @param msg The MAVLink message to compress the data into
  107. * @param encapsulated_data C-struct to read the message contents from
  108. */
  109. 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)
  110. {
  111. return mavlink_msg_encapsulated_data_pack_chan(system_id, component_id, chan, msg, encapsulated_data->seqnr, encapsulated_data->data);
  112. }
  113. /**
  114. * @brief Send a encapsulated_data message
  115. * @param chan MAVLink channel to send the message
  116. *
  117. * @param seqnr sequence number (starting with 0 on every transmission)
  118. * @param data image data bytes
  119. */
  120. #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
  121. static inline void mavlink_msg_encapsulated_data_send(mavlink_channel_t chan, uint16_t seqnr, const uint8_t *data)
  122. {
  123. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  124. char buf[MAVLINK_MSG_ID_ENCAPSULATED_DATA_LEN];
  125. _mav_put_uint16_t(buf, 0, seqnr);
  126. _mav_put_uint8_t_array(buf, 2, data, 253);
  127. _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);
  128. #else
  129. mavlink_encapsulated_data_t packet;
  130. packet.seqnr = seqnr;
  131. mav_array_memcpy(packet.data, data, sizeof(uint8_t)*253);
  132. _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);
  133. #endif
  134. }
  135. /**
  136. * @brief Send a encapsulated_data message
  137. * @param chan MAVLink channel to send the message
  138. * @param struct The MAVLink struct to serialize
  139. */
  140. static inline void mavlink_msg_encapsulated_data_send_struct(mavlink_channel_t chan, const mavlink_encapsulated_data_t* encapsulated_data)
  141. {
  142. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  143. mavlink_msg_encapsulated_data_send(chan, encapsulated_data->seqnr, encapsulated_data->data);
  144. #else
  145. _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);
  146. #endif
  147. }
  148. #if MAVLINK_MSG_ID_ENCAPSULATED_DATA_LEN <= MAVLINK_MAX_PAYLOAD_LEN
  149. /*
  150. This varient of _send() can be used to save stack space by re-using
  151. memory from the receive buffer. The caller provides a
  152. mavlink_message_t which is the size of a full mavlink message. This
  153. is usually the receive buffer for the channel, and allows a reply to an
  154. incoming message with minimum stack space usage.
  155. */
  156. static inline void mavlink_msg_encapsulated_data_send_buf(mavlink_message_t *msgbuf, mavlink_channel_t chan, uint16_t seqnr, const uint8_t *data)
  157. {
  158. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  159. char *buf = (char *)msgbuf;
  160. _mav_put_uint16_t(buf, 0, seqnr);
  161. _mav_put_uint8_t_array(buf, 2, data, 253);
  162. _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);
  163. #else
  164. mavlink_encapsulated_data_t *packet = (mavlink_encapsulated_data_t *)msgbuf;
  165. packet->seqnr = seqnr;
  166. mav_array_memcpy(packet->data, data, sizeof(uint8_t)*253);
  167. _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);
  168. #endif
  169. }
  170. #endif
  171. #endif
  172. // MESSAGE ENCAPSULATED_DATA UNPACKING
  173. /**
  174. * @brief Get field seqnr from encapsulated_data message
  175. *
  176. * @return sequence number (starting with 0 on every transmission)
  177. */
  178. static inline uint16_t mavlink_msg_encapsulated_data_get_seqnr(const mavlink_message_t* msg)
  179. {
  180. return _MAV_RETURN_uint16_t(msg, 0);
  181. }
  182. /**
  183. * @brief Get field data from encapsulated_data message
  184. *
  185. * @return image data bytes
  186. */
  187. static inline uint16_t mavlink_msg_encapsulated_data_get_data(const mavlink_message_t* msg, uint8_t *data)
  188. {
  189. return _MAV_RETURN_uint8_t_array(msg, data, 253, 2);
  190. }
  191. /**
  192. * @brief Decode a encapsulated_data message into a struct
  193. *
  194. * @param msg The message to decode
  195. * @param encapsulated_data C-struct to decode the message contents into
  196. */
  197. static inline void mavlink_msg_encapsulated_data_decode(const mavlink_message_t* msg, mavlink_encapsulated_data_t* encapsulated_data)
  198. {
  199. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  200. encapsulated_data->seqnr = mavlink_msg_encapsulated_data_get_seqnr(msg);
  201. mavlink_msg_encapsulated_data_get_data(msg, encapsulated_data->data);
  202. #else
  203. uint8_t len = msg->len < MAVLINK_MSG_ID_ENCAPSULATED_DATA_LEN? msg->len : MAVLINK_MSG_ID_ENCAPSULATED_DATA_LEN;
  204. memset(encapsulated_data, 0, MAVLINK_MSG_ID_ENCAPSULATED_DATA_LEN);
  205. memcpy(encapsulated_data, _MAV_PAYLOAD(msg), len);
  206. #endif
  207. }