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

#define MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL 5
lm's avatar
lm committed
4 5
#define MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_LEN 28
#define MAVLINK_MSG_5_LEN 28
lm's avatar
lm committed
6 7
#define MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_KEY 0x7E
#define MAVLINK_MSG_5_KEY 0x7E
James Goppert's avatar
James Goppert committed
8 9 10

typedef struct __mavlink_change_operator_control_t 
{
lm's avatar
lm committed
11 12 13 14
	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
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32

} mavlink_change_operator_control_t;
#define MAVLINK_MSG_CHANGE_OPERATOR_CONTROL_FIELD_PASSKEY_LEN 25

/**
 * @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)
 */
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)
{
lm's avatar
lm committed
33
	mavlink_change_operator_control_t *p = (mavlink_change_operator_control_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
34 35
	msg->msgid = MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL;

lm's avatar
lm committed
36 37 38 39
	p->target_system = target_system;	// uint8_t:System the GCS requests control for
	p->control_request = control_request;	// uint8_t:0: request control of this MAV, 1: Release control of this MAV
	p->version = version;	// uint8_t: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.
	memcpy(p->passkey, passkey, sizeof(p->passkey));	// char[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
40

lm's avatar
lm committed
41
	return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_LEN);
James Goppert's avatar
James Goppert committed
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
}

/**
 * @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 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)
 */
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
58
	mavlink_change_operator_control_t *p = (mavlink_change_operator_control_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
59 60
	msg->msgid = MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL;

lm's avatar
lm committed
61 62 63 64
	p->target_system = target_system;	// uint8_t:System the GCS requests control for
	p->control_request = control_request;	// uint8_t:0: request control of this MAV, 1: Release control of this MAV
	p->version = version;	// uint8_t: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.
	memcpy(p->passkey, passkey, sizeof(p->passkey));	// char[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
65

lm's avatar
lm committed
66
	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_LEN);
James Goppert's avatar
James Goppert committed
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
}

/**
 * @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);
}

lm's avatar
lm committed
82 83

#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
James Goppert's avatar
James Goppert committed
84 85 86 87 88 89 90 91 92
/**
 * @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
93 94 95 96 97
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)
{
	mavlink_header_t hdr;
	mavlink_change_operator_control_t payload;

lm's avatar
lm committed
98 99 100 101 102
	MAVLINK_BUFFER_CHECK_START( chan, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_LEN )
	payload.target_system = target_system;	// uint8_t:System the GCS requests control for
	payload.control_request = control_request;	// uint8_t:0: request control of this MAV, 1: Release control of this MAV
	payload.version = version;	// uint8_t: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.
	memcpy(payload.passkey, passkey, sizeof(payload.passkey));	// char[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 "!?,.-"
lm's avatar
lm committed
103 104 105 106 107 108 109 110 111 112

	hdr.STX = MAVLINK_STX;
	hdr.len = MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_LEN;
	hdr.msgid = MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL;
	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
113 114 115 116 117 118
	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( 0x7E, &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
119 120 121 122 123 124 125 126 127 128 129 130
}

#endif
// MESSAGE CHANGE_OPERATOR_CONTROL UNPACKING

/**
 * @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
131 132
	mavlink_change_operator_control_t *p = (mavlink_change_operator_control_t *)&msg->payload[0];
	return (uint8_t)(p->target_system);
James Goppert's avatar
James Goppert committed
133 134 135 136 137 138 139 140 141
}

/**
 * @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
142 143
	mavlink_change_operator_control_t *p = (mavlink_change_operator_control_t *)&msg->payload[0];
	return (uint8_t)(p->control_request);
James Goppert's avatar
James Goppert committed
144 145 146 147 148 149 150 151 152
}

/**
 * @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
153 154
	mavlink_change_operator_control_t *p = (mavlink_change_operator_control_t *)&msg->payload[0];
	return (uint8_t)(p->version);
James Goppert's avatar
James Goppert committed
155 156 157 158 159 160 161
}

/**
 * @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
162
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
163
{
lm's avatar
lm committed
164
	mavlink_change_operator_control_t *p = (mavlink_change_operator_control_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
165

lm's avatar
lm committed
166 167
	memcpy(passkey, p->passkey, sizeof(p->passkey));
	return sizeof(p->passkey);
James Goppert's avatar
James Goppert committed
168 169 170 171 172 173 174 175 176 177
}

/**
 * @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
178
	memcpy( change_operator_control, msg->payload, sizeof(mavlink_change_operator_control_t));
James Goppert's avatar
James Goppert committed
179
}