mavlink_msg_can_frame.h 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330
  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 on a channel
  86. * @param system_id ID of this system
  87. * @param component_id ID of this component (e.g. 200 for IMU)
  88. * @param chan The MAVLink channel this message will be sent over
  89. * @param msg The MAVLink message to compress the data into
  90. * @param target_system System ID.
  91. * @param target_component Component ID.
  92. * @param bus Bus number
  93. * @param len Frame length
  94. * @param id Frame ID
  95. * @param data Frame data
  96. * @return length of the message in bytes (excluding serial stream start sign)
  97. */
  98. static inline uint16_t mavlink_msg_can_frame_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
  99. 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. 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);
  123. }
  124. /**
  125. * @brief Encode a can_frame struct
  126. *
  127. * @param system_id ID of this system
  128. * @param component_id ID of this component (e.g. 200 for IMU)
  129. * @param msg The MAVLink message to compress the data into
  130. * @param can_frame C-struct to read the message contents from
  131. */
  132. 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)
  133. {
  134. 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);
  135. }
  136. /**
  137. * @brief Encode a can_frame struct on a channel
  138. *
  139. * @param system_id ID of this system
  140. * @param component_id ID of this component (e.g. 200 for IMU)
  141. * @param chan The MAVLink channel this message will be sent over
  142. * @param msg The MAVLink message to compress the data into
  143. * @param can_frame C-struct to read the message contents from
  144. */
  145. 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)
  146. {
  147. 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);
  148. }
  149. /**
  150. * @brief Send a can_frame message
  151. * @param chan MAVLink channel to send the message
  152. *
  153. * @param target_system System ID.
  154. * @param target_component Component ID.
  155. * @param bus Bus number
  156. * @param len Frame length
  157. * @param id Frame ID
  158. * @param data Frame data
  159. */
  160. #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
  161. 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)
  162. {
  163. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  164. char buf[MAVLINK_MSG_ID_CAN_FRAME_LEN];
  165. _mav_put_uint32_t(buf, 0, id);
  166. _mav_put_uint8_t(buf, 4, target_system);
  167. _mav_put_uint8_t(buf, 5, target_component);
  168. _mav_put_uint8_t(buf, 6, bus);
  169. _mav_put_uint8_t(buf, 7, len);
  170. _mav_put_uint8_t_array(buf, 8, data, 8);
  171. _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);
  172. #else
  173. mavlink_can_frame_t packet;
  174. packet.id = id;
  175. packet.target_system = target_system;
  176. packet.target_component = target_component;
  177. packet.bus = bus;
  178. packet.len = len;
  179. mav_array_memcpy(packet.data, data, sizeof(uint8_t)*8);
  180. _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);
  181. #endif
  182. }
  183. /**
  184. * @brief Send a can_frame message
  185. * @param chan MAVLink channel to send the message
  186. * @param struct The MAVLink struct to serialize
  187. */
  188. static inline void mavlink_msg_can_frame_send_struct(mavlink_channel_t chan, const mavlink_can_frame_t* can_frame)
  189. {
  190. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  191. 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);
  192. #else
  193. _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);
  194. #endif
  195. }
  196. #if MAVLINK_MSG_ID_CAN_FRAME_LEN <= MAVLINK_MAX_PAYLOAD_LEN
  197. /*
  198. This variant of _send() can be used to save stack space by re-using
  199. memory from the receive buffer. The caller provides a
  200. mavlink_message_t which is the size of a full mavlink message. This
  201. is usually the receive buffer for the channel, and allows a reply to an
  202. incoming message with minimum stack space usage.
  203. */
  204. 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)
  205. {
  206. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  207. char *buf = (char *)msgbuf;
  208. _mav_put_uint32_t(buf, 0, id);
  209. _mav_put_uint8_t(buf, 4, target_system);
  210. _mav_put_uint8_t(buf, 5, target_component);
  211. _mav_put_uint8_t(buf, 6, bus);
  212. _mav_put_uint8_t(buf, 7, len);
  213. _mav_put_uint8_t_array(buf, 8, data, 8);
  214. _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);
  215. #else
  216. mavlink_can_frame_t *packet = (mavlink_can_frame_t *)msgbuf;
  217. packet->id = id;
  218. packet->target_system = target_system;
  219. packet->target_component = target_component;
  220. packet->bus = bus;
  221. packet->len = len;
  222. mav_array_memcpy(packet->data, data, sizeof(uint8_t)*8);
  223. _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);
  224. #endif
  225. }
  226. #endif
  227. #endif
  228. // MESSAGE CAN_FRAME UNPACKING
  229. /**
  230. * @brief Get field target_system from can_frame message
  231. *
  232. * @return System ID.
  233. */
  234. static inline uint8_t mavlink_msg_can_frame_get_target_system(const mavlink_message_t* msg)
  235. {
  236. return _MAV_RETURN_uint8_t(msg, 4);
  237. }
  238. /**
  239. * @brief Get field target_component from can_frame message
  240. *
  241. * @return Component ID.
  242. */
  243. static inline uint8_t mavlink_msg_can_frame_get_target_component(const mavlink_message_t* msg)
  244. {
  245. return _MAV_RETURN_uint8_t(msg, 5);
  246. }
  247. /**
  248. * @brief Get field bus from can_frame message
  249. *
  250. * @return Bus number
  251. */
  252. static inline uint8_t mavlink_msg_can_frame_get_bus(const mavlink_message_t* msg)
  253. {
  254. return _MAV_RETURN_uint8_t(msg, 6);
  255. }
  256. /**
  257. * @brief Get field len from can_frame message
  258. *
  259. * @return Frame length
  260. */
  261. static inline uint8_t mavlink_msg_can_frame_get_len(const mavlink_message_t* msg)
  262. {
  263. return _MAV_RETURN_uint8_t(msg, 7);
  264. }
  265. /**
  266. * @brief Get field id from can_frame message
  267. *
  268. * @return Frame ID
  269. */
  270. static inline uint32_t mavlink_msg_can_frame_get_id(const mavlink_message_t* msg)
  271. {
  272. return _MAV_RETURN_uint32_t(msg, 0);
  273. }
  274. /**
  275. * @brief Get field data from can_frame message
  276. *
  277. * @return Frame data
  278. */
  279. static inline uint16_t mavlink_msg_can_frame_get_data(const mavlink_message_t* msg, uint8_t *data)
  280. {
  281. return _MAV_RETURN_uint8_t_array(msg, data, 8, 8);
  282. }
  283. /**
  284. * @brief Decode a can_frame message into a struct
  285. *
  286. * @param msg The message to decode
  287. * @param can_frame C-struct to decode the message contents into
  288. */
  289. static inline void mavlink_msg_can_frame_decode(const mavlink_message_t* msg, mavlink_can_frame_t* can_frame)
  290. {
  291. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  292. can_frame->id = mavlink_msg_can_frame_get_id(msg);
  293. can_frame->target_system = mavlink_msg_can_frame_get_target_system(msg);
  294. can_frame->target_component = mavlink_msg_can_frame_get_target_component(msg);
  295. can_frame->bus = mavlink_msg_can_frame_get_bus(msg);
  296. can_frame->len = mavlink_msg_can_frame_get_len(msg);
  297. mavlink_msg_can_frame_get_data(msg, can_frame->data);
  298. #else
  299. uint8_t len = msg->len < MAVLINK_MSG_ID_CAN_FRAME_LEN? msg->len : MAVLINK_MSG_ID_CAN_FRAME_LEN;
  300. memset(can_frame, 0, MAVLINK_MSG_ID_CAN_FRAME_LEN);
  301. memcpy(can_frame, _MAV_PAYLOAD(msg), len);
  302. #endif
  303. }