mavlink_msg_extended_sys_state.h 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238
  1. #pragma once
  2. // MESSAGE EXTENDED_SYS_STATE PACKING
  3. #define MAVLINK_MSG_ID_EXTENDED_SYS_STATE 245
  4. typedef struct __mavlink_extended_sys_state_t {
  5. uint8_t vtol_state; /*< The VTOL state if applicable. Is set to MAV_VTOL_STATE_UNDEFINED if UAV is not in VTOL configuration.*/
  6. uint8_t landed_state; /*< The landed state. Is set to MAV_LANDED_STATE_UNDEFINED if landed state is unknown.*/
  7. } mavlink_extended_sys_state_t;
  8. #define MAVLINK_MSG_ID_EXTENDED_SYS_STATE_LEN 2
  9. #define MAVLINK_MSG_ID_EXTENDED_SYS_STATE_MIN_LEN 2
  10. #define MAVLINK_MSG_ID_245_LEN 2
  11. #define MAVLINK_MSG_ID_245_MIN_LEN 2
  12. #define MAVLINK_MSG_ID_EXTENDED_SYS_STATE_CRC 130
  13. #define MAVLINK_MSG_ID_245_CRC 130
  14. #if MAVLINK_COMMAND_24BIT
  15. #define MAVLINK_MESSAGE_INFO_EXTENDED_SYS_STATE { \
  16. 245, \
  17. "EXTENDED_SYS_STATE", \
  18. 2, \
  19. { { "vtol_state", NULL, MAVLINK_TYPE_UINT8_T, 0, 0, offsetof(mavlink_extended_sys_state_t, vtol_state) }, \
  20. { "landed_state", NULL, MAVLINK_TYPE_UINT8_T, 0, 1, offsetof(mavlink_extended_sys_state_t, landed_state) }, \
  21. } \
  22. }
  23. #else
  24. #define MAVLINK_MESSAGE_INFO_EXTENDED_SYS_STATE { \
  25. "EXTENDED_SYS_STATE", \
  26. 2, \
  27. { { "vtol_state", NULL, MAVLINK_TYPE_UINT8_T, 0, 0, offsetof(mavlink_extended_sys_state_t, vtol_state) }, \
  28. { "landed_state", NULL, MAVLINK_TYPE_UINT8_T, 0, 1, offsetof(mavlink_extended_sys_state_t, landed_state) }, \
  29. } \
  30. }
  31. #endif
  32. /**
  33. * @brief Pack a extended_sys_state message
  34. * @param system_id ID of this system
  35. * @param component_id ID of this component (e.g. 200 for IMU)
  36. * @param msg The MAVLink message to compress the data into
  37. *
  38. * @param vtol_state The VTOL state if applicable. Is set to MAV_VTOL_STATE_UNDEFINED if UAV is not in VTOL configuration.
  39. * @param landed_state The landed state. Is set to MAV_LANDED_STATE_UNDEFINED if landed state is unknown.
  40. * @return length of the message in bytes (excluding serial stream start sign)
  41. */
  42. static inline uint16_t mavlink_msg_extended_sys_state_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
  43. uint8_t vtol_state, uint8_t landed_state)
  44. {
  45. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  46. char buf[MAVLINK_MSG_ID_EXTENDED_SYS_STATE_LEN];
  47. _mav_put_uint8_t(buf, 0, vtol_state);
  48. _mav_put_uint8_t(buf, 1, landed_state);
  49. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_EXTENDED_SYS_STATE_LEN);
  50. #else
  51. mavlink_extended_sys_state_t packet;
  52. packet.vtol_state = vtol_state;
  53. packet.landed_state = landed_state;
  54. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_EXTENDED_SYS_STATE_LEN);
  55. #endif
  56. msg->msgid = MAVLINK_MSG_ID_EXTENDED_SYS_STATE;
  57. return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_EXTENDED_SYS_STATE_MIN_LEN, MAVLINK_MSG_ID_EXTENDED_SYS_STATE_LEN, MAVLINK_MSG_ID_EXTENDED_SYS_STATE_CRC);
  58. }
  59. /**
  60. * @brief Pack a extended_sys_state message on a channel
  61. * @param system_id ID of this system
  62. * @param component_id ID of this component (e.g. 200 for IMU)
  63. * @param chan The MAVLink channel this message will be sent over
  64. * @param msg The MAVLink message to compress the data into
  65. * @param vtol_state The VTOL state if applicable. Is set to MAV_VTOL_STATE_UNDEFINED if UAV is not in VTOL configuration.
  66. * @param landed_state The landed state. Is set to MAV_LANDED_STATE_UNDEFINED if landed state is unknown.
  67. * @return length of the message in bytes (excluding serial stream start sign)
  68. */
  69. static inline uint16_t mavlink_msg_extended_sys_state_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
  70. mavlink_message_t* msg,
  71. uint8_t vtol_state,uint8_t landed_state)
  72. {
  73. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  74. char buf[MAVLINK_MSG_ID_EXTENDED_SYS_STATE_LEN];
  75. _mav_put_uint8_t(buf, 0, vtol_state);
  76. _mav_put_uint8_t(buf, 1, landed_state);
  77. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_EXTENDED_SYS_STATE_LEN);
  78. #else
  79. mavlink_extended_sys_state_t packet;
  80. packet.vtol_state = vtol_state;
  81. packet.landed_state = landed_state;
  82. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_EXTENDED_SYS_STATE_LEN);
  83. #endif
  84. msg->msgid = MAVLINK_MSG_ID_EXTENDED_SYS_STATE;
  85. return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_EXTENDED_SYS_STATE_MIN_LEN, MAVLINK_MSG_ID_EXTENDED_SYS_STATE_LEN, MAVLINK_MSG_ID_EXTENDED_SYS_STATE_CRC);
  86. }
  87. /**
  88. * @brief Encode a extended_sys_state struct
  89. *
  90. * @param system_id ID of this system
  91. * @param component_id ID of this component (e.g. 200 for IMU)
  92. * @param msg The MAVLink message to compress the data into
  93. * @param extended_sys_state C-struct to read the message contents from
  94. */
  95. static inline uint16_t mavlink_msg_extended_sys_state_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_extended_sys_state_t* extended_sys_state)
  96. {
  97. return mavlink_msg_extended_sys_state_pack(system_id, component_id, msg, extended_sys_state->vtol_state, extended_sys_state->landed_state);
  98. }
  99. /**
  100. * @brief Encode a extended_sys_state struct on a channel
  101. *
  102. * @param system_id ID of this system
  103. * @param component_id ID of this component (e.g. 200 for IMU)
  104. * @param chan The MAVLink channel this message will be sent over
  105. * @param msg The MAVLink message to compress the data into
  106. * @param extended_sys_state C-struct to read the message contents from
  107. */
  108. static inline uint16_t mavlink_msg_extended_sys_state_encode_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const mavlink_extended_sys_state_t* extended_sys_state)
  109. {
  110. return mavlink_msg_extended_sys_state_pack_chan(system_id, component_id, chan, msg, extended_sys_state->vtol_state, extended_sys_state->landed_state);
  111. }
  112. /**
  113. * @brief Send a extended_sys_state message
  114. * @param chan MAVLink channel to send the message
  115. *
  116. * @param vtol_state The VTOL state if applicable. Is set to MAV_VTOL_STATE_UNDEFINED if UAV is not in VTOL configuration.
  117. * @param landed_state The landed state. Is set to MAV_LANDED_STATE_UNDEFINED if landed state is unknown.
  118. */
  119. #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
  120. static inline void mavlink_msg_extended_sys_state_send(mavlink_channel_t chan, uint8_t vtol_state, uint8_t landed_state)
  121. {
  122. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  123. char buf[MAVLINK_MSG_ID_EXTENDED_SYS_STATE_LEN];
  124. _mav_put_uint8_t(buf, 0, vtol_state);
  125. _mav_put_uint8_t(buf, 1, landed_state);
  126. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_EXTENDED_SYS_STATE, buf, MAVLINK_MSG_ID_EXTENDED_SYS_STATE_MIN_LEN, MAVLINK_MSG_ID_EXTENDED_SYS_STATE_LEN, MAVLINK_MSG_ID_EXTENDED_SYS_STATE_CRC);
  127. #else
  128. mavlink_extended_sys_state_t packet;
  129. packet.vtol_state = vtol_state;
  130. packet.landed_state = landed_state;
  131. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_EXTENDED_SYS_STATE, (const char *)&packet, MAVLINK_MSG_ID_EXTENDED_SYS_STATE_MIN_LEN, MAVLINK_MSG_ID_EXTENDED_SYS_STATE_LEN, MAVLINK_MSG_ID_EXTENDED_SYS_STATE_CRC);
  132. #endif
  133. }
  134. /**
  135. * @brief Send a extended_sys_state message
  136. * @param chan MAVLink channel to send the message
  137. * @param struct The MAVLink struct to serialize
  138. */
  139. static inline void mavlink_msg_extended_sys_state_send_struct(mavlink_channel_t chan, const mavlink_extended_sys_state_t* extended_sys_state)
  140. {
  141. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  142. mavlink_msg_extended_sys_state_send(chan, extended_sys_state->vtol_state, extended_sys_state->landed_state);
  143. #else
  144. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_EXTENDED_SYS_STATE, (const char *)extended_sys_state, MAVLINK_MSG_ID_EXTENDED_SYS_STATE_MIN_LEN, MAVLINK_MSG_ID_EXTENDED_SYS_STATE_LEN, MAVLINK_MSG_ID_EXTENDED_SYS_STATE_CRC);
  145. #endif
  146. }
  147. #if MAVLINK_MSG_ID_EXTENDED_SYS_STATE_LEN <= MAVLINK_MAX_PAYLOAD_LEN
  148. /*
  149. This variant of _send() can be used to save stack space by re-using
  150. memory from the receive buffer. The caller provides a
  151. mavlink_message_t which is the size of a full mavlink message. This
  152. is usually the receive buffer for the channel, and allows a reply to an
  153. incoming message with minimum stack space usage.
  154. */
  155. static inline void mavlink_msg_extended_sys_state_send_buf(mavlink_message_t *msgbuf, mavlink_channel_t chan, uint8_t vtol_state, uint8_t landed_state)
  156. {
  157. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  158. char *buf = (char *)msgbuf;
  159. _mav_put_uint8_t(buf, 0, vtol_state);
  160. _mav_put_uint8_t(buf, 1, landed_state);
  161. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_EXTENDED_SYS_STATE, buf, MAVLINK_MSG_ID_EXTENDED_SYS_STATE_MIN_LEN, MAVLINK_MSG_ID_EXTENDED_SYS_STATE_LEN, MAVLINK_MSG_ID_EXTENDED_SYS_STATE_CRC);
  162. #else
  163. mavlink_extended_sys_state_t *packet = (mavlink_extended_sys_state_t *)msgbuf;
  164. packet->vtol_state = vtol_state;
  165. packet->landed_state = landed_state;
  166. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_EXTENDED_SYS_STATE, (const char *)packet, MAVLINK_MSG_ID_EXTENDED_SYS_STATE_MIN_LEN, MAVLINK_MSG_ID_EXTENDED_SYS_STATE_LEN, MAVLINK_MSG_ID_EXTENDED_SYS_STATE_CRC);
  167. #endif
  168. }
  169. #endif
  170. #endif
  171. // MESSAGE EXTENDED_SYS_STATE UNPACKING
  172. /**
  173. * @brief Get field vtol_state from extended_sys_state message
  174. *
  175. * @return The VTOL state if applicable. Is set to MAV_VTOL_STATE_UNDEFINED if UAV is not in VTOL configuration.
  176. */
  177. static inline uint8_t mavlink_msg_extended_sys_state_get_vtol_state(const mavlink_message_t* msg)
  178. {
  179. return _MAV_RETURN_uint8_t(msg, 0);
  180. }
  181. /**
  182. * @brief Get field landed_state from extended_sys_state message
  183. *
  184. * @return The landed state. Is set to MAV_LANDED_STATE_UNDEFINED if landed state is unknown.
  185. */
  186. static inline uint8_t mavlink_msg_extended_sys_state_get_landed_state(const mavlink_message_t* msg)
  187. {
  188. return _MAV_RETURN_uint8_t(msg, 1);
  189. }
  190. /**
  191. * @brief Decode a extended_sys_state message into a struct
  192. *
  193. * @param msg The message to decode
  194. * @param extended_sys_state C-struct to decode the message contents into
  195. */
  196. static inline void mavlink_msg_extended_sys_state_decode(const mavlink_message_t* msg, mavlink_extended_sys_state_t* extended_sys_state)
  197. {
  198. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  199. extended_sys_state->vtol_state = mavlink_msg_extended_sys_state_get_vtol_state(msg);
  200. extended_sys_state->landed_state = mavlink_msg_extended_sys_state_get_landed_state(msg);
  201. #else
  202. uint8_t len = msg->len < MAVLINK_MSG_ID_EXTENDED_SYS_STATE_LEN? msg->len : MAVLINK_MSG_ID_EXTENDED_SYS_STATE_LEN;
  203. memset(extended_sys_state, 0, MAVLINK_MSG_ID_EXTENDED_SYS_STATE_LEN);
  204. memcpy(extended_sys_state, _MAV_PAYLOAD(msg), len);
  205. #endif
  206. }