mavlink_msg_command.h 10.7 KB
Newer Older
James Goppert's avatar
James Goppert committed
1 2 3
// MESSAGE COMMAND PACKING

#define MAVLINK_MSG_ID_COMMAND 75
lm's avatar
lm committed
4 5
#define MAVLINK_MSG_ID_COMMAND_LEN 20
#define MAVLINK_MSG_75_LEN 20
lm's avatar
lm committed
6 7
#define MAVLINK_MSG_ID_COMMAND_KEY 0x14
#define MAVLINK_MSG_75_KEY 0x14
James Goppert's avatar
James Goppert committed
8 9 10

typedef struct __mavlink_command_t 
{
lm's avatar
lm committed
11 12 13 14 15 16 17 18
	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.
	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)
James Goppert's avatar
James Goppert committed
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39

} mavlink_command_t;

/**
 * @brief Pack a command 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 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.
 * @return length of the message in bytes (excluding serial stream start sign)
 */
static inline uint16_t mavlink_msg_command_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)
{
lm's avatar
lm committed
40
	mavlink_command_t *p = (mavlink_command_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
41 42
	msg->msgid = MAVLINK_MSG_ID_COMMAND;

lm's avatar
lm committed
43 44 45 46 47 48 49 50
	p->target_system = target_system;	// uint8_t:System which should execute the command
	p->target_component = target_component;	// uint8_t:Component which should execute the command, 0 for all components
	p->command = command;	// uint8_t:Command ID, as defined by MAV_CMD enum.
	p->confirmation = confirmation;	// uint8_t:0: First transmission of this command. 1-255: Confirmation transmissions (e.g. for kill command)
	p->param1 = param1;	// float:Parameter 1, as defined by MAV_CMD enum.
	p->param2 = param2;	// float:Parameter 2, as defined by MAV_CMD enum.
	p->param3 = param3;	// float:Parameter 3, as defined by MAV_CMD enum.
	p->param4 = param4;	// float:Parameter 4, as defined by MAV_CMD enum.
James Goppert's avatar
James Goppert committed
51

lm's avatar
lm committed
52
	return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_COMMAND_LEN);
James Goppert's avatar
James Goppert committed
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
}

/**
 * @brief Pack a command 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 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.
 * @return length of the message in bytes (excluding serial stream start sign)
 */
static inline uint16_t mavlink_msg_command_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)
{
lm's avatar
lm committed
73
	mavlink_command_t *p = (mavlink_command_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
74 75
	msg->msgid = MAVLINK_MSG_ID_COMMAND;

lm's avatar
lm committed
76 77 78 79 80 81 82 83
	p->target_system = target_system;	// uint8_t:System which should execute the command
	p->target_component = target_component;	// uint8_t:Component which should execute the command, 0 for all components
	p->command = command;	// uint8_t:Command ID, as defined by MAV_CMD enum.
	p->confirmation = confirmation;	// uint8_t:0: First transmission of this command. 1-255: Confirmation transmissions (e.g. for kill command)
	p->param1 = param1;	// float:Parameter 1, as defined by MAV_CMD enum.
	p->param2 = param2;	// float:Parameter 2, as defined by MAV_CMD enum.
	p->param3 = param3;	// float:Parameter 3, as defined by MAV_CMD enum.
	p->param4 = param4;	// float:Parameter 4, as defined by MAV_CMD enum.
James Goppert's avatar
James Goppert committed
84

lm's avatar
lm committed
85
	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_COMMAND_LEN);
James Goppert's avatar
James Goppert committed
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
}

/**
 * @brief Encode a command 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 command C-struct to read the message contents from
 */
static inline uint16_t mavlink_msg_command_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_command_t* command)
{
	return mavlink_msg_command_pack(system_id, component_id, msg, command->target_system, command->target_component, command->command, command->confirmation, command->param1, command->param2, command->param3, command->param4);
}

lm's avatar
lm committed
101 102

#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
James Goppert's avatar
James Goppert committed
103 104 105 106 107 108 109 110 111 112 113 114 115
/**
 * @brief Send a command message
 * @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.
 */
lm's avatar
lm committed
116 117 118 119
static inline void mavlink_msg_command_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)
{
	mavlink_header_t hdr;
	mavlink_command_t payload;
lm's avatar
lm committed
120 121 122 123 124 125 126 127 128 129

	MAVLINK_BUFFER_CHECK_START( chan, MAVLINK_MSG_ID_COMMAND_LEN )
	payload.target_system = target_system;	// uint8_t:System which should execute the command
	payload.target_component = target_component;	// uint8_t:Component which should execute the command, 0 for all components
	payload.command = command;	// uint8_t:Command ID, as defined by MAV_CMD enum.
	payload.confirmation = confirmation;	// uint8_t:0: First transmission of this command. 1-255: Confirmation transmissions (e.g. for kill command)
	payload.param1 = param1;	// float:Parameter 1, as defined by MAV_CMD enum.
	payload.param2 = param2;	// float:Parameter 2, as defined by MAV_CMD enum.
	payload.param3 = param3;	// float:Parameter 3, as defined by MAV_CMD enum.
	payload.param4 = param4;	// float:Parameter 4, as defined by MAV_CMD enum.
lm's avatar
lm committed
130 131 132 133 134 135 136 137 138 139

	hdr.STX = MAVLINK_STX;
	hdr.len = MAVLINK_MSG_ID_COMMAND_LEN;
	hdr.msgid = MAVLINK_MSG_ID_COMMAND;
	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 );

lm's avatar
lm committed
140 141 142 143 144 145
	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 );
	crc_accumulate( 0x14, &hdr.ck); /// include key in X25 checksum
	mavlink_send_mem(chan, (uint8_t *)&hdr.ck, MAVLINK_NUM_CHECKSUM_BYTES);
	MAVLINK_BUFFER_CHECK_END
James Goppert's avatar
James Goppert committed
146 147 148 149 150 151 152 153 154 155 156 157
}

#endif
// MESSAGE COMMAND UNPACKING

/**
 * @brief Get field target_system from command message
 *
 * @return System which should execute the command
 */
static inline uint8_t mavlink_msg_command_get_target_system(const mavlink_message_t* msg)
{
lm's avatar
lm committed
158 159
	mavlink_command_t *p = (mavlink_command_t *)&msg->payload[0];
	return (uint8_t)(p->target_system);
James Goppert's avatar
James Goppert committed
160 161 162 163 164 165 166 167 168
}

/**
 * @brief Get field target_component from command message
 *
 * @return Component which should execute the command, 0 for all components
 */
static inline uint8_t mavlink_msg_command_get_target_component(const mavlink_message_t* msg)
{
lm's avatar
lm committed
169 170
	mavlink_command_t *p = (mavlink_command_t *)&msg->payload[0];
	return (uint8_t)(p->target_component);
James Goppert's avatar
James Goppert committed
171 172 173 174 175 176 177 178 179
}

/**
 * @brief Get field command from command message
 *
 * @return Command ID, as defined by MAV_CMD enum.
 */
static inline uint8_t mavlink_msg_command_get_command(const mavlink_message_t* msg)
{
lm's avatar
lm committed
180 181
	mavlink_command_t *p = (mavlink_command_t *)&msg->payload[0];
	return (uint8_t)(p->command);
James Goppert's avatar
James Goppert committed
182 183 184 185 186 187 188 189 190
}

/**
 * @brief Get field confirmation from command message
 *
 * @return 0: First transmission of this command. 1-255: Confirmation transmissions (e.g. for kill command)
 */
static inline uint8_t mavlink_msg_command_get_confirmation(const mavlink_message_t* msg)
{
lm's avatar
lm committed
191 192
	mavlink_command_t *p = (mavlink_command_t *)&msg->payload[0];
	return (uint8_t)(p->confirmation);
James Goppert's avatar
James Goppert committed
193 194 195 196 197 198 199 200 201
}

/**
 * @brief Get field param1 from command message
 *
 * @return Parameter 1, as defined by MAV_CMD enum.
 */
static inline float mavlink_msg_command_get_param1(const mavlink_message_t* msg)
{
lm's avatar
lm committed
202 203
	mavlink_command_t *p = (mavlink_command_t *)&msg->payload[0];
	return (float)(p->param1);
James Goppert's avatar
James Goppert committed
204 205 206 207 208 209 210 211 212
}

/**
 * @brief Get field param2 from command message
 *
 * @return Parameter 2, as defined by MAV_CMD enum.
 */
static inline float mavlink_msg_command_get_param2(const mavlink_message_t* msg)
{
lm's avatar
lm committed
213 214
	mavlink_command_t *p = (mavlink_command_t *)&msg->payload[0];
	return (float)(p->param2);
James Goppert's avatar
James Goppert committed
215 216 217 218 219 220 221 222 223
}

/**
 * @brief Get field param3 from command message
 *
 * @return Parameter 3, as defined by MAV_CMD enum.
 */
static inline float mavlink_msg_command_get_param3(const mavlink_message_t* msg)
{
lm's avatar
lm committed
224 225
	mavlink_command_t *p = (mavlink_command_t *)&msg->payload[0];
	return (float)(p->param3);
James Goppert's avatar
James Goppert committed
226 227 228 229 230 231 232 233 234
}

/**
 * @brief Get field param4 from command message
 *
 * @return Parameter 4, as defined by MAV_CMD enum.
 */
static inline float mavlink_msg_command_get_param4(const mavlink_message_t* msg)
{
lm's avatar
lm committed
235 236
	mavlink_command_t *p = (mavlink_command_t *)&msg->payload[0];
	return (float)(p->param4);
James Goppert's avatar
James Goppert committed
237 238 239 240 241 242 243 244 245 246
}

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