mavlink_msg_cmd_ack.h 4.72 KB
Newer Older
LM's avatar
LM committed
1 2 3 4 5
// MESSAGE CMD_ACK PACKING

#define MAVLINK_MSG_ID_CMD_ACK 9
#define MAVLINK_MSG_ID_CMD_ACK_LEN 2
#define MAVLINK_MSG_9_LEN 2
lm's avatar
lm committed
6 7
#define MAVLINK_MSG_ID_CMD_ACK_KEY 0x90
#define MAVLINK_MSG_9_KEY 0x90
LM's avatar
LM committed
8 9 10

typedef struct __mavlink_cmd_ack_t 
{
lm's avatar
lm committed
11 12
	uint8_t cmd;	///< The MAV_CMD ID
	uint8_t result;	///< 0: Action DENIED, 1: Action executed
LM's avatar
LM committed
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30

} mavlink_cmd_ack_t;

/**
 * @brief Pack a cmd_ack 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 cmd The MAV_CMD ID
 * @param result 0: Action DENIED, 1: Action executed
 * @return length of the message in bytes (excluding serial stream start sign)
 */
static inline uint16_t mavlink_msg_cmd_ack_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, uint8_t cmd, uint8_t result)
{
	mavlink_cmd_ack_t *p = (mavlink_cmd_ack_t *)&msg->payload[0];
	msg->msgid = MAVLINK_MSG_ID_CMD_ACK;

lm's avatar
lm committed
31 32
	p->cmd = cmd;	// uint8_t:The MAV_CMD ID
	p->result = result;	// uint8_t:0: Action DENIED, 1: Action executed
LM's avatar
LM committed
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51

	return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_CMD_ACK_LEN);
}

/**
 * @brief Pack a cmd_ack 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 cmd The MAV_CMD ID
 * @param result 0: Action DENIED, 1: Action executed
 * @return length of the message in bytes (excluding serial stream start sign)
 */
static inline uint16_t mavlink_msg_cmd_ack_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, uint8_t cmd, uint8_t result)
{
	mavlink_cmd_ack_t *p = (mavlink_cmd_ack_t *)&msg->payload[0];
	msg->msgid = MAVLINK_MSG_ID_CMD_ACK;

lm's avatar
lm committed
52 53
	p->cmd = cmd;	// uint8_t:The MAV_CMD ID
	p->result = result;	// uint8_t:0: Action DENIED, 1: Action executed
LM's avatar
LM committed
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70

	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_CMD_ACK_LEN);
}

/**
 * @brief Encode a cmd_ack 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 cmd_ack C-struct to read the message contents from
 */
static inline uint16_t mavlink_msg_cmd_ack_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_cmd_ack_t* cmd_ack)
{
	return mavlink_msg_cmd_ack_pack(system_id, component_id, msg, cmd_ack->cmd, cmd_ack->result);
}

lm's avatar
lm committed
71 72

#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
LM's avatar
LM committed
73 74 75 76 77 78 79 80 81 82 83 84
/**
 * @brief Send a cmd_ack message
 * @param chan MAVLink channel to send the message
 *
 * @param cmd The MAV_CMD ID
 * @param result 0: Action DENIED, 1: Action executed
 */
static inline void mavlink_msg_cmd_ack_send(mavlink_channel_t chan, uint8_t cmd, uint8_t result)
{
	mavlink_header_t hdr;
	mavlink_cmd_ack_t payload;

lm's avatar
lm committed
85 86 87
	MAVLINK_BUFFER_CHECK_START( chan, MAVLINK_MSG_ID_CMD_ACK_LEN )
	payload.cmd = cmd;	// uint8_t:The MAV_CMD ID
	payload.result = result;	// uint8_t:0: Action DENIED, 1: Action executed
LM's avatar
LM committed
88 89 90 91 92 93 94 95 96

	hdr.STX = MAVLINK_STX;
	hdr.len = MAVLINK_MSG_ID_CMD_ACK_LEN;
	hdr.msgid = MAVLINK_MSG_ID_CMD_ACK;
	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 );
97
	mavlink_send_mem(chan, (uint8_t *)&payload, sizeof(payload) );
LM's avatar
LM committed
98

lm's avatar
lm committed
99 100 101 102 103 104
	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( 0x90, &hdr.ck); /// include key in X25 checksum
	mavlink_send_mem(chan, (uint8_t *)&hdr.ck, MAVLINK_NUM_CHECKSUM_BYTES);
	MAVLINK_BUFFER_CHECK_END
LM's avatar
LM committed
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
}

#endif
// MESSAGE CMD_ACK UNPACKING

/**
 * @brief Get field cmd from cmd_ack message
 *
 * @return The MAV_CMD ID
 */
static inline uint8_t mavlink_msg_cmd_ack_get_cmd(const mavlink_message_t* msg)
{
	mavlink_cmd_ack_t *p = (mavlink_cmd_ack_t *)&msg->payload[0];
	return (uint8_t)(p->cmd);
}

/**
 * @brief Get field result from cmd_ack message
 *
 * @return 0: Action DENIED, 1: Action executed
 */
static inline uint8_t mavlink_msg_cmd_ack_get_result(const mavlink_message_t* msg)
{
	mavlink_cmd_ack_t *p = (mavlink_cmd_ack_t *)&msg->payload[0];
	return (uint8_t)(p->result);
}

/**
 * @brief Decode a cmd_ack message into a struct
 *
 * @param msg The message to decode
 * @param cmd_ack C-struct to decode the message contents into
 */
static inline void mavlink_msg_cmd_ack_decode(const mavlink_message_t* msg, mavlink_cmd_ack_t* cmd_ack)
{
	memcpy( cmd_ack, msg->payload, sizeof(mavlink_cmd_ack_t));
}