mavlink_msg_vfr_hud.h 8.13 KB
Newer Older
James Goppert's avatar
James Goppert committed
1 2 3
// MESSAGE VFR_HUD PACKING

#define MAVLINK_MSG_ID_VFR_HUD 74
lm's avatar
lm committed
4 5
#define MAVLINK_MSG_ID_VFR_HUD_LEN 20
#define MAVLINK_MSG_74_LEN 20
lm's avatar
lm committed
6 7
#define MAVLINK_MSG_ID_VFR_HUD_KEY 0xFB
#define MAVLINK_MSG_74_KEY 0xFB
James Goppert's avatar
James Goppert committed
8 9 10

typedef struct __mavlink_vfr_hud_t 
{
lm's avatar
lm committed
11 12 13 14 15 16
	float airspeed;	///< Current airspeed in m/s
	float groundspeed;	///< Current ground speed in m/s
	float alt;	///< Current altitude (MSL), in meters
	float climb;	///< Current climb rate in meters/second
	int16_t heading;	///< Current heading in degrees, in compass units (0..360, 0=north)
	uint16_t throttle;	///< Current throttle setting in integer percent, 0 to 100
James Goppert's avatar
James Goppert committed
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35

} mavlink_vfr_hud_t;

/**
 * @brief Pack a vfr_hud 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 airspeed Current airspeed in m/s
 * @param groundspeed Current ground speed in m/s
 * @param heading Current heading in degrees, in compass units (0..360, 0=north)
 * @param throttle Current throttle setting in integer percent, 0 to 100
 * @param alt Current altitude (MSL), in meters
 * @param climb Current climb rate in meters/second
 * @return length of the message in bytes (excluding serial stream start sign)
 */
static inline uint16_t mavlink_msg_vfr_hud_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, float airspeed, float groundspeed, int16_t heading, uint16_t throttle, float alt, float climb)
{
lm's avatar
lm committed
36
	mavlink_vfr_hud_t *p = (mavlink_vfr_hud_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
37 38
	msg->msgid = MAVLINK_MSG_ID_VFR_HUD;

lm's avatar
lm committed
39 40 41 42 43 44
	p->airspeed = airspeed;	// float:Current airspeed in m/s
	p->groundspeed = groundspeed;	// float:Current ground speed in m/s
	p->heading = heading;	// int16_t:Current heading in degrees, in compass units (0..360, 0=north)
	p->throttle = throttle;	// uint16_t:Current throttle setting in integer percent, 0 to 100
	p->alt = alt;	// float:Current altitude (MSL), in meters
	p->climb = climb;	// float:Current climb rate in meters/second
James Goppert's avatar
James Goppert committed
45

lm's avatar
lm committed
46
	return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_VFR_HUD_LEN);
James Goppert's avatar
James Goppert committed
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
}

/**
 * @brief Pack a vfr_hud 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 airspeed Current airspeed in m/s
 * @param groundspeed Current ground speed in m/s
 * @param heading Current heading in degrees, in compass units (0..360, 0=north)
 * @param throttle Current throttle setting in integer percent, 0 to 100
 * @param alt Current altitude (MSL), in meters
 * @param climb Current climb rate in meters/second
 * @return length of the message in bytes (excluding serial stream start sign)
 */
static inline uint16_t mavlink_msg_vfr_hud_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, float airspeed, float groundspeed, int16_t heading, uint16_t throttle, float alt, float climb)
{
lm's avatar
lm committed
65
	mavlink_vfr_hud_t *p = (mavlink_vfr_hud_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
66 67
	msg->msgid = MAVLINK_MSG_ID_VFR_HUD;

lm's avatar
lm committed
68 69 70 71 72 73
	p->airspeed = airspeed;	// float:Current airspeed in m/s
	p->groundspeed = groundspeed;	// float:Current ground speed in m/s
	p->heading = heading;	// int16_t:Current heading in degrees, in compass units (0..360, 0=north)
	p->throttle = throttle;	// uint16_t:Current throttle setting in integer percent, 0 to 100
	p->alt = alt;	// float:Current altitude (MSL), in meters
	p->climb = climb;	// float:Current climb rate in meters/second
James Goppert's avatar
James Goppert committed
74

lm's avatar
lm committed
75
	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_VFR_HUD_LEN);
James Goppert's avatar
James Goppert committed
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
}

/**
 * @brief Encode a vfr_hud 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 vfr_hud C-struct to read the message contents from
 */
static inline uint16_t mavlink_msg_vfr_hud_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_vfr_hud_t* vfr_hud)
{
	return mavlink_msg_vfr_hud_pack(system_id, component_id, msg, vfr_hud->airspeed, vfr_hud->groundspeed, vfr_hud->heading, vfr_hud->throttle, vfr_hud->alt, vfr_hud->climb);
}

lm's avatar
lm committed
91 92

#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
James Goppert's avatar
James Goppert committed
93 94 95 96 97 98 99 100 101 102 103
/**
 * @brief Send a vfr_hud message
 * @param chan MAVLink channel to send the message
 *
 * @param airspeed Current airspeed in m/s
 * @param groundspeed Current ground speed in m/s
 * @param heading Current heading in degrees, in compass units (0..360, 0=north)
 * @param throttle Current throttle setting in integer percent, 0 to 100
 * @param alt Current altitude (MSL), in meters
 * @param climb Current climb rate in meters/second
 */
lm's avatar
lm committed
104 105 106 107 108
static inline void mavlink_msg_vfr_hud_send(mavlink_channel_t chan, float airspeed, float groundspeed, int16_t heading, uint16_t throttle, float alt, float climb)
{
	mavlink_header_t hdr;
	mavlink_vfr_hud_t payload;

lm's avatar
lm committed
109 110 111 112 113 114 115
	MAVLINK_BUFFER_CHECK_START( chan, MAVLINK_MSG_ID_VFR_HUD_LEN )
	payload.airspeed = airspeed;	// float:Current airspeed in m/s
	payload.groundspeed = groundspeed;	// float:Current ground speed in m/s
	payload.heading = heading;	// int16_t:Current heading in degrees, in compass units (0..360, 0=north)
	payload.throttle = throttle;	// uint16_t:Current throttle setting in integer percent, 0 to 100
	payload.alt = alt;	// float:Current altitude (MSL), in meters
	payload.climb = climb;	// float:Current climb rate in meters/second
lm's avatar
lm committed
116 117 118 119 120 121 122 123 124 125

	hdr.STX = MAVLINK_STX;
	hdr.len = MAVLINK_MSG_ID_VFR_HUD_LEN;
	hdr.msgid = MAVLINK_MSG_ID_VFR_HUD;
	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
126 127 128 129 130 131
	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( 0xFB, &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
132 133 134 135 136 137 138 139 140 141 142 143
}

#endif
// MESSAGE VFR_HUD UNPACKING

/**
 * @brief Get field airspeed from vfr_hud message
 *
 * @return Current airspeed in m/s
 */
static inline float mavlink_msg_vfr_hud_get_airspeed(const mavlink_message_t* msg)
{
lm's avatar
lm committed
144 145
	mavlink_vfr_hud_t *p = (mavlink_vfr_hud_t *)&msg->payload[0];
	return (float)(p->airspeed);
James Goppert's avatar
James Goppert committed
146 147 148 149 150 151 152 153 154
}

/**
 * @brief Get field groundspeed from vfr_hud message
 *
 * @return Current ground speed in m/s
 */
static inline float mavlink_msg_vfr_hud_get_groundspeed(const mavlink_message_t* msg)
{
lm's avatar
lm committed
155 156
	mavlink_vfr_hud_t *p = (mavlink_vfr_hud_t *)&msg->payload[0];
	return (float)(p->groundspeed);
James Goppert's avatar
James Goppert committed
157 158 159 160 161 162 163 164 165
}

/**
 * @brief Get field heading from vfr_hud message
 *
 * @return Current heading in degrees, in compass units (0..360, 0=north)
 */
static inline int16_t mavlink_msg_vfr_hud_get_heading(const mavlink_message_t* msg)
{
lm's avatar
lm committed
166 167
	mavlink_vfr_hud_t *p = (mavlink_vfr_hud_t *)&msg->payload[0];
	return (int16_t)(p->heading);
James Goppert's avatar
James Goppert committed
168 169 170 171 172 173 174 175 176
}

/**
 * @brief Get field throttle from vfr_hud message
 *
 * @return Current throttle setting in integer percent, 0 to 100
 */
static inline uint16_t mavlink_msg_vfr_hud_get_throttle(const mavlink_message_t* msg)
{
lm's avatar
lm committed
177 178
	mavlink_vfr_hud_t *p = (mavlink_vfr_hud_t *)&msg->payload[0];
	return (uint16_t)(p->throttle);
James Goppert's avatar
James Goppert committed
179 180 181 182 183 184 185 186 187
}

/**
 * @brief Get field alt from vfr_hud message
 *
 * @return Current altitude (MSL), in meters
 */
static inline float mavlink_msg_vfr_hud_get_alt(const mavlink_message_t* msg)
{
lm's avatar
lm committed
188 189
	mavlink_vfr_hud_t *p = (mavlink_vfr_hud_t *)&msg->payload[0];
	return (float)(p->alt);
James Goppert's avatar
James Goppert committed
190 191 192 193 194 195 196 197 198
}

/**
 * @brief Get field climb from vfr_hud message
 *
 * @return Current climb rate in meters/second
 */
static inline float mavlink_msg_vfr_hud_get_climb(const mavlink_message_t* msg)
{
lm's avatar
lm committed
199 200
	mavlink_vfr_hud_t *p = (mavlink_vfr_hud_t *)&msg->payload[0];
	return (float)(p->climb);
James Goppert's avatar
James Goppert committed
201 202 203 204 205 206 207 208 209 210
}

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