mavlink_msg_altitude.h

Go to the documentation of this file.

// MESSAGE ALTITUDE PACKING

#define MAVLINK_MSG_ID_ALTITUDE 141

typedef struct __mavlink_altitude_t
{
 uint64_t time_usec; /*< Timestamp (milliseconds since system boot)*/
 float altitude_monotonic; /*< 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.*/
 float altitude_amsl; /*< 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 AMSL by default and not the WGS84 altitude.*/
 float altitude_local; /*< 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.*/
 float altitude_relative; /*< This is the altitude above the home position. It resets on each change of the current home position.*/
 float altitude_terrain; /*< 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.*/
 float bottom_clearance; /*< 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.*/
} mavlink_altitude_t;

#define MAVLINK_MSG_ID_ALTITUDE_LEN 32
#define MAVLINK_MSG_ID_141_LEN 32

#define MAVLINK_MSG_ID_ALTITUDE_CRC 47
#define MAVLINK_MSG_ID_141_CRC 47



#define MAVLINK_MESSAGE_INFO_ALTITUDE { \
        "ALTITUDE", \
        7, \
        {  { "time_usec", NULL, MAVLINK_TYPE_UINT64_T, 0, 0, offsetof(mavlink_altitude_t, time_usec) }, \
         { "altitude_monotonic", NULL, MAVLINK_TYPE_FLOAT, 0, 8, offsetof(mavlink_altitude_t, altitude_monotonic) }, \
         { "altitude_amsl", NULL, MAVLINK_TYPE_FLOAT, 0, 12, offsetof(mavlink_altitude_t, altitude_amsl) }, \
         { "altitude_local", NULL, MAVLINK_TYPE_FLOAT, 0, 16, offsetof(mavlink_altitude_t, altitude_local) }, \
         { "altitude_relative", NULL, MAVLINK_TYPE_FLOAT, 0, 20, offsetof(mavlink_altitude_t, altitude_relative) }, \
         { "altitude_terrain", NULL, MAVLINK_TYPE_FLOAT, 0, 24, offsetof(mavlink_altitude_t, altitude_terrain) }, \
         { "bottom_clearance", NULL, MAVLINK_TYPE_FLOAT, 0, 28, offsetof(mavlink_altitude_t, bottom_clearance) }, \
         } \
}


static inline uint16_t mavlink_msg_altitude_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
                                                       uint64_t time_usec, float altitude_monotonic, float altitude_amsl, float altitude_local, float altitude_relative, float altitude_terrain, float bottom_clearance)
{
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
        char buf[MAVLINK_MSG_ID_ALTITUDE_LEN];
        _mav_put_uint64_t(buf, 0, time_usec);
        _mav_put_float(buf, 8, altitude_monotonic);
        _mav_put_float(buf, 12, altitude_amsl);
        _mav_put_float(buf, 16, altitude_local);
        _mav_put_float(buf, 20, altitude_relative);
        _mav_put_float(buf, 24, altitude_terrain);
        _mav_put_float(buf, 28, bottom_clearance);

        memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_ALTITUDE_LEN);
#else
        mavlink_altitude_t packet;
        packet.time_usec = time_usec;
        packet.altitude_monotonic = altitude_monotonic;
        packet.altitude_amsl = altitude_amsl;
        packet.altitude_local = altitude_local;
        packet.altitude_relative = altitude_relative;
        packet.altitude_terrain = altitude_terrain;
        packet.bottom_clearance = bottom_clearance;

        memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_ALTITUDE_LEN);
#endif

        msg->msgid = MAVLINK_MSG_ID_ALTITUDE;
#if MAVLINK_CRC_EXTRA
    return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_ALTITUDE_LEN, MAVLINK_MSG_ID_ALTITUDE_CRC);
#else
    return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_ALTITUDE_LEN);
#endif
}

static inline uint16_t mavlink_msg_altitude_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
                                                           mavlink_message_t* msg,
                                                           uint64_t time_usec,float altitude_monotonic,float altitude_amsl,float altitude_local,float altitude_relative,float altitude_terrain,float bottom_clearance)
{
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
        char buf[MAVLINK_MSG_ID_ALTITUDE_LEN];
        _mav_put_uint64_t(buf, 0, time_usec);
        _mav_put_float(buf, 8, altitude_monotonic);
        _mav_put_float(buf, 12, altitude_amsl);
        _mav_put_float(buf, 16, altitude_local);
        _mav_put_float(buf, 20, altitude_relative);
        _mav_put_float(buf, 24, altitude_terrain);
        _mav_put_float(buf, 28, bottom_clearance);

        memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_ALTITUDE_LEN);
#else
        mavlink_altitude_t packet;
        packet.time_usec = time_usec;
        packet.altitude_monotonic = altitude_monotonic;
        packet.altitude_amsl = altitude_amsl;
        packet.altitude_local = altitude_local;
        packet.altitude_relative = altitude_relative;
        packet.altitude_terrain = altitude_terrain;
        packet.bottom_clearance = bottom_clearance;

        memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_ALTITUDE_LEN);
#endif

        msg->msgid = MAVLINK_MSG_ID_ALTITUDE;
#if MAVLINK_CRC_EXTRA
    return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_ALTITUDE_LEN, MAVLINK_MSG_ID_ALTITUDE_CRC);
#else
    return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_ALTITUDE_LEN);
#endif
}

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)
{
        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);
}

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)
{
        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);
}

#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

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)
{
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
        char buf[MAVLINK_MSG_ID_ALTITUDE_LEN];
        _mav_put_uint64_t(buf, 0, time_usec);
        _mav_put_float(buf, 8, altitude_monotonic);
        _mav_put_float(buf, 12, altitude_amsl);
        _mav_put_float(buf, 16, altitude_local);
        _mav_put_float(buf, 20, altitude_relative);
        _mav_put_float(buf, 24, altitude_terrain);
        _mav_put_float(buf, 28, bottom_clearance);

#if MAVLINK_CRC_EXTRA
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_ALTITUDE, buf, MAVLINK_MSG_ID_ALTITUDE_LEN, MAVLINK_MSG_ID_ALTITUDE_CRC);
#else
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_ALTITUDE, buf, MAVLINK_MSG_ID_ALTITUDE_LEN);
#endif
#else
        mavlink_altitude_t packet;
        packet.time_usec = time_usec;
        packet.altitude_monotonic = altitude_monotonic;
        packet.altitude_amsl = altitude_amsl;
        packet.altitude_local = altitude_local;
        packet.altitude_relative = altitude_relative;
        packet.altitude_terrain = altitude_terrain;
        packet.bottom_clearance = bottom_clearance;

#if MAVLINK_CRC_EXTRA
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_ALTITUDE, (const char *)&packet, MAVLINK_MSG_ID_ALTITUDE_LEN, MAVLINK_MSG_ID_ALTITUDE_CRC);
#else
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_ALTITUDE, (const char *)&packet, MAVLINK_MSG_ID_ALTITUDE_LEN);
#endif
#endif
}

#if MAVLINK_MSG_ID_ALTITUDE_LEN <= MAVLINK_MAX_PAYLOAD_LEN
/*
  This varient of _send() can be used to save stack space by re-using
  memory from the receive buffer.  The caller provides a
  mavlink_message_t which is the size of a full mavlink message. This
  is usually the receive buffer for the channel, and allows a reply to an
  incoming message with minimum stack space usage.
 */
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)
{
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
        char *buf = (char *)msgbuf;
        _mav_put_uint64_t(buf, 0, time_usec);
        _mav_put_float(buf, 8, altitude_monotonic);
        _mav_put_float(buf, 12, altitude_amsl);
        _mav_put_float(buf, 16, altitude_local);
        _mav_put_float(buf, 20, altitude_relative);
        _mav_put_float(buf, 24, altitude_terrain);
        _mav_put_float(buf, 28, bottom_clearance);

#if MAVLINK_CRC_EXTRA
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_ALTITUDE, buf, MAVLINK_MSG_ID_ALTITUDE_LEN, MAVLINK_MSG_ID_ALTITUDE_CRC);
#else
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_ALTITUDE, buf, MAVLINK_MSG_ID_ALTITUDE_LEN);
#endif
#else
        mavlink_altitude_t *packet = (mavlink_altitude_t *)msgbuf;
        packet->time_usec = time_usec;
        packet->altitude_monotonic = altitude_monotonic;
        packet->altitude_amsl = altitude_amsl;
        packet->altitude_local = altitude_local;
        packet->altitude_relative = altitude_relative;
        packet->altitude_terrain = altitude_terrain;
        packet->bottom_clearance = bottom_clearance;

#if MAVLINK_CRC_EXTRA
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_ALTITUDE, (const char *)packet, MAVLINK_MSG_ID_ALTITUDE_LEN, MAVLINK_MSG_ID_ALTITUDE_CRC);
#else
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_ALTITUDE, (const char *)packet, MAVLINK_MSG_ID_ALTITUDE_LEN);
#endif
#endif
}
#endif

#endif

// MESSAGE ALTITUDE UNPACKING


static inline uint64_t mavlink_msg_altitude_get_time_usec(const mavlink_message_t* msg)
{
        return _MAV_RETURN_uint64_t(msg,  0);
}

static inline float mavlink_msg_altitude_get_altitude_monotonic(const mavlink_message_t* msg)
{
        return _MAV_RETURN_float(msg,  8);
}

static inline float mavlink_msg_altitude_get_altitude_amsl(const mavlink_message_t* msg)
{
        return _MAV_RETURN_float(msg,  12);
}

static inline float mavlink_msg_altitude_get_altitude_local(const mavlink_message_t* msg)
{
        return _MAV_RETURN_float(msg,  16);
}

static inline float mavlink_msg_altitude_get_altitude_relative(const mavlink_message_t* msg)
{
        return _MAV_RETURN_float(msg,  20);
}

static inline float mavlink_msg_altitude_get_altitude_terrain(const mavlink_message_t* msg)
{
        return _MAV_RETURN_float(msg,  24);
}

static inline float mavlink_msg_altitude_get_bottom_clearance(const mavlink_message_t* msg)
{
        return _MAV_RETURN_float(msg,  28);
}

static inline void mavlink_msg_altitude_decode(const mavlink_message_t* msg, mavlink_altitude_t* altitude)
{
#if MAVLINK_NEED_BYTE_SWAP
        altitude->time_usec = mavlink_msg_altitude_get_time_usec(msg);
        altitude->altitude_monotonic = mavlink_msg_altitude_get_altitude_monotonic(msg);
        altitude->altitude_amsl = mavlink_msg_altitude_get_altitude_amsl(msg);
        altitude->altitude_local = mavlink_msg_altitude_get_altitude_local(msg);
        altitude->altitude_relative = mavlink_msg_altitude_get_altitude_relative(msg);
        altitude->altitude_terrain = mavlink_msg_altitude_get_altitude_terrain(msg);
        altitude->bottom_clearance = mavlink_msg_altitude_get_bottom_clearance(msg);
#else
        memcpy(altitude, _MAV_PAYLOAD(msg), MAVLINK_MSG_ID_ALTITUDE_LEN);
#endif
}