mavlink_msg_auth_key.h 4.09 KB
Newer Older
James Goppert's avatar
James Goppert committed
1 2 3
// MESSAGE AUTH_KEY PACKING

#define MAVLINK_MSG_ID_AUTH_KEY 7
lm's avatar
lm committed
4 5
#define MAVLINK_MSG_ID_AUTH_KEY_LEN 32
#define MAVLINK_MSG_7_LEN 32
lm's avatar
lm committed
6 7
#define MAVLINK_MSG_ID_AUTH_KEY_KEY 0xBA
#define MAVLINK_MSG_7_KEY 0xBA
James Goppert's avatar
James Goppert committed
8 9 10

typedef struct __mavlink_auth_key_t 
{
lm's avatar
lm committed
11
	char key[32];	///< key
James Goppert's avatar
James Goppert committed
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26

} mavlink_auth_key_t;
#define MAVLINK_MSG_AUTH_KEY_FIELD_KEY_LEN 32

/**
 * @brief Pack a auth_key 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 key key
 * @return length of the message in bytes (excluding serial stream start sign)
 */
static inline uint16_t mavlink_msg_auth_key_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const char* key)
{
lm's avatar
lm committed
27
	mavlink_auth_key_t *p = (mavlink_auth_key_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
28 29
	msg->msgid = MAVLINK_MSG_ID_AUTH_KEY;

lm's avatar
lm committed
30
	memcpy(p->key, key, sizeof(p->key));	// char[32]:key
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_AUTH_KEY_LEN);
James Goppert's avatar
James Goppert committed
33 34 35 36 37 38 39 40 41 42 43 44 45
}

/**
 * @brief Pack a auth_key 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 key key
 * @return length of the message in bytes (excluding serial stream start sign)
 */
static inline uint16_t mavlink_msg_auth_key_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const char* key)
{
lm's avatar
lm committed
46
	mavlink_auth_key_t *p = (mavlink_auth_key_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
47 48
	msg->msgid = MAVLINK_MSG_ID_AUTH_KEY;

lm's avatar
lm committed
49
	memcpy(p->key, key, sizeof(p->key));	// char[32]:key
James Goppert's avatar
James Goppert committed
50

lm's avatar
lm committed
51
	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_AUTH_KEY_LEN);
James Goppert's avatar
James Goppert committed
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
}

/**
 * @brief Encode a auth_key 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 auth_key C-struct to read the message contents from
 */
static inline uint16_t mavlink_msg_auth_key_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_auth_key_t* auth_key)
{
	return mavlink_msg_auth_key_pack(system_id, component_id, msg, auth_key->key);
}

lm's avatar
lm committed
67 68

#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
James Goppert's avatar
James Goppert committed
69 70 71 72 73 74
/**
 * @brief Send a auth_key message
 * @param chan MAVLink channel to send the message
 *
 * @param key key
 */
lm's avatar
lm committed
75 76 77 78 79
static inline void mavlink_msg_auth_key_send(mavlink_channel_t chan, const char* key)
{
	mavlink_header_t hdr;
	mavlink_auth_key_t payload;

lm's avatar
lm committed
80 81
	MAVLINK_BUFFER_CHECK_START( chan, MAVLINK_MSG_ID_AUTH_KEY_LEN )
	memcpy(payload.key, key, sizeof(payload.key));	// char[32]:key
lm's avatar
lm committed
82 83 84 85 86 87 88 89 90

	hdr.STX = MAVLINK_STX;
	hdr.len = MAVLINK_MSG_ID_AUTH_KEY_LEN;
	hdr.msgid = MAVLINK_MSG_ID_AUTH_KEY;
	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 );
91
	mavlink_send_mem(chan, (uint8_t *)&payload, sizeof(payload) );
lm's avatar
lm committed
92

lm's avatar
lm committed
93 94 95 96 97 98
	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( 0xBA, &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
99 100 101 102 103 104 105 106 107 108
}

#endif
// MESSAGE AUTH_KEY UNPACKING

/**
 * @brief Get field key from auth_key message
 *
 * @return key
 */
lm's avatar
lm committed
109
static inline uint16_t mavlink_msg_auth_key_get_key(const mavlink_message_t* msg, char* key)
James Goppert's avatar
James Goppert committed
110
{
lm's avatar
lm committed
111
	mavlink_auth_key_t *p = (mavlink_auth_key_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
112

lm's avatar
lm committed
113 114
	memcpy(key, p->key, sizeof(p->key));
	return sizeof(p->key);
James Goppert's avatar
James Goppert committed
115 116 117 118 119 120 121 122 123 124
}

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