mavlink_msg_action_ack.h 4.85 KB
Newer Older
James Goppert's avatar
James Goppert committed
1 2 3
// MESSAGE ACTION_ACK PACKING

#define MAVLINK_MSG_ID_ACTION_ACK 9
lm's avatar
lm committed
4 5
#define MAVLINK_MSG_ID_ACTION_ACK_LEN 2
#define MAVLINK_MSG_9_LEN 2
James Goppert's avatar
James Goppert committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25

typedef struct __mavlink_action_ack_t 
{
	uint8_t action; ///< The action id
	uint8_t result; ///< 0: Action DENIED, 1: Action executed

} mavlink_action_ack_t;

/**
 * @brief Pack a action_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 action The action 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_action_ack_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, uint8_t action, uint8_t result)
{
lm's avatar
lm committed
26
	mavlink_action_ack_t *p = (mavlink_action_ack_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
27 28
	msg->msgid = MAVLINK_MSG_ID_ACTION_ACK;

lm's avatar
lm committed
29 30
	p->action = action; // uint8_t:The action id
	p->result = result; // uint8_t:0: Action DENIED, 1: Action executed
James Goppert's avatar
James Goppert committed
31

lm's avatar
lm committed
32
	return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_ACTION_ACK_LEN);
James Goppert's avatar
James Goppert committed
33 34 35 36 37 38 39 40 41 42 43 44 45 46
}

/**
 * @brief Pack a action_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 action The action 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_action_ack_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, uint8_t action, uint8_t result)
{
lm's avatar
lm committed
47
	mavlink_action_ack_t *p = (mavlink_action_ack_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
48 49
	msg->msgid = MAVLINK_MSG_ID_ACTION_ACK;

lm's avatar
lm committed
50 51
	p->action = action; // uint8_t:The action id
	p->result = result; // uint8_t:0: Action DENIED, 1: Action executed
James Goppert's avatar
James Goppert committed
52

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

/**
 * @brief Encode a action_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 action_ack C-struct to read the message contents from
 */
static inline uint16_t mavlink_msg_action_ack_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_action_ack_t* action_ack)
{
	return mavlink_msg_action_ack_pack(system_id, component_id, msg, action_ack->action, action_ack->result);
}

/**
 * @brief Send a action_ack message
 * @param chan MAVLink channel to send the message
 *
 * @param action The action id
 * @param result 0: Action DENIED, 1: Action executed
 */
lm's avatar
lm committed
76 77


78
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
lm's avatar
lm committed
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
static inline void mavlink_msg_action_ack_send(mavlink_channel_t chan, uint8_t action, uint8_t result)
{
	mavlink_header_t hdr;
	mavlink_action_ack_t payload;
	uint16_t checksum;
	mavlink_action_ack_t *p = &payload;

	p->action = action; // uint8_t:The action id
	p->result = result; // uint8_t:0: Action DENIED, 1: Action executed

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

	crc_init(&checksum);
	checksum = crc_calculate_mem((uint8_t *)&hdr.len, &checksum, MAVLINK_CORE_HEADER_LEN);
	checksum = crc_calculate_mem((uint8_t *)&payload, &checksum, hdr.len );
	hdr.ck_a = (uint8_t)(checksum & 0xFF); ///< Low byte
	hdr.ck_b = (uint8_t)(checksum >> 8); ///< High byte

	mavlink_send_mem(chan, (uint8_t *)&payload, hdr.len);
	mavlink_send_mem(chan, (uint8_t *)&hdr.ck_a, MAVLINK_NUM_CHECKSUM_BYTES);
James Goppert's avatar
James Goppert committed
106 107 108 109 110 111 112 113 114 115 116 117
}

#endif
// MESSAGE ACTION_ACK UNPACKING

/**
 * @brief Get field action from action_ack message
 *
 * @return The action id
 */
static inline uint8_t mavlink_msg_action_ack_get_action(const mavlink_message_t* msg)
{
lm's avatar
lm committed
118 119
	mavlink_action_ack_t *p = (mavlink_action_ack_t *)&msg->payload[0];
	return (uint8_t)(p->action);
James Goppert's avatar
James Goppert committed
120 121 122 123 124 125 126 127 128
}

/**
 * @brief Get field result from action_ack message
 *
 * @return 0: Action DENIED, 1: Action executed
 */
static inline uint8_t mavlink_msg_action_ack_get_result(const mavlink_message_t* msg)
{
lm's avatar
lm committed
129 130
	mavlink_action_ack_t *p = (mavlink_action_ack_t *)&msg->payload[0];
	return (uint8_t)(p->result);
James Goppert's avatar
James Goppert committed
131 132 133 134 135 136 137 138 139 140
}

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