mavlink_msg_uavcan_node_status.h 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338
  1. #pragma once
  2. // MESSAGE UAVCAN_NODE_STATUS PACKING
  3. #define MAVLINK_MSG_ID_UAVCAN_NODE_STATUS 310
  4. typedef struct __mavlink_uavcan_node_status_t {
  5. uint64_t time_usec; /*< [us] Timestamp (UNIX Epoch time or time since system boot). The receiving end can infer timestamp format (since 1.1.1970 or since system boot) by checking for the magnitude of the number.*/
  6. uint32_t uptime_sec; /*< [s] Time since the start-up of the node.*/
  7. uint16_t vendor_specific_status_code; /*< Vendor-specific status information.*/
  8. uint8_t health; /*< Generalized node health status.*/
  9. uint8_t mode; /*< Generalized operating mode.*/
  10. uint8_t sub_mode; /*< Not used currently.*/
  11. } mavlink_uavcan_node_status_t;
  12. #define MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_LEN 17
  13. #define MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_MIN_LEN 17
  14. #define MAVLINK_MSG_ID_310_LEN 17
  15. #define MAVLINK_MSG_ID_310_MIN_LEN 17
  16. #define MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_CRC 28
  17. #define MAVLINK_MSG_ID_310_CRC 28
  18. #if MAVLINK_COMMAND_24BIT
  19. #define MAVLINK_MESSAGE_INFO_UAVCAN_NODE_STATUS { \
  20. 310, \
  21. "UAVCAN_NODE_STATUS", \
  22. 6, \
  23. { { "time_usec", NULL, MAVLINK_TYPE_UINT64_T, 0, 0, offsetof(mavlink_uavcan_node_status_t, time_usec) }, \
  24. { "uptime_sec", NULL, MAVLINK_TYPE_UINT32_T, 0, 8, offsetof(mavlink_uavcan_node_status_t, uptime_sec) }, \
  25. { "health", NULL, MAVLINK_TYPE_UINT8_T, 0, 14, offsetof(mavlink_uavcan_node_status_t, health) }, \
  26. { "mode", NULL, MAVLINK_TYPE_UINT8_T, 0, 15, offsetof(mavlink_uavcan_node_status_t, mode) }, \
  27. { "sub_mode", NULL, MAVLINK_TYPE_UINT8_T, 0, 16, offsetof(mavlink_uavcan_node_status_t, sub_mode) }, \
  28. { "vendor_specific_status_code", NULL, MAVLINK_TYPE_UINT16_T, 0, 12, offsetof(mavlink_uavcan_node_status_t, vendor_specific_status_code) }, \
  29. } \
  30. }
  31. #else
  32. #define MAVLINK_MESSAGE_INFO_UAVCAN_NODE_STATUS { \
  33. "UAVCAN_NODE_STATUS", \
  34. 6, \
  35. { { "time_usec", NULL, MAVLINK_TYPE_UINT64_T, 0, 0, offsetof(mavlink_uavcan_node_status_t, time_usec) }, \
  36. { "uptime_sec", NULL, MAVLINK_TYPE_UINT32_T, 0, 8, offsetof(mavlink_uavcan_node_status_t, uptime_sec) }, \
  37. { "health", NULL, MAVLINK_TYPE_UINT8_T, 0, 14, offsetof(mavlink_uavcan_node_status_t, health) }, \
  38. { "mode", NULL, MAVLINK_TYPE_UINT8_T, 0, 15, offsetof(mavlink_uavcan_node_status_t, mode) }, \
  39. { "sub_mode", NULL, MAVLINK_TYPE_UINT8_T, 0, 16, offsetof(mavlink_uavcan_node_status_t, sub_mode) }, \
  40. { "vendor_specific_status_code", NULL, MAVLINK_TYPE_UINT16_T, 0, 12, offsetof(mavlink_uavcan_node_status_t, vendor_specific_status_code) }, \
  41. } \
  42. }
  43. #endif
  44. /**
  45. * @brief Pack a uavcan_node_status message
  46. * @param system_id ID of this system
  47. * @param component_id ID of this component (e.g. 200 for IMU)
  48. * @param msg The MAVLink message to compress the data into
  49. *
  50. * @param time_usec [us] Timestamp (UNIX Epoch time or time since system boot). The receiving end can infer timestamp format (since 1.1.1970 or since system boot) by checking for the magnitude of the number.
  51. * @param uptime_sec [s] Time since the start-up of the node.
  52. * @param health Generalized node health status.
  53. * @param mode Generalized operating mode.
  54. * @param sub_mode Not used currently.
  55. * @param vendor_specific_status_code Vendor-specific status information.
  56. * @return length of the message in bytes (excluding serial stream start sign)
  57. */
  58. static inline uint16_t mavlink_msg_uavcan_node_status_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
  59. uint64_t time_usec, uint32_t uptime_sec, uint8_t health, uint8_t mode, uint8_t sub_mode, uint16_t vendor_specific_status_code)
  60. {
  61. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  62. char buf[MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_LEN];
  63. _mav_put_uint64_t(buf, 0, time_usec);
  64. _mav_put_uint32_t(buf, 8, uptime_sec);
  65. _mav_put_uint16_t(buf, 12, vendor_specific_status_code);
  66. _mav_put_uint8_t(buf, 14, health);
  67. _mav_put_uint8_t(buf, 15, mode);
  68. _mav_put_uint8_t(buf, 16, sub_mode);
  69. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_LEN);
  70. #else
  71. mavlink_uavcan_node_status_t packet;
  72. packet.time_usec = time_usec;
  73. packet.uptime_sec = uptime_sec;
  74. packet.vendor_specific_status_code = vendor_specific_status_code;
  75. packet.health = health;
  76. packet.mode = mode;
  77. packet.sub_mode = sub_mode;
  78. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_LEN);
  79. #endif
  80. msg->msgid = MAVLINK_MSG_ID_UAVCAN_NODE_STATUS;
  81. return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_MIN_LEN, MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_LEN, MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_CRC);
  82. }
  83. /**
  84. * @brief Pack a uavcan_node_status message on a channel
  85. * @param system_id ID of this system
  86. * @param component_id ID of this component (e.g. 200 for IMU)
  87. * @param chan The MAVLink channel this message will be sent over
  88. * @param msg The MAVLink message to compress the data into
  89. * @param time_usec [us] Timestamp (UNIX Epoch time or time since system boot). The receiving end can infer timestamp format (since 1.1.1970 or since system boot) by checking for the magnitude of the number.
  90. * @param uptime_sec [s] Time since the start-up of the node.
  91. * @param health Generalized node health status.
  92. * @param mode Generalized operating mode.
  93. * @param sub_mode Not used currently.
  94. * @param vendor_specific_status_code Vendor-specific status information.
  95. * @return length of the message in bytes (excluding serial stream start sign)
  96. */
  97. static inline uint16_t mavlink_msg_uavcan_node_status_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
  98. mavlink_message_t* msg,
  99. uint64_t time_usec,uint32_t uptime_sec,uint8_t health,uint8_t mode,uint8_t sub_mode,uint16_t vendor_specific_status_code)
  100. {
  101. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  102. char buf[MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_LEN];
  103. _mav_put_uint64_t(buf, 0, time_usec);
  104. _mav_put_uint32_t(buf, 8, uptime_sec);
  105. _mav_put_uint16_t(buf, 12, vendor_specific_status_code);
  106. _mav_put_uint8_t(buf, 14, health);
  107. _mav_put_uint8_t(buf, 15, mode);
  108. _mav_put_uint8_t(buf, 16, sub_mode);
  109. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_LEN);
  110. #else
  111. mavlink_uavcan_node_status_t packet;
  112. packet.time_usec = time_usec;
  113. packet.uptime_sec = uptime_sec;
  114. packet.vendor_specific_status_code = vendor_specific_status_code;
  115. packet.health = health;
  116. packet.mode = mode;
  117. packet.sub_mode = sub_mode;
  118. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_LEN);
  119. #endif
  120. msg->msgid = MAVLINK_MSG_ID_UAVCAN_NODE_STATUS;
  121. return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_MIN_LEN, MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_LEN, MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_CRC);
  122. }
  123. /**
  124. * @brief Encode a uavcan_node_status struct
  125. *
  126. * @param system_id ID of this system
  127. * @param component_id ID of this component (e.g. 200 for IMU)
  128. * @param msg The MAVLink message to compress the data into
  129. * @param uavcan_node_status C-struct to read the message contents from
  130. */
  131. static inline uint16_t mavlink_msg_uavcan_node_status_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_uavcan_node_status_t* uavcan_node_status)
  132. {
  133. return mavlink_msg_uavcan_node_status_pack(system_id, component_id, msg, uavcan_node_status->time_usec, uavcan_node_status->uptime_sec, uavcan_node_status->health, uavcan_node_status->mode, uavcan_node_status->sub_mode, uavcan_node_status->vendor_specific_status_code);
  134. }
  135. /**
  136. * @brief Encode a uavcan_node_status struct on a channel
  137. *
  138. * @param system_id ID of this system
  139. * @param component_id ID of this component (e.g. 200 for IMU)
  140. * @param chan The MAVLink channel this message will be sent over
  141. * @param msg The MAVLink message to compress the data into
  142. * @param uavcan_node_status C-struct to read the message contents from
  143. */
  144. static inline uint16_t mavlink_msg_uavcan_node_status_encode_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const mavlink_uavcan_node_status_t* uavcan_node_status)
  145. {
  146. return mavlink_msg_uavcan_node_status_pack_chan(system_id, component_id, chan, msg, uavcan_node_status->time_usec, uavcan_node_status->uptime_sec, uavcan_node_status->health, uavcan_node_status->mode, uavcan_node_status->sub_mode, uavcan_node_status->vendor_specific_status_code);
  147. }
  148. /**
  149. * @brief Send a uavcan_node_status message
  150. * @param chan MAVLink channel to send the message
  151. *
  152. * @param time_usec [us] Timestamp (UNIX Epoch time or time since system boot). The receiving end can infer timestamp format (since 1.1.1970 or since system boot) by checking for the magnitude of the number.
  153. * @param uptime_sec [s] Time since the start-up of the node.
  154. * @param health Generalized node health status.
  155. * @param mode Generalized operating mode.
  156. * @param sub_mode Not used currently.
  157. * @param vendor_specific_status_code Vendor-specific status information.
  158. */
  159. #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
  160. static inline void mavlink_msg_uavcan_node_status_send(mavlink_channel_t chan, uint64_t time_usec, uint32_t uptime_sec, uint8_t health, uint8_t mode, uint8_t sub_mode, uint16_t vendor_specific_status_code)
  161. {
  162. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  163. char buf[MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_LEN];
  164. _mav_put_uint64_t(buf, 0, time_usec);
  165. _mav_put_uint32_t(buf, 8, uptime_sec);
  166. _mav_put_uint16_t(buf, 12, vendor_specific_status_code);
  167. _mav_put_uint8_t(buf, 14, health);
  168. _mav_put_uint8_t(buf, 15, mode);
  169. _mav_put_uint8_t(buf, 16, sub_mode);
  170. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_UAVCAN_NODE_STATUS, buf, MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_MIN_LEN, MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_LEN, MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_CRC);
  171. #else
  172. mavlink_uavcan_node_status_t packet;
  173. packet.time_usec = time_usec;
  174. packet.uptime_sec = uptime_sec;
  175. packet.vendor_specific_status_code = vendor_specific_status_code;
  176. packet.health = health;
  177. packet.mode = mode;
  178. packet.sub_mode = sub_mode;
  179. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_UAVCAN_NODE_STATUS, (const char *)&packet, MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_MIN_LEN, MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_LEN, MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_CRC);
  180. #endif
  181. }
  182. /**
  183. * @brief Send a uavcan_node_status message
  184. * @param chan MAVLink channel to send the message
  185. * @param struct The MAVLink struct to serialize
  186. */
  187. static inline void mavlink_msg_uavcan_node_status_send_struct(mavlink_channel_t chan, const mavlink_uavcan_node_status_t* uavcan_node_status)
  188. {
  189. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  190. mavlink_msg_uavcan_node_status_send(chan, uavcan_node_status->time_usec, uavcan_node_status->uptime_sec, uavcan_node_status->health, uavcan_node_status->mode, uavcan_node_status->sub_mode, uavcan_node_status->vendor_specific_status_code);
  191. #else
  192. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_UAVCAN_NODE_STATUS, (const char *)uavcan_node_status, MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_MIN_LEN, MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_LEN, MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_CRC);
  193. #endif
  194. }
  195. #if MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_LEN <= MAVLINK_MAX_PAYLOAD_LEN
  196. /*
  197. This variant of _send() can be used to save stack space by re-using
  198. memory from the receive buffer. The caller provides a
  199. mavlink_message_t which is the size of a full mavlink message. This
  200. is usually the receive buffer for the channel, and allows a reply to an
  201. incoming message with minimum stack space usage.
  202. */
  203. static inline void mavlink_msg_uavcan_node_status_send_buf(mavlink_message_t *msgbuf, mavlink_channel_t chan, uint64_t time_usec, uint32_t uptime_sec, uint8_t health, uint8_t mode, uint8_t sub_mode, uint16_t vendor_specific_status_code)
  204. {
  205. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  206. char *buf = (char *)msgbuf;
  207. _mav_put_uint64_t(buf, 0, time_usec);
  208. _mav_put_uint32_t(buf, 8, uptime_sec);
  209. _mav_put_uint16_t(buf, 12, vendor_specific_status_code);
  210. _mav_put_uint8_t(buf, 14, health);
  211. _mav_put_uint8_t(buf, 15, mode);
  212. _mav_put_uint8_t(buf, 16, sub_mode);
  213. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_UAVCAN_NODE_STATUS, buf, MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_MIN_LEN, MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_LEN, MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_CRC);
  214. #else
  215. mavlink_uavcan_node_status_t *packet = (mavlink_uavcan_node_status_t *)msgbuf;
  216. packet->time_usec = time_usec;
  217. packet->uptime_sec = uptime_sec;
  218. packet->vendor_specific_status_code = vendor_specific_status_code;
  219. packet->health = health;
  220. packet->mode = mode;
  221. packet->sub_mode = sub_mode;
  222. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_UAVCAN_NODE_STATUS, (const char *)packet, MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_MIN_LEN, MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_LEN, MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_CRC);
  223. #endif
  224. }
  225. #endif
  226. #endif
  227. // MESSAGE UAVCAN_NODE_STATUS UNPACKING
  228. /**
  229. * @brief Get field time_usec from uavcan_node_status message
  230. *
  231. * @return [us] Timestamp (UNIX Epoch time or time since system boot). The receiving end can infer timestamp format (since 1.1.1970 or since system boot) by checking for the magnitude of the number.
  232. */
  233. static inline uint64_t mavlink_msg_uavcan_node_status_get_time_usec(const mavlink_message_t* msg)
  234. {
  235. return _MAV_RETURN_uint64_t(msg, 0);
  236. }
  237. /**
  238. * @brief Get field uptime_sec from uavcan_node_status message
  239. *
  240. * @return [s] Time since the start-up of the node.
  241. */
  242. static inline uint32_t mavlink_msg_uavcan_node_status_get_uptime_sec(const mavlink_message_t* msg)
  243. {
  244. return _MAV_RETURN_uint32_t(msg, 8);
  245. }
  246. /**
  247. * @brief Get field health from uavcan_node_status message
  248. *
  249. * @return Generalized node health status.
  250. */
  251. static inline uint8_t mavlink_msg_uavcan_node_status_get_health(const mavlink_message_t* msg)
  252. {
  253. return _MAV_RETURN_uint8_t(msg, 14);
  254. }
  255. /**
  256. * @brief Get field mode from uavcan_node_status message
  257. *
  258. * @return Generalized operating mode.
  259. */
  260. static inline uint8_t mavlink_msg_uavcan_node_status_get_mode(const mavlink_message_t* msg)
  261. {
  262. return _MAV_RETURN_uint8_t(msg, 15);
  263. }
  264. /**
  265. * @brief Get field sub_mode from uavcan_node_status message
  266. *
  267. * @return Not used currently.
  268. */
  269. static inline uint8_t mavlink_msg_uavcan_node_status_get_sub_mode(const mavlink_message_t* msg)
  270. {
  271. return _MAV_RETURN_uint8_t(msg, 16);
  272. }
  273. /**
  274. * @brief Get field vendor_specific_status_code from uavcan_node_status message
  275. *
  276. * @return Vendor-specific status information.
  277. */
  278. static inline uint16_t mavlink_msg_uavcan_node_status_get_vendor_specific_status_code(const mavlink_message_t* msg)
  279. {
  280. return _MAV_RETURN_uint16_t(msg, 12);
  281. }
  282. /**
  283. * @brief Decode a uavcan_node_status message into a struct
  284. *
  285. * @param msg The message to decode
  286. * @param uavcan_node_status C-struct to decode the message contents into
  287. */
  288. static inline void mavlink_msg_uavcan_node_status_decode(const mavlink_message_t* msg, mavlink_uavcan_node_status_t* uavcan_node_status)
  289. {
  290. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  291. uavcan_node_status->time_usec = mavlink_msg_uavcan_node_status_get_time_usec(msg);
  292. uavcan_node_status->uptime_sec = mavlink_msg_uavcan_node_status_get_uptime_sec(msg);
  293. uavcan_node_status->vendor_specific_status_code = mavlink_msg_uavcan_node_status_get_vendor_specific_status_code(msg);
  294. uavcan_node_status->health = mavlink_msg_uavcan_node_status_get_health(msg);
  295. uavcan_node_status->mode = mavlink_msg_uavcan_node_status_get_mode(msg);
  296. uavcan_node_status->sub_mode = mavlink_msg_uavcan_node_status_get_sub_mode(msg);
  297. #else
  298. uint8_t len = msg->len < MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_LEN? msg->len : MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_LEN;
  299. memset(uavcan_node_status, 0, MAVLINK_MSG_ID_UAVCAN_NODE_STATUS_LEN);
  300. memcpy(uavcan_node_status, _MAV_PAYLOAD(msg), len);
  301. #endif
  302. }