mavlink_msg_set_altitude.h 4.74 KB
Newer Older
James Goppert's avatar
James Goppert committed
1 2 3 4
// MESSAGE SET_ALTITUDE PACKING

#define MAVLINK_MSG_ID_SET_ALTITUDE 65

lm's avatar
lm committed
5
typedef struct __mavlink_set_altitude_t
James Goppert's avatar
James Goppert committed
6
{
lm's avatar
lm committed
7 8
 uint32_t mode; ///< The new altitude in meters
 uint8_t target; ///< The system setting the altitude
James Goppert's avatar
James Goppert committed
9 10 11 12 13 14 15 16 17 18 19 20
} mavlink_set_altitude_t;

/**
 * @brief Pack a set_altitude 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 target The system setting the altitude
 * @param mode The new altitude in meters
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
21 22
static inline uint16_t mavlink_msg_set_altitude_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
						       uint8_t target, uint32_t mode)
James Goppert's avatar
James Goppert committed
23 24 25
{
	msg->msgid = MAVLINK_MSG_ID_SET_ALTITUDE;

lm's avatar
lm committed
26 27
	put_uint32_t_by_index(mode, 0,  msg->payload); // The new altitude in meters
	put_uint8_t_by_index(target, 4,  msg->payload); // The system setting the altitude
James Goppert's avatar
James Goppert committed
28

lm's avatar
lm committed
29
	return mavlink_finalize_message(msg, system_id, component_id, 5, 56);
James Goppert's avatar
James Goppert committed
30 31 32
}

/**
lm's avatar
lm committed
33
 * @brief Pack a set_altitude message on a channel
James Goppert's avatar
James Goppert committed
34 35 36 37 38 39 40 41
 * @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 target The system setting the altitude
 * @param mode The new altitude in meters
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
static inline uint16_t mavlink_msg_set_altitude_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
							   mavlink_message_t* msg,
						           uint8_t target,uint32_t mode)
{
	msg->msgid = MAVLINK_MSG_ID_SET_ALTITUDE;

	put_uint32_t_by_index(mode, 0,  msg->payload); // The new altitude in meters
	put_uint8_t_by_index(target, 4,  msg->payload); // The system setting the altitude

	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, 5, 56);
}

#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

/**
 * @brief Pack a set_altitude 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 target The system setting the altitude
 * @param mode The new altitude in meters
 */
static inline void mavlink_msg_set_altitude_pack_chan_send(mavlink_channel_t chan,
							   mavlink_message_t* msg,
						           uint8_t target,uint32_t mode)
James Goppert's avatar
James Goppert committed
66 67 68
{
	msg->msgid = MAVLINK_MSG_ID_SET_ALTITUDE;

lm's avatar
lm committed
69 70
	put_uint32_t_by_index(mode, 0,  msg->payload); // The new altitude in meters
	put_uint8_t_by_index(target, 4,  msg->payload); // The system setting the altitude
James Goppert's avatar
James Goppert committed
71

lm's avatar
lm committed
72
	mavlink_finalize_message_chan_send(msg, chan, 5, 56);
James Goppert's avatar
James Goppert committed
73
}
lm's avatar
lm committed
74 75
#endif // MAVLINK_USE_CONVENIENCE_FUNCTIONS

James Goppert's avatar
James Goppert committed
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96

/**
 * @brief Encode a set_altitude 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 set_altitude C-struct to read the message contents from
 */
static inline uint16_t mavlink_msg_set_altitude_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_set_altitude_t* set_altitude)
{
	return mavlink_msg_set_altitude_pack(system_id, component_id, msg, set_altitude->target, set_altitude->mode);
}

/**
 * @brief Send a set_altitude message
 * @param chan MAVLink channel to send the message
 *
 * @param target The system setting the altitude
 * @param mode The new altitude in meters
 */
lm's avatar
lm committed
97 98
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

lm's avatar
lm committed
99 100
static inline void mavlink_msg_set_altitude_send(mavlink_channel_t chan, uint8_t target, uint32_t mode)
{
lm's avatar
lm committed
101 102
	MAVLINK_ALIGNED_MESSAGE(msg, 5);
	mavlink_msg_set_altitude_pack_chan_send(chan, msg, target, mode);
James Goppert's avatar
James Goppert committed
103 104 105
}

#endif
lm's avatar
lm committed
106

James Goppert's avatar
James Goppert committed
107 108
// MESSAGE SET_ALTITUDE UNPACKING

lm's avatar
lm committed
109

James Goppert's avatar
James Goppert committed
110 111 112 113 114 115 116
/**
 * @brief Get field target from set_altitude message
 *
 * @return The system setting the altitude
 */
static inline uint8_t mavlink_msg_set_altitude_get_target(const mavlink_message_t* msg)
{
lm's avatar
lm committed
117
	return MAVLINK_MSG_RETURN_uint8_t(msg,  4);
James Goppert's avatar
James Goppert committed
118 119 120 121 122 123 124 125 126
}

/**
 * @brief Get field mode from set_altitude message
 *
 * @return The new altitude in meters
 */
static inline uint32_t mavlink_msg_set_altitude_get_mode(const mavlink_message_t* msg)
{
lm's avatar
lm committed
127
	return MAVLINK_MSG_RETURN_uint32_t(msg,  0);
James Goppert's avatar
James Goppert committed
128 129 130 131 132 133 134 135 136 137
}

/**
 * @brief Decode a set_altitude message into a struct
 *
 * @param msg The message to decode
 * @param set_altitude C-struct to decode the message contents into
 */
static inline void mavlink_msg_set_altitude_decode(const mavlink_message_t* msg, mavlink_set_altitude_t* set_altitude)
{
lm's avatar
lm committed
138 139 140 141 142 143
#if MAVLINK_NEED_BYTE_SWAP
	set_altitude->mode = mavlink_msg_set_altitude_get_mode(msg);
	set_altitude->target = mavlink_msg_set_altitude_get_target(msg);
#else
	memcpy(set_altitude, msg->payload, 5);
#endif
James Goppert's avatar
James Goppert committed
144
}