APM:Libraries: AP_AK8963_BusDriver Class Reference

APM:Libraries

#include <AP_Compass_AK8963.h>

Inheritance diagram for AP_AK8963_BusDriver:

Public Member Functions
virtual	~AP_AK8963_BusDriver ()

virtual bool	block_read (uint8_t reg, uint8_t *buf, uint32_t size)=0

virtual bool	register_read (uint8_t reg, uint8_t *val)=0

virtual bool	register_write (uint8_t reg, uint8_t val)=0

virtual AP_HAL::Semaphore *	get_semaphore ()=0

virtual bool	configure ()

virtual bool	start_measurements ()

virtual AP_HAL::Device::PeriodicHandle	register_periodic_callback (uint32_t, AP_HAL::Device::PeriodicCb)=0

virtual void	set_device_type (uint8_t devtype)=0

virtual uint32_t	get_bus_id (void) const =0

Detailed Description

Definition at line 68 of file AP_Compass_AK8963.h.

Constructor & Destructor Documentation

◆ ~AP_AK8963_BusDriver()

virtual AP_AK8963_BusDriver::~AP_AK8963_BusDriver ( )

inlinevirtual

Definition at line 71 of file AP_Compass_AK8963.h.

Member Function Documentation

◆ block_read()

virtual bool AP_AK8963_BusDriver::block_read	(	uint8_t	reg,
		uint8_t *	buf,
		uint32_t	size
	)

pure virtual

Implemented in AP_AK8963_BusDriver_Auxiliary, and AP_AK8963_BusDriver_HALDevice.

Referenced by AP_Compass_AK8963::_calibrate(), and AP_Compass_AK8963::_update().

Here is the caller graph for this function:

◆ configure()

virtual bool AP_AK8963_BusDriver::configure ( )

inlinevirtual

Reimplemented in AP_AK8963_BusDriver_Auxiliary.

Definition at line 79 of file AP_Compass_AK8963.h.

Referenced by AP_Compass_AK8963::init().

Here is the caller graph for this function:

◆ get_bus_id()

virtual uint32_t AP_AK8963_BusDriver::get_bus_id ( void ) const

pure virtual

Implemented in AP_AK8963_BusDriver_Auxiliary, and AP_AK8963_BusDriver_HALDevice.

Referenced by AP_Compass_AK8963::init().

Here is the caller graph for this function:

◆ get_semaphore()

virtual AP_HAL::Semaphore* AP_AK8963_BusDriver::get_semaphore ( )

pure virtual

Implemented in AP_AK8963_BusDriver_Auxiliary, and AP_AK8963_BusDriver_HALDevice.

Referenced by AP_Compass_AK8963::init().

Here is the caller graph for this function:

◆ register_periodic_callback()

virtual AP_HAL::Device::PeriodicHandle AP_AK8963_BusDriver::register_periodic_callback	(	uint32_t	,
		AP_HAL::Device::PeriodicCb
	)

pure virtual

Implemented in AP_AK8963_BusDriver_Auxiliary, and AP_AK8963_BusDriver_HALDevice.

Referenced by AP_Compass_AK8963::init().

Here is the caller graph for this function:

◆ register_read()

virtual bool AP_AK8963_BusDriver::register_read	(	uint8_t	reg,
		uint8_t *	val
	)

pure virtual

Implemented in AP_AK8963_BusDriver_Auxiliary, and AP_AK8963_BusDriver_HALDevice.

Referenced by AP_Compass_AK8963::_check_id().

Here is the caller graph for this function:

◆ register_write()

virtual bool AP_AK8963_BusDriver::register_write	(	uint8_t	reg,
		uint8_t	val
	)

pure virtual

Implemented in AP_AK8963_BusDriver_Auxiliary, and AP_AK8963_BusDriver_HALDevice.

Referenced by AP_Compass_AK8963::_calibrate(), AP_Compass_AK8963::_reset(), and AP_Compass_AK8963::_setup_mode().

Here is the caller graph for this function:

◆ set_device_type()

virtual void AP_AK8963_BusDriver::set_device_type ( uint8_t devtype )

pure virtual

Implemented in AP_AK8963_BusDriver_Auxiliary, and AP_AK8963_BusDriver_HALDevice.

Referenced by AP_Compass_AK8963::init().

Here is the caller graph for this function:

◆ start_measurements()

virtual bool AP_AK8963_BusDriver::start_measurements ( )

inlinevirtual

Reimplemented in AP_AK8963_BusDriver_Auxiliary.

Definition at line 80 of file AP_Compass_AK8963.h.

Referenced by AP_Compass_AK8963::init().

Here is the caller graph for this function:

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

libraries/AP_Compass/AP_Compass_AK8963.h