mavlink_msg_esc_status.h 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364
  1. #pragma once
  2. // MESSAGE ESC_STATUS PACKING
  3. #define MAVLINK_MSG_ID_ESC_STATUS 291
  4. typedef struct __mavlink_esc_status_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 the number.*/
  6. int32_t rpm[4]; /*< [rpm] Reported motor RPM from each ESC (negative for reverse rotation).*/
  7. float voltage[4]; /*< [V] Voltage measured from each ESC.*/
  8. float current[4]; /*< [A] Current measured from each ESC.*/
  9. uint8_t index; /*< Index of the first ESC in this message. minValue = 0, maxValue = 60, increment = 4.*/
  10. } mavlink_esc_status_t;
  11. #define MAVLINK_MSG_ID_ESC_STATUS_LEN 57
  12. #define MAVLINK_MSG_ID_ESC_STATUS_MIN_LEN 57
  13. #define MAVLINK_MSG_ID_291_LEN 57
  14. #define MAVLINK_MSG_ID_291_MIN_LEN 57
  15. #define MAVLINK_MSG_ID_ESC_STATUS_CRC 10
  16. #define MAVLINK_MSG_ID_291_CRC 10
  17. #define MAVLINK_MSG_ESC_STATUS_FIELD_RPM_LEN 4
  18. #define MAVLINK_MSG_ESC_STATUS_FIELD_VOLTAGE_LEN 4
  19. #define MAVLINK_MSG_ESC_STATUS_FIELD_CURRENT_LEN 4
  20. #if MAVLINK_COMMAND_24BIT
  21. #define MAVLINK_MESSAGE_INFO_ESC_STATUS { \
  22. 291, \
  23. "ESC_STATUS", \
  24. 5, \
  25. { { "index", NULL, MAVLINK_TYPE_UINT8_T, 0, 56, offsetof(mavlink_esc_status_t, index) }, \
  26. { "time_usec", NULL, MAVLINK_TYPE_UINT64_T, 0, 0, offsetof(mavlink_esc_status_t, time_usec) }, \
  27. { "rpm", NULL, MAVLINK_TYPE_INT32_T, 4, 8, offsetof(mavlink_esc_status_t, rpm) }, \
  28. { "voltage", NULL, MAVLINK_TYPE_FLOAT, 4, 24, offsetof(mavlink_esc_status_t, voltage) }, \
  29. { "current", NULL, MAVLINK_TYPE_FLOAT, 4, 40, offsetof(mavlink_esc_status_t, current) }, \
  30. } \
  31. }
  32. #else
  33. #define MAVLINK_MESSAGE_INFO_ESC_STATUS { \
  34. "ESC_STATUS", \
  35. 5, \
  36. { { "index", NULL, MAVLINK_TYPE_UINT8_T, 0, 56, offsetof(mavlink_esc_status_t, index) }, \
  37. { "time_usec", NULL, MAVLINK_TYPE_UINT64_T, 0, 0, offsetof(mavlink_esc_status_t, time_usec) }, \
  38. { "rpm", NULL, MAVLINK_TYPE_INT32_T, 4, 8, offsetof(mavlink_esc_status_t, rpm) }, \
  39. { "voltage", NULL, MAVLINK_TYPE_FLOAT, 4, 24, offsetof(mavlink_esc_status_t, voltage) }, \
  40. { "current", NULL, MAVLINK_TYPE_FLOAT, 4, 40, offsetof(mavlink_esc_status_t, current) }, \
  41. } \
  42. }
  43. #endif
  44. /**
  45. * @brief Pack a esc_status message
  46. * @param system_id ID of this system
  47. * @param component_id ID of this component (e.g. 200 for IMU)
  48. * @param msg The MAVLink message to compress the data into
  49. *
  50. * @param index Index of the first ESC in this message. minValue = 0, maxValue = 60, increment = 4.
  51. * @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 the number.
  52. * @param rpm [rpm] Reported motor RPM from each ESC (negative for reverse rotation).
  53. * @param voltage [V] Voltage measured from each ESC.
  54. * @param current [A] Current measured from each ESC.
  55. * @return length of the message in bytes (excluding serial stream start sign)
  56. */
  57. static inline uint16_t mavlink_msg_esc_status_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
  58. uint8_t index, uint64_t time_usec, const int32_t *rpm, const float *voltage, const float *current)
  59. {
  60. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  61. char buf[MAVLINK_MSG_ID_ESC_STATUS_LEN];
  62. _mav_put_uint64_t(buf, 0, time_usec);
  63. _mav_put_uint8_t(buf, 56, index);
  64. _mav_put_int32_t_array(buf, 8, rpm, 4);
  65. _mav_put_float_array(buf, 24, voltage, 4);
  66. _mav_put_float_array(buf, 40, current, 4);
  67. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_ESC_STATUS_LEN);
  68. #else
  69. mavlink_esc_status_t packet;
  70. packet.time_usec = time_usec;
  71. packet.index = index;
  72. mav_array_memcpy(packet.rpm, rpm, sizeof(int32_t)*4);
  73. mav_array_memcpy(packet.voltage, voltage, sizeof(float)*4);
  74. mav_array_memcpy(packet.current, current, sizeof(float)*4);
  75. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_ESC_STATUS_LEN);
  76. #endif
  77. msg->msgid = MAVLINK_MSG_ID_ESC_STATUS;
  78. return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_ESC_STATUS_MIN_LEN, MAVLINK_MSG_ID_ESC_STATUS_LEN, MAVLINK_MSG_ID_ESC_STATUS_CRC);
  79. }
  80. /**
  81. * @brief Pack a esc_status message
  82. * @param system_id ID of this system
  83. * @param component_id ID of this component (e.g. 200 for IMU)
  84. * @param status MAVLink status structure
  85. * @param msg The MAVLink message to compress the data into
  86. *
  87. * @param index Index of the first ESC in this message. minValue = 0, maxValue = 60, increment = 4.
  88. * @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 the number.
  89. * @param rpm [rpm] Reported motor RPM from each ESC (negative for reverse rotation).
  90. * @param voltage [V] Voltage measured from each ESC.
  91. * @param current [A] Current measured from each ESC.
  92. * @return length of the message in bytes (excluding serial stream start sign)
  93. */
  94. static inline uint16_t mavlink_msg_esc_status_pack_status(uint8_t system_id, uint8_t component_id, mavlink_status_t *_status, mavlink_message_t* msg,
  95. uint8_t index, uint64_t time_usec, const int32_t *rpm, const float *voltage, const float *current)
  96. {
  97. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  98. char buf[MAVLINK_MSG_ID_ESC_STATUS_LEN];
  99. _mav_put_uint64_t(buf, 0, time_usec);
  100. _mav_put_uint8_t(buf, 56, index);
  101. _mav_put_int32_t_array(buf, 8, rpm, 4);
  102. _mav_put_float_array(buf, 24, voltage, 4);
  103. _mav_put_float_array(buf, 40, current, 4);
  104. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_ESC_STATUS_LEN);
  105. #else
  106. mavlink_esc_status_t packet;
  107. packet.time_usec = time_usec;
  108. packet.index = index;
  109. mav_array_memcpy(packet.rpm, rpm, sizeof(int32_t)*4);
  110. mav_array_memcpy(packet.voltage, voltage, sizeof(float)*4);
  111. mav_array_memcpy(packet.current, current, sizeof(float)*4);
  112. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_ESC_STATUS_LEN);
  113. #endif
  114. msg->msgid = MAVLINK_MSG_ID_ESC_STATUS;
  115. #if MAVLINK_CRC_EXTRA
  116. return mavlink_finalize_message_buffer(msg, system_id, component_id, _status, MAVLINK_MSG_ID_ESC_STATUS_MIN_LEN, MAVLINK_MSG_ID_ESC_STATUS_LEN, MAVLINK_MSG_ID_ESC_STATUS_CRC);
  117. #else
  118. return mavlink_finalize_message_buffer(msg, system_id, component_id, _status, MAVLINK_MSG_ID_ESC_STATUS_MIN_LEN, MAVLINK_MSG_ID_ESC_STATUS_LEN);
  119. #endif
  120. }
  121. /**
  122. * @brief Pack a esc_status message on a channel
  123. * @param system_id ID of this system
  124. * @param component_id ID of this component (e.g. 200 for IMU)
  125. * @param chan The MAVLink channel this message will be sent over
  126. * @param msg The MAVLink message to compress the data into
  127. * @param index Index of the first ESC in this message. minValue = 0, maxValue = 60, increment = 4.
  128. * @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 the number.
  129. * @param rpm [rpm] Reported motor RPM from each ESC (negative for reverse rotation).
  130. * @param voltage [V] Voltage measured from each ESC.
  131. * @param current [A] Current measured from each ESC.
  132. * @return length of the message in bytes (excluding serial stream start sign)
  133. */
  134. static inline uint16_t mavlink_msg_esc_status_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
  135. mavlink_message_t* msg,
  136. uint8_t index,uint64_t time_usec,const int32_t *rpm,const float *voltage,const float *current)
  137. {
  138. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  139. char buf[MAVLINK_MSG_ID_ESC_STATUS_LEN];
  140. _mav_put_uint64_t(buf, 0, time_usec);
  141. _mav_put_uint8_t(buf, 56, index);
  142. _mav_put_int32_t_array(buf, 8, rpm, 4);
  143. _mav_put_float_array(buf, 24, voltage, 4);
  144. _mav_put_float_array(buf, 40, current, 4);
  145. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_ESC_STATUS_LEN);
  146. #else
  147. mavlink_esc_status_t packet;
  148. packet.time_usec = time_usec;
  149. packet.index = index;
  150. mav_array_memcpy(packet.rpm, rpm, sizeof(int32_t)*4);
  151. mav_array_memcpy(packet.voltage, voltage, sizeof(float)*4);
  152. mav_array_memcpy(packet.current, current, sizeof(float)*4);
  153. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_ESC_STATUS_LEN);
  154. #endif
  155. msg->msgid = MAVLINK_MSG_ID_ESC_STATUS;
  156. return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_ESC_STATUS_MIN_LEN, MAVLINK_MSG_ID_ESC_STATUS_LEN, MAVLINK_MSG_ID_ESC_STATUS_CRC);
  157. }
  158. /**
  159. * @brief Encode a esc_status struct
  160. *
  161. * @param system_id ID of this system
  162. * @param component_id ID of this component (e.g. 200 for IMU)
  163. * @param msg The MAVLink message to compress the data into
  164. * @param esc_status C-struct to read the message contents from
  165. */
  166. static inline uint16_t mavlink_msg_esc_status_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_esc_status_t* esc_status)
  167. {
  168. return mavlink_msg_esc_status_pack(system_id, component_id, msg, esc_status->index, esc_status->time_usec, esc_status->rpm, esc_status->voltage, esc_status->current);
  169. }
  170. /**
  171. * @brief Encode a esc_status struct on a channel
  172. *
  173. * @param system_id ID of this system
  174. * @param component_id ID of this component (e.g. 200 for IMU)
  175. * @param chan The MAVLink channel this message will be sent over
  176. * @param msg The MAVLink message to compress the data into
  177. * @param esc_status C-struct to read the message contents from
  178. */
  179. static inline uint16_t mavlink_msg_esc_status_encode_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const mavlink_esc_status_t* esc_status)
  180. {
  181. return mavlink_msg_esc_status_pack_chan(system_id, component_id, chan, msg, esc_status->index, esc_status->time_usec, esc_status->rpm, esc_status->voltage, esc_status->current);
  182. }
  183. /**
  184. * @brief Encode a esc_status struct with provided status structure
  185. *
  186. * @param system_id ID of this system
  187. * @param component_id ID of this component (e.g. 200 for IMU)
  188. * @param status MAVLink status structure
  189. * @param msg The MAVLink message to compress the data into
  190. * @param esc_status C-struct to read the message contents from
  191. */
  192. static inline uint16_t mavlink_msg_esc_status_encode_status(uint8_t system_id, uint8_t component_id, mavlink_status_t* _status, mavlink_message_t* msg, const mavlink_esc_status_t* esc_status)
  193. {
  194. return mavlink_msg_esc_status_pack_status(system_id, component_id, _status, msg, esc_status->index, esc_status->time_usec, esc_status->rpm, esc_status->voltage, esc_status->current);
  195. }
  196. /**
  197. * @brief Send a esc_status message
  198. * @param chan MAVLink channel to send the message
  199. *
  200. * @param index Index of the first ESC in this message. minValue = 0, maxValue = 60, increment = 4.
  201. * @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 the number.
  202. * @param rpm [rpm] Reported motor RPM from each ESC (negative for reverse rotation).
  203. * @param voltage [V] Voltage measured from each ESC.
  204. * @param current [A] Current measured from each ESC.
  205. */
  206. #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
  207. static inline void mavlink_msg_esc_status_send(mavlink_channel_t chan, uint8_t index, uint64_t time_usec, const int32_t *rpm, const float *voltage, const float *current)
  208. {
  209. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  210. char buf[MAVLINK_MSG_ID_ESC_STATUS_LEN];
  211. _mav_put_uint64_t(buf, 0, time_usec);
  212. _mav_put_uint8_t(buf, 56, index);
  213. _mav_put_int32_t_array(buf, 8, rpm, 4);
  214. _mav_put_float_array(buf, 24, voltage, 4);
  215. _mav_put_float_array(buf, 40, current, 4);
  216. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_ESC_STATUS, buf, MAVLINK_MSG_ID_ESC_STATUS_MIN_LEN, MAVLINK_MSG_ID_ESC_STATUS_LEN, MAVLINK_MSG_ID_ESC_STATUS_CRC);
  217. #else
  218. mavlink_esc_status_t packet;
  219. packet.time_usec = time_usec;
  220. packet.index = index;
  221. mav_array_memcpy(packet.rpm, rpm, sizeof(int32_t)*4);
  222. mav_array_memcpy(packet.voltage, voltage, sizeof(float)*4);
  223. mav_array_memcpy(packet.current, current, sizeof(float)*4);
  224. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_ESC_STATUS, (const char *)&packet, MAVLINK_MSG_ID_ESC_STATUS_MIN_LEN, MAVLINK_MSG_ID_ESC_STATUS_LEN, MAVLINK_MSG_ID_ESC_STATUS_CRC);
  225. #endif
  226. }
  227. /**
  228. * @brief Send a esc_status message
  229. * @param chan MAVLink channel to send the message
  230. * @param struct The MAVLink struct to serialize
  231. */
  232. static inline void mavlink_msg_esc_status_send_struct(mavlink_channel_t chan, const mavlink_esc_status_t* esc_status)
  233. {
  234. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  235. mavlink_msg_esc_status_send(chan, esc_status->index, esc_status->time_usec, esc_status->rpm, esc_status->voltage, esc_status->current);
  236. #else
  237. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_ESC_STATUS, (const char *)esc_status, MAVLINK_MSG_ID_ESC_STATUS_MIN_LEN, MAVLINK_MSG_ID_ESC_STATUS_LEN, MAVLINK_MSG_ID_ESC_STATUS_CRC);
  238. #endif
  239. }
  240. #if MAVLINK_MSG_ID_ESC_STATUS_LEN <= MAVLINK_MAX_PAYLOAD_LEN
  241. /*
  242. This variant of _send() can be used to save stack space by re-using
  243. memory from the receive buffer. The caller provides a
  244. mavlink_message_t which is the size of a full mavlink message. This
  245. is usually the receive buffer for the channel, and allows a reply to an
  246. incoming message with minimum stack space usage.
  247. */
  248. static inline void mavlink_msg_esc_status_send_buf(mavlink_message_t *msgbuf, mavlink_channel_t chan, uint8_t index, uint64_t time_usec, const int32_t *rpm, const float *voltage, const float *current)
  249. {
  250. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  251. char *buf = (char *)msgbuf;
  252. _mav_put_uint64_t(buf, 0, time_usec);
  253. _mav_put_uint8_t(buf, 56, index);
  254. _mav_put_int32_t_array(buf, 8, rpm, 4);
  255. _mav_put_float_array(buf, 24, voltage, 4);
  256. _mav_put_float_array(buf, 40, current, 4);
  257. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_ESC_STATUS, buf, MAVLINK_MSG_ID_ESC_STATUS_MIN_LEN, MAVLINK_MSG_ID_ESC_STATUS_LEN, MAVLINK_MSG_ID_ESC_STATUS_CRC);
  258. #else
  259. mavlink_esc_status_t *packet = (mavlink_esc_status_t *)msgbuf;
  260. packet->time_usec = time_usec;
  261. packet->index = index;
  262. mav_array_memcpy(packet->rpm, rpm, sizeof(int32_t)*4);
  263. mav_array_memcpy(packet->voltage, voltage, sizeof(float)*4);
  264. mav_array_memcpy(packet->current, current, sizeof(float)*4);
  265. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_ESC_STATUS, (const char *)packet, MAVLINK_MSG_ID_ESC_STATUS_MIN_LEN, MAVLINK_MSG_ID_ESC_STATUS_LEN, MAVLINK_MSG_ID_ESC_STATUS_CRC);
  266. #endif
  267. }
  268. #endif
  269. #endif
  270. // MESSAGE ESC_STATUS UNPACKING
  271. /**
  272. * @brief Get field index from esc_status message
  273. *
  274. * @return Index of the first ESC in this message. minValue = 0, maxValue = 60, increment = 4.
  275. */
  276. static inline uint8_t mavlink_msg_esc_status_get_index(const mavlink_message_t* msg)
  277. {
  278. return _MAV_RETURN_uint8_t(msg, 56);
  279. }
  280. /**
  281. * @brief Get field time_usec from esc_status message
  282. *
  283. * @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 the number.
  284. */
  285. static inline uint64_t mavlink_msg_esc_status_get_time_usec(const mavlink_message_t* msg)
  286. {
  287. return _MAV_RETURN_uint64_t(msg, 0);
  288. }
  289. /**
  290. * @brief Get field rpm from esc_status message
  291. *
  292. * @return [rpm] Reported motor RPM from each ESC (negative for reverse rotation).
  293. */
  294. static inline uint16_t mavlink_msg_esc_status_get_rpm(const mavlink_message_t* msg, int32_t *rpm)
  295. {
  296. return _MAV_RETURN_int32_t_array(msg, rpm, 4, 8);
  297. }
  298. /**
  299. * @brief Get field voltage from esc_status message
  300. *
  301. * @return [V] Voltage measured from each ESC.
  302. */
  303. static inline uint16_t mavlink_msg_esc_status_get_voltage(const mavlink_message_t* msg, float *voltage)
  304. {
  305. return _MAV_RETURN_float_array(msg, voltage, 4, 24);
  306. }
  307. /**
  308. * @brief Get field current from esc_status message
  309. *
  310. * @return [A] Current measured from each ESC.
  311. */
  312. static inline uint16_t mavlink_msg_esc_status_get_current(const mavlink_message_t* msg, float *current)
  313. {
  314. return _MAV_RETURN_float_array(msg, current, 4, 40);
  315. }
  316. /**
  317. * @brief Decode a esc_status message into a struct
  318. *
  319. * @param msg The message to decode
  320. * @param esc_status C-struct to decode the message contents into
  321. */
  322. static inline void mavlink_msg_esc_status_decode(const mavlink_message_t* msg, mavlink_esc_status_t* esc_status)
  323. {
  324. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  325. esc_status->time_usec = mavlink_msg_esc_status_get_time_usec(msg);
  326. mavlink_msg_esc_status_get_rpm(msg, esc_status->rpm);
  327. mavlink_msg_esc_status_get_voltage(msg, esc_status->voltage);
  328. mavlink_msg_esc_status_get_current(msg, esc_status->current);
  329. esc_status->index = mavlink_msg_esc_status_get_index(msg);
  330. #else
  331. uint8_t len = msg->len < MAVLINK_MSG_ID_ESC_STATUS_LEN? msg->len : MAVLINK_MSG_ID_ESC_STATUS_LEN;
  332. memset(esc_status, 0, MAVLINK_MSG_ID_ESC_STATUS_LEN);
  333. memcpy(esc_status, _MAV_PAYLOAD(msg), len);
  334. #endif
  335. }