mavlink_msg_resource_request.h 15 KB

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