mavlink_msg_manual_control.h 13.5 KB
Newer Older
James Goppert's avatar
James Goppert committed
1 2 3 4
// MESSAGE MANUAL_CONTROL PACKING

#define MAVLINK_MSG_ID_MANUAL_CONTROL 69

lm's avatar
lm committed
5
typedef struct __mavlink_manual_control_t
James Goppert's avatar
James Goppert committed
6
{
Lorenz Meier's avatar
Lorenz Meier committed
7 8 9 10 11 12
 int16_t x; ///< X-axis, normalized to the range [-1000,1000]. A value of INT16_MAX indicates that this axis is invalid. Generally corresponds to forward(1000)-backward(-1000) movement on a joystick and the pitch of a vehicle.
 int16_t y; ///< Y-axis, normalized to the range [-1000,1000]. A value of INT16_MAX indicates that this axis is invalid. Generally corresponds to left(-1000)-right(1000) movement on a joystick and the roll of a vehicle.
 int16_t z; ///< Z-axis, normalized to the range [-1000,1000]. A value of INT16_MAX indicates that this axis is invalid. Generally corresponds to a separate slider movement with maximum being 1000 and minimum being -1000 on a joystick and the thrust of a vehicle.
 int16_t r; ///< R-axis, normalized to the range [-1000,1000]. A value of INT16_MAX indicates that this axis is invalid. Generally corresponds to a twisting of the joystick, with counter-clockwise being 1000 and clockwise being -1000, and the yaw of a vehicle.
 uint16_t buttons; ///< A bitfield corresponding to the joystick buttons' current state, 1 for pressed, 0 for released. The lowest bit corresponds to Button 1.
 uint8_t target; ///< The system to be controlled.
James Goppert's avatar
James Goppert committed
13 14
} mavlink_manual_control_t;

Lorenz Meier's avatar
Lorenz Meier committed
15 16
#define MAVLINK_MSG_ID_MANUAL_CONTROL_LEN 11
#define MAVLINK_MSG_ID_69_LEN 11
lm's avatar
lm committed
17

Lorenz Meier's avatar
Lorenz Meier committed
18 19 20
#define MAVLINK_MSG_ID_MANUAL_CONTROL_CRC 243
#define MAVLINK_MSG_ID_69_CRC 243

lm's avatar
lm committed
21 22 23 24


#define MAVLINK_MESSAGE_INFO_MANUAL_CONTROL { \
	"MANUAL_CONTROL", \
Lorenz Meier's avatar
Lorenz Meier committed
25 26 27 28 29 30 31
	6, \
	{  { "x", NULL, MAVLINK_TYPE_INT16_T, 0, 0, offsetof(mavlink_manual_control_t, x) }, \
         { "y", NULL, MAVLINK_TYPE_INT16_T, 0, 2, offsetof(mavlink_manual_control_t, y) }, \
         { "z", NULL, MAVLINK_TYPE_INT16_T, 0, 4, offsetof(mavlink_manual_control_t, z) }, \
         { "r", NULL, MAVLINK_TYPE_INT16_T, 0, 6, offsetof(mavlink_manual_control_t, r) }, \
         { "buttons", NULL, MAVLINK_TYPE_UINT16_T, 0, 8, offsetof(mavlink_manual_control_t, buttons) }, \
         { "target", NULL, MAVLINK_TYPE_UINT8_T, 0, 10, offsetof(mavlink_manual_control_t, target) }, \
lm's avatar
lm committed
32 33 34 35
         } \
}


James Goppert's avatar
James Goppert committed
36 37 38 39 40 41
/**
 * @brief Pack a manual_control 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
 *
Lorenz Meier's avatar
Lorenz Meier committed
42 43 44 45 46 47
 * @param target The system to be controlled.
 * @param x X-axis, normalized to the range [-1000,1000]. A value of INT16_MAX indicates that this axis is invalid. Generally corresponds to forward(1000)-backward(-1000) movement on a joystick and the pitch of a vehicle.
 * @param y Y-axis, normalized to the range [-1000,1000]. A value of INT16_MAX indicates that this axis is invalid. Generally corresponds to left(-1000)-right(1000) movement on a joystick and the roll of a vehicle.
 * @param z Z-axis, normalized to the range [-1000,1000]. A value of INT16_MAX indicates that this axis is invalid. Generally corresponds to a separate slider movement with maximum being 1000 and minimum being -1000 on a joystick and the thrust of a vehicle.
 * @param r R-axis, normalized to the range [-1000,1000]. A value of INT16_MAX indicates that this axis is invalid. Generally corresponds to a twisting of the joystick, with counter-clockwise being 1000 and clockwise being -1000, and the yaw of a vehicle.
 * @param buttons A bitfield corresponding to the joystick buttons' current state, 1 for pressed, 0 for released. The lowest bit corresponds to Button 1.
James Goppert's avatar
James Goppert committed
48 49
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
50
static inline uint16_t mavlink_msg_manual_control_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
Lorenz Meier's avatar
Lorenz Meier committed
51
						       uint8_t target, int16_t x, int16_t y, int16_t z, int16_t r, uint16_t buttons)
James Goppert's avatar
James Goppert committed
52
{
LM's avatar
LM committed
53
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
Lorenz Meier's avatar
Lorenz Meier committed
54
	char buf[MAVLINK_MSG_ID_MANUAL_CONTROL_LEN];
Lorenz Meier's avatar
Lorenz Meier committed
55 56 57 58 59 60 61
	_mav_put_int16_t(buf, 0, x);
	_mav_put_int16_t(buf, 2, y);
	_mav_put_int16_t(buf, 4, z);
	_mav_put_int16_t(buf, 6, r);
	_mav_put_uint16_t(buf, 8, buttons);
	_mav_put_uint8_t(buf, 10, target);

Lorenz Meier's avatar
Lorenz Meier committed
62
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_MANUAL_CONTROL_LEN);
LM's avatar
LM committed
63 64
#else
	mavlink_manual_control_t packet;
Lorenz Meier's avatar
Lorenz Meier committed
65 66 67 68 69
	packet.x = x;
	packet.y = y;
	packet.z = z;
	packet.r = r;
	packet.buttons = buttons;
LM's avatar
LM committed
70
	packet.target = target;
James Goppert's avatar
James Goppert committed
71

Lorenz Meier's avatar
Lorenz Meier committed
72
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_MANUAL_CONTROL_LEN);
LM's avatar
LM committed
73
#endif
lm's avatar
lm committed
74

LM's avatar
LM committed
75
	msg->msgid = MAVLINK_MSG_ID_MANUAL_CONTROL;
Lorenz Meier's avatar
Lorenz Meier committed
76 77 78 79 80
#if MAVLINK_CRC_EXTRA
    return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_MANUAL_CONTROL_LEN, MAVLINK_MSG_ID_MANUAL_CONTROL_CRC);
#else
    return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_MANUAL_CONTROL_LEN);
#endif
James Goppert's avatar
James Goppert committed
81 82 83
}

/**
lm's avatar
lm committed
84
 * @brief Pack a manual_control message on a channel
James Goppert's avatar
James Goppert committed
85 86 87 88
 * @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
Lorenz Meier's avatar
Lorenz Meier committed
89 90 91 92 93 94
 * @param target The system to be controlled.
 * @param x X-axis, normalized to the range [-1000,1000]. A value of INT16_MAX indicates that this axis is invalid. Generally corresponds to forward(1000)-backward(-1000) movement on a joystick and the pitch of a vehicle.
 * @param y Y-axis, normalized to the range [-1000,1000]. A value of INT16_MAX indicates that this axis is invalid. Generally corresponds to left(-1000)-right(1000) movement on a joystick and the roll of a vehicle.
 * @param z Z-axis, normalized to the range [-1000,1000]. A value of INT16_MAX indicates that this axis is invalid. Generally corresponds to a separate slider movement with maximum being 1000 and minimum being -1000 on a joystick and the thrust of a vehicle.
 * @param r R-axis, normalized to the range [-1000,1000]. A value of INT16_MAX indicates that this axis is invalid. Generally corresponds to a twisting of the joystick, with counter-clockwise being 1000 and clockwise being -1000, and the yaw of a vehicle.
 * @param buttons A bitfield corresponding to the joystick buttons' current state, 1 for pressed, 0 for released. The lowest bit corresponds to Button 1.
James Goppert's avatar
James Goppert committed
95 96
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
97 98
static inline uint16_t mavlink_msg_manual_control_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
							   mavlink_message_t* msg,
Lorenz Meier's avatar
Lorenz Meier committed
99
						           uint8_t target,int16_t x,int16_t y,int16_t z,int16_t r,uint16_t buttons)
James Goppert's avatar
James Goppert committed
100
{
LM's avatar
LM committed
101
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
Lorenz Meier's avatar
Lorenz Meier committed
102
	char buf[MAVLINK_MSG_ID_MANUAL_CONTROL_LEN];
Lorenz Meier's avatar
Lorenz Meier committed
103 104 105 106 107 108 109
	_mav_put_int16_t(buf, 0, x);
	_mav_put_int16_t(buf, 2, y);
	_mav_put_int16_t(buf, 4, z);
	_mav_put_int16_t(buf, 6, r);
	_mav_put_uint16_t(buf, 8, buttons);
	_mav_put_uint8_t(buf, 10, target);

Lorenz Meier's avatar
Lorenz Meier committed
110
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_MANUAL_CONTROL_LEN);
LM's avatar
LM committed
111 112
#else
	mavlink_manual_control_t packet;
Lorenz Meier's avatar
Lorenz Meier committed
113 114 115 116 117
	packet.x = x;
	packet.y = y;
	packet.z = z;
	packet.r = r;
	packet.buttons = buttons;
LM's avatar
LM committed
118
	packet.target = target;
James Goppert's avatar
James Goppert committed
119

Lorenz Meier's avatar
Lorenz Meier committed
120
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_MANUAL_CONTROL_LEN);
LM's avatar
LM committed
121
#endif
lm's avatar
lm committed
122

LM's avatar
LM committed
123
	msg->msgid = MAVLINK_MSG_ID_MANUAL_CONTROL;
Lorenz Meier's avatar
Lorenz Meier committed
124 125 126 127 128
#if MAVLINK_CRC_EXTRA
    return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_MANUAL_CONTROL_LEN, MAVLINK_MSG_ID_MANUAL_CONTROL_CRC);
#else
    return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_MANUAL_CONTROL_LEN);
#endif
James Goppert's avatar
James Goppert committed
129 130 131 132 133 134 135 136 137 138 139 140
}

/**
 * @brief Encode a manual_control 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 manual_control C-struct to read the message contents from
 */
static inline uint16_t mavlink_msg_manual_control_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_manual_control_t* manual_control)
{
Lorenz Meier's avatar
Lorenz Meier committed
141
	return mavlink_msg_manual_control_pack(system_id, component_id, msg, manual_control->target, manual_control->x, manual_control->y, manual_control->z, manual_control->r, manual_control->buttons);
James Goppert's avatar
James Goppert committed
142 143 144 145 146 147
}

/**
 * @brief Send a manual_control message
 * @param chan MAVLink channel to send the message
 *
Lorenz Meier's avatar
Lorenz Meier committed
148 149 150 151 152 153
 * @param target The system to be controlled.
 * @param x X-axis, normalized to the range [-1000,1000]. A value of INT16_MAX indicates that this axis is invalid. Generally corresponds to forward(1000)-backward(-1000) movement on a joystick and the pitch of a vehicle.
 * @param y Y-axis, normalized to the range [-1000,1000]. A value of INT16_MAX indicates that this axis is invalid. Generally corresponds to left(-1000)-right(1000) movement on a joystick and the roll of a vehicle.
 * @param z Z-axis, normalized to the range [-1000,1000]. A value of INT16_MAX indicates that this axis is invalid. Generally corresponds to a separate slider movement with maximum being 1000 and minimum being -1000 on a joystick and the thrust of a vehicle.
 * @param r R-axis, normalized to the range [-1000,1000]. A value of INT16_MAX indicates that this axis is invalid. Generally corresponds to a twisting of the joystick, with counter-clockwise being 1000 and clockwise being -1000, and the yaw of a vehicle.
 * @param buttons A bitfield corresponding to the joystick buttons' current state, 1 for pressed, 0 for released. The lowest bit corresponds to Button 1.
James Goppert's avatar
James Goppert committed
154
 */
lm's avatar
lm committed
155 156
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

Lorenz Meier's avatar
Lorenz Meier committed
157
static inline void mavlink_msg_manual_control_send(mavlink_channel_t chan, uint8_t target, int16_t x, int16_t y, int16_t z, int16_t r, uint16_t buttons)
lm's avatar
lm committed
158
{
LM's avatar
LM committed
159
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
Lorenz Meier's avatar
Lorenz Meier committed
160
	char buf[MAVLINK_MSG_ID_MANUAL_CONTROL_LEN];
Lorenz Meier's avatar
Lorenz Meier committed
161 162 163 164 165 166 167
	_mav_put_int16_t(buf, 0, x);
	_mav_put_int16_t(buf, 2, y);
	_mav_put_int16_t(buf, 4, z);
	_mav_put_int16_t(buf, 6, r);
	_mav_put_uint16_t(buf, 8, buttons);
	_mav_put_uint8_t(buf, 10, target);

Lorenz Meier's avatar
Lorenz Meier committed
168 169 170 171 172
#if MAVLINK_CRC_EXTRA
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_MANUAL_CONTROL, buf, MAVLINK_MSG_ID_MANUAL_CONTROL_LEN, MAVLINK_MSG_ID_MANUAL_CONTROL_CRC);
#else
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_MANUAL_CONTROL, buf, MAVLINK_MSG_ID_MANUAL_CONTROL_LEN);
#endif
LM's avatar
LM committed
173 174
#else
	mavlink_manual_control_t packet;
Lorenz Meier's avatar
Lorenz Meier committed
175 176 177 178 179
	packet.x = x;
	packet.y = y;
	packet.z = z;
	packet.r = r;
	packet.buttons = buttons;
LM's avatar
LM committed
180 181
	packet.target = target;

Lorenz Meier's avatar
Lorenz Meier committed
182 183 184 185 186
#if MAVLINK_CRC_EXTRA
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_MANUAL_CONTROL, (const char *)&packet, MAVLINK_MSG_ID_MANUAL_CONTROL_LEN, MAVLINK_MSG_ID_MANUAL_CONTROL_CRC);
#else
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_MANUAL_CONTROL, (const char *)&packet, MAVLINK_MSG_ID_MANUAL_CONTROL_LEN);
#endif
LM's avatar
LM committed
187
#endif
James Goppert's avatar
James Goppert committed
188 189 190
}

#endif
lm's avatar
lm committed
191

James Goppert's avatar
James Goppert committed
192 193
// MESSAGE MANUAL_CONTROL UNPACKING

lm's avatar
lm committed
194

James Goppert's avatar
James Goppert committed
195 196 197
/**
 * @brief Get field target from manual_control message
 *
Lorenz Meier's avatar
Lorenz Meier committed
198
 * @return The system to be controlled.
James Goppert's avatar
James Goppert committed
199 200 201
 */
static inline uint8_t mavlink_msg_manual_control_get_target(const mavlink_message_t* msg)
{
Lorenz Meier's avatar
Lorenz Meier committed
202
	return _MAV_RETURN_uint8_t(msg,  10);
James Goppert's avatar
James Goppert committed
203 204 205
}

/**
Lorenz Meier's avatar
Lorenz Meier committed
206
 * @brief Get field x from manual_control message
James Goppert's avatar
James Goppert committed
207
 *
Lorenz Meier's avatar
Lorenz Meier committed
208
 * @return X-axis, normalized to the range [-1000,1000]. A value of INT16_MAX indicates that this axis is invalid. Generally corresponds to forward(1000)-backward(-1000) movement on a joystick and the pitch of a vehicle.
James Goppert's avatar
James Goppert committed
209
 */
Lorenz Meier's avatar
Lorenz Meier committed
210
static inline int16_t mavlink_msg_manual_control_get_x(const mavlink_message_t* msg)
James Goppert's avatar
James Goppert committed
211
{
Lorenz Meier's avatar
Lorenz Meier committed
212
	return _MAV_RETURN_int16_t(msg,  0);
James Goppert's avatar
James Goppert committed
213 214 215
}

/**
Lorenz Meier's avatar
Lorenz Meier committed
216
 * @brief Get field y from manual_control message
James Goppert's avatar
James Goppert committed
217
 *
Lorenz Meier's avatar
Lorenz Meier committed
218
 * @return Y-axis, normalized to the range [-1000,1000]. A value of INT16_MAX indicates that this axis is invalid. Generally corresponds to left(-1000)-right(1000) movement on a joystick and the roll of a vehicle.
James Goppert's avatar
James Goppert committed
219
 */
Lorenz Meier's avatar
Lorenz Meier committed
220
static inline int16_t mavlink_msg_manual_control_get_y(const mavlink_message_t* msg)
James Goppert's avatar
James Goppert committed
221
{
Lorenz Meier's avatar
Lorenz Meier committed
222
	return _MAV_RETURN_int16_t(msg,  2);
James Goppert's avatar
James Goppert committed
223 224 225
}

/**
Lorenz Meier's avatar
Lorenz Meier committed
226
 * @brief Get field z from manual_control message
James Goppert's avatar
James Goppert committed
227
 *
Lorenz Meier's avatar
Lorenz Meier committed
228
 * @return Z-axis, normalized to the range [-1000,1000]. A value of INT16_MAX indicates that this axis is invalid. Generally corresponds to a separate slider movement with maximum being 1000 and minimum being -1000 on a joystick and the thrust of a vehicle.
James Goppert's avatar
James Goppert committed
229
 */
Lorenz Meier's avatar
Lorenz Meier committed
230
static inline int16_t mavlink_msg_manual_control_get_z(const mavlink_message_t* msg)
James Goppert's avatar
James Goppert committed
231
{
Lorenz Meier's avatar
Lorenz Meier committed
232
	return _MAV_RETURN_int16_t(msg,  4);
James Goppert's avatar
James Goppert committed
233 234 235
}

/**
Lorenz Meier's avatar
Lorenz Meier committed
236
 * @brief Get field r from manual_control message
James Goppert's avatar
James Goppert committed
237
 *
Lorenz Meier's avatar
Lorenz Meier committed
238
 * @return R-axis, normalized to the range [-1000,1000]. A value of INT16_MAX indicates that this axis is invalid. Generally corresponds to a twisting of the joystick, with counter-clockwise being 1000 and clockwise being -1000, and the yaw of a vehicle.
James Goppert's avatar
James Goppert committed
239
 */
Lorenz Meier's avatar
Lorenz Meier committed
240
static inline int16_t mavlink_msg_manual_control_get_r(const mavlink_message_t* msg)
James Goppert's avatar
James Goppert committed
241
{
Lorenz Meier's avatar
Lorenz Meier committed
242
	return _MAV_RETURN_int16_t(msg,  6);
James Goppert's avatar
James Goppert committed
243 244 245
}

/**
Lorenz Meier's avatar
Lorenz Meier committed
246
 * @brief Get field buttons from manual_control message
James Goppert's avatar
James Goppert committed
247
 *
Lorenz Meier's avatar
Lorenz Meier committed
248
 * @return A bitfield corresponding to the joystick buttons' current state, 1 for pressed, 0 for released. The lowest bit corresponds to Button 1.
James Goppert's avatar
James Goppert committed
249
 */
Lorenz Meier's avatar
Lorenz Meier committed
250
static inline uint16_t mavlink_msg_manual_control_get_buttons(const mavlink_message_t* msg)
James Goppert's avatar
James Goppert committed
251
{
Lorenz Meier's avatar
Lorenz Meier committed
252
	return _MAV_RETURN_uint16_t(msg,  8);
James Goppert's avatar
James Goppert committed
253 254 255 256 257 258 259 260 261 262
}

/**
 * @brief Decode a manual_control message into a struct
 *
 * @param msg The message to decode
 * @param manual_control C-struct to decode the message contents into
 */
static inline void mavlink_msg_manual_control_decode(const mavlink_message_t* msg, mavlink_manual_control_t* manual_control)
{
lm's avatar
lm committed
263
#if MAVLINK_NEED_BYTE_SWAP
Lorenz Meier's avatar
Lorenz Meier committed
264 265 266 267 268
	manual_control->x = mavlink_msg_manual_control_get_x(msg);
	manual_control->y = mavlink_msg_manual_control_get_y(msg);
	manual_control->z = mavlink_msg_manual_control_get_z(msg);
	manual_control->r = mavlink_msg_manual_control_get_r(msg);
	manual_control->buttons = mavlink_msg_manual_control_get_buttons(msg);
lm's avatar
lm committed
269 270
	manual_control->target = mavlink_msg_manual_control_get_target(msg);
#else
Lorenz Meier's avatar
Lorenz Meier committed
271
	memcpy(manual_control, _MAV_PAYLOAD(msg), MAVLINK_MSG_ID_MANUAL_CONTROL_LEN);
lm's avatar
lm committed
272
#endif
James Goppert's avatar
James Goppert committed
273
}