mavlink_msg_param_request_read.h 7.76 KB
Newer Older
James Goppert's avatar
James Goppert committed
1 2 3 4
// MESSAGE PARAM_REQUEST_READ PACKING

#define MAVLINK_MSG_ID_PARAM_REQUEST_READ 20

lm's avatar
lm committed
5
typedef struct __mavlink_param_request_read_t
James Goppert's avatar
James Goppert committed
6
{
lm's avatar
lm committed
7 8 9 10
 int16_t param_index; ///< Parameter index. Send -1 to use the param ID field as identifier
 uint8_t target_system; ///< System ID
 uint8_t target_component; ///< Component ID
 char param_id[16]; ///< Onboard parameter id
James Goppert's avatar
James Goppert committed
11
} mavlink_param_request_read_t;
lm's avatar
lm committed
12 13 14 15

#define MAVLINK_MSG_ID_PARAM_REQUEST_READ_LEN 20
#define MAVLINK_MSG_ID_20_LEN 20

16
#define MAVLINK_MSG_PARAM_REQUEST_READ_FIELD_PARAM_ID_LEN 16
James Goppert's avatar
James Goppert committed
17

lm's avatar
lm committed
18 19 20 21 22 23 24 25 26 27 28
#define MAVLINK_MESSAGE_INFO_PARAM_REQUEST_READ { \
	"PARAM_REQUEST_READ", \
	4, \
	{  { "param_index", MAVLINK_TYPE_INT16_T, 0, 0, offsetof(mavlink_param_request_read_t, param_index) }, \
         { "target_system", MAVLINK_TYPE_UINT8_T, 0, 2, offsetof(mavlink_param_request_read_t, target_system) }, \
         { "target_component", MAVLINK_TYPE_UINT8_T, 0, 3, offsetof(mavlink_param_request_read_t, target_component) }, \
         { "param_id", MAVLINK_TYPE_CHAR, 16, 4, offsetof(mavlink_param_request_read_t, param_id) }, \
         } \
}


James Goppert's avatar
James Goppert committed
29 30 31 32 33 34 35 36 37 38 39 40
/**
 * @brief Pack a param_request_read message
 * @param system_id ID of this system
 * @param component_id ID of this component (e.g. 200 for IMU)
 * @param msg The MAVLink message to compress the data into
 *
 * @param target_system System ID
 * @param target_component Component ID
 * @param param_id Onboard parameter id
 * @param param_index Parameter index. Send -1 to use the param ID field as identifier
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
41 42
static inline uint16_t mavlink_msg_param_request_read_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
						       uint8_t target_system, uint8_t target_component, const char *param_id, int16_t param_index)
James Goppert's avatar
James Goppert committed
43 44 45
{
	msg->msgid = MAVLINK_MSG_ID_PARAM_REQUEST_READ;

lm's avatar
lm committed
46 47 48 49
	put_int16_t_by_index(msg, 0, param_index); // Parameter index. Send -1 to use the param ID field as identifier
	put_uint8_t_by_index(msg, 2, target_system); // System ID
	put_uint8_t_by_index(msg, 3, target_component); // Component ID
	put_char_array_by_index(msg, 4, param_id, 16); // Onboard parameter id
James Goppert's avatar
James Goppert committed
50

lm's avatar
lm committed
51
	return mavlink_finalize_message(msg, system_id, component_id, 20, 214);
James Goppert's avatar
James Goppert committed
52 53 54
}

/**
lm's avatar
lm committed
55
 * @brief Pack a param_request_read message on a channel
James Goppert's avatar
James Goppert committed
56 57 58 59 60 61 62 63 64 65
 * @param system_id ID of this system
 * @param component_id ID of this component (e.g. 200 for IMU)
 * @param chan The MAVLink channel this message was sent over
 * @param msg The MAVLink message to compress the data into
 * @param target_system System ID
 * @param target_component Component ID
 * @param param_id Onboard parameter id
 * @param param_index Parameter index. Send -1 to use the param ID field as identifier
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
static inline uint16_t mavlink_msg_param_request_read_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
							   mavlink_message_t* msg,
						           uint8_t target_system,uint8_t target_component,const char *param_id,int16_t param_index)
{
	msg->msgid = MAVLINK_MSG_ID_PARAM_REQUEST_READ;

	put_int16_t_by_index(msg, 0, param_index); // Parameter index. Send -1 to use the param ID field as identifier
	put_uint8_t_by_index(msg, 2, target_system); // System ID
	put_uint8_t_by_index(msg, 3, target_component); // Component ID
	put_char_array_by_index(msg, 4, param_id, 16); // Onboard parameter id

	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, 20, 214);
}

#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

/**
 * @brief Pack a param_request_read message on a channel and send
 * @param chan The MAVLink channel this message was sent over
 * @param msg The MAVLink message to compress the data into
 * @param target_system System ID
 * @param target_component Component ID
 * @param param_id Onboard parameter id
 * @param param_index Parameter index. Send -1 to use the param ID field as identifier
 */
static inline void mavlink_msg_param_request_read_pack_chan_send(mavlink_channel_t chan,
							   mavlink_message_t* msg,
						           uint8_t target_system,uint8_t target_component,const char *param_id,int16_t param_index)
James Goppert's avatar
James Goppert committed
94 95 96
{
	msg->msgid = MAVLINK_MSG_ID_PARAM_REQUEST_READ;

lm's avatar
lm committed
97 98 99 100
	put_int16_t_by_index(msg, 0, param_index); // Parameter index. Send -1 to use the param ID field as identifier
	put_uint8_t_by_index(msg, 2, target_system); // System ID
	put_uint8_t_by_index(msg, 3, target_component); // Component ID
	put_char_array_by_index(msg, 4, param_id, 16); // Onboard parameter id
James Goppert's avatar
James Goppert committed
101

lm's avatar
lm committed
102
	mavlink_finalize_message_chan_send(msg, chan, 20, 214);
James Goppert's avatar
James Goppert committed
103
}
lm's avatar
lm committed
104 105
#endif // MAVLINK_USE_CONVENIENCE_FUNCTIONS

James Goppert's avatar
James Goppert committed
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128

/**
 * @brief Encode a param_request_read struct into a message
 *
 * @param system_id ID of this system
 * @param component_id ID of this component (e.g. 200 for IMU)
 * @param msg The MAVLink message to compress the data into
 * @param param_request_read C-struct to read the message contents from
 */
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)
{
	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);
}

/**
 * @brief Send a param_request_read message
 * @param chan MAVLink channel to send the message
 *
 * @param target_system System ID
 * @param target_component Component ID
 * @param param_id Onboard parameter id
 * @param param_index Parameter index. Send -1 to use the param ID field as identifier
 */
lm's avatar
lm committed
129 130 131
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

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)
lm's avatar
lm committed
132
{
lm's avatar
lm committed
133 134
	MAVLINK_ALIGNED_MESSAGE(msg, 20);
	mavlink_msg_param_request_read_pack_chan_send(chan, msg, target_system, target_component, param_id, param_index);
James Goppert's avatar
James Goppert committed
135 136 137
}

#endif
lm's avatar
lm committed
138

James Goppert's avatar
James Goppert committed
139 140
// MESSAGE PARAM_REQUEST_READ UNPACKING

lm's avatar
lm committed
141

James Goppert's avatar
James Goppert committed
142 143 144 145 146 147 148
/**
 * @brief Get field target_system from param_request_read message
 *
 * @return System ID
 */
static inline uint8_t mavlink_msg_param_request_read_get_target_system(const mavlink_message_t* msg)
{
lm's avatar
lm committed
149
	return MAVLINK_MSG_RETURN_uint8_t(msg,  2);
James Goppert's avatar
James Goppert committed
150 151 152 153 154 155 156 157 158
}

/**
 * @brief Get field target_component from param_request_read message
 *
 * @return Component ID
 */
static inline uint8_t mavlink_msg_param_request_read_get_target_component(const mavlink_message_t* msg)
{
lm's avatar
lm committed
159
	return MAVLINK_MSG_RETURN_uint8_t(msg,  3);
James Goppert's avatar
James Goppert committed
160 161 162 163 164 165 166
}

/**
 * @brief Get field param_id from param_request_read message
 *
 * @return Onboard parameter id
 */
lm's avatar
lm committed
167
static inline uint16_t mavlink_msg_param_request_read_get_param_id(const mavlink_message_t* msg, char *param_id)
James Goppert's avatar
James Goppert committed
168
{
lm's avatar
lm committed
169
	return MAVLINK_MSG_RETURN_char_array(msg, param_id, 16,  4);
James Goppert's avatar
James Goppert committed
170 171 172 173 174 175 176 177 178
}

/**
 * @brief Get field param_index from param_request_read message
 *
 * @return Parameter index. Send -1 to use the param ID field as identifier
 */
static inline int16_t mavlink_msg_param_request_read_get_param_index(const mavlink_message_t* msg)
{
lm's avatar
lm committed
179
	return MAVLINK_MSG_RETURN_int16_t(msg,  0);
James Goppert's avatar
James Goppert committed
180 181 182 183 184 185 186 187 188 189
}

/**
 * @brief Decode a param_request_read message into a struct
 *
 * @param msg The message to decode
 * @param param_request_read C-struct to decode the message contents into
 */
static inline void mavlink_msg_param_request_read_decode(const mavlink_message_t* msg, mavlink_param_request_read_t* param_request_read)
{
lm's avatar
lm committed
190 191 192 193 194 195 196 197
#if MAVLINK_NEED_BYTE_SWAP
	param_request_read->param_index = mavlink_msg_param_request_read_get_param_index(msg);
	param_request_read->target_system = mavlink_msg_param_request_read_get_target_system(msg);
	param_request_read->target_component = mavlink_msg_param_request_read_get_target_component(msg);
	mavlink_msg_param_request_read_get_param_id(msg, param_request_read->param_id);
#else
	memcpy(param_request_read, MAVLINK_PAYLOAD(msg), 20);
#endif
James Goppert's avatar
James Goppert committed
198
}