common.h

Go to the documentation of this file.

/****************************************************************************
 *
 *   Copyright (c) 2015 Estimation and Control Library (ECL). All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name ECL nor the names of its contributors may be
 *    used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 ****************************************************************************/

/**
 * @file common.h
 * Definition of base class for attitude estimators
 *
 * @author Roman Bast <bapstroman@gmail.com>
 * @author Siddharth Bharat Purohit <siddharthbharatpurohit@gmail.com>
 *
 */

#include <matrix/math.hpp>

namespace estimator
{

using matrix::AxisAnglef;
using matrix::Dcmf;
using matrix::Eulerf;
using matrix::Matrix3f;
using matrix::Quatf;
using matrix::Vector2f;
using matrix::Vector3f;
using matrix::wrap_pi;

struct gps_message {
    uint64_t time_usec;
    int32_t lat;        ///< Latitude in 1E-7 degrees
    int32_t lon;        ///< Longitude in 1E-7 degrees
    int32_t alt;        ///< Altitude in 1E-3 meters (millimeters) above MSL
    float yaw;      ///< yaw angle. NaN if not set (used for dual antenna GPS), (rad, [-PI, PI])
    float yaw_offset;   ///< Heading/Yaw offset for dual antenna GPS - refer to description for GPS_YAW_OFFSET
    uint8_t fix_type;   ///< 0-1: no fix, 2: 2D fix, 3: 3D fix, 4: RTCM code differential, 5: Real-Time Kinematic
    float eph;      ///< GPS horizontal position accuracy in m
    float epv;      ///< GPS vertical position accuracy in m
    float sacc;     ///< GPS speed accuracy in m/s
    float vel_m_s;      ///< GPS ground speed (m/sec)
    float vel_ned[3];   ///< GPS ground speed NED
    bool vel_ned_valid; ///< GPS ground speed is valid
    uint8_t nsats;      ///< number of satellites used
    float pdop;     ///< position dilution of precision
};

struct flow_message {
    uint8_t quality;    ///< Quality of Flow data
    Vector2f flowdata;  ///< Optical flow rates about the X and Y body axes (rad/sec)
    Vector3f gyrodata;  ///< Gyro rates about the XYZ body axes (rad/sec)
    uint32_t dt;        ///< integration time of flow samples (sec)
};

struct ext_vision_message {
    Vector3f pos;   ///< XYZ position in earth frame (m) - Z must be aligned with down axis
    Vector3f vel;   ///< XYZ velocity in earth frame (m/sec) - Z must be aligned with down axis
    Quatf quat;     ///< quaternion defining rotation from body to earth frame
    float posErr;       ///< 1-Sigma horizontal position accuracy (m)
    float hgtErr;       ///< 1-Sigma height accuracy (m)
    float velErr;       ///< 1-Sigma velocity accuracy (m/sec)
    float angErr;       ///< 1-Sigma angular error (rad)
};

struct outputSample {
    Quatf  quat_nominal;    ///< nominal quaternion describing vehicle attitude
    Vector3f    vel;    ///< NED velocity estimate in earth frame (m/sec)
    Vector3f    pos;    ///< NED position estimate in earth frame (m/sec)
    uint64_t    time_us;    ///< timestamp of the measurement (uSec)
};

struct outputVert {
    float       vel_d;      ///< D velocity calculated using alternative algorithm (m/sec)
    float       vel_d_integ;    ///< Integral of vel_d (m)
    float       dt;         ///< delta time (sec)
    uint64_t    time_us;        ///< timestamp of the measurement (uSec)
};

struct imuSample {
    Vector3f    delta_ang;      ///< delta angle in body frame (integrated gyro measurements) (rad)
    Vector3f    delta_vel;      ///< delta velocity in body frame (integrated accelerometer measurements) (m/sec)
    float       delta_ang_dt;   ///< delta angle integration period (sec)
    float       delta_vel_dt;   ///< delta velocity integration period (sec)
    uint64_t    time_us;        ///< timestamp of the measurement (uSec)
};

struct gpsSample {
    Vector2f    pos;    ///< NE earth frame gps horizontal position measurement (m)
    float       hgt;    ///< gps height measurement (m)
    Vector3f    vel;    ///< NED earth frame gps velocity measurement (m/sec)
    float       yaw;    ///< yaw angle. NaN if not set (used for dual antenna GPS), (rad, [-PI, PI])
    float       hacc;   ///< 1-std horizontal position error (m)
    float       vacc;   ///< 1-std vertical position error (m)
    float       sacc;   ///< 1-std speed error (m/sec)
    uint64_t    time_us;    ///< timestamp of the measurement (uSec)
};

struct magSample {
    Vector3f    mag;    ///< NED magnetometer body frame measurements (Gauss)
    uint64_t    time_us;    ///< timestamp of the measurement (uSec)
};

struct baroSample {
    float       hgt{0.0f};  ///< pressure altitude above sea level (m)
    uint64_t    time_us{0}; ///< timestamp of the measurement (uSec)
};

struct rangeSample {
    float       rng;        ///< range (distance to ground) measurement (m)
    uint64_t    time_us;    ///< timestamp of the measurement (uSec)
    int8_t      quality;    ///< Signal quality in percent (0...100%), where 0 = invalid signal, 100 = perfect signal, and -1 = unknown signal quality.
};

struct airspeedSample {
    float       true_airspeed;  ///< true airspeed measurement (m/sec)
    float       eas2tas;    ///< equivalent to true airspeed factor
    uint64_t    time_us;        ///< timestamp of the measurement (uSec)
};

struct flowSample {
    uint8_t  quality;   ///< quality indicator between 0 and 255
    Vector2f flowRadXY; ///< measured delta angle of the image about the X and Y body axes (rad), RH rotation is positive
    Vector3f gyroXYZ;   ///< measured delta angle of the inertial frame about the body axes obtained from rate gyro measurements (rad), RH rotation is positive
    float    dt;        ///< amount of integration time (sec)
    uint64_t time_us;   ///< timestamp of the integration period leading edge (uSec)
};

struct extVisionSample {
    Vector3f pos;   ///< XYZ position in earth frame (m) - Z must be aligned with down axis
    Vector3f vel;   ///< XYZ velocity in earth frame (m/sec) - Z must be aligned with down axis
    Quatf quat;     ///< quaternion defining rotation from body to earth frame
    float posErr;       ///< 1-Sigma horizontal position accuracy (m)
    float hgtErr;       ///< 1-Sigma height accuracy (m)
    float velErr;       ///< 1-Sigma velocity accuracy (m/sec)
    float angErr;       ///< 1-Sigma angular error (rad)
    uint64_t time_us;   ///< timestamp of the measurement (uSec)
};

struct dragSample {
    Vector2f accelXY;   ///< measured specific force along the X and Y body axes (m/sec**2)
    uint64_t time_us;   ///< timestamp of the measurement (uSec)
};

struct auxVelSample {
    Vector2f velNE;     ///< measured NE velocity relative to the local origin (m/sec)
    Vector2f velVarNE;  ///< estimated error variance of the NE velocity (m/sec)**2
    uint64_t time_us;   ///< timestamp of the measurement (uSec)
};

// Integer definitions for vdist_sensor_type
#define VDIST_SENSOR_BARO  0    ///< Use baro height
#define VDIST_SENSOR_GPS   1    ///< Use GPS height
#define VDIST_SENSOR_RANGE 2    ///< Use range finder height
#define VDIST_SENSOR_EV    3    ///< Use external vision

// Bit locations for mag_declination_source
#define MASK_USE_GEO_DECL   (1<<0)  ///< set to true to use the declination from the geo library when the GPS position becomes available, set to false to always use the EKF2_MAG_DECL value
#define MASK_SAVE_GEO_DECL  (1<<1)  ///< set to true to set the EKF2_MAG_DECL parameter to the value returned by the geo library
#define MASK_FUSE_DECL      (1<<2)  ///< set to true if the declination is always fused as an observation to constrain drift when 3-axis fusion is performed

// Bit locations for fusion_mode
#define MASK_USE_GPS    (1<<0)      ///< set to true to use GPS data
#define MASK_USE_OF     (1<<1)      ///< set to true to use optical flow data
#define MASK_INHIBIT_ACC_BIAS (1<<2)    ///< set to true to inhibit estimation of accelerometer delta velocity bias
#define MASK_USE_EVPOS  (1<<3)      ///< set to true to use external vision position data
#define MASK_USE_EVYAW  (1<<4)      ///< set to true to use external vision quaternion data for yaw
#define MASK_USE_DRAG  (1<<5)       ///< set to true to use the multi-rotor drag model to estimate wind
#define MASK_ROTATE_EV  (1<<6)      ///< set to true to if the EV observations are in a non NED reference frame and need to be rotated before being used
#define MASK_USE_GPSYAW  (1<<7)     ///< set to true to use GPS yaw data if available
#define MASK_USE_EVVEL  (1<<8)      ///< sset to true to use external vision velocity data

// Integer definitions for mag_fusion_type
#define MAG_FUSE_TYPE_AUTO      0   ///< The selection of either heading or 3D magnetometer fusion will be automatic
#define MAG_FUSE_TYPE_HEADING   1   ///< Simple yaw angle fusion will always be used. This is less accurate, but less affected by earth field distortions. It should not be used for pitch angles outside the range from -60 to +60 deg
#define MAG_FUSE_TYPE_3D        2   ///< Magnetometer 3-axis fusion will always be used. This is more accurate, but more affected by localised earth field distortions
#define MAG_FUSE_TYPE_UNUSED    3   ///< Not implemented
#define MAG_FUSE_TYPE_INDOOR    4   ///< The same as option 0, but magnetometer or yaw fusion will not be used unless earth frame external aiding (GPS or External Vision) is being used. This prevents inconsistent magnetic fields associated with indoor operation degrading state estimates.
#define MAG_FUSE_TYPE_NONE  5   ///< Do not use magnetometer under any circumstance. Other sources of yaw may be used if selected via the EKF2_AID_MASK parameter.

// Maximum sensor intervals in usec
#define GPS_MAX_INTERVAL  (uint64_t)5e5 ///< Maximum allowable time interval between GPS measurements (uSec)
#define BARO_MAX_INTERVAL (uint64_t)2e5 ///< Maximum allowable time interval between pressure altitude measurements (uSec)
#define RNG_MAX_INTERVAL  (uint64_t)2e5 ///< Maximum allowable time interval between range finder  measurements (uSec)
#define EV_MAX_INTERVAL   (uint64_t)2e5 ///< Maximum allowable time interval between external vision system measurements (uSec)

// bad accelerometer detection and mitigation
#define BADACC_PROBATION  (uint64_t)10e6    ///< Period of time that accel data declared bad must continuously pass checks to be declared good again (uSec)
#define BADACC_BIAS_PNOISE  4.9f    ///< The delta velocity process noise is set to this when accel data is declared bad (m/sec**2)

// ground effect compensation
#define GNDEFFECT_TIMEOUT   10E6    ///< Maximum period of time that ground effect protection will be active after it was last turned on (uSec)

struct parameters {
    // measurement source control
    int32_t fusion_mode{MASK_USE_GPS};      ///< bitmasked integer that selects which aiding sources will be used
    int32_t vdist_sensor_type{VDIST_SENSOR_BARO};   ///< selects the primary source for height data
    int32_t sensor_interval_min_ms{20};     ///< minimum time of arrival difference between non IMU sensor updates. Sets the size of the observation buffers. (mSec)

    // measurement time delays
    float min_delay_ms{0.0f};       ///< Maximum time delay of any sensor used to increase buffer length to handle large timing jitter (mSec)
    float mag_delay_ms{0.0f};       ///< magnetometer measurement delay relative to the IMU (mSec)
    float baro_delay_ms{0.0f};      ///< barometer height measurement delay relative to the IMU (mSec)
    float gps_delay_ms{110.0f};     ///< GPS measurement delay relative to the IMU (mSec)
    float airspeed_delay_ms{100.0f};    ///< airspeed measurement delay relative to the IMU (mSec)
    float flow_delay_ms{5.0f};      ///< optical flow measurement delay relative to the IMU (mSec) - this is to the middle of the optical flow integration interval
    float range_delay_ms{5.0f};     ///< range finder measurement delay relative to the IMU (mSec)
    float ev_delay_ms{100.0f};      ///< off-board vision measurement delay relative to the IMU (mSec)
    float auxvel_delay_ms{0.0f};        ///< auxiliary velocity measurement delay relative to the IMU (mSec)

    // input noise
    float gyro_noise{1.5e-2f};      ///< IMU angular rate noise used for covariance prediction (rad/sec)
    float accel_noise{3.5e-1f};     ///< IMU acceleration noise use for covariance prediction (m/sec**2)

    // process noise
    float gyro_bias_p_noise{1.0e-3f};   ///< process noise for IMU rate gyro bias prediction (rad/sec**2)
    float accel_bias_p_noise{6.0e-3f};  ///< process noise for IMU accelerometer bias prediction (m/sec**3)
    float mage_p_noise{1.0e-3f};        ///< process noise for earth magnetic field prediction (Gauss/sec)
    float magb_p_noise{1.0e-4f};        ///< process noise for body magnetic field prediction (Gauss/sec)
    float wind_vel_p_noise{1.0e-1f};    ///< process noise for wind velocity prediction (m/sec**2)
    float wind_vel_p_noise_scaler{0.5f};    ///< scaling of wind process noise with vertical velocity
    float terrain_p_noise{5.0f};        ///< process noise for terrain offset (m/sec)
    float terrain_gradient{0.5f};       ///< gradient of terrain used to estimate process noise due to changing position (m/m)

    // initialization errors
    float switch_on_gyro_bias{0.1f};    ///< 1-sigma gyro bias uncertainty at switch on (rad/sec)
    float switch_on_accel_bias{0.2f};   ///< 1-sigma accelerometer bias uncertainty at switch on (m/sec**2)
    float initial_tilt_err{0.1f};       ///< 1-sigma tilt error after initial alignment using gravity vector (rad)
    float initial_wind_uncertainty{1.0f};   ///< 1-sigma initial uncertainty in wind velocity (m/sec)

    // position and velocity fusion
    float gps_vel_noise{5.0e-1f};       ///< minimum allowed observation noise for gps velocity fusion (m/sec)
    float gps_pos_noise{0.5f};      ///< minimum allowed observation noise for gps position fusion (m)
    float pos_noaid_noise{10.0f};       ///< observation noise for non-aiding position fusion (m)
    float baro_noise{2.0f};         ///< observation noise for barometric height fusion (m)
    float baro_innov_gate{5.0f};        ///< barometric and GPS height innovation consistency gate size (STD)
    float gps_pos_innov_gate{5.0f};     ///< GPS horizontal position innovation consistency gate size (STD)
    float gps_vel_innov_gate{5.0f};     ///< GPS velocity innovation consistency gate size (STD)
    float gnd_effect_deadzone{5.0f};    ///< Size of deadzone applied to negative baro innovations when ground effect compensation is active (m)
    float gnd_effect_max_hgt{0.5f};     ///< Height above ground at which baro ground effect becomes insignificant (m)

    // magnetometer fusion
    float mag_heading_noise{3.0e-1f};   ///< measurement noise used for simple heading fusion (rad)
    float mag_noise{5.0e-2f};       ///< measurement noise used for 3-axis magnetoemeter fusion (Gauss)
    float mag_declination_deg{0.0f};    ///< magnetic declination (degrees)
    float heading_innov_gate{2.6f};     ///< heading fusion innovation consistency gate size (STD)
    float mag_innov_gate{3.0f};     ///< magnetometer fusion innovation consistency gate size (STD)
    int32_t mag_declination_source{7};  ///< bitmask used to control the handling of declination data
    int32_t mag_fusion_type{0};     ///< integer used to specify the type of magnetometer fusion used
    float mag_acc_gate{0.5f};       ///< when in auto select mode, heading fusion will be used when manoeuvre accel is lower than this (m/sec**2)
    float mag_yaw_rate_gate{0.25f};     ///< yaw rate threshold used by mode select logic (rad/sec)

    // airspeed fusion
    float tas_innov_gate{5.0f};     ///< True Airspeed innovation consistency gate size (STD)
    float eas_noise{1.4f};          ///< EAS measurement noise standard deviation used for airspeed fusion (m/s)

    // synthetic sideslip fusion
    float beta_innov_gate{5.0f};        ///< synthetic sideslip innovation consistency gate size in standard deviation (STD)
    float beta_noise{0.3f};         ///< synthetic sideslip noise (rad)
    float beta_avg_ft_us{150000.0f};    ///< The average time between synthetic sideslip measurements (uSec)

    // range finder fusion
    float range_noise{0.1f};        ///< observation noise for range finder measurements (m)
    float range_innov_gate{5.0f};       ///< range finder fusion innovation consistency gate size (STD)
    float rng_gnd_clearance{0.1f};      ///< minimum valid value for range when on ground (m)
    float rng_sens_pitch{0.0f};     ///< Pitch offset of the range sensor (rad). Sensor points out along Z axis when offset is zero. Positive rotation is RH about Y axis.
    float range_noise_scaler{0.0f};     ///< scaling from range measurement to noise (m/m)
    float vehicle_variance_scaler{0.0f};    ///< gain applied to vehicle height variance used in calculation of height above ground observation variance
    float max_hagl_for_range_aid{5.0f}; ///< maximum height above ground for which we allow to use the range finder as height source (if range_aid == 1)
    float max_vel_for_range_aid{1.0f};  ///< maximum ground velocity for which we allow to use the range finder as height source (if range_aid == 1)
    int32_t range_aid{0};           ///< allow switching primary height source to range finder if certain conditions are met
    float range_aid_innov_gate{1.0f};   ///< gate size used for innovation consistency checks for range aid fusion
    float range_cos_max_tilt{0.7071f};  ///< cosine of the maximum tilt angle from the vertical that permits use of range finder and flow data
    float range_stuck_threshold{0.1f};  ///< minimum variation in range finder reading required to declare a range finder 'unstuck' when readings recommence after being out of range (m)
    int32_t range_signal_hysteresis_ms{1000};   ///< minimum duration during which the reported range finder signal quality needs to be non-zero in order to be declared valid (ms)

    // vision position fusion
        float ev_vel_innov_gate{3.0f};      ///< vision velocity fusion innovation consistency gate size (STD)
        float ev_pos_innov_gate{5.0f};      ///< vision position fusion innovation consistency gate size (STD)

    // optical flow fusion
    float flow_noise{0.15f};        ///< observation noise for optical flow LOS rate measurements (rad/sec)
    float flow_noise_qual_min{0.5f};    ///< observation noise for optical flow LOS rate measurements when flow sensor quality is at the minimum useable (rad/sec)
    int32_t flow_qual_min{1};       ///< minimum acceptable quality integer from  the flow sensor
    float flow_innov_gate{3.0f};        ///< optical flow fusion innovation consistency gate size (STD)

    // these parameters control the strictness of GPS quality checks used to determine if the GPS is
    // good enough to set a local origin and commence aiding
    int32_t gps_check_mask{21};     ///< bitmask used to control which GPS quality checks are used
    float req_hacc{5.0f};           ///< maximum acceptable horizontal position error (m)
    float req_vacc{8.0f};           ///< maximum acceptable vertical position error (m)
    float req_sacc{1.0f};           ///< maximum acceptable speed error (m/s)
    int32_t req_nsats{6};           ///< minimum acceptable satellite count
    float req_pdop{2.0f};           ///< maximum acceptable position dilution of precision
    float req_hdrift{0.3f};         ///< maximum acceptable horizontal drift speed (m/s)
    float req_vdrift{0.5f};         ///< maximum acceptable vertical drift speed (m/s)

    // XYZ offset of sensors in body axes (m)
    Vector3f imu_pos_body;          ///< xyz position of IMU in body frame (m)
    Vector3f gps_pos_body;          ///< xyz position of the GPS antenna in body frame (m)
    Vector3f rng_pos_body;          ///< xyz position of range sensor in body frame (m)
    Vector3f flow_pos_body;         ///< xyz position of range sensor focal point in body frame (m)
    Vector3f ev_pos_body;           ///< xyz position of VI-sensor focal point in body frame (m)

    // output complementary filter tuning
    float vel_Tau{0.25f};           ///< velocity state correction time constant (1/sec)
    float pos_Tau{0.25f};           ///< position state correction time constant (1/sec)

    // accel bias learning control
    float acc_bias_lim{0.4f};       ///< maximum accel bias magnitude (m/sec**2)
    float acc_bias_learn_acc_lim{25.0f};    ///< learning is disabled if the magnitude of the IMU acceleration vector is greater than this (m/sec**2)
    float acc_bias_learn_gyr_lim{3.0f}; ///< learning is disabled if the magnitude of the IMU angular rate vector is greater than this (rad/sec)
    float acc_bias_learn_tc{0.5f};      ///< time constant used to control the decaying envelope filters applied to the accel and gyro magnitudes (sec)

    unsigned reset_timeout_max{7000000};    ///< maximum time we allow horizontal inertial dead reckoning before attempting to reset the states to the measurement or change _control_status if the data is unavailable (uSec)
    unsigned no_aid_timeout_max{1000000};   ///< maximum lapsed time from last fusion of a measurement that constrains horizontal velocity drift before the EKF will determine that the sensor is no longer contributing to aiding (uSec)

    int32_t valid_timeout_max{5000000}; ///< amount of time spent inertial dead reckoning before the estimator reports the state estimates as invalid (uSec)

    // multi-rotor drag specific force fusion
    float drag_noise{2.5f};         ///< observation noise variance for drag specific force measurements (m/sec**2)**2
    float bcoef_x{25.0f};           ///< ballistic coefficient along the X-axis (kg/m**2)
    float bcoef_y{25.0f};           ///< ballistic coefficient along the Y-axis (kg/m**2)

    // control of accel error detection and mitigation (IMU clipping)
    float vert_innov_test_lim{4.5f};    ///< Number of standard deviations allowed before the combined vertical velocity and position test is declared as failed
    int bad_acc_reset_delay_us{500000}; ///< Continuous time that the vertical position and velocity innovation test must fail before the states are reset (uSec)

    // auxiliary velocity fusion
    float auxvel_noise{0.5f};       ///< minimum observation noise, uses reported noise if greater (m/s)
    float auxvel_gate{5.0f};        ///< velocity fusion innovation consistency gate size (STD)

    // control of on-ground movement check
    float is_moving_scaler{1.0f};       ///< gain scaler used to adjust the threshold for the on-ground movement detection. Larger values make the test less sensitive.

    // compute synthetic magnetomter Z value if possible
    int32_t synthesize_mag_z{0};
    int32_t check_mag_strength{0};
};

struct stateSample {
    Quatf  quat_nominal;    ///< quaternion defining the rotation from body to earth frame
    Vector3f    vel;    ///< NED velocity in earth frame in m/s
    Vector3f    pos;    ///< NED position in earth frame in m
    Vector3f    gyro_bias;  ///< delta angle bias estimate in rad
    Vector3f    accel_bias; ///< delta velocity bias estimate in m/s
    Vector3f    mag_I;  ///< NED earth magnetic field in gauss
    Vector3f    mag_B;  ///< magnetometer bias estimate in body frame in gauss
    Vector2f    wind_vel;   ///< wind velocity in m/s
};

union fault_status_u {
    struct {
        bool bad_mag_x: 1;  ///< 0 - true if the fusion of the magnetometer X-axis has encountered a numerical error
        bool bad_mag_y: 1;  ///< 1 - true if the fusion of the magnetometer Y-axis has encountered a numerical error
        bool bad_mag_z: 1;  ///< 2 - true if the fusion of the magnetometer Z-axis has encountered a numerical error
        bool bad_hdg: 1;    ///< 3 - true if the fusion of the heading angle has encountered a numerical error
        bool bad_mag_decl: 1;   ///< 4 - true if the fusion of the magnetic declination has encountered a numerical error
        bool bad_airspeed: 1;   ///< 5 - true if fusion of the airspeed has encountered a numerical error
        bool bad_sideslip: 1;   ///< 6 - true if fusion of the synthetic sideslip constraint has encountered a numerical error
        bool bad_optflow_X: 1;  ///< 7 - true if fusion of the optical flow X axis has encountered a numerical error
        bool bad_optflow_Y: 1;  ///< 8 - true if fusion of the optical flow Y axis has encountered a numerical error
        bool bad_vel_N: 1;  ///< 9 - true if fusion of the North velocity has encountered a numerical error
        bool bad_vel_E: 1;  ///< 10 - true if fusion of the East velocity has encountered a numerical error
        bool bad_vel_D: 1;  ///< 11 - true if fusion of the Down velocity has encountered a numerical error
        bool bad_pos_N: 1;  ///< 12 - true if fusion of the North position has encountered a numerical error
        bool bad_pos_E: 1;  ///< 13 - true if fusion of the East position has encountered a numerical error
        bool bad_pos_D: 1;  ///< 14 - true if fusion of the Down position has encountered a numerical error
        bool bad_acc_bias: 1;   ///< 15 - true if bad delta velocity bias estimates have been detected
    } flags;
    uint16_t value;

};

// define structure used to communicate innovation test failures
union innovation_fault_status_u {
    struct {
        bool reject_vel_NED: 1;     ///< 0 - true if velocity observations have been rejected
        bool reject_pos_NE: 1;      ///< 1 - true if horizontal position observations have been rejected
        bool reject_pos_D: 1;       ///< 2 - true if true if vertical position observations have been rejected
        bool reject_mag_x: 1;       ///< 3 - true if the X magnetometer observation has been rejected
        bool reject_mag_y: 1;       ///< 4 - true if the Y magnetometer observation has been rejected
        bool reject_mag_z: 1;       ///< 5 - true if the Z magnetometer observation has been rejected
        bool reject_yaw: 1;     ///< 6 - true if the yaw observation has been rejected
        bool reject_airspeed: 1;    ///< 7 - true if the airspeed observation has been rejected
        bool reject_sideslip: 1;    ///< 8 - true if the synthetic sideslip observation has been rejected
        bool reject_hagl: 1;        ///< 9 - true if the height above ground observation has been rejected
        bool reject_optflow_X: 1;   ///< 10 - true if the X optical flow observation has been rejected
        bool reject_optflow_Y: 1;   ///< 11 - true if the Y optical flow observation has been rejected
    } flags;
    uint16_t value;

};

// publish the status of various GPS quality checks
union gps_check_fail_status_u {
    struct {
        uint16_t fix    : 1; ///< 0 - true if the fix type is insufficient (no 3D solution)
        uint16_t nsats  : 1; ///< 1 - true if number of satellites used is insufficient
        uint16_t pdop   : 1; ///< 2 - true if position dilution of precision is insufficient
        uint16_t hacc   : 1; ///< 3 - true if reported horizontal accuracy is insufficient
        uint16_t vacc   : 1; ///< 4 - true if reported vertical accuracy is insufficient
        uint16_t sacc   : 1; ///< 5 - true if reported speed accuracy is insufficient
        uint16_t hdrift : 1; ///< 6 - true if horizontal drift is excessive (can only be used when stationary on ground)
        uint16_t vdrift : 1; ///< 7 - true if vertical drift is excessive (can only be used when stationary on ground)
        uint16_t hspeed : 1; ///< 8 - true if horizontal speed is excessive (can only be used when stationary on ground)
        uint16_t vspeed : 1; ///< 9 - true if vertical speed error is excessive
    } flags;
    uint16_t value;
};

// bitmask containing filter control status
union filter_control_status_u {
    struct {
        uint32_t tilt_align  : 1; ///< 0 - true if the filter tilt alignment is complete
        uint32_t yaw_align   : 1; ///< 1 - true if the filter yaw alignment is complete
        uint32_t gps         : 1; ///< 2 - true if GPS measurements are being fused
        uint32_t opt_flow    : 1; ///< 3 - true if optical flow measurements are being fused
        uint32_t mag_hdg     : 1; ///< 4 - true if a simple magnetic yaw heading is being fused
        uint32_t mag_3D      : 1; ///< 5 - true if 3-axis magnetometer measurement are being fused
        uint32_t mag_dec     : 1; ///< 6 - true if synthetic magnetic declination measurements are being fused
        uint32_t in_air      : 1; ///< 7 - true when the vehicle is airborne
        uint32_t wind        : 1; ///< 8 - true when wind velocity is being estimated
        uint32_t baro_hgt    : 1; ///< 9 - true when baro height is being fused as a primary height reference
        uint32_t rng_hgt     : 1; ///< 10 - true when range finder height is being fused as a primary height reference
        uint32_t gps_hgt     : 1; ///< 11 - true when GPS height is being fused as a primary height reference
        uint32_t ev_pos      : 1; ///< 12 - true when local position data from external vision is being fused
        uint32_t ev_yaw      : 1; ///< 13 - true when yaw data from external vision measurements is being fused
        uint32_t ev_hgt      : 1; ///< 14 - true when height data from external vision measurements is being fused
        uint32_t fuse_beta   : 1; ///< 15 - true when synthetic sideslip measurements are being fused
        uint32_t mag_field_disturbed : 1; ///< 16 - true when the mag field does not match the expected strength
        uint32_t fixed_wing  : 1; ///< 17 - true when the vehicle is operating as a fixed wing vehicle
        uint32_t mag_fault   : 1; ///< 18 - true when the magnetometer has been declared faulty and is no longer being used
        uint32_t fuse_aspd   : 1; ///< 19 - true when airspeed measurements are being fused
        uint32_t gnd_effect  : 1; ///< 20 - true when protection from ground effect induced static pressure rise is active
        uint32_t rng_stuck   : 1; ///< 21 - true when rng data wasn't ready for more than 10s and new rng values haven't changed enough
        uint32_t gps_yaw     : 1; ///< 22 - true when yaw (not ground course) data from a GPS receiver is being fused
        uint32_t mag_aligned_in_flight   : 1; ///< 23 - true when the in-flight mag field alignment has been completed
        uint32_t ev_vel      : 1; ///< 24 - true when local earth frame velocity data from external vision measurements are being fused
        uint32_t synthetic_mag_z : 1; ///< 25 - true when we are using a synthesized measurement for the magnetometer Z component
    } flags;
    uint32_t value;
};

union ekf_solution_status {
    struct {
        uint16_t attitude           : 1; ///< 0 - True if the attitude estimate is good
        uint16_t velocity_horiz     : 1; ///< 1 - True if the horizontal velocity estimate is good
        uint16_t velocity_vert      : 1; ///< 2 - True if the vertical velocity estimate is good
        uint16_t pos_horiz_rel      : 1; ///< 3 - True if the horizontal position (relative) estimate is good
        uint16_t pos_horiz_abs      : 1; ///< 4 - True if the horizontal position (absolute) estimate is good
        uint16_t pos_vert_abs       : 1; ///< 5 - True if the vertical position (absolute) estimate is good
        uint16_t pos_vert_agl       : 1; ///< 6 - True if the vertical position (above ground) estimate is good
        uint16_t const_pos_mode     : 1; ///< 7 - True if the EKF is in a constant position mode and is not using external measurements (eg GPS or optical flow)
        uint16_t pred_pos_horiz_rel : 1; ///< 8 - True if the EKF has sufficient data to enter a mode that will provide a (relative) position estimate
        uint16_t pred_pos_horiz_abs : 1; ///< 9 - True if the EKF has sufficient data to enter a mode that will provide a (absolute) position estimate
        uint16_t gps_glitch         : 1; ///< 10 - True if the EKF has detected a GPS glitch
        uint16_t accel_error        : 1; ///< 11 - True if the EKF has detected bad accelerometer data
    } flags;
    uint16_t value;
};

}