lib/main/MAVLink/common/mavlink_msg_resource_request.h

   1 #pragma once
   2 // MESSAGE RESOURCE_REQUEST PACKING
   3
   4 #define MAVLINK_MSG_ID_RESOURCE_REQUEST 142
   5
   6 MAVPACKED(
   7 typedef struct __mavlink_resource_request_t {
   8  uint8_t request_id; /*< Request ID. This ID should be re-used when sending back URI contents*/
   9  uint8_t uri_type; /*< The type of requested URI. 0 = a file via URL. 1 = a UAVCAN binary*/
  10  uint8_t uri[120]; /*< The requested unique resource identifier (URI). It is not necessarily a straight domain name (depends on the URI type enum)*/
  11  uint8_t transfer_type; /*< The way the autopilot wants to receive the URI. 0 = MAVLink FTP. 1 = binary stream.*/
  12  uint8_t storage[120]; /*< The storage path the autopilot wants the URI to be stored in. Will only be valid if the transfer_type has a storage associated (e.g. MAVLink FTP).*/
  13 }) mavlink_resource_request_t;
  14
  15 #define MAVLINK_MSG_ID_RESOURCE_REQUEST_LEN 243
  16 #define MAVLINK_MSG_ID_RESOURCE_REQUEST_MIN_LEN 243
  17 #define MAVLINK_MSG_ID_142_LEN 243
  18 #define MAVLINK_MSG_ID_142_MIN_LEN 243
  19
  20 #define MAVLINK_MSG_ID_RESOURCE_REQUEST_CRC 72
  21 #define MAVLINK_MSG_ID_142_CRC 72
  22
  23 #define MAVLINK_MSG_RESOURCE_REQUEST_FIELD_URI_LEN 120
  24 #define MAVLINK_MSG_RESOURCE_REQUEST_FIELD_STORAGE_LEN 120
  25
  26 #if MAVLINK_COMMAND_24BIT
  27 #define MAVLINK_MESSAGE_INFO_RESOURCE_REQUEST { \
  28     142, \
  29     "RESOURCE_REQUEST", \
  30     5, \
  31     {  { "request_id", NULL, MAVLINK_TYPE_UINT8_T, 0, 0, offsetof(mavlink_resource_request_t, request_id) }, \
  32          { "uri_type", NULL, MAVLINK_TYPE_UINT8_T, 0, 1, offsetof(mavlink_resource_request_t, uri_type) }, \
  33          { "uri", NULL, MAVLINK_TYPE_UINT8_T, 120, 2, offsetof(mavlink_resource_request_t, uri) }, \
  34          { "transfer_type", NULL, MAVLINK_TYPE_UINT8_T, 0, 122, offsetof(mavlink_resource_request_t, transfer_type) }, \
  35          { "storage", NULL, MAVLINK_TYPE_UINT8_T, 120, 123, offsetof(mavlink_resource_request_t, storage) }, \
  36          } \
  37 }
  38 #else
  39 #define MAVLINK_MESSAGE_INFO_RESOURCE_REQUEST { \
  40     "RESOURCE_REQUEST", \
  41     5, \
  42     {  { "request_id", NULL, MAVLINK_TYPE_UINT8_T, 0, 0, offsetof(mavlink_resource_request_t, request_id) }, \
  43          { "uri_type", NULL, MAVLINK_TYPE_UINT8_T, 0, 1, offsetof(mavlink_resource_request_t, uri_type) }, \
  44          { "uri", NULL, MAVLINK_TYPE_UINT8_T, 120, 2, offsetof(mavlink_resource_request_t, uri) }, \
  45          { "transfer_type", NULL, MAVLINK_TYPE_UINT8_T, 0, 122, offsetof(mavlink_resource_request_t, transfer_type) }, \
  46          { "storage", NULL, MAVLINK_TYPE_UINT8_T, 120, 123, offsetof(mavlink_resource_request_t, storage) }, \
  47          } \
  48 }
  49 #endif
  50
  51 /**
  52  * @brief Pack a resource_request message
  53  * @param system_id ID of this system
  54  * @param component_id ID of this component (e.g. 200 for IMU)
  55  * @param msg The MAVLink message to compress the data into
  56  *
  57  * @param request_id Request ID. This ID should be re-used when sending back URI contents
  58  * @param uri_type The type of requested URI. 0 = a file via URL. 1 = a UAVCAN binary
  59  * @param uri The requested unique resource identifier (URI). It is not necessarily a straight domain name (depends on the URI type enum)
  60  * @param transfer_type The way the autopilot wants to receive the URI. 0 = MAVLink FTP. 1 = binary stream.
  61  * @param storage The storage path the autopilot wants the URI to be stored in. Will only be valid if the transfer_type has a storage associated (e.g. MAVLink FTP).
  62  * @return length of the message in bytes (excluding serial stream start sign)
  63  */
  64 static inline uint16_t mavlink_msg_resource_request_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
  65                                uint8_t request_id, uint8_t uri_type, const uint8_t *uri, uint8_t transfer_type, const uint8_t *storage)
  66 {
  67 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  68     char buf[MAVLINK_MSG_ID_RESOURCE_REQUEST_LEN];
  69     _mav_put_uint8_t(buf, 0, request_id);
  70     _mav_put_uint8_t(buf, 1, uri_type);
  71     _mav_put_uint8_t(buf, 122, transfer_type);
  72     _mav_put_uint8_t_array(buf, 2, uri, 120);
  73     _mav_put_uint8_t_array(buf, 123, storage, 120);
  74         memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_RESOURCE_REQUEST_LEN);
  75 #else
  76     mavlink_resource_request_t packet;
  77     packet.request_id = request_id;
  78     packet.uri_type = uri_type;
  79     packet.transfer_type = transfer_type;
  80     mav_array_memcpy(packet.uri, uri, sizeof(uint8_t)*120);
  81     mav_array_memcpy(packet.storage, storage, sizeof(uint8_t)*120);
  82         memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_RESOURCE_REQUEST_LEN);
  83 #endif
  84
  85     msg->msgid = MAVLINK_MSG_ID_RESOURCE_REQUEST;
  86     return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_RESOURCE_REQUEST_MIN_LEN, MAVLINK_MSG_ID_RESOURCE_REQUEST_LEN, MAVLINK_MSG_ID_RESOURCE_REQUEST_CRC);
  87 }
  88
  89 /**
  90  * @brief Pack a resource_request message on a channel
  91  * @param system_id ID of this system
  92  * @param component_id ID of this component (e.g. 200 for IMU)
  93  * @param chan The MAVLink channel this message will be sent over
  94  * @param msg The MAVLink message to compress the data into
  95  * @param request_id Request ID. This ID should be re-used when sending back URI contents
  96  * @param uri_type The type of requested URI. 0 = a file via URL. 1 = a UAVCAN binary
  97  * @param uri The requested unique resource identifier (URI). It is not necessarily a straight domain name (depends on the URI type enum)
  98  * @param transfer_type The way the autopilot wants to receive the URI. 0 = MAVLink FTP. 1 = binary stream.
  99  * @param storage The storage path the autopilot wants the URI to be stored in. Will only be valid if the transfer_type has a storage associated (e.g. MAVLink FTP).
 100  * @return length of the message in bytes (excluding serial stream start sign)
 101  */
 102 static inline uint16_t mavlink_msg_resource_request_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
 103                                mavlink_message_t* msg,
 104                                    uint8_t request_id,uint8_t uri_type,const uint8_t *uri,uint8_t transfer_type,const uint8_t *storage)
 105 {
 106 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
 107     char buf[MAVLINK_MSG_ID_RESOURCE_REQUEST_LEN];
 108     _mav_put_uint8_t(buf, 0, request_id);
 109     _mav_put_uint8_t(buf, 1, uri_type);
 110     _mav_put_uint8_t(buf, 122, transfer_type);
 111     _mav_put_uint8_t_array(buf, 2, uri, 120);
 112     _mav_put_uint8_t_array(buf, 123, storage, 120);
 113         memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_RESOURCE_REQUEST_LEN);
 114 #else
 115     mavlink_resource_request_t packet;
 116     packet.request_id = request_id;
 117     packet.uri_type = uri_type;
 118     packet.transfer_type = transfer_type;
 119     mav_array_memcpy(packet.uri, uri, sizeof(uint8_t)*120);
 120     mav_array_memcpy(packet.storage, storage, sizeof(uint8_t)*120);
 121         memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_RESOURCE_REQUEST_LEN);
 122 #endif
 123
 124     msg->msgid = MAVLINK_MSG_ID_RESOURCE_REQUEST;
 125     return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_RESOURCE_REQUEST_MIN_LEN, MAVLINK_MSG_ID_RESOURCE_REQUEST_LEN, MAVLINK_MSG_ID_RESOURCE_REQUEST_CRC);
 126 }
 127
 128 /**
 129  * @brief Encode a resource_request struct
 130  *
 131  * @param system_id ID of this system
 132  * @param component_id ID of this component (e.g. 200 for IMU)
 133  * @param msg The MAVLink message to compress the data into
 134  * @param resource_request C-struct to read the message contents from
 135  */
 136 static inline uint16_t mavlink_msg_resource_request_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_resource_request_t* resource_request)
 137 {
 138     return mavlink_msg_resource_request_pack(system_id, component_id, msg, resource_request->request_id, resource_request->uri_type, resource_request->uri, resource_request->transfer_type, resource_request->storage);
 139 }
 140
 141 /**
 142  * @brief Encode a resource_request struct on a channel
 143  *
 144  * @param system_id ID of this system
 145  * @param component_id ID of this component (e.g. 200 for IMU)
 146  * @param chan The MAVLink channel this message will be sent over
 147  * @param msg The MAVLink message to compress the data into
 148  * @param resource_request C-struct to read the message contents from
 149  */
 150 static inline uint16_t mavlink_msg_resource_request_encode_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const mavlink_resource_request_t* resource_request)
 151 {
 152     return mavlink_msg_resource_request_pack_chan(system_id, component_id, chan, msg, resource_request->request_id, resource_request->uri_type, resource_request->uri, resource_request->transfer_type, resource_request->storage);
 153 }
 154
 155 /**
 156  * @brief Send a resource_request message
 157  * @param chan MAVLink channel to send the message
 158  *
 159  * @param request_id Request ID. This ID should be re-used when sending back URI contents
 160  * @param uri_type The type of requested URI. 0 = a file via URL. 1 = a UAVCAN binary
 161  * @param uri The requested unique resource identifier (URI). It is not necessarily a straight domain name (depends on the URI type enum)
 162  * @param transfer_type The way the autopilot wants to receive the URI. 0 = MAVLink FTP. 1 = binary stream.
 163  * @param storage The storage path the autopilot wants the URI to be stored in. Will only be valid if the transfer_type has a storage associated (e.g. MAVLink FTP).
 164  */
 165 #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
 166
 167 static inline void mavlink_msg_resource_request_send(mavlink_channel_t chan, uint8_t request_id, uint8_t uri_type, const uint8_t *uri, uint8_t transfer_type, const uint8_t *storage)
 168 {
 169 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
 170     char buf[MAVLINK_MSG_ID_RESOURCE_REQUEST_LEN];
 171     _mav_put_uint8_t(buf, 0, request_id);
 172     _mav_put_uint8_t(buf, 1, uri_type);
 173     _mav_put_uint8_t(buf, 122, transfer_type);
 174     _mav_put_uint8_t_array(buf, 2, uri, 120);
 175     _mav_put_uint8_t_array(buf, 123, storage, 120);
 176     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_RESOURCE_REQUEST, buf, MAVLINK_MSG_ID_RESOURCE_REQUEST_MIN_LEN, MAVLINK_MSG_ID_RESOURCE_REQUEST_LEN, MAVLINK_MSG_ID_RESOURCE_REQUEST_CRC);
 177 #else
 178     mavlink_resource_request_t packet;
 179     packet.request_id = request_id;
 180     packet.uri_type = uri_type;
 181     packet.transfer_type = transfer_type;
 182     mav_array_memcpy(packet.uri, uri, sizeof(uint8_t)*120);
 183     mav_array_memcpy(packet.storage, storage, sizeof(uint8_t)*120);
 184     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_RESOURCE_REQUEST, (const char *)&packet, MAVLINK_MSG_ID_RESOURCE_REQUEST_MIN_LEN, MAVLINK_MSG_ID_RESOURCE_REQUEST_LEN, MAVLINK_MSG_ID_RESOURCE_REQUEST_CRC);
 185 #endif
 186 }
 187
 188 /**
 189  * @brief Send a resource_request message
 190  * @param chan MAVLink channel to send the message
 191  * @param struct The MAVLink struct to serialize
 192  */
 193 static inline void mavlink_msg_resource_request_send_struct(mavlink_channel_t chan, const mavlink_resource_request_t* resource_request)
 194 {
 195 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
 196     mavlink_msg_resource_request_send(chan, resource_request->request_id, resource_request->uri_type, resource_request->uri, resource_request->transfer_type, resource_request->storage);
 197 #else
 198     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_RESOURCE_REQUEST, (const char *)resource_request, MAVLINK_MSG_ID_RESOURCE_REQUEST_MIN_LEN, MAVLINK_MSG_ID_RESOURCE_REQUEST_LEN, MAVLINK_MSG_ID_RESOURCE_REQUEST_CRC);
 199 #endif
 200 }
 201
 202 #if MAVLINK_MSG_ID_RESOURCE_REQUEST_LEN <= MAVLINK_MAX_PAYLOAD_LEN
 203 /*
 204   This varient of _send() can be used to save stack space by re-using
 205   memory from the receive buffer.  The caller provides a
 206   mavlink_message_t which is the size of a full mavlink message. This
 207   is usually the receive buffer for the channel, and allows a reply to an
 208   incoming message with minimum stack space usage.
 209  */
 210 static inline void mavlink_msg_resource_request_send_buf(mavlink_message_t *msgbuf, mavlink_channel_t chan,  uint8_t request_id, uint8_t uri_type, const uint8_t *uri, uint8_t transfer_type, const uint8_t *storage)
 211 {
 212 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
 213     char *buf = (char *)msgbuf;
 214     _mav_put_uint8_t(buf, 0, request_id);
 215     _mav_put_uint8_t(buf, 1, uri_type);
 216     _mav_put_uint8_t(buf, 122, transfer_type);
 217     _mav_put_uint8_t_array(buf, 2, uri, 120);
 218     _mav_put_uint8_t_array(buf, 123, storage, 120);
 219     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_RESOURCE_REQUEST, buf, MAVLINK_MSG_ID_RESOURCE_REQUEST_MIN_LEN, MAVLINK_MSG_ID_RESOURCE_REQUEST_LEN, MAVLINK_MSG_ID_RESOURCE_REQUEST_CRC);
 220 #else
 221     mavlink_resource_request_t *packet = (mavlink_resource_request_t *)msgbuf;
 222     packet->request_id = request_id;
 223     packet->uri_type = uri_type;
 224     packet->transfer_type = transfer_type;
 225     mav_array_memcpy(packet->uri, uri, sizeof(uint8_t)*120);
 226     mav_array_memcpy(packet->storage, storage, sizeof(uint8_t)*120);
 227     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_RESOURCE_REQUEST, (const char *)packet, MAVLINK_MSG_ID_RESOURCE_REQUEST_MIN_LEN, MAVLINK_MSG_ID_RESOURCE_REQUEST_LEN, MAVLINK_MSG_ID_RESOURCE_REQUEST_CRC);
 228 #endif
 229 }
 230 #endif
 231
 232 #endif
 233
 234 // MESSAGE RESOURCE_REQUEST UNPACKING
 235
 236
 237 /**
 238  * @brief Get field request_id from resource_request message
 239  *
 240  * @return Request ID. This ID should be re-used when sending back URI contents
 241  */
 242 static inline uint8_t mavlink_msg_resource_request_get_request_id(const mavlink_message_t* msg)
 243 {
 244     return _MAV_RETURN_uint8_t(msg,  0);
 245 }
 246
 247 /**
 248  * @brief Get field uri_type from resource_request message
 249  *
 250  * @return The type of requested URI. 0 = a file via URL. 1 = a UAVCAN binary
 251  */
 252 static inline uint8_t mavlink_msg_resource_request_get_uri_type(const mavlink_message_t* msg)
 253 {
 254     return _MAV_RETURN_uint8_t(msg,  1);
 255 }
 256
 257 /**
 258  * @brief Get field uri from resource_request message
 259  *
 260  * @return The requested unique resource identifier (URI). It is not necessarily a straight domain name (depends on the URI type enum)
 261  */
 262 static inline uint16_t mavlink_msg_resource_request_get_uri(const mavlink_message_t* msg, uint8_t *uri)
 263 {
 264     return _MAV_RETURN_uint8_t_array(msg, uri, 120,  2);
 265 }
 266
 267 /**
 268  * @brief Get field transfer_type from resource_request message
 269  *
 270  * @return The way the autopilot wants to receive the URI. 0 = MAVLink FTP. 1 = binary stream.
 271  */
 272 static inline uint8_t mavlink_msg_resource_request_get_transfer_type(const mavlink_message_t* msg)
 273 {
 274     return _MAV_RETURN_uint8_t(msg,  122);
 275 }
 276
 277 /**
 278  * @brief Get field storage from resource_request message
 279  *
 280  * @return The storage path the autopilot wants the URI to be stored in. Will only be valid if the transfer_type has a storage associated (e.g. MAVLink FTP).
 281  */
 282 static inline uint16_t mavlink_msg_resource_request_get_storage(const mavlink_message_t* msg, uint8_t *storage)
 283 {
 284     return _MAV_RETURN_uint8_t_array(msg, storage, 120,  123);
 285 }
 286
 287 /**
 288  * @brief Decode a resource_request message into a struct
 289  *
 290  * @param msg The message to decode
 291  * @param resource_request C-struct to decode the message contents into
 292  */
 293 static inline void mavlink_msg_resource_request_decode(const mavlink_message_t* msg, mavlink_resource_request_t* resource_request)
 294 {
 295 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
 296     resource_request->request_id = mavlink_msg_resource_request_get_request_id(msg);
 297     resource_request->uri_type = mavlink_msg_resource_request_get_uri_type(msg);
 298     mavlink_msg_resource_request_get_uri(msg, resource_request->uri);
 299     resource_request->transfer_type = mavlink_msg_resource_request_get_transfer_type(msg);
 300     mavlink_msg_resource_request_get_storage(msg, resource_request->storage);
 301 #else
 302         uint8_t len = msg->len < MAVLINK_MSG_ID_RESOURCE_REQUEST_LEN? msg->len : MAVLINK_MSG_ID_RESOURCE_REQUEST_LEN;
 303         memset(resource_request, 0, MAVLINK_MSG_ID_RESOURCE_REQUEST_LEN);
 304     memcpy(resource_request, _MAV_PAYLOAD(msg), len);
 305 #endif
 306 }