mavlink_msg_play_tune.h 11 KB

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