mavlink_msg_altitude.h 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428
  1. #pragma once
  2. // MESSAGE ALTITUDE PACKING
  3. #define MAVLINK_MSG_ID_ALTITUDE 141
  4. typedef struct __mavlink_altitude_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 altitude_monotonic; /*< [m] This altitude measure is initialized on system boot and monotonic (it is never reset, but represents the local altitude change). The only guarantee on this field is that it will never be reset and is consistent within a flight. The recommended value for this field is the uncorrected barometric altitude at boot time. This altitude will also drift and vary between flights.*/
  7. float altitude_amsl; /*< [m] This altitude measure is strictly above mean sea level and might be non-monotonic (it might reset on events like GPS lock or when a new QNH value is set). It should be the altitude to which global altitude waypoints are compared to. Note that it is *not* the GPS altitude, however, most GPS modules already output MSL by default and not the WGS84 altitude.*/
  8. float altitude_local; /*< [m] This is the local altitude in the local coordinate frame. It is not the altitude above home, but in reference to the coordinate origin (0, 0, 0). It is up-positive.*/
  9. float altitude_relative; /*< [m] This is the altitude above the home position. It resets on each change of the current home position.*/
  10. float altitude_terrain; /*< [m] This is the altitude above terrain. It might be fed by a terrain database or an altimeter. Values smaller than -1000 should be interpreted as unknown.*/
  11. float bottom_clearance; /*< [m] This is not the altitude, but the clear space below the system according to the fused clearance estimate. It generally should max out at the maximum range of e.g. the laser altimeter. It is generally a moving target. A negative value indicates no measurement available.*/
  12. } mavlink_altitude_t;
  13. #define MAVLINK_MSG_ID_ALTITUDE_LEN 32
  14. #define MAVLINK_MSG_ID_ALTITUDE_MIN_LEN 32
  15. #define MAVLINK_MSG_ID_141_LEN 32
  16. #define MAVLINK_MSG_ID_141_MIN_LEN 32
  17. #define MAVLINK_MSG_ID_ALTITUDE_CRC 47
  18. #define MAVLINK_MSG_ID_141_CRC 47
  19. #if MAVLINK_COMMAND_24BIT
  20. #define MAVLINK_MESSAGE_INFO_ALTITUDE { \
  21. 141, \
  22. "ALTITUDE", \
  23. 7, \
  24. { { "time_usec", NULL, MAVLINK_TYPE_UINT64_T, 0, 0, offsetof(mavlink_altitude_t, time_usec) }, \
  25. { "altitude_monotonic", NULL, MAVLINK_TYPE_FLOAT, 0, 8, offsetof(mavlink_altitude_t, altitude_monotonic) }, \
  26. { "altitude_amsl", NULL, MAVLINK_TYPE_FLOAT, 0, 12, offsetof(mavlink_altitude_t, altitude_amsl) }, \
  27. { "altitude_local", NULL, MAVLINK_TYPE_FLOAT, 0, 16, offsetof(mavlink_altitude_t, altitude_local) }, \
  28. { "altitude_relative", NULL, MAVLINK_TYPE_FLOAT, 0, 20, offsetof(mavlink_altitude_t, altitude_relative) }, \
  29. { "altitude_terrain", NULL, MAVLINK_TYPE_FLOAT, 0, 24, offsetof(mavlink_altitude_t, altitude_terrain) }, \
  30. { "bottom_clearance", NULL, MAVLINK_TYPE_FLOAT, 0, 28, offsetof(mavlink_altitude_t, bottom_clearance) }, \
  31. } \
  32. }
  33. #else
  34. #define MAVLINK_MESSAGE_INFO_ALTITUDE { \
  35. "ALTITUDE", \
  36. 7, \
  37. { { "time_usec", NULL, MAVLINK_TYPE_UINT64_T, 0, 0, offsetof(mavlink_altitude_t, time_usec) }, \
  38. { "altitude_monotonic", NULL, MAVLINK_TYPE_FLOAT, 0, 8, offsetof(mavlink_altitude_t, altitude_monotonic) }, \
  39. { "altitude_amsl", NULL, MAVLINK_TYPE_FLOAT, 0, 12, offsetof(mavlink_altitude_t, altitude_amsl) }, \
  40. { "altitude_local", NULL, MAVLINK_TYPE_FLOAT, 0, 16, offsetof(mavlink_altitude_t, altitude_local) }, \
  41. { "altitude_relative", NULL, MAVLINK_TYPE_FLOAT, 0, 20, offsetof(mavlink_altitude_t, altitude_relative) }, \
  42. { "altitude_terrain", NULL, MAVLINK_TYPE_FLOAT, 0, 24, offsetof(mavlink_altitude_t, altitude_terrain) }, \
  43. { "bottom_clearance", NULL, MAVLINK_TYPE_FLOAT, 0, 28, offsetof(mavlink_altitude_t, bottom_clearance) }, \
  44. } \
  45. }
  46. #endif
  47. /**
  48. * @brief Pack a altitude 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 altitude_monotonic [m] This altitude measure is initialized on system boot and monotonic (it is never reset, but represents the local altitude change). The only guarantee on this field is that it will never be reset and is consistent within a flight. The recommended value for this field is the uncorrected barometric altitude at boot time. This altitude will also drift and vary between flights.
  55. * @param altitude_amsl [m] This altitude measure is strictly above mean sea level and might be non-monotonic (it might reset on events like GPS lock or when a new QNH value is set). It should be the altitude to which global altitude waypoints are compared to. Note that it is *not* the GPS altitude, however, most GPS modules already output MSL by default and not the WGS84 altitude.
  56. * @param altitude_local [m] This is the local altitude in the local coordinate frame. It is not the altitude above home, but in reference to the coordinate origin (0, 0, 0). It is up-positive.
  57. * @param altitude_relative [m] This is the altitude above the home position. It resets on each change of the current home position.
  58. * @param altitude_terrain [m] This is the altitude above terrain. It might be fed by a terrain database or an altimeter. Values smaller than -1000 should be interpreted as unknown.
  59. * @param bottom_clearance [m] This is not the altitude, but the clear space below the system according to the fused clearance estimate. It generally should max out at the maximum range of e.g. the laser altimeter. It is generally a moving target. A negative value indicates no measurement available.
  60. * @return length of the message in bytes (excluding serial stream start sign)
  61. */
  62. static inline uint16_t mavlink_msg_altitude_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
  63. uint64_t time_usec, float altitude_monotonic, float altitude_amsl, float altitude_local, float altitude_relative, float altitude_terrain, float bottom_clearance)
  64. {
  65. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  66. char buf[MAVLINK_MSG_ID_ALTITUDE_LEN];
  67. _mav_put_uint64_t(buf, 0, time_usec);
  68. _mav_put_float(buf, 8, altitude_monotonic);
  69. _mav_put_float(buf, 12, altitude_amsl);
  70. _mav_put_float(buf, 16, altitude_local);
  71. _mav_put_float(buf, 20, altitude_relative);
  72. _mav_put_float(buf, 24, altitude_terrain);
  73. _mav_put_float(buf, 28, bottom_clearance);
  74. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_ALTITUDE_LEN);
  75. #else
  76. mavlink_altitude_t packet;
  77. packet.time_usec = time_usec;
  78. packet.altitude_monotonic = altitude_monotonic;
  79. packet.altitude_amsl = altitude_amsl;
  80. packet.altitude_local = altitude_local;
  81. packet.altitude_relative = altitude_relative;
  82. packet.altitude_terrain = altitude_terrain;
  83. packet.bottom_clearance = bottom_clearance;
  84. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_ALTITUDE_LEN);
  85. #endif
  86. msg->msgid = MAVLINK_MSG_ID_ALTITUDE;
  87. return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_ALTITUDE_MIN_LEN, MAVLINK_MSG_ID_ALTITUDE_LEN, MAVLINK_MSG_ID_ALTITUDE_CRC);
  88. }
  89. /**
  90. * @brief Pack a altitude message
  91. * @param system_id ID of this system
  92. * @param component_id ID of this component (e.g. 200 for IMU)
  93. * @param status MAVLink status structure
  94. * @param msg The MAVLink message to compress the data into
  95. *
  96. * @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.
  97. * @param altitude_monotonic [m] This altitude measure is initialized on system boot and monotonic (it is never reset, but represents the local altitude change). The only guarantee on this field is that it will never be reset and is consistent within a flight. The recommended value for this field is the uncorrected barometric altitude at boot time. This altitude will also drift and vary between flights.
  98. * @param altitude_amsl [m] This altitude measure is strictly above mean sea level and might be non-monotonic (it might reset on events like GPS lock or when a new QNH value is set). It should be the altitude to which global altitude waypoints are compared to. Note that it is *not* the GPS altitude, however, most GPS modules already output MSL by default and not the WGS84 altitude.
  99. * @param altitude_local [m] This is the local altitude in the local coordinate frame. It is not the altitude above home, but in reference to the coordinate origin (0, 0, 0). It is up-positive.
  100. * @param altitude_relative [m] This is the altitude above the home position. It resets on each change of the current home position.
  101. * @param altitude_terrain [m] This is the altitude above terrain. It might be fed by a terrain database or an altimeter. Values smaller than -1000 should be interpreted as unknown.
  102. * @param bottom_clearance [m] This is not the altitude, but the clear space below the system according to the fused clearance estimate. It generally should max out at the maximum range of e.g. the laser altimeter. It is generally a moving target. A negative value indicates no measurement available.
  103. * @return length of the message in bytes (excluding serial stream start sign)
  104. */
  105. static inline uint16_t mavlink_msg_altitude_pack_status(uint8_t system_id, uint8_t component_id, mavlink_status_t *_status, mavlink_message_t* msg,
  106. uint64_t time_usec, float altitude_monotonic, float altitude_amsl, float altitude_local, float altitude_relative, float altitude_terrain, float bottom_clearance)
  107. {
  108. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  109. char buf[MAVLINK_MSG_ID_ALTITUDE_LEN];
  110. _mav_put_uint64_t(buf, 0, time_usec);
  111. _mav_put_float(buf, 8, altitude_monotonic);
  112. _mav_put_float(buf, 12, altitude_amsl);
  113. _mav_put_float(buf, 16, altitude_local);
  114. _mav_put_float(buf, 20, altitude_relative);
  115. _mav_put_float(buf, 24, altitude_terrain);
  116. _mav_put_float(buf, 28, bottom_clearance);
  117. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_ALTITUDE_LEN);
  118. #else
  119. mavlink_altitude_t packet;
  120. packet.time_usec = time_usec;
  121. packet.altitude_monotonic = altitude_monotonic;
  122. packet.altitude_amsl = altitude_amsl;
  123. packet.altitude_local = altitude_local;
  124. packet.altitude_relative = altitude_relative;
  125. packet.altitude_terrain = altitude_terrain;
  126. packet.bottom_clearance = bottom_clearance;
  127. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_ALTITUDE_LEN);
  128. #endif
  129. msg->msgid = MAVLINK_MSG_ID_ALTITUDE;
  130. #if MAVLINK_CRC_EXTRA
  131. return mavlink_finalize_message_buffer(msg, system_id, component_id, _status, MAVLINK_MSG_ID_ALTITUDE_MIN_LEN, MAVLINK_MSG_ID_ALTITUDE_LEN, MAVLINK_MSG_ID_ALTITUDE_CRC);
  132. #else
  133. return mavlink_finalize_message_buffer(msg, system_id, component_id, _status, MAVLINK_MSG_ID_ALTITUDE_MIN_LEN, MAVLINK_MSG_ID_ALTITUDE_LEN);
  134. #endif
  135. }
  136. /**
  137. * @brief Pack a altitude message on a channel
  138. * @param system_id ID of this system
  139. * @param component_id ID of this component (e.g. 200 for IMU)
  140. * @param chan The MAVLink channel this message will be sent over
  141. * @param msg The MAVLink message to compress the data into
  142. * @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.
  143. * @param altitude_monotonic [m] This altitude measure is initialized on system boot and monotonic (it is never reset, but represents the local altitude change). The only guarantee on this field is that it will never be reset and is consistent within a flight. The recommended value for this field is the uncorrected barometric altitude at boot time. This altitude will also drift and vary between flights.
  144. * @param altitude_amsl [m] This altitude measure is strictly above mean sea level and might be non-monotonic (it might reset on events like GPS lock or when a new QNH value is set). It should be the altitude to which global altitude waypoints are compared to. Note that it is *not* the GPS altitude, however, most GPS modules already output MSL by default and not the WGS84 altitude.
  145. * @param altitude_local [m] This is the local altitude in the local coordinate frame. It is not the altitude above home, but in reference to the coordinate origin (0, 0, 0). It is up-positive.
  146. * @param altitude_relative [m] This is the altitude above the home position. It resets on each change of the current home position.
  147. * @param altitude_terrain [m] This is the altitude above terrain. It might be fed by a terrain database or an altimeter. Values smaller than -1000 should be interpreted as unknown.
  148. * @param bottom_clearance [m] This is not the altitude, but the clear space below the system according to the fused clearance estimate. It generally should max out at the maximum range of e.g. the laser altimeter. It is generally a moving target. A negative value indicates no measurement available.
  149. * @return length of the message in bytes (excluding serial stream start sign)
  150. */
  151. static inline uint16_t mavlink_msg_altitude_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
  152. mavlink_message_t* msg,
  153. uint64_t time_usec,float altitude_monotonic,float altitude_amsl,float altitude_local,float altitude_relative,float altitude_terrain,float bottom_clearance)
  154. {
  155. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  156. char buf[MAVLINK_MSG_ID_ALTITUDE_LEN];
  157. _mav_put_uint64_t(buf, 0, time_usec);
  158. _mav_put_float(buf, 8, altitude_monotonic);
  159. _mav_put_float(buf, 12, altitude_amsl);
  160. _mav_put_float(buf, 16, altitude_local);
  161. _mav_put_float(buf, 20, altitude_relative);
  162. _mav_put_float(buf, 24, altitude_terrain);
  163. _mav_put_float(buf, 28, bottom_clearance);
  164. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_ALTITUDE_LEN);
  165. #else
  166. mavlink_altitude_t packet;
  167. packet.time_usec = time_usec;
  168. packet.altitude_monotonic = altitude_monotonic;
  169. packet.altitude_amsl = altitude_amsl;
  170. packet.altitude_local = altitude_local;
  171. packet.altitude_relative = altitude_relative;
  172. packet.altitude_terrain = altitude_terrain;
  173. packet.bottom_clearance = bottom_clearance;
  174. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_ALTITUDE_LEN);
  175. #endif
  176. msg->msgid = MAVLINK_MSG_ID_ALTITUDE;
  177. return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_ALTITUDE_MIN_LEN, MAVLINK_MSG_ID_ALTITUDE_LEN, MAVLINK_MSG_ID_ALTITUDE_CRC);
  178. }
  179. /**
  180. * @brief Encode a altitude struct
  181. *
  182. * @param system_id ID of this system
  183. * @param component_id ID of this component (e.g. 200 for IMU)
  184. * @param msg The MAVLink message to compress the data into
  185. * @param altitude C-struct to read the message contents from
  186. */
  187. static inline uint16_t mavlink_msg_altitude_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_altitude_t* altitude)
  188. {
  189. return mavlink_msg_altitude_pack(system_id, component_id, msg, altitude->time_usec, altitude->altitude_monotonic, altitude->altitude_amsl, altitude->altitude_local, altitude->altitude_relative, altitude->altitude_terrain, altitude->bottom_clearance);
  190. }
  191. /**
  192. * @brief Encode a altitude struct on a channel
  193. *
  194. * @param system_id ID of this system
  195. * @param component_id ID of this component (e.g. 200 for IMU)
  196. * @param chan The MAVLink channel this message will be sent over
  197. * @param msg The MAVLink message to compress the data into
  198. * @param altitude C-struct to read the message contents from
  199. */
  200. static inline uint16_t mavlink_msg_altitude_encode_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const mavlink_altitude_t* altitude)
  201. {
  202. return mavlink_msg_altitude_pack_chan(system_id, component_id, chan, msg, altitude->time_usec, altitude->altitude_monotonic, altitude->altitude_amsl, altitude->altitude_local, altitude->altitude_relative, altitude->altitude_terrain, altitude->bottom_clearance);
  203. }
  204. /**
  205. * @brief Encode a altitude struct with provided status structure
  206. *
  207. * @param system_id ID of this system
  208. * @param component_id ID of this component (e.g. 200 for IMU)
  209. * @param status MAVLink status structure
  210. * @param msg The MAVLink message to compress the data into
  211. * @param altitude C-struct to read the message contents from
  212. */
  213. static inline uint16_t mavlink_msg_altitude_encode_status(uint8_t system_id, uint8_t component_id, mavlink_status_t* _status, mavlink_message_t* msg, const mavlink_altitude_t* altitude)
  214. {
  215. return mavlink_msg_altitude_pack_status(system_id, component_id, _status, msg, altitude->time_usec, altitude->altitude_monotonic, altitude->altitude_amsl, altitude->altitude_local, altitude->altitude_relative, altitude->altitude_terrain, altitude->bottom_clearance);
  216. }
  217. /**
  218. * @brief Send a altitude message
  219. * @param chan MAVLink channel to send the message
  220. *
  221. * @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.
  222. * @param altitude_monotonic [m] This altitude measure is initialized on system boot and monotonic (it is never reset, but represents the local altitude change). The only guarantee on this field is that it will never be reset and is consistent within a flight. The recommended value for this field is the uncorrected barometric altitude at boot time. This altitude will also drift and vary between flights.
  223. * @param altitude_amsl [m] This altitude measure is strictly above mean sea level and might be non-monotonic (it might reset on events like GPS lock or when a new QNH value is set). It should be the altitude to which global altitude waypoints are compared to. Note that it is *not* the GPS altitude, however, most GPS modules already output MSL by default and not the WGS84 altitude.
  224. * @param altitude_local [m] This is the local altitude in the local coordinate frame. It is not the altitude above home, but in reference to the coordinate origin (0, 0, 0). It is up-positive.
  225. * @param altitude_relative [m] This is the altitude above the home position. It resets on each change of the current home position.
  226. * @param altitude_terrain [m] This is the altitude above terrain. It might be fed by a terrain database or an altimeter. Values smaller than -1000 should be interpreted as unknown.
  227. * @param bottom_clearance [m] This is not the altitude, but the clear space below the system according to the fused clearance estimate. It generally should max out at the maximum range of e.g. the laser altimeter. It is generally a moving target. A negative value indicates no measurement available.
  228. */
  229. #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
  230. static inline void mavlink_msg_altitude_send(mavlink_channel_t chan, uint64_t time_usec, float altitude_monotonic, float altitude_amsl, float altitude_local, float altitude_relative, float altitude_terrain, float bottom_clearance)
  231. {
  232. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  233. char buf[MAVLINK_MSG_ID_ALTITUDE_LEN];
  234. _mav_put_uint64_t(buf, 0, time_usec);
  235. _mav_put_float(buf, 8, altitude_monotonic);
  236. _mav_put_float(buf, 12, altitude_amsl);
  237. _mav_put_float(buf, 16, altitude_local);
  238. _mav_put_float(buf, 20, altitude_relative);
  239. _mav_put_float(buf, 24, altitude_terrain);
  240. _mav_put_float(buf, 28, bottom_clearance);
  241. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_ALTITUDE, buf, MAVLINK_MSG_ID_ALTITUDE_MIN_LEN, MAVLINK_MSG_ID_ALTITUDE_LEN, MAVLINK_MSG_ID_ALTITUDE_CRC);
  242. #else
  243. mavlink_altitude_t packet;
  244. packet.time_usec = time_usec;
  245. packet.altitude_monotonic = altitude_monotonic;
  246. packet.altitude_amsl = altitude_amsl;
  247. packet.altitude_local = altitude_local;
  248. packet.altitude_relative = altitude_relative;
  249. packet.altitude_terrain = altitude_terrain;
  250. packet.bottom_clearance = bottom_clearance;
  251. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_ALTITUDE, (const char *)&packet, MAVLINK_MSG_ID_ALTITUDE_MIN_LEN, MAVLINK_MSG_ID_ALTITUDE_LEN, MAVLINK_MSG_ID_ALTITUDE_CRC);
  252. #endif
  253. }
  254. /**
  255. * @brief Send a altitude message
  256. * @param chan MAVLink channel to send the message
  257. * @param struct The MAVLink struct to serialize
  258. */
  259. static inline void mavlink_msg_altitude_send_struct(mavlink_channel_t chan, const mavlink_altitude_t* altitude)
  260. {
  261. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  262. mavlink_msg_altitude_send(chan, altitude->time_usec, altitude->altitude_monotonic, altitude->altitude_amsl, altitude->altitude_local, altitude->altitude_relative, altitude->altitude_terrain, altitude->bottom_clearance);
  263. #else
  264. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_ALTITUDE, (const char *)altitude, MAVLINK_MSG_ID_ALTITUDE_MIN_LEN, MAVLINK_MSG_ID_ALTITUDE_LEN, MAVLINK_MSG_ID_ALTITUDE_CRC);
  265. #endif
  266. }
  267. #if MAVLINK_MSG_ID_ALTITUDE_LEN <= MAVLINK_MAX_PAYLOAD_LEN
  268. /*
  269. This variant of _send() can be used to save stack space by re-using
  270. memory from the receive buffer. The caller provides a
  271. mavlink_message_t which is the size of a full mavlink message. This
  272. is usually the receive buffer for the channel, and allows a reply to an
  273. incoming message with minimum stack space usage.
  274. */
  275. static inline void mavlink_msg_altitude_send_buf(mavlink_message_t *msgbuf, mavlink_channel_t chan, uint64_t time_usec, float altitude_monotonic, float altitude_amsl, float altitude_local, float altitude_relative, float altitude_terrain, float bottom_clearance)
  276. {
  277. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  278. char *buf = (char *)msgbuf;
  279. _mav_put_uint64_t(buf, 0, time_usec);
  280. _mav_put_float(buf, 8, altitude_monotonic);
  281. _mav_put_float(buf, 12, altitude_amsl);
  282. _mav_put_float(buf, 16, altitude_local);
  283. _mav_put_float(buf, 20, altitude_relative);
  284. _mav_put_float(buf, 24, altitude_terrain);
  285. _mav_put_float(buf, 28, bottom_clearance);
  286. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_ALTITUDE, buf, MAVLINK_MSG_ID_ALTITUDE_MIN_LEN, MAVLINK_MSG_ID_ALTITUDE_LEN, MAVLINK_MSG_ID_ALTITUDE_CRC);
  287. #else
  288. mavlink_altitude_t *packet = (mavlink_altitude_t *)msgbuf;
  289. packet->time_usec = time_usec;
  290. packet->altitude_monotonic = altitude_monotonic;
  291. packet->altitude_amsl = altitude_amsl;
  292. packet->altitude_local = altitude_local;
  293. packet->altitude_relative = altitude_relative;
  294. packet->altitude_terrain = altitude_terrain;
  295. packet->bottom_clearance = bottom_clearance;
  296. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_ALTITUDE, (const char *)packet, MAVLINK_MSG_ID_ALTITUDE_MIN_LEN, MAVLINK_MSG_ID_ALTITUDE_LEN, MAVLINK_MSG_ID_ALTITUDE_CRC);
  297. #endif
  298. }
  299. #endif
  300. #endif
  301. // MESSAGE ALTITUDE UNPACKING
  302. /**
  303. * @brief Get field time_usec from altitude message
  304. *
  305. * @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.
  306. */
  307. static inline uint64_t mavlink_msg_altitude_get_time_usec(const mavlink_message_t* msg)
  308. {
  309. return _MAV_RETURN_uint64_t(msg, 0);
  310. }
  311. /**
  312. * @brief Get field altitude_monotonic from altitude message
  313. *
  314. * @return [m] This altitude measure is initialized on system boot and monotonic (it is never reset, but represents the local altitude change). The only guarantee on this field is that it will never be reset and is consistent within a flight. The recommended value for this field is the uncorrected barometric altitude at boot time. This altitude will also drift and vary between flights.
  315. */
  316. static inline float mavlink_msg_altitude_get_altitude_monotonic(const mavlink_message_t* msg)
  317. {
  318. return _MAV_RETURN_float(msg, 8);
  319. }
  320. /**
  321. * @brief Get field altitude_amsl from altitude message
  322. *
  323. * @return [m] This altitude measure is strictly above mean sea level and might be non-monotonic (it might reset on events like GPS lock or when a new QNH value is set). It should be the altitude to which global altitude waypoints are compared to. Note that it is *not* the GPS altitude, however, most GPS modules already output MSL by default and not the WGS84 altitude.
  324. */
  325. static inline float mavlink_msg_altitude_get_altitude_amsl(const mavlink_message_t* msg)
  326. {
  327. return _MAV_RETURN_float(msg, 12);
  328. }
  329. /**
  330. * @brief Get field altitude_local from altitude message
  331. *
  332. * @return [m] This is the local altitude in the local coordinate frame. It is not the altitude above home, but in reference to the coordinate origin (0, 0, 0). It is up-positive.
  333. */
  334. static inline float mavlink_msg_altitude_get_altitude_local(const mavlink_message_t* msg)
  335. {
  336. return _MAV_RETURN_float(msg, 16);
  337. }
  338. /**
  339. * @brief Get field altitude_relative from altitude message
  340. *
  341. * @return [m] This is the altitude above the home position. It resets on each change of the current home position.
  342. */
  343. static inline float mavlink_msg_altitude_get_altitude_relative(const mavlink_message_t* msg)
  344. {
  345. return _MAV_RETURN_float(msg, 20);
  346. }
  347. /**
  348. * @brief Get field altitude_terrain from altitude message
  349. *
  350. * @return [m] This is the altitude above terrain. It might be fed by a terrain database or an altimeter. Values smaller than -1000 should be interpreted as unknown.
  351. */
  352. static inline float mavlink_msg_altitude_get_altitude_terrain(const mavlink_message_t* msg)
  353. {
  354. return _MAV_RETURN_float(msg, 24);
  355. }
  356. /**
  357. * @brief Get field bottom_clearance from altitude message
  358. *
  359. * @return [m] This is not the altitude, but the clear space below the system according to the fused clearance estimate. It generally should max out at the maximum range of e.g. the laser altimeter. It is generally a moving target. A negative value indicates no measurement available.
  360. */
  361. static inline float mavlink_msg_altitude_get_bottom_clearance(const mavlink_message_t* msg)
  362. {
  363. return _MAV_RETURN_float(msg, 28);
  364. }
  365. /**
  366. * @brief Decode a altitude message into a struct
  367. *
  368. * @param msg The message to decode
  369. * @param altitude C-struct to decode the message contents into
  370. */
  371. static inline void mavlink_msg_altitude_decode(const mavlink_message_t* msg, mavlink_altitude_t* altitude)
  372. {
  373. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  374. altitude->time_usec = mavlink_msg_altitude_get_time_usec(msg);
  375. altitude->altitude_monotonic = mavlink_msg_altitude_get_altitude_monotonic(msg);
  376. altitude->altitude_amsl = mavlink_msg_altitude_get_altitude_amsl(msg);
  377. altitude->altitude_local = mavlink_msg_altitude_get_altitude_local(msg);
  378. altitude->altitude_relative = mavlink_msg_altitude_get_altitude_relative(msg);
  379. altitude->altitude_terrain = mavlink_msg_altitude_get_altitude_terrain(msg);
  380. altitude->bottom_clearance = mavlink_msg_altitude_get_bottom_clearance(msg);
  381. #else
  382. uint8_t len = msg->len < MAVLINK_MSG_ID_ALTITUDE_LEN? msg->len : MAVLINK_MSG_ID_ALTITUDE_LEN;
  383. memset(altitude, 0, MAVLINK_MSG_ID_ALTITUDE_LEN);
  384. memcpy(altitude, _MAV_PAYLOAD(msg), len);
  385. #endif
  386. }