mavlink_msg_command_long.h 14.1 KB
Newer Older
1
// MESSAGE COMMAND_LONG PACKING
James Goppert's avatar
James Goppert committed
2

3
#define MAVLINK_MSG_ID_COMMAND_LONG 76
James Goppert's avatar
James Goppert committed
4

lm's avatar
lm committed
5
typedef struct __mavlink_command_long_t
James Goppert's avatar
James Goppert committed
6
{
lm's avatar
lm committed
7 8 9 10 11 12 13 14 15 16 17
 float param1; ///< Parameter 1, as defined by MAV_CMD enum.
 float param2; ///< Parameter 2, as defined by MAV_CMD enum.
 float param3; ///< Parameter 3, as defined by MAV_CMD enum.
 float param4; ///< Parameter 4, as defined by MAV_CMD enum.
 float param5; ///< Parameter 5, as defined by MAV_CMD enum.
 float param6; ///< Parameter 6, as defined by MAV_CMD enum.
 float param7; ///< Parameter 7, as defined by MAV_CMD enum.
 uint8_t target_system; ///< System which should execute the command
 uint8_t target_component; ///< Component which should execute the command, 0 for all components
 uint8_t command; ///< Command ID, as defined by MAV_CMD enum.
 uint8_t confirmation; ///< 0: First transmission of this command. 1-255: Confirmation transmissions (e.g. for kill command)
18
} mavlink_command_long_t;
James Goppert's avatar
James Goppert committed
19

lm's avatar
lm committed
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
#define MAVLINK_MSG_ID_COMMAND_LONG_LEN 32
#define MAVLINK_MSG_ID_76_LEN 32



#define MAVLINK_MESSAGE_INFO_COMMAND_LONG { \
	"COMMAND_LONG", \
	11, \
	{  { "param1", MAVLINK_TYPE_FLOAT, 0, 0, offsetof(mavlink_command_long_t, param1) }, \
         { "param2", MAVLINK_TYPE_FLOAT, 0, 4, offsetof(mavlink_command_long_t, param2) }, \
         { "param3", MAVLINK_TYPE_FLOAT, 0, 8, offsetof(mavlink_command_long_t, param3) }, \
         { "param4", MAVLINK_TYPE_FLOAT, 0, 12, offsetof(mavlink_command_long_t, param4) }, \
         { "param5", MAVLINK_TYPE_FLOAT, 0, 16, offsetof(mavlink_command_long_t, param5) }, \
         { "param6", MAVLINK_TYPE_FLOAT, 0, 20, offsetof(mavlink_command_long_t, param6) }, \
         { "param7", MAVLINK_TYPE_FLOAT, 0, 24, offsetof(mavlink_command_long_t, param7) }, \
         { "target_system", MAVLINK_TYPE_UINT8_T, 0, 28, offsetof(mavlink_command_long_t, target_system) }, \
         { "target_component", MAVLINK_TYPE_UINT8_T, 0, 29, offsetof(mavlink_command_long_t, target_component) }, \
         { "command", MAVLINK_TYPE_UINT8_T, 0, 30, offsetof(mavlink_command_long_t, command) }, \
         { "confirmation", MAVLINK_TYPE_UINT8_T, 0, 31, offsetof(mavlink_command_long_t, confirmation) }, \
         } \
}


James Goppert's avatar
James Goppert committed
43
/**
44
 * @brief Pack a command_long message
James Goppert's avatar
James Goppert committed
45 46 47 48 49 50 51 52 53 54 55 56
 * @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 which should execute the command
 * @param target_component Component which should execute the command, 0 for all components
 * @param command Command ID, as defined by MAV_CMD enum.
 * @param confirmation 0: First transmission of this command. 1-255: Confirmation transmissions (e.g. for kill command)
 * @param param1 Parameter 1, as defined by MAV_CMD enum.
 * @param param2 Parameter 2, as defined by MAV_CMD enum.
 * @param param3 Parameter 3, as defined by MAV_CMD enum.
 * @param param4 Parameter 4, as defined by MAV_CMD enum.
57 58 59
 * @param param5 Parameter 5, as defined by MAV_CMD enum.
 * @param param6 Parameter 6, as defined by MAV_CMD enum.
 * @param param7 Parameter 7, as defined by MAV_CMD enum.
James Goppert's avatar
James Goppert committed
60 61
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
62 63
static inline uint16_t mavlink_msg_command_long_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
						       uint8_t target_system, uint8_t target_component, uint8_t command, uint8_t confirmation, float param1, float param2, float param3, float param4, float param5, float param6, float param7)
James Goppert's avatar
James Goppert committed
64
{
65
	msg->msgid = MAVLINK_MSG_ID_COMMAND_LONG;
James Goppert's avatar
James Goppert committed
66

lm's avatar
lm committed
67 68 69 70 71 72 73 74 75 76 77 78 79
	put_float_by_index(msg, 0, param1); // Parameter 1, as defined by MAV_CMD enum.
	put_float_by_index(msg, 4, param2); // Parameter 2, as defined by MAV_CMD enum.
	put_float_by_index(msg, 8, param3); // Parameter 3, as defined by MAV_CMD enum.
	put_float_by_index(msg, 12, param4); // Parameter 4, as defined by MAV_CMD enum.
	put_float_by_index(msg, 16, param5); // Parameter 5, as defined by MAV_CMD enum.
	put_float_by_index(msg, 20, param6); // Parameter 6, as defined by MAV_CMD enum.
	put_float_by_index(msg, 24, param7); // Parameter 7, as defined by MAV_CMD enum.
	put_uint8_t_by_index(msg, 28, target_system); // System which should execute the command
	put_uint8_t_by_index(msg, 29, target_component); // Component which should execute the command, 0 for all components
	put_uint8_t_by_index(msg, 30, command); // Command ID, as defined by MAV_CMD enum.
	put_uint8_t_by_index(msg, 31, confirmation); // 0: First transmission of this command. 1-255: Confirmation transmissions (e.g. for kill command)

	return mavlink_finalize_message(msg, system_id, component_id, 32, 168);
James Goppert's avatar
James Goppert committed
80 81 82
}

/**
lm's avatar
lm committed
83
 * @brief Pack a command_long message on a channel
James Goppert's avatar
James Goppert committed
84 85 86 87 88 89 90 91 92 93 94 95
 * @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 which should execute the command
 * @param target_component Component which should execute the command, 0 for all components
 * @param command Command ID, as defined by MAV_CMD enum.
 * @param confirmation 0: First transmission of this command. 1-255: Confirmation transmissions (e.g. for kill command)
 * @param param1 Parameter 1, as defined by MAV_CMD enum.
 * @param param2 Parameter 2, as defined by MAV_CMD enum.
 * @param param3 Parameter 3, as defined by MAV_CMD enum.
 * @param param4 Parameter 4, as defined by MAV_CMD enum.
96 97 98
 * @param param5 Parameter 5, as defined by MAV_CMD enum.
 * @param param6 Parameter 6, as defined by MAV_CMD enum.
 * @param param7 Parameter 7, as defined by MAV_CMD enum.
James Goppert's avatar
James Goppert committed
99 100
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
101 102 103
static inline uint16_t mavlink_msg_command_long_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,uint8_t command,uint8_t confirmation,float param1,float param2,float param3,float param4,float param5,float param6,float param7)
James Goppert's avatar
James Goppert committed
104
{
105
	msg->msgid = MAVLINK_MSG_ID_COMMAND_LONG;
James Goppert's avatar
James Goppert committed
106

lm's avatar
lm committed
107 108 109 110 111 112 113 114 115 116 117 118 119
	put_float_by_index(msg, 0, param1); // Parameter 1, as defined by MAV_CMD enum.
	put_float_by_index(msg, 4, param2); // Parameter 2, as defined by MAV_CMD enum.
	put_float_by_index(msg, 8, param3); // Parameter 3, as defined by MAV_CMD enum.
	put_float_by_index(msg, 12, param4); // Parameter 4, as defined by MAV_CMD enum.
	put_float_by_index(msg, 16, param5); // Parameter 5, as defined by MAV_CMD enum.
	put_float_by_index(msg, 20, param6); // Parameter 6, as defined by MAV_CMD enum.
	put_float_by_index(msg, 24, param7); // Parameter 7, as defined by MAV_CMD enum.
	put_uint8_t_by_index(msg, 28, target_system); // System which should execute the command
	put_uint8_t_by_index(msg, 29, target_component); // Component which should execute the command, 0 for all components
	put_uint8_t_by_index(msg, 30, command); // Command ID, as defined by MAV_CMD enum.
	put_uint8_t_by_index(msg, 31, confirmation); // 0: First transmission of this command. 1-255: Confirmation transmissions (e.g. for kill command)

	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, 32, 168);
James Goppert's avatar
James Goppert committed
120 121 122
}

/**
123
 * @brief Encode a command_long struct into a message
James Goppert's avatar
James Goppert committed
124 125 126 127
 *
 * @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
128
 * @param command_long C-struct to read the message contents from
James Goppert's avatar
James Goppert committed
129
 */
130
static inline uint16_t mavlink_msg_command_long_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_command_long_t* command_long)
James Goppert's avatar
James Goppert committed
131
{
132
	return mavlink_msg_command_long_pack(system_id, component_id, msg, command_long->target_system, command_long->target_component, command_long->command, command_long->confirmation, command_long->param1, command_long->param2, command_long->param3, command_long->param4, command_long->param5, command_long->param6, command_long->param7);
James Goppert's avatar
James Goppert committed
133 134 135
}

/**
136
 * @brief Send a command_long message
James Goppert's avatar
James Goppert committed
137 138 139 140 141 142 143 144 145 146
 * @param chan MAVLink channel to send the message
 *
 * @param target_system System which should execute the command
 * @param target_component Component which should execute the command, 0 for all components
 * @param command Command ID, as defined by MAV_CMD enum.
 * @param confirmation 0: First transmission of this command. 1-255: Confirmation transmissions (e.g. for kill command)
 * @param param1 Parameter 1, as defined by MAV_CMD enum.
 * @param param2 Parameter 2, as defined by MAV_CMD enum.
 * @param param3 Parameter 3, as defined by MAV_CMD enum.
 * @param param4 Parameter 4, as defined by MAV_CMD enum.
147 148 149
 * @param param5 Parameter 5, as defined by MAV_CMD enum.
 * @param param6 Parameter 6, as defined by MAV_CMD enum.
 * @param param7 Parameter 7, as defined by MAV_CMD enum.
James Goppert's avatar
James Goppert committed
150
 */
lm's avatar
lm committed
151 152
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

153
static inline void mavlink_msg_command_long_send(mavlink_channel_t chan, uint8_t target_system, uint8_t target_component, uint8_t command, uint8_t confirmation, float param1, float param2, float param3, float param4, float param5, float param6, float param7)
lm's avatar
lm committed
154
{
lm's avatar
lm committed
155
	MAVLINK_ALIGNED_MESSAGE(msg, 32);
LM's avatar
LM committed
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
	msg->msgid = MAVLINK_MSG_ID_COMMAND_LONG;

	put_float_by_index(msg, 0, param1); // Parameter 1, as defined by MAV_CMD enum.
	put_float_by_index(msg, 4, param2); // Parameter 2, as defined by MAV_CMD enum.
	put_float_by_index(msg, 8, param3); // Parameter 3, as defined by MAV_CMD enum.
	put_float_by_index(msg, 12, param4); // Parameter 4, as defined by MAV_CMD enum.
	put_float_by_index(msg, 16, param5); // Parameter 5, as defined by MAV_CMD enum.
	put_float_by_index(msg, 20, param6); // Parameter 6, as defined by MAV_CMD enum.
	put_float_by_index(msg, 24, param7); // Parameter 7, as defined by MAV_CMD enum.
	put_uint8_t_by_index(msg, 28, target_system); // System which should execute the command
	put_uint8_t_by_index(msg, 29, target_component); // Component which should execute the command, 0 for all components
	put_uint8_t_by_index(msg, 30, command); // Command ID, as defined by MAV_CMD enum.
	put_uint8_t_by_index(msg, 31, confirmation); // 0: First transmission of this command. 1-255: Confirmation transmissions (e.g. for kill command)

	mavlink_finalize_message_chan_send(msg, chan, 32, 168);
James Goppert's avatar
James Goppert committed
171 172 173
}

#endif
lm's avatar
lm committed
174

175
// MESSAGE COMMAND_LONG UNPACKING
James Goppert's avatar
James Goppert committed
176

lm's avatar
lm committed
177

James Goppert's avatar
James Goppert committed
178
/**
179
 * @brief Get field target_system from command_long message
James Goppert's avatar
James Goppert committed
180 181 182
 *
 * @return System which should execute the command
 */
183
static inline uint8_t mavlink_msg_command_long_get_target_system(const mavlink_message_t* msg)
James Goppert's avatar
James Goppert committed
184
{
lm's avatar
lm committed
185
	return MAVLINK_MSG_RETURN_uint8_t(msg,  28);
James Goppert's avatar
James Goppert committed
186 187 188
}

/**
189
 * @brief Get field target_component from command_long message
James Goppert's avatar
James Goppert committed
190 191 192
 *
 * @return Component which should execute the command, 0 for all components
 */
193
static inline uint8_t mavlink_msg_command_long_get_target_component(const mavlink_message_t* msg)
James Goppert's avatar
James Goppert committed
194
{
lm's avatar
lm committed
195
	return MAVLINK_MSG_RETURN_uint8_t(msg,  29);
James Goppert's avatar
James Goppert committed
196 197 198
}

/**
199
 * @brief Get field command from command_long message
James Goppert's avatar
James Goppert committed
200 201 202
 *
 * @return Command ID, as defined by MAV_CMD enum.
 */
203
static inline uint8_t mavlink_msg_command_long_get_command(const mavlink_message_t* msg)
James Goppert's avatar
James Goppert committed
204
{
lm's avatar
lm committed
205
	return MAVLINK_MSG_RETURN_uint8_t(msg,  30);
James Goppert's avatar
James Goppert committed
206 207 208
}

/**
209
 * @brief Get field confirmation from command_long message
James Goppert's avatar
James Goppert committed
210 211 212
 *
 * @return 0: First transmission of this command. 1-255: Confirmation transmissions (e.g. for kill command)
 */
213
static inline uint8_t mavlink_msg_command_long_get_confirmation(const mavlink_message_t* msg)
James Goppert's avatar
James Goppert committed
214
{
lm's avatar
lm committed
215
	return MAVLINK_MSG_RETURN_uint8_t(msg,  31);
James Goppert's avatar
James Goppert committed
216 217 218
}

/**
219
 * @brief Get field param1 from command_long message
James Goppert's avatar
James Goppert committed
220 221 222
 *
 * @return Parameter 1, as defined by MAV_CMD enum.
 */
223
static inline float mavlink_msg_command_long_get_param1(const mavlink_message_t* msg)
James Goppert's avatar
James Goppert committed
224
{
lm's avatar
lm committed
225
	return MAVLINK_MSG_RETURN_float(msg,  0);
James Goppert's avatar
James Goppert committed
226 227 228
}

/**
229
 * @brief Get field param2 from command_long message
James Goppert's avatar
James Goppert committed
230 231 232
 *
 * @return Parameter 2, as defined by MAV_CMD enum.
 */
233
static inline float mavlink_msg_command_long_get_param2(const mavlink_message_t* msg)
James Goppert's avatar
James Goppert committed
234
{
lm's avatar
lm committed
235
	return MAVLINK_MSG_RETURN_float(msg,  4);
James Goppert's avatar
James Goppert committed
236 237 238
}

/**
239
 * @brief Get field param3 from command_long message
James Goppert's avatar
James Goppert committed
240 241 242
 *
 * @return Parameter 3, as defined by MAV_CMD enum.
 */
243
static inline float mavlink_msg_command_long_get_param3(const mavlink_message_t* msg)
James Goppert's avatar
James Goppert committed
244
{
lm's avatar
lm committed
245
	return MAVLINK_MSG_RETURN_float(msg,  8);
James Goppert's avatar
James Goppert committed
246 247 248
}

/**
249
 * @brief Get field param4 from command_long message
James Goppert's avatar
James Goppert committed
250 251 252
 *
 * @return Parameter 4, as defined by MAV_CMD enum.
 */
253
static inline float mavlink_msg_command_long_get_param4(const mavlink_message_t* msg)
James Goppert's avatar
James Goppert committed
254
{
lm's avatar
lm committed
255
	return MAVLINK_MSG_RETURN_float(msg,  12);
James Goppert's avatar
James Goppert committed
256 257 258
}

/**
259 260 261 262 263 264
 * @brief Get field param5 from command_long message
 *
 * @return Parameter 5, as defined by MAV_CMD enum.
 */
static inline float mavlink_msg_command_long_get_param5(const mavlink_message_t* msg)
{
lm's avatar
lm committed
265
	return MAVLINK_MSG_RETURN_float(msg,  16);
266 267 268 269 270 271 272 273 274
}

/**
 * @brief Get field param6 from command_long message
 *
 * @return Parameter 6, as defined by MAV_CMD enum.
 */
static inline float mavlink_msg_command_long_get_param6(const mavlink_message_t* msg)
{
lm's avatar
lm committed
275
	return MAVLINK_MSG_RETURN_float(msg,  20);
276 277 278 279 280 281 282 283 284
}

/**
 * @brief Get field param7 from command_long message
 *
 * @return Parameter 7, as defined by MAV_CMD enum.
 */
static inline float mavlink_msg_command_long_get_param7(const mavlink_message_t* msg)
{
lm's avatar
lm committed
285
	return MAVLINK_MSG_RETURN_float(msg,  24);
286 287 288 289
}

/**
 * @brief Decode a command_long message into a struct
James Goppert's avatar
James Goppert committed
290 291
 *
 * @param msg The message to decode
292
 * @param command_long C-struct to decode the message contents into
James Goppert's avatar
James Goppert committed
293
 */
294
static inline void mavlink_msg_command_long_decode(const mavlink_message_t* msg, mavlink_command_long_t* command_long)
James Goppert's avatar
James Goppert committed
295
{
lm's avatar
lm committed
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
#if MAVLINK_NEED_BYTE_SWAP
	command_long->param1 = mavlink_msg_command_long_get_param1(msg);
	command_long->param2 = mavlink_msg_command_long_get_param2(msg);
	command_long->param3 = mavlink_msg_command_long_get_param3(msg);
	command_long->param4 = mavlink_msg_command_long_get_param4(msg);
	command_long->param5 = mavlink_msg_command_long_get_param5(msg);
	command_long->param6 = mavlink_msg_command_long_get_param6(msg);
	command_long->param7 = mavlink_msg_command_long_get_param7(msg);
	command_long->target_system = mavlink_msg_command_long_get_target_system(msg);
	command_long->target_component = mavlink_msg_command_long_get_target_component(msg);
	command_long->command = mavlink_msg_command_long_get_command(msg);
	command_long->confirmation = mavlink_msg_command_long_get_confirmation(msg);
#else
	memcpy(command_long, MAVLINK_PAYLOAD(msg), 32);
#endif
James Goppert's avatar
James Goppert committed
311
}