mavlink_msg_auth_key.h 4.04 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
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

typedef struct __mavlink_auth_key_t 
{
	char key[32]; ///< key

} 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
25
	mavlink_auth_key_t *p = (mavlink_auth_key_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
26 27
	msg->msgid = MAVLINK_MSG_ID_AUTH_KEY;

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

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

/**
 * @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
44
	mavlink_auth_key_t *p = (mavlink_auth_key_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
45 46
	msg->msgid = MAVLINK_MSG_ID_AUTH_KEY;

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

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

/**
 * @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);
}

/**
 * @brief Send a auth_key message
 * @param chan MAVLink channel to send the message
 *
 * @param key key
 */
lm's avatar
lm committed
71 72


73
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
lm's avatar
lm committed
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
static inline void mavlink_msg_auth_key_send(mavlink_channel_t chan, const char* key)
{
	mavlink_header_t hdr;
	mavlink_auth_key_t payload;
	uint16_t checksum;
	mavlink_auth_key_t *p = &payload;

	memcpy(p->key, key, sizeof(p->key)); // char[32]:key

	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 );

	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
100 101 102 103 104 105 106 107 108 109
}

#endif
// MESSAGE AUTH_KEY UNPACKING

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

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

/**
 * @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
126
	memcpy( auth_key, msg->payload, sizeof(mavlink_auth_key_t));
James Goppert's avatar
James Goppert committed
127
}