mavlink_msg_tunnel.h 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305
  1. #pragma once
  2. // MESSAGE TUNNEL PACKING
  3. #define MAVLINK_MSG_ID_TUNNEL 385
  4. typedef struct __mavlink_tunnel_t {
  5. uint16_t payload_type; /*< A code that identifies the content of the payload (0 for unknown, which is the default). If this code is less than 32768, it is a 'registered' payload type and the corresponding code should be added to the MAV_TUNNEL_PAYLOAD_TYPE enum. Software creators can register blocks of types as needed. Codes greater than 32767 are considered local experiments and should not be checked in to any widely distributed codebase.*/
  6. uint8_t target_system; /*< System ID (can be 0 for broadcast, but this is discouraged)*/
  7. uint8_t target_component; /*< Component ID (can be 0 for broadcast, but this is discouraged)*/
  8. uint8_t payload_length; /*< Length of the data transported in payload*/
  9. uint8_t payload[128]; /*< Variable length payload. The payload length is defined by payload_length. The entire content of this block is opaque unless you understand the encoding specified by payload_type.*/
  10. } mavlink_tunnel_t;
  11. #define MAVLINK_MSG_ID_TUNNEL_LEN 133
  12. #define MAVLINK_MSG_ID_TUNNEL_MIN_LEN 133
  13. #define MAVLINK_MSG_ID_385_LEN 133
  14. #define MAVLINK_MSG_ID_385_MIN_LEN 133
  15. #define MAVLINK_MSG_ID_TUNNEL_CRC 147
  16. #define MAVLINK_MSG_ID_385_CRC 147
  17. #define MAVLINK_MSG_TUNNEL_FIELD_PAYLOAD_LEN 128
  18. #if MAVLINK_COMMAND_24BIT
  19. #define MAVLINK_MESSAGE_INFO_TUNNEL { \
  20. 385, \
  21. "TUNNEL", \
  22. 5, \
  23. { { "target_system", NULL, MAVLINK_TYPE_UINT8_T, 0, 2, offsetof(mavlink_tunnel_t, target_system) }, \
  24. { "target_component", NULL, MAVLINK_TYPE_UINT8_T, 0, 3, offsetof(mavlink_tunnel_t, target_component) }, \
  25. { "payload_type", NULL, MAVLINK_TYPE_UINT16_T, 0, 0, offsetof(mavlink_tunnel_t, payload_type) }, \
  26. { "payload_length", NULL, MAVLINK_TYPE_UINT8_T, 0, 4, offsetof(mavlink_tunnel_t, payload_length) }, \
  27. { "payload", NULL, MAVLINK_TYPE_UINT8_T, 128, 5, offsetof(mavlink_tunnel_t, payload) }, \
  28. } \
  29. }
  30. #else
  31. #define MAVLINK_MESSAGE_INFO_TUNNEL { \
  32. "TUNNEL", \
  33. 5, \
  34. { { "target_system", NULL, MAVLINK_TYPE_UINT8_T, 0, 2, offsetof(mavlink_tunnel_t, target_system) }, \
  35. { "target_component", NULL, MAVLINK_TYPE_UINT8_T, 0, 3, offsetof(mavlink_tunnel_t, target_component) }, \
  36. { "payload_type", NULL, MAVLINK_TYPE_UINT16_T, 0, 0, offsetof(mavlink_tunnel_t, payload_type) }, \
  37. { "payload_length", NULL, MAVLINK_TYPE_UINT8_T, 0, 4, offsetof(mavlink_tunnel_t, payload_length) }, \
  38. { "payload", NULL, MAVLINK_TYPE_UINT8_T, 128, 5, offsetof(mavlink_tunnel_t, payload) }, \
  39. } \
  40. }
  41. #endif
  42. /**
  43. * @brief Pack a tunnel 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_system System ID (can be 0 for broadcast, but this is discouraged)
  49. * @param target_component Component ID (can be 0 for broadcast, but this is discouraged)
  50. * @param payload_type A code that identifies the content of the payload (0 for unknown, which is the default). If this code is less than 32768, it is a 'registered' payload type and the corresponding code should be added to the MAV_TUNNEL_PAYLOAD_TYPE enum. Software creators can register blocks of types as needed. Codes greater than 32767 are considered local experiments and should not be checked in to any widely distributed codebase.
  51. * @param payload_length Length of the data transported in payload
  52. * @param payload Variable length payload. The payload length is defined by payload_length. The entire content of this block is opaque unless you understand the encoding specified by payload_type.
  53. * @return length of the message in bytes (excluding serial stream start sign)
  54. */
  55. static inline uint16_t mavlink_msg_tunnel_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
  56. uint8_t target_system, uint8_t target_component, uint16_t payload_type, uint8_t payload_length, const uint8_t *payload)
  57. {
  58. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  59. char buf[MAVLINK_MSG_ID_TUNNEL_LEN];
  60. _mav_put_uint16_t(buf, 0, payload_type);
  61. _mav_put_uint8_t(buf, 2, target_system);
  62. _mav_put_uint8_t(buf, 3, target_component);
  63. _mav_put_uint8_t(buf, 4, payload_length);
  64. _mav_put_uint8_t_array(buf, 5, payload, 128);
  65. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_TUNNEL_LEN);
  66. #else
  67. mavlink_tunnel_t packet;
  68. packet.payload_type = payload_type;
  69. packet.target_system = target_system;
  70. packet.target_component = target_component;
  71. packet.payload_length = payload_length;
  72. mav_array_memcpy(packet.payload, payload, sizeof(uint8_t)*128);
  73. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_TUNNEL_LEN);
  74. #endif
  75. msg->msgid = MAVLINK_MSG_ID_TUNNEL;
  76. return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_TUNNEL_MIN_LEN, MAVLINK_MSG_ID_TUNNEL_LEN, MAVLINK_MSG_ID_TUNNEL_CRC);
  77. }
  78. /**
  79. * @brief Pack a tunnel 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_system System ID (can be 0 for broadcast, but this is discouraged)
  85. * @param target_component Component ID (can be 0 for broadcast, but this is discouraged)
  86. * @param payload_type A code that identifies the content of the payload (0 for unknown, which is the default). If this code is less than 32768, it is a 'registered' payload type and the corresponding code should be added to the MAV_TUNNEL_PAYLOAD_TYPE enum. Software creators can register blocks of types as needed. Codes greater than 32767 are considered local experiments and should not be checked in to any widely distributed codebase.
  87. * @param payload_length Length of the data transported in payload
  88. * @param payload Variable length payload. The payload length is defined by payload_length. The entire content of this block is opaque unless you understand the encoding specified by payload_type.
  89. * @return length of the message in bytes (excluding serial stream start sign)
  90. */
  91. static inline uint16_t mavlink_msg_tunnel_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
  92. mavlink_message_t* msg,
  93. uint8_t target_system,uint8_t target_component,uint16_t payload_type,uint8_t payload_length,const uint8_t *payload)
  94. {
  95. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  96. char buf[MAVLINK_MSG_ID_TUNNEL_LEN];
  97. _mav_put_uint16_t(buf, 0, payload_type);
  98. _mav_put_uint8_t(buf, 2, target_system);
  99. _mav_put_uint8_t(buf, 3, target_component);
  100. _mav_put_uint8_t(buf, 4, payload_length);
  101. _mav_put_uint8_t_array(buf, 5, payload, 128);
  102. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_TUNNEL_LEN);
  103. #else
  104. mavlink_tunnel_t packet;
  105. packet.payload_type = payload_type;
  106. packet.target_system = target_system;
  107. packet.target_component = target_component;
  108. packet.payload_length = payload_length;
  109. mav_array_memcpy(packet.payload, payload, sizeof(uint8_t)*128);
  110. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_TUNNEL_LEN);
  111. #endif
  112. msg->msgid = MAVLINK_MSG_ID_TUNNEL;
  113. return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_TUNNEL_MIN_LEN, MAVLINK_MSG_ID_TUNNEL_LEN, MAVLINK_MSG_ID_TUNNEL_CRC);
  114. }
  115. /**
  116. * @brief Encode a tunnel 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 tunnel C-struct to read the message contents from
  122. */
  123. static inline uint16_t mavlink_msg_tunnel_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_tunnel_t* tunnel)
  124. {
  125. return mavlink_msg_tunnel_pack(system_id, component_id, msg, tunnel->target_system, tunnel->target_component, tunnel->payload_type, tunnel->payload_length, tunnel->payload);
  126. }
  127. /**
  128. * @brief Encode a tunnel 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 tunnel C-struct to read the message contents from
  135. */
  136. static inline uint16_t mavlink_msg_tunnel_encode_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const mavlink_tunnel_t* tunnel)
  137. {
  138. return mavlink_msg_tunnel_pack_chan(system_id, component_id, chan, msg, tunnel->target_system, tunnel->target_component, tunnel->payload_type, tunnel->payload_length, tunnel->payload);
  139. }
  140. /**
  141. * @brief Send a tunnel message
  142. * @param chan MAVLink channel to send the message
  143. *
  144. * @param target_system System ID (can be 0 for broadcast, but this is discouraged)
  145. * @param target_component Component ID (can be 0 for broadcast, but this is discouraged)
  146. * @param payload_type A code that identifies the content of the payload (0 for unknown, which is the default). If this code is less than 32768, it is a 'registered' payload type and the corresponding code should be added to the MAV_TUNNEL_PAYLOAD_TYPE enum. Software creators can register blocks of types as needed. Codes greater than 32767 are considered local experiments and should not be checked in to any widely distributed codebase.
  147. * @param payload_length Length of the data transported in payload
  148. * @param payload Variable length payload. The payload length is defined by payload_length. The entire content of this block is opaque unless you understand the encoding specified by payload_type.
  149. */
  150. #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
  151. static inline void mavlink_msg_tunnel_send(mavlink_channel_t chan, uint8_t target_system, uint8_t target_component, uint16_t payload_type, uint8_t payload_length, const uint8_t *payload)
  152. {
  153. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  154. char buf[MAVLINK_MSG_ID_TUNNEL_LEN];
  155. _mav_put_uint16_t(buf, 0, payload_type);
  156. _mav_put_uint8_t(buf, 2, target_system);
  157. _mav_put_uint8_t(buf, 3, target_component);
  158. _mav_put_uint8_t(buf, 4, payload_length);
  159. _mav_put_uint8_t_array(buf, 5, payload, 128);
  160. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_TUNNEL, buf, MAVLINK_MSG_ID_TUNNEL_MIN_LEN, MAVLINK_MSG_ID_TUNNEL_LEN, MAVLINK_MSG_ID_TUNNEL_CRC);
  161. #else
  162. mavlink_tunnel_t packet;
  163. packet.payload_type = payload_type;
  164. packet.target_system = target_system;
  165. packet.target_component = target_component;
  166. packet.payload_length = payload_length;
  167. mav_array_memcpy(packet.payload, payload, sizeof(uint8_t)*128);
  168. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_TUNNEL, (const char *)&packet, MAVLINK_MSG_ID_TUNNEL_MIN_LEN, MAVLINK_MSG_ID_TUNNEL_LEN, MAVLINK_MSG_ID_TUNNEL_CRC);
  169. #endif
  170. }
  171. /**
  172. * @brief Send a tunnel 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_tunnel_send_struct(mavlink_channel_t chan, const mavlink_tunnel_t* tunnel)
  177. {
  178. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  179. mavlink_msg_tunnel_send(chan, tunnel->target_system, tunnel->target_component, tunnel->payload_type, tunnel->payload_length, tunnel->payload);
  180. #else
  181. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_TUNNEL, (const char *)tunnel, MAVLINK_MSG_ID_TUNNEL_MIN_LEN, MAVLINK_MSG_ID_TUNNEL_LEN, MAVLINK_MSG_ID_TUNNEL_CRC);
  182. #endif
  183. }
  184. #if MAVLINK_MSG_ID_TUNNEL_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_tunnel_send_buf(mavlink_message_t *msgbuf, mavlink_channel_t chan, uint8_t target_system, uint8_t target_component, uint16_t payload_type, uint8_t payload_length, 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, payload_type);
  197. _mav_put_uint8_t(buf, 2, target_system);
  198. _mav_put_uint8_t(buf, 3, target_component);
  199. _mav_put_uint8_t(buf, 4, payload_length);
  200. _mav_put_uint8_t_array(buf, 5, payload, 128);
  201. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_TUNNEL, buf, MAVLINK_MSG_ID_TUNNEL_MIN_LEN, MAVLINK_MSG_ID_TUNNEL_LEN, MAVLINK_MSG_ID_TUNNEL_CRC);
  202. #else
  203. mavlink_tunnel_t *packet = (mavlink_tunnel_t *)msgbuf;
  204. packet->payload_type = payload_type;
  205. packet->target_system = target_system;
  206. packet->target_component = target_component;
  207. packet->payload_length = payload_length;
  208. mav_array_memcpy(packet->payload, payload, sizeof(uint8_t)*128);
  209. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_TUNNEL, (const char *)packet, MAVLINK_MSG_ID_TUNNEL_MIN_LEN, MAVLINK_MSG_ID_TUNNEL_LEN, MAVLINK_MSG_ID_TUNNEL_CRC);
  210. #endif
  211. }
  212. #endif
  213. #endif
  214. // MESSAGE TUNNEL UNPACKING
  215. /**
  216. * @brief Get field target_system from tunnel message
  217. *
  218. * @return System ID (can be 0 for broadcast, but this is discouraged)
  219. */
  220. static inline uint8_t mavlink_msg_tunnel_get_target_system(const mavlink_message_t* msg)
  221. {
  222. return _MAV_RETURN_uint8_t(msg, 2);
  223. }
  224. /**
  225. * @brief Get field target_component from tunnel message
  226. *
  227. * @return Component ID (can be 0 for broadcast, but this is discouraged)
  228. */
  229. static inline uint8_t mavlink_msg_tunnel_get_target_component(const mavlink_message_t* msg)
  230. {
  231. return _MAV_RETURN_uint8_t(msg, 3);
  232. }
  233. /**
  234. * @brief Get field payload_type from tunnel message
  235. *
  236. * @return A code that identifies the content of the payload (0 for unknown, which is the default). If this code is less than 32768, it is a 'registered' payload type and the corresponding code should be added to the MAV_TUNNEL_PAYLOAD_TYPE enum. Software creators can register blocks of types as needed. Codes greater than 32767 are considered local experiments and should not be checked in to any widely distributed codebase.
  237. */
  238. static inline uint16_t mavlink_msg_tunnel_get_payload_type(const mavlink_message_t* msg)
  239. {
  240. return _MAV_RETURN_uint16_t(msg, 0);
  241. }
  242. /**
  243. * @brief Get field payload_length from tunnel message
  244. *
  245. * @return Length of the data transported in payload
  246. */
  247. static inline uint8_t mavlink_msg_tunnel_get_payload_length(const mavlink_message_t* msg)
  248. {
  249. return _MAV_RETURN_uint8_t(msg, 4);
  250. }
  251. /**
  252. * @brief Get field payload from tunnel message
  253. *
  254. * @return Variable length payload. The payload length is defined by payload_length. The entire content of this block is opaque unless you understand the encoding specified by payload_type.
  255. */
  256. static inline uint16_t mavlink_msg_tunnel_get_payload(const mavlink_message_t* msg, uint8_t *payload)
  257. {
  258. return _MAV_RETURN_uint8_t_array(msg, payload, 128, 5);
  259. }
  260. /**
  261. * @brief Decode a tunnel message into a struct
  262. *
  263. * @param msg The message to decode
  264. * @param tunnel C-struct to decode the message contents into
  265. */
  266. static inline void mavlink_msg_tunnel_decode(const mavlink_message_t* msg, mavlink_tunnel_t* tunnel)
  267. {
  268. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  269. tunnel->payload_type = mavlink_msg_tunnel_get_payload_type(msg);
  270. tunnel->target_system = mavlink_msg_tunnel_get_target_system(msg);
  271. tunnel->target_component = mavlink_msg_tunnel_get_target_component(msg);
  272. tunnel->payload_length = mavlink_msg_tunnel_get_payload_length(msg);
  273. mavlink_msg_tunnel_get_payload(msg, tunnel->payload);
  274. #else
  275. uint8_t len = msg->len < MAVLINK_MSG_ID_TUNNEL_LEN? msg->len : MAVLINK_MSG_ID_TUNNEL_LEN;
  276. memset(tunnel, 0, MAVLINK_MSG_ID_TUNNEL_LEN);
  277. memcpy(tunnel, _MAV_PAYLOAD(msg), len);
  278. #endif
  279. }