mavlink_msg_can_frame.h 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390
  1. #pragma once
  2. // MESSAGE CAN_FRAME PACKING
  3. #define MAVLINK_MSG_ID_CAN_FRAME 386
  4. typedef struct __mavlink_can_frame_t {
  5. uint32_t id; /*< Frame ID*/
  6. uint8_t target_system; /*< System ID.*/
  7. uint8_t target_component; /*< Component ID.*/
  8. uint8_t bus; /*< Bus number*/
  9. uint8_t len; /*< Frame length*/
  10. uint8_t data[8]; /*< Frame data*/
  11. } mavlink_can_frame_t;
  12. #define MAVLINK_MSG_ID_CAN_FRAME_LEN 16
  13. #define MAVLINK_MSG_ID_CAN_FRAME_MIN_LEN 16
  14. #define MAVLINK_MSG_ID_386_LEN 16
  15. #define MAVLINK_MSG_ID_386_MIN_LEN 16
  16. #define MAVLINK_MSG_ID_CAN_FRAME_CRC 132
  17. #define MAVLINK_MSG_ID_386_CRC 132
  18. #define MAVLINK_MSG_CAN_FRAME_FIELD_DATA_LEN 8
  19. #if MAVLINK_COMMAND_24BIT
  20. #define MAVLINK_MESSAGE_INFO_CAN_FRAME { \
  21. 386, \
  22. "CAN_FRAME", \
  23. 6, \
  24. { { "target_system", NULL, MAVLINK_TYPE_UINT8_T, 0, 4, offsetof(mavlink_can_frame_t, target_system) }, \
  25. { "target_component", NULL, MAVLINK_TYPE_UINT8_T, 0, 5, offsetof(mavlink_can_frame_t, target_component) }, \
  26. { "bus", NULL, MAVLINK_TYPE_UINT8_T, 0, 6, offsetof(mavlink_can_frame_t, bus) }, \
  27. { "len", NULL, MAVLINK_TYPE_UINT8_T, 0, 7, offsetof(mavlink_can_frame_t, len) }, \
  28. { "id", NULL, MAVLINK_TYPE_UINT32_T, 0, 0, offsetof(mavlink_can_frame_t, id) }, \
  29. { "data", NULL, MAVLINK_TYPE_UINT8_T, 8, 8, offsetof(mavlink_can_frame_t, data) }, \
  30. } \
  31. }
  32. #else
  33. #define MAVLINK_MESSAGE_INFO_CAN_FRAME { \
  34. "CAN_FRAME", \
  35. 6, \
  36. { { "target_system", NULL, MAVLINK_TYPE_UINT8_T, 0, 4, offsetof(mavlink_can_frame_t, target_system) }, \
  37. { "target_component", NULL, MAVLINK_TYPE_UINT8_T, 0, 5, offsetof(mavlink_can_frame_t, target_component) }, \
  38. { "bus", NULL, MAVLINK_TYPE_UINT8_T, 0, 6, offsetof(mavlink_can_frame_t, bus) }, \
  39. { "len", NULL, MAVLINK_TYPE_UINT8_T, 0, 7, offsetof(mavlink_can_frame_t, len) }, \
  40. { "id", NULL, MAVLINK_TYPE_UINT32_T, 0, 0, offsetof(mavlink_can_frame_t, id) }, \
  41. { "data", NULL, MAVLINK_TYPE_UINT8_T, 8, 8, offsetof(mavlink_can_frame_t, data) }, \
  42. } \
  43. }
  44. #endif
  45. /**
  46. * @brief Pack a can_frame message
  47. * @param system_id ID of this system
  48. * @param component_id ID of this component (e.g. 200 for IMU)
  49. * @param msg The MAVLink message to compress the data into
  50. *
  51. * @param target_system System ID.
  52. * @param target_component Component ID.
  53. * @param bus Bus number
  54. * @param len Frame length
  55. * @param id Frame ID
  56. * @param data Frame data
  57. * @return length of the message in bytes (excluding serial stream start sign)
  58. */
  59. static inline uint16_t mavlink_msg_can_frame_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
  60. uint8_t target_system, uint8_t target_component, uint8_t bus, uint8_t len, uint32_t id, const uint8_t *data)
  61. {
  62. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  63. char buf[MAVLINK_MSG_ID_CAN_FRAME_LEN];
  64. _mav_put_uint32_t(buf, 0, id);
  65. _mav_put_uint8_t(buf, 4, target_system);
  66. _mav_put_uint8_t(buf, 5, target_component);
  67. _mav_put_uint8_t(buf, 6, bus);
  68. _mav_put_uint8_t(buf, 7, len);
  69. _mav_put_uint8_t_array(buf, 8, data, 8);
  70. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_CAN_FRAME_LEN);
  71. #else
  72. mavlink_can_frame_t packet;
  73. packet.id = id;
  74. packet.target_system = target_system;
  75. packet.target_component = target_component;
  76. packet.bus = bus;
  77. packet.len = len;
  78. mav_array_memcpy(packet.data, data, sizeof(uint8_t)*8);
  79. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_CAN_FRAME_LEN);
  80. #endif
  81. msg->msgid = MAVLINK_MSG_ID_CAN_FRAME;
  82. return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_CAN_FRAME_MIN_LEN, MAVLINK_MSG_ID_CAN_FRAME_LEN, MAVLINK_MSG_ID_CAN_FRAME_CRC);
  83. }
  84. /**
  85. * @brief Pack a can_frame message
  86. * @param system_id ID of this system
  87. * @param component_id ID of this component (e.g. 200 for IMU)
  88. * @param status MAVLink status structure
  89. * @param msg The MAVLink message to compress the data into
  90. *
  91. * @param target_system System ID.
  92. * @param target_component Component ID.
  93. * @param bus Bus number
  94. * @param len Frame length
  95. * @param id Frame ID
  96. * @param data Frame data
  97. * @return length of the message in bytes (excluding serial stream start sign)
  98. */
  99. static inline uint16_t mavlink_msg_can_frame_pack_status(uint8_t system_id, uint8_t component_id, mavlink_status_t *_status, mavlink_message_t* msg,
  100. uint8_t target_system, uint8_t target_component, uint8_t bus, uint8_t len, uint32_t id, const uint8_t *data)
  101. {
  102. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  103. char buf[MAVLINK_MSG_ID_CAN_FRAME_LEN];
  104. _mav_put_uint32_t(buf, 0, id);
  105. _mav_put_uint8_t(buf, 4, target_system);
  106. _mav_put_uint8_t(buf, 5, target_component);
  107. _mav_put_uint8_t(buf, 6, bus);
  108. _mav_put_uint8_t(buf, 7, len);
  109. _mav_put_uint8_t_array(buf, 8, data, 8);
  110. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_CAN_FRAME_LEN);
  111. #else
  112. mavlink_can_frame_t packet;
  113. packet.id = id;
  114. packet.target_system = target_system;
  115. packet.target_component = target_component;
  116. packet.bus = bus;
  117. packet.len = len;
  118. mav_array_memcpy(packet.data, data, sizeof(uint8_t)*8);
  119. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_CAN_FRAME_LEN);
  120. #endif
  121. msg->msgid = MAVLINK_MSG_ID_CAN_FRAME;
  122. #if MAVLINK_CRC_EXTRA
  123. return mavlink_finalize_message_buffer(msg, system_id, component_id, _status, MAVLINK_MSG_ID_CAN_FRAME_MIN_LEN, MAVLINK_MSG_ID_CAN_FRAME_LEN, MAVLINK_MSG_ID_CAN_FRAME_CRC);
  124. #else
  125. return mavlink_finalize_message_buffer(msg, system_id, component_id, _status, MAVLINK_MSG_ID_CAN_FRAME_MIN_LEN, MAVLINK_MSG_ID_CAN_FRAME_LEN);
  126. #endif
  127. }
  128. /**
  129. * @brief Pack a can_frame message on a channel
  130. * @param system_id ID of this system
  131. * @param component_id ID of this component (e.g. 200 for IMU)
  132. * @param chan The MAVLink channel this message will be sent over
  133. * @param msg The MAVLink message to compress the data into
  134. * @param target_system System ID.
  135. * @param target_component Component ID.
  136. * @param bus Bus number
  137. * @param len Frame length
  138. * @param id Frame ID
  139. * @param data Frame data
  140. * @return length of the message in bytes (excluding serial stream start sign)
  141. */
  142. static inline uint16_t mavlink_msg_can_frame_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
  143. mavlink_message_t* msg,
  144. uint8_t target_system,uint8_t target_component,uint8_t bus,uint8_t len,uint32_t id,const uint8_t *data)
  145. {
  146. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  147. char buf[MAVLINK_MSG_ID_CAN_FRAME_LEN];
  148. _mav_put_uint32_t(buf, 0, id);
  149. _mav_put_uint8_t(buf, 4, target_system);
  150. _mav_put_uint8_t(buf, 5, target_component);
  151. _mav_put_uint8_t(buf, 6, bus);
  152. _mav_put_uint8_t(buf, 7, len);
  153. _mav_put_uint8_t_array(buf, 8, data, 8);
  154. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_CAN_FRAME_LEN);
  155. #else
  156. mavlink_can_frame_t packet;
  157. packet.id = id;
  158. packet.target_system = target_system;
  159. packet.target_component = target_component;
  160. packet.bus = bus;
  161. packet.len = len;
  162. mav_array_memcpy(packet.data, data, sizeof(uint8_t)*8);
  163. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_CAN_FRAME_LEN);
  164. #endif
  165. msg->msgid = MAVLINK_MSG_ID_CAN_FRAME;
  166. return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_CAN_FRAME_MIN_LEN, MAVLINK_MSG_ID_CAN_FRAME_LEN, MAVLINK_MSG_ID_CAN_FRAME_CRC);
  167. }
  168. /**
  169. * @brief Encode a can_frame struct
  170. *
  171. * @param system_id ID of this system
  172. * @param component_id ID of this component (e.g. 200 for IMU)
  173. * @param msg The MAVLink message to compress the data into
  174. * @param can_frame C-struct to read the message contents from
  175. */
  176. static inline uint16_t mavlink_msg_can_frame_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_can_frame_t* can_frame)
  177. {
  178. return mavlink_msg_can_frame_pack(system_id, component_id, msg, can_frame->target_system, can_frame->target_component, can_frame->bus, can_frame->len, can_frame->id, can_frame->data);
  179. }
  180. /**
  181. * @brief Encode a can_frame struct on a channel
  182. *
  183. * @param system_id ID of this system
  184. * @param component_id ID of this component (e.g. 200 for IMU)
  185. * @param chan The MAVLink channel this message will be sent over
  186. * @param msg The MAVLink message to compress the data into
  187. * @param can_frame C-struct to read the message contents from
  188. */
  189. static inline uint16_t mavlink_msg_can_frame_encode_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const mavlink_can_frame_t* can_frame)
  190. {
  191. return mavlink_msg_can_frame_pack_chan(system_id, component_id, chan, msg, can_frame->target_system, can_frame->target_component, can_frame->bus, can_frame->len, can_frame->id, can_frame->data);
  192. }
  193. /**
  194. * @brief Encode a can_frame struct with provided status structure
  195. *
  196. * @param system_id ID of this system
  197. * @param component_id ID of this component (e.g. 200 for IMU)
  198. * @param status MAVLink status structure
  199. * @param msg The MAVLink message to compress the data into
  200. * @param can_frame C-struct to read the message contents from
  201. */
  202. static inline uint16_t mavlink_msg_can_frame_encode_status(uint8_t system_id, uint8_t component_id, mavlink_status_t* _status, mavlink_message_t* msg, const mavlink_can_frame_t* can_frame)
  203. {
  204. return mavlink_msg_can_frame_pack_status(system_id, component_id, _status, msg, can_frame->target_system, can_frame->target_component, can_frame->bus, can_frame->len, can_frame->id, can_frame->data);
  205. }
  206. /**
  207. * @brief Send a can_frame message
  208. * @param chan MAVLink channel to send the message
  209. *
  210. * @param target_system System ID.
  211. * @param target_component Component ID.
  212. * @param bus Bus number
  213. * @param len Frame length
  214. * @param id Frame ID
  215. * @param data Frame data
  216. */
  217. #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
  218. static inline void mavlink_msg_can_frame_send(mavlink_channel_t chan, uint8_t target_system, uint8_t target_component, uint8_t bus, uint8_t len, uint32_t id, const uint8_t *data)
  219. {
  220. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  221. char buf[MAVLINK_MSG_ID_CAN_FRAME_LEN];
  222. _mav_put_uint32_t(buf, 0, id);
  223. _mav_put_uint8_t(buf, 4, target_system);
  224. _mav_put_uint8_t(buf, 5, target_component);
  225. _mav_put_uint8_t(buf, 6, bus);
  226. _mav_put_uint8_t(buf, 7, len);
  227. _mav_put_uint8_t_array(buf, 8, data, 8);
  228. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_CAN_FRAME, buf, MAVLINK_MSG_ID_CAN_FRAME_MIN_LEN, MAVLINK_MSG_ID_CAN_FRAME_LEN, MAVLINK_MSG_ID_CAN_FRAME_CRC);
  229. #else
  230. mavlink_can_frame_t packet;
  231. packet.id = id;
  232. packet.target_system = target_system;
  233. packet.target_component = target_component;
  234. packet.bus = bus;
  235. packet.len = len;
  236. mav_array_memcpy(packet.data, data, sizeof(uint8_t)*8);
  237. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_CAN_FRAME, (const char *)&packet, MAVLINK_MSG_ID_CAN_FRAME_MIN_LEN, MAVLINK_MSG_ID_CAN_FRAME_LEN, MAVLINK_MSG_ID_CAN_FRAME_CRC);
  238. #endif
  239. }
  240. /**
  241. * @brief Send a can_frame message
  242. * @param chan MAVLink channel to send the message
  243. * @param struct The MAVLink struct to serialize
  244. */
  245. static inline void mavlink_msg_can_frame_send_struct(mavlink_channel_t chan, const mavlink_can_frame_t* can_frame)
  246. {
  247. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  248. mavlink_msg_can_frame_send(chan, can_frame->target_system, can_frame->target_component, can_frame->bus, can_frame->len, can_frame->id, can_frame->data);
  249. #else
  250. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_CAN_FRAME, (const char *)can_frame, MAVLINK_MSG_ID_CAN_FRAME_MIN_LEN, MAVLINK_MSG_ID_CAN_FRAME_LEN, MAVLINK_MSG_ID_CAN_FRAME_CRC);
  251. #endif
  252. }
  253. #if MAVLINK_MSG_ID_CAN_FRAME_LEN <= MAVLINK_MAX_PAYLOAD_LEN
  254. /*
  255. This variant of _send() can be used to save stack space by re-using
  256. memory from the receive buffer. The caller provides a
  257. mavlink_message_t which is the size of a full mavlink message. This
  258. is usually the receive buffer for the channel, and allows a reply to an
  259. incoming message with minimum stack space usage.
  260. */
  261. static inline void mavlink_msg_can_frame_send_buf(mavlink_message_t *msgbuf, mavlink_channel_t chan, uint8_t target_system, uint8_t target_component, uint8_t bus, uint8_t len, uint32_t id, const uint8_t *data)
  262. {
  263. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  264. char *buf = (char *)msgbuf;
  265. _mav_put_uint32_t(buf, 0, id);
  266. _mav_put_uint8_t(buf, 4, target_system);
  267. _mav_put_uint8_t(buf, 5, target_component);
  268. _mav_put_uint8_t(buf, 6, bus);
  269. _mav_put_uint8_t(buf, 7, len);
  270. _mav_put_uint8_t_array(buf, 8, data, 8);
  271. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_CAN_FRAME, buf, MAVLINK_MSG_ID_CAN_FRAME_MIN_LEN, MAVLINK_MSG_ID_CAN_FRAME_LEN, MAVLINK_MSG_ID_CAN_FRAME_CRC);
  272. #else
  273. mavlink_can_frame_t *packet = (mavlink_can_frame_t *)msgbuf;
  274. packet->id = id;
  275. packet->target_system = target_system;
  276. packet->target_component = target_component;
  277. packet->bus = bus;
  278. packet->len = len;
  279. mav_array_memcpy(packet->data, data, sizeof(uint8_t)*8);
  280. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_CAN_FRAME, (const char *)packet, MAVLINK_MSG_ID_CAN_FRAME_MIN_LEN, MAVLINK_MSG_ID_CAN_FRAME_LEN, MAVLINK_MSG_ID_CAN_FRAME_CRC);
  281. #endif
  282. }
  283. #endif
  284. #endif
  285. // MESSAGE CAN_FRAME UNPACKING
  286. /**
  287. * @brief Get field target_system from can_frame message
  288. *
  289. * @return System ID.
  290. */
  291. static inline uint8_t mavlink_msg_can_frame_get_target_system(const mavlink_message_t* msg)
  292. {
  293. return _MAV_RETURN_uint8_t(msg, 4);
  294. }
  295. /**
  296. * @brief Get field target_component from can_frame message
  297. *
  298. * @return Component ID.
  299. */
  300. static inline uint8_t mavlink_msg_can_frame_get_target_component(const mavlink_message_t* msg)
  301. {
  302. return _MAV_RETURN_uint8_t(msg, 5);
  303. }
  304. /**
  305. * @brief Get field bus from can_frame message
  306. *
  307. * @return Bus number
  308. */
  309. static inline uint8_t mavlink_msg_can_frame_get_bus(const mavlink_message_t* msg)
  310. {
  311. return _MAV_RETURN_uint8_t(msg, 6);
  312. }
  313. /**
  314. * @brief Get field len from can_frame message
  315. *
  316. * @return Frame length
  317. */
  318. static inline uint8_t mavlink_msg_can_frame_get_len(const mavlink_message_t* msg)
  319. {
  320. return _MAV_RETURN_uint8_t(msg, 7);
  321. }
  322. /**
  323. * @brief Get field id from can_frame message
  324. *
  325. * @return Frame ID
  326. */
  327. static inline uint32_t mavlink_msg_can_frame_get_id(const mavlink_message_t* msg)
  328. {
  329. return _MAV_RETURN_uint32_t(msg, 0);
  330. }
  331. /**
  332. * @brief Get field data from can_frame message
  333. *
  334. * @return Frame data
  335. */
  336. static inline uint16_t mavlink_msg_can_frame_get_data(const mavlink_message_t* msg, uint8_t *data)
  337. {
  338. return _MAV_RETURN_uint8_t_array(msg, data, 8, 8);
  339. }
  340. /**
  341. * @brief Decode a can_frame message into a struct
  342. *
  343. * @param msg The message to decode
  344. * @param can_frame C-struct to decode the message contents into
  345. */
  346. static inline void mavlink_msg_can_frame_decode(const mavlink_message_t* msg, mavlink_can_frame_t* can_frame)
  347. {
  348. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  349. can_frame->id = mavlink_msg_can_frame_get_id(msg);
  350. can_frame->target_system = mavlink_msg_can_frame_get_target_system(msg);
  351. can_frame->target_component = mavlink_msg_can_frame_get_target_component(msg);
  352. can_frame->bus = mavlink_msg_can_frame_get_bus(msg);
  353. can_frame->len = mavlink_msg_can_frame_get_len(msg);
  354. mavlink_msg_can_frame_get_data(msg, can_frame->data);
  355. #else
  356. uint8_t len = msg->len < MAVLINK_MSG_ID_CAN_FRAME_LEN? msg->len : MAVLINK_MSG_ID_CAN_FRAME_LEN;
  357. memset(can_frame, 0, MAVLINK_MSG_ID_CAN_FRAME_LEN);
  358. memcpy(can_frame, _MAV_PAYLOAD(msg), len);
  359. #endif
  360. }