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

#define MAVLINK_MSG_ID_PARAM_REQUEST_READ 20
4 5
#define MAVLINK_MSG_ID_PARAM_REQUEST_READ_LEN 20
#define MAVLINK_MSG_20_LEN 20
James Goppert's avatar
James Goppert committed
6 7 8

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

} mavlink_param_request_read_t;
15
#define MAVLINK_MSG_PARAM_REQUEST_READ_FIELD_PARAM_ID_LEN 16
James Goppert's avatar
James Goppert committed
16 17 18 19 20 21 22 23 24 25 26 27 28

/**
 * @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
29
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
30
{
lm's avatar
lm committed
31
	mavlink_param_request_read_t *p = (mavlink_param_request_read_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
32 33
	msg->msgid = MAVLINK_MSG_ID_PARAM_REQUEST_READ;

lm's avatar
lm committed
34 35
	p->target_system = target_system; // uint8_t:System ID
	p->target_component = target_component; // uint8_t:Component ID
LM's avatar
LM committed
36
	memcpy(p->param_id, param_id, sizeof(p->param_id)); // char[16]:Onboard parameter id
lm's avatar
lm committed
37
	p->param_index = param_index; // int16_t:Parameter index. Send -1 to use the param ID field as identifier
James Goppert's avatar
James Goppert committed
38

lm's avatar
lm committed
39
	return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_PARAM_REQUEST_READ_LEN);
James Goppert's avatar
James Goppert committed
40 41 42 43 44 45 46 47 48 49 50 51 52 53
}

/**
 * @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 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
54
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)
James Goppert's avatar
James Goppert committed
55
{
lm's avatar
lm committed
56
	mavlink_param_request_read_t *p = (mavlink_param_request_read_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
57 58
	msg->msgid = MAVLINK_MSG_ID_PARAM_REQUEST_READ;

lm's avatar
lm committed
59 60
	p->target_system = target_system; // uint8_t:System ID
	p->target_component = target_component; // uint8_t:Component ID
LM's avatar
LM committed
61
	memcpy(p->param_id, param_id, sizeof(p->param_id)); // char[16]:Onboard parameter id
lm's avatar
lm committed
62
	p->param_index = param_index; // int16_t:Parameter index. Send -1 to use the param ID field as identifier
James Goppert's avatar
James Goppert committed
63

lm's avatar
lm committed
64
	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_PARAM_REQUEST_READ_LEN);
James Goppert's avatar
James Goppert committed
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
}

/**
 * @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
89 90


91
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
LM's avatar
LM committed
92
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
93 94 95 96 97 98 99 100
{
	mavlink_header_t hdr;
	mavlink_param_request_read_t payload;
	uint16_t checksum;
	mavlink_param_request_read_t *p = &payload;

	p->target_system = target_system; // uint8_t:System ID
	p->target_component = target_component; // uint8_t:Component ID
LM's avatar
LM committed
101
	memcpy(p->param_id, param_id, sizeof(p->param_id)); // char[16]:Onboard parameter id
lm's avatar
lm committed
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
	p->param_index = param_index; // int16_t:Parameter index. Send -1 to use the param ID field as identifier

	hdr.STX = MAVLINK_STX;
	hdr.len = MAVLINK_MSG_ID_PARAM_REQUEST_READ_LEN;
	hdr.msgid = MAVLINK_MSG_ID_PARAM_REQUEST_READ;
	hdr.sysid = mavlink_system.sysid;
	hdr.compid = mavlink_system.compid;
	hdr.seq = mavlink_get_channel_status(chan)->current_tx_seq;
	mavlink_get_channel_status(chan)->current_tx_seq = hdr.seq + 1;
	mavlink_send_mem(chan, (uint8_t *)&hdr.STX, MAVLINK_NUM_HEADER_BYTES );

	crc_init(&checksum);
	checksum = crc_calculate_mem((uint8_t *)&hdr.len, &checksum, MAVLINK_CORE_HEADER_LEN);
	checksum = crc_calculate_mem((uint8_t *)&payload, &checksum, hdr.len );
	hdr.ck_a = (uint8_t)(checksum & 0xFF); ///< Low byte
	hdr.ck_b = (uint8_t)(checksum >> 8); ///< High byte

	mavlink_send_mem(chan, (uint8_t *)&payload, hdr.len);
	mavlink_send_mem(chan, (uint8_t *)&hdr.ck_a, MAVLINK_NUM_CHECKSUM_BYTES);
James Goppert's avatar
James Goppert committed
121 122 123 124 125 126 127 128 129 130 131 132
}

#endif
// MESSAGE PARAM_REQUEST_READ UNPACKING

/**
 * @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
133 134
	mavlink_param_request_read_t *p = (mavlink_param_request_read_t *)&msg->payload[0];
	return (uint8_t)(p->target_system);
James Goppert's avatar
James Goppert committed
135 136 137 138 139 140 141 142 143
}

/**
 * @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
144 145
	mavlink_param_request_read_t *p = (mavlink_param_request_read_t *)&msg->payload[0];
	return (uint8_t)(p->target_component);
James Goppert's avatar
James Goppert committed
146 147 148 149 150 151 152
}

/**
 * @brief Get field param_id from param_request_read message
 *
 * @return Onboard parameter id
 */
LM's avatar
LM committed
153
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
154
{
lm's avatar
lm committed
155
	mavlink_param_request_read_t *p = (mavlink_param_request_read_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
156

lm's avatar
lm committed
157 158
	memcpy(param_id, p->param_id, sizeof(p->param_id));
	return sizeof(p->param_id);
James Goppert's avatar
James Goppert committed
159 160 161 162 163 164 165 166 167
}

/**
 * @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
168 169
	mavlink_param_request_read_t *p = (mavlink_param_request_read_t *)&msg->payload[0];
	return (int16_t)(p->param_index);
James Goppert's avatar
James Goppert committed
170 171 172 173 174 175 176 177 178 179
}

/**
 * @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
180
	memcpy( param_request_read, msg->payload, sizeof(mavlink_param_request_read_t));
James Goppert's avatar
James Goppert committed
181
}