mavlink_msg_param_value.h 7.98 KB
Newer Older
James Goppert's avatar
James Goppert committed
1 2 3
// MESSAGE PARAM_VALUE PACKING

#define MAVLINK_MSG_ID_PARAM_VALUE 22
lm's avatar
lm committed
4 5
#define MAVLINK_MSG_ID_PARAM_VALUE_LEN 23
#define MAVLINK_MSG_22_LEN 23
James Goppert's avatar
James Goppert committed
6 7 8

typedef struct __mavlink_param_value_t 
{
lm's avatar
lm committed
9
	char param_id[15]; ///< Onboard parameter id
James Goppert's avatar
James Goppert committed
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
	float param_value; ///< Onboard parameter value
	uint16_t param_count; ///< Total number of onboard parameters
	uint16_t param_index; ///< Index of this onboard parameter

} mavlink_param_value_t;
#define MAVLINK_MSG_PARAM_VALUE_FIELD_PARAM_ID_LEN 15

/**
 * @brief Pack a param_value 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_id Onboard parameter id
 * @param param_value Onboard parameter value
 * @param param_count Total number of onboard parameters
 * @param param_index Index of this onboard parameter
 * @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_value_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const char* param_id, float param_value, uint16_t param_count, uint16_t param_index)
James Goppert's avatar
James Goppert committed
30
{
lm's avatar
lm committed
31
	mavlink_param_value_t *p = (mavlink_param_value_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
32 33
	msg->msgid = MAVLINK_MSG_ID_PARAM_VALUE;

lm's avatar
lm committed
34 35 36 37
	memcpy(p->param_id, param_id, sizeof(p->param_id)); // char[15]:Onboard parameter id
	p->param_value = param_value; // float:Onboard parameter value
	p->param_count = param_count; // uint16_t:Total number of onboard parameters
	p->param_index = param_index; // uint16_t:Index of this onboard parameter
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_VALUE_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_value 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 param_id Onboard parameter id
 * @param param_value Onboard parameter value
 * @param param_count Total number of onboard parameters
 * @param param_index Index of this onboard parameter
 * @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_value_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const char* param_id, float param_value, uint16_t param_count, uint16_t param_index)
James Goppert's avatar
James Goppert committed
55
{
lm's avatar
lm committed
56
	mavlink_param_value_t *p = (mavlink_param_value_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
57 58
	msg->msgid = MAVLINK_MSG_ID_PARAM_VALUE;

lm's avatar
lm committed
59 60 61 62
	memcpy(p->param_id, param_id, sizeof(p->param_id)); // char[15]:Onboard parameter id
	p->param_value = param_value; // float:Onboard parameter value
	p->param_count = param_count; // uint16_t:Total number of onboard parameters
	p->param_index = param_index; // uint16_t:Index of this onboard parameter
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_VALUE_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 89
}

/**
 * @brief Encode a param_value 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_value C-struct to read the message contents from
 */
static inline uint16_t mavlink_msg_param_value_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_param_value_t* param_value)
{
	return mavlink_msg_param_value_pack(system_id, component_id, msg, param_value->param_id, param_value->param_value, param_value->param_count, param_value->param_index);
}

/**
 * @brief Send a param_value message
 * @param chan MAVLink channel to send the message
 *
 * @param param_id Onboard parameter id
 * @param param_value Onboard parameter value
 * @param param_count Total number of onboard parameters
 * @param param_index Index of this onboard parameter
 */
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
lm's avatar
lm committed
90
static inline void mavlink_msg_param_value_send(mavlink_channel_t chan, const char* param_id, float param_value, uint16_t param_count, uint16_t param_index)
James Goppert's avatar
James Goppert committed
91 92
{
	mavlink_message_t msg;
lm's avatar
lm committed
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
	uint16_t checksum;
	mavlink_param_value_t *p = (mavlink_param_value_t *)&msg.payload[0];

	memcpy(p->param_id, param_id, sizeof(p->param_id)); // char[15]:Onboard parameter id
	p->param_value = param_value; // float:Onboard parameter value
	p->param_count = param_count; // uint16_t:Total number of onboard parameters
	p->param_index = param_index; // uint16_t:Index of this onboard parameter

	msg.STX = MAVLINK_STX;
	msg.len = MAVLINK_MSG_ID_PARAM_VALUE_LEN;
	msg.msgid = MAVLINK_MSG_ID_PARAM_VALUE;
	msg.sysid = mavlink_system.sysid;
	msg.compid = mavlink_system.compid;
	msg.seq = mavlink_get_channel_status(chan)->current_tx_seq;
	mavlink_get_channel_status(chan)->current_tx_seq = msg.seq + 1;
	checksum = crc_calculate_msg(&msg, msg.len + MAVLINK_CORE_HEADER_LEN);
	msg.ck_a = (uint8_t)(checksum & 0xFF); ///< Low byte
	msg.ck_b = (uint8_t)(checksum >> 8); ///< High byte

	mavlink_send_msg(chan, &msg);
}

#endif

#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS_SMALL
static inline void mavlink_msg_param_value_send(mavlink_channel_t chan, const char* param_id, float param_value, uint16_t param_count, uint16_t param_index)
{
	mavlink_header_t hdr;
	mavlink_param_value_t payload;
	uint16_t checksum;
	mavlink_param_value_t *p = &payload;

	memcpy(p->param_id, param_id, sizeof(p->param_id)); // char[15]:Onboard parameter id
	p->param_value = param_value; // float:Onboard parameter value
	p->param_count = param_count; // uint16_t:Total number of onboard parameters
	p->param_index = param_index; // uint16_t:Index of this onboard parameter

	hdr.STX = MAVLINK_STX;
	hdr.len = MAVLINK_MSG_ID_PARAM_VALUE_LEN;
	hdr.msgid = MAVLINK_MSG_ID_PARAM_VALUE;
	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
147 148 149 150 151 152 153 154 155 156
}

#endif
// MESSAGE PARAM_VALUE UNPACKING

/**
 * @brief Get field param_id from param_value message
 *
 * @return Onboard parameter id
 */
lm's avatar
lm committed
157
static inline uint16_t mavlink_msg_param_value_get_param_id(const mavlink_message_t* msg, char* param_id)
James Goppert's avatar
James Goppert committed
158
{
lm's avatar
lm committed
159
	mavlink_param_value_t *p = (mavlink_param_value_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
160

lm's avatar
lm committed
161 162
	memcpy(param_id, p->param_id, sizeof(p->param_id));
	return sizeof(p->param_id);
James Goppert's avatar
James Goppert committed
163 164 165 166 167 168 169 170 171
}

/**
 * @brief Get field param_value from param_value message
 *
 * @return Onboard parameter value
 */
static inline float mavlink_msg_param_value_get_param_value(const mavlink_message_t* msg)
{
lm's avatar
lm committed
172 173
	mavlink_param_value_t *p = (mavlink_param_value_t *)&msg->payload[0];
	return (float)(p->param_value);
James Goppert's avatar
James Goppert committed
174 175 176 177 178 179 180 181 182
}

/**
 * @brief Get field param_count from param_value message
 *
 * @return Total number of onboard parameters
 */
static inline uint16_t mavlink_msg_param_value_get_param_count(const mavlink_message_t* msg)
{
lm's avatar
lm committed
183 184
	mavlink_param_value_t *p = (mavlink_param_value_t *)&msg->payload[0];
	return (uint16_t)(p->param_count);
James Goppert's avatar
James Goppert committed
185 186 187 188 189 190 191 192 193
}

/**
 * @brief Get field param_index from param_value message
 *
 * @return Index of this onboard parameter
 */
static inline uint16_t mavlink_msg_param_value_get_param_index(const mavlink_message_t* msg)
{
lm's avatar
lm committed
194 195
	mavlink_param_value_t *p = (mavlink_param_value_t *)&msg->payload[0];
	return (uint16_t)(p->param_index);
James Goppert's avatar
James Goppert committed
196 197 198 199 200 201 202 203 204 205
}

/**
 * @brief Decode a param_value message into a struct
 *
 * @param msg The message to decode
 * @param param_value C-struct to decode the message contents into
 */
static inline void mavlink_msg_param_value_decode(const mavlink_message_t* msg, mavlink_param_value_t* param_value)
{
lm's avatar
lm committed
206
	memcpy( param_value, msg->payload, sizeof(mavlink_param_value_t));
James Goppert's avatar
James Goppert committed
207
}