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

#define MAVLINK_MSG_ID_VFR_HUD 74

lm's avatar
lm committed
5
typedef struct __mavlink_vfr_hud_t
James Goppert's avatar
James Goppert committed
6
{
lm's avatar
lm committed
7 8 9 10 11 12
 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
13 14
} mavlink_vfr_hud_t;

lm's avatar
lm committed
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
#define MAVLINK_MSG_ID_VFR_HUD_LEN 20
#define MAVLINK_MSG_ID_74_LEN 20



#define MAVLINK_MESSAGE_INFO_VFR_HUD { \
	"VFR_HUD", \
	6, \
	{  { "airspeed", MAVLINK_TYPE_FLOAT, 0, 0, offsetof(mavlink_vfr_hud_t, airspeed) }, \
         { "groundspeed", MAVLINK_TYPE_FLOAT, 0, 4, offsetof(mavlink_vfr_hud_t, groundspeed) }, \
         { "alt", MAVLINK_TYPE_FLOAT, 0, 8, offsetof(mavlink_vfr_hud_t, alt) }, \
         { "climb", MAVLINK_TYPE_FLOAT, 0, 12, offsetof(mavlink_vfr_hud_t, climb) }, \
         { "heading", MAVLINK_TYPE_INT16_T, 0, 16, offsetof(mavlink_vfr_hud_t, heading) }, \
         { "throttle", MAVLINK_TYPE_UINT16_T, 0, 18, offsetof(mavlink_vfr_hud_t, throttle) }, \
         } \
}


James Goppert's avatar
James Goppert committed
33 34 35 36 37 38 39 40 41 42 43 44 45 46
/**
 * @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)
 */
lm's avatar
lm committed
47 48
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)
James Goppert's avatar
James Goppert committed
49 50 51
{
	msg->msgid = MAVLINK_MSG_ID_VFR_HUD;

lm's avatar
lm committed
52 53 54 55 56 57
	put_float_by_index(msg, 0, airspeed); // Current airspeed in m/s
	put_float_by_index(msg, 4, groundspeed); // Current ground speed in m/s
	put_float_by_index(msg, 8, alt); // Current altitude (MSL), in meters
	put_float_by_index(msg, 12, climb); // Current climb rate in meters/second
	put_int16_t_by_index(msg, 16, heading); // Current heading in degrees, in compass units (0..360, 0=north)
	put_uint16_t_by_index(msg, 18, throttle); // Current throttle setting in integer percent, 0 to 100
James Goppert's avatar
James Goppert committed
58

lm's avatar
lm committed
59
	return mavlink_finalize_message(msg, system_id, component_id, 20, 20);
James Goppert's avatar
James Goppert committed
60 61 62
}

/**
lm's avatar
lm committed
63
 * @brief Pack a vfr_hud message on a channel
James Goppert's avatar
James Goppert committed
64 65 66 67 68 69 70 71 72 73 74 75
 * @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)
 */
lm's avatar
lm committed
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
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)
{
	msg->msgid = MAVLINK_MSG_ID_VFR_HUD;

	put_float_by_index(msg, 0, airspeed); // Current airspeed in m/s
	put_float_by_index(msg, 4, groundspeed); // Current ground speed in m/s
	put_float_by_index(msg, 8, alt); // Current altitude (MSL), in meters
	put_float_by_index(msg, 12, climb); // Current climb rate in meters/second
	put_int16_t_by_index(msg, 16, heading); // Current heading in degrees, in compass units (0..360, 0=north)
	put_uint16_t_by_index(msg, 18, throttle); // Current throttle setting in integer percent, 0 to 100

	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, 20, 20);
}

#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

/**
 * @brief Pack a vfr_hud 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 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
 */
static inline void mavlink_msg_vfr_hud_pack_chan_send(mavlink_channel_t chan,
							   mavlink_message_t* msg,
						           float airspeed,float groundspeed,int16_t heading,uint16_t throttle,float alt,float climb)
James Goppert's avatar
James Goppert committed
108 109 110
{
	msg->msgid = MAVLINK_MSG_ID_VFR_HUD;

lm's avatar
lm committed
111 112 113 114 115 116
	put_float_by_index(msg, 0, airspeed); // Current airspeed in m/s
	put_float_by_index(msg, 4, groundspeed); // Current ground speed in m/s
	put_float_by_index(msg, 8, alt); // Current altitude (MSL), in meters
	put_float_by_index(msg, 12, climb); // Current climb rate in meters/second
	put_int16_t_by_index(msg, 16, heading); // Current heading in degrees, in compass units (0..360, 0=north)
	put_uint16_t_by_index(msg, 18, throttle); // Current throttle setting in integer percent, 0 to 100
James Goppert's avatar
James Goppert committed
117

lm's avatar
lm committed
118
	mavlink_finalize_message_chan_send(msg, chan, 20, 20);
James Goppert's avatar
James Goppert committed
119
}
lm's avatar
lm committed
120 121
#endif // MAVLINK_USE_CONVENIENCE_FUNCTIONS

James Goppert's avatar
James Goppert committed
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146

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

/**
 * @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
147 148
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

lm's avatar
lm committed
149 150
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)
{
lm's avatar
lm committed
151 152
	MAVLINK_ALIGNED_MESSAGE(msg, 20);
	mavlink_msg_vfr_hud_pack_chan_send(chan, msg, airspeed, groundspeed, heading, throttle, alt, climb);
James Goppert's avatar
James Goppert committed
153 154 155
}

#endif
lm's avatar
lm committed
156

James Goppert's avatar
James Goppert committed
157 158
// MESSAGE VFR_HUD UNPACKING

lm's avatar
lm committed
159

James Goppert's avatar
James Goppert committed
160 161 162 163 164 165 166
/**
 * @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
167
	return MAVLINK_MSG_RETURN_float(msg,  0);
James Goppert's avatar
James Goppert committed
168 169 170 171 172 173 174 175 176
}

/**
 * @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
177
	return MAVLINK_MSG_RETURN_float(msg,  4);
James Goppert's avatar
James Goppert committed
178 179 180 181 182 183 184 185 186
}

/**
 * @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
187
	return MAVLINK_MSG_RETURN_int16_t(msg,  16);
James Goppert's avatar
James Goppert committed
188 189 190 191 192 193 194 195 196
}

/**
 * @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
197
	return MAVLINK_MSG_RETURN_uint16_t(msg,  18);
James Goppert's avatar
James Goppert committed
198 199 200 201 202 203 204 205 206
}

/**
 * @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
207
	return MAVLINK_MSG_RETURN_float(msg,  8);
James Goppert's avatar
James Goppert committed
208 209 210 211 212 213 214 215 216
}

/**
 * @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
217
	return MAVLINK_MSG_RETURN_float(msg,  12);
James Goppert's avatar
James Goppert committed
218 219 220 221 222 223 224 225 226 227
}

/**
 * @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
228 229 230 231 232 233 234 235 236 237
#if MAVLINK_NEED_BYTE_SWAP
	vfr_hud->airspeed = mavlink_msg_vfr_hud_get_airspeed(msg);
	vfr_hud->groundspeed = mavlink_msg_vfr_hud_get_groundspeed(msg);
	vfr_hud->alt = mavlink_msg_vfr_hud_get_alt(msg);
	vfr_hud->climb = mavlink_msg_vfr_hud_get_climb(msg);
	vfr_hud->heading = mavlink_msg_vfr_hud_get_heading(msg);
	vfr_hud->throttle = mavlink_msg_vfr_hud_get_throttle(msg);
#else
	memcpy(vfr_hud, MAVLINK_PAYLOAD(msg), 20);
#endif
James Goppert's avatar
James Goppert committed
238
}