mavlink_msg_param_request_read.h
Go to the documentation of this file.
1 // MESSAGE PARAM_REQUEST_READ PACKING
2 
3 #define MAVLINK_MSG_ID_PARAM_REQUEST_READ 20
4 
6 {
7  int16_t param_index; /*< Parameter index. Send -1 to use the param ID field as identifier (else the param id will be ignored)*/
8  uint8_t target_system; /*< System ID*/
9  uint8_t target_component; /*< Component ID*/
10  char param_id[16]; /*< Onboard 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*/
12 
13 #define MAVLINK_MSG_ID_PARAM_REQUEST_READ_LEN 20
14 #define MAVLINK_MSG_ID_20_LEN 20
15 
16 #define MAVLINK_MSG_ID_PARAM_REQUEST_READ_CRC 214
17 #define MAVLINK_MSG_ID_20_CRC 214
18 
19 #define MAVLINK_MSG_PARAM_REQUEST_READ_FIELD_PARAM_ID_LEN 16
20 
21 #define MAVLINK_MESSAGE_INFO_PARAM_REQUEST_READ { \
22  "PARAM_REQUEST_READ", \
23  4, \
24  { { "param_index", NULL, MAVLINK_TYPE_INT16_T, 0, 0, offsetof(mavlink_param_request_read_t, param_index) }, \
25  { "target_system", NULL, MAVLINK_TYPE_UINT8_T, 0, 2, offsetof(mavlink_param_request_read_t, target_system) }, \
26  { "target_component", NULL, MAVLINK_TYPE_UINT8_T, 0, 3, offsetof(mavlink_param_request_read_t, target_component) }, \
27  { "param_id", NULL, MAVLINK_TYPE_CHAR, 16, 4, offsetof(mavlink_param_request_read_t, param_id) }, \
28  } \
29 }
30 
31 
44 static inline uint16_t mavlink_msg_param_request_read_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
45  uint8_t target_system, uint8_t target_component, const char *param_id, int16_t param_index)
46 {
47 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
49  _mav_put_int16_t(buf, 0, param_index);
50  _mav_put_uint8_t(buf, 2, target_system);
51  _mav_put_uint8_t(buf, 3, target_component);
52  _mav_put_char_array(buf, 4, param_id, 16);
54 #else
56  packet.param_index = param_index;
59  mav_array_memcpy(packet.param_id, param_id, sizeof(char)*16);
61 #endif
62 
64 #if MAVLINK_CRC_EXTRA
66 #else
67  return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_PARAM_REQUEST_READ_LEN);
68 #endif
69 }
70 
83 static inline uint16_t mavlink_msg_param_request_read_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
84  mavlink_message_t* msg,
85  uint8_t target_system,uint8_t target_component,const char *param_id,int16_t param_index)
86 {
87 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
89  _mav_put_int16_t(buf, 0, param_index);
90  _mav_put_uint8_t(buf, 2, target_system);
91  _mav_put_uint8_t(buf, 3, target_component);
92  _mav_put_char_array(buf, 4, param_id, 16);
94 #else
96  packet.param_index = param_index;
99  mav_array_memcpy(packet.param_id, param_id, sizeof(char)*16);
101 #endif
102 
104 #if MAVLINK_CRC_EXTRA
106 #else
107  return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_PARAM_REQUEST_READ_LEN);
108 #endif
109 }
110 
119 static inline uint16_t mavlink_msg_param_request_read_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_param_request_read_t* param_request_read)
120 {
121  return mavlink_msg_param_request_read_pack(system_id, component_id, msg, param_request_read->target_system, param_request_read->target_component, param_request_read->param_id, param_request_read->param_index);
122 }
123 
133 static inline uint16_t mavlink_msg_param_request_read_encode_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const mavlink_param_request_read_t* param_request_read)
134 {
135  return mavlink_msg_param_request_read_pack_chan(system_id, component_id, chan, msg, param_request_read->target_system, param_request_read->target_component, param_request_read->param_id, param_request_read->param_index);
136 }
137 
147 #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
148 
149 static inline void mavlink_msg_param_request_read_send(mavlink_channel_t chan, uint8_t target_system, uint8_t target_component, const char *param_id, int16_t param_index)
150 {
151 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
153  _mav_put_int16_t(buf, 0, param_index);
156  _mav_put_char_array(buf, 4, param_id, 16);
157 #if MAVLINK_CRC_EXTRA
159 #else
160  _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_PARAM_REQUEST_READ, buf, MAVLINK_MSG_ID_PARAM_REQUEST_READ_LEN);
161 #endif
162 #else
164  packet.param_index = param_index;
165  packet.target_system = target_system;
167  mav_array_memcpy(packet.param_id, param_id, sizeof(char)*16);
168 #if MAVLINK_CRC_EXTRA
169  _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_PARAM_REQUEST_READ, (const char *)&packet, MAVLINK_MSG_ID_PARAM_REQUEST_READ_LEN, MAVLINK_MSG_ID_PARAM_REQUEST_READ_CRC);
170 #else
171  _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_PARAM_REQUEST_READ, (const char *)&packet, MAVLINK_MSG_ID_PARAM_REQUEST_READ_LEN);
172 #endif
173 #endif
174 }
175 
176 #if MAVLINK_MSG_ID_PARAM_REQUEST_READ_LEN <= MAVLINK_MAX_PAYLOAD_LEN
177 /*
178  This varient of _send() can be used to save stack space by re-using
179  memory from the receive buffer. The caller provides a
180  mavlink_message_t which is the size of a full mavlink message. This
181  is usually the receive buffer for the channel, and allows a reply to an
182  incoming message with minimum stack space usage.
183  */
184 static inline void mavlink_msg_param_request_read_send_buf(mavlink_message_t *msgbuf, mavlink_channel_t chan, uint8_t target_system, uint8_t target_component, const char *param_id, int16_t param_index)
185 {
186 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
187  char *buf = (char *)msgbuf;
188  _mav_put_int16_t(buf, 0, param_index);
191  _mav_put_char_array(buf, 4, param_id, 16);
192 #if MAVLINK_CRC_EXTRA
194 #else
195  _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_PARAM_REQUEST_READ, buf, MAVLINK_MSG_ID_PARAM_REQUEST_READ_LEN);
196 #endif
197 #else
199  packet->param_index = param_index;
200  packet->target_system = target_system;
202  mav_array_memcpy(packet->param_id, param_id, sizeof(char)*16);
203 #if MAVLINK_CRC_EXTRA
204  _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_PARAM_REQUEST_READ, (const char *)packet, MAVLINK_MSG_ID_PARAM_REQUEST_READ_LEN, MAVLINK_MSG_ID_PARAM_REQUEST_READ_CRC);
205 #else
206  _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_PARAM_REQUEST_READ, (const char *)packet, MAVLINK_MSG_ID_PARAM_REQUEST_READ_LEN);
207 #endif
208 #endif
209 }
210 #endif
211 
212 #endif
213 
214 // MESSAGE PARAM_REQUEST_READ UNPACKING
215 
216 
222 static inline uint8_t mavlink_msg_param_request_read_get_target_system(const mavlink_message_t* msg)
223 {
224  return _MAV_RETURN_uint8_t(msg, 2);
225 }
226 
232 static inline uint8_t mavlink_msg_param_request_read_get_target_component(const mavlink_message_t* msg)
233 {
234  return _MAV_RETURN_uint8_t(msg, 3);
235 }
236 
242 static inline uint16_t mavlink_msg_param_request_read_get_param_id(const mavlink_message_t* msg, char *param_id)
243 {
244  return _MAV_RETURN_char_array(msg, param_id, 16, 4);
245 }
246 
252 static inline int16_t mavlink_msg_param_request_read_get_param_index(const mavlink_message_t* msg)
253 {
254  return _MAV_RETURN_int16_t(msg, 0);
255 }
256 
263 static inline void mavlink_msg_param_request_read_decode(const mavlink_message_t* msg, mavlink_param_request_read_t* param_request_read)
264 {
265 #if MAVLINK_NEED_BYTE_SWAP
269  mavlink_msg_param_request_read_get_param_id(msg, param_request_read->param_id);
270 #else
271  memcpy(param_request_read, _MAV_PAYLOAD(msg), MAVLINK_MSG_ID_PARAM_REQUEST_READ_LEN);
272 #endif
273 }
#define _MAV_RETURN_uint8_t(msg, wire_offset)
Definition: protocol.h:244
#define _mav_put_uint8_t(buf, wire_offset, b)
Definition: protocol.h:140
static void mav_array_memcpy(void *dest, const void *src, size_t n)
Definition: protocol.h:176
static uint16_t _MAV_RETURN_char_array(const mavlink_message_t *msg, char *value, uint8_t array_length, uint8_t wire_offset)
Definition: protocol.h:288
static void _mav_put_char_array(char *buf, uint8_t wire_offset, const char *b, uint8_t array_length)
Definition: protocol.h:188
#define _mav_put_int16_t(buf, wire_offset, b)
Definition: protocol.h:146


rosflight_firmware
Author(s): Daniel Koch , James Jackson
autogenerated on Thu Apr 15 2021 05:07:47