mavlink_msg_boot.h 3.95 KB
Newer Older
James Goppert's avatar
James Goppert committed
1 2 3
// MESSAGE BOOT PACKING

#define MAVLINK_MSG_ID_BOOT 1
lm's avatar
lm committed
4 5
#define MAVLINK_MSG_ID_BOOT_LEN 4
#define MAVLINK_MSG_1_LEN 4
lm's avatar
lm committed
6 7
#define MAVLINK_MSG_ID_BOOT_KEY 0xF9
#define MAVLINK_MSG_1_KEY 0xF9
James Goppert's avatar
James Goppert committed
8 9 10

typedef struct __mavlink_boot_t 
{
lm's avatar
lm committed
11
	uint32_t version;	///< The onboard software version
James Goppert's avatar
James Goppert committed
12 13 14 15 16 17 18 19 20 21 22 23 24 25

} mavlink_boot_t;

/**
 * @brief Pack a boot 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 version The onboard software version
 * @return length of the message in bytes (excluding serial stream start sign)
 */
static inline uint16_t mavlink_msg_boot_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, uint32_t version)
{
lm's avatar
lm committed
26
	mavlink_boot_t *p = (mavlink_boot_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
27 28
	msg->msgid = MAVLINK_MSG_ID_BOOT;

lm's avatar
lm committed
29
	p->version = version;	// uint32_t:The onboard software version
James Goppert's avatar
James Goppert committed
30

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

/**
 * @brief Pack a boot 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 version The onboard software version
 * @return length of the message in bytes (excluding serial stream start sign)
 */
static inline uint16_t mavlink_msg_boot_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, uint32_t version)
{
lm's avatar
lm committed
45
	mavlink_boot_t *p = (mavlink_boot_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
46 47
	msg->msgid = MAVLINK_MSG_ID_BOOT;

lm's avatar
lm committed
48
	p->version = version;	// uint32_t:The onboard software version
James Goppert's avatar
James Goppert committed
49

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

/**
 * @brief Encode a boot 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 boot C-struct to read the message contents from
 */
static inline uint16_t mavlink_msg_boot_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_boot_t* boot)
{
	return mavlink_msg_boot_pack(system_id, component_id, msg, boot->version);
}

lm's avatar
lm committed
66 67

#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
James Goppert's avatar
James Goppert committed
68 69 70 71 72 73
/**
 * @brief Send a boot message
 * @param chan MAVLink channel to send the message
 *
 * @param version The onboard software version
 */
lm's avatar
lm committed
74 75 76 77 78
static inline void mavlink_msg_boot_send(mavlink_channel_t chan, uint32_t version)
{
	mavlink_header_t hdr;
	mavlink_boot_t payload;

lm's avatar
lm committed
79 80
	MAVLINK_BUFFER_CHECK_START( chan, MAVLINK_MSG_ID_BOOT_LEN )
	payload.version = version;	// uint32_t:The onboard software version
lm's avatar
lm committed
81 82 83 84 85 86 87 88 89 90

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

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

#endif
// MESSAGE BOOT UNPACKING

/**
 * @brief Get field version from boot message
 *
 * @return The onboard software version
 */
static inline uint32_t mavlink_msg_boot_get_version(const mavlink_message_t* msg)
{
lm's avatar
lm committed
109 110
	mavlink_boot_t *p = (mavlink_boot_t *)&msg->payload[0];
	return (uint32_t)(p->version);
James Goppert's avatar
James Goppert committed
111 112 113 114 115 116 117 118 119 120
}

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