mavlink_msg_data_stream.h 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316
  1. #pragma once
  2. // MESSAGE DATA_STREAM PACKING
  3. #define MAVLINK_MSG_ID_DATA_STREAM 67
  4. typedef struct __mavlink_data_stream_t {
  5. uint16_t message_rate; /*< [Hz] The message rate*/
  6. uint8_t stream_id; /*< The ID of the requested data stream*/
  7. uint8_t on_off; /*< 1 stream is enabled, 0 stream is stopped.*/
  8. } mavlink_data_stream_t;
  9. #define MAVLINK_MSG_ID_DATA_STREAM_LEN 4
  10. #define MAVLINK_MSG_ID_DATA_STREAM_MIN_LEN 4
  11. #define MAVLINK_MSG_ID_67_LEN 4
  12. #define MAVLINK_MSG_ID_67_MIN_LEN 4
  13. #define MAVLINK_MSG_ID_DATA_STREAM_CRC 21
  14. #define MAVLINK_MSG_ID_67_CRC 21
  15. #if MAVLINK_COMMAND_24BIT
  16. #define MAVLINK_MESSAGE_INFO_DATA_STREAM { \
  17. 67, \
  18. "DATA_STREAM", \
  19. 3, \
  20. { { "stream_id", NULL, MAVLINK_TYPE_UINT8_T, 0, 2, offsetof(mavlink_data_stream_t, stream_id) }, \
  21. { "message_rate", NULL, MAVLINK_TYPE_UINT16_T, 0, 0, offsetof(mavlink_data_stream_t, message_rate) }, \
  22. { "on_off", NULL, MAVLINK_TYPE_UINT8_T, 0, 3, offsetof(mavlink_data_stream_t, on_off) }, \
  23. } \
  24. }
  25. #else
  26. #define MAVLINK_MESSAGE_INFO_DATA_STREAM { \
  27. "DATA_STREAM", \
  28. 3, \
  29. { { "stream_id", NULL, MAVLINK_TYPE_UINT8_T, 0, 2, offsetof(mavlink_data_stream_t, stream_id) }, \
  30. { "message_rate", NULL, MAVLINK_TYPE_UINT16_T, 0, 0, offsetof(mavlink_data_stream_t, message_rate) }, \
  31. { "on_off", NULL, MAVLINK_TYPE_UINT8_T, 0, 3, offsetof(mavlink_data_stream_t, on_off) }, \
  32. } \
  33. }
  34. #endif
  35. /**
  36. * @brief Pack a data_stream 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 stream_id The ID of the requested data stream
  42. * @param message_rate [Hz] The message rate
  43. * @param on_off 1 stream is enabled, 0 stream is stopped.
  44. * @return length of the message in bytes (excluding serial stream start sign)
  45. */
  46. static inline uint16_t mavlink_msg_data_stream_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
  47. uint8_t stream_id, uint16_t message_rate, uint8_t on_off)
  48. {
  49. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  50. char buf[MAVLINK_MSG_ID_DATA_STREAM_LEN];
  51. _mav_put_uint16_t(buf, 0, message_rate);
  52. _mav_put_uint8_t(buf, 2, stream_id);
  53. _mav_put_uint8_t(buf, 3, on_off);
  54. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_DATA_STREAM_LEN);
  55. #else
  56. mavlink_data_stream_t packet;
  57. packet.message_rate = message_rate;
  58. packet.stream_id = stream_id;
  59. packet.on_off = on_off;
  60. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_DATA_STREAM_LEN);
  61. #endif
  62. msg->msgid = MAVLINK_MSG_ID_DATA_STREAM;
  63. return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_DATA_STREAM_MIN_LEN, MAVLINK_MSG_ID_DATA_STREAM_LEN, MAVLINK_MSG_ID_DATA_STREAM_CRC);
  64. }
  65. /**
  66. * @brief Pack a data_stream message
  67. * @param system_id ID of this system
  68. * @param component_id ID of this component (e.g. 200 for IMU)
  69. * @param status MAVLink status structure
  70. * @param msg The MAVLink message to compress the data into
  71. *
  72. * @param stream_id The ID of the requested data stream
  73. * @param message_rate [Hz] The message rate
  74. * @param on_off 1 stream is enabled, 0 stream is stopped.
  75. * @return length of the message in bytes (excluding serial stream start sign)
  76. */
  77. static inline uint16_t mavlink_msg_data_stream_pack_status(uint8_t system_id, uint8_t component_id, mavlink_status_t *_status, mavlink_message_t* msg,
  78. uint8_t stream_id, uint16_t message_rate, uint8_t on_off)
  79. {
  80. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  81. char buf[MAVLINK_MSG_ID_DATA_STREAM_LEN];
  82. _mav_put_uint16_t(buf, 0, message_rate);
  83. _mav_put_uint8_t(buf, 2, stream_id);
  84. _mav_put_uint8_t(buf, 3, on_off);
  85. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_DATA_STREAM_LEN);
  86. #else
  87. mavlink_data_stream_t packet;
  88. packet.message_rate = message_rate;
  89. packet.stream_id = stream_id;
  90. packet.on_off = on_off;
  91. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_DATA_STREAM_LEN);
  92. #endif
  93. msg->msgid = MAVLINK_MSG_ID_DATA_STREAM;
  94. #if MAVLINK_CRC_EXTRA
  95. return mavlink_finalize_message_buffer(msg, system_id, component_id, _status, MAVLINK_MSG_ID_DATA_STREAM_MIN_LEN, MAVLINK_MSG_ID_DATA_STREAM_LEN, MAVLINK_MSG_ID_DATA_STREAM_CRC);
  96. #else
  97. return mavlink_finalize_message_buffer(msg, system_id, component_id, _status, MAVLINK_MSG_ID_DATA_STREAM_MIN_LEN, MAVLINK_MSG_ID_DATA_STREAM_LEN);
  98. #endif
  99. }
  100. /**
  101. * @brief Pack a data_stream message on a channel
  102. * @param system_id ID of this system
  103. * @param component_id ID of this component (e.g. 200 for IMU)
  104. * @param chan The MAVLink channel this message will be sent over
  105. * @param msg The MAVLink message to compress the data into
  106. * @param stream_id The ID of the requested data stream
  107. * @param message_rate [Hz] The message rate
  108. * @param on_off 1 stream is enabled, 0 stream is stopped.
  109. * @return length of the message in bytes (excluding serial stream start sign)
  110. */
  111. static inline uint16_t mavlink_msg_data_stream_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
  112. mavlink_message_t* msg,
  113. uint8_t stream_id,uint16_t message_rate,uint8_t on_off)
  114. {
  115. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  116. char buf[MAVLINK_MSG_ID_DATA_STREAM_LEN];
  117. _mav_put_uint16_t(buf, 0, message_rate);
  118. _mav_put_uint8_t(buf, 2, stream_id);
  119. _mav_put_uint8_t(buf, 3, on_off);
  120. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_DATA_STREAM_LEN);
  121. #else
  122. mavlink_data_stream_t packet;
  123. packet.message_rate = message_rate;
  124. packet.stream_id = stream_id;
  125. packet.on_off = on_off;
  126. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_DATA_STREAM_LEN);
  127. #endif
  128. msg->msgid = MAVLINK_MSG_ID_DATA_STREAM;
  129. return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_DATA_STREAM_MIN_LEN, MAVLINK_MSG_ID_DATA_STREAM_LEN, MAVLINK_MSG_ID_DATA_STREAM_CRC);
  130. }
  131. /**
  132. * @brief Encode a data_stream struct
  133. *
  134. * @param system_id ID of this system
  135. * @param component_id ID of this component (e.g. 200 for IMU)
  136. * @param msg The MAVLink message to compress the data into
  137. * @param data_stream C-struct to read the message contents from
  138. */
  139. static inline uint16_t mavlink_msg_data_stream_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_data_stream_t* data_stream)
  140. {
  141. return mavlink_msg_data_stream_pack(system_id, component_id, msg, data_stream->stream_id, data_stream->message_rate, data_stream->on_off);
  142. }
  143. /**
  144. * @brief Encode a data_stream struct on a channel
  145. *
  146. * @param system_id ID of this system
  147. * @param component_id ID of this component (e.g. 200 for IMU)
  148. * @param chan The MAVLink channel this message will be sent over
  149. * @param msg The MAVLink message to compress the data into
  150. * @param data_stream C-struct to read the message contents from
  151. */
  152. static inline uint16_t mavlink_msg_data_stream_encode_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const mavlink_data_stream_t* data_stream)
  153. {
  154. return mavlink_msg_data_stream_pack_chan(system_id, component_id, chan, msg, data_stream->stream_id, data_stream->message_rate, data_stream->on_off);
  155. }
  156. /**
  157. * @brief Encode a data_stream struct with provided status structure
  158. *
  159. * @param system_id ID of this system
  160. * @param component_id ID of this component (e.g. 200 for IMU)
  161. * @param status MAVLink status structure
  162. * @param msg The MAVLink message to compress the data into
  163. * @param data_stream C-struct to read the message contents from
  164. */
  165. static inline uint16_t mavlink_msg_data_stream_encode_status(uint8_t system_id, uint8_t component_id, mavlink_status_t* _status, mavlink_message_t* msg, const mavlink_data_stream_t* data_stream)
  166. {
  167. return mavlink_msg_data_stream_pack_status(system_id, component_id, _status, msg, data_stream->stream_id, data_stream->message_rate, data_stream->on_off);
  168. }
  169. /**
  170. * @brief Send a data_stream message
  171. * @param chan MAVLink channel to send the message
  172. *
  173. * @param stream_id The ID of the requested data stream
  174. * @param message_rate [Hz] The message rate
  175. * @param on_off 1 stream is enabled, 0 stream is stopped.
  176. */
  177. #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
  178. static inline void mavlink_msg_data_stream_send(mavlink_channel_t chan, uint8_t stream_id, uint16_t message_rate, uint8_t on_off)
  179. {
  180. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  181. char buf[MAVLINK_MSG_ID_DATA_STREAM_LEN];
  182. _mav_put_uint16_t(buf, 0, message_rate);
  183. _mav_put_uint8_t(buf, 2, stream_id);
  184. _mav_put_uint8_t(buf, 3, on_off);
  185. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_DATA_STREAM, buf, MAVLINK_MSG_ID_DATA_STREAM_MIN_LEN, MAVLINK_MSG_ID_DATA_STREAM_LEN, MAVLINK_MSG_ID_DATA_STREAM_CRC);
  186. #else
  187. mavlink_data_stream_t packet;
  188. packet.message_rate = message_rate;
  189. packet.stream_id = stream_id;
  190. packet.on_off = on_off;
  191. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_DATA_STREAM, (const char *)&packet, MAVLINK_MSG_ID_DATA_STREAM_MIN_LEN, MAVLINK_MSG_ID_DATA_STREAM_LEN, MAVLINK_MSG_ID_DATA_STREAM_CRC);
  192. #endif
  193. }
  194. /**
  195. * @brief Send a data_stream message
  196. * @param chan MAVLink channel to send the message
  197. * @param struct The MAVLink struct to serialize
  198. */
  199. static inline void mavlink_msg_data_stream_send_struct(mavlink_channel_t chan, const mavlink_data_stream_t* data_stream)
  200. {
  201. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  202. mavlink_msg_data_stream_send(chan, data_stream->stream_id, data_stream->message_rate, data_stream->on_off);
  203. #else
  204. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_DATA_STREAM, (const char *)data_stream, MAVLINK_MSG_ID_DATA_STREAM_MIN_LEN, MAVLINK_MSG_ID_DATA_STREAM_LEN, MAVLINK_MSG_ID_DATA_STREAM_CRC);
  205. #endif
  206. }
  207. #if MAVLINK_MSG_ID_DATA_STREAM_LEN <= MAVLINK_MAX_PAYLOAD_LEN
  208. /*
  209. This variant of _send() can be used to save stack space by re-using
  210. memory from the receive buffer. The caller provides a
  211. mavlink_message_t which is the size of a full mavlink message. This
  212. is usually the receive buffer for the channel, and allows a reply to an
  213. incoming message with minimum stack space usage.
  214. */
  215. static inline void mavlink_msg_data_stream_send_buf(mavlink_message_t *msgbuf, mavlink_channel_t chan, uint8_t stream_id, uint16_t message_rate, uint8_t on_off)
  216. {
  217. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  218. char *buf = (char *)msgbuf;
  219. _mav_put_uint16_t(buf, 0, message_rate);
  220. _mav_put_uint8_t(buf, 2, stream_id);
  221. _mav_put_uint8_t(buf, 3, on_off);
  222. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_DATA_STREAM, buf, MAVLINK_MSG_ID_DATA_STREAM_MIN_LEN, MAVLINK_MSG_ID_DATA_STREAM_LEN, MAVLINK_MSG_ID_DATA_STREAM_CRC);
  223. #else
  224. mavlink_data_stream_t *packet = (mavlink_data_stream_t *)msgbuf;
  225. packet->message_rate = message_rate;
  226. packet->stream_id = stream_id;
  227. packet->on_off = on_off;
  228. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_DATA_STREAM, (const char *)packet, MAVLINK_MSG_ID_DATA_STREAM_MIN_LEN, MAVLINK_MSG_ID_DATA_STREAM_LEN, MAVLINK_MSG_ID_DATA_STREAM_CRC);
  229. #endif
  230. }
  231. #endif
  232. #endif
  233. // MESSAGE DATA_STREAM UNPACKING
  234. /**
  235. * @brief Get field stream_id from data_stream message
  236. *
  237. * @return The ID of the requested data stream
  238. */
  239. static inline uint8_t mavlink_msg_data_stream_get_stream_id(const mavlink_message_t* msg)
  240. {
  241. return _MAV_RETURN_uint8_t(msg, 2);
  242. }
  243. /**
  244. * @brief Get field message_rate from data_stream message
  245. *
  246. * @return [Hz] The message rate
  247. */
  248. static inline uint16_t mavlink_msg_data_stream_get_message_rate(const mavlink_message_t* msg)
  249. {
  250. return _MAV_RETURN_uint16_t(msg, 0);
  251. }
  252. /**
  253. * @brief Get field on_off from data_stream message
  254. *
  255. * @return 1 stream is enabled, 0 stream is stopped.
  256. */
  257. static inline uint8_t mavlink_msg_data_stream_get_on_off(const mavlink_message_t* msg)
  258. {
  259. return _MAV_RETURN_uint8_t(msg, 3);
  260. }
  261. /**
  262. * @brief Decode a data_stream message into a struct
  263. *
  264. * @param msg The message to decode
  265. * @param data_stream C-struct to decode the message contents into
  266. */
  267. static inline void mavlink_msg_data_stream_decode(const mavlink_message_t* msg, mavlink_data_stream_t* data_stream)
  268. {
  269. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  270. data_stream->message_rate = mavlink_msg_data_stream_get_message_rate(msg);
  271. data_stream->stream_id = mavlink_msg_data_stream_get_stream_id(msg);
  272. data_stream->on_off = mavlink_msg_data_stream_get_on_off(msg);
  273. #else
  274. uint8_t len = msg->len < MAVLINK_MSG_ID_DATA_STREAM_LEN? msg->len : MAVLINK_MSG_ID_DATA_STREAM_LEN;
  275. memset(data_stream, 0, MAVLINK_MSG_ID_DATA_STREAM_LEN);
  276. memcpy(data_stream, _MAV_PAYLOAD(msg), len);
  277. #endif
  278. }