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

#define MAVLINK_MSG_ID_BOOT 1

lm's avatar
lm committed
5
typedef struct __mavlink_boot_t
James Goppert's avatar
James Goppert committed
6
{
lm's avatar
lm committed
7
 uint32_t version; ///< The onboard software version
James Goppert's avatar
James Goppert committed
8 9 10 11 12 13 14 15 16 17 18
} 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)
 */
lm's avatar
lm committed
19 20
static inline uint16_t mavlink_msg_boot_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
						       uint32_t version)
James Goppert's avatar
James Goppert committed
21 22 23
{
	msg->msgid = MAVLINK_MSG_ID_BOOT;

lm's avatar
lm committed
24
	put_uint32_t_by_index(version, 0,  msg->payload); // The onboard software version
James Goppert's avatar
James Goppert committed
25

lm's avatar
lm committed
26
	return mavlink_finalize_message(msg, system_id, component_id, 4, 61);
James Goppert's avatar
James Goppert committed
27 28 29
}

/**
lm's avatar
lm committed
30
 * @brief Pack a boot message on a channel
James Goppert's avatar
James Goppert committed
31 32 33 34 35 36 37
 * @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)
 */
lm's avatar
lm committed
38 39 40
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)
James Goppert's avatar
James Goppert committed
41 42 43
{
	msg->msgid = MAVLINK_MSG_ID_BOOT;

lm's avatar
lm committed
44
	put_uint32_t_by_index(version, 0,  msg->payload); // The onboard software version
James Goppert's avatar
James Goppert committed
45

lm's avatar
lm committed
46
	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, 4, 61);
James Goppert's avatar
James Goppert committed
47 48
}

lm's avatar
lm committed
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

/**
 * @brief Pack a boot message on a channel and send
 * @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
 */
static inline void mavlink_msg_boot_pack_chan_send(mavlink_channel_t chan,
							   mavlink_message_t* msg,
						           uint32_t version)
{
	msg->msgid = MAVLINK_MSG_ID_BOOT;

	put_uint32_t_by_index(version, 0,  msg->payload); // The onboard software version

	mavlink_finalize_message_chan_send(msg, chan, 4, 61);
}
#endif // MAVLINK_USE_CONVENIENCE_FUNCTIONS


James Goppert's avatar
James Goppert committed
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
/**
 * @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);
}

/**
 * @brief Send a boot message
 * @param chan MAVLink channel to send the message
 *
 * @param version The onboard software version
 */
lm's avatar
lm committed
89 90
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

lm's avatar
lm committed
91 92
static inline void mavlink_msg_boot_send(mavlink_channel_t chan, uint32_t version)
{
lm's avatar
lm committed
93 94
	MAVLINK_ALIGNED_MESSAGE(msg, 4);
	mavlink_msg_boot_pack_chan_send(chan, msg, version);
James Goppert's avatar
James Goppert committed
95 96 97
}

#endif
lm's avatar
lm committed
98

James Goppert's avatar
James Goppert committed
99 100
// MESSAGE BOOT UNPACKING

lm's avatar
lm committed
101

James Goppert's avatar
James Goppert committed
102 103 104 105 106 107 108
/**
 * @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
	return MAVLINK_MSG_RETURN_uint32_t(msg,  0);
James Goppert's avatar
James Goppert committed
110 111 112 113 114 115 116 117 118 119
}

/**
 * @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
120 121 122 123 124
#if MAVLINK_NEED_BYTE_SWAP
	boot->version = mavlink_msg_boot_get_version(msg);
#else
	memcpy(boot, msg->payload, 4);
#endif
James Goppert's avatar
James Goppert committed
125
}