mavlink_msg_event.h 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355
  1. #pragma once
  2. // MESSAGE EVENT PACKING
  3. #define MAVLINK_MSG_ID_EVENT 410
  4. typedef struct __mavlink_event_t {
  5. uint32_t id; /*< Event ID (as defined in the component metadata)*/
  6. uint32_t event_time_boot_ms; /*< [ms] Timestamp (time since system boot when the event happened).*/
  7. uint16_t sequence; /*< Sequence number.*/
  8. uint8_t destination_component; /*< Component ID*/
  9. uint8_t destination_system; /*< System ID*/
  10. uint8_t log_levels; /*< Log levels: 4 bits MSB: internal (for logging purposes), 4 bits LSB: external. Levels: Emergency = 0, Alert = 1, Critical = 2, Error = 3, Warning = 4, Notice = 5, Info = 6, Debug = 7, Protocol = 8, Disabled = 9*/
  11. uint8_t arguments[40]; /*< Arguments (depend on event ID).*/
  12. } mavlink_event_t;
  13. #define MAVLINK_MSG_ID_EVENT_LEN 53
  14. #define MAVLINK_MSG_ID_EVENT_MIN_LEN 53
  15. #define MAVLINK_MSG_ID_410_LEN 53
  16. #define MAVLINK_MSG_ID_410_MIN_LEN 53
  17. #define MAVLINK_MSG_ID_EVENT_CRC 160
  18. #define MAVLINK_MSG_ID_410_CRC 160
  19. #define MAVLINK_MSG_EVENT_FIELD_ARGUMENTS_LEN 40
  20. #if MAVLINK_COMMAND_24BIT
  21. #define MAVLINK_MESSAGE_INFO_EVENT { \
  22. 410, \
  23. "EVENT", \
  24. 7, \
  25. { { "destination_component", NULL, MAVLINK_TYPE_UINT8_T, 0, 10, offsetof(mavlink_event_t, destination_component) }, \
  26. { "destination_system", NULL, MAVLINK_TYPE_UINT8_T, 0, 11, offsetof(mavlink_event_t, destination_system) }, \
  27. { "id", NULL, MAVLINK_TYPE_UINT32_T, 0, 0, offsetof(mavlink_event_t, id) }, \
  28. { "event_time_boot_ms", NULL, MAVLINK_TYPE_UINT32_T, 0, 4, offsetof(mavlink_event_t, event_time_boot_ms) }, \
  29. { "sequence", NULL, MAVLINK_TYPE_UINT16_T, 0, 8, offsetof(mavlink_event_t, sequence) }, \
  30. { "log_levels", NULL, MAVLINK_TYPE_UINT8_T, 0, 12, offsetof(mavlink_event_t, log_levels) }, \
  31. { "arguments", NULL, MAVLINK_TYPE_UINT8_T, 40, 13, offsetof(mavlink_event_t, arguments) }, \
  32. } \
  33. }
  34. #else
  35. #define MAVLINK_MESSAGE_INFO_EVENT { \
  36. "EVENT", \
  37. 7, \
  38. { { "destination_component", NULL, MAVLINK_TYPE_UINT8_T, 0, 10, offsetof(mavlink_event_t, destination_component) }, \
  39. { "destination_system", NULL, MAVLINK_TYPE_UINT8_T, 0, 11, offsetof(mavlink_event_t, destination_system) }, \
  40. { "id", NULL, MAVLINK_TYPE_UINT32_T, 0, 0, offsetof(mavlink_event_t, id) }, \
  41. { "event_time_boot_ms", NULL, MAVLINK_TYPE_UINT32_T, 0, 4, offsetof(mavlink_event_t, event_time_boot_ms) }, \
  42. { "sequence", NULL, MAVLINK_TYPE_UINT16_T, 0, 8, offsetof(mavlink_event_t, sequence) }, \
  43. { "log_levels", NULL, MAVLINK_TYPE_UINT8_T, 0, 12, offsetof(mavlink_event_t, log_levels) }, \
  44. { "arguments", NULL, MAVLINK_TYPE_UINT8_T, 40, 13, offsetof(mavlink_event_t, arguments) }, \
  45. } \
  46. }
  47. #endif
  48. /**
  49. * @brief Pack a event message
  50. * @param system_id ID of this system
  51. * @param component_id ID of this component (e.g. 200 for IMU)
  52. * @param msg The MAVLink message to compress the data into
  53. *
  54. * @param destination_component Component ID
  55. * @param destination_system System ID
  56. * @param id Event ID (as defined in the component metadata)
  57. * @param event_time_boot_ms [ms] Timestamp (time since system boot when the event happened).
  58. * @param sequence Sequence number.
  59. * @param log_levels Log levels: 4 bits MSB: internal (for logging purposes), 4 bits LSB: external. Levels: Emergency = 0, Alert = 1, Critical = 2, Error = 3, Warning = 4, Notice = 5, Info = 6, Debug = 7, Protocol = 8, Disabled = 9
  60. * @param arguments Arguments (depend on event ID).
  61. * @return length of the message in bytes (excluding serial stream start sign)
  62. */
  63. static inline uint16_t mavlink_msg_event_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
  64. uint8_t destination_component, uint8_t destination_system, uint32_t id, uint32_t event_time_boot_ms, uint16_t sequence, uint8_t log_levels, const uint8_t *arguments)
  65. {
  66. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  67. char buf[MAVLINK_MSG_ID_EVENT_LEN];
  68. _mav_put_uint32_t(buf, 0, id);
  69. _mav_put_uint32_t(buf, 4, event_time_boot_ms);
  70. _mav_put_uint16_t(buf, 8, sequence);
  71. _mav_put_uint8_t(buf, 10, destination_component);
  72. _mav_put_uint8_t(buf, 11, destination_system);
  73. _mav_put_uint8_t(buf, 12, log_levels);
  74. _mav_put_uint8_t_array(buf, 13, arguments, 40);
  75. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_EVENT_LEN);
  76. #else
  77. mavlink_event_t packet;
  78. packet.id = id;
  79. packet.event_time_boot_ms = event_time_boot_ms;
  80. packet.sequence = sequence;
  81. packet.destination_component = destination_component;
  82. packet.destination_system = destination_system;
  83. packet.log_levels = log_levels;
  84. mav_array_memcpy(packet.arguments, arguments, sizeof(uint8_t)*40);
  85. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_EVENT_LEN);
  86. #endif
  87. msg->msgid = MAVLINK_MSG_ID_EVENT;
  88. return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_EVENT_MIN_LEN, MAVLINK_MSG_ID_EVENT_LEN, MAVLINK_MSG_ID_EVENT_CRC);
  89. }
  90. /**
  91. * @brief Pack a event message on a channel
  92. * @param system_id ID of this system
  93. * @param component_id ID of this component (e.g. 200 for IMU)
  94. * @param chan The MAVLink channel this message will be sent over
  95. * @param msg The MAVLink message to compress the data into
  96. * @param destination_component Component ID
  97. * @param destination_system System ID
  98. * @param id Event ID (as defined in the component metadata)
  99. * @param event_time_boot_ms [ms] Timestamp (time since system boot when the event happened).
  100. * @param sequence Sequence number.
  101. * @param log_levels Log levels: 4 bits MSB: internal (for logging purposes), 4 bits LSB: external. Levels: Emergency = 0, Alert = 1, Critical = 2, Error = 3, Warning = 4, Notice = 5, Info = 6, Debug = 7, Protocol = 8, Disabled = 9
  102. * @param arguments Arguments (depend on event ID).
  103. * @return length of the message in bytes (excluding serial stream start sign)
  104. */
  105. static inline uint16_t mavlink_msg_event_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
  106. mavlink_message_t* msg,
  107. uint8_t destination_component,uint8_t destination_system,uint32_t id,uint32_t event_time_boot_ms,uint16_t sequence,uint8_t log_levels,const uint8_t *arguments)
  108. {
  109. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  110. char buf[MAVLINK_MSG_ID_EVENT_LEN];
  111. _mav_put_uint32_t(buf, 0, id);
  112. _mav_put_uint32_t(buf, 4, event_time_boot_ms);
  113. _mav_put_uint16_t(buf, 8, sequence);
  114. _mav_put_uint8_t(buf, 10, destination_component);
  115. _mav_put_uint8_t(buf, 11, destination_system);
  116. _mav_put_uint8_t(buf, 12, log_levels);
  117. _mav_put_uint8_t_array(buf, 13, arguments, 40);
  118. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_EVENT_LEN);
  119. #else
  120. mavlink_event_t packet;
  121. packet.id = id;
  122. packet.event_time_boot_ms = event_time_boot_ms;
  123. packet.sequence = sequence;
  124. packet.destination_component = destination_component;
  125. packet.destination_system = destination_system;
  126. packet.log_levels = log_levels;
  127. mav_array_memcpy(packet.arguments, arguments, sizeof(uint8_t)*40);
  128. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_EVENT_LEN);
  129. #endif
  130. msg->msgid = MAVLINK_MSG_ID_EVENT;
  131. return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_EVENT_MIN_LEN, MAVLINK_MSG_ID_EVENT_LEN, MAVLINK_MSG_ID_EVENT_CRC);
  132. }
  133. /**
  134. * @brief Encode a event struct
  135. *
  136. * @param system_id ID of this system
  137. * @param component_id ID of this component (e.g. 200 for IMU)
  138. * @param msg The MAVLink message to compress the data into
  139. * @param event C-struct to read the message contents from
  140. */
  141. static inline uint16_t mavlink_msg_event_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_event_t* event)
  142. {
  143. return mavlink_msg_event_pack(system_id, component_id, msg, event->destination_component, event->destination_system, event->id, event->event_time_boot_ms, event->sequence, event->log_levels, event->arguments);
  144. }
  145. /**
  146. * @brief Encode a event struct on a channel
  147. *
  148. * @param system_id ID of this system
  149. * @param component_id ID of this component (e.g. 200 for IMU)
  150. * @param chan The MAVLink channel this message will be sent over
  151. * @param msg The MAVLink message to compress the data into
  152. * @param event C-struct to read the message contents from
  153. */
  154. static inline uint16_t mavlink_msg_event_encode_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const mavlink_event_t* event)
  155. {
  156. return mavlink_msg_event_pack_chan(system_id, component_id, chan, msg, event->destination_component, event->destination_system, event->id, event->event_time_boot_ms, event->sequence, event->log_levels, event->arguments);
  157. }
  158. /**
  159. * @brief Send a event message
  160. * @param chan MAVLink channel to send the message
  161. *
  162. * @param destination_component Component ID
  163. * @param destination_system System ID
  164. * @param id Event ID (as defined in the component metadata)
  165. * @param event_time_boot_ms [ms] Timestamp (time since system boot when the event happened).
  166. * @param sequence Sequence number.
  167. * @param log_levels Log levels: 4 bits MSB: internal (for logging purposes), 4 bits LSB: external. Levels: Emergency = 0, Alert = 1, Critical = 2, Error = 3, Warning = 4, Notice = 5, Info = 6, Debug = 7, Protocol = 8, Disabled = 9
  168. * @param arguments Arguments (depend on event ID).
  169. */
  170. #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
  171. static inline void mavlink_msg_event_send(mavlink_channel_t chan, uint8_t destination_component, uint8_t destination_system, uint32_t id, uint32_t event_time_boot_ms, uint16_t sequence, uint8_t log_levels, const uint8_t *arguments)
  172. {
  173. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  174. char buf[MAVLINK_MSG_ID_EVENT_LEN];
  175. _mav_put_uint32_t(buf, 0, id);
  176. _mav_put_uint32_t(buf, 4, event_time_boot_ms);
  177. _mav_put_uint16_t(buf, 8, sequence);
  178. _mav_put_uint8_t(buf, 10, destination_component);
  179. _mav_put_uint8_t(buf, 11, destination_system);
  180. _mav_put_uint8_t(buf, 12, log_levels);
  181. _mav_put_uint8_t_array(buf, 13, arguments, 40);
  182. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_EVENT, buf, MAVLINK_MSG_ID_EVENT_MIN_LEN, MAVLINK_MSG_ID_EVENT_LEN, MAVLINK_MSG_ID_EVENT_CRC);
  183. #else
  184. mavlink_event_t packet;
  185. packet.id = id;
  186. packet.event_time_boot_ms = event_time_boot_ms;
  187. packet.sequence = sequence;
  188. packet.destination_component = destination_component;
  189. packet.destination_system = destination_system;
  190. packet.log_levels = log_levels;
  191. mav_array_memcpy(packet.arguments, arguments, sizeof(uint8_t)*40);
  192. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_EVENT, (const char *)&packet, MAVLINK_MSG_ID_EVENT_MIN_LEN, MAVLINK_MSG_ID_EVENT_LEN, MAVLINK_MSG_ID_EVENT_CRC);
  193. #endif
  194. }
  195. /**
  196. * @brief Send a event 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_event_send_struct(mavlink_channel_t chan, const mavlink_event_t* event)
  201. {
  202. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  203. mavlink_msg_event_send(chan, event->destination_component, event->destination_system, event->id, event->event_time_boot_ms, event->sequence, event->log_levels, event->arguments);
  204. #else
  205. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_EVENT, (const char *)event, MAVLINK_MSG_ID_EVENT_MIN_LEN, MAVLINK_MSG_ID_EVENT_LEN, MAVLINK_MSG_ID_EVENT_CRC);
  206. #endif
  207. }
  208. #if MAVLINK_MSG_ID_EVENT_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_event_send_buf(mavlink_message_t *msgbuf, mavlink_channel_t chan, uint8_t destination_component, uint8_t destination_system, uint32_t id, uint32_t event_time_boot_ms, uint16_t sequence, uint8_t log_levels, const uint8_t *arguments)
  217. {
  218. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  219. char *buf = (char *)msgbuf;
  220. _mav_put_uint32_t(buf, 0, id);
  221. _mav_put_uint32_t(buf, 4, event_time_boot_ms);
  222. _mav_put_uint16_t(buf, 8, sequence);
  223. _mav_put_uint8_t(buf, 10, destination_component);
  224. _mav_put_uint8_t(buf, 11, destination_system);
  225. _mav_put_uint8_t(buf, 12, log_levels);
  226. _mav_put_uint8_t_array(buf, 13, arguments, 40);
  227. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_EVENT, buf, MAVLINK_MSG_ID_EVENT_MIN_LEN, MAVLINK_MSG_ID_EVENT_LEN, MAVLINK_MSG_ID_EVENT_CRC);
  228. #else
  229. mavlink_event_t *packet = (mavlink_event_t *)msgbuf;
  230. packet->id = id;
  231. packet->event_time_boot_ms = event_time_boot_ms;
  232. packet->sequence = sequence;
  233. packet->destination_component = destination_component;
  234. packet->destination_system = destination_system;
  235. packet->log_levels = log_levels;
  236. mav_array_memcpy(packet->arguments, arguments, sizeof(uint8_t)*40);
  237. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_EVENT, (const char *)packet, MAVLINK_MSG_ID_EVENT_MIN_LEN, MAVLINK_MSG_ID_EVENT_LEN, MAVLINK_MSG_ID_EVENT_CRC);
  238. #endif
  239. }
  240. #endif
  241. #endif
  242. // MESSAGE EVENT UNPACKING
  243. /**
  244. * @brief Get field destination_component from event message
  245. *
  246. * @return Component ID
  247. */
  248. static inline uint8_t mavlink_msg_event_get_destination_component(const mavlink_message_t* msg)
  249. {
  250. return _MAV_RETURN_uint8_t(msg, 10);
  251. }
  252. /**
  253. * @brief Get field destination_system from event message
  254. *
  255. * @return System ID
  256. */
  257. static inline uint8_t mavlink_msg_event_get_destination_system(const mavlink_message_t* msg)
  258. {
  259. return _MAV_RETURN_uint8_t(msg, 11);
  260. }
  261. /**
  262. * @brief Get field id from event message
  263. *
  264. * @return Event ID (as defined in the component metadata)
  265. */
  266. static inline uint32_t mavlink_msg_event_get_id(const mavlink_message_t* msg)
  267. {
  268. return _MAV_RETURN_uint32_t(msg, 0);
  269. }
  270. /**
  271. * @brief Get field event_time_boot_ms from event message
  272. *
  273. * @return [ms] Timestamp (time since system boot when the event happened).
  274. */
  275. static inline uint32_t mavlink_msg_event_get_event_time_boot_ms(const mavlink_message_t* msg)
  276. {
  277. return _MAV_RETURN_uint32_t(msg, 4);
  278. }
  279. /**
  280. * @brief Get field sequence from event message
  281. *
  282. * @return Sequence number.
  283. */
  284. static inline uint16_t mavlink_msg_event_get_sequence(const mavlink_message_t* msg)
  285. {
  286. return _MAV_RETURN_uint16_t(msg, 8);
  287. }
  288. /**
  289. * @brief Get field log_levels from event message
  290. *
  291. * @return Log levels: 4 bits MSB: internal (for logging purposes), 4 bits LSB: external. Levels: Emergency = 0, Alert = 1, Critical = 2, Error = 3, Warning = 4, Notice = 5, Info = 6, Debug = 7, Protocol = 8, Disabled = 9
  292. */
  293. static inline uint8_t mavlink_msg_event_get_log_levels(const mavlink_message_t* msg)
  294. {
  295. return _MAV_RETURN_uint8_t(msg, 12);
  296. }
  297. /**
  298. * @brief Get field arguments from event message
  299. *
  300. * @return Arguments (depend on event ID).
  301. */
  302. static inline uint16_t mavlink_msg_event_get_arguments(const mavlink_message_t* msg, uint8_t *arguments)
  303. {
  304. return _MAV_RETURN_uint8_t_array(msg, arguments, 40, 13);
  305. }
  306. /**
  307. * @brief Decode a event message into a struct
  308. *
  309. * @param msg The message to decode
  310. * @param event C-struct to decode the message contents into
  311. */
  312. static inline void mavlink_msg_event_decode(const mavlink_message_t* msg, mavlink_event_t* event)
  313. {
  314. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  315. event->id = mavlink_msg_event_get_id(msg);
  316. event->event_time_boot_ms = mavlink_msg_event_get_event_time_boot_ms(msg);
  317. event->sequence = mavlink_msg_event_get_sequence(msg);
  318. event->destination_component = mavlink_msg_event_get_destination_component(msg);
  319. event->destination_system = mavlink_msg_event_get_destination_system(msg);
  320. event->log_levels = mavlink_msg_event_get_log_levels(msg);
  321. mavlink_msg_event_get_arguments(msg, event->arguments);
  322. #else
  323. uint8_t len = msg->len < MAVLINK_MSG_ID_EVENT_LEN? msg->len : MAVLINK_MSG_ID_EVENT_LEN;
  324. memset(event, 0, MAVLINK_MSG_ID_EVENT_LEN);
  325. memcpy(event, _MAV_PAYLOAD(msg), len);
  326. #endif
  327. }