mavlink_msg_action.h 5.54 KB
Newer Older
James Goppert's avatar
James Goppert committed
1 2 3
// MESSAGE ACTION PACKING

#define MAVLINK_MSG_ID_ACTION 10
lm's avatar
lm committed
4 5
#define MAVLINK_MSG_ID_ACTION_LEN 3
#define MAVLINK_MSG_10_LEN 3
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 26 27

typedef struct __mavlink_action_t 
{
	uint8_t target; ///< The system executing the action
	uint8_t target_component; ///< The component executing the action
	uint8_t action; ///< The action id

} mavlink_action_t;

/**
 * @brief Pack a action 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 The system executing the action
 * @param target_component The component executing the action
 * @param action The action id
 * @return length of the message in bytes (excluding serial stream start sign)
 */
static inline uint16_t mavlink_msg_action_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, uint8_t target, uint8_t target_component, uint8_t action)
{
lm's avatar
lm committed
28
	mavlink_action_t *p = (mavlink_action_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
29 30
	msg->msgid = MAVLINK_MSG_ID_ACTION;

lm's avatar
lm committed
31 32 33
	p->target = target; // uint8_t:The system executing the action
	p->target_component = target_component; // uint8_t:The component executing the action
	p->action = action; // uint8_t:The action id
James Goppert's avatar
James Goppert committed
34

lm's avatar
lm committed
35
	return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_ACTION_LEN);
James Goppert's avatar
James Goppert committed
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
}

/**
 * @brief Pack a action 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 The system executing the action
 * @param target_component The component executing the action
 * @param action The action id
 * @return length of the message in bytes (excluding serial stream start sign)
 */
static inline uint16_t mavlink_msg_action_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, uint8_t target, uint8_t target_component, uint8_t action)
{
lm's avatar
lm committed
51
	mavlink_action_t *p = (mavlink_action_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
52 53
	msg->msgid = MAVLINK_MSG_ID_ACTION;

lm's avatar
lm committed
54 55 56
	p->target = target; // uint8_t:The system executing the action
	p->target_component = target_component; // uint8_t:The component executing the action
	p->action = action; // uint8_t:The action id
James Goppert's avatar
James Goppert committed
57

lm's avatar
lm committed
58
	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_ACTION_LEN);
James Goppert's avatar
James Goppert committed
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
}

/**
 * @brief Encode a action 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 C-struct to read the message contents from
 */
static inline uint16_t mavlink_msg_action_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_action_t* action)
{
	return mavlink_msg_action_pack(system_id, component_id, msg, action->target, action->target_component, action->action);
}

/**
 * @brief Send a action message
 * @param chan MAVLink channel to send the message
 *
 * @param target The system executing the action
 * @param target_component The component executing the action
 * @param action The action id
 */
lm's avatar
lm committed
82 83


84
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
lm's avatar
lm committed
85 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
static inline void mavlink_msg_action_send(mavlink_channel_t chan, uint8_t target, uint8_t target_component, uint8_t action)
{
	mavlink_header_t hdr;
	mavlink_action_t payload;
	uint16_t checksum;
	mavlink_action_t *p = &payload;

	p->target = target; // uint8_t:The system executing the action
	p->target_component = target_component; // uint8_t:The component executing the action
	p->action = action; // uint8_t:The action id

	hdr.STX = MAVLINK_STX;
	hdr.len = MAVLINK_MSG_ID_ACTION_LEN;
	hdr.msgid = MAVLINK_MSG_ID_ACTION;
	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
113 114 115 116 117 118 119 120 121 122 123 124
}

#endif
// MESSAGE ACTION UNPACKING

/**
 * @brief Get field target from action message
 *
 * @return The system executing the action
 */
static inline uint8_t mavlink_msg_action_get_target(const mavlink_message_t* msg)
{
lm's avatar
lm committed
125 126
	mavlink_action_t *p = (mavlink_action_t *)&msg->payload[0];
	return (uint8_t)(p->target);
James Goppert's avatar
James Goppert committed
127 128 129 130 131 132 133 134 135
}

/**
 * @brief Get field target_component from action message
 *
 * @return The component executing the action
 */
static inline uint8_t mavlink_msg_action_get_target_component(const mavlink_message_t* msg)
{
lm's avatar
lm committed
136 137
	mavlink_action_t *p = (mavlink_action_t *)&msg->payload[0];
	return (uint8_t)(p->target_component);
James Goppert's avatar
James Goppert committed
138 139 140 141 142 143 144 145 146
}

/**
 * @brief Get field action from action message
 *
 * @return The action id
 */
static inline uint8_t mavlink_msg_action_get_action(const mavlink_message_t* msg)
{
lm's avatar
lm committed
147 148
	mavlink_action_t *p = (mavlink_action_t *)&msg->payload[0];
	return (uint8_t)(p->action);
James Goppert's avatar
James Goppert committed
149 150 151 152 153 154 155 156 157 158
}

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