APM:Libraries
Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Member Functions | Private Attributes | List of all members
AP_Compass_QMC5883L Class Reference

#include <AP_Compass_QMC5883L.h>

Inheritance diagram for AP_Compass_QMC5883L:
[legend]
Collaboration diagram for AP_Compass_QMC5883L:
[legend]

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_Backendprobe (Compass &compass, AP_HAL::OwnPtr< AP_HAL::I2CDevice > dev, bool force_external, enum Rotation rotation=ROTATION_NONE)
 

Static Public Attributes

static constexpr const char * name = "QMC5883L"
 

Private Member Functions

 AP_Compass_QMC5883L (Compass &compass, AP_HAL::OwnPtr< AP_HAL::Device > dev, bool force_external, enum Rotation rotation)
 
void _dump_registers ()
 
bool _check_whoami ()
 
void timer ()
 
bool init ()
 

Private Attributes

AP_HAL::OwnPtr< AP_HAL::Device_dev
 
Vector3f _accum = Vector3f()
 
uint32_t _accum_count = 0
 
enum Rotation _rotation
 
uint8_t _instance
 
bool _force_external:1
 

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_QMC5883L.h.

Constructor & Destructor Documentation

◆ AP_Compass_QMC5883L()

AP_Compass_QMC5883L::AP_Compass_QMC5883L ( Compass compass,
AP_HAL::OwnPtr< AP_HAL::Device dev,
bool  force_external,
enum Rotation  rotation 
)
private

Definition at line 78 of file AP_Compass_QMC5883L.cpp.

Referenced by probe().

Here is the caller graph for this function:

Member Function Documentation

◆ _check_whoami()

bool AP_Compass_QMC5883L::_check_whoami ( void  )
private

Definition at line 145 of file AP_Compass_QMC5883L.cpp.

Referenced by init().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ _dump_registers()

void AP_Compass_QMC5883L::_dump_registers ( )
private

Definition at line 249 of file AP_Compass_QMC5883L.cpp.

Referenced by init().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ init()

bool AP_Compass_QMC5883L::init ( void  )
private

Definition at line 89 of file AP_Compass_QMC5883L.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_QMC5883L::probe ( Compass compass,
AP_HAL::OwnPtr< AP_HAL::I2CDevice dev,
bool  force_external,
enum Rotation  rotation = ROTATION_NONE 
)
static

Definition at line 60 of file AP_Compass_QMC5883L.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_QMC5883L::read ( void  )
overridevirtual

Implements AP_Compass_Backend.

Definition at line 227 of file AP_Compass_QMC5883L.cpp.

Here is the call graph for this function:

◆ timer()

void AP_Compass_QMC5883L::timer ( void  )
private

Definition at line 161 of file AP_Compass_QMC5883L.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_QMC5883L::_accum = Vector3f()
private

Definition at line 56 of file AP_Compass_QMC5883L.h.

Referenced by read(), and timer().

◆ _accum_count

uint32_t AP_Compass_QMC5883L::_accum_count = 0
private

Definition at line 57 of file AP_Compass_QMC5883L.h.

Referenced by read(), and timer().

◆ _dev

AP_HAL::OwnPtr<AP_HAL::Device> AP_Compass_QMC5883L::_dev
private

Definition at line 54 of file AP_Compass_QMC5883L.h.

Referenced by _check_whoami(), _dump_registers(), init(), and timer().

◆ _force_external

bool AP_Compass_QMC5883L::_force_external
private

Definition at line 61 of file AP_Compass_QMC5883L.h.

Referenced by init().

◆ _instance

uint8_t AP_Compass_QMC5883L::_instance
private

Definition at line 60 of file AP_Compass_QMC5883L.h.

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

◆ _rotation

enum Rotation AP_Compass_QMC5883L::_rotation
private

Definition at line 59 of file AP_Compass_QMC5883L.h.

Referenced by init().

◆ name

constexpr const char* AP_Compass_QMC5883L::name = "QMC5883L"
static

Definition at line 41 of file AP_Compass_QMC5883L.h.

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


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