AP_Compass.h File Reference

#include <inttypes.h>
#include <AP_Common/AP_Common.h>
#include <AP_Declination/AP_Declination.h>
#include <AP_HAL/AP_HAL.h>
#include <AP_Math/AP_Math.h>
#include <AP_Param/AP_Param.h>
#include <GCS_MAVLink/GCS_MAVLink.h>
#include <AP_BattMonitor/AP_BattMonitor.h>
#include "CompassCalibrator.h"
#include "AP_Compass_Backend.h"
#include "Compass_PerMotor.h"

Include dependency graph for AP_Compass.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	Compass
struct	Compass::mag_state

Namespaces
	AP

Macros
#define	AP_COMPASS_MOT_COMP_DISABLED   0x00
#define	AP_COMPASS_MOT_COMP_THROTTLE   0x01
#define	AP_COMPASS_MOT_COMP_CURRENT   0x02
#define	AP_COMPASS_MOT_COMP_PER_MOTOR   0x03
#define	AP_COMPASS_CALIBRATION_FITNESS_DEFAULT   16.0f
#define	AP_COMPASS_MAX_XYZ_ANG_DIFF   radians(90.0f)
#define	AP_COMPASS_MAX_XY_ANG_DIFF   radians(60.0f)
#define	AP_COMPASS_MAX_XY_LENGTH_DIFF   200.0f
#define	COMPASS_MAX_INSTANCES   3
#define	COMPASS_MAX_BACKEND   3

Functions
Compass &	AP::compass ()

Macro Definition Documentation

AP_COMPASS_CALIBRATION_FITNESS_DEFAULT

#define AP_COMPASS_CALIBRATION_FITNESS_DEFAULT   16.0f

Definition at line 37 of file AP_Compass.h.

AP_COMPASS_MAX_XY_ANG_DIFF

#define AP_COMPASS_MAX_XY_ANG_DIFF   radians(60.0f)

Definition at line 39 of file AP_Compass.h.

Referenced by Compass::consistent().

AP_COMPASS_MAX_XY_LENGTH_DIFF

#define AP_COMPASS_MAX_XY_LENGTH_DIFF   200.0f

Definition at line 40 of file AP_Compass.h.

Referenced by Compass::consistent().

AP_COMPASS_MAX_XYZ_ANG_DIFF

#define AP_COMPASS_MAX_XYZ_ANG_DIFF   radians(90.0f)

Definition at line 38 of file AP_Compass.h.

Referenced by Compass::consistent().

AP_COMPASS_MOT_COMP_CURRENT

#define AP_COMPASS_MOT_COMP_CURRENT   0x02

Definition at line 20 of file AP_Compass.h.

Referenced by AP_Compass_Backend::correct_field(), and Compass::motor_compensation_type().

AP_COMPASS_MOT_COMP_DISABLED

#define AP_COMPASS_MOT_COMP_DISABLED   0x00

Definition at line 18 of file AP_Compass.h.

AP_COMPASS_MOT_COMP_PER_MOTOR

#define AP_COMPASS_MOT_COMP_PER_MOTOR   0x03

Definition at line 21 of file AP_Compass.h.

AP_COMPASS_MOT_COMP_THROTTLE

#define AP_COMPASS_MOT_COMP_THROTTLE   0x01

Definition at line 19 of file AP_Compass.h.

Referenced by AP_Compass_Backend::correct_field(), and Compass::set_throttle().

COMPASS_MAX_BACKEND

#define COMPASS_MAX_BACKEND   3

Definition at line 47 of file AP_Compass.h.

Referenced by Compass::_add_backend(), Compass::_detect_backends(), and Compass::Compass().

COMPASS_MAX_INSTANCES

#define COMPASS_MAX_INSTANCES   3

maximum number of compass instances available on this platform. If more than 1 then redundant sensors may be available

Definition at line 46 of file AP_Compass.h.

Referenced by Compass::_accept_calibration_mask(), Compass::_cancel_calibration_mask(), Compass::_detect_backends(), Compass::_get_cal_mask(), Compass::_start_calibration_mask(), Compass::Compass(), Compass::compass_cal_update(), Compass::get_healthy_mask(), Compass::is_calibrating(), loop(), Compass::motor_compensation_type(), Compass::read(), Compass::register_compass(), Compass::save_motor_compensation(), Compass::save_offsets(), Compass::send_mag_cal_progress(), Compass::send_mag_cal_report(), Compass::set_and_save_diagonals(), Compass::set_and_save_offdiagonals(), Compass::set_and_save_offsets(), Compass::set_offsets(), and Compass::start_calibration_all().