AP_Compass_IST8310 Class Reference

#include <AP_Compass_IST8310.h>

Inheritance diagram for AP_Compass_IST8310:

Collaboration diagram for AP_Compass_IST8310:

Public Member Functions
void	read () override
Public Member Functions inherited from AP_Compass_Backend
	AP_Compass_Backend (Compass &compass)
virtual	~AP_Compass_Backend (void)
virtual void	accumulate (void)
virtual void	handle_mag_msg (Vector3f &mag)

Static Public Member Functions
static AP_Compass_Backend *	probe (Compass &compass, AP_HAL::OwnPtr< AP_HAL::I2CDevice > dev, bool force_external=false, enum Rotation rotation=ROTATION_NONE)

Static Public Attributes
static constexpr const char *	name = "IST8310"

Private Member Functions
	AP_Compass_IST8310 (Compass &compass, AP_HAL::OwnPtr< AP_HAL::Device > dev, bool force_external, enum Rotation rotation)
void	timer ()
bool	init ()
void	start_conversion ()

Private Attributes
AP_HAL::OwnPtr< AP_HAL::Device >	_dev
AP_HAL::Device::PeriodicHandle	_periodic_handle
AP_HAL::Util::perf_counter_t	_perf_xfer_err
AP_HAL::Util::perf_counter_t	_perf_bad_data
Vector3f	_accum = Vector3f()
uint32_t	_accum_count = 0
enum Rotation	_rotation
uint8_t	_instance
bool	_ignore_next_sample
bool	_force_external

Additional Inherited Members
Public Types inherited from AP_Compass_Backend
enum	DevTypes {   DEVTYPE_HMC5883_OLD = 0x01, DEVTYPE_HMC5883 = 0x07, DEVTYPE_LSM303D = 0x02, DEVTYPE_AK8963 = 0x04,   DEVTYPE_BMM150 = 0x05, DEVTYPE_LSM9DS1 = 0x06, DEVTYPE_LIS3MDL = 0x08, DEVTYPE_AK09916 = 0x09,   DEVTYPE_IST8310 = 0x0A, DEVTYPE_ICM20948 = 0x0B, DEVTYPE_MMC3416 = 0x0C, DEVTYPE_QMC5883L = 0x0D,   DEVTYPE_MAG3110 = 0x0E }
Protected Member Functions inherited from AP_Compass_Backend
void	rotate_field (Vector3f &mag, uint8_t instance)
void	publish_raw_field (const Vector3f &mag, uint8_t instance)
void	correct_field (Vector3f &mag, uint8_t i)
void	publish_filtered_field (const Vector3f &mag, uint8_t instance)
void	set_last_update_usec (uint32_t last_update, uint8_t instance)
uint8_t	register_compass (void) const
void	set_dev_id (uint8_t instance, uint32_t dev_id)
void	set_external (uint8_t instance, bool external)
bool	is_external (uint8_t instance)
void	set_rotation (uint8_t instance, enum Rotation rotation)
bool	field_ok (const Vector3f &field)
uint32_t	get_error_count () const
Protected Attributes inherited from AP_Compass_Backend
Compass &	_compass
AP_HAL::Semaphore *	_sem

Detailed Description

Definition at line 31 of file AP_Compass_IST8310.h.

Constructor & Destructor Documentation

AP_Compass_IST8310()

AP_Compass_IST8310::AP_Compass_IST8310 ( Compass &  compass, AP_HAL::OwnPtr< AP_HAL::Device >  dev, bool  force_external, enum Rotation  rotation  )

private

Definition at line 96 of file AP_Compass_IST8310.cpp.

Referenced by probe().

Here is the caller graph for this function:

Member Function Documentation

init()

bool AP_Compass_IST8310::init ( void  )

private

Definition at line 107 of file AP_Compass_IST8310.cpp.

Referenced by probe().

Here is the call graph for this function:

Here is the caller graph for this function:

probe()

AP_Compass_Backend * AP_Compass_IST8310::probe ( Compass &  compass, AP_HAL::OwnPtr< AP_HAL::I2CDevice >  dev, bool  force_external = false, enum Rotation  rotation = ROTATION_NONE  )

static

Definition at line 78 of file AP_Compass_IST8310.cpp.

Referenced by Compass::_detect_backends().

Here is the call graph for this function:

Here is the caller graph for this function:

read()

void AP_Compass_IST8310::read ( void  )

overridevirtual

Implements AP_Compass_Backend.

Definition at line 256 of file AP_Compass_IST8310.cpp.

Here is the call graph for this function:

start_conversion()

void AP_Compass_IST8310::start_conversion ( )

private

Definition at line 186 of file AP_Compass_IST8310.cpp.

Referenced by init(), and timer().

Here is the call graph for this function:

Here is the caller graph for this function:

timer()

void AP_Compass_IST8310::timer ( void  )

private

Definition at line 194 of file AP_Compass_IST8310.cpp.

Referenced by init().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

_accum

Vector3f AP_Compass_IST8310::_accum = Vector3f()

private

Definition at line 58 of file AP_Compass_IST8310.h.

Referenced by read(), and timer().

_accum_count

uint32_t AP_Compass_IST8310::_accum_count = 0

private

Definition at line 59 of file AP_Compass_IST8310.h.

Referenced by read(), and timer().

_dev

AP_HAL::OwnPtr<AP_HAL::Device> AP_Compass_IST8310::_dev

private

Definition at line 53 of file AP_Compass_IST8310.h.

Referenced by init(), start_conversion(), and timer().

_force_external

bool AP_Compass_IST8310::_force_external

private

Definition at line 64 of file AP_Compass_IST8310.h.

Referenced by init().

_ignore_next_sample

bool AP_Compass_IST8310::_ignore_next_sample

private

Definition at line 63 of file AP_Compass_IST8310.h.

Referenced by start_conversion(), and timer().

_instance

uint8_t AP_Compass_IST8310::_instance

private

Definition at line 62 of file AP_Compass_IST8310.h.

Referenced by init(), read(), and timer().

_perf_bad_data

AP_HAL::Util::perf_counter_t AP_Compass_IST8310::_perf_bad_data

private

Definition at line 56 of file AP_Compass_IST8310.h.

Referenced by init(), and timer().

_perf_xfer_err

AP_HAL::Util::perf_counter_t AP_Compass_IST8310::_perf_xfer_err

private

Definition at line 55 of file AP_Compass_IST8310.h.

Referenced by init(), start_conversion(), and timer().

_periodic_handle

AP_HAL::Device::PeriodicHandle AP_Compass_IST8310::_periodic_handle

private

Definition at line 54 of file AP_Compass_IST8310.h.

Referenced by init(), and timer().

_rotation

enum Rotation AP_Compass_IST8310::_rotation

private

Definition at line 61 of file AP_Compass_IST8310.h.

Referenced by init().

name

constexpr const char* AP_Compass_IST8310::name = "IST8310"

static

Definition at line 41 of file AP_Compass_IST8310.h.

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

---

The documentation for this class was generated from the following files:

• libraries/AP_Compass/AP_Compass_IST8310.h
• libraries/AP_Compass/AP_Compass_IST8310.cpp