Merge remote-tracking branch 'upstream/master' into abo_fw_alt_vel_control
[inav.git] / lib / main / MAVLink / common / mavlink_msg_param_ext_set.h
blobbb4c7ccf0499dfe3c1d2d879bd09a3b08f4a1d67
1 #pragma once
2 // MESSAGE PARAM_EXT_SET PACKING
4 #define MAVLINK_MSG_ID_PARAM_EXT_SET 323
7 typedef struct __mavlink_param_ext_set_t {
8 uint8_t target_system; /*< System ID*/
9 uint8_t target_component; /*< Component ID*/
10 char param_id[16]; /*< Parameter id, terminated by NULL if the length is less than 16 human-readable chars and WITHOUT null termination (NULL) byte if the length is exactly 16 chars - applications have to provide 16+1 bytes storage if the ID is stored as string*/
11 char param_value[128]; /*< Parameter value*/
12 uint8_t param_type; /*< Parameter type.*/
13 } mavlink_param_ext_set_t;
15 #define MAVLINK_MSG_ID_PARAM_EXT_SET_LEN 147
16 #define MAVLINK_MSG_ID_PARAM_EXT_SET_MIN_LEN 147
17 #define MAVLINK_MSG_ID_323_LEN 147
18 #define MAVLINK_MSG_ID_323_MIN_LEN 147
20 #define MAVLINK_MSG_ID_PARAM_EXT_SET_CRC 78
21 #define MAVLINK_MSG_ID_323_CRC 78
23 #define MAVLINK_MSG_PARAM_EXT_SET_FIELD_PARAM_ID_LEN 16
24 #define MAVLINK_MSG_PARAM_EXT_SET_FIELD_PARAM_VALUE_LEN 128
26 #if MAVLINK_COMMAND_24BIT
27 #define MAVLINK_MESSAGE_INFO_PARAM_EXT_SET { \
28 323, \
29 "PARAM_EXT_SET", \
30 5, \
31 { { "target_system", NULL, MAVLINK_TYPE_UINT8_T, 0, 0, offsetof(mavlink_param_ext_set_t, target_system) }, \
32 { "target_component", NULL, MAVLINK_TYPE_UINT8_T, 0, 1, offsetof(mavlink_param_ext_set_t, target_component) }, \
33 { "param_id", NULL, MAVLINK_TYPE_CHAR, 16, 2, offsetof(mavlink_param_ext_set_t, param_id) }, \
34 { "param_value", NULL, MAVLINK_TYPE_CHAR, 128, 18, offsetof(mavlink_param_ext_set_t, param_value) }, \
35 { "param_type", NULL, MAVLINK_TYPE_UINT8_T, 0, 146, offsetof(mavlink_param_ext_set_t, param_type) }, \
36 } \
38 #else
39 #define MAVLINK_MESSAGE_INFO_PARAM_EXT_SET { \
40 "PARAM_EXT_SET", \
41 5, \
42 { { "target_system", NULL, MAVLINK_TYPE_UINT8_T, 0, 0, offsetof(mavlink_param_ext_set_t, target_system) }, \
43 { "target_component", NULL, MAVLINK_TYPE_UINT8_T, 0, 1, offsetof(mavlink_param_ext_set_t, target_component) }, \
44 { "param_id", NULL, MAVLINK_TYPE_CHAR, 16, 2, offsetof(mavlink_param_ext_set_t, param_id) }, \
45 { "param_value", NULL, MAVLINK_TYPE_CHAR, 128, 18, offsetof(mavlink_param_ext_set_t, param_value) }, \
46 { "param_type", NULL, MAVLINK_TYPE_UINT8_T, 0, 146, offsetof(mavlink_param_ext_set_t, param_type) }, \
47 } \
49 #endif
51 /**
52 * @brief Pack a param_ext_set message
53 * @param system_id ID of this system
54 * @param component_id ID of this component (e.g. 200 for IMU)
55 * @param msg The MAVLink message to compress the data into
57 * @param target_system System ID
58 * @param target_component Component ID
59 * @param param_id Parameter id, terminated by NULL if the length is less than 16 human-readable chars and WITHOUT null termination (NULL) byte if the length is exactly 16 chars - applications have to provide 16+1 bytes storage if the ID is stored as string
60 * @param param_value Parameter value
61 * @param param_type Parameter type.
62 * @return length of the message in bytes (excluding serial stream start sign)
64 static inline uint16_t mavlink_msg_param_ext_set_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
65 uint8_t target_system, uint8_t target_component, const char *param_id, const char *param_value, uint8_t param_type)
67 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
68 char buf[MAVLINK_MSG_ID_PARAM_EXT_SET_LEN];
69 _mav_put_uint8_t(buf, 0, target_system);
70 _mav_put_uint8_t(buf, 1, target_component);
71 _mav_put_uint8_t(buf, 146, param_type);
72 _mav_put_char_array(buf, 2, param_id, 16);
73 _mav_put_char_array(buf, 18, param_value, 128);
74 memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_PARAM_EXT_SET_LEN);
75 #else
76 mavlink_param_ext_set_t packet;
77 packet.target_system = target_system;
78 packet.target_component = target_component;
79 packet.param_type = param_type;
80 mav_array_memcpy(packet.param_id, param_id, sizeof(char)*16);
81 mav_array_memcpy(packet.param_value, param_value, sizeof(char)*128);
82 memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_PARAM_EXT_SET_LEN);
83 #endif
85 msg->msgid = MAVLINK_MSG_ID_PARAM_EXT_SET;
86 return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_PARAM_EXT_SET_MIN_LEN, MAVLINK_MSG_ID_PARAM_EXT_SET_LEN, MAVLINK_MSG_ID_PARAM_EXT_SET_CRC);
89 /**
90 * @brief Pack a param_ext_set message on a channel
91 * @param system_id ID of this system
92 * @param component_id ID of this component (e.g. 200 for IMU)
93 * @param chan The MAVLink channel this message will be sent over
94 * @param msg The MAVLink message to compress the data into
95 * @param target_system System ID
96 * @param target_component Component ID
97 * @param param_id Parameter id, terminated by NULL if the length is less than 16 human-readable chars and WITHOUT null termination (NULL) byte if the length is exactly 16 chars - applications have to provide 16+1 bytes storage if the ID is stored as string
98 * @param param_value Parameter value
99 * @param param_type Parameter type.
100 * @return length of the message in bytes (excluding serial stream start sign)
102 static inline uint16_t mavlink_msg_param_ext_set_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
103 mavlink_message_t* msg,
104 uint8_t target_system,uint8_t target_component,const char *param_id,const char *param_value,uint8_t param_type)
106 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
107 char buf[MAVLINK_MSG_ID_PARAM_EXT_SET_LEN];
108 _mav_put_uint8_t(buf, 0, target_system);
109 _mav_put_uint8_t(buf, 1, target_component);
110 _mav_put_uint8_t(buf, 146, param_type);
111 _mav_put_char_array(buf, 2, param_id, 16);
112 _mav_put_char_array(buf, 18, param_value, 128);
113 memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_PARAM_EXT_SET_LEN);
114 #else
115 mavlink_param_ext_set_t packet;
116 packet.target_system = target_system;
117 packet.target_component = target_component;
118 packet.param_type = param_type;
119 mav_array_memcpy(packet.param_id, param_id, sizeof(char)*16);
120 mav_array_memcpy(packet.param_value, param_value, sizeof(char)*128);
121 memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_PARAM_EXT_SET_LEN);
122 #endif
124 msg->msgid = MAVLINK_MSG_ID_PARAM_EXT_SET;
125 return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_PARAM_EXT_SET_MIN_LEN, MAVLINK_MSG_ID_PARAM_EXT_SET_LEN, MAVLINK_MSG_ID_PARAM_EXT_SET_CRC);
129 * @brief Encode a param_ext_set struct
131 * @param system_id ID of this system
132 * @param component_id ID of this component (e.g. 200 for IMU)
133 * @param msg The MAVLink message to compress the data into
134 * @param param_ext_set C-struct to read the message contents from
136 static inline uint16_t mavlink_msg_param_ext_set_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_param_ext_set_t* param_ext_set)
138 return mavlink_msg_param_ext_set_pack(system_id, component_id, msg, param_ext_set->target_system, param_ext_set->target_component, param_ext_set->param_id, param_ext_set->param_value, param_ext_set->param_type);
142 * @brief Encode a param_ext_set struct on a channel
144 * @param system_id ID of this system
145 * @param component_id ID of this component (e.g. 200 for IMU)
146 * @param chan The MAVLink channel this message will be sent over
147 * @param msg The MAVLink message to compress the data into
148 * @param param_ext_set C-struct to read the message contents from
150 static inline uint16_t mavlink_msg_param_ext_set_encode_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const mavlink_param_ext_set_t* param_ext_set)
152 return mavlink_msg_param_ext_set_pack_chan(system_id, component_id, chan, msg, param_ext_set->target_system, param_ext_set->target_component, param_ext_set->param_id, param_ext_set->param_value, param_ext_set->param_type);
156 * @brief Send a param_ext_set message
157 * @param chan MAVLink channel to send the message
159 * @param target_system System ID
160 * @param target_component Component ID
161 * @param param_id Parameter id, terminated by NULL if the length is less than 16 human-readable chars and WITHOUT null termination (NULL) byte if the length is exactly 16 chars - applications have to provide 16+1 bytes storage if the ID is stored as string
162 * @param param_value Parameter value
163 * @param param_type Parameter type.
165 #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
167 static inline void mavlink_msg_param_ext_set_send(mavlink_channel_t chan, uint8_t target_system, uint8_t target_component, const char *param_id, const char *param_value, uint8_t param_type)
169 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
170 char buf[MAVLINK_MSG_ID_PARAM_EXT_SET_LEN];
171 _mav_put_uint8_t(buf, 0, target_system);
172 _mav_put_uint8_t(buf, 1, target_component);
173 _mav_put_uint8_t(buf, 146, param_type);
174 _mav_put_char_array(buf, 2, param_id, 16);
175 _mav_put_char_array(buf, 18, param_value, 128);
176 _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_PARAM_EXT_SET, buf, MAVLINK_MSG_ID_PARAM_EXT_SET_MIN_LEN, MAVLINK_MSG_ID_PARAM_EXT_SET_LEN, MAVLINK_MSG_ID_PARAM_EXT_SET_CRC);
177 #else
178 mavlink_param_ext_set_t packet;
179 packet.target_system = target_system;
180 packet.target_component = target_component;
181 packet.param_type = param_type;
182 mav_array_memcpy(packet.param_id, param_id, sizeof(char)*16);
183 mav_array_memcpy(packet.param_value, param_value, sizeof(char)*128);
184 _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_PARAM_EXT_SET, (const char *)&packet, MAVLINK_MSG_ID_PARAM_EXT_SET_MIN_LEN, MAVLINK_MSG_ID_PARAM_EXT_SET_LEN, MAVLINK_MSG_ID_PARAM_EXT_SET_CRC);
185 #endif
189 * @brief Send a param_ext_set message
190 * @param chan MAVLink channel to send the message
191 * @param struct The MAVLink struct to serialize
193 static inline void mavlink_msg_param_ext_set_send_struct(mavlink_channel_t chan, const mavlink_param_ext_set_t* param_ext_set)
195 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
196 mavlink_msg_param_ext_set_send(chan, param_ext_set->target_system, param_ext_set->target_component, param_ext_set->param_id, param_ext_set->param_value, param_ext_set->param_type);
197 #else
198 _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_PARAM_EXT_SET, (const char *)param_ext_set, MAVLINK_MSG_ID_PARAM_EXT_SET_MIN_LEN, MAVLINK_MSG_ID_PARAM_EXT_SET_LEN, MAVLINK_MSG_ID_PARAM_EXT_SET_CRC);
199 #endif
202 #if MAVLINK_MSG_ID_PARAM_EXT_SET_LEN <= MAVLINK_MAX_PAYLOAD_LEN
204 This varient of _send() can be used to save stack space by re-using
205 memory from the receive buffer. The caller provides a
206 mavlink_message_t which is the size of a full mavlink message. This
207 is usually the receive buffer for the channel, and allows a reply to an
208 incoming message with minimum stack space usage.
210 static inline void mavlink_msg_param_ext_set_send_buf(mavlink_message_t *msgbuf, mavlink_channel_t chan, uint8_t target_system, uint8_t target_component, const char *param_id, const char *param_value, uint8_t param_type)
212 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
213 char *buf = (char *)msgbuf;
214 _mav_put_uint8_t(buf, 0, target_system);
215 _mav_put_uint8_t(buf, 1, target_component);
216 _mav_put_uint8_t(buf, 146, param_type);
217 _mav_put_char_array(buf, 2, param_id, 16);
218 _mav_put_char_array(buf, 18, param_value, 128);
219 _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_PARAM_EXT_SET, buf, MAVLINK_MSG_ID_PARAM_EXT_SET_MIN_LEN, MAVLINK_MSG_ID_PARAM_EXT_SET_LEN, MAVLINK_MSG_ID_PARAM_EXT_SET_CRC);
220 #else
221 mavlink_param_ext_set_t *packet = (mavlink_param_ext_set_t *)msgbuf;
222 packet->target_system = target_system;
223 packet->target_component = target_component;
224 packet->param_type = param_type;
225 mav_array_memcpy(packet->param_id, param_id, sizeof(char)*16);
226 mav_array_memcpy(packet->param_value, param_value, sizeof(char)*128);
227 _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_PARAM_EXT_SET, (const char *)packet, MAVLINK_MSG_ID_PARAM_EXT_SET_MIN_LEN, MAVLINK_MSG_ID_PARAM_EXT_SET_LEN, MAVLINK_MSG_ID_PARAM_EXT_SET_CRC);
228 #endif
230 #endif
232 #endif
234 // MESSAGE PARAM_EXT_SET UNPACKING
238 * @brief Get field target_system from param_ext_set message
240 * @return System ID
242 static inline uint8_t mavlink_msg_param_ext_set_get_target_system(const mavlink_message_t* msg)
244 return _MAV_RETURN_uint8_t(msg, 0);
248 * @brief Get field target_component from param_ext_set message
250 * @return Component ID
252 static inline uint8_t mavlink_msg_param_ext_set_get_target_component(const mavlink_message_t* msg)
254 return _MAV_RETURN_uint8_t(msg, 1);
258 * @brief Get field param_id from param_ext_set message
260 * @return Parameter id, terminated by NULL if the length is less than 16 human-readable chars and WITHOUT null termination (NULL) byte if the length is exactly 16 chars - applications have to provide 16+1 bytes storage if the ID is stored as string
262 static inline uint16_t mavlink_msg_param_ext_set_get_param_id(const mavlink_message_t* msg, char *param_id)
264 return _MAV_RETURN_char_array(msg, param_id, 16, 2);
268 * @brief Get field param_value from param_ext_set message
270 * @return Parameter value
272 static inline uint16_t mavlink_msg_param_ext_set_get_param_value(const mavlink_message_t* msg, char *param_value)
274 return _MAV_RETURN_char_array(msg, param_value, 128, 18);
278 * @brief Get field param_type from param_ext_set message
280 * @return Parameter type.
282 static inline uint8_t mavlink_msg_param_ext_set_get_param_type(const mavlink_message_t* msg)
284 return _MAV_RETURN_uint8_t(msg, 146);
288 * @brief Decode a param_ext_set message into a struct
290 * @param msg The message to decode
291 * @param param_ext_set C-struct to decode the message contents into
293 static inline void mavlink_msg_param_ext_set_decode(const mavlink_message_t* msg, mavlink_param_ext_set_t* param_ext_set)
295 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
296 param_ext_set->target_system = mavlink_msg_param_ext_set_get_target_system(msg);
297 param_ext_set->target_component = mavlink_msg_param_ext_set_get_target_component(msg);
298 mavlink_msg_param_ext_set_get_param_id(msg, param_ext_set->param_id);
299 mavlink_msg_param_ext_set_get_param_value(msg, param_ext_set->param_value);
300 param_ext_set->param_type = mavlink_msg_param_ext_set_get_param_type(msg);
301 #else
302 uint8_t len = msg->len < MAVLINK_MSG_ID_PARAM_EXT_SET_LEN? msg->len : MAVLINK_MSG_ID_PARAM_EXT_SET_LEN;
303 memset(param_ext_set, 0, MAVLINK_MSG_ID_PARAM_EXT_SET_LEN);
304 memcpy(param_ext_set, _MAV_PAYLOAD(msg), len);
305 #endif