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

#define MAVLINK_MSG_ID_PARAM_VALUE 22
4 5 6 7
#define MAVLINK_MSG_ID_PARAM_VALUE_LEN 25
#define MAVLINK_MSG_22_LEN 25
#define MAVLINK_MSG_ID_PARAM_VALUE_KEY 0xBF
#define MAVLINK_MSG_22_KEY 0xBF
James Goppert's avatar
James Goppert committed
8 9 10

typedef struct __mavlink_param_value_t 
{
lm's avatar
lm committed
11 12 13 14
	float param_value;	///< Onboard parameter value
	uint16_t param_count;	///< Total number of onboard parameters
	uint16_t param_index;	///< Index of this onboard parameter
	char param_id[16];	///< Onboard parameter id
15
	uint8_t param_type;	///< Onboard parameter type: 0: float, 1: uint8_t, 2: int8_t, 3: uint16_t, 4: int16_t, 5: uint32_t, 6: int32_t
James Goppert's avatar
James Goppert committed
16 17

} mavlink_param_value_t;
18
#define MAVLINK_MSG_PARAM_VALUE_FIELD_PARAM_ID_LEN 16
James Goppert's avatar
James Goppert committed
19 20 21 22 23 24 25 26 27

/**
 * @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
28
 * @param param_type Onboard parameter type: 0: float, 1: uint8_t, 2: int8_t, 3: uint16_t, 4: int16_t, 5: uint32_t, 6: int32_t
James Goppert's avatar
James Goppert committed
29 30 31 32
 * @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)
 */
33
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, uint8_t param_type, uint16_t param_count, uint16_t param_index)
James Goppert's avatar
James Goppert committed
34
{
lm's avatar
lm committed
35
	mavlink_param_value_t *p = (mavlink_param_value_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
36 37
	msg->msgid = MAVLINK_MSG_ID_PARAM_VALUE;

lm's avatar
lm committed
38 39
	memcpy(p->param_id, param_id, sizeof(p->param_id));	// char[16]:Onboard parameter id
	p->param_value = param_value;	// float:Onboard parameter value
40
	p->param_type = param_type;	// uint8_t:Onboard parameter type: 0: float, 1: uint8_t, 2: int8_t, 3: uint16_t, 4: int16_t, 5: uint32_t, 6: int32_t
lm's avatar
lm committed
41 42
	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
43

lm's avatar
lm committed
44
	return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_PARAM_VALUE_LEN);
James Goppert's avatar
James Goppert committed
45 46 47 48 49 50 51 52 53 54
}

/**
 * @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
55
 * @param param_type Onboard parameter type: 0: float, 1: uint8_t, 2: int8_t, 3: uint16_t, 4: int16_t, 5: uint32_t, 6: int32_t
James Goppert's avatar
James Goppert committed
56 57 58 59
 * @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)
 */
60
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, uint8_t param_type, uint16_t param_count, uint16_t param_index)
James Goppert's avatar
James Goppert committed
61
{
lm's avatar
lm committed
62
	mavlink_param_value_t *p = (mavlink_param_value_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
63 64
	msg->msgid = MAVLINK_MSG_ID_PARAM_VALUE;

lm's avatar
lm committed
65 66
	memcpy(p->param_id, param_id, sizeof(p->param_id));	// char[16]:Onboard parameter id
	p->param_value = param_value;	// float:Onboard parameter value
67
	p->param_type = param_type;	// uint8_t:Onboard parameter type: 0: float, 1: uint8_t, 2: int8_t, 3: uint16_t, 4: int16_t, 5: uint32_t, 6: int32_t
lm's avatar
lm committed
68 69
	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
70

lm's avatar
lm committed
71
	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_PARAM_VALUE_LEN);
James Goppert's avatar
James Goppert committed
72 73 74 75 76 77 78 79 80 81 82 83
}

/**
 * @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)
{
84
	return mavlink_msg_param_value_pack(system_id, component_id, msg, param_value->param_id, param_value->param_value, param_value->param_type, param_value->param_count, param_value->param_index);
James Goppert's avatar
James Goppert committed
85 86
}

lm's avatar
lm committed
87 88

#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
James Goppert's avatar
James Goppert committed
89 90 91 92 93 94
/**
 * @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
95
 * @param param_type Onboard parameter type: 0: float, 1: uint8_t, 2: int8_t, 3: uint16_t, 4: int16_t, 5: uint32_t, 6: int32_t
James Goppert's avatar
James Goppert committed
96 97 98
 * @param param_count Total number of onboard parameters
 * @param param_index Index of this onboard parameter
 */
99
static inline void mavlink_msg_param_value_send(mavlink_channel_t chan, const char* param_id, float param_value, uint8_t param_type, uint16_t param_count, uint16_t param_index)
lm's avatar
lm committed
100 101 102 103
{
	mavlink_header_t hdr;
	mavlink_param_value_t payload;

lm's avatar
lm committed
104 105 106
	MAVLINK_BUFFER_CHECK_START( chan, MAVLINK_MSG_ID_PARAM_VALUE_LEN )
	memcpy(payload.param_id, param_id, sizeof(payload.param_id));	// char[16]:Onboard parameter id
	payload.param_value = param_value;	// float:Onboard parameter value
107
	payload.param_type = param_type;	// uint8_t:Onboard parameter type: 0: float, 1: uint8_t, 2: int8_t, 3: uint16_t, 4: int16_t, 5: uint32_t, 6: int32_t
lm's avatar
lm committed
108 109
	payload.param_count = param_count;	// uint16_t:Total number of onboard parameters
	payload.param_index = param_index;	// uint16_t:Index of this onboard parameter
lm's avatar
lm committed
110 111 112 113 114 115 116 117 118

	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 );
119
	mavlink_send_mem(chan, (uint8_t *)&payload, sizeof(payload) );
lm's avatar
lm committed
120

lm's avatar
lm committed
121 122 123
	crc_init(&hdr.ck);
	crc_calculate_mem((uint8_t *)&hdr.len, &hdr.ck, MAVLINK_CORE_HEADER_LEN);
	crc_calculate_mem((uint8_t *)&payload, &hdr.ck, hdr.len );
124
	crc_accumulate( 0xBF, &hdr.ck); /// include key in X25 checksum
lm's avatar
lm committed
125 126
	mavlink_send_mem(chan, (uint8_t *)&hdr.ck, MAVLINK_NUM_CHECKSUM_BYTES);
	MAVLINK_BUFFER_CHECK_END
James Goppert's avatar
James Goppert committed
127 128 129 130 131 132 133 134 135 136
}

#endif
// MESSAGE PARAM_VALUE UNPACKING

/**
 * @brief Get field param_id from param_value message
 *
 * @return Onboard parameter id
 */
LM's avatar
LM committed
137
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
138
{
lm's avatar
lm committed
139
	mavlink_param_value_t *p = (mavlink_param_value_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
140

lm's avatar
lm committed
141 142
	memcpy(param_id, p->param_id, sizeof(p->param_id));
	return sizeof(p->param_id);
James Goppert's avatar
James Goppert committed
143 144 145 146 147 148 149 150 151
}

/**
 * @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
152 153
	mavlink_param_value_t *p = (mavlink_param_value_t *)&msg->payload[0];
	return (float)(p->param_value);
James Goppert's avatar
James Goppert committed
154 155
}

156 157 158 159 160 161 162 163 164 165 166
/**
 * @brief Get field param_type from param_value message
 *
 * @return Onboard parameter type: 0: float, 1: uint8_t, 2: int8_t, 3: uint16_t, 4: int16_t, 5: uint32_t, 6: int32_t
 */
static inline uint8_t mavlink_msg_param_value_get_param_type(const mavlink_message_t* msg)
{
	mavlink_param_value_t *p = (mavlink_param_value_t *)&msg->payload[0];
	return (uint8_t)(p->param_type);
}

James Goppert's avatar
James Goppert committed
167 168 169 170 171 172 173
/**
 * @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
174 175
	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
176 177 178 179 180 181 182 183 184
}

/**
 * @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
185 186
	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
187 188 189 190 191 192 193 194 195 196
}

/**
 * @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
197
	memcpy( param_value, msg->payload, sizeof(mavlink_param_value_t));
James Goppert's avatar
James Goppert committed
198
}