ardupilot/libraries/AP_ExternalAHRS/AP_ExternalAHRS_backend.h

89 lines
2.7 KiB
C++

/*
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/*
parent class for ExternalAHRS backends
*/
#pragma once
#include "AP_ExternalAHRS.h"
#if HAL_EXTERNAL_AHRS_ENABLED
class AP_ExternalAHRS_backend {
public:
AP_ExternalAHRS_backend(AP_ExternalAHRS *frontend, AP_ExternalAHRS::state_t &state);
// get serial port number, -1 for not enabled
virtual int8_t get_port(void) const { return -1; }
// Get model/type name
virtual const char* get_name() const = 0;
// Accessors for AP_AHRS
// If not healthy, none of the other API's can be trusted.
// Example: Serial cable is severed.
virtual bool healthy(void) const = 0;
// The communication interface is up and the device has sent valid data.
virtual bool initialised(void) const = 0;
virtual bool pre_arm_check(char *failure_msg, uint8_t failure_msg_len) const = 0;
virtual void get_filter_status(nav_filter_status &status) const {}
virtual bool get_variances(float &velVar, float &posVar, float &hgtVar, Vector3f &magVar, float &tasVar) const { return false; }
// Check for new data.
// This is used when there's not a separate thread for EAHRS.
// This can also copy interim state protected by locking.
virtual void update() = 0;
// Return the number of GPS sensors sharing data to AP_GPS.
virtual uint8_t num_gps_sensors(void) const = 0;
protected:
AP_ExternalAHRS::state_t &state;
uint16_t get_rate(void) const;
bool option_is_set(AP_ExternalAHRS::OPTIONS option) const;
// set default of EAHRS_SENSORS
void set_default_sensors(uint16_t sensors) {
frontend.set_default_sensors(sensors);
}
/*
return true if the GNSS is disabled
*/
bool gnss_is_disabled(void) const {
return frontend.gnss_is_disabled;
}
/*
return true when we are in fixed wing flight
*/
bool in_fly_forward(void) const;
/*
scale factors for get_variances() to return normalised values from SI units
*/
const float vel_gate_scale = 0.2;
const float pos_gate_scale = 0.2;
const float hgt_gate_scale = 0.2;
private:
AP_ExternalAHRS &frontend;
};
#endif // HAL_EXTERNAL_AHRS_ENABLED