mavlink_msg_esc_status.h 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307
  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 on a channel
  82. * @param system_id ID of this system
  83. * @param component_id ID of this component (e.g. 200 for IMU)
  84. * @param chan The MAVLink channel this message will be sent over
  85. * @param msg The MAVLink message to compress the data into
  86. * @param index Index of the first ESC in this message. minValue = 0, maxValue = 60, increment = 4.
  87. * @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.
  88. * @param rpm [rpm] Reported motor RPM from each ESC (negative for reverse rotation).
  89. * @param voltage [V] Voltage measured from each ESC.
  90. * @param current [A] Current measured from each ESC.
  91. * @return length of the message in bytes (excluding serial stream start sign)
  92. */
  93. static inline uint16_t mavlink_msg_esc_status_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
  94. 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. 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);
  116. }
  117. /**
  118. * @brief Encode a esc_status struct
  119. *
  120. * @param system_id ID of this system
  121. * @param component_id ID of this component (e.g. 200 for IMU)
  122. * @param msg The MAVLink message to compress the data into
  123. * @param esc_status C-struct to read the message contents from
  124. */
  125. 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)
  126. {
  127. 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);
  128. }
  129. /**
  130. * @brief Encode a esc_status struct on a channel
  131. *
  132. * @param system_id ID of this system
  133. * @param component_id ID of this component (e.g. 200 for IMU)
  134. * @param chan The MAVLink channel this message will be sent over
  135. * @param msg The MAVLink message to compress the data into
  136. * @param esc_status C-struct to read the message contents from
  137. */
  138. 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)
  139. {
  140. 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);
  141. }
  142. /**
  143. * @brief Send a esc_status message
  144. * @param chan MAVLink channel to send the message
  145. *
  146. * @param index Index of the first ESC in this message. minValue = 0, maxValue = 60, increment = 4.
  147. * @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.
  148. * @param rpm [rpm] Reported motor RPM from each ESC (negative for reverse rotation).
  149. * @param voltage [V] Voltage measured from each ESC.
  150. * @param current [A] Current measured from each ESC.
  151. */
  152. #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
  153. 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)
  154. {
  155. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  156. char buf[MAVLINK_MSG_ID_ESC_STATUS_LEN];
  157. _mav_put_uint64_t(buf, 0, time_usec);
  158. _mav_put_uint8_t(buf, 56, index);
  159. _mav_put_int32_t_array(buf, 8, rpm, 4);
  160. _mav_put_float_array(buf, 24, voltage, 4);
  161. _mav_put_float_array(buf, 40, current, 4);
  162. _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);
  163. #else
  164. mavlink_esc_status_t packet;
  165. packet.time_usec = time_usec;
  166. packet.index = index;
  167. mav_array_memcpy(packet.rpm, rpm, sizeof(int32_t)*4);
  168. mav_array_memcpy(packet.voltage, voltage, sizeof(float)*4);
  169. mav_array_memcpy(packet.current, current, sizeof(float)*4);
  170. _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);
  171. #endif
  172. }
  173. /**
  174. * @brief Send a esc_status message
  175. * @param chan MAVLink channel to send the message
  176. * @param struct The MAVLink struct to serialize
  177. */
  178. static inline void mavlink_msg_esc_status_send_struct(mavlink_channel_t chan, const mavlink_esc_status_t* esc_status)
  179. {
  180. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  181. mavlink_msg_esc_status_send(chan, esc_status->index, esc_status->time_usec, esc_status->rpm, esc_status->voltage, esc_status->current);
  182. #else
  183. _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);
  184. #endif
  185. }
  186. #if MAVLINK_MSG_ID_ESC_STATUS_LEN <= MAVLINK_MAX_PAYLOAD_LEN
  187. /*
  188. This variant of _send() can be used to save stack space by re-using
  189. memory from the receive buffer. The caller provides a
  190. mavlink_message_t which is the size of a full mavlink message. This
  191. is usually the receive buffer for the channel, and allows a reply to an
  192. incoming message with minimum stack space usage.
  193. */
  194. 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)
  195. {
  196. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  197. char *buf = (char *)msgbuf;
  198. _mav_put_uint64_t(buf, 0, time_usec);
  199. _mav_put_uint8_t(buf, 56, index);
  200. _mav_put_int32_t_array(buf, 8, rpm, 4);
  201. _mav_put_float_array(buf, 24, voltage, 4);
  202. _mav_put_float_array(buf, 40, current, 4);
  203. _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);
  204. #else
  205. mavlink_esc_status_t *packet = (mavlink_esc_status_t *)msgbuf;
  206. packet->time_usec = time_usec;
  207. packet->index = index;
  208. mav_array_memcpy(packet->rpm, rpm, sizeof(int32_t)*4);
  209. mav_array_memcpy(packet->voltage, voltage, sizeof(float)*4);
  210. mav_array_memcpy(packet->current, current, sizeof(float)*4);
  211. _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);
  212. #endif
  213. }
  214. #endif
  215. #endif
  216. // MESSAGE ESC_STATUS UNPACKING
  217. /**
  218. * @brief Get field index from esc_status message
  219. *
  220. * @return Index of the first ESC in this message. minValue = 0, maxValue = 60, increment = 4.
  221. */
  222. static inline uint8_t mavlink_msg_esc_status_get_index(const mavlink_message_t* msg)
  223. {
  224. return _MAV_RETURN_uint8_t(msg, 56);
  225. }
  226. /**
  227. * @brief Get field time_usec from esc_status message
  228. *
  229. * @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.
  230. */
  231. static inline uint64_t mavlink_msg_esc_status_get_time_usec(const mavlink_message_t* msg)
  232. {
  233. return _MAV_RETURN_uint64_t(msg, 0);
  234. }
  235. /**
  236. * @brief Get field rpm from esc_status message
  237. *
  238. * @return [rpm] Reported motor RPM from each ESC (negative for reverse rotation).
  239. */
  240. static inline uint16_t mavlink_msg_esc_status_get_rpm(const mavlink_message_t* msg, int32_t *rpm)
  241. {
  242. return _MAV_RETURN_int32_t_array(msg, rpm, 4, 8);
  243. }
  244. /**
  245. * @brief Get field voltage from esc_status message
  246. *
  247. * @return [V] Voltage measured from each ESC.
  248. */
  249. static inline uint16_t mavlink_msg_esc_status_get_voltage(const mavlink_message_t* msg, float *voltage)
  250. {
  251. return _MAV_RETURN_float_array(msg, voltage, 4, 24);
  252. }
  253. /**
  254. * @brief Get field current from esc_status message
  255. *
  256. * @return [A] Current measured from each ESC.
  257. */
  258. static inline uint16_t mavlink_msg_esc_status_get_current(const mavlink_message_t* msg, float *current)
  259. {
  260. return _MAV_RETURN_float_array(msg, current, 4, 40);
  261. }
  262. /**
  263. * @brief Decode a esc_status message into a struct
  264. *
  265. * @param msg The message to decode
  266. * @param esc_status C-struct to decode the message contents into
  267. */
  268. static inline void mavlink_msg_esc_status_decode(const mavlink_message_t* msg, mavlink_esc_status_t* esc_status)
  269. {
  270. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  271. esc_status->time_usec = mavlink_msg_esc_status_get_time_usec(msg);
  272. mavlink_msg_esc_status_get_rpm(msg, esc_status->rpm);
  273. mavlink_msg_esc_status_get_voltage(msg, esc_status->voltage);
  274. mavlink_msg_esc_status_get_current(msg, esc_status->current);
  275. esc_status->index = mavlink_msg_esc_status_get_index(msg);
  276. #else
  277. uint8_t len = msg->len < MAVLINK_MSG_ID_ESC_STATUS_LEN? msg->len : MAVLINK_MSG_ID_ESC_STATUS_LEN;
  278. memset(esc_status, 0, MAVLINK_MSG_ID_ESC_STATUS_LEN);
  279. memcpy(esc_status, _MAV_PAYLOAD(msg), len);
  280. #endif
  281. }