mavlink_msg_hil_controls.h 13.1 KB
Newer Older
1 2 3 4
// MESSAGE HIL_CONTROLS PACKING

#define MAVLINK_MSG_ID_HIL_CONTROLS 91

lm's avatar
lm committed
5
typedef struct __mavlink_hil_controls_t
6
{
lm's avatar
lm committed
7 8 9 10 11 12 13 14 15 16 17
 uint64_t time_us; ///< Timestamp (microseconds since UNIX epoch or microseconds since system boot)
 float roll_ailerons; ///< Control output -1 .. 1
 float pitch_elevator; ///< Control output -1 .. 1
 float yaw_rudder; ///< Control output -1 .. 1
 float throttle; ///< Throttle 0 .. 1
 float aux1; ///< Aux 1, -1 .. 1
 float aux2; ///< Aux 2, -1 .. 1
 float aux3; ///< Aux 3, -1 .. 1
 float aux4; ///< Aux 4, -1 .. 1
 uint8_t mode; ///< System mode (MAV_MODE)
 uint8_t nav_mode; ///< Navigation mode (MAV_NAV_MODE)
18 19
} mavlink_hil_controls_t;

lm's avatar
lm committed
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
#define MAVLINK_MSG_ID_HIL_CONTROLS_LEN 42
#define MAVLINK_MSG_ID_91_LEN 42



#define MAVLINK_MESSAGE_INFO_HIL_CONTROLS { \
	"HIL_CONTROLS", \
	11, \
	{  { "time_us", MAVLINK_TYPE_UINT64_T, 0, 0, offsetof(mavlink_hil_controls_t, time_us) }, \
         { "roll_ailerons", MAVLINK_TYPE_FLOAT, 0, 8, offsetof(mavlink_hil_controls_t, roll_ailerons) }, \
         { "pitch_elevator", MAVLINK_TYPE_FLOAT, 0, 12, offsetof(mavlink_hil_controls_t, pitch_elevator) }, \
         { "yaw_rudder", MAVLINK_TYPE_FLOAT, 0, 16, offsetof(mavlink_hil_controls_t, yaw_rudder) }, \
         { "throttle", MAVLINK_TYPE_FLOAT, 0, 20, offsetof(mavlink_hil_controls_t, throttle) }, \
         { "aux1", MAVLINK_TYPE_FLOAT, 0, 24, offsetof(mavlink_hil_controls_t, aux1) }, \
         { "aux2", MAVLINK_TYPE_FLOAT, 0, 28, offsetof(mavlink_hil_controls_t, aux2) }, \
         { "aux3", MAVLINK_TYPE_FLOAT, 0, 32, offsetof(mavlink_hil_controls_t, aux3) }, \
         { "aux4", MAVLINK_TYPE_FLOAT, 0, 36, offsetof(mavlink_hil_controls_t, aux4) }, \
         { "mode", MAVLINK_TYPE_UINT8_T, 0, 40, offsetof(mavlink_hil_controls_t, mode) }, \
         { "nav_mode", MAVLINK_TYPE_UINT8_T, 0, 41, offsetof(mavlink_hil_controls_t, nav_mode) }, \
         } \
}


43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
/**
 * @brief Pack a hil_controls 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 time_us Timestamp (microseconds since UNIX epoch or microseconds since system boot)
 * @param roll_ailerons Control output -1 .. 1
 * @param pitch_elevator Control output -1 .. 1
 * @param yaw_rudder Control output -1 .. 1
 * @param throttle Throttle 0 .. 1
 * @param aux1 Aux 1, -1 .. 1
 * @param aux2 Aux 2, -1 .. 1
 * @param aux3 Aux 3, -1 .. 1
 * @param aux4 Aux 4, -1 .. 1
 * @param mode System mode (MAV_MODE)
 * @param nav_mode Navigation mode (MAV_NAV_MODE)
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
62 63
static inline uint16_t mavlink_msg_hil_controls_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
						       uint64_t time_us, float roll_ailerons, float pitch_elevator, float yaw_rudder, float throttle, float aux1, float aux2, float aux3, float aux4, uint8_t mode, uint8_t nav_mode)
64 65 66
{
	msg->msgid = MAVLINK_MSG_ID_HIL_CONTROLS;

lm's avatar
lm committed
67 68 69 70 71 72 73 74 75 76 77 78 79
	put_uint64_t_by_index(msg, 0, time_us); // Timestamp (microseconds since UNIX epoch or microseconds since system boot)
	put_float_by_index(msg, 8, roll_ailerons); // Control output -1 .. 1
	put_float_by_index(msg, 12, pitch_elevator); // Control output -1 .. 1
	put_float_by_index(msg, 16, yaw_rudder); // Control output -1 .. 1
	put_float_by_index(msg, 20, throttle); // Throttle 0 .. 1
	put_float_by_index(msg, 24, aux1); // Aux 1, -1 .. 1
	put_float_by_index(msg, 28, aux2); // Aux 2, -1 .. 1
	put_float_by_index(msg, 32, aux3); // Aux 3, -1 .. 1
	put_float_by_index(msg, 36, aux4); // Aux 4, -1 .. 1
	put_uint8_t_by_index(msg, 40, mode); // System mode (MAV_MODE)
	put_uint8_t_by_index(msg, 41, nav_mode); // Navigation mode (MAV_NAV_MODE)

	return mavlink_finalize_message(msg, system_id, component_id, 42, 250);
80 81 82
}

/**
lm's avatar
lm committed
83
 * @brief Pack a hil_controls message on a channel
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
 * @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 time_us Timestamp (microseconds since UNIX epoch or microseconds since system boot)
 * @param roll_ailerons Control output -1 .. 1
 * @param pitch_elevator Control output -1 .. 1
 * @param yaw_rudder Control output -1 .. 1
 * @param throttle Throttle 0 .. 1
 * @param aux1 Aux 1, -1 .. 1
 * @param aux2 Aux 2, -1 .. 1
 * @param aux3 Aux 3, -1 .. 1
 * @param aux4 Aux 4, -1 .. 1
 * @param mode System mode (MAV_MODE)
 * @param nav_mode Navigation mode (MAV_NAV_MODE)
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
101 102 103
static inline uint16_t mavlink_msg_hil_controls_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
							   mavlink_message_t* msg,
						           uint64_t time_us,float roll_ailerons,float pitch_elevator,float yaw_rudder,float throttle,float aux1,float aux2,float aux3,float aux4,uint8_t mode,uint8_t nav_mode)
104 105 106
{
	msg->msgid = MAVLINK_MSG_ID_HIL_CONTROLS;

lm's avatar
lm committed
107 108 109 110 111 112 113 114 115 116 117 118 119
	put_uint64_t_by_index(msg, 0, time_us); // Timestamp (microseconds since UNIX epoch or microseconds since system boot)
	put_float_by_index(msg, 8, roll_ailerons); // Control output -1 .. 1
	put_float_by_index(msg, 12, pitch_elevator); // Control output -1 .. 1
	put_float_by_index(msg, 16, yaw_rudder); // Control output -1 .. 1
	put_float_by_index(msg, 20, throttle); // Throttle 0 .. 1
	put_float_by_index(msg, 24, aux1); // Aux 1, -1 .. 1
	put_float_by_index(msg, 28, aux2); // Aux 2, -1 .. 1
	put_float_by_index(msg, 32, aux3); // Aux 3, -1 .. 1
	put_float_by_index(msg, 36, aux4); // Aux 4, -1 .. 1
	put_uint8_t_by_index(msg, 40, mode); // System mode (MAV_MODE)
	put_uint8_t_by_index(msg, 41, nav_mode); // Navigation mode (MAV_NAV_MODE)

	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, 42, 250);
120 121
}

lm's avatar
lm 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 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

/**
 * @brief Pack a hil_controls 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 time_us Timestamp (microseconds since UNIX epoch or microseconds since system boot)
 * @param roll_ailerons Control output -1 .. 1
 * @param pitch_elevator Control output -1 .. 1
 * @param yaw_rudder Control output -1 .. 1
 * @param throttle Throttle 0 .. 1
 * @param aux1 Aux 1, -1 .. 1
 * @param aux2 Aux 2, -1 .. 1
 * @param aux3 Aux 3, -1 .. 1
 * @param aux4 Aux 4, -1 .. 1
 * @param mode System mode (MAV_MODE)
 * @param nav_mode Navigation mode (MAV_NAV_MODE)
 */
static inline void mavlink_msg_hil_controls_pack_chan_send(mavlink_channel_t chan,
							   mavlink_message_t* msg,
						           uint64_t time_us,float roll_ailerons,float pitch_elevator,float yaw_rudder,float throttle,float aux1,float aux2,float aux3,float aux4,uint8_t mode,uint8_t nav_mode)
{
	msg->msgid = MAVLINK_MSG_ID_HIL_CONTROLS;

	put_uint64_t_by_index(msg, 0, time_us); // Timestamp (microseconds since UNIX epoch or microseconds since system boot)
	put_float_by_index(msg, 8, roll_ailerons); // Control output -1 .. 1
	put_float_by_index(msg, 12, pitch_elevator); // Control output -1 .. 1
	put_float_by_index(msg, 16, yaw_rudder); // Control output -1 .. 1
	put_float_by_index(msg, 20, throttle); // Throttle 0 .. 1
	put_float_by_index(msg, 24, aux1); // Aux 1, -1 .. 1
	put_float_by_index(msg, 28, aux2); // Aux 2, -1 .. 1
	put_float_by_index(msg, 32, aux3); // Aux 3, -1 .. 1
	put_float_by_index(msg, 36, aux4); // Aux 4, -1 .. 1
	put_uint8_t_by_index(msg, 40, mode); // System mode (MAV_MODE)
	put_uint8_t_by_index(msg, 41, nav_mode); // Navigation mode (MAV_NAV_MODE)

	mavlink_finalize_message_chan_send(msg, chan, 42, 250);
}
#endif // MAVLINK_USE_CONVENIENCE_FUNCTIONS


163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
/**
 * @brief Encode a hil_controls 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 hil_controls C-struct to read the message contents from
 */
static inline uint16_t mavlink_msg_hil_controls_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_hil_controls_t* hil_controls)
{
	return mavlink_msg_hil_controls_pack(system_id, component_id, msg, hil_controls->time_us, hil_controls->roll_ailerons, hil_controls->pitch_elevator, hil_controls->yaw_rudder, hil_controls->throttle, hil_controls->aux1, hil_controls->aux2, hil_controls->aux3, hil_controls->aux4, hil_controls->mode, hil_controls->nav_mode);
}

/**
 * @brief Send a hil_controls message
 * @param chan MAVLink channel to send the message
 *
 * @param time_us Timestamp (microseconds since UNIX epoch or microseconds since system boot)
 * @param roll_ailerons Control output -1 .. 1
 * @param pitch_elevator Control output -1 .. 1
 * @param yaw_rudder Control output -1 .. 1
 * @param throttle Throttle 0 .. 1
 * @param aux1 Aux 1, -1 .. 1
 * @param aux2 Aux 2, -1 .. 1
 * @param aux3 Aux 3, -1 .. 1
 * @param aux4 Aux 4, -1 .. 1
 * @param mode System mode (MAV_MODE)
 * @param nav_mode Navigation mode (MAV_NAV_MODE)
 */
lm's avatar
lm committed
192 193
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

194 195
static inline void mavlink_msg_hil_controls_send(mavlink_channel_t chan, uint64_t time_us, float roll_ailerons, float pitch_elevator, float yaw_rudder, float throttle, float aux1, float aux2, float aux3, float aux4, uint8_t mode, uint8_t nav_mode)
{
lm's avatar
lm committed
196 197
	MAVLINK_ALIGNED_MESSAGE(msg, 42);
	mavlink_msg_hil_controls_pack_chan_send(chan, msg, time_us, roll_ailerons, pitch_elevator, yaw_rudder, throttle, aux1, aux2, aux3, aux4, mode, nav_mode);
198 199 200
}

#endif
lm's avatar
lm committed
201

202 203
// MESSAGE HIL_CONTROLS UNPACKING

lm's avatar
lm committed
204

205 206 207 208 209 210 211
/**
 * @brief Get field time_us from hil_controls message
 *
 * @return Timestamp (microseconds since UNIX epoch or microseconds since system boot)
 */
static inline uint64_t mavlink_msg_hil_controls_get_time_us(const mavlink_message_t* msg)
{
lm's avatar
lm committed
212
	return MAVLINK_MSG_RETURN_uint64_t(msg,  0);
213 214 215 216 217 218 219 220 221
}

/**
 * @brief Get field roll_ailerons from hil_controls message
 *
 * @return Control output -1 .. 1
 */
static inline float mavlink_msg_hil_controls_get_roll_ailerons(const mavlink_message_t* msg)
{
lm's avatar
lm committed
222
	return MAVLINK_MSG_RETURN_float(msg,  8);
223 224 225 226 227 228 229 230 231
}

/**
 * @brief Get field pitch_elevator from hil_controls message
 *
 * @return Control output -1 .. 1
 */
static inline float mavlink_msg_hil_controls_get_pitch_elevator(const mavlink_message_t* msg)
{
lm's avatar
lm committed
232
	return MAVLINK_MSG_RETURN_float(msg,  12);
233 234 235 236 237 238 239 240 241
}

/**
 * @brief Get field yaw_rudder from hil_controls message
 *
 * @return Control output -1 .. 1
 */
static inline float mavlink_msg_hil_controls_get_yaw_rudder(const mavlink_message_t* msg)
{
lm's avatar
lm committed
242
	return MAVLINK_MSG_RETURN_float(msg,  16);
243 244 245 246 247 248 249 250 251
}

/**
 * @brief Get field throttle from hil_controls message
 *
 * @return Throttle 0 .. 1
 */
static inline float mavlink_msg_hil_controls_get_throttle(const mavlink_message_t* msg)
{
lm's avatar
lm committed
252
	return MAVLINK_MSG_RETURN_float(msg,  20);
253 254 255 256 257 258 259 260 261
}

/**
 * @brief Get field aux1 from hil_controls message
 *
 * @return Aux 1, -1 .. 1
 */
static inline float mavlink_msg_hil_controls_get_aux1(const mavlink_message_t* msg)
{
lm's avatar
lm committed
262
	return MAVLINK_MSG_RETURN_float(msg,  24);
263 264 265 266 267 268 269 270 271
}

/**
 * @brief Get field aux2 from hil_controls message
 *
 * @return Aux 2, -1 .. 1
 */
static inline float mavlink_msg_hil_controls_get_aux2(const mavlink_message_t* msg)
{
lm's avatar
lm committed
272
	return MAVLINK_MSG_RETURN_float(msg,  28);
273 274 275 276 277 278 279 280 281
}

/**
 * @brief Get field aux3 from hil_controls message
 *
 * @return Aux 3, -1 .. 1
 */
static inline float mavlink_msg_hil_controls_get_aux3(const mavlink_message_t* msg)
{
lm's avatar
lm committed
282
	return MAVLINK_MSG_RETURN_float(msg,  32);
283 284 285 286 287 288 289 290 291
}

/**
 * @brief Get field aux4 from hil_controls message
 *
 * @return Aux 4, -1 .. 1
 */
static inline float mavlink_msg_hil_controls_get_aux4(const mavlink_message_t* msg)
{
lm's avatar
lm committed
292
	return MAVLINK_MSG_RETURN_float(msg,  36);
293 294 295 296 297 298 299 300 301
}

/**
 * @brief Get field mode from hil_controls message
 *
 * @return System mode (MAV_MODE)
 */
static inline uint8_t mavlink_msg_hil_controls_get_mode(const mavlink_message_t* msg)
{
lm's avatar
lm committed
302
	return MAVLINK_MSG_RETURN_uint8_t(msg,  40);
303 304 305 306 307 308 309 310 311
}

/**
 * @brief Get field nav_mode from hil_controls message
 *
 * @return Navigation mode (MAV_NAV_MODE)
 */
static inline uint8_t mavlink_msg_hil_controls_get_nav_mode(const mavlink_message_t* msg)
{
lm's avatar
lm committed
312
	return MAVLINK_MSG_RETURN_uint8_t(msg,  41);
313 314 315 316 317 318 319 320 321 322
}

/**
 * @brief Decode a hil_controls message into a struct
 *
 * @param msg The message to decode
 * @param hil_controls C-struct to decode the message contents into
 */
static inline void mavlink_msg_hil_controls_decode(const mavlink_message_t* msg, mavlink_hil_controls_t* hil_controls)
{
lm's avatar
lm committed
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
#if MAVLINK_NEED_BYTE_SWAP
	hil_controls->time_us = mavlink_msg_hil_controls_get_time_us(msg);
	hil_controls->roll_ailerons = mavlink_msg_hil_controls_get_roll_ailerons(msg);
	hil_controls->pitch_elevator = mavlink_msg_hil_controls_get_pitch_elevator(msg);
	hil_controls->yaw_rudder = mavlink_msg_hil_controls_get_yaw_rudder(msg);
	hil_controls->throttle = mavlink_msg_hil_controls_get_throttle(msg);
	hil_controls->aux1 = mavlink_msg_hil_controls_get_aux1(msg);
	hil_controls->aux2 = mavlink_msg_hil_controls_get_aux2(msg);
	hil_controls->aux3 = mavlink_msg_hil_controls_get_aux3(msg);
	hil_controls->aux4 = mavlink_msg_hil_controls_get_aux4(msg);
	hil_controls->mode = mavlink_msg_hil_controls_get_mode(msg);
	hil_controls->nav_mode = mavlink_msg_hil_controls_get_nav_mode(msg);
#else
	memcpy(hil_controls, MAVLINK_PAYLOAD(msg), 42);
#endif
338
}