aboutsummaryrefslogtreecommitdiff
path: root/mavlink/include/mavlink/v1.0/common/mavlink_msg_file_transfer_start.h
blob: 5eaa9b2207177f0e8cb106c3092af0ec94c94393 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
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
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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
// MESSAGE FILE_TRANSFER_START PACKING

#define MAVLINK_MSG_ID_FILE_TRANSFER_START 110

typedef struct __mavlink_file_transfer_start_t
{
 uint64_t transfer_uid; ///< Unique transfer ID
 uint32_t file_size; ///< File size in bytes
 char dest_path[240]; ///< Destination path
 uint8_t direction; ///< Transfer direction: 0: from requester, 1: to requester
 uint8_t flags; ///< RESERVED
} mavlink_file_transfer_start_t;

#define MAVLINK_MSG_ID_FILE_TRANSFER_START_LEN 254
#define MAVLINK_MSG_ID_110_LEN 254

#define MAVLINK_MSG_FILE_TRANSFER_START_FIELD_DEST_PATH_LEN 240

#define MAVLINK_MESSAGE_INFO_FILE_TRANSFER_START { \
	"FILE_TRANSFER_START", \
	5, \
	{  { "transfer_uid", NULL, MAVLINK_TYPE_UINT64_T, 0, 0, offsetof(mavlink_file_transfer_start_t, transfer_uid) }, \
         { "file_size", NULL, MAVLINK_TYPE_UINT32_T, 0, 8, offsetof(mavlink_file_transfer_start_t, file_size) }, \
         { "dest_path", NULL, MAVLINK_TYPE_CHAR, 240, 12, offsetof(mavlink_file_transfer_start_t, dest_path) }, \
         { "direction", NULL, MAVLINK_TYPE_UINT8_T, 0, 252, offsetof(mavlink_file_transfer_start_t, direction) }, \
         { "flags", NULL, MAVLINK_TYPE_UINT8_T, 0, 253, offsetof(mavlink_file_transfer_start_t, flags) }, \
         } \
}


/**
 * @brief Pack a file_transfer_start 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 transfer_uid Unique transfer ID
 * @param dest_path Destination path
 * @param direction Transfer direction: 0: from requester, 1: to requester
 * @param file_size File size in bytes
 * @param flags RESERVED
 * @return length of the message in bytes (excluding serial stream start sign)
 */
static inline uint16_t mavlink_msg_file_transfer_start_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
						       uint64_t transfer_uid, const char *dest_path, uint8_t direction, uint32_t file_size, uint8_t flags)
{
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
	char buf[254];
	_mav_put_uint64_t(buf, 0, transfer_uid);
	_mav_put_uint32_t(buf, 8, file_size);
	_mav_put_uint8_t(buf, 252, direction);
	_mav_put_uint8_t(buf, 253, flags);
	_mav_put_char_array(buf, 12, dest_path, 240);
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, 254);
#else
	mavlink_file_transfer_start_t packet;
	packet.transfer_uid = transfer_uid;
	packet.file_size = file_size;
	packet.direction = direction;
	packet.flags = flags;
	mav_array_memcpy(packet.dest_path, dest_path, sizeof(char)*240);
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, 254);
#endif

	msg->msgid = MAVLINK_MSG_ID_FILE_TRANSFER_START;
	return mavlink_finalize_message(msg, system_id, component_id, 254, 235);
}

/**
 * @brief Pack a file_transfer_start message on a channel
 * @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 transfer_uid Unique transfer ID
 * @param dest_path Destination path
 * @param direction Transfer direction: 0: from requester, 1: to requester
 * @param file_size File size in bytes
 * @param flags RESERVED
 * @return length of the message in bytes (excluding serial stream start sign)
 */
static inline uint16_t mavlink_msg_file_transfer_start_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
							   mavlink_message_t* msg,
						           uint64_t transfer_uid,const char *dest_path,uint8_t direction,uint32_t file_size,uint8_t flags)
{
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
	char buf[254];
	_mav_put_uint64_t(buf, 0, transfer_uid);
	_mav_put_uint32_t(buf, 8, file_size);
	_mav_put_uint8_t(buf, 252, direction);
	_mav_put_uint8_t(buf, 253, flags);
	_mav_put_char_array(buf, 12, dest_path, 240);
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, 254);
#else
	mavlink_file_transfer_start_t packet;
	packet.transfer_uid = transfer_uid;
	packet.file_size = file_size;
	packet.direction = direction;
	packet.flags = flags;
	mav_array_memcpy(packet.dest_path, dest_path, sizeof(char)*240);
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, 254);
#endif

	msg->msgid = MAVLINK_MSG_ID_FILE_TRANSFER_START;
	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, 254, 235);
}

/**
 * @brief Encode a file_transfer_start 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 file_transfer_start C-struct to read the message contents from
 */
static inline uint16_t mavlink_msg_file_transfer_start_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_file_transfer_start_t* file_transfer_start)
{
	return mavlink_msg_file_transfer_start_pack(system_id, component_id, msg, file_transfer_start->transfer_uid, file_transfer_start->dest_path, file_transfer_start->direction, file_transfer_start->file_size, file_transfer_start->flags);
}

/**
 * @brief Send a file_transfer_start message
 * @param chan MAVLink channel to send the message
 *
 * @param transfer_uid Unique transfer ID
 * @param dest_path Destination path
 * @param direction Transfer direction: 0: from requester, 1: to requester
 * @param file_size File size in bytes
 * @param flags RESERVED
 */
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

static inline void mavlink_msg_file_transfer_start_send(mavlink_channel_t chan, uint64_t transfer_uid, const char *dest_path, uint8_t direction, uint32_t file_size, uint8_t flags)
{
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
	char buf[254];
	_mav_put_uint64_t(buf, 0, transfer_uid);
	_mav_put_uint32_t(buf, 8, file_size);
	_mav_put_uint8_t(buf, 252, direction);
	_mav_put_uint8_t(buf, 253, flags);
	_mav_put_char_array(buf, 12, dest_path, 240);
	_mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_FILE_TRANSFER_START, buf, 254, 235);
#else
	mavlink_file_transfer_start_t packet;
	packet.transfer_uid = transfer_uid;
	packet.file_size = file_size;
	packet.direction = direction;
	packet.flags = flags;
	mav_array_memcpy(packet.dest_path, dest_path, sizeof(char)*240);
	_mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_FILE_TRANSFER_START, (const char *)&packet, 254, 235);
#endif
}

#endif

// MESSAGE FILE_TRANSFER_START UNPACKING


/**
 * @brief Get field transfer_uid from file_transfer_start message
 *
 * @return Unique transfer ID
 */
static inline uint64_t mavlink_msg_file_transfer_start_get_transfer_uid(const mavlink_message_t* msg)
{
	return _MAV_RETURN_uint64_t(msg,  0);
}

/**
 * @brief Get field dest_path from file_transfer_start message
 *
 * @return Destination path
 */
static inline uint16_t mavlink_msg_file_transfer_start_get_dest_path(const mavlink_message_t* msg, char *dest_path)
{
	return _MAV_RETURN_char_array(msg, dest_path, 240,  12);
}

/**
 * @brief Get field direction from file_transfer_start message
 *
 * @return Transfer direction: 0: from requester, 1: to requester
 */
static inline uint8_t mavlink_msg_file_transfer_start_get_direction(const mavlink_message_t* msg)
{
	return _MAV_RETURN_uint8_t(msg,  252);
}

/**
 * @brief Get field file_size from file_transfer_start message
 *
 * @return File size in bytes
 */
static inline uint32_t mavlink_msg_file_transfer_start_get_file_size(const mavlink_message_t* msg)
{
	return _MAV_RETURN_uint32_t(msg,  8);
}

/**
 * @brief Get field flags from file_transfer_start message
 *
 * @return RESERVED
 */
static inline uint8_t mavlink_msg_file_transfer_start_get_flags(const mavlink_message_t* msg)
{
	return _MAV_RETURN_uint8_t(msg,  253);
}

/**
 * @brief Decode a file_transfer_start message into a struct
 *
 * @param msg The message to decode
 * @param file_transfer_start C-struct to decode the message contents into
 */
static inline void mavlink_msg_file_transfer_start_decode(const mavlink_message_t* msg, mavlink_file_transfer_start_t* file_transfer_start)
{
#if MAVLINK_NEED_BYTE_SWAP
	file_transfer_start->transfer_uid = mavlink_msg_file_transfer_start_get_transfer_uid(msg);
	file_transfer_start->file_size = mavlink_msg_file_transfer_start_get_file_size(msg);
	mavlink_msg_file_transfer_start_get_dest_path(msg, file_transfer_start->dest_path);
	file_transfer_start->direction = mavlink_msg_file_transfer_start_get_direction(msg);
	file_transfer_start->flags = mavlink_msg_file_transfer_start_get_flags(msg);
#else
	memcpy(file_transfer_start, _MAV_PAYLOAD(msg), 254);
#endif
}