mavlink_msg_data_stream.h 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263
  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 on a channel
  67. * @param system_id ID of this system
  68. * @param component_id ID of this component (e.g. 200 for IMU)
  69. * @param chan The MAVLink channel this message will be sent over
  70. * @param msg The MAVLink message to compress the data into
  71. * @param stream_id The ID of the requested data stream
  72. * @param message_rate [Hz] The message rate
  73. * @param on_off 1 stream is enabled, 0 stream is stopped.
  74. * @return length of the message in bytes (excluding serial stream start sign)
  75. */
  76. static inline uint16_t mavlink_msg_data_stream_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
  77. 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. 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);
  95. }
  96. /**
  97. * @brief Encode a data_stream struct
  98. *
  99. * @param system_id ID of this system
  100. * @param component_id ID of this component (e.g. 200 for IMU)
  101. * @param msg The MAVLink message to compress the data into
  102. * @param data_stream C-struct to read the message contents from
  103. */
  104. 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)
  105. {
  106. return mavlink_msg_data_stream_pack(system_id, component_id, msg, data_stream->stream_id, data_stream->message_rate, data_stream->on_off);
  107. }
  108. /**
  109. * @brief Encode a data_stream struct on a channel
  110. *
  111. * @param system_id ID of this system
  112. * @param component_id ID of this component (e.g. 200 for IMU)
  113. * @param chan The MAVLink channel this message will be sent over
  114. * @param msg The MAVLink message to compress the data into
  115. * @param data_stream C-struct to read the message contents from
  116. */
  117. 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)
  118. {
  119. 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);
  120. }
  121. /**
  122. * @brief Send a data_stream message
  123. * @param chan MAVLink channel to send the message
  124. *
  125. * @param stream_id The ID of the requested data stream
  126. * @param message_rate [Hz] The message rate
  127. * @param on_off 1 stream is enabled, 0 stream is stopped.
  128. */
  129. #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
  130. static inline void mavlink_msg_data_stream_send(mavlink_channel_t chan, uint8_t stream_id, uint16_t message_rate, uint8_t on_off)
  131. {
  132. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  133. char buf[MAVLINK_MSG_ID_DATA_STREAM_LEN];
  134. _mav_put_uint16_t(buf, 0, message_rate);
  135. _mav_put_uint8_t(buf, 2, stream_id);
  136. _mav_put_uint8_t(buf, 3, on_off);
  137. _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);
  138. #else
  139. mavlink_data_stream_t packet;
  140. packet.message_rate = message_rate;
  141. packet.stream_id = stream_id;
  142. packet.on_off = on_off;
  143. _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);
  144. #endif
  145. }
  146. /**
  147. * @brief Send a data_stream message
  148. * @param chan MAVLink channel to send the message
  149. * @param struct The MAVLink struct to serialize
  150. */
  151. static inline void mavlink_msg_data_stream_send_struct(mavlink_channel_t chan, const mavlink_data_stream_t* data_stream)
  152. {
  153. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  154. mavlink_msg_data_stream_send(chan, data_stream->stream_id, data_stream->message_rate, data_stream->on_off);
  155. #else
  156. _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);
  157. #endif
  158. }
  159. #if MAVLINK_MSG_ID_DATA_STREAM_LEN <= MAVLINK_MAX_PAYLOAD_LEN
  160. /*
  161. This variant of _send() can be used to save stack space by re-using
  162. memory from the receive buffer. The caller provides a
  163. mavlink_message_t which is the size of a full mavlink message. This
  164. is usually the receive buffer for the channel, and allows a reply to an
  165. incoming message with minimum stack space usage.
  166. */
  167. 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)
  168. {
  169. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  170. char *buf = (char *)msgbuf;
  171. _mav_put_uint16_t(buf, 0, message_rate);
  172. _mav_put_uint8_t(buf, 2, stream_id);
  173. _mav_put_uint8_t(buf, 3, on_off);
  174. _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);
  175. #else
  176. mavlink_data_stream_t *packet = (mavlink_data_stream_t *)msgbuf;
  177. packet->message_rate = message_rate;
  178. packet->stream_id = stream_id;
  179. packet->on_off = on_off;
  180. _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);
  181. #endif
  182. }
  183. #endif
  184. #endif
  185. // MESSAGE DATA_STREAM UNPACKING
  186. /**
  187. * @brief Get field stream_id from data_stream message
  188. *
  189. * @return The ID of the requested data stream
  190. */
  191. static inline uint8_t mavlink_msg_data_stream_get_stream_id(const mavlink_message_t* msg)
  192. {
  193. return _MAV_RETURN_uint8_t(msg, 2);
  194. }
  195. /**
  196. * @brief Get field message_rate from data_stream message
  197. *
  198. * @return [Hz] The message rate
  199. */
  200. static inline uint16_t mavlink_msg_data_stream_get_message_rate(const mavlink_message_t* msg)
  201. {
  202. return _MAV_RETURN_uint16_t(msg, 0);
  203. }
  204. /**
  205. * @brief Get field on_off from data_stream message
  206. *
  207. * @return 1 stream is enabled, 0 stream is stopped.
  208. */
  209. static inline uint8_t mavlink_msg_data_stream_get_on_off(const mavlink_message_t* msg)
  210. {
  211. return _MAV_RETURN_uint8_t(msg, 3);
  212. }
  213. /**
  214. * @brief Decode a data_stream message into a struct
  215. *
  216. * @param msg The message to decode
  217. * @param data_stream C-struct to decode the message contents into
  218. */
  219. static inline void mavlink_msg_data_stream_decode(const mavlink_message_t* msg, mavlink_data_stream_t* data_stream)
  220. {
  221. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  222. data_stream->message_rate = mavlink_msg_data_stream_get_message_rate(msg);
  223. data_stream->stream_id = mavlink_msg_data_stream_get_stream_id(msg);
  224. data_stream->on_off = mavlink_msg_data_stream_get_on_off(msg);
  225. #else
  226. uint8_t len = msg->len < MAVLINK_MSG_ID_DATA_STREAM_LEN? msg->len : MAVLINK_MSG_ID_DATA_STREAM_LEN;
  227. memset(data_stream, 0, MAVLINK_MSG_ID_DATA_STREAM_LEN);
  228. memcpy(data_stream, _MAV_PAYLOAD(msg), len);
  229. #endif
  230. }