mavlink_msg_file_transfer_res.h 6.77 KB
Newer Older
Lorenz Meier's avatar
Lorenz Meier committed
1 2 3 4 5 6 7 8 9 10 11 12 13
// MESSAGE FILE_TRANSFER_RES PACKING

#define MAVLINK_MSG_ID_FILE_TRANSFER_RES 112

typedef struct __mavlink_file_transfer_res_t
{
 uint64_t transfer_uid; ///< Unique transfer ID
 uint8_t result; ///< 0: OK, 1: not permitted, 2: bad path / file name, 3: no space left on device
} mavlink_file_transfer_res_t;

#define MAVLINK_MSG_ID_FILE_TRANSFER_RES_LEN 9
#define MAVLINK_MSG_ID_112_LEN 9

Lorenz Meier's avatar
Lorenz Meier committed
14 15 16
#define MAVLINK_MSG_ID_FILE_TRANSFER_RES_CRC 124
#define MAVLINK_MSG_ID_112_CRC 124

Lorenz Meier's avatar
Lorenz Meier committed
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


#define MAVLINK_MESSAGE_INFO_FILE_TRANSFER_RES { \
	"FILE_TRANSFER_RES", \
	2, \
	{  { "transfer_uid", NULL, MAVLINK_TYPE_UINT64_T, 0, 0, offsetof(mavlink_file_transfer_res_t, transfer_uid) }, \
         { "result", NULL, MAVLINK_TYPE_UINT8_T, 0, 8, offsetof(mavlink_file_transfer_res_t, result) }, \
         } \
}


/**
 * @brief Pack a file_transfer_res 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 result 0: OK, 1: not permitted, 2: bad path / file name, 3: no space left on device
 * @return length of the message in bytes (excluding serial stream start sign)
 */
static inline uint16_t mavlink_msg_file_transfer_res_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
						       uint64_t transfer_uid, uint8_t result)
{
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
Lorenz Meier's avatar
Lorenz Meier committed
42
	char buf[MAVLINK_MSG_ID_FILE_TRANSFER_RES_LEN];
Lorenz Meier's avatar
Lorenz Meier committed
43 44 45
	_mav_put_uint64_t(buf, 0, transfer_uid);
	_mav_put_uint8_t(buf, 8, result);

Lorenz Meier's avatar
Lorenz Meier committed
46
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_FILE_TRANSFER_RES_LEN);
Lorenz Meier's avatar
Lorenz Meier committed
47 48 49 50 51
#else
	mavlink_file_transfer_res_t packet;
	packet.transfer_uid = transfer_uid;
	packet.result = result;

Lorenz Meier's avatar
Lorenz Meier committed
52
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_FILE_TRANSFER_RES_LEN);
Lorenz Meier's avatar
Lorenz Meier committed
53 54 55
#endif

	msg->msgid = MAVLINK_MSG_ID_FILE_TRANSFER_RES;
Lorenz Meier's avatar
Lorenz Meier committed
56 57 58 59 60
#if MAVLINK_CRC_EXTRA
    return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_FILE_TRANSFER_RES_LEN, MAVLINK_MSG_ID_FILE_TRANSFER_RES_CRC);
#else
    return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_FILE_TRANSFER_RES_LEN);
#endif
Lorenz Meier's avatar
Lorenz Meier committed
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
}

/**
 * @brief Pack a file_transfer_res 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 result 0: OK, 1: not permitted, 2: bad path / file name, 3: no space left on device
 * @return length of the message in bytes (excluding serial stream start sign)
 */
static inline uint16_t mavlink_msg_file_transfer_res_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
							   mavlink_message_t* msg,
						           uint64_t transfer_uid,uint8_t result)
{
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
Lorenz Meier's avatar
Lorenz Meier committed
78
	char buf[MAVLINK_MSG_ID_FILE_TRANSFER_RES_LEN];
Lorenz Meier's avatar
Lorenz Meier committed
79 80 81
	_mav_put_uint64_t(buf, 0, transfer_uid);
	_mav_put_uint8_t(buf, 8, result);

Lorenz Meier's avatar
Lorenz Meier committed
82
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_FILE_TRANSFER_RES_LEN);
Lorenz Meier's avatar
Lorenz Meier committed
83 84 85 86 87
#else
	mavlink_file_transfer_res_t packet;
	packet.transfer_uid = transfer_uid;
	packet.result = result;

Lorenz Meier's avatar
Lorenz Meier committed
88
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_FILE_TRANSFER_RES_LEN);
Lorenz Meier's avatar
Lorenz Meier committed
89 90 91
#endif

	msg->msgid = MAVLINK_MSG_ID_FILE_TRANSFER_RES;
Lorenz Meier's avatar
Lorenz Meier committed
92 93 94 95 96
#if MAVLINK_CRC_EXTRA
    return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_FILE_TRANSFER_RES_LEN, MAVLINK_MSG_ID_FILE_TRANSFER_RES_CRC);
#else
    return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_FILE_TRANSFER_RES_LEN);
#endif
Lorenz Meier's avatar
Lorenz Meier committed
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
}

/**
 * @brief Encode a file_transfer_res 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_res C-struct to read the message contents from
 */
static inline uint16_t mavlink_msg_file_transfer_res_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_file_transfer_res_t* file_transfer_res)
{
	return mavlink_msg_file_transfer_res_pack(system_id, component_id, msg, file_transfer_res->transfer_uid, file_transfer_res->result);
}

/**
 * @brief Send a file_transfer_res message
 * @param chan MAVLink channel to send the message
 *
 * @param transfer_uid Unique transfer ID
 * @param result 0: OK, 1: not permitted, 2: bad path / file name, 3: no space left on device
 */
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

static inline void mavlink_msg_file_transfer_res_send(mavlink_channel_t chan, uint64_t transfer_uid, uint8_t result)
{
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
Lorenz Meier's avatar
Lorenz Meier committed
124
	char buf[MAVLINK_MSG_ID_FILE_TRANSFER_RES_LEN];
Lorenz Meier's avatar
Lorenz Meier committed
125 126 127
	_mav_put_uint64_t(buf, 0, transfer_uid);
	_mav_put_uint8_t(buf, 8, result);

Lorenz Meier's avatar
Lorenz Meier committed
128 129 130 131 132
#if MAVLINK_CRC_EXTRA
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_FILE_TRANSFER_RES, buf, MAVLINK_MSG_ID_FILE_TRANSFER_RES_LEN, MAVLINK_MSG_ID_FILE_TRANSFER_RES_CRC);
#else
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_FILE_TRANSFER_RES, buf, MAVLINK_MSG_ID_FILE_TRANSFER_RES_LEN);
#endif
Lorenz Meier's avatar
Lorenz Meier committed
133 134 135 136 137
#else
	mavlink_file_transfer_res_t packet;
	packet.transfer_uid = transfer_uid;
	packet.result = result;

Lorenz Meier's avatar
Lorenz Meier committed
138 139 140 141 142
#if MAVLINK_CRC_EXTRA
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_FILE_TRANSFER_RES, (const char *)&packet, MAVLINK_MSG_ID_FILE_TRANSFER_RES_LEN, MAVLINK_MSG_ID_FILE_TRANSFER_RES_CRC);
#else
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_FILE_TRANSFER_RES, (const char *)&packet, MAVLINK_MSG_ID_FILE_TRANSFER_RES_LEN);
#endif
Lorenz Meier's avatar
Lorenz Meier committed
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
#endif
}

#endif

// MESSAGE FILE_TRANSFER_RES UNPACKING


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

/**
 * @brief Get field result from file_transfer_res message
 *
 * @return 0: OK, 1: not permitted, 2: bad path / file name, 3: no space left on device
 */
static inline uint8_t mavlink_msg_file_transfer_res_get_result(const mavlink_message_t* msg)
{
	return _MAV_RETURN_uint8_t(msg,  8);
}

/**
 * @brief Decode a file_transfer_res message into a struct
 *
 * @param msg The message to decode
 * @param file_transfer_res C-struct to decode the message contents into
 */
static inline void mavlink_msg_file_transfer_res_decode(const mavlink_message_t* msg, mavlink_file_transfer_res_t* file_transfer_res)
{
#if MAVLINK_NEED_BYTE_SWAP
	file_transfer_res->transfer_uid = mavlink_msg_file_transfer_res_get_transfer_uid(msg);
	file_transfer_res->result = mavlink_msg_file_transfer_res_get_result(msg);
#else
Lorenz Meier's avatar
Lorenz Meier committed
183
	memcpy(file_transfer_res, _MAV_PAYLOAD(msg), MAVLINK_MSG_ID_FILE_TRANSFER_RES_LEN);
Lorenz Meier's avatar
Lorenz Meier committed
184 185
#endif
}