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