mavlink_msg_vibration.h 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363
  1. #pragma once
  2. // MESSAGE VIBRATION PACKING
  3. #define MAVLINK_MSG_ID_VIBRATION 241
  4. typedef struct __mavlink_vibration_t {
  5. uint64_t time_usec; /*< [us] Timestamp (UNIX Epoch time or time since system boot). The receiving end can infer timestamp format (since 1.1.1970 or since system boot) by checking for the magnitude of the number.*/
  6. float vibration_x; /*< Vibration levels on X-axis*/
  7. float vibration_y; /*< Vibration levels on Y-axis*/
  8. float vibration_z; /*< Vibration levels on Z-axis*/
  9. uint32_t clipping_0; /*< first accelerometer clipping count*/
  10. uint32_t clipping_1; /*< second accelerometer clipping count*/
  11. uint32_t clipping_2; /*< third accelerometer clipping count*/
  12. } mavlink_vibration_t;
  13. #define MAVLINK_MSG_ID_VIBRATION_LEN 32
  14. #define MAVLINK_MSG_ID_VIBRATION_MIN_LEN 32
  15. #define MAVLINK_MSG_ID_241_LEN 32
  16. #define MAVLINK_MSG_ID_241_MIN_LEN 32
  17. #define MAVLINK_MSG_ID_VIBRATION_CRC 90
  18. #define MAVLINK_MSG_ID_241_CRC 90
  19. #if MAVLINK_COMMAND_24BIT
  20. #define MAVLINK_MESSAGE_INFO_VIBRATION { \
  21. 241, \
  22. "VIBRATION", \
  23. 7, \
  24. { { "time_usec", NULL, MAVLINK_TYPE_UINT64_T, 0, 0, offsetof(mavlink_vibration_t, time_usec) }, \
  25. { "vibration_x", NULL, MAVLINK_TYPE_FLOAT, 0, 8, offsetof(mavlink_vibration_t, vibration_x) }, \
  26. { "vibration_y", NULL, MAVLINK_TYPE_FLOAT, 0, 12, offsetof(mavlink_vibration_t, vibration_y) }, \
  27. { "vibration_z", NULL, MAVLINK_TYPE_FLOAT, 0, 16, offsetof(mavlink_vibration_t, vibration_z) }, \
  28. { "clipping_0", NULL, MAVLINK_TYPE_UINT32_T, 0, 20, offsetof(mavlink_vibration_t, clipping_0) }, \
  29. { "clipping_1", NULL, MAVLINK_TYPE_UINT32_T, 0, 24, offsetof(mavlink_vibration_t, clipping_1) }, \
  30. { "clipping_2", NULL, MAVLINK_TYPE_UINT32_T, 0, 28, offsetof(mavlink_vibration_t, clipping_2) }, \
  31. } \
  32. }
  33. #else
  34. #define MAVLINK_MESSAGE_INFO_VIBRATION { \
  35. "VIBRATION", \
  36. 7, \
  37. { { "time_usec", NULL, MAVLINK_TYPE_UINT64_T, 0, 0, offsetof(mavlink_vibration_t, time_usec) }, \
  38. { "vibration_x", NULL, MAVLINK_TYPE_FLOAT, 0, 8, offsetof(mavlink_vibration_t, vibration_x) }, \
  39. { "vibration_y", NULL, MAVLINK_TYPE_FLOAT, 0, 12, offsetof(mavlink_vibration_t, vibration_y) }, \
  40. { "vibration_z", NULL, MAVLINK_TYPE_FLOAT, 0, 16, offsetof(mavlink_vibration_t, vibration_z) }, \
  41. { "clipping_0", NULL, MAVLINK_TYPE_UINT32_T, 0, 20, offsetof(mavlink_vibration_t, clipping_0) }, \
  42. { "clipping_1", NULL, MAVLINK_TYPE_UINT32_T, 0, 24, offsetof(mavlink_vibration_t, clipping_1) }, \
  43. { "clipping_2", NULL, MAVLINK_TYPE_UINT32_T, 0, 28, offsetof(mavlink_vibration_t, clipping_2) }, \
  44. } \
  45. }
  46. #endif
  47. /**
  48. * @brief Pack a vibration 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 time_usec [us] Timestamp (UNIX Epoch time or time since system boot). The receiving end can infer timestamp format (since 1.1.1970 or since system boot) by checking for the magnitude of the number.
  54. * @param vibration_x Vibration levels on X-axis
  55. * @param vibration_y Vibration levels on Y-axis
  56. * @param vibration_z Vibration levels on Z-axis
  57. * @param clipping_0 first accelerometer clipping count
  58. * @param clipping_1 second accelerometer clipping count
  59. * @param clipping_2 third accelerometer clipping count
  60. * @return length of the message in bytes (excluding serial stream start sign)
  61. */
  62. static inline uint16_t mavlink_msg_vibration_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
  63. uint64_t time_usec, float vibration_x, float vibration_y, float vibration_z, uint32_t clipping_0, uint32_t clipping_1, uint32_t clipping_2)
  64. {
  65. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  66. char buf[MAVLINK_MSG_ID_VIBRATION_LEN];
  67. _mav_put_uint64_t(buf, 0, time_usec);
  68. _mav_put_float(buf, 8, vibration_x);
  69. _mav_put_float(buf, 12, vibration_y);
  70. _mav_put_float(buf, 16, vibration_z);
  71. _mav_put_uint32_t(buf, 20, clipping_0);
  72. _mav_put_uint32_t(buf, 24, clipping_1);
  73. _mav_put_uint32_t(buf, 28, clipping_2);
  74. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_VIBRATION_LEN);
  75. #else
  76. mavlink_vibration_t packet;
  77. packet.time_usec = time_usec;
  78. packet.vibration_x = vibration_x;
  79. packet.vibration_y = vibration_y;
  80. packet.vibration_z = vibration_z;
  81. packet.clipping_0 = clipping_0;
  82. packet.clipping_1 = clipping_1;
  83. packet.clipping_2 = clipping_2;
  84. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_VIBRATION_LEN);
  85. #endif
  86. msg->msgid = MAVLINK_MSG_ID_VIBRATION;
  87. return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_VIBRATION_MIN_LEN, MAVLINK_MSG_ID_VIBRATION_LEN, MAVLINK_MSG_ID_VIBRATION_CRC);
  88. }
  89. /**
  90. * @brief Pack a vibration 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 time_usec [us] Timestamp (UNIX Epoch time or time since system boot). The receiving end can infer timestamp format (since 1.1.1970 or since system boot) by checking for the magnitude of the number.
  96. * @param vibration_x Vibration levels on X-axis
  97. * @param vibration_y Vibration levels on Y-axis
  98. * @param vibration_z Vibration levels on Z-axis
  99. * @param clipping_0 first accelerometer clipping count
  100. * @param clipping_1 second accelerometer clipping count
  101. * @param clipping_2 third accelerometer clipping count
  102. * @return length of the message in bytes (excluding serial stream start sign)
  103. */
  104. static inline uint16_t mavlink_msg_vibration_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
  105. mavlink_message_t* msg,
  106. uint64_t time_usec,float vibration_x,float vibration_y,float vibration_z,uint32_t clipping_0,uint32_t clipping_1,uint32_t clipping_2)
  107. {
  108. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  109. char buf[MAVLINK_MSG_ID_VIBRATION_LEN];
  110. _mav_put_uint64_t(buf, 0, time_usec);
  111. _mav_put_float(buf, 8, vibration_x);
  112. _mav_put_float(buf, 12, vibration_y);
  113. _mav_put_float(buf, 16, vibration_z);
  114. _mav_put_uint32_t(buf, 20, clipping_0);
  115. _mav_put_uint32_t(buf, 24, clipping_1);
  116. _mav_put_uint32_t(buf, 28, clipping_2);
  117. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_VIBRATION_LEN);
  118. #else
  119. mavlink_vibration_t packet;
  120. packet.time_usec = time_usec;
  121. packet.vibration_x = vibration_x;
  122. packet.vibration_y = vibration_y;
  123. packet.vibration_z = vibration_z;
  124. packet.clipping_0 = clipping_0;
  125. packet.clipping_1 = clipping_1;
  126. packet.clipping_2 = clipping_2;
  127. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_VIBRATION_LEN);
  128. #endif
  129. msg->msgid = MAVLINK_MSG_ID_VIBRATION;
  130. return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_VIBRATION_MIN_LEN, MAVLINK_MSG_ID_VIBRATION_LEN, MAVLINK_MSG_ID_VIBRATION_CRC);
  131. }
  132. /**
  133. * @brief Encode a vibration 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 vibration C-struct to read the message contents from
  139. */
  140. static inline uint16_t mavlink_msg_vibration_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_vibration_t* vibration)
  141. {
  142. return mavlink_msg_vibration_pack(system_id, component_id, msg, vibration->time_usec, vibration->vibration_x, vibration->vibration_y, vibration->vibration_z, vibration->clipping_0, vibration->clipping_1, vibration->clipping_2);
  143. }
  144. /**
  145. * @brief Encode a vibration 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 vibration C-struct to read the message contents from
  152. */
  153. static inline uint16_t mavlink_msg_vibration_encode_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const mavlink_vibration_t* vibration)
  154. {
  155. return mavlink_msg_vibration_pack_chan(system_id, component_id, chan, msg, vibration->time_usec, vibration->vibration_x, vibration->vibration_y, vibration->vibration_z, vibration->clipping_0, vibration->clipping_1, vibration->clipping_2);
  156. }
  157. /**
  158. * @brief Send a vibration message
  159. * @param chan MAVLink channel to send the message
  160. *
  161. * @param time_usec [us] Timestamp (UNIX Epoch time or time since system boot). The receiving end can infer timestamp format (since 1.1.1970 or since system boot) by checking for the magnitude of the number.
  162. * @param vibration_x Vibration levels on X-axis
  163. * @param vibration_y Vibration levels on Y-axis
  164. * @param vibration_z Vibration levels on Z-axis
  165. * @param clipping_0 first accelerometer clipping count
  166. * @param clipping_1 second accelerometer clipping count
  167. * @param clipping_2 third accelerometer clipping count
  168. */
  169. #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
  170. static inline void mavlink_msg_vibration_send(mavlink_channel_t chan, uint64_t time_usec, float vibration_x, float vibration_y, float vibration_z, uint32_t clipping_0, uint32_t clipping_1, uint32_t clipping_2)
  171. {
  172. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  173. char buf[MAVLINK_MSG_ID_VIBRATION_LEN];
  174. _mav_put_uint64_t(buf, 0, time_usec);
  175. _mav_put_float(buf, 8, vibration_x);
  176. _mav_put_float(buf, 12, vibration_y);
  177. _mav_put_float(buf, 16, vibration_z);
  178. _mav_put_uint32_t(buf, 20, clipping_0);
  179. _mav_put_uint32_t(buf, 24, clipping_1);
  180. _mav_put_uint32_t(buf, 28, clipping_2);
  181. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_VIBRATION, buf, MAVLINK_MSG_ID_VIBRATION_MIN_LEN, MAVLINK_MSG_ID_VIBRATION_LEN, MAVLINK_MSG_ID_VIBRATION_CRC);
  182. #else
  183. mavlink_vibration_t packet;
  184. packet.time_usec = time_usec;
  185. packet.vibration_x = vibration_x;
  186. packet.vibration_y = vibration_y;
  187. packet.vibration_z = vibration_z;
  188. packet.clipping_0 = clipping_0;
  189. packet.clipping_1 = clipping_1;
  190. packet.clipping_2 = clipping_2;
  191. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_VIBRATION, (const char *)&packet, MAVLINK_MSG_ID_VIBRATION_MIN_LEN, MAVLINK_MSG_ID_VIBRATION_LEN, MAVLINK_MSG_ID_VIBRATION_CRC);
  192. #endif
  193. }
  194. /**
  195. * @brief Send a vibration 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_vibration_send_struct(mavlink_channel_t chan, const mavlink_vibration_t* vibration)
  200. {
  201. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  202. mavlink_msg_vibration_send(chan, vibration->time_usec, vibration->vibration_x, vibration->vibration_y, vibration->vibration_z, vibration->clipping_0, vibration->clipping_1, vibration->clipping_2);
  203. #else
  204. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_VIBRATION, (const char *)vibration, MAVLINK_MSG_ID_VIBRATION_MIN_LEN, MAVLINK_MSG_ID_VIBRATION_LEN, MAVLINK_MSG_ID_VIBRATION_CRC);
  205. #endif
  206. }
  207. #if MAVLINK_MSG_ID_VIBRATION_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_vibration_send_buf(mavlink_message_t *msgbuf, mavlink_channel_t chan, uint64_t time_usec, float vibration_x, float vibration_y, float vibration_z, uint32_t clipping_0, uint32_t clipping_1, uint32_t clipping_2)
  216. {
  217. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  218. char *buf = (char *)msgbuf;
  219. _mav_put_uint64_t(buf, 0, time_usec);
  220. _mav_put_float(buf, 8, vibration_x);
  221. _mav_put_float(buf, 12, vibration_y);
  222. _mav_put_float(buf, 16, vibration_z);
  223. _mav_put_uint32_t(buf, 20, clipping_0);
  224. _mav_put_uint32_t(buf, 24, clipping_1);
  225. _mav_put_uint32_t(buf, 28, clipping_2);
  226. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_VIBRATION, buf, MAVLINK_MSG_ID_VIBRATION_MIN_LEN, MAVLINK_MSG_ID_VIBRATION_LEN, MAVLINK_MSG_ID_VIBRATION_CRC);
  227. #else
  228. mavlink_vibration_t *packet = (mavlink_vibration_t *)msgbuf;
  229. packet->time_usec = time_usec;
  230. packet->vibration_x = vibration_x;
  231. packet->vibration_y = vibration_y;
  232. packet->vibration_z = vibration_z;
  233. packet->clipping_0 = clipping_0;
  234. packet->clipping_1 = clipping_1;
  235. packet->clipping_2 = clipping_2;
  236. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_VIBRATION, (const char *)packet, MAVLINK_MSG_ID_VIBRATION_MIN_LEN, MAVLINK_MSG_ID_VIBRATION_LEN, MAVLINK_MSG_ID_VIBRATION_CRC);
  237. #endif
  238. }
  239. #endif
  240. #endif
  241. // MESSAGE VIBRATION UNPACKING
  242. /**
  243. * @brief Get field time_usec from vibration message
  244. *
  245. * @return [us] Timestamp (UNIX Epoch time or time since system boot). The receiving end can infer timestamp format (since 1.1.1970 or since system boot) by checking for the magnitude of the number.
  246. */
  247. static inline uint64_t mavlink_msg_vibration_get_time_usec(const mavlink_message_t* msg)
  248. {
  249. return _MAV_RETURN_uint64_t(msg, 0);
  250. }
  251. /**
  252. * @brief Get field vibration_x from vibration message
  253. *
  254. * @return Vibration levels on X-axis
  255. */
  256. static inline float mavlink_msg_vibration_get_vibration_x(const mavlink_message_t* msg)
  257. {
  258. return _MAV_RETURN_float(msg, 8);
  259. }
  260. /**
  261. * @brief Get field vibration_y from vibration message
  262. *
  263. * @return Vibration levels on Y-axis
  264. */
  265. static inline float mavlink_msg_vibration_get_vibration_y(const mavlink_message_t* msg)
  266. {
  267. return _MAV_RETURN_float(msg, 12);
  268. }
  269. /**
  270. * @brief Get field vibration_z from vibration message
  271. *
  272. * @return Vibration levels on Z-axis
  273. */
  274. static inline float mavlink_msg_vibration_get_vibration_z(const mavlink_message_t* msg)
  275. {
  276. return _MAV_RETURN_float(msg, 16);
  277. }
  278. /**
  279. * @brief Get field clipping_0 from vibration message
  280. *
  281. * @return first accelerometer clipping count
  282. */
  283. static inline uint32_t mavlink_msg_vibration_get_clipping_0(const mavlink_message_t* msg)
  284. {
  285. return _MAV_RETURN_uint32_t(msg, 20);
  286. }
  287. /**
  288. * @brief Get field clipping_1 from vibration message
  289. *
  290. * @return second accelerometer clipping count
  291. */
  292. static inline uint32_t mavlink_msg_vibration_get_clipping_1(const mavlink_message_t* msg)
  293. {
  294. return _MAV_RETURN_uint32_t(msg, 24);
  295. }
  296. /**
  297. * @brief Get field clipping_2 from vibration message
  298. *
  299. * @return third accelerometer clipping count
  300. */
  301. static inline uint32_t mavlink_msg_vibration_get_clipping_2(const mavlink_message_t* msg)
  302. {
  303. return _MAV_RETURN_uint32_t(msg, 28);
  304. }
  305. /**
  306. * @brief Decode a vibration message into a struct
  307. *
  308. * @param msg The message to decode
  309. * @param vibration C-struct to decode the message contents into
  310. */
  311. static inline void mavlink_msg_vibration_decode(const mavlink_message_t* msg, mavlink_vibration_t* vibration)
  312. {
  313. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  314. vibration->time_usec = mavlink_msg_vibration_get_time_usec(msg);
  315. vibration->vibration_x = mavlink_msg_vibration_get_vibration_x(msg);
  316. vibration->vibration_y = mavlink_msg_vibration_get_vibration_y(msg);
  317. vibration->vibration_z = mavlink_msg_vibration_get_vibration_z(msg);
  318. vibration->clipping_0 = mavlink_msg_vibration_get_clipping_0(msg);
  319. vibration->clipping_1 = mavlink_msg_vibration_get_clipping_1(msg);
  320. vibration->clipping_2 = mavlink_msg_vibration_get_clipping_2(msg);
  321. #else
  322. uint8_t len = msg->len < MAVLINK_MSG_ID_VIBRATION_LEN? msg->len : MAVLINK_MSG_ID_VIBRATION_LEN;
  323. memset(vibration, 0, MAVLINK_MSG_ID_VIBRATION_LEN);
  324. memcpy(vibration, _MAV_PAYLOAD(msg), len);
  325. #endif
  326. }