mavlink_msg_vfr_hud.h 9.36 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
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 25 26 27 28 29 30 31 32 33

typedef struct __mavlink_vfr_hud_t 
{
	float airspeed; ///< Current airspeed in m/s
	float groundspeed; ///< Current ground speed in m/s
	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
	float alt; ///< Current altitude (MSL), in meters
	float climb; ///< Current climb rate in meters/second

} 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
34
	mavlink_vfr_hud_t *p = (mavlink_vfr_hud_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
35 36
	msg->msgid = MAVLINK_MSG_ID_VFR_HUD;

lm's avatar
lm committed
37 38 39 40 41 42
	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
43

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

/**
 * @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
63
	mavlink_vfr_hud_t *p = (mavlink_vfr_hud_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
64 65
	msg->msgid = MAVLINK_MSG_ID_VFR_HUD;

lm's avatar
lm committed
66 67 68 69 70 71
	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
72

lm's avatar
lm committed
73
	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_VFR_HUD_LEN);
James Goppert's avatar
James Goppert 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 100 101 102 103
}

/**
 * @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
 */
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
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_message_t msg;
lm's avatar
lm committed
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 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 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
	uint16_t checksum;
	mavlink_vfr_hud_t *p = (mavlink_vfr_hud_t *)&msg.payload[0];

	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

	msg.STX = MAVLINK_STX;
	msg.len = MAVLINK_MSG_ID_VFR_HUD_LEN;
	msg.msgid = MAVLINK_MSG_ID_VFR_HUD;
	msg.sysid = mavlink_system.sysid;
	msg.compid = mavlink_system.compid;
	msg.seq = mavlink_get_channel_status(chan)->current_tx_seq;
	mavlink_get_channel_status(chan)->current_tx_seq = msg.seq + 1;
	checksum = crc_calculate_msg(&msg, msg.len + MAVLINK_CORE_HEADER_LEN);
	msg.ck_a = (uint8_t)(checksum & 0xFF); ///< Low byte
	msg.ck_b = (uint8_t)(checksum >> 8); ///< High byte

	mavlink_send_msg(chan, &msg);
}

#endif

#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS_SMALL
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;
	uint16_t checksum;
	mavlink_vfr_hud_t *p = &payload;

	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

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

	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
162 163 164 165 166 167 168 169 170 171 172 173
}

#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
174 175
	mavlink_vfr_hud_t *p = (mavlink_vfr_hud_t *)&msg->payload[0];
	return (float)(p->airspeed);
James Goppert's avatar
James Goppert committed
176 177 178 179 180 181 182 183 184
}

/**
 * @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
185 186
	mavlink_vfr_hud_t *p = (mavlink_vfr_hud_t *)&msg->payload[0];
	return (float)(p->groundspeed);
James Goppert's avatar
James Goppert committed
187 188 189 190 191 192 193 194 195
}

/**
 * @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
196 197
	mavlink_vfr_hud_t *p = (mavlink_vfr_hud_t *)&msg->payload[0];
	return (int16_t)(p->heading);
James Goppert's avatar
James Goppert committed
198 199 200 201 202 203 204 205 206
}

/**
 * @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
207 208
	mavlink_vfr_hud_t *p = (mavlink_vfr_hud_t *)&msg->payload[0];
	return (uint16_t)(p->throttle);
James Goppert's avatar
James Goppert committed
209 210 211 212 213 214 215 216 217
}

/**
 * @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
218 219
	mavlink_vfr_hud_t *p = (mavlink_vfr_hud_t *)&msg->payload[0];
	return (float)(p->alt);
James Goppert's avatar
James Goppert committed
220 221 222 223 224 225 226 227 228
}

/**
 * @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
229 230
	mavlink_vfr_hud_t *p = (mavlink_vfr_hud_t *)&msg->payload[0];
	return (float)(p->climb);
James Goppert's avatar
James Goppert committed
231 232 233 234 235 236 237 238 239 240
}

/**
 * @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
241
	memcpy( vfr_hud, msg->payload, sizeof(mavlink_vfr_hud_t));
James Goppert's avatar
James Goppert committed
242
}