mavlink_msg_time_estimate_to_target.h 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313
  1. #pragma once
  2. // MESSAGE TIME_ESTIMATE_TO_TARGET PACKING
  3. #define MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET 380
  4. typedef struct __mavlink_time_estimate_to_target_t {
  5. int32_t safe_return; /*< [s] Estimated time to complete the vehicle's configured "safe return" action from its current position (e.g. RTL, Smart RTL, etc.). -1 indicates that the vehicle is landed, or that no time estimate available.*/
  6. int32_t land; /*< [s] Estimated time for vehicle to complete the LAND action from its current position. -1 indicates that the vehicle is landed, or that no time estimate available.*/
  7. int32_t mission_next_item; /*< [s] Estimated time for reaching/completing the currently active mission item. -1 means no time estimate available.*/
  8. int32_t mission_end; /*< [s] Estimated time for completing the current mission. -1 means no mission active and/or no estimate available.*/
  9. int32_t commanded_action; /*< [s] Estimated time for completing the current commanded action (i.e. Go To, Takeoff, Land, etc.). -1 means no action active and/or no estimate available.*/
  10. } mavlink_time_estimate_to_target_t;
  11. #define MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_LEN 20
  12. #define MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_MIN_LEN 20
  13. #define MAVLINK_MSG_ID_380_LEN 20
  14. #define MAVLINK_MSG_ID_380_MIN_LEN 20
  15. #define MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_CRC 232
  16. #define MAVLINK_MSG_ID_380_CRC 232
  17. #if MAVLINK_COMMAND_24BIT
  18. #define MAVLINK_MESSAGE_INFO_TIME_ESTIMATE_TO_TARGET { \
  19. 380, \
  20. "TIME_ESTIMATE_TO_TARGET", \
  21. 5, \
  22. { { "safe_return", NULL, MAVLINK_TYPE_INT32_T, 0, 0, offsetof(mavlink_time_estimate_to_target_t, safe_return) }, \
  23. { "land", NULL, MAVLINK_TYPE_INT32_T, 0, 4, offsetof(mavlink_time_estimate_to_target_t, land) }, \
  24. { "mission_next_item", NULL, MAVLINK_TYPE_INT32_T, 0, 8, offsetof(mavlink_time_estimate_to_target_t, mission_next_item) }, \
  25. { "mission_end", NULL, MAVLINK_TYPE_INT32_T, 0, 12, offsetof(mavlink_time_estimate_to_target_t, mission_end) }, \
  26. { "commanded_action", NULL, MAVLINK_TYPE_INT32_T, 0, 16, offsetof(mavlink_time_estimate_to_target_t, commanded_action) }, \
  27. } \
  28. }
  29. #else
  30. #define MAVLINK_MESSAGE_INFO_TIME_ESTIMATE_TO_TARGET { \
  31. "TIME_ESTIMATE_TO_TARGET", \
  32. 5, \
  33. { { "safe_return", NULL, MAVLINK_TYPE_INT32_T, 0, 0, offsetof(mavlink_time_estimate_to_target_t, safe_return) }, \
  34. { "land", NULL, MAVLINK_TYPE_INT32_T, 0, 4, offsetof(mavlink_time_estimate_to_target_t, land) }, \
  35. { "mission_next_item", NULL, MAVLINK_TYPE_INT32_T, 0, 8, offsetof(mavlink_time_estimate_to_target_t, mission_next_item) }, \
  36. { "mission_end", NULL, MAVLINK_TYPE_INT32_T, 0, 12, offsetof(mavlink_time_estimate_to_target_t, mission_end) }, \
  37. { "commanded_action", NULL, MAVLINK_TYPE_INT32_T, 0, 16, offsetof(mavlink_time_estimate_to_target_t, commanded_action) }, \
  38. } \
  39. }
  40. #endif
  41. /**
  42. * @brief Pack a time_estimate_to_target message
  43. * @param system_id ID of this system
  44. * @param component_id ID of this component (e.g. 200 for IMU)
  45. * @param msg The MAVLink message to compress the data into
  46. *
  47. * @param safe_return [s] Estimated time to complete the vehicle's configured "safe return" action from its current position (e.g. RTL, Smart RTL, etc.). -1 indicates that the vehicle is landed, or that no time estimate available.
  48. * @param land [s] Estimated time for vehicle to complete the LAND action from its current position. -1 indicates that the vehicle is landed, or that no time estimate available.
  49. * @param mission_next_item [s] Estimated time for reaching/completing the currently active mission item. -1 means no time estimate available.
  50. * @param mission_end [s] Estimated time for completing the current mission. -1 means no mission active and/or no estimate available.
  51. * @param commanded_action [s] Estimated time for completing the current commanded action (i.e. Go To, Takeoff, Land, etc.). -1 means no action active and/or no estimate available.
  52. * @return length of the message in bytes (excluding serial stream start sign)
  53. */
  54. static inline uint16_t mavlink_msg_time_estimate_to_target_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
  55. int32_t safe_return, int32_t land, int32_t mission_next_item, int32_t mission_end, int32_t commanded_action)
  56. {
  57. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  58. char buf[MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_LEN];
  59. _mav_put_int32_t(buf, 0, safe_return);
  60. _mav_put_int32_t(buf, 4, land);
  61. _mav_put_int32_t(buf, 8, mission_next_item);
  62. _mav_put_int32_t(buf, 12, mission_end);
  63. _mav_put_int32_t(buf, 16, commanded_action);
  64. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_LEN);
  65. #else
  66. mavlink_time_estimate_to_target_t packet;
  67. packet.safe_return = safe_return;
  68. packet.land = land;
  69. packet.mission_next_item = mission_next_item;
  70. packet.mission_end = mission_end;
  71. packet.commanded_action = commanded_action;
  72. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_LEN);
  73. #endif
  74. msg->msgid = MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET;
  75. return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_MIN_LEN, MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_LEN, MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_CRC);
  76. }
  77. /**
  78. * @brief Pack a time_estimate_to_target message on a channel
  79. * @param system_id ID of this system
  80. * @param component_id ID of this component (e.g. 200 for IMU)
  81. * @param chan The MAVLink channel this message will be sent over
  82. * @param msg The MAVLink message to compress the data into
  83. * @param safe_return [s] Estimated time to complete the vehicle's configured "safe return" action from its current position (e.g. RTL, Smart RTL, etc.). -1 indicates that the vehicle is landed, or that no time estimate available.
  84. * @param land [s] Estimated time for vehicle to complete the LAND action from its current position. -1 indicates that the vehicle is landed, or that no time estimate available.
  85. * @param mission_next_item [s] Estimated time for reaching/completing the currently active mission item. -1 means no time estimate available.
  86. * @param mission_end [s] Estimated time for completing the current mission. -1 means no mission active and/or no estimate available.
  87. * @param commanded_action [s] Estimated time for completing the current commanded action (i.e. Go To, Takeoff, Land, etc.). -1 means no action active and/or no estimate available.
  88. * @return length of the message in bytes (excluding serial stream start sign)
  89. */
  90. static inline uint16_t mavlink_msg_time_estimate_to_target_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
  91. mavlink_message_t* msg,
  92. int32_t safe_return,int32_t land,int32_t mission_next_item,int32_t mission_end,int32_t commanded_action)
  93. {
  94. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  95. char buf[MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_LEN];
  96. _mav_put_int32_t(buf, 0, safe_return);
  97. _mav_put_int32_t(buf, 4, land);
  98. _mav_put_int32_t(buf, 8, mission_next_item);
  99. _mav_put_int32_t(buf, 12, mission_end);
  100. _mav_put_int32_t(buf, 16, commanded_action);
  101. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_LEN);
  102. #else
  103. mavlink_time_estimate_to_target_t packet;
  104. packet.safe_return = safe_return;
  105. packet.land = land;
  106. packet.mission_next_item = mission_next_item;
  107. packet.mission_end = mission_end;
  108. packet.commanded_action = commanded_action;
  109. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_LEN);
  110. #endif
  111. msg->msgid = MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET;
  112. return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_MIN_LEN, MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_LEN, MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_CRC);
  113. }
  114. /**
  115. * @brief Encode a time_estimate_to_target struct
  116. *
  117. * @param system_id ID of this system
  118. * @param component_id ID of this component (e.g. 200 for IMU)
  119. * @param msg The MAVLink message to compress the data into
  120. * @param time_estimate_to_target C-struct to read the message contents from
  121. */
  122. static inline uint16_t mavlink_msg_time_estimate_to_target_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_time_estimate_to_target_t* time_estimate_to_target)
  123. {
  124. return mavlink_msg_time_estimate_to_target_pack(system_id, component_id, msg, time_estimate_to_target->safe_return, time_estimate_to_target->land, time_estimate_to_target->mission_next_item, time_estimate_to_target->mission_end, time_estimate_to_target->commanded_action);
  125. }
  126. /**
  127. * @brief Encode a time_estimate_to_target struct on a channel
  128. *
  129. * @param system_id ID of this system
  130. * @param component_id ID of this component (e.g. 200 for IMU)
  131. * @param chan The MAVLink channel this message will be sent over
  132. * @param msg The MAVLink message to compress the data into
  133. * @param time_estimate_to_target C-struct to read the message contents from
  134. */
  135. static inline uint16_t mavlink_msg_time_estimate_to_target_encode_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const mavlink_time_estimate_to_target_t* time_estimate_to_target)
  136. {
  137. return mavlink_msg_time_estimate_to_target_pack_chan(system_id, component_id, chan, msg, time_estimate_to_target->safe_return, time_estimate_to_target->land, time_estimate_to_target->mission_next_item, time_estimate_to_target->mission_end, time_estimate_to_target->commanded_action);
  138. }
  139. /**
  140. * @brief Send a time_estimate_to_target message
  141. * @param chan MAVLink channel to send the message
  142. *
  143. * @param safe_return [s] Estimated time to complete the vehicle's configured "safe return" action from its current position (e.g. RTL, Smart RTL, etc.). -1 indicates that the vehicle is landed, or that no time estimate available.
  144. * @param land [s] Estimated time for vehicle to complete the LAND action from its current position. -1 indicates that the vehicle is landed, or that no time estimate available.
  145. * @param mission_next_item [s] Estimated time for reaching/completing the currently active mission item. -1 means no time estimate available.
  146. * @param mission_end [s] Estimated time for completing the current mission. -1 means no mission active and/or no estimate available.
  147. * @param commanded_action [s] Estimated time for completing the current commanded action (i.e. Go To, Takeoff, Land, etc.). -1 means no action active and/or no estimate available.
  148. */
  149. #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
  150. static inline void mavlink_msg_time_estimate_to_target_send(mavlink_channel_t chan, int32_t safe_return, int32_t land, int32_t mission_next_item, int32_t mission_end, int32_t commanded_action)
  151. {
  152. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  153. char buf[MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_LEN];
  154. _mav_put_int32_t(buf, 0, safe_return);
  155. _mav_put_int32_t(buf, 4, land);
  156. _mav_put_int32_t(buf, 8, mission_next_item);
  157. _mav_put_int32_t(buf, 12, mission_end);
  158. _mav_put_int32_t(buf, 16, commanded_action);
  159. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET, buf, MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_MIN_LEN, MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_LEN, MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_CRC);
  160. #else
  161. mavlink_time_estimate_to_target_t packet;
  162. packet.safe_return = safe_return;
  163. packet.land = land;
  164. packet.mission_next_item = mission_next_item;
  165. packet.mission_end = mission_end;
  166. packet.commanded_action = commanded_action;
  167. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET, (const char *)&packet, MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_MIN_LEN, MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_LEN, MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_CRC);
  168. #endif
  169. }
  170. /**
  171. * @brief Send a time_estimate_to_target message
  172. * @param chan MAVLink channel to send the message
  173. * @param struct The MAVLink struct to serialize
  174. */
  175. static inline void mavlink_msg_time_estimate_to_target_send_struct(mavlink_channel_t chan, const mavlink_time_estimate_to_target_t* time_estimate_to_target)
  176. {
  177. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  178. mavlink_msg_time_estimate_to_target_send(chan, time_estimate_to_target->safe_return, time_estimate_to_target->land, time_estimate_to_target->mission_next_item, time_estimate_to_target->mission_end, time_estimate_to_target->commanded_action);
  179. #else
  180. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET, (const char *)time_estimate_to_target, MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_MIN_LEN, MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_LEN, MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_CRC);
  181. #endif
  182. }
  183. #if MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_LEN <= MAVLINK_MAX_PAYLOAD_LEN
  184. /*
  185. This variant of _send() can be used to save stack space by re-using
  186. memory from the receive buffer. The caller provides a
  187. mavlink_message_t which is the size of a full mavlink message. This
  188. is usually the receive buffer for the channel, and allows a reply to an
  189. incoming message with minimum stack space usage.
  190. */
  191. static inline void mavlink_msg_time_estimate_to_target_send_buf(mavlink_message_t *msgbuf, mavlink_channel_t chan, int32_t safe_return, int32_t land, int32_t mission_next_item, int32_t mission_end, int32_t commanded_action)
  192. {
  193. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  194. char *buf = (char *)msgbuf;
  195. _mav_put_int32_t(buf, 0, safe_return);
  196. _mav_put_int32_t(buf, 4, land);
  197. _mav_put_int32_t(buf, 8, mission_next_item);
  198. _mav_put_int32_t(buf, 12, mission_end);
  199. _mav_put_int32_t(buf, 16, commanded_action);
  200. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET, buf, MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_MIN_LEN, MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_LEN, MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_CRC);
  201. #else
  202. mavlink_time_estimate_to_target_t *packet = (mavlink_time_estimate_to_target_t *)msgbuf;
  203. packet->safe_return = safe_return;
  204. packet->land = land;
  205. packet->mission_next_item = mission_next_item;
  206. packet->mission_end = mission_end;
  207. packet->commanded_action = commanded_action;
  208. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET, (const char *)packet, MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_MIN_LEN, MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_LEN, MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_CRC);
  209. #endif
  210. }
  211. #endif
  212. #endif
  213. // MESSAGE TIME_ESTIMATE_TO_TARGET UNPACKING
  214. /**
  215. * @brief Get field safe_return from time_estimate_to_target message
  216. *
  217. * @return [s] Estimated time to complete the vehicle's configured "safe return" action from its current position (e.g. RTL, Smart RTL, etc.). -1 indicates that the vehicle is landed, or that no time estimate available.
  218. */
  219. static inline int32_t mavlink_msg_time_estimate_to_target_get_safe_return(const mavlink_message_t* msg)
  220. {
  221. return _MAV_RETURN_int32_t(msg, 0);
  222. }
  223. /**
  224. * @brief Get field land from time_estimate_to_target message
  225. *
  226. * @return [s] Estimated time for vehicle to complete the LAND action from its current position. -1 indicates that the vehicle is landed, or that no time estimate available.
  227. */
  228. static inline int32_t mavlink_msg_time_estimate_to_target_get_land(const mavlink_message_t* msg)
  229. {
  230. return _MAV_RETURN_int32_t(msg, 4);
  231. }
  232. /**
  233. * @brief Get field mission_next_item from time_estimate_to_target message
  234. *
  235. * @return [s] Estimated time for reaching/completing the currently active mission item. -1 means no time estimate available.
  236. */
  237. static inline int32_t mavlink_msg_time_estimate_to_target_get_mission_next_item(const mavlink_message_t* msg)
  238. {
  239. return _MAV_RETURN_int32_t(msg, 8);
  240. }
  241. /**
  242. * @brief Get field mission_end from time_estimate_to_target message
  243. *
  244. * @return [s] Estimated time for completing the current mission. -1 means no mission active and/or no estimate available.
  245. */
  246. static inline int32_t mavlink_msg_time_estimate_to_target_get_mission_end(const mavlink_message_t* msg)
  247. {
  248. return _MAV_RETURN_int32_t(msg, 12);
  249. }
  250. /**
  251. * @brief Get field commanded_action from time_estimate_to_target message
  252. *
  253. * @return [s] Estimated time for completing the current commanded action (i.e. Go To, Takeoff, Land, etc.). -1 means no action active and/or no estimate available.
  254. */
  255. static inline int32_t mavlink_msg_time_estimate_to_target_get_commanded_action(const mavlink_message_t* msg)
  256. {
  257. return _MAV_RETURN_int32_t(msg, 16);
  258. }
  259. /**
  260. * @brief Decode a time_estimate_to_target message into a struct
  261. *
  262. * @param msg The message to decode
  263. * @param time_estimate_to_target C-struct to decode the message contents into
  264. */
  265. static inline void mavlink_msg_time_estimate_to_target_decode(const mavlink_message_t* msg, mavlink_time_estimate_to_target_t* time_estimate_to_target)
  266. {
  267. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  268. time_estimate_to_target->safe_return = mavlink_msg_time_estimate_to_target_get_safe_return(msg);
  269. time_estimate_to_target->land = mavlink_msg_time_estimate_to_target_get_land(msg);
  270. time_estimate_to_target->mission_next_item = mavlink_msg_time_estimate_to_target_get_mission_next_item(msg);
  271. time_estimate_to_target->mission_end = mavlink_msg_time_estimate_to_target_get_mission_end(msg);
  272. time_estimate_to_target->commanded_action = mavlink_msg_time_estimate_to_target_get_commanded_action(msg);
  273. #else
  274. uint8_t len = msg->len < MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_LEN? msg->len : MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_LEN;
  275. memset(time_estimate_to_target, 0, MAVLINK_MSG_ID_TIME_ESTIMATE_TO_TARGET_LEN);
  276. memcpy(time_estimate_to_target, _MAV_PAYLOAD(msg), len);
  277. #endif
  278. }