mavlink_msg_terrain_report.h 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363
  1. #pragma once
  2. // MESSAGE TERRAIN_REPORT PACKING
  3. #define MAVLINK_MSG_ID_TERRAIN_REPORT 136
  4. typedef struct __mavlink_terrain_report_t {
  5. int32_t lat; /*< [degE7] Latitude*/
  6. int32_t lon; /*< [degE7] Longitude*/
  7. float terrain_height; /*< [m] Terrain height MSL*/
  8. float current_height; /*< [m] Current vehicle height above lat/lon terrain height*/
  9. uint16_t spacing; /*< grid spacing (zero if terrain at this location unavailable)*/
  10. uint16_t pending; /*< Number of 4x4 terrain blocks waiting to be received or read from disk*/
  11. uint16_t loaded; /*< Number of 4x4 terrain blocks in memory*/
  12. } mavlink_terrain_report_t;
  13. #define MAVLINK_MSG_ID_TERRAIN_REPORT_LEN 22
  14. #define MAVLINK_MSG_ID_TERRAIN_REPORT_MIN_LEN 22
  15. #define MAVLINK_MSG_ID_136_LEN 22
  16. #define MAVLINK_MSG_ID_136_MIN_LEN 22
  17. #define MAVLINK_MSG_ID_TERRAIN_REPORT_CRC 1
  18. #define MAVLINK_MSG_ID_136_CRC 1
  19. #if MAVLINK_COMMAND_24BIT
  20. #define MAVLINK_MESSAGE_INFO_TERRAIN_REPORT { \
  21. 136, \
  22. "TERRAIN_REPORT", \
  23. 7, \
  24. { { "lat", NULL, MAVLINK_TYPE_INT32_T, 0, 0, offsetof(mavlink_terrain_report_t, lat) }, \
  25. { "lon", NULL, MAVLINK_TYPE_INT32_T, 0, 4, offsetof(mavlink_terrain_report_t, lon) }, \
  26. { "spacing", NULL, MAVLINK_TYPE_UINT16_T, 0, 16, offsetof(mavlink_terrain_report_t, spacing) }, \
  27. { "terrain_height", NULL, MAVLINK_TYPE_FLOAT, 0, 8, offsetof(mavlink_terrain_report_t, terrain_height) }, \
  28. { "current_height", NULL, MAVLINK_TYPE_FLOAT, 0, 12, offsetof(mavlink_terrain_report_t, current_height) }, \
  29. { "pending", NULL, MAVLINK_TYPE_UINT16_T, 0, 18, offsetof(mavlink_terrain_report_t, pending) }, \
  30. { "loaded", NULL, MAVLINK_TYPE_UINT16_T, 0, 20, offsetof(mavlink_terrain_report_t, loaded) }, \
  31. } \
  32. }
  33. #else
  34. #define MAVLINK_MESSAGE_INFO_TERRAIN_REPORT { \
  35. "TERRAIN_REPORT", \
  36. 7, \
  37. { { "lat", NULL, MAVLINK_TYPE_INT32_T, 0, 0, offsetof(mavlink_terrain_report_t, lat) }, \
  38. { "lon", NULL, MAVLINK_TYPE_INT32_T, 0, 4, offsetof(mavlink_terrain_report_t, lon) }, \
  39. { "spacing", NULL, MAVLINK_TYPE_UINT16_T, 0, 16, offsetof(mavlink_terrain_report_t, spacing) }, \
  40. { "terrain_height", NULL, MAVLINK_TYPE_FLOAT, 0, 8, offsetof(mavlink_terrain_report_t, terrain_height) }, \
  41. { "current_height", NULL, MAVLINK_TYPE_FLOAT, 0, 12, offsetof(mavlink_terrain_report_t, current_height) }, \
  42. { "pending", NULL, MAVLINK_TYPE_UINT16_T, 0, 18, offsetof(mavlink_terrain_report_t, pending) }, \
  43. { "loaded", NULL, MAVLINK_TYPE_UINT16_T, 0, 20, offsetof(mavlink_terrain_report_t, loaded) }, \
  44. } \
  45. }
  46. #endif
  47. /**
  48. * @brief Pack a terrain_report 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 lat [degE7] Latitude
  54. * @param lon [degE7] Longitude
  55. * @param spacing grid spacing (zero if terrain at this location unavailable)
  56. * @param terrain_height [m] Terrain height MSL
  57. * @param current_height [m] Current vehicle height above lat/lon terrain height
  58. * @param pending Number of 4x4 terrain blocks waiting to be received or read from disk
  59. * @param loaded Number of 4x4 terrain blocks in memory
  60. * @return length of the message in bytes (excluding serial stream start sign)
  61. */
  62. static inline uint16_t mavlink_msg_terrain_report_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
  63. int32_t lat, int32_t lon, uint16_t spacing, float terrain_height, float current_height, uint16_t pending, uint16_t loaded)
  64. {
  65. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  66. char buf[MAVLINK_MSG_ID_TERRAIN_REPORT_LEN];
  67. _mav_put_int32_t(buf, 0, lat);
  68. _mav_put_int32_t(buf, 4, lon);
  69. _mav_put_float(buf, 8, terrain_height);
  70. _mav_put_float(buf, 12, current_height);
  71. _mav_put_uint16_t(buf, 16, spacing);
  72. _mav_put_uint16_t(buf, 18, pending);
  73. _mav_put_uint16_t(buf, 20, loaded);
  74. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_TERRAIN_REPORT_LEN);
  75. #else
  76. mavlink_terrain_report_t packet;
  77. packet.lat = lat;
  78. packet.lon = lon;
  79. packet.terrain_height = terrain_height;
  80. packet.current_height = current_height;
  81. packet.spacing = spacing;
  82. packet.pending = pending;
  83. packet.loaded = loaded;
  84. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_TERRAIN_REPORT_LEN);
  85. #endif
  86. msg->msgid = MAVLINK_MSG_ID_TERRAIN_REPORT;
  87. return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_TERRAIN_REPORT_MIN_LEN, MAVLINK_MSG_ID_TERRAIN_REPORT_LEN, MAVLINK_MSG_ID_TERRAIN_REPORT_CRC);
  88. }
  89. /**
  90. * @brief Pack a terrain_report message on a channel
  91. * @param system_id ID of this system
  92. * @param component_id ID of this component (e.g. 200 for IMU)
  93. * @param chan The MAVLink channel this message will be sent over
  94. * @param msg The MAVLink message to compress the data into
  95. * @param lat [degE7] Latitude
  96. * @param lon [degE7] Longitude
  97. * @param spacing grid spacing (zero if terrain at this location unavailable)
  98. * @param terrain_height [m] Terrain height MSL
  99. * @param current_height [m] Current vehicle height above lat/lon terrain height
  100. * @param pending Number of 4x4 terrain blocks waiting to be received or read from disk
  101. * @param loaded Number of 4x4 terrain blocks in memory
  102. * @return length of the message in bytes (excluding serial stream start sign)
  103. */
  104. static inline uint16_t mavlink_msg_terrain_report_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
  105. mavlink_message_t* msg,
  106. int32_t lat,int32_t lon,uint16_t spacing,float terrain_height,float current_height,uint16_t pending,uint16_t loaded)
  107. {
  108. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  109. char buf[MAVLINK_MSG_ID_TERRAIN_REPORT_LEN];
  110. _mav_put_int32_t(buf, 0, lat);
  111. _mav_put_int32_t(buf, 4, lon);
  112. _mav_put_float(buf, 8, terrain_height);
  113. _mav_put_float(buf, 12, current_height);
  114. _mav_put_uint16_t(buf, 16, spacing);
  115. _mav_put_uint16_t(buf, 18, pending);
  116. _mav_put_uint16_t(buf, 20, loaded);
  117. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_TERRAIN_REPORT_LEN);
  118. #else
  119. mavlink_terrain_report_t packet;
  120. packet.lat = lat;
  121. packet.lon = lon;
  122. packet.terrain_height = terrain_height;
  123. packet.current_height = current_height;
  124. packet.spacing = spacing;
  125. packet.pending = pending;
  126. packet.loaded = loaded;
  127. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_TERRAIN_REPORT_LEN);
  128. #endif
  129. msg->msgid = MAVLINK_MSG_ID_TERRAIN_REPORT;
  130. return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_TERRAIN_REPORT_MIN_LEN, MAVLINK_MSG_ID_TERRAIN_REPORT_LEN, MAVLINK_MSG_ID_TERRAIN_REPORT_CRC);
  131. }
  132. /**
  133. * @brief Encode a terrain_report struct
  134. *
  135. * @param system_id ID of this system
  136. * @param component_id ID of this component (e.g. 200 for IMU)
  137. * @param msg The MAVLink message to compress the data into
  138. * @param terrain_report C-struct to read the message contents from
  139. */
  140. static inline uint16_t mavlink_msg_terrain_report_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_terrain_report_t* terrain_report)
  141. {
  142. return mavlink_msg_terrain_report_pack(system_id, component_id, msg, terrain_report->lat, terrain_report->lon, terrain_report->spacing, terrain_report->terrain_height, terrain_report->current_height, terrain_report->pending, terrain_report->loaded);
  143. }
  144. /**
  145. * @brief Encode a terrain_report struct on a channel
  146. *
  147. * @param system_id ID of this system
  148. * @param component_id ID of this component (e.g. 200 for IMU)
  149. * @param chan The MAVLink channel this message will be sent over
  150. * @param msg The MAVLink message to compress the data into
  151. * @param terrain_report C-struct to read the message contents from
  152. */
  153. static inline uint16_t mavlink_msg_terrain_report_encode_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const mavlink_terrain_report_t* terrain_report)
  154. {
  155. return mavlink_msg_terrain_report_pack_chan(system_id, component_id, chan, msg, terrain_report->lat, terrain_report->lon, terrain_report->spacing, terrain_report->terrain_height, terrain_report->current_height, terrain_report->pending, terrain_report->loaded);
  156. }
  157. /**
  158. * @brief Send a terrain_report message
  159. * @param chan MAVLink channel to send the message
  160. *
  161. * @param lat [degE7] Latitude
  162. * @param lon [degE7] Longitude
  163. * @param spacing grid spacing (zero if terrain at this location unavailable)
  164. * @param terrain_height [m] Terrain height MSL
  165. * @param current_height [m] Current vehicle height above lat/lon terrain height
  166. * @param pending Number of 4x4 terrain blocks waiting to be received or read from disk
  167. * @param loaded Number of 4x4 terrain blocks in memory
  168. */
  169. #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
  170. static inline void mavlink_msg_terrain_report_send(mavlink_channel_t chan, int32_t lat, int32_t lon, uint16_t spacing, float terrain_height, float current_height, uint16_t pending, uint16_t loaded)
  171. {
  172. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  173. char buf[MAVLINK_MSG_ID_TERRAIN_REPORT_LEN];
  174. _mav_put_int32_t(buf, 0, lat);
  175. _mav_put_int32_t(buf, 4, lon);
  176. _mav_put_float(buf, 8, terrain_height);
  177. _mav_put_float(buf, 12, current_height);
  178. _mav_put_uint16_t(buf, 16, spacing);
  179. _mav_put_uint16_t(buf, 18, pending);
  180. _mav_put_uint16_t(buf, 20, loaded);
  181. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_TERRAIN_REPORT, buf, MAVLINK_MSG_ID_TERRAIN_REPORT_MIN_LEN, MAVLINK_MSG_ID_TERRAIN_REPORT_LEN, MAVLINK_MSG_ID_TERRAIN_REPORT_CRC);
  182. #else
  183. mavlink_terrain_report_t packet;
  184. packet.lat = lat;
  185. packet.lon = lon;
  186. packet.terrain_height = terrain_height;
  187. packet.current_height = current_height;
  188. packet.spacing = spacing;
  189. packet.pending = pending;
  190. packet.loaded = loaded;
  191. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_TERRAIN_REPORT, (const char *)&packet, MAVLINK_MSG_ID_TERRAIN_REPORT_MIN_LEN, MAVLINK_MSG_ID_TERRAIN_REPORT_LEN, MAVLINK_MSG_ID_TERRAIN_REPORT_CRC);
  192. #endif
  193. }
  194. /**
  195. * @brief Send a terrain_report message
  196. * @param chan MAVLink channel to send the message
  197. * @param struct The MAVLink struct to serialize
  198. */
  199. static inline void mavlink_msg_terrain_report_send_struct(mavlink_channel_t chan, const mavlink_terrain_report_t* terrain_report)
  200. {
  201. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  202. mavlink_msg_terrain_report_send(chan, terrain_report->lat, terrain_report->lon, terrain_report->spacing, terrain_report->terrain_height, terrain_report->current_height, terrain_report->pending, terrain_report->loaded);
  203. #else
  204. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_TERRAIN_REPORT, (const char *)terrain_report, MAVLINK_MSG_ID_TERRAIN_REPORT_MIN_LEN, MAVLINK_MSG_ID_TERRAIN_REPORT_LEN, MAVLINK_MSG_ID_TERRAIN_REPORT_CRC);
  205. #endif
  206. }
  207. #if MAVLINK_MSG_ID_TERRAIN_REPORT_LEN <= MAVLINK_MAX_PAYLOAD_LEN
  208. /*
  209. This variant of _send() can be used to save stack space by re-using
  210. memory from the receive buffer. The caller provides a
  211. mavlink_message_t which is the size of a full mavlink message. This
  212. is usually the receive buffer for the channel, and allows a reply to an
  213. incoming message with minimum stack space usage.
  214. */
  215. static inline void mavlink_msg_terrain_report_send_buf(mavlink_message_t *msgbuf, mavlink_channel_t chan, int32_t lat, int32_t lon, uint16_t spacing, float terrain_height, float current_height, uint16_t pending, uint16_t loaded)
  216. {
  217. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  218. char *buf = (char *)msgbuf;
  219. _mav_put_int32_t(buf, 0, lat);
  220. _mav_put_int32_t(buf, 4, lon);
  221. _mav_put_float(buf, 8, terrain_height);
  222. _mav_put_float(buf, 12, current_height);
  223. _mav_put_uint16_t(buf, 16, spacing);
  224. _mav_put_uint16_t(buf, 18, pending);
  225. _mav_put_uint16_t(buf, 20, loaded);
  226. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_TERRAIN_REPORT, buf, MAVLINK_MSG_ID_TERRAIN_REPORT_MIN_LEN, MAVLINK_MSG_ID_TERRAIN_REPORT_LEN, MAVLINK_MSG_ID_TERRAIN_REPORT_CRC);
  227. #else
  228. mavlink_terrain_report_t *packet = (mavlink_terrain_report_t *)msgbuf;
  229. packet->lat = lat;
  230. packet->lon = lon;
  231. packet->terrain_height = terrain_height;
  232. packet->current_height = current_height;
  233. packet->spacing = spacing;
  234. packet->pending = pending;
  235. packet->loaded = loaded;
  236. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_TERRAIN_REPORT, (const char *)packet, MAVLINK_MSG_ID_TERRAIN_REPORT_MIN_LEN, MAVLINK_MSG_ID_TERRAIN_REPORT_LEN, MAVLINK_MSG_ID_TERRAIN_REPORT_CRC);
  237. #endif
  238. }
  239. #endif
  240. #endif
  241. // MESSAGE TERRAIN_REPORT UNPACKING
  242. /**
  243. * @brief Get field lat from terrain_report message
  244. *
  245. * @return [degE7] Latitude
  246. */
  247. static inline int32_t mavlink_msg_terrain_report_get_lat(const mavlink_message_t* msg)
  248. {
  249. return _MAV_RETURN_int32_t(msg, 0);
  250. }
  251. /**
  252. * @brief Get field lon from terrain_report message
  253. *
  254. * @return [degE7] Longitude
  255. */
  256. static inline int32_t mavlink_msg_terrain_report_get_lon(const mavlink_message_t* msg)
  257. {
  258. return _MAV_RETURN_int32_t(msg, 4);
  259. }
  260. /**
  261. * @brief Get field spacing from terrain_report message
  262. *
  263. * @return grid spacing (zero if terrain at this location unavailable)
  264. */
  265. static inline uint16_t mavlink_msg_terrain_report_get_spacing(const mavlink_message_t* msg)
  266. {
  267. return _MAV_RETURN_uint16_t(msg, 16);
  268. }
  269. /**
  270. * @brief Get field terrain_height from terrain_report message
  271. *
  272. * @return [m] Terrain height MSL
  273. */
  274. static inline float mavlink_msg_terrain_report_get_terrain_height(const mavlink_message_t* msg)
  275. {
  276. return _MAV_RETURN_float(msg, 8);
  277. }
  278. /**
  279. * @brief Get field current_height from terrain_report message
  280. *
  281. * @return [m] Current vehicle height above lat/lon terrain height
  282. */
  283. static inline float mavlink_msg_terrain_report_get_current_height(const mavlink_message_t* msg)
  284. {
  285. return _MAV_RETURN_float(msg, 12);
  286. }
  287. /**
  288. * @brief Get field pending from terrain_report message
  289. *
  290. * @return Number of 4x4 terrain blocks waiting to be received or read from disk
  291. */
  292. static inline uint16_t mavlink_msg_terrain_report_get_pending(const mavlink_message_t* msg)
  293. {
  294. return _MAV_RETURN_uint16_t(msg, 18);
  295. }
  296. /**
  297. * @brief Get field loaded from terrain_report message
  298. *
  299. * @return Number of 4x4 terrain blocks in memory
  300. */
  301. static inline uint16_t mavlink_msg_terrain_report_get_loaded(const mavlink_message_t* msg)
  302. {
  303. return _MAV_RETURN_uint16_t(msg, 20);
  304. }
  305. /**
  306. * @brief Decode a terrain_report message into a struct
  307. *
  308. * @param msg The message to decode
  309. * @param terrain_report C-struct to decode the message contents into
  310. */
  311. static inline void mavlink_msg_terrain_report_decode(const mavlink_message_t* msg, mavlink_terrain_report_t* terrain_report)
  312. {
  313. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  314. terrain_report->lat = mavlink_msg_terrain_report_get_lat(msg);
  315. terrain_report->lon = mavlink_msg_terrain_report_get_lon(msg);
  316. terrain_report->terrain_height = mavlink_msg_terrain_report_get_terrain_height(msg);
  317. terrain_report->current_height = mavlink_msg_terrain_report_get_current_height(msg);
  318. terrain_report->spacing = mavlink_msg_terrain_report_get_spacing(msg);
  319. terrain_report->pending = mavlink_msg_terrain_report_get_pending(msg);
  320. terrain_report->loaded = mavlink_msg_terrain_report_get_loaded(msg);
  321. #else
  322. uint8_t len = msg->len < MAVLINK_MSG_ID_TERRAIN_REPORT_LEN? msg->len : MAVLINK_MSG_ID_TERRAIN_REPORT_LEN;
  323. memset(terrain_report, 0, MAVLINK_MSG_ID_TERRAIN_REPORT_LEN);
  324. memcpy(terrain_report, _MAV_PAYLOAD(msg), len);
  325. #endif
  326. }