mavlink_msg_control_status.h 12.5 KB
Newer Older
James Goppert's avatar
James Goppert committed
1 2 3
// MESSAGE CONTROL_STATUS PACKING

#define MAVLINK_MSG_ID_CONTROL_STATUS 52
lm's avatar
lm committed
4 5
#define MAVLINK_MSG_ID_CONTROL_STATUS_LEN 8
#define MAVLINK_MSG_52_LEN 8
lm's avatar
lm committed
6 7
#define MAVLINK_MSG_ID_CONTROL_STATUS_KEY 0xF9
#define MAVLINK_MSG_52_KEY 0xF9
James Goppert's avatar
James Goppert committed
8 9 10

typedef struct __mavlink_control_status_t 
{
lm's avatar
lm committed
11 12 13 14 15 16 17 18
	uint8_t position_fix;	///< Position fix: 0: lost, 2: 2D position fix, 3: 3D position fix 
	uint8_t vision_fix;	///< Vision position fix: 0: lost, 1: 2D local position hold, 2: 2D global position fix, 3: 3D global position fix 
	uint8_t gps_fix;	///< GPS position fix: 0: no reception, 1: Minimum 1 satellite, but no position fix, 2: 2D position fix, 3: 3D position fix 
	uint8_t ahrs_health;	///< Attitude estimation health: 0: poor, 255: excellent
	uint8_t control_att;	///< 0: Attitude control disabled, 1: enabled
	uint8_t control_pos_xy;	///< 0: X, Y position control disabled, 1: enabled
	uint8_t control_pos_z;	///< 0: Z position control disabled, 1: enabled
	uint8_t control_pos_yaw;	///< 0: Yaw angle control disabled, 1: enabled
James Goppert's avatar
James Goppert committed
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39

} mavlink_control_status_t;

/**
 * @brief Pack a control_status 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 position_fix Position fix: 0: lost, 2: 2D position fix, 3: 3D position fix 
 * @param vision_fix Vision position fix: 0: lost, 1: 2D local position hold, 2: 2D global position fix, 3: 3D global position fix 
 * @param gps_fix GPS position fix: 0: no reception, 1: Minimum 1 satellite, but no position fix, 2: 2D position fix, 3: 3D position fix 
 * @param ahrs_health Attitude estimation health: 0: poor, 255: excellent
 * @param control_att 0: Attitude control disabled, 1: enabled
 * @param control_pos_xy 0: X, Y position control disabled, 1: enabled
 * @param control_pos_z 0: Z position control disabled, 1: enabled
 * @param control_pos_yaw 0: Yaw angle control disabled, 1: enabled
 * @return length of the message in bytes (excluding serial stream start sign)
 */
static inline uint16_t mavlink_msg_control_status_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, uint8_t position_fix, uint8_t vision_fix, uint8_t gps_fix, uint8_t ahrs_health, uint8_t control_att, uint8_t control_pos_xy, uint8_t control_pos_z, uint8_t control_pos_yaw)
{
lm's avatar
lm committed
40
	mavlink_control_status_t *p = (mavlink_control_status_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
41 42
	msg->msgid = MAVLINK_MSG_ID_CONTROL_STATUS;

lm's avatar
lm committed
43 44 45 46 47 48 49 50
	p->position_fix = position_fix;	// uint8_t:Position fix: 0: lost, 2: 2D position fix, 3: 3D position fix 
	p->vision_fix = vision_fix;	// uint8_t:Vision position fix: 0: lost, 1: 2D local position hold, 2: 2D global position fix, 3: 3D global position fix 
	p->gps_fix = gps_fix;	// uint8_t:GPS position fix: 0: no reception, 1: Minimum 1 satellite, but no position fix, 2: 2D position fix, 3: 3D position fix 
	p->ahrs_health = ahrs_health;	// uint8_t:Attitude estimation health: 0: poor, 255: excellent
	p->control_att = control_att;	// uint8_t:0: Attitude control disabled, 1: enabled
	p->control_pos_xy = control_pos_xy;	// uint8_t:0: X, Y position control disabled, 1: enabled
	p->control_pos_z = control_pos_z;	// uint8_t:0: Z position control disabled, 1: enabled
	p->control_pos_yaw = control_pos_yaw;	// uint8_t:0: Yaw angle control disabled, 1: enabled
James Goppert's avatar
James Goppert committed
51

lm's avatar
lm committed
52
	return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_CONTROL_STATUS_LEN);
James Goppert's avatar
James Goppert committed
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
}

/**
 * @brief Pack a control_status 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 position_fix Position fix: 0: lost, 2: 2D position fix, 3: 3D position fix 
 * @param vision_fix Vision position fix: 0: lost, 1: 2D local position hold, 2: 2D global position fix, 3: 3D global position fix 
 * @param gps_fix GPS position fix: 0: no reception, 1: Minimum 1 satellite, but no position fix, 2: 2D position fix, 3: 3D position fix 
 * @param ahrs_health Attitude estimation health: 0: poor, 255: excellent
 * @param control_att 0: Attitude control disabled, 1: enabled
 * @param control_pos_xy 0: X, Y position control disabled, 1: enabled
 * @param control_pos_z 0: Z position control disabled, 1: enabled
 * @param control_pos_yaw 0: Yaw angle control disabled, 1: enabled
 * @return length of the message in bytes (excluding serial stream start sign)
 */
static inline uint16_t mavlink_msg_control_status_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, uint8_t position_fix, uint8_t vision_fix, uint8_t gps_fix, uint8_t ahrs_health, uint8_t control_att, uint8_t control_pos_xy, uint8_t control_pos_z, uint8_t control_pos_yaw)
{
lm's avatar
lm committed
73
	mavlink_control_status_t *p = (mavlink_control_status_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
74 75
	msg->msgid = MAVLINK_MSG_ID_CONTROL_STATUS;

lm's avatar
lm committed
76 77 78 79 80 81 82 83
	p->position_fix = position_fix;	// uint8_t:Position fix: 0: lost, 2: 2D position fix, 3: 3D position fix 
	p->vision_fix = vision_fix;	// uint8_t:Vision position fix: 0: lost, 1: 2D local position hold, 2: 2D global position fix, 3: 3D global position fix 
	p->gps_fix = gps_fix;	// uint8_t:GPS position fix: 0: no reception, 1: Minimum 1 satellite, but no position fix, 2: 2D position fix, 3: 3D position fix 
	p->ahrs_health = ahrs_health;	// uint8_t:Attitude estimation health: 0: poor, 255: excellent
	p->control_att = control_att;	// uint8_t:0: Attitude control disabled, 1: enabled
	p->control_pos_xy = control_pos_xy;	// uint8_t:0: X, Y position control disabled, 1: enabled
	p->control_pos_z = control_pos_z;	// uint8_t:0: Z position control disabled, 1: enabled
	p->control_pos_yaw = control_pos_yaw;	// uint8_t:0: Yaw angle control disabled, 1: enabled
James Goppert's avatar
James Goppert committed
84

lm's avatar
lm committed
85
	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_CONTROL_STATUS_LEN);
James Goppert's avatar
James Goppert committed
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
}

/**
 * @brief Encode a control_status 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 control_status C-struct to read the message contents from
 */
static inline uint16_t mavlink_msg_control_status_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_control_status_t* control_status)
{
	return mavlink_msg_control_status_pack(system_id, component_id, msg, control_status->position_fix, control_status->vision_fix, control_status->gps_fix, control_status->ahrs_health, control_status->control_att, control_status->control_pos_xy, control_status->control_pos_z, control_status->control_pos_yaw);
}

lm's avatar
lm committed
101 102

#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
James Goppert's avatar
James Goppert committed
103 104 105 106 107 108 109 110 111 112 113 114 115
/**
 * @brief Send a control_status message
 * @param chan MAVLink channel to send the message
 *
 * @param position_fix Position fix: 0: lost, 2: 2D position fix, 3: 3D position fix 
 * @param vision_fix Vision position fix: 0: lost, 1: 2D local position hold, 2: 2D global position fix, 3: 3D global position fix 
 * @param gps_fix GPS position fix: 0: no reception, 1: Minimum 1 satellite, but no position fix, 2: 2D position fix, 3: 3D position fix 
 * @param ahrs_health Attitude estimation health: 0: poor, 255: excellent
 * @param control_att 0: Attitude control disabled, 1: enabled
 * @param control_pos_xy 0: X, Y position control disabled, 1: enabled
 * @param control_pos_z 0: Z position control disabled, 1: enabled
 * @param control_pos_yaw 0: Yaw angle control disabled, 1: enabled
 */
lm's avatar
lm committed
116 117 118 119
static inline void mavlink_msg_control_status_send(mavlink_channel_t chan, uint8_t position_fix, uint8_t vision_fix, uint8_t gps_fix, uint8_t ahrs_health, uint8_t control_att, uint8_t control_pos_xy, uint8_t control_pos_z, uint8_t control_pos_yaw)
{
	mavlink_header_t hdr;
	mavlink_control_status_t payload;
lm's avatar
lm committed
120 121 122 123 124 125 126 127 128 129

	MAVLINK_BUFFER_CHECK_START( chan, MAVLINK_MSG_ID_CONTROL_STATUS_LEN )
	payload.position_fix = position_fix;	// uint8_t:Position fix: 0: lost, 2: 2D position fix, 3: 3D position fix 
	payload.vision_fix = vision_fix;	// uint8_t:Vision position fix: 0: lost, 1: 2D local position hold, 2: 2D global position fix, 3: 3D global position fix 
	payload.gps_fix = gps_fix;	// uint8_t:GPS position fix: 0: no reception, 1: Minimum 1 satellite, but no position fix, 2: 2D position fix, 3: 3D position fix 
	payload.ahrs_health = ahrs_health;	// uint8_t:Attitude estimation health: 0: poor, 255: excellent
	payload.control_att = control_att;	// uint8_t:0: Attitude control disabled, 1: enabled
	payload.control_pos_xy = control_pos_xy;	// uint8_t:0: X, Y position control disabled, 1: enabled
	payload.control_pos_z = control_pos_z;	// uint8_t:0: Z position control disabled, 1: enabled
	payload.control_pos_yaw = control_pos_yaw;	// uint8_t:0: Yaw angle control disabled, 1: enabled
lm's avatar
lm committed
130 131 132 133 134 135 136 137 138 139

	hdr.STX = MAVLINK_STX;
	hdr.len = MAVLINK_MSG_ID_CONTROL_STATUS_LEN;
	hdr.msgid = MAVLINK_MSG_ID_CONTROL_STATUS;
	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
140 141 142 143 144 145
	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( 0xF9, &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
146 147 148 149 150 151 152 153 154 155 156 157
}

#endif
// MESSAGE CONTROL_STATUS UNPACKING

/**
 * @brief Get field position_fix from control_status message
 *
 * @return Position fix: 0: lost, 2: 2D position fix, 3: 3D position fix 
 */
static inline uint8_t mavlink_msg_control_status_get_position_fix(const mavlink_message_t* msg)
{
lm's avatar
lm committed
158 159
	mavlink_control_status_t *p = (mavlink_control_status_t *)&msg->payload[0];
	return (uint8_t)(p->position_fix);
James Goppert's avatar
James Goppert committed
160 161 162 163 164 165 166 167 168
}

/**
 * @brief Get field vision_fix from control_status message
 *
 * @return Vision position fix: 0: lost, 1: 2D local position hold, 2: 2D global position fix, 3: 3D global position fix 
 */
static inline uint8_t mavlink_msg_control_status_get_vision_fix(const mavlink_message_t* msg)
{
lm's avatar
lm committed
169 170
	mavlink_control_status_t *p = (mavlink_control_status_t *)&msg->payload[0];
	return (uint8_t)(p->vision_fix);
James Goppert's avatar
James Goppert committed
171 172 173 174 175 176 177 178 179
}

/**
 * @brief Get field gps_fix from control_status message
 *
 * @return GPS position fix: 0: no reception, 1: Minimum 1 satellite, but no position fix, 2: 2D position fix, 3: 3D position fix 
 */
static inline uint8_t mavlink_msg_control_status_get_gps_fix(const mavlink_message_t* msg)
{
lm's avatar
lm committed
180 181
	mavlink_control_status_t *p = (mavlink_control_status_t *)&msg->payload[0];
	return (uint8_t)(p->gps_fix);
James Goppert's avatar
James Goppert committed
182 183 184 185 186 187 188 189 190
}

/**
 * @brief Get field ahrs_health from control_status message
 *
 * @return Attitude estimation health: 0: poor, 255: excellent
 */
static inline uint8_t mavlink_msg_control_status_get_ahrs_health(const mavlink_message_t* msg)
{
lm's avatar
lm committed
191 192
	mavlink_control_status_t *p = (mavlink_control_status_t *)&msg->payload[0];
	return (uint8_t)(p->ahrs_health);
James Goppert's avatar
James Goppert committed
193 194 195 196 197 198 199 200 201
}

/**
 * @brief Get field control_att from control_status message
 *
 * @return 0: Attitude control disabled, 1: enabled
 */
static inline uint8_t mavlink_msg_control_status_get_control_att(const mavlink_message_t* msg)
{
lm's avatar
lm committed
202 203
	mavlink_control_status_t *p = (mavlink_control_status_t *)&msg->payload[0];
	return (uint8_t)(p->control_att);
James Goppert's avatar
James Goppert committed
204 205 206 207 208 209 210 211 212
}

/**
 * @brief Get field control_pos_xy from control_status message
 *
 * @return 0: X, Y position control disabled, 1: enabled
 */
static inline uint8_t mavlink_msg_control_status_get_control_pos_xy(const mavlink_message_t* msg)
{
lm's avatar
lm committed
213 214
	mavlink_control_status_t *p = (mavlink_control_status_t *)&msg->payload[0];
	return (uint8_t)(p->control_pos_xy);
James Goppert's avatar
James Goppert committed
215 216 217 218 219 220 221 222 223
}

/**
 * @brief Get field control_pos_z from control_status message
 *
 * @return 0: Z position control disabled, 1: enabled
 */
static inline uint8_t mavlink_msg_control_status_get_control_pos_z(const mavlink_message_t* msg)
{
lm's avatar
lm committed
224 225
	mavlink_control_status_t *p = (mavlink_control_status_t *)&msg->payload[0];
	return (uint8_t)(p->control_pos_z);
James Goppert's avatar
James Goppert committed
226 227 228 229 230 231 232 233 234
}

/**
 * @brief Get field control_pos_yaw from control_status message
 *
 * @return 0: Yaw angle control disabled, 1: enabled
 */
static inline uint8_t mavlink_msg_control_status_get_control_pos_yaw(const mavlink_message_t* msg)
{
lm's avatar
lm committed
235 236
	mavlink_control_status_t *p = (mavlink_control_status_t *)&msg->payload[0];
	return (uint8_t)(p->control_pos_yaw);
James Goppert's avatar
James Goppert committed
237 238 239 240 241 242 243 244 245 246
}

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