mavlink_msg_slugs_action.h 6.31 KB
Newer Older
James Goppert's avatar
James Goppert committed
1 2 3
// MESSAGE SLUGS_ACTION PACKING

#define MAVLINK_MSG_ID_SLUGS_ACTION 183
lm's avatar
lm committed
4 5
#define MAVLINK_MSG_ID_SLUGS_ACTION_LEN 4
#define MAVLINK_MSG_183_LEN 4
lm's avatar
lm committed
6 7
#define MAVLINK_MSG_ID_SLUGS_ACTION_KEY 0xD4
#define MAVLINK_MSG_183_KEY 0xD4
James Goppert's avatar
James Goppert committed
8 9 10

typedef struct __mavlink_slugs_action_t 
{
lm's avatar
lm committed
11 12 13
	uint16_t actionVal;	///< Value associated with the action
	uint8_t target;	///< The system reporting the action
	uint8_t actionId;	///< Action ID. See apDefinitions.h in the SLUGS /clib directory for the ID names
James Goppert's avatar
James Goppert committed
14 15 16 17

} mavlink_slugs_action_t;

/**
James Goppert's avatar
James Goppert committed
18 19 20 21
 * @brief Pack a slugs_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
James Goppert's avatar
James Goppert committed
22 23 24 25 26 27 28 29
 *
 * @param target The system reporting the action
 * @param actionId Action ID. See apDefinitions.h in the SLUGS /clib directory for the ID names
 * @param actionVal Value associated with the action
 * @return length of the message in bytes (excluding serial stream start sign)
 */
static inline uint16_t mavlink_msg_slugs_action_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, uint8_t target, uint8_t actionId, uint16_t actionVal)
{
lm's avatar
lm committed
30
	mavlink_slugs_action_t *p = (mavlink_slugs_action_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
31 32
	msg->msgid = MAVLINK_MSG_ID_SLUGS_ACTION;

lm's avatar
lm committed
33 34 35
	p->target = target;	// uint8_t:The system reporting the action
	p->actionId = actionId;	// uint8_t:Action ID. See apDefinitions.h in the SLUGS /clib directory for the ID names
	p->actionVal = actionVal;	// uint16_t:Value associated with the action
James Goppert's avatar
James Goppert committed
36

lm's avatar
lm committed
37
	return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_SLUGS_ACTION_LEN);
James Goppert's avatar
James Goppert committed
38 39
}

James Goppert's avatar
James Goppert committed
40 41 42 43 44 45 46 47 48 49 50 51 52
/**
 * @brief Pack a slugs_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 reporting the action
 * @param actionId Action ID. See apDefinitions.h in the SLUGS /clib directory for the ID names
 * @param actionVal Value associated with the action
 * @return length of the message in bytes (excluding serial stream start sign)
 */
static inline uint16_t mavlink_msg_slugs_action_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, uint8_t target, uint8_t actionId, uint16_t actionVal)
{
lm's avatar
lm committed
53
	mavlink_slugs_action_t *p = (mavlink_slugs_action_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
54 55
	msg->msgid = MAVLINK_MSG_ID_SLUGS_ACTION;

lm's avatar
lm committed
56 57 58
	p->target = target;	// uint8_t:The system reporting the action
	p->actionId = actionId;	// uint8_t:Action ID. See apDefinitions.h in the SLUGS /clib directory for the ID names
	p->actionVal = actionVal;	// uint16_t:Value associated with the action
James Goppert's avatar
James Goppert committed
59

lm's avatar
lm committed
60
	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_SLUGS_ACTION_LEN);
James Goppert's avatar
James Goppert committed
61 62 63 64 65 66 67 68 69 70
}

/**
 * @brief Encode a slugs_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 slugs_action C-struct to read the message contents from
 */
James Goppert's avatar
James Goppert committed
71 72 73 74 75
static inline uint16_t mavlink_msg_slugs_action_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_slugs_action_t* slugs_action)
{
	return mavlink_msg_slugs_action_pack(system_id, component_id, msg, slugs_action->target, slugs_action->actionId, slugs_action->actionVal);
}

lm's avatar
lm committed
76 77

#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
James Goppert's avatar
James Goppert committed
78 79 80 81 82 83 84 85
/**
 * @brief Send a slugs_action message
 * @param chan MAVLink channel to send the message
 *
 * @param target The system reporting the action
 * @param actionId Action ID. See apDefinitions.h in the SLUGS /clib directory for the ID names
 * @param actionVal Value associated with the action
 */
lm's avatar
lm committed
86 87 88 89 90
static inline void mavlink_msg_slugs_action_send(mavlink_channel_t chan, uint8_t target, uint8_t actionId, uint16_t actionVal)
{
	mavlink_header_t hdr;
	mavlink_slugs_action_t payload;

lm's avatar
lm committed
91 92 93 94
	MAVLINK_BUFFER_CHECK_START( chan, MAVLINK_MSG_ID_SLUGS_ACTION_LEN )
	payload.target = target;	// uint8_t:The system reporting the action
	payload.actionId = actionId;	// uint8_t:Action ID. See apDefinitions.h in the SLUGS /clib directory for the ID names
	payload.actionVal = actionVal;	// uint16_t:Value associated with the action
lm's avatar
lm committed
95 96 97 98 99 100 101 102 103

	hdr.STX = MAVLINK_STX;
	hdr.len = MAVLINK_MSG_ID_SLUGS_ACTION_LEN;
	hdr.msgid = MAVLINK_MSG_ID_SLUGS_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 );
104
	mavlink_send_mem(chan, (uint8_t *)&payload, sizeof(payload) );
lm's avatar
lm committed
105

lm's avatar
lm committed
106 107 108 109 110 111
	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( 0xD4, &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
112 113 114 115 116 117 118 119 120 121 122 123
}

#endif
// MESSAGE SLUGS_ACTION UNPACKING

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

/**
 * @brief Get field actionId from slugs_action message
 *
 * @return Action ID. See apDefinitions.h in the SLUGS /clib directory for the ID names
 */
static inline uint8_t mavlink_msg_slugs_action_get_actionId(const mavlink_message_t* msg)
{
lm's avatar
lm committed
135 136
	mavlink_slugs_action_t *p = (mavlink_slugs_action_t *)&msg->payload[0];
	return (uint8_t)(p->actionId);
James Goppert's avatar
James Goppert committed
137 138 139 140 141 142 143 144 145
}

/**
 * @brief Get field actionVal from slugs_action message
 *
 * @return Value associated with the action
 */
static inline uint16_t mavlink_msg_slugs_action_get_actionVal(const mavlink_message_t* msg)
{
lm's avatar
lm committed
146 147
	mavlink_slugs_action_t *p = (mavlink_slugs_action_t *)&msg->payload[0];
	return (uint16_t)(p->actionVal);
James Goppert's avatar
James Goppert committed
148 149
}

James Goppert's avatar
James Goppert committed
150 151 152 153 154 155
/**
 * @brief Decode a slugs_action message into a struct
 *
 * @param msg The message to decode
 * @param slugs_action C-struct to decode the message contents into
 */
James Goppert's avatar
James Goppert committed
156 157
static inline void mavlink_msg_slugs_action_decode(const mavlink_message_t* msg, mavlink_slugs_action_t* slugs_action)
{
lm's avatar
lm committed
158
	memcpy( slugs_action, msg->payload, sizeof(mavlink_slugs_action_t));
James Goppert's avatar
James Goppert committed
159
}