mavlink_msg_data_transmission_handshake.h 9.35 KB
Newer Older
James Goppert's avatar
James Goppert committed
1 2
// MESSAGE DATA_TRANSMISSION_HANDSHAKE PACKING

lm's avatar
lm committed
3
#define MAVLINK_MSG_ID_DATA_TRANSMISSION_HANDSHAKE 193
James Goppert's avatar
James Goppert committed
4

lm's avatar
lm committed
5
typedef struct __mavlink_data_transmission_handshake_t
James Goppert's avatar
James Goppert committed
6
{
lm's avatar
lm committed
7
 uint8_t type; ///< type of requested/acknowledged data (as defined in ENUM DATA_TYPES in mavlink/include/mavlink_types.h)
Lorenz Meier's avatar
Lorenz Meier committed
8
 uint32_t size; ///< total data size in bytes (set on ACK only)
lm's avatar
lm committed
9 10 11
 uint8_t packets; ///< number of packets beeing sent (set on ACK only)
 uint8_t payload; ///< payload size per packet (normally 253 byte, see DATA field size in message ENCAPSULATED_DATA) (set on ACK only)
 uint8_t jpg_quality; ///< JPEG quality out of [1,100]
James Goppert's avatar
James Goppert committed
12 13
} mavlink_data_transmission_handshake_t;

Lorenz Meier's avatar
Lorenz Meier committed
14 15
#define MAVLINK_MSG_ID_DATA_TRANSMISSION_HANDSHAKE_LEN 8
#define MAVLINK_MSG_ID_193_LEN 8
lm's avatar
lm committed
16 17 18 19 20



#define MAVLINK_MESSAGE_INFO_DATA_TRANSMISSION_HANDSHAKE { \
	"DATA_TRANSMISSION_HANDSHAKE", \
Lorenz Meier's avatar
Lorenz Meier committed
21 22 23 24 25 26
	5, \
	{  { "type", NULL, MAVLINK_TYPE_UINT8_T, 0, 0, offsetof(mavlink_data_transmission_handshake_t, type) }, \
         { "size", NULL, MAVLINK_TYPE_UINT32_T, 0, 1, offsetof(mavlink_data_transmission_handshake_t, size) }, \
         { "packets", NULL, MAVLINK_TYPE_UINT8_T, 0, 5, offsetof(mavlink_data_transmission_handshake_t, packets) }, \
         { "payload", NULL, MAVLINK_TYPE_UINT8_T, 0, 6, offsetof(mavlink_data_transmission_handshake_t, payload) }, \
         { "jpg_quality", NULL, MAVLINK_TYPE_UINT8_T, 0, 7, offsetof(mavlink_data_transmission_handshake_t, jpg_quality) }, \
lm's avatar
lm committed
27 28 29 30
         } \
}


James Goppert's avatar
James Goppert committed
31 32 33 34 35 36 37 38 39 40 41 42 43
/**
 * @brief Pack a data_transmission_handshake 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 type type of requested/acknowledged data (as defined in ENUM DATA_TYPES in mavlink/include/mavlink_types.h)
 * @param size total data size in bytes (set on ACK only)
 * @param packets number of packets beeing sent (set on ACK only)
 * @param payload payload size per packet (normally 253 byte, see DATA field size in message ENCAPSULATED_DATA) (set on ACK only)
 * @param jpg_quality JPEG quality out of [1,100]
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
44
static inline uint16_t mavlink_msg_data_transmission_handshake_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
Lorenz Meier's avatar
Lorenz Meier committed
45
						       uint8_t type, uint32_t size, uint8_t packets, uint8_t payload, uint8_t jpg_quality)
James Goppert's avatar
James Goppert committed
46
{
LM's avatar
LM committed
47
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
Lorenz Meier's avatar
Lorenz Meier committed
48 49 50 51 52 53 54 55
	char buf[8];
	_mav_put_uint8_t(buf, 0, type);
	_mav_put_uint32_t(buf, 1, size);
	_mav_put_uint8_t(buf, 5, packets);
	_mav_put_uint8_t(buf, 6, payload);
	_mav_put_uint8_t(buf, 7, jpg_quality);

        memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, 8);
LM's avatar
LM committed
56 57 58
#else
	mavlink_data_transmission_handshake_t packet;
	packet.type = type;
Lorenz Meier's avatar
Lorenz Meier committed
59
	packet.size = size;
LM's avatar
LM committed
60 61 62 63
	packet.packets = packets;
	packet.payload = payload;
	packet.jpg_quality = jpg_quality;

Lorenz Meier's avatar
Lorenz Meier committed
64
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, 8);
LM's avatar
LM committed
65
#endif
James Goppert's avatar
James Goppert committed
66

LM's avatar
LM committed
67
	msg->msgid = MAVLINK_MSG_ID_DATA_TRANSMISSION_HANDSHAKE;
Lorenz Meier's avatar
Lorenz Meier committed
68
	return mavlink_finalize_message(msg, system_id, component_id, 8);
James Goppert's avatar
James Goppert committed
69 70 71
}

/**
lm's avatar
lm committed
72
 * @brief Pack a data_transmission_handshake message on a channel
James Goppert's avatar
James Goppert committed
73 74 75 76 77 78 79 80 81 82 83
 * @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 type type of requested/acknowledged data (as defined in ENUM DATA_TYPES in mavlink/include/mavlink_types.h)
 * @param size total data size in bytes (set on ACK only)
 * @param packets number of packets beeing sent (set on ACK only)
 * @param payload payload size per packet (normally 253 byte, see DATA field size in message ENCAPSULATED_DATA) (set on ACK only)
 * @param jpg_quality JPEG quality out of [1,100]
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
84 85
static inline uint16_t mavlink_msg_data_transmission_handshake_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
							   mavlink_message_t* msg,
Lorenz Meier's avatar
Lorenz Meier committed
86
						           uint8_t type,uint32_t size,uint8_t packets,uint8_t payload,uint8_t jpg_quality)
James Goppert's avatar
James Goppert committed
87
{
LM's avatar
LM committed
88
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
Lorenz Meier's avatar
Lorenz Meier committed
89 90 91 92 93 94 95 96
	char buf[8];
	_mav_put_uint8_t(buf, 0, type);
	_mav_put_uint32_t(buf, 1, size);
	_mav_put_uint8_t(buf, 5, packets);
	_mav_put_uint8_t(buf, 6, payload);
	_mav_put_uint8_t(buf, 7, jpg_quality);

        memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, 8);
LM's avatar
LM committed
97 98 99
#else
	mavlink_data_transmission_handshake_t packet;
	packet.type = type;
Lorenz Meier's avatar
Lorenz Meier committed
100
	packet.size = size;
LM's avatar
LM committed
101 102 103 104
	packet.packets = packets;
	packet.payload = payload;
	packet.jpg_quality = jpg_quality;

Lorenz Meier's avatar
Lorenz Meier committed
105
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, 8);
LM's avatar
LM committed
106
#endif
James Goppert's avatar
James Goppert committed
107

LM's avatar
LM committed
108
	msg->msgid = MAVLINK_MSG_ID_DATA_TRANSMISSION_HANDSHAKE;
Lorenz Meier's avatar
Lorenz Meier committed
109
	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, 8);
James Goppert's avatar
James Goppert committed
110 111 112 113 114 115 116 117 118 119 120 121
}

/**
 * @brief Encode a data_transmission_handshake 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 data_transmission_handshake C-struct to read the message contents from
 */
static inline uint16_t mavlink_msg_data_transmission_handshake_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_data_transmission_handshake_t* data_transmission_handshake)
{
Lorenz Meier's avatar
Lorenz Meier committed
122
	return mavlink_msg_data_transmission_handshake_pack(system_id, component_id, msg, data_transmission_handshake->type, data_transmission_handshake->size, data_transmission_handshake->packets, data_transmission_handshake->payload, data_transmission_handshake->jpg_quality);
James Goppert's avatar
James Goppert committed
123 124 125 126 127 128 129 130 131 132 133 134
}

/**
 * @brief Send a data_transmission_handshake message
 * @param chan MAVLink channel to send the message
 *
 * @param type type of requested/acknowledged data (as defined in ENUM DATA_TYPES in mavlink/include/mavlink_types.h)
 * @param size total data size in bytes (set on ACK only)
 * @param packets number of packets beeing sent (set on ACK only)
 * @param payload payload size per packet (normally 253 byte, see DATA field size in message ENCAPSULATED_DATA) (set on ACK only)
 * @param jpg_quality JPEG quality out of [1,100]
 */
lm's avatar
lm committed
135 136
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

Lorenz Meier's avatar
Lorenz Meier committed
137
static inline void mavlink_msg_data_transmission_handshake_send(mavlink_channel_t chan, uint8_t type, uint32_t size, uint8_t packets, uint8_t payload, uint8_t jpg_quality)
lm's avatar
lm committed
138
{
LM's avatar
LM committed
139
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
Lorenz Meier's avatar
Lorenz Meier committed
140 141 142 143 144 145 146 147
	char buf[8];
	_mav_put_uint8_t(buf, 0, type);
	_mav_put_uint32_t(buf, 1, size);
	_mav_put_uint8_t(buf, 5, packets);
	_mav_put_uint8_t(buf, 6, payload);
	_mav_put_uint8_t(buf, 7, jpg_quality);

	_mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_DATA_TRANSMISSION_HANDSHAKE, buf, 8);
LM's avatar
LM committed
148 149 150
#else
	mavlink_data_transmission_handshake_t packet;
	packet.type = type;
Lorenz Meier's avatar
Lorenz Meier committed
151
	packet.size = size;
LM's avatar
LM committed
152 153 154 155
	packet.packets = packets;
	packet.payload = payload;
	packet.jpg_quality = jpg_quality;

Lorenz Meier's avatar
Lorenz Meier committed
156
	_mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_DATA_TRANSMISSION_HANDSHAKE, (const char *)&packet, 8);
LM's avatar
LM committed
157
#endif
James Goppert's avatar
James Goppert committed
158 159 160
}

#endif
lm's avatar
lm committed
161

James Goppert's avatar
James Goppert committed
162 163
// MESSAGE DATA_TRANSMISSION_HANDSHAKE UNPACKING

lm's avatar
lm committed
164

James Goppert's avatar
James Goppert committed
165 166 167 168 169 170 171
/**
 * @brief Get field type from data_transmission_handshake message
 *
 * @return type of requested/acknowledged data (as defined in ENUM DATA_TYPES in mavlink/include/mavlink_types.h)
 */
static inline uint8_t mavlink_msg_data_transmission_handshake_get_type(const mavlink_message_t* msg)
{
Lorenz Meier's avatar
Lorenz Meier committed
172
	return _MAV_RETURN_uint8_t(msg,  0);
James Goppert's avatar
James Goppert committed
173 174 175 176 177 178 179 180 181
}

/**
 * @brief Get field size from data_transmission_handshake message
 *
 * @return total data size in bytes (set on ACK only)
 */
static inline uint32_t mavlink_msg_data_transmission_handshake_get_size(const mavlink_message_t* msg)
{
Lorenz Meier's avatar
Lorenz Meier committed
182
	return _MAV_RETURN_uint32_t(msg,  1);
183 184
}

James Goppert's avatar
James Goppert committed
185 186 187 188 189 190 191
/**
 * @brief Get field packets from data_transmission_handshake message
 *
 * @return number of packets beeing sent (set on ACK only)
 */
static inline uint8_t mavlink_msg_data_transmission_handshake_get_packets(const mavlink_message_t* msg)
{
Lorenz Meier's avatar
Lorenz Meier committed
192
	return _MAV_RETURN_uint8_t(msg,  5);
James Goppert's avatar
James Goppert committed
193 194 195 196 197 198 199 200 201
}

/**
 * @brief Get field payload from data_transmission_handshake message
 *
 * @return payload size per packet (normally 253 byte, see DATA field size in message ENCAPSULATED_DATA) (set on ACK only)
 */
static inline uint8_t mavlink_msg_data_transmission_handshake_get_payload(const mavlink_message_t* msg)
{
Lorenz Meier's avatar
Lorenz Meier committed
202
	return _MAV_RETURN_uint8_t(msg,  6);
James Goppert's avatar
James Goppert committed
203 204 205 206 207 208 209 210 211
}

/**
 * @brief Get field jpg_quality from data_transmission_handshake message
 *
 * @return JPEG quality out of [1,100]
 */
static inline uint8_t mavlink_msg_data_transmission_handshake_get_jpg_quality(const mavlink_message_t* msg)
{
Lorenz Meier's avatar
Lorenz Meier committed
212
	return _MAV_RETURN_uint8_t(msg,  7);
James Goppert's avatar
James Goppert committed
213 214 215 216 217 218 219 220 221 222
}

/**
 * @brief Decode a data_transmission_handshake message into a struct
 *
 * @param msg The message to decode
 * @param data_transmission_handshake C-struct to decode the message contents into
 */
static inline void mavlink_msg_data_transmission_handshake_decode(const mavlink_message_t* msg, mavlink_data_transmission_handshake_t* data_transmission_handshake)
{
lm's avatar
lm committed
223 224
#if MAVLINK_NEED_BYTE_SWAP
	data_transmission_handshake->type = mavlink_msg_data_transmission_handshake_get_type(msg);
Lorenz Meier's avatar
Lorenz Meier committed
225
	data_transmission_handshake->size = mavlink_msg_data_transmission_handshake_get_size(msg);
lm's avatar
lm committed
226 227 228 229
	data_transmission_handshake->packets = mavlink_msg_data_transmission_handshake_get_packets(msg);
	data_transmission_handshake->payload = mavlink_msg_data_transmission_handshake_get_payload(msg);
	data_transmission_handshake->jpg_quality = mavlink_msg_data_transmission_handshake_get_jpg_quality(msg);
#else
Lorenz Meier's avatar
Lorenz Meier committed
230
	memcpy(data_transmission_handshake, _MAV_PAYLOAD(msg), 8);
lm's avatar
lm committed
231
#endif
James Goppert's avatar
James Goppert committed
232
}