mavlink_msg_fence_status.h 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313
  1. #pragma once
  2. // MESSAGE FENCE_STATUS PACKING
  3. #define MAVLINK_MSG_ID_FENCE_STATUS 162
  4. typedef struct __mavlink_fence_status_t {
  5. uint32_t breach_time; /*< [ms] Time (since boot) of last breach.*/
  6. uint16_t breach_count; /*< Number of fence breaches.*/
  7. uint8_t breach_status; /*< Breach status (0 if currently inside fence, 1 if outside).*/
  8. uint8_t breach_type; /*< Last breach type.*/
  9. uint8_t breach_mitigation; /*< Active action to prevent fence breach*/
  10. } mavlink_fence_status_t;
  11. #define MAVLINK_MSG_ID_FENCE_STATUS_LEN 9
  12. #define MAVLINK_MSG_ID_FENCE_STATUS_MIN_LEN 8
  13. #define MAVLINK_MSG_ID_162_LEN 9
  14. #define MAVLINK_MSG_ID_162_MIN_LEN 8
  15. #define MAVLINK_MSG_ID_FENCE_STATUS_CRC 189
  16. #define MAVLINK_MSG_ID_162_CRC 189
  17. #if MAVLINK_COMMAND_24BIT
  18. #define MAVLINK_MESSAGE_INFO_FENCE_STATUS { \
  19. 162, \
  20. "FENCE_STATUS", \
  21. 5, \
  22. { { "breach_status", NULL, MAVLINK_TYPE_UINT8_T, 0, 6, offsetof(mavlink_fence_status_t, breach_status) }, \
  23. { "breach_count", NULL, MAVLINK_TYPE_UINT16_T, 0, 4, offsetof(mavlink_fence_status_t, breach_count) }, \
  24. { "breach_type", NULL, MAVLINK_TYPE_UINT8_T, 0, 7, offsetof(mavlink_fence_status_t, breach_type) }, \
  25. { "breach_time", NULL, MAVLINK_TYPE_UINT32_T, 0, 0, offsetof(mavlink_fence_status_t, breach_time) }, \
  26. { "breach_mitigation", NULL, MAVLINK_TYPE_UINT8_T, 0, 8, offsetof(mavlink_fence_status_t, breach_mitigation) }, \
  27. } \
  28. }
  29. #else
  30. #define MAVLINK_MESSAGE_INFO_FENCE_STATUS { \
  31. "FENCE_STATUS", \
  32. 5, \
  33. { { "breach_status", NULL, MAVLINK_TYPE_UINT8_T, 0, 6, offsetof(mavlink_fence_status_t, breach_status) }, \
  34. { "breach_count", NULL, MAVLINK_TYPE_UINT16_T, 0, 4, offsetof(mavlink_fence_status_t, breach_count) }, \
  35. { "breach_type", NULL, MAVLINK_TYPE_UINT8_T, 0, 7, offsetof(mavlink_fence_status_t, breach_type) }, \
  36. { "breach_time", NULL, MAVLINK_TYPE_UINT32_T, 0, 0, offsetof(mavlink_fence_status_t, breach_time) }, \
  37. { "breach_mitigation", NULL, MAVLINK_TYPE_UINT8_T, 0, 8, offsetof(mavlink_fence_status_t, breach_mitigation) }, \
  38. } \
  39. }
  40. #endif
  41. /**
  42. * @brief Pack a fence_status message
  43. * @param system_id ID of this system
  44. * @param component_id ID of this component (e.g. 200 for IMU)
  45. * @param msg The MAVLink message to compress the data into
  46. *
  47. * @param breach_status Breach status (0 if currently inside fence, 1 if outside).
  48. * @param breach_count Number of fence breaches.
  49. * @param breach_type Last breach type.
  50. * @param breach_time [ms] Time (since boot) of last breach.
  51. * @param breach_mitigation Active action to prevent fence breach
  52. * @return length of the message in bytes (excluding serial stream start sign)
  53. */
  54. static inline uint16_t mavlink_msg_fence_status_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
  55. uint8_t breach_status, uint16_t breach_count, uint8_t breach_type, uint32_t breach_time, uint8_t breach_mitigation)
  56. {
  57. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  58. char buf[MAVLINK_MSG_ID_FENCE_STATUS_LEN];
  59. _mav_put_uint32_t(buf, 0, breach_time);
  60. _mav_put_uint16_t(buf, 4, breach_count);
  61. _mav_put_uint8_t(buf, 6, breach_status);
  62. _mav_put_uint8_t(buf, 7, breach_type);
  63. _mav_put_uint8_t(buf, 8, breach_mitigation);
  64. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_FENCE_STATUS_LEN);
  65. #else
  66. mavlink_fence_status_t packet;
  67. packet.breach_time = breach_time;
  68. packet.breach_count = breach_count;
  69. packet.breach_status = breach_status;
  70. packet.breach_type = breach_type;
  71. packet.breach_mitigation = breach_mitigation;
  72. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_FENCE_STATUS_LEN);
  73. #endif
  74. msg->msgid = MAVLINK_MSG_ID_FENCE_STATUS;
  75. return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_FENCE_STATUS_MIN_LEN, MAVLINK_MSG_ID_FENCE_STATUS_LEN, MAVLINK_MSG_ID_FENCE_STATUS_CRC);
  76. }
  77. /**
  78. * @brief Pack a fence_status message on a channel
  79. * @param system_id ID of this system
  80. * @param component_id ID of this component (e.g. 200 for IMU)
  81. * @param chan The MAVLink channel this message will be sent over
  82. * @param msg The MAVLink message to compress the data into
  83. * @param breach_status Breach status (0 if currently inside fence, 1 if outside).
  84. * @param breach_count Number of fence breaches.
  85. * @param breach_type Last breach type.
  86. * @param breach_time [ms] Time (since boot) of last breach.
  87. * @param breach_mitigation Active action to prevent fence breach
  88. * @return length of the message in bytes (excluding serial stream start sign)
  89. */
  90. static inline uint16_t mavlink_msg_fence_status_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
  91. mavlink_message_t* msg,
  92. uint8_t breach_status,uint16_t breach_count,uint8_t breach_type,uint32_t breach_time,uint8_t breach_mitigation)
  93. {
  94. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  95. char buf[MAVLINK_MSG_ID_FENCE_STATUS_LEN];
  96. _mav_put_uint32_t(buf, 0, breach_time);
  97. _mav_put_uint16_t(buf, 4, breach_count);
  98. _mav_put_uint8_t(buf, 6, breach_status);
  99. _mav_put_uint8_t(buf, 7, breach_type);
  100. _mav_put_uint8_t(buf, 8, breach_mitigation);
  101. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_FENCE_STATUS_LEN);
  102. #else
  103. mavlink_fence_status_t packet;
  104. packet.breach_time = breach_time;
  105. packet.breach_count = breach_count;
  106. packet.breach_status = breach_status;
  107. packet.breach_type = breach_type;
  108. packet.breach_mitigation = breach_mitigation;
  109. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_FENCE_STATUS_LEN);
  110. #endif
  111. msg->msgid = MAVLINK_MSG_ID_FENCE_STATUS;
  112. return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_FENCE_STATUS_MIN_LEN, MAVLINK_MSG_ID_FENCE_STATUS_LEN, MAVLINK_MSG_ID_FENCE_STATUS_CRC);
  113. }
  114. /**
  115. * @brief Encode a fence_status struct
  116. *
  117. * @param system_id ID of this system
  118. * @param component_id ID of this component (e.g. 200 for IMU)
  119. * @param msg The MAVLink message to compress the data into
  120. * @param fence_status C-struct to read the message contents from
  121. */
  122. static inline uint16_t mavlink_msg_fence_status_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_fence_status_t* fence_status)
  123. {
  124. return mavlink_msg_fence_status_pack(system_id, component_id, msg, fence_status->breach_status, fence_status->breach_count, fence_status->breach_type, fence_status->breach_time, fence_status->breach_mitigation);
  125. }
  126. /**
  127. * @brief Encode a fence_status struct on a channel
  128. *
  129. * @param system_id ID of this system
  130. * @param component_id ID of this component (e.g. 200 for IMU)
  131. * @param chan The MAVLink channel this message will be sent over
  132. * @param msg The MAVLink message to compress the data into
  133. * @param fence_status C-struct to read the message contents from
  134. */
  135. static inline uint16_t mavlink_msg_fence_status_encode_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const mavlink_fence_status_t* fence_status)
  136. {
  137. return mavlink_msg_fence_status_pack_chan(system_id, component_id, chan, msg, fence_status->breach_status, fence_status->breach_count, fence_status->breach_type, fence_status->breach_time, fence_status->breach_mitigation);
  138. }
  139. /**
  140. * @brief Send a fence_status message
  141. * @param chan MAVLink channel to send the message
  142. *
  143. * @param breach_status Breach status (0 if currently inside fence, 1 if outside).
  144. * @param breach_count Number of fence breaches.
  145. * @param breach_type Last breach type.
  146. * @param breach_time [ms] Time (since boot) of last breach.
  147. * @param breach_mitigation Active action to prevent fence breach
  148. */
  149. #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
  150. static inline void mavlink_msg_fence_status_send(mavlink_channel_t chan, uint8_t breach_status, uint16_t breach_count, uint8_t breach_type, uint32_t breach_time, uint8_t breach_mitigation)
  151. {
  152. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  153. char buf[MAVLINK_MSG_ID_FENCE_STATUS_LEN];
  154. _mav_put_uint32_t(buf, 0, breach_time);
  155. _mav_put_uint16_t(buf, 4, breach_count);
  156. _mav_put_uint8_t(buf, 6, breach_status);
  157. _mav_put_uint8_t(buf, 7, breach_type);
  158. _mav_put_uint8_t(buf, 8, breach_mitigation);
  159. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_FENCE_STATUS, buf, MAVLINK_MSG_ID_FENCE_STATUS_MIN_LEN, MAVLINK_MSG_ID_FENCE_STATUS_LEN, MAVLINK_MSG_ID_FENCE_STATUS_CRC);
  160. #else
  161. mavlink_fence_status_t packet;
  162. packet.breach_time = breach_time;
  163. packet.breach_count = breach_count;
  164. packet.breach_status = breach_status;
  165. packet.breach_type = breach_type;
  166. packet.breach_mitigation = breach_mitigation;
  167. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_FENCE_STATUS, (const char *)&packet, MAVLINK_MSG_ID_FENCE_STATUS_MIN_LEN, MAVLINK_MSG_ID_FENCE_STATUS_LEN, MAVLINK_MSG_ID_FENCE_STATUS_CRC);
  168. #endif
  169. }
  170. /**
  171. * @brief Send a fence_status message
  172. * @param chan MAVLink channel to send the message
  173. * @param struct The MAVLink struct to serialize
  174. */
  175. static inline void mavlink_msg_fence_status_send_struct(mavlink_channel_t chan, const mavlink_fence_status_t* fence_status)
  176. {
  177. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  178. mavlink_msg_fence_status_send(chan, fence_status->breach_status, fence_status->breach_count, fence_status->breach_type, fence_status->breach_time, fence_status->breach_mitigation);
  179. #else
  180. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_FENCE_STATUS, (const char *)fence_status, MAVLINK_MSG_ID_FENCE_STATUS_MIN_LEN, MAVLINK_MSG_ID_FENCE_STATUS_LEN, MAVLINK_MSG_ID_FENCE_STATUS_CRC);
  181. #endif
  182. }
  183. #if MAVLINK_MSG_ID_FENCE_STATUS_LEN <= MAVLINK_MAX_PAYLOAD_LEN
  184. /*
  185. This variant of _send() can be used to save stack space by re-using
  186. memory from the receive buffer. The caller provides a
  187. mavlink_message_t which is the size of a full mavlink message. This
  188. is usually the receive buffer for the channel, and allows a reply to an
  189. incoming message with minimum stack space usage.
  190. */
  191. static inline void mavlink_msg_fence_status_send_buf(mavlink_message_t *msgbuf, mavlink_channel_t chan, uint8_t breach_status, uint16_t breach_count, uint8_t breach_type, uint32_t breach_time, uint8_t breach_mitigation)
  192. {
  193. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  194. char *buf = (char *)msgbuf;
  195. _mav_put_uint32_t(buf, 0, breach_time);
  196. _mav_put_uint16_t(buf, 4, breach_count);
  197. _mav_put_uint8_t(buf, 6, breach_status);
  198. _mav_put_uint8_t(buf, 7, breach_type);
  199. _mav_put_uint8_t(buf, 8, breach_mitigation);
  200. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_FENCE_STATUS, buf, MAVLINK_MSG_ID_FENCE_STATUS_MIN_LEN, MAVLINK_MSG_ID_FENCE_STATUS_LEN, MAVLINK_MSG_ID_FENCE_STATUS_CRC);
  201. #else
  202. mavlink_fence_status_t *packet = (mavlink_fence_status_t *)msgbuf;
  203. packet->breach_time = breach_time;
  204. packet->breach_count = breach_count;
  205. packet->breach_status = breach_status;
  206. packet->breach_type = breach_type;
  207. packet->breach_mitigation = breach_mitigation;
  208. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_FENCE_STATUS, (const char *)packet, MAVLINK_MSG_ID_FENCE_STATUS_MIN_LEN, MAVLINK_MSG_ID_FENCE_STATUS_LEN, MAVLINK_MSG_ID_FENCE_STATUS_CRC);
  209. #endif
  210. }
  211. #endif
  212. #endif
  213. // MESSAGE FENCE_STATUS UNPACKING
  214. /**
  215. * @brief Get field breach_status from fence_status message
  216. *
  217. * @return Breach status (0 if currently inside fence, 1 if outside).
  218. */
  219. static inline uint8_t mavlink_msg_fence_status_get_breach_status(const mavlink_message_t* msg)
  220. {
  221. return _MAV_RETURN_uint8_t(msg, 6);
  222. }
  223. /**
  224. * @brief Get field breach_count from fence_status message
  225. *
  226. * @return Number of fence breaches.
  227. */
  228. static inline uint16_t mavlink_msg_fence_status_get_breach_count(const mavlink_message_t* msg)
  229. {
  230. return _MAV_RETURN_uint16_t(msg, 4);
  231. }
  232. /**
  233. * @brief Get field breach_type from fence_status message
  234. *
  235. * @return Last breach type.
  236. */
  237. static inline uint8_t mavlink_msg_fence_status_get_breach_type(const mavlink_message_t* msg)
  238. {
  239. return _MAV_RETURN_uint8_t(msg, 7);
  240. }
  241. /**
  242. * @brief Get field breach_time from fence_status message
  243. *
  244. * @return [ms] Time (since boot) of last breach.
  245. */
  246. static inline uint32_t mavlink_msg_fence_status_get_breach_time(const mavlink_message_t* msg)
  247. {
  248. return _MAV_RETURN_uint32_t(msg, 0);
  249. }
  250. /**
  251. * @brief Get field breach_mitigation from fence_status message
  252. *
  253. * @return Active action to prevent fence breach
  254. */
  255. static inline uint8_t mavlink_msg_fence_status_get_breach_mitigation(const mavlink_message_t* msg)
  256. {
  257. return _MAV_RETURN_uint8_t(msg, 8);
  258. }
  259. /**
  260. * @brief Decode a fence_status message into a struct
  261. *
  262. * @param msg The message to decode
  263. * @param fence_status C-struct to decode the message contents into
  264. */
  265. static inline void mavlink_msg_fence_status_decode(const mavlink_message_t* msg, mavlink_fence_status_t* fence_status)
  266. {
  267. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  268. fence_status->breach_time = mavlink_msg_fence_status_get_breach_time(msg);
  269. fence_status->breach_count = mavlink_msg_fence_status_get_breach_count(msg);
  270. fence_status->breach_status = mavlink_msg_fence_status_get_breach_status(msg);
  271. fence_status->breach_type = mavlink_msg_fence_status_get_breach_type(msg);
  272. fence_status->breach_mitigation = mavlink_msg_fence_status_get_breach_mitigation(msg);
  273. #else
  274. uint8_t len = msg->len < MAVLINK_MSG_ID_FENCE_STATUS_LEN? msg->len : MAVLINK_MSG_ID_FENCE_STATUS_LEN;
  275. memset(fence_status, 0, MAVLINK_MSG_ID_FENCE_STATUS_LEN);
  276. memcpy(fence_status, _MAV_PAYLOAD(msg), len);
  277. #endif
  278. }