mavlink_msg_component_metadata.h 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306
  1. #pragma once
  2. // MESSAGE COMPONENT_METADATA PACKING
  3. #define MAVLINK_MSG_ID_COMPONENT_METADATA 397
  4. typedef struct __mavlink_component_metadata_t {
  5. uint32_t time_boot_ms; /*< [ms] Timestamp (time since system boot).*/
  6. uint32_t file_crc; /*< CRC32 of the general metadata file.*/
  7. char uri[100]; /*< MAVLink FTP URI for the general metadata file (COMP_METADATA_TYPE_GENERAL), which may be compressed with xz. The file contains general component metadata, and may contain URI links for additional metadata (see COMP_METADATA_TYPE). The information is static from boot, and may be generated at compile time. The string needs to be zero terminated.*/
  8. } mavlink_component_metadata_t;
  9. #define MAVLINK_MSG_ID_COMPONENT_METADATA_LEN 108
  10. #define MAVLINK_MSG_ID_COMPONENT_METADATA_MIN_LEN 108
  11. #define MAVLINK_MSG_ID_397_LEN 108
  12. #define MAVLINK_MSG_ID_397_MIN_LEN 108
  13. #define MAVLINK_MSG_ID_COMPONENT_METADATA_CRC 182
  14. #define MAVLINK_MSG_ID_397_CRC 182
  15. #define MAVLINK_MSG_COMPONENT_METADATA_FIELD_URI_LEN 100
  16. #if MAVLINK_COMMAND_24BIT
  17. #define MAVLINK_MESSAGE_INFO_COMPONENT_METADATA { \
  18. 397, \
  19. "COMPONENT_METADATA", \
  20. 3, \
  21. { { "time_boot_ms", NULL, MAVLINK_TYPE_UINT32_T, 0, 0, offsetof(mavlink_component_metadata_t, time_boot_ms) }, \
  22. { "file_crc", NULL, MAVLINK_TYPE_UINT32_T, 0, 4, offsetof(mavlink_component_metadata_t, file_crc) }, \
  23. { "uri", NULL, MAVLINK_TYPE_CHAR, 100, 8, offsetof(mavlink_component_metadata_t, uri) }, \
  24. } \
  25. }
  26. #else
  27. #define MAVLINK_MESSAGE_INFO_COMPONENT_METADATA { \
  28. "COMPONENT_METADATA", \
  29. 3, \
  30. { { "time_boot_ms", NULL, MAVLINK_TYPE_UINT32_T, 0, 0, offsetof(mavlink_component_metadata_t, time_boot_ms) }, \
  31. { "file_crc", NULL, MAVLINK_TYPE_UINT32_T, 0, 4, offsetof(mavlink_component_metadata_t, file_crc) }, \
  32. { "uri", NULL, MAVLINK_TYPE_CHAR, 100, 8, offsetof(mavlink_component_metadata_t, uri) }, \
  33. } \
  34. }
  35. #endif
  36. /**
  37. * @brief Pack a component_metadata message
  38. * @param system_id ID of this system
  39. * @param component_id ID of this component (e.g. 200 for IMU)
  40. * @param msg The MAVLink message to compress the data into
  41. *
  42. * @param time_boot_ms [ms] Timestamp (time since system boot).
  43. * @param file_crc CRC32 of the general metadata file.
  44. * @param uri MAVLink FTP URI for the general metadata file (COMP_METADATA_TYPE_GENERAL), which may be compressed with xz. The file contains general component metadata, and may contain URI links for additional metadata (see COMP_METADATA_TYPE). The information is static from boot, and may be generated at compile time. The string needs to be zero terminated.
  45. * @return length of the message in bytes (excluding serial stream start sign)
  46. */
  47. static inline uint16_t mavlink_msg_component_metadata_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
  48. uint32_t time_boot_ms, uint32_t file_crc, const char *uri)
  49. {
  50. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  51. char buf[MAVLINK_MSG_ID_COMPONENT_METADATA_LEN];
  52. _mav_put_uint32_t(buf, 0, time_boot_ms);
  53. _mav_put_uint32_t(buf, 4, file_crc);
  54. _mav_put_char_array(buf, 8, uri, 100);
  55. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_COMPONENT_METADATA_LEN);
  56. #else
  57. mavlink_component_metadata_t packet;
  58. packet.time_boot_ms = time_boot_ms;
  59. packet.file_crc = file_crc;
  60. mav_array_memcpy(packet.uri, uri, sizeof(char)*100);
  61. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_COMPONENT_METADATA_LEN);
  62. #endif
  63. msg->msgid = MAVLINK_MSG_ID_COMPONENT_METADATA;
  64. return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_COMPONENT_METADATA_MIN_LEN, MAVLINK_MSG_ID_COMPONENT_METADATA_LEN, MAVLINK_MSG_ID_COMPONENT_METADATA_CRC);
  65. }
  66. /**
  67. * @brief Pack a component_metadata message
  68. * @param system_id ID of this system
  69. * @param component_id ID of this component (e.g. 200 for IMU)
  70. * @param status MAVLink status structure
  71. * @param msg The MAVLink message to compress the data into
  72. *
  73. * @param time_boot_ms [ms] Timestamp (time since system boot).
  74. * @param file_crc CRC32 of the general metadata file.
  75. * @param uri MAVLink FTP URI for the general metadata file (COMP_METADATA_TYPE_GENERAL), which may be compressed with xz. The file contains general component metadata, and may contain URI links for additional metadata (see COMP_METADATA_TYPE). The information is static from boot, and may be generated at compile time. The string needs to be zero terminated.
  76. * @return length of the message in bytes (excluding serial stream start sign)
  77. */
  78. static inline uint16_t mavlink_msg_component_metadata_pack_status(uint8_t system_id, uint8_t component_id, mavlink_status_t *_status, mavlink_message_t* msg,
  79. uint32_t time_boot_ms, uint32_t file_crc, const char *uri)
  80. {
  81. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  82. char buf[MAVLINK_MSG_ID_COMPONENT_METADATA_LEN];
  83. _mav_put_uint32_t(buf, 0, time_boot_ms);
  84. _mav_put_uint32_t(buf, 4, file_crc);
  85. _mav_put_char_array(buf, 8, uri, 100);
  86. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_COMPONENT_METADATA_LEN);
  87. #else
  88. mavlink_component_metadata_t packet;
  89. packet.time_boot_ms = time_boot_ms;
  90. packet.file_crc = file_crc;
  91. mav_array_memcpy(packet.uri, uri, sizeof(char)*100);
  92. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_COMPONENT_METADATA_LEN);
  93. #endif
  94. msg->msgid = MAVLINK_MSG_ID_COMPONENT_METADATA;
  95. #if MAVLINK_CRC_EXTRA
  96. return mavlink_finalize_message_buffer(msg, system_id, component_id, _status, MAVLINK_MSG_ID_COMPONENT_METADATA_MIN_LEN, MAVLINK_MSG_ID_COMPONENT_METADATA_LEN, MAVLINK_MSG_ID_COMPONENT_METADATA_CRC);
  97. #else
  98. return mavlink_finalize_message_buffer(msg, system_id, component_id, _status, MAVLINK_MSG_ID_COMPONENT_METADATA_MIN_LEN, MAVLINK_MSG_ID_COMPONENT_METADATA_LEN);
  99. #endif
  100. }
  101. /**
  102. * @brief Pack a component_metadata message on a channel
  103. * @param system_id ID of this system
  104. * @param component_id ID of this component (e.g. 200 for IMU)
  105. * @param chan The MAVLink channel this message will be sent over
  106. * @param msg The MAVLink message to compress the data into
  107. * @param time_boot_ms [ms] Timestamp (time since system boot).
  108. * @param file_crc CRC32 of the general metadata file.
  109. * @param uri MAVLink FTP URI for the general metadata file (COMP_METADATA_TYPE_GENERAL), which may be compressed with xz. The file contains general component metadata, and may contain URI links for additional metadata (see COMP_METADATA_TYPE). The information is static from boot, and may be generated at compile time. The string needs to be zero terminated.
  110. * @return length of the message in bytes (excluding serial stream start sign)
  111. */
  112. static inline uint16_t mavlink_msg_component_metadata_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
  113. mavlink_message_t* msg,
  114. uint32_t time_boot_ms,uint32_t file_crc,const char *uri)
  115. {
  116. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  117. char buf[MAVLINK_MSG_ID_COMPONENT_METADATA_LEN];
  118. _mav_put_uint32_t(buf, 0, time_boot_ms);
  119. _mav_put_uint32_t(buf, 4, file_crc);
  120. _mav_put_char_array(buf, 8, uri, 100);
  121. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_COMPONENT_METADATA_LEN);
  122. #else
  123. mavlink_component_metadata_t packet;
  124. packet.time_boot_ms = time_boot_ms;
  125. packet.file_crc = file_crc;
  126. mav_array_memcpy(packet.uri, uri, sizeof(char)*100);
  127. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_COMPONENT_METADATA_LEN);
  128. #endif
  129. msg->msgid = MAVLINK_MSG_ID_COMPONENT_METADATA;
  130. return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_COMPONENT_METADATA_MIN_LEN, MAVLINK_MSG_ID_COMPONENT_METADATA_LEN, MAVLINK_MSG_ID_COMPONENT_METADATA_CRC);
  131. }
  132. /**
  133. * @brief Encode a component_metadata struct
  134. *
  135. * @param system_id ID of this system
  136. * @param component_id ID of this component (e.g. 200 for IMU)
  137. * @param msg The MAVLink message to compress the data into
  138. * @param component_metadata C-struct to read the message contents from
  139. */
  140. static inline uint16_t mavlink_msg_component_metadata_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_component_metadata_t* component_metadata)
  141. {
  142. return mavlink_msg_component_metadata_pack(system_id, component_id, msg, component_metadata->time_boot_ms, component_metadata->file_crc, component_metadata->uri);
  143. }
  144. /**
  145. * @brief Encode a component_metadata struct on a channel
  146. *
  147. * @param system_id ID of this system
  148. * @param component_id ID of this component (e.g. 200 for IMU)
  149. * @param chan The MAVLink channel this message will be sent over
  150. * @param msg The MAVLink message to compress the data into
  151. * @param component_metadata C-struct to read the message contents from
  152. */
  153. static inline uint16_t mavlink_msg_component_metadata_encode_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const mavlink_component_metadata_t* component_metadata)
  154. {
  155. return mavlink_msg_component_metadata_pack_chan(system_id, component_id, chan, msg, component_metadata->time_boot_ms, component_metadata->file_crc, component_metadata->uri);
  156. }
  157. /**
  158. * @brief Encode a component_metadata struct with provided status structure
  159. *
  160. * @param system_id ID of this system
  161. * @param component_id ID of this component (e.g. 200 for IMU)
  162. * @param status MAVLink status structure
  163. * @param msg The MAVLink message to compress the data into
  164. * @param component_metadata C-struct to read the message contents from
  165. */
  166. static inline uint16_t mavlink_msg_component_metadata_encode_status(uint8_t system_id, uint8_t component_id, mavlink_status_t* _status, mavlink_message_t* msg, const mavlink_component_metadata_t* component_metadata)
  167. {
  168. return mavlink_msg_component_metadata_pack_status(system_id, component_id, _status, msg, component_metadata->time_boot_ms, component_metadata->file_crc, component_metadata->uri);
  169. }
  170. /**
  171. * @brief Send a component_metadata message
  172. * @param chan MAVLink channel to send the message
  173. *
  174. * @param time_boot_ms [ms] Timestamp (time since system boot).
  175. * @param file_crc CRC32 of the general metadata file.
  176. * @param uri MAVLink FTP URI for the general metadata file (COMP_METADATA_TYPE_GENERAL), which may be compressed with xz. The file contains general component metadata, and may contain URI links for additional metadata (see COMP_METADATA_TYPE). The information is static from boot, and may be generated at compile time. The string needs to be zero terminated.
  177. */
  178. #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
  179. static inline void mavlink_msg_component_metadata_send(mavlink_channel_t chan, uint32_t time_boot_ms, uint32_t file_crc, const char *uri)
  180. {
  181. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  182. char buf[MAVLINK_MSG_ID_COMPONENT_METADATA_LEN];
  183. _mav_put_uint32_t(buf, 0, time_boot_ms);
  184. _mav_put_uint32_t(buf, 4, file_crc);
  185. _mav_put_char_array(buf, 8, uri, 100);
  186. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_COMPONENT_METADATA, buf, MAVLINK_MSG_ID_COMPONENT_METADATA_MIN_LEN, MAVLINK_MSG_ID_COMPONENT_METADATA_LEN, MAVLINK_MSG_ID_COMPONENT_METADATA_CRC);
  187. #else
  188. mavlink_component_metadata_t packet;
  189. packet.time_boot_ms = time_boot_ms;
  190. packet.file_crc = file_crc;
  191. mav_array_memcpy(packet.uri, uri, sizeof(char)*100);
  192. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_COMPONENT_METADATA, (const char *)&packet, MAVLINK_MSG_ID_COMPONENT_METADATA_MIN_LEN, MAVLINK_MSG_ID_COMPONENT_METADATA_LEN, MAVLINK_MSG_ID_COMPONENT_METADATA_CRC);
  193. #endif
  194. }
  195. /**
  196. * @brief Send a component_metadata message
  197. * @param chan MAVLink channel to send the message
  198. * @param struct The MAVLink struct to serialize
  199. */
  200. static inline void mavlink_msg_component_metadata_send_struct(mavlink_channel_t chan, const mavlink_component_metadata_t* component_metadata)
  201. {
  202. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  203. mavlink_msg_component_metadata_send(chan, component_metadata->time_boot_ms, component_metadata->file_crc, component_metadata->uri);
  204. #else
  205. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_COMPONENT_METADATA, (const char *)component_metadata, MAVLINK_MSG_ID_COMPONENT_METADATA_MIN_LEN, MAVLINK_MSG_ID_COMPONENT_METADATA_LEN, MAVLINK_MSG_ID_COMPONENT_METADATA_CRC);
  206. #endif
  207. }
  208. #if MAVLINK_MSG_ID_COMPONENT_METADATA_LEN <= MAVLINK_MAX_PAYLOAD_LEN
  209. /*
  210. This variant of _send() can be used to save stack space by re-using
  211. memory from the receive buffer. The caller provides a
  212. mavlink_message_t which is the size of a full mavlink message. This
  213. is usually the receive buffer for the channel, and allows a reply to an
  214. incoming message with minimum stack space usage.
  215. */
  216. static inline void mavlink_msg_component_metadata_send_buf(mavlink_message_t *msgbuf, mavlink_channel_t chan, uint32_t time_boot_ms, uint32_t file_crc, const char *uri)
  217. {
  218. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  219. char *buf = (char *)msgbuf;
  220. _mav_put_uint32_t(buf, 0, time_boot_ms);
  221. _mav_put_uint32_t(buf, 4, file_crc);
  222. _mav_put_char_array(buf, 8, uri, 100);
  223. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_COMPONENT_METADATA, buf, MAVLINK_MSG_ID_COMPONENT_METADATA_MIN_LEN, MAVLINK_MSG_ID_COMPONENT_METADATA_LEN, MAVLINK_MSG_ID_COMPONENT_METADATA_CRC);
  224. #else
  225. mavlink_component_metadata_t *packet = (mavlink_component_metadata_t *)msgbuf;
  226. packet->time_boot_ms = time_boot_ms;
  227. packet->file_crc = file_crc;
  228. mav_array_memcpy(packet->uri, uri, sizeof(char)*100);
  229. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_COMPONENT_METADATA, (const char *)packet, MAVLINK_MSG_ID_COMPONENT_METADATA_MIN_LEN, MAVLINK_MSG_ID_COMPONENT_METADATA_LEN, MAVLINK_MSG_ID_COMPONENT_METADATA_CRC);
  230. #endif
  231. }
  232. #endif
  233. #endif
  234. // MESSAGE COMPONENT_METADATA UNPACKING
  235. /**
  236. * @brief Get field time_boot_ms from component_metadata message
  237. *
  238. * @return [ms] Timestamp (time since system boot).
  239. */
  240. static inline uint32_t mavlink_msg_component_metadata_get_time_boot_ms(const mavlink_message_t* msg)
  241. {
  242. return _MAV_RETURN_uint32_t(msg, 0);
  243. }
  244. /**
  245. * @brief Get field file_crc from component_metadata message
  246. *
  247. * @return CRC32 of the general metadata file.
  248. */
  249. static inline uint32_t mavlink_msg_component_metadata_get_file_crc(const mavlink_message_t* msg)
  250. {
  251. return _MAV_RETURN_uint32_t(msg, 4);
  252. }
  253. /**
  254. * @brief Get field uri from component_metadata message
  255. *
  256. * @return MAVLink FTP URI for the general metadata file (COMP_METADATA_TYPE_GENERAL), which may be compressed with xz. The file contains general component metadata, and may contain URI links for additional metadata (see COMP_METADATA_TYPE). The information is static from boot, and may be generated at compile time. The string needs to be zero terminated.
  257. */
  258. static inline uint16_t mavlink_msg_component_metadata_get_uri(const mavlink_message_t* msg, char *uri)
  259. {
  260. return _MAV_RETURN_char_array(msg, uri, 100, 8);
  261. }
  262. /**
  263. * @brief Decode a component_metadata message into a struct
  264. *
  265. * @param msg The message to decode
  266. * @param component_metadata C-struct to decode the message contents into
  267. */
  268. static inline void mavlink_msg_component_metadata_decode(const mavlink_message_t* msg, mavlink_component_metadata_t* component_metadata)
  269. {
  270. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  271. component_metadata->time_boot_ms = mavlink_msg_component_metadata_get_time_boot_ms(msg);
  272. component_metadata->file_crc = mavlink_msg_component_metadata_get_file_crc(msg);
  273. mavlink_msg_component_metadata_get_uri(msg, component_metadata->uri);
  274. #else
  275. uint8_t len = msg->len < MAVLINK_MSG_ID_COMPONENT_METADATA_LEN? msg->len : MAVLINK_MSG_ID_COMPONENT_METADATA_LEN;
  276. memset(component_metadata, 0, MAVLINK_MSG_ID_COMPONENT_METADATA_LEN);
  277. memcpy(component_metadata, _MAV_PAYLOAD(msg), len);
  278. #endif
  279. }