lib/main/MAVLink/common/mavlink_msg_terrain_request.h

   1 #pragma once
   2 // MESSAGE TERRAIN_REQUEST PACKING
   3
   4 #define MAVLINK_MSG_ID_TERRAIN_REQUEST 133
   5
   6
   7 typedef struct __mavlink_terrain_request_t {
   8  uint64_t mask; /*<  Bitmask of requested 4x4 grids (row major 8x7 array of grids, 56 bits)*/
   9  int32_t lat; /*< [degE7] Latitude of SW corner of first grid*/
  10  int32_t lon; /*< [degE7] Longitude of SW corner of first grid*/
  11  uint16_t grid_spacing; /*< [m] Grid spacing*/
  12 } mavlink_terrain_request_t;
  13
  14 #define MAVLINK_MSG_ID_TERRAIN_REQUEST_LEN 18
  15 #define MAVLINK_MSG_ID_TERRAIN_REQUEST_MIN_LEN 18
  16 #define MAVLINK_MSG_ID_133_LEN 18
  17 #define MAVLINK_MSG_ID_133_MIN_LEN 18
  18
  19 #define MAVLINK_MSG_ID_TERRAIN_REQUEST_CRC 6
  20 #define MAVLINK_MSG_ID_133_CRC 6
  21
  22
  23
  24 #if MAVLINK_COMMAND_24BIT
  25 #define MAVLINK_MESSAGE_INFO_TERRAIN_REQUEST { \
  26     133, \
  27     "TERRAIN_REQUEST", \
  28     4, \
  29     {  { "lat", NULL, MAVLINK_TYPE_INT32_T, 0, 8, offsetof(mavlink_terrain_request_t, lat) }, \
  30          { "lon", NULL, MAVLINK_TYPE_INT32_T, 0, 12, offsetof(mavlink_terrain_request_t, lon) }, \
  31          { "grid_spacing", NULL, MAVLINK_TYPE_UINT16_T, 0, 16, offsetof(mavlink_terrain_request_t, grid_spacing) }, \
  32          { "mask", "0x%07x", MAVLINK_TYPE_UINT64_T, 0, 0, offsetof(mavlink_terrain_request_t, mask) }, \
  33          } \
  34 }
  35 #else
  36 #define MAVLINK_MESSAGE_INFO_TERRAIN_REQUEST { \
  37     "TERRAIN_REQUEST", \
  38     4, \
  39     {  { "lat", NULL, MAVLINK_TYPE_INT32_T, 0, 8, offsetof(mavlink_terrain_request_t, lat) }, \
  40          { "lon", NULL, MAVLINK_TYPE_INT32_T, 0, 12, offsetof(mavlink_terrain_request_t, lon) }, \
  41          { "grid_spacing", NULL, MAVLINK_TYPE_UINT16_T, 0, 16, offsetof(mavlink_terrain_request_t, grid_spacing) }, \
  42          { "mask", "0x%07x", MAVLINK_TYPE_UINT64_T, 0, 0, offsetof(mavlink_terrain_request_t, mask) }, \
  43          } \
  44 }
  45 #endif
  46
  47 /**
  48  * @brief Pack a terrain_request 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 of SW corner of first grid
  54  * @param lon [degE7] Longitude of SW corner of first grid
  55  * @param grid_spacing [m] Grid spacing
  56  * @param mask  Bitmask of requested 4x4 grids (row major 8x7 array of grids, 56 bits)
  57  * @return length of the message in bytes (excluding serial stream start sign)
  58  */
  59 static inline uint16_t mavlink_msg_terrain_request_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
  60                                int32_t lat, int32_t lon, uint16_t grid_spacing, uint64_t mask)
  61 {
  62 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  63     char buf[MAVLINK_MSG_ID_TERRAIN_REQUEST_LEN];
  64     _mav_put_uint64_t(buf, 0, mask);
  65     _mav_put_int32_t(buf, 8, lat);
  66     _mav_put_int32_t(buf, 12, lon);
  67     _mav_put_uint16_t(buf, 16, grid_spacing);
  68
  69         memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_TERRAIN_REQUEST_LEN);
  70 #else
  71     mavlink_terrain_request_t packet;
  72     packet.mask = mask;
  73     packet.lat = lat;
  74     packet.lon = lon;
  75     packet.grid_spacing = grid_spacing;
  76
  77         memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_TERRAIN_REQUEST_LEN);
  78 #endif
  79
  80     msg->msgid = MAVLINK_MSG_ID_TERRAIN_REQUEST;
  81     return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_TERRAIN_REQUEST_MIN_LEN, MAVLINK_MSG_ID_TERRAIN_REQUEST_LEN, MAVLINK_MSG_ID_TERRAIN_REQUEST_CRC);
  82 }
  83
  84 /**
  85  * @brief Pack a terrain_request message on a channel
  86  * @param system_id ID of this system
  87  * @param component_id ID of this component (e.g. 200 for IMU)
  88  * @param chan The MAVLink channel this message will be sent over
  89  * @param msg The MAVLink message to compress the data into
  90  * @param lat [degE7] Latitude of SW corner of first grid
  91  * @param lon [degE7] Longitude of SW corner of first grid
  92  * @param grid_spacing [m] Grid spacing
  93  * @param mask  Bitmask of requested 4x4 grids (row major 8x7 array of grids, 56 bits)
  94  * @return length of the message in bytes (excluding serial stream start sign)
  95  */
  96 static inline uint16_t mavlink_msg_terrain_request_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
  97                                mavlink_message_t* msg,
  98                                    int32_t lat,int32_t lon,uint16_t grid_spacing,uint64_t mask)
  99 {
 100 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
 101     char buf[MAVLINK_MSG_ID_TERRAIN_REQUEST_LEN];
 102     _mav_put_uint64_t(buf, 0, mask);
 103     _mav_put_int32_t(buf, 8, lat);
 104     _mav_put_int32_t(buf, 12, lon);
 105     _mav_put_uint16_t(buf, 16, grid_spacing);
 106
 107         memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_TERRAIN_REQUEST_LEN);
 108 #else
 109     mavlink_terrain_request_t packet;
 110     packet.mask = mask;
 111     packet.lat = lat;
 112     packet.lon = lon;
 113     packet.grid_spacing = grid_spacing;
 114
 115         memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_TERRAIN_REQUEST_LEN);
 116 #endif
 117
 118     msg->msgid = MAVLINK_MSG_ID_TERRAIN_REQUEST;
 119     return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_TERRAIN_REQUEST_MIN_LEN, MAVLINK_MSG_ID_TERRAIN_REQUEST_LEN, MAVLINK_MSG_ID_TERRAIN_REQUEST_CRC);
 120 }
 121
 122 /**
 123  * @brief Encode a terrain_request struct
 124  *
 125  * @param system_id ID of this system
 126  * @param component_id ID of this component (e.g. 200 for IMU)
 127  * @param msg The MAVLink message to compress the data into
 128  * @param terrain_request C-struct to read the message contents from
 129  */
 130 static inline uint16_t mavlink_msg_terrain_request_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_terrain_request_t* terrain_request)
 131 {
 132     return mavlink_msg_terrain_request_pack(system_id, component_id, msg, terrain_request->lat, terrain_request->lon, terrain_request->grid_spacing, terrain_request->mask);
 133 }
 134
 135 /**
 136  * @brief Encode a terrain_request struct on a channel
 137  *
 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 terrain_request C-struct to read the message contents from
 143  */
 144 static inline uint16_t mavlink_msg_terrain_request_encode_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const mavlink_terrain_request_t* terrain_request)
 145 {
 146     return mavlink_msg_terrain_request_pack_chan(system_id, component_id, chan, msg, terrain_request->lat, terrain_request->lon, terrain_request->grid_spacing, terrain_request->mask);
 147 }
 148
 149 /**
 150  * @brief Send a terrain_request message
 151  * @param chan MAVLink channel to send the message
 152  *
 153  * @param lat [degE7] Latitude of SW corner of first grid
 154  * @param lon [degE7] Longitude of SW corner of first grid
 155  * @param grid_spacing [m] Grid spacing
 156  * @param mask  Bitmask of requested 4x4 grids (row major 8x7 array of grids, 56 bits)
 157  */
 158 #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
 159
 160 static inline void mavlink_msg_terrain_request_send(mavlink_channel_t chan, int32_t lat, int32_t lon, uint16_t grid_spacing, uint64_t mask)
 161 {
 162 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
 163     char buf[MAVLINK_MSG_ID_TERRAIN_REQUEST_LEN];
 164     _mav_put_uint64_t(buf, 0, mask);
 165     _mav_put_int32_t(buf, 8, lat);
 166     _mav_put_int32_t(buf, 12, lon);
 167     _mav_put_uint16_t(buf, 16, grid_spacing);
 168
 169     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_TERRAIN_REQUEST, buf, MAVLINK_MSG_ID_TERRAIN_REQUEST_MIN_LEN, MAVLINK_MSG_ID_TERRAIN_REQUEST_LEN, MAVLINK_MSG_ID_TERRAIN_REQUEST_CRC);
 170 #else
 171     mavlink_terrain_request_t packet;
 172     packet.mask = mask;
 173     packet.lat = lat;
 174     packet.lon = lon;
 175     packet.grid_spacing = grid_spacing;
 176
 177     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_TERRAIN_REQUEST, (const char *)&packet, MAVLINK_MSG_ID_TERRAIN_REQUEST_MIN_LEN, MAVLINK_MSG_ID_TERRAIN_REQUEST_LEN, MAVLINK_MSG_ID_TERRAIN_REQUEST_CRC);
 178 #endif
 179 }
 180
 181 /**
 182  * @brief Send a terrain_request message
 183  * @param chan MAVLink channel to send the message
 184  * @param struct The MAVLink struct to serialize
 185  */
 186 static inline void mavlink_msg_terrain_request_send_struct(mavlink_channel_t chan, const mavlink_terrain_request_t* terrain_request)
 187 {
 188 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
 189     mavlink_msg_terrain_request_send(chan, terrain_request->lat, terrain_request->lon, terrain_request->grid_spacing, terrain_request->mask);
 190 #else
 191     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_TERRAIN_REQUEST, (const char *)terrain_request, MAVLINK_MSG_ID_TERRAIN_REQUEST_MIN_LEN, MAVLINK_MSG_ID_TERRAIN_REQUEST_LEN, MAVLINK_MSG_ID_TERRAIN_REQUEST_CRC);
 192 #endif
 193 }
 194
 195 #if MAVLINK_MSG_ID_TERRAIN_REQUEST_LEN <= MAVLINK_MAX_PAYLOAD_LEN
 196 /*
 197   This varient of _send() can be used to save stack space by re-using
 198   memory from the receive buffer.  The caller provides a
 199   mavlink_message_t which is the size of a full mavlink message. This
 200   is usually the receive buffer for the channel, and allows a reply to an
 201   incoming message with minimum stack space usage.
 202  */
 203 static inline void mavlink_msg_terrain_request_send_buf(mavlink_message_t *msgbuf, mavlink_channel_t chan,  int32_t lat, int32_t lon, uint16_t grid_spacing, uint64_t mask)
 204 {
 205 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
 206     char *buf = (char *)msgbuf;
 207     _mav_put_uint64_t(buf, 0, mask);
 208     _mav_put_int32_t(buf, 8, lat);
 209     _mav_put_int32_t(buf, 12, lon);
 210     _mav_put_uint16_t(buf, 16, grid_spacing);
 211
 212     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_TERRAIN_REQUEST, buf, MAVLINK_MSG_ID_TERRAIN_REQUEST_MIN_LEN, MAVLINK_MSG_ID_TERRAIN_REQUEST_LEN, MAVLINK_MSG_ID_TERRAIN_REQUEST_CRC);
 213 #else
 214     mavlink_terrain_request_t *packet = (mavlink_terrain_request_t *)msgbuf;
 215     packet->mask = mask;
 216     packet->lat = lat;
 217     packet->lon = lon;
 218     packet->grid_spacing = grid_spacing;
 219
 220     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_TERRAIN_REQUEST, (const char *)packet, MAVLINK_MSG_ID_TERRAIN_REQUEST_MIN_LEN, MAVLINK_MSG_ID_TERRAIN_REQUEST_LEN, MAVLINK_MSG_ID_TERRAIN_REQUEST_CRC);
 221 #endif
 222 }
 223 #endif
 224
 225 #endif
 226
 227 // MESSAGE TERRAIN_REQUEST UNPACKING
 228
 229
 230 /**
 231  * @brief Get field lat from terrain_request message
 232  *
 233  * @return [degE7] Latitude of SW corner of first grid
 234  */
 235 static inline int32_t mavlink_msg_terrain_request_get_lat(const mavlink_message_t* msg)
 236 {
 237     return _MAV_RETURN_int32_t(msg,  8);
 238 }
 239
 240 /**
 241  * @brief Get field lon from terrain_request message
 242  *
 243  * @return [degE7] Longitude of SW corner of first grid
 244  */
 245 static inline int32_t mavlink_msg_terrain_request_get_lon(const mavlink_message_t* msg)
 246 {
 247     return _MAV_RETURN_int32_t(msg,  12);
 248 }
 249
 250 /**
 251  * @brief Get field grid_spacing from terrain_request message
 252  *
 253  * @return [m] Grid spacing
 254  */
 255 static inline uint16_t mavlink_msg_terrain_request_get_grid_spacing(const mavlink_message_t* msg)
 256 {
 257     return _MAV_RETURN_uint16_t(msg,  16);
 258 }
 259
 260 /**
 261  * @brief Get field mask from terrain_request message
 262  *
 263  * @return  Bitmask of requested 4x4 grids (row major 8x7 array of grids, 56 bits)
 264  */
 265 static inline uint64_t mavlink_msg_terrain_request_get_mask(const mavlink_message_t* msg)
 266 {
 267     return _MAV_RETURN_uint64_t(msg,  0);
 268 }
 269
 270 /**
 271  * @brief Decode a terrain_request message into a struct
 272  *
 273  * @param msg The message to decode
 274  * @param terrain_request C-struct to decode the message contents into
 275  */
 276 static inline void mavlink_msg_terrain_request_decode(const mavlink_message_t* msg, mavlink_terrain_request_t* terrain_request)
 277 {
 278 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
 279     terrain_request->mask = mavlink_msg_terrain_request_get_mask(msg);
 280     terrain_request->lat = mavlink_msg_terrain_request_get_lat(msg);
 281     terrain_request->lon = mavlink_msg_terrain_request_get_lon(msg);
 282     terrain_request->grid_spacing = mavlink_msg_terrain_request_get_grid_spacing(msg);
 283 #else
 284         uint8_t len = msg->len < MAVLINK_MSG_ID_TERRAIN_REQUEST_LEN? msg->len : MAVLINK_MSG_ID_TERRAIN_REQUEST_LEN;
 285         memset(terrain_request, 0, MAVLINK_MSG_ID_TERRAIN_REQUEST_LEN);
 286     memcpy(terrain_request, _MAV_PAYLOAD(msg), len);
 287 #endif
 288 }