mavlink_msg_collision.h 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363
  1. #pragma once
  2. // MESSAGE COLLISION PACKING
  3. #define MAVLINK_MSG_ID_COLLISION 247
  4. typedef struct __mavlink_collision_t {
  5. uint32_t id; /*< Unique identifier, domain based on src field*/
  6. float time_to_minimum_delta; /*< [s] Estimated time until collision occurs*/
  7. float altitude_minimum_delta; /*< [m] Closest vertical distance between vehicle and object*/
  8. float horizontal_minimum_delta; /*< [m] Closest horizontal distance between vehicle and object*/
  9. uint8_t src; /*< Collision data source*/
  10. uint8_t action; /*< Action that is being taken to avoid this collision*/
  11. uint8_t threat_level; /*< How concerned the aircraft is about this collision*/
  12. } mavlink_collision_t;
  13. #define MAVLINK_MSG_ID_COLLISION_LEN 19
  14. #define MAVLINK_MSG_ID_COLLISION_MIN_LEN 19
  15. #define MAVLINK_MSG_ID_247_LEN 19
  16. #define MAVLINK_MSG_ID_247_MIN_LEN 19
  17. #define MAVLINK_MSG_ID_COLLISION_CRC 81
  18. #define MAVLINK_MSG_ID_247_CRC 81
  19. #if MAVLINK_COMMAND_24BIT
  20. #define MAVLINK_MESSAGE_INFO_COLLISION { \
  21. 247, \
  22. "COLLISION", \
  23. 7, \
  24. { { "src", NULL, MAVLINK_TYPE_UINT8_T, 0, 16, offsetof(mavlink_collision_t, src) }, \
  25. { "id", NULL, MAVLINK_TYPE_UINT32_T, 0, 0, offsetof(mavlink_collision_t, id) }, \
  26. { "action", NULL, MAVLINK_TYPE_UINT8_T, 0, 17, offsetof(mavlink_collision_t, action) }, \
  27. { "threat_level", NULL, MAVLINK_TYPE_UINT8_T, 0, 18, offsetof(mavlink_collision_t, threat_level) }, \
  28. { "time_to_minimum_delta", NULL, MAVLINK_TYPE_FLOAT, 0, 4, offsetof(mavlink_collision_t, time_to_minimum_delta) }, \
  29. { "altitude_minimum_delta", NULL, MAVLINK_TYPE_FLOAT, 0, 8, offsetof(mavlink_collision_t, altitude_minimum_delta) }, \
  30. { "horizontal_minimum_delta", NULL, MAVLINK_TYPE_FLOAT, 0, 12, offsetof(mavlink_collision_t, horizontal_minimum_delta) }, \
  31. } \
  32. }
  33. #else
  34. #define MAVLINK_MESSAGE_INFO_COLLISION { \
  35. "COLLISION", \
  36. 7, \
  37. { { "src", NULL, MAVLINK_TYPE_UINT8_T, 0, 16, offsetof(mavlink_collision_t, src) }, \
  38. { "id", NULL, MAVLINK_TYPE_UINT32_T, 0, 0, offsetof(mavlink_collision_t, id) }, \
  39. { "action", NULL, MAVLINK_TYPE_UINT8_T, 0, 17, offsetof(mavlink_collision_t, action) }, \
  40. { "threat_level", NULL, MAVLINK_TYPE_UINT8_T, 0, 18, offsetof(mavlink_collision_t, threat_level) }, \
  41. { "time_to_minimum_delta", NULL, MAVLINK_TYPE_FLOAT, 0, 4, offsetof(mavlink_collision_t, time_to_minimum_delta) }, \
  42. { "altitude_minimum_delta", NULL, MAVLINK_TYPE_FLOAT, 0, 8, offsetof(mavlink_collision_t, altitude_minimum_delta) }, \
  43. { "horizontal_minimum_delta", NULL, MAVLINK_TYPE_FLOAT, 0, 12, offsetof(mavlink_collision_t, horizontal_minimum_delta) }, \
  44. } \
  45. }
  46. #endif
  47. /**
  48. * @brief Pack a collision message
  49. * @param system_id ID of this system
  50. * @param component_id ID of this component (e.g. 200 for IMU)
  51. * @param msg The MAVLink message to compress the data into
  52. *
  53. * @param src Collision data source
  54. * @param id Unique identifier, domain based on src field
  55. * @param action Action that is being taken to avoid this collision
  56. * @param threat_level How concerned the aircraft is about this collision
  57. * @param time_to_minimum_delta [s] Estimated time until collision occurs
  58. * @param altitude_minimum_delta [m] Closest vertical distance between vehicle and object
  59. * @param horizontal_minimum_delta [m] Closest horizontal distance between vehicle and object
  60. * @return length of the message in bytes (excluding serial stream start sign)
  61. */
  62. static inline uint16_t mavlink_msg_collision_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
  63. uint8_t src, uint32_t id, uint8_t action, uint8_t threat_level, float time_to_minimum_delta, float altitude_minimum_delta, float horizontal_minimum_delta)
  64. {
  65. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  66. char buf[MAVLINK_MSG_ID_COLLISION_LEN];
  67. _mav_put_uint32_t(buf, 0, id);
  68. _mav_put_float(buf, 4, time_to_minimum_delta);
  69. _mav_put_float(buf, 8, altitude_minimum_delta);
  70. _mav_put_float(buf, 12, horizontal_minimum_delta);
  71. _mav_put_uint8_t(buf, 16, src);
  72. _mav_put_uint8_t(buf, 17, action);
  73. _mav_put_uint8_t(buf, 18, threat_level);
  74. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_COLLISION_LEN);
  75. #else
  76. mavlink_collision_t packet;
  77. packet.id = id;
  78. packet.time_to_minimum_delta = time_to_minimum_delta;
  79. packet.altitude_minimum_delta = altitude_minimum_delta;
  80. packet.horizontal_minimum_delta = horizontal_minimum_delta;
  81. packet.src = src;
  82. packet.action = action;
  83. packet.threat_level = threat_level;
  84. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_COLLISION_LEN);
  85. #endif
  86. msg->msgid = MAVLINK_MSG_ID_COLLISION;
  87. return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_COLLISION_MIN_LEN, MAVLINK_MSG_ID_COLLISION_LEN, MAVLINK_MSG_ID_COLLISION_CRC);
  88. }
  89. /**
  90. * @brief Pack a collision 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 src Collision data source
  96. * @param id Unique identifier, domain based on src field
  97. * @param action Action that is being taken to avoid this collision
  98. * @param threat_level How concerned the aircraft is about this collision
  99. * @param time_to_minimum_delta [s] Estimated time until collision occurs
  100. * @param altitude_minimum_delta [m] Closest vertical distance between vehicle and object
  101. * @param horizontal_minimum_delta [m] Closest horizontal distance between vehicle and object
  102. * @return length of the message in bytes (excluding serial stream start sign)
  103. */
  104. static inline uint16_t mavlink_msg_collision_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
  105. mavlink_message_t* msg,
  106. uint8_t src,uint32_t id,uint8_t action,uint8_t threat_level,float time_to_minimum_delta,float altitude_minimum_delta,float horizontal_minimum_delta)
  107. {
  108. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  109. char buf[MAVLINK_MSG_ID_COLLISION_LEN];
  110. _mav_put_uint32_t(buf, 0, id);
  111. _mav_put_float(buf, 4, time_to_minimum_delta);
  112. _mav_put_float(buf, 8, altitude_minimum_delta);
  113. _mav_put_float(buf, 12, horizontal_minimum_delta);
  114. _mav_put_uint8_t(buf, 16, src);
  115. _mav_put_uint8_t(buf, 17, action);
  116. _mav_put_uint8_t(buf, 18, threat_level);
  117. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_COLLISION_LEN);
  118. #else
  119. mavlink_collision_t packet;
  120. packet.id = id;
  121. packet.time_to_minimum_delta = time_to_minimum_delta;
  122. packet.altitude_minimum_delta = altitude_minimum_delta;
  123. packet.horizontal_minimum_delta = horizontal_minimum_delta;
  124. packet.src = src;
  125. packet.action = action;
  126. packet.threat_level = threat_level;
  127. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_COLLISION_LEN);
  128. #endif
  129. msg->msgid = MAVLINK_MSG_ID_COLLISION;
  130. return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_COLLISION_MIN_LEN, MAVLINK_MSG_ID_COLLISION_LEN, MAVLINK_MSG_ID_COLLISION_CRC);
  131. }
  132. /**
  133. * @brief Encode a collision 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 collision C-struct to read the message contents from
  139. */
  140. static inline uint16_t mavlink_msg_collision_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_collision_t* collision)
  141. {
  142. return mavlink_msg_collision_pack(system_id, component_id, msg, collision->src, collision->id, collision->action, collision->threat_level, collision->time_to_minimum_delta, collision->altitude_minimum_delta, collision->horizontal_minimum_delta);
  143. }
  144. /**
  145. * @brief Encode a collision 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 collision C-struct to read the message contents from
  152. */
  153. static inline uint16_t mavlink_msg_collision_encode_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const mavlink_collision_t* collision)
  154. {
  155. return mavlink_msg_collision_pack_chan(system_id, component_id, chan, msg, collision->src, collision->id, collision->action, collision->threat_level, collision->time_to_minimum_delta, collision->altitude_minimum_delta, collision->horizontal_minimum_delta);
  156. }
  157. /**
  158. * @brief Send a collision message
  159. * @param chan MAVLink channel to send the message
  160. *
  161. * @param src Collision data source
  162. * @param id Unique identifier, domain based on src field
  163. * @param action Action that is being taken to avoid this collision
  164. * @param threat_level How concerned the aircraft is about this collision
  165. * @param time_to_minimum_delta [s] Estimated time until collision occurs
  166. * @param altitude_minimum_delta [m] Closest vertical distance between vehicle and object
  167. * @param horizontal_minimum_delta [m] Closest horizontal distance between vehicle and object
  168. */
  169. #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
  170. static inline void mavlink_msg_collision_send(mavlink_channel_t chan, uint8_t src, uint32_t id, uint8_t action, uint8_t threat_level, float time_to_minimum_delta, float altitude_minimum_delta, float horizontal_minimum_delta)
  171. {
  172. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  173. char buf[MAVLINK_MSG_ID_COLLISION_LEN];
  174. _mav_put_uint32_t(buf, 0, id);
  175. _mav_put_float(buf, 4, time_to_minimum_delta);
  176. _mav_put_float(buf, 8, altitude_minimum_delta);
  177. _mav_put_float(buf, 12, horizontal_minimum_delta);
  178. _mav_put_uint8_t(buf, 16, src);
  179. _mav_put_uint8_t(buf, 17, action);
  180. _mav_put_uint8_t(buf, 18, threat_level);
  181. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_COLLISION, buf, MAVLINK_MSG_ID_COLLISION_MIN_LEN, MAVLINK_MSG_ID_COLLISION_LEN, MAVLINK_MSG_ID_COLLISION_CRC);
  182. #else
  183. mavlink_collision_t packet;
  184. packet.id = id;
  185. packet.time_to_minimum_delta = time_to_minimum_delta;
  186. packet.altitude_minimum_delta = altitude_minimum_delta;
  187. packet.horizontal_minimum_delta = horizontal_minimum_delta;
  188. packet.src = src;
  189. packet.action = action;
  190. packet.threat_level = threat_level;
  191. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_COLLISION, (const char *)&packet, MAVLINK_MSG_ID_COLLISION_MIN_LEN, MAVLINK_MSG_ID_COLLISION_LEN, MAVLINK_MSG_ID_COLLISION_CRC);
  192. #endif
  193. }
  194. /**
  195. * @brief Send a collision message
  196. * @param chan MAVLink channel to send the message
  197. * @param struct The MAVLink struct to serialize
  198. */
  199. static inline void mavlink_msg_collision_send_struct(mavlink_channel_t chan, const mavlink_collision_t* collision)
  200. {
  201. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  202. mavlink_msg_collision_send(chan, collision->src, collision->id, collision->action, collision->threat_level, collision->time_to_minimum_delta, collision->altitude_minimum_delta, collision->horizontal_minimum_delta);
  203. #else
  204. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_COLLISION, (const char *)collision, MAVLINK_MSG_ID_COLLISION_MIN_LEN, MAVLINK_MSG_ID_COLLISION_LEN, MAVLINK_MSG_ID_COLLISION_CRC);
  205. #endif
  206. }
  207. #if MAVLINK_MSG_ID_COLLISION_LEN <= MAVLINK_MAX_PAYLOAD_LEN
  208. /*
  209. This variant of _send() can be used to save stack space by re-using
  210. memory from the receive buffer. The caller provides a
  211. mavlink_message_t which is the size of a full mavlink message. This
  212. is usually the receive buffer for the channel, and allows a reply to an
  213. incoming message with minimum stack space usage.
  214. */
  215. static inline void mavlink_msg_collision_send_buf(mavlink_message_t *msgbuf, mavlink_channel_t chan, uint8_t src, uint32_t id, uint8_t action, uint8_t threat_level, float time_to_minimum_delta, float altitude_minimum_delta, float horizontal_minimum_delta)
  216. {
  217. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  218. char *buf = (char *)msgbuf;
  219. _mav_put_uint32_t(buf, 0, id);
  220. _mav_put_float(buf, 4, time_to_minimum_delta);
  221. _mav_put_float(buf, 8, altitude_minimum_delta);
  222. _mav_put_float(buf, 12, horizontal_minimum_delta);
  223. _mav_put_uint8_t(buf, 16, src);
  224. _mav_put_uint8_t(buf, 17, action);
  225. _mav_put_uint8_t(buf, 18, threat_level);
  226. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_COLLISION, buf, MAVLINK_MSG_ID_COLLISION_MIN_LEN, MAVLINK_MSG_ID_COLLISION_LEN, MAVLINK_MSG_ID_COLLISION_CRC);
  227. #else
  228. mavlink_collision_t *packet = (mavlink_collision_t *)msgbuf;
  229. packet->id = id;
  230. packet->time_to_minimum_delta = time_to_minimum_delta;
  231. packet->altitude_minimum_delta = altitude_minimum_delta;
  232. packet->horizontal_minimum_delta = horizontal_minimum_delta;
  233. packet->src = src;
  234. packet->action = action;
  235. packet->threat_level = threat_level;
  236. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_COLLISION, (const char *)packet, MAVLINK_MSG_ID_COLLISION_MIN_LEN, MAVLINK_MSG_ID_COLLISION_LEN, MAVLINK_MSG_ID_COLLISION_CRC);
  237. #endif
  238. }
  239. #endif
  240. #endif
  241. // MESSAGE COLLISION UNPACKING
  242. /**
  243. * @brief Get field src from collision message
  244. *
  245. * @return Collision data source
  246. */
  247. static inline uint8_t mavlink_msg_collision_get_src(const mavlink_message_t* msg)
  248. {
  249. return _MAV_RETURN_uint8_t(msg, 16);
  250. }
  251. /**
  252. * @brief Get field id from collision message
  253. *
  254. * @return Unique identifier, domain based on src field
  255. */
  256. static inline uint32_t mavlink_msg_collision_get_id(const mavlink_message_t* msg)
  257. {
  258. return _MAV_RETURN_uint32_t(msg, 0);
  259. }
  260. /**
  261. * @brief Get field action from collision message
  262. *
  263. * @return Action that is being taken to avoid this collision
  264. */
  265. static inline uint8_t mavlink_msg_collision_get_action(const mavlink_message_t* msg)
  266. {
  267. return _MAV_RETURN_uint8_t(msg, 17);
  268. }
  269. /**
  270. * @brief Get field threat_level from collision message
  271. *
  272. * @return How concerned the aircraft is about this collision
  273. */
  274. static inline uint8_t mavlink_msg_collision_get_threat_level(const mavlink_message_t* msg)
  275. {
  276. return _MAV_RETURN_uint8_t(msg, 18);
  277. }
  278. /**
  279. * @brief Get field time_to_minimum_delta from collision message
  280. *
  281. * @return [s] Estimated time until collision occurs
  282. */
  283. static inline float mavlink_msg_collision_get_time_to_minimum_delta(const mavlink_message_t* msg)
  284. {
  285. return _MAV_RETURN_float(msg, 4);
  286. }
  287. /**
  288. * @brief Get field altitude_minimum_delta from collision message
  289. *
  290. * @return [m] Closest vertical distance between vehicle and object
  291. */
  292. static inline float mavlink_msg_collision_get_altitude_minimum_delta(const mavlink_message_t* msg)
  293. {
  294. return _MAV_RETURN_float(msg, 8);
  295. }
  296. /**
  297. * @brief Get field horizontal_minimum_delta from collision message
  298. *
  299. * @return [m] Closest horizontal distance between vehicle and object
  300. */
  301. static inline float mavlink_msg_collision_get_horizontal_minimum_delta(const mavlink_message_t* msg)
  302. {
  303. return _MAV_RETURN_float(msg, 12);
  304. }
  305. /**
  306. * @brief Decode a collision message into a struct
  307. *
  308. * @param msg The message to decode
  309. * @param collision C-struct to decode the message contents into
  310. */
  311. static inline void mavlink_msg_collision_decode(const mavlink_message_t* msg, mavlink_collision_t* collision)
  312. {
  313. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  314. collision->id = mavlink_msg_collision_get_id(msg);
  315. collision->time_to_minimum_delta = mavlink_msg_collision_get_time_to_minimum_delta(msg);
  316. collision->altitude_minimum_delta = mavlink_msg_collision_get_altitude_minimum_delta(msg);
  317. collision->horizontal_minimum_delta = mavlink_msg_collision_get_horizontal_minimum_delta(msg);
  318. collision->src = mavlink_msg_collision_get_src(msg);
  319. collision->action = mavlink_msg_collision_get_action(msg);
  320. collision->threat_level = mavlink_msg_collision_get_threat_level(msg);
  321. #else
  322. uint8_t len = msg->len < MAVLINK_MSG_ID_COLLISION_LEN? msg->len : MAVLINK_MSG_ID_COLLISION_LEN;
  323. memset(collision, 0, MAVLINK_MSG_ID_COLLISION_LEN);
  324. memcpy(collision, _MAV_PAYLOAD(msg), len);
  325. #endif
  326. }