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

#define MAVLINK_MSG_ID_PARAM_VALUE 22

lm's avatar
lm committed
5
typedef struct __mavlink_param_value_t
James Goppert's avatar
James Goppert committed
6
{
lm's avatar
lm committed
7 8 9 10 11
 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
 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
12
} mavlink_param_value_t;
lm's avatar
lm committed
13 14 15 16

#define MAVLINK_MSG_ID_PARAM_VALUE_LEN 25
#define MAVLINK_MSG_ID_22_LEN 25

17
#define MAVLINK_MSG_PARAM_VALUE_FIELD_PARAM_ID_LEN 16
James Goppert's avatar
James Goppert committed
18

lm's avatar
lm committed
19 20 21 22 23 24 25 26 27 28 29 30
#define MAVLINK_MESSAGE_INFO_PARAM_VALUE { \
	"PARAM_VALUE", \
	5, \
	{  { "param_value", MAVLINK_TYPE_FLOAT, 0, 0, offsetof(mavlink_param_value_t, param_value) }, \
         { "param_count", MAVLINK_TYPE_UINT16_T, 0, 4, offsetof(mavlink_param_value_t, param_count) }, \
         { "param_index", MAVLINK_TYPE_UINT16_T, 0, 6, offsetof(mavlink_param_value_t, param_index) }, \
         { "param_id", MAVLINK_TYPE_CHAR, 16, 8, offsetof(mavlink_param_value_t, param_id) }, \
         { "param_type", MAVLINK_TYPE_UINT8_T, 0, 24, offsetof(mavlink_param_value_t, param_type) }, \
         } \
}


James Goppert's avatar
James Goppert committed
31 32 33 34 35 36 37 38
/**
 * @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
39
 * @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
40 41 42 43
 * @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
44 45
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
46 47 48
{
	msg->msgid = MAVLINK_MSG_ID_PARAM_VALUE;

lm's avatar
lm committed
49 50 51 52 53
	put_float_by_index(msg, 0, param_value); // Onboard parameter value
	put_uint16_t_by_index(msg, 4, param_count); // Total number of onboard parameters
	put_uint16_t_by_index(msg, 6, param_index); // Index of this onboard parameter
	put_char_array_by_index(msg, 8, param_id, 16); // Onboard parameter id
	put_uint8_t_by_index(msg, 24, 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
54

lm's avatar
lm committed
55
	return mavlink_finalize_message(msg, system_id, component_id, 25, 220);
James Goppert's avatar
James Goppert committed
56 57 58
}

/**
lm's avatar
lm committed
59
 * @brief Pack a param_value message on a channel
James Goppert's avatar
James Goppert committed
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 param_id Onboard parameter id
 * @param param_value Onboard parameter value
66
 * @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
67 68 69 70
 * @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
71 72 73
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
74 75 76
{
	msg->msgid = MAVLINK_MSG_ID_PARAM_VALUE;

lm's avatar
lm committed
77 78 79 80 81
	put_float_by_index(msg, 0, param_value); // Onboard parameter value
	put_uint16_t_by_index(msg, 4, param_count); // Total number of onboard parameters
	put_uint16_t_by_index(msg, 6, param_index); // Index of this onboard parameter
	put_char_array_by_index(msg, 8, param_id, 16); // Onboard parameter id
	put_uint8_t_by_index(msg, 24, 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
82

lm's avatar
lm committed
83
	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, 25, 220);
James Goppert's avatar
James Goppert committed
84 85
}

lm's avatar
lm committed
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

/**
 * @brief Pack a param_value 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 param_id Onboard parameter id
 * @param param_value Onboard parameter value
 * @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
 * @param param_count Total number of onboard parameters
 * @param param_index Index of this onboard parameter
 */
static inline void mavlink_msg_param_value_pack_chan_send(mavlink_channel_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)
{
	msg->msgid = MAVLINK_MSG_ID_PARAM_VALUE;

	put_float_by_index(msg, 0, param_value); // Onboard parameter value
	put_uint16_t_by_index(msg, 4, param_count); // Total number of onboard parameters
	put_uint16_t_by_index(msg, 6, param_index); // Index of this onboard parameter
	put_char_array_by_index(msg, 8, param_id, 16); // Onboard parameter id
	put_uint8_t_by_index(msg, 24, 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

	mavlink_finalize_message_chan_send(msg, chan, 25, 220);
}
#endif // MAVLINK_USE_CONVENIENCE_FUNCTIONS


James Goppert's avatar
James Goppert committed
115 116 117 118 119 120 121 122 123 124
/**
 * @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)
{
125
	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
126 127 128 129 130 131 132 133
}

/**
 * @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
134
 * @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
135 136 137
 * @param param_count Total number of onboard parameters
 * @param param_index Index of this onboard parameter
 */
lm's avatar
lm committed
138 139 140
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

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
141
{
lm's avatar
lm committed
142 143
	MAVLINK_ALIGNED_MESSAGE(msg, 25);
	mavlink_msg_param_value_pack_chan_send(chan, msg, param_id, param_value, param_type, param_count, param_index);
James Goppert's avatar
James Goppert committed
144 145 146
}

#endif
lm's avatar
lm committed
147

James Goppert's avatar
James Goppert committed
148 149
// MESSAGE PARAM_VALUE UNPACKING

lm's avatar
lm committed
150

James Goppert's avatar
James Goppert committed
151 152 153 154 155
/**
 * @brief Get field param_id from param_value message
 *
 * @return Onboard parameter id
 */
lm's avatar
lm committed
156
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
157
{
lm's avatar
lm committed
158
	return MAVLINK_MSG_RETURN_char_array(msg, param_id, 16,  8);
James Goppert's avatar
James Goppert committed
159 160 161 162 163 164 165 166 167
}

/**
 * @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
168
	return MAVLINK_MSG_RETURN_float(msg,  0);
James Goppert's avatar
James Goppert committed
169 170
}

171 172 173 174 175 176 177
/**
 * @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)
{
lm's avatar
lm committed
178
	return MAVLINK_MSG_RETURN_uint8_t(msg,  24);
179 180
}

James Goppert's avatar
James Goppert committed
181 182 183 184 185 186 187
/**
 * @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
188
	return MAVLINK_MSG_RETURN_uint16_t(msg,  4);
James Goppert's avatar
James Goppert committed
189 190 191 192 193 194 195 196 197
}

/**
 * @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
198
	return MAVLINK_MSG_RETURN_uint16_t(msg,  6);
James Goppert's avatar
James Goppert committed
199 200 201 202 203 204 205 206 207 208
}

/**
 * @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
209 210 211 212 213 214 215 216 217
#if MAVLINK_NEED_BYTE_SWAP
	param_value->param_value = mavlink_msg_param_value_get_param_value(msg);
	param_value->param_count = mavlink_msg_param_value_get_param_count(msg);
	param_value->param_index = mavlink_msg_param_value_get_param_index(msg);
	mavlink_msg_param_value_get_param_id(msg, param_value->param_id);
	param_value->param_type = mavlink_msg_param_value_get_param_type(msg);
#else
	memcpy(param_value, MAVLINK_PAYLOAD(msg), 25);
#endif
James Goppert's avatar
James Goppert committed
218
}