mavlink_msg_change_operator_control.h 9.77 KB
Newer Older
James Goppert's avatar
James Goppert committed
1 2 3 4
// MESSAGE CHANGE_OPERATOR_CONTROL PACKING

#define MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL 5

lm's avatar
lm committed
5
typedef struct __mavlink_change_operator_control_t
James Goppert's avatar
James Goppert committed
6
{
lm's avatar
lm committed
7 8 9 10
 uint8_t target_system; ///< System the GCS requests control for
 uint8_t control_request; ///< 0: request control of this MAV, 1: Release control of this MAV
 uint8_t version; ///< 0: key as plaintext, 1-255: future, different hashing/encryption variants. The GCS should in general use the safest mode possible initially and then gradually move down the encryption level if it gets a NACK message indicating an encryption mismatch.
 char passkey[25]; ///< Password / Key, depending on version plaintext or encrypted. 25 or less characters, NULL terminated. The characters may involve A-Z, a-z, 0-9, and "!?,.-"
James Goppert's avatar
James Goppert committed
11
} mavlink_change_operator_control_t;
lm's avatar
lm committed
12 13 14 15

#define MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_LEN 28
#define MAVLINK_MSG_ID_5_LEN 28

James Goppert's avatar
James Goppert committed
16 17
#define MAVLINK_MSG_CHANGE_OPERATOR_CONTROL_FIELD_PASSKEY_LEN 25

lm's avatar
lm committed
18 19 20
#define MAVLINK_MESSAGE_INFO_CHANGE_OPERATOR_CONTROL { \
	"CHANGE_OPERATOR_CONTROL", \
	4, \
lm's avatar
lm committed
21 22 23 24
	{  { "target_system", NULL, MAVLINK_TYPE_UINT8_T, 0, 0, offsetof(mavlink_change_operator_control_t, target_system) }, \
         { "control_request", NULL, MAVLINK_TYPE_UINT8_T, 0, 1, offsetof(mavlink_change_operator_control_t, control_request) }, \
         { "version", NULL, MAVLINK_TYPE_UINT8_T, 0, 2, offsetof(mavlink_change_operator_control_t, version) }, \
         { "passkey", NULL, MAVLINK_TYPE_CHAR, 25, 3, offsetof(mavlink_change_operator_control_t, passkey) }, \
lm's avatar
lm committed
25 26 27 28
         } \
}


James Goppert's avatar
James Goppert committed
29 30 31 32 33 34 35 36 37 38 39 40
/**
 * @brief Pack a change_operator_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
 *
 * @param target_system System the GCS requests control for
 * @param control_request 0: request control of this MAV, 1: Release control of this MAV
 * @param version 0: key as plaintext, 1-255: future, different hashing/encryption variants. The GCS should in general use the safest mode possible initially and then gradually move down the encryption level if it gets a NACK message indicating an encryption mismatch.
 * @param passkey Password / Key, depending on version plaintext or encrypted. 25 or less characters, NULL terminated. The characters may involve A-Z, a-z, 0-9, and "!?,.-"
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
41 42
static inline uint16_t mavlink_msg_change_operator_control_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
						       uint8_t target_system, uint8_t control_request, uint8_t version, const char *passkey)
James Goppert's avatar
James Goppert committed
43
{
LM's avatar
LM committed
44 45 46 47 48 49
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
	char buf[28];
	_mav_put_uint8_t(buf, 0, target_system);
	_mav_put_uint8_t(buf, 1, control_request);
	_mav_put_uint8_t(buf, 2, version);
	_mav_put_char_array(buf, 3, passkey, 25);
50
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, 28);
LM's avatar
LM committed
51 52 53 54 55
#else
	mavlink_change_operator_control_t packet;
	packet.target_system = target_system;
	packet.control_request = control_request;
	packet.version = version;
56
	mav_array_memcpy(packet.passkey, passkey, sizeof(char)*25);
57
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, 28);
LM's avatar
LM committed
58
#endif
James Goppert's avatar
James Goppert committed
59

LM's avatar
LM committed
60
	msg->msgid = MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL;
lm's avatar
lm committed
61
	return mavlink_finalize_message(msg, system_id, component_id, 28, 217);
James Goppert's avatar
James Goppert committed
62 63 64
}

/**
lm's avatar
lm committed
65
 * @brief Pack a change_operator_control message on a channel
James Goppert's avatar
James Goppert committed
66 67 68 69 70 71 72 73 74 75
 * @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_system System the GCS requests control for
 * @param control_request 0: request control of this MAV, 1: Release control of this MAV
 * @param version 0: key as plaintext, 1-255: future, different hashing/encryption variants. The GCS should in general use the safest mode possible initially and then gradually move down the encryption level if it gets a NACK message indicating an encryption mismatch.
 * @param passkey Password / Key, depending on version plaintext or encrypted. 25 or less characters, NULL terminated. The characters may involve A-Z, a-z, 0-9, and "!?,.-"
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
76 77 78 79
static inline uint16_t mavlink_msg_change_operator_control_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
							   mavlink_message_t* msg,
						           uint8_t target_system,uint8_t control_request,uint8_t version,const char *passkey)
{
LM's avatar
LM committed
80 81 82 83 84 85
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
	char buf[28];
	_mav_put_uint8_t(buf, 0, target_system);
	_mav_put_uint8_t(buf, 1, control_request);
	_mav_put_uint8_t(buf, 2, version);
	_mav_put_char_array(buf, 3, passkey, 25);
86
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, 28);
LM's avatar
LM committed
87 88 89 90 91
#else
	mavlink_change_operator_control_t packet;
	packet.target_system = target_system;
	packet.control_request = control_request;
	packet.version = version;
92
	mav_array_memcpy(packet.passkey, passkey, sizeof(char)*25);
93
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, 28);
LM's avatar
LM committed
94
#endif
lm's avatar
lm committed
95

LM's avatar
LM committed
96
	msg->msgid = MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL;
lm's avatar
lm committed
97 98 99
	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, 28, 217);
}

James Goppert's avatar
James Goppert committed
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
/**
 * @brief Encode a change_operator_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 change_operator_control C-struct to read the message contents from
 */
static inline uint16_t mavlink_msg_change_operator_control_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_change_operator_control_t* change_operator_control)
{
	return mavlink_msg_change_operator_control_pack(system_id, component_id, msg, change_operator_control->target_system, change_operator_control->control_request, change_operator_control->version, change_operator_control->passkey);
}

/**
 * @brief Send a change_operator_control message
 * @param chan MAVLink channel to send the message
 *
 * @param target_system System the GCS requests control for
 * @param control_request 0: request control of this MAV, 1: Release control of this MAV
 * @param version 0: key as plaintext, 1-255: future, different hashing/encryption variants. The GCS should in general use the safest mode possible initially and then gradually move down the encryption level if it gets a NACK message indicating an encryption mismatch.
 * @param passkey Password / Key, depending on version plaintext or encrypted. 25 or less characters, NULL terminated. The characters may involve A-Z, a-z, 0-9, and "!?,.-"
 */
lm's avatar
lm committed
122 123 124
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

static inline void mavlink_msg_change_operator_control_send(mavlink_channel_t chan, uint8_t target_system, uint8_t control_request, uint8_t version, const char *passkey)
lm's avatar
lm committed
125
{
LM's avatar
LM committed
126 127 128 129 130 131 132 133 134 135 136 137
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
	char buf[28];
	_mav_put_uint8_t(buf, 0, target_system);
	_mav_put_uint8_t(buf, 1, control_request);
	_mav_put_uint8_t(buf, 2, version);
	_mav_put_char_array(buf, 3, passkey, 25);
	_mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL, buf, 28, 217);
#else
	mavlink_change_operator_control_t packet;
	packet.target_system = target_system;
	packet.control_request = control_request;
	packet.version = version;
138
	mav_array_memcpy(packet.passkey, passkey, sizeof(char)*25);
LM's avatar
LM committed
139 140
	_mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL, (const char *)&packet, 28, 217);
#endif
James Goppert's avatar
James Goppert committed
141 142 143
}

#endif
lm's avatar
lm committed
144

James Goppert's avatar
James Goppert committed
145 146
// MESSAGE CHANGE_OPERATOR_CONTROL UNPACKING

lm's avatar
lm committed
147

James Goppert's avatar
James Goppert committed
148 149 150 151 152 153 154
/**
 * @brief Get field target_system from change_operator_control message
 *
 * @return System the GCS requests control for
 */
static inline uint8_t mavlink_msg_change_operator_control_get_target_system(const mavlink_message_t* msg)
{
LM's avatar
LM committed
155
	return _MAV_RETURN_uint8_t(msg,  0);
James Goppert's avatar
James Goppert committed
156 157 158 159 160 161 162 163 164
}

/**
 * @brief Get field control_request from change_operator_control message
 *
 * @return 0: request control of this MAV, 1: Release control of this MAV
 */
static inline uint8_t mavlink_msg_change_operator_control_get_control_request(const mavlink_message_t* msg)
{
LM's avatar
LM committed
165
	return _MAV_RETURN_uint8_t(msg,  1);
James Goppert's avatar
James Goppert committed
166 167 168 169 170 171 172 173 174
}

/**
 * @brief Get field version from change_operator_control message
 *
 * @return 0: key as plaintext, 1-255: future, different hashing/encryption variants. The GCS should in general use the safest mode possible initially and then gradually move down the encryption level if it gets a NACK message indicating an encryption mismatch.
 */
static inline uint8_t mavlink_msg_change_operator_control_get_version(const mavlink_message_t* msg)
{
LM's avatar
LM committed
175
	return _MAV_RETURN_uint8_t(msg,  2);
James Goppert's avatar
James Goppert committed
176 177 178 179 180 181 182
}

/**
 * @brief Get field passkey from change_operator_control message
 *
 * @return Password / Key, depending on version plaintext or encrypted. 25 or less characters, NULL terminated. The characters may involve A-Z, a-z, 0-9, and "!?,.-"
 */
lm's avatar
lm committed
183
static inline uint16_t mavlink_msg_change_operator_control_get_passkey(const mavlink_message_t* msg, char *passkey)
James Goppert's avatar
James Goppert committed
184
{
LM's avatar
LM committed
185
	return _MAV_RETURN_char_array(msg, passkey, 25,  3);
James Goppert's avatar
James Goppert committed
186 187 188 189 190 191 192 193 194 195
}

/**
 * @brief Decode a change_operator_control message into a struct
 *
 * @param msg The message to decode
 * @param change_operator_control C-struct to decode the message contents into
 */
static inline void mavlink_msg_change_operator_control_decode(const mavlink_message_t* msg, mavlink_change_operator_control_t* change_operator_control)
{
lm's avatar
lm committed
196 197 198 199 200 201
#if MAVLINK_NEED_BYTE_SWAP
	change_operator_control->target_system = mavlink_msg_change_operator_control_get_target_system(msg);
	change_operator_control->control_request = mavlink_msg_change_operator_control_get_control_request(msg);
	change_operator_control->version = mavlink_msg_change_operator_control_get_version(msg);
	mavlink_msg_change_operator_control_get_passkey(msg, change_operator_control->passkey);
#else
LM's avatar
LM committed
202
	memcpy(change_operator_control, _MAV_PAYLOAD(msg), 28);
lm's avatar
lm committed
203
#endif
James Goppert's avatar
James Goppert committed
204
}