M5Unified
Public Member Functions | Static Public Attributes | List of all members
m5::AK8963_Class Class Reference

#include <AK8963_Class.hpp>

Inheritance diagram for m5::AK8963_Class:
Inheritance graph
[legend]
Collaboration diagram for m5::AK8963_Class:
Collaboration graph
[legend]

Public Member Functions

virtual ~AK8963_Class ()
 
 AK8963_Class (std::uint8_t i2c_addr=DEFAULT_ADDRESS, std::uint32_t freq=400000, I2C_Class *i2c=&In_I2C)
 
imu_spec_t begin (I2C_Class *i2c=nullptr) override
 
imu_spec_t getImuRawData (imu_raw_data_t *data) const override
 
void getConvertParam (imu_convert_param_t *param) const override
 
std::uint8_t WhoAmI (void)
 
- Public Member Functions inherited from m5::IMU_Base
virtual ~IMU_Base ()
 
 IMU_Base (std::uint8_t i2c_addr, std::uint32_t freq=400000, I2C_Class *i2c=&In_I2C)
 
virtual bool getTempAdc (int16_t *adc) const
 
virtual bool setINTPinActiveLogic (bool level)
 
- Public Member Functions inherited from m5::I2C_Device
 I2C_Device (std::uint8_t i2c_addr, std::uint32_t freq, I2C_Class *i2c=&In_I2C)
 
void setPort (I2C_Class *i2c)
 
bool writeRegister8 (std::uint8_t reg, std::uint8_t data) const
 
std::uint8_t readRegister8 (std::uint8_t reg) const
 
bool writeRegister8Array (const std::uint8_t *reg_data_array, std::size_t length) const
 
bool writeRegister (std::uint8_t reg, const std::uint8_t *data, std::size_t length) const
 
bool readRegister (std::uint8_t reg, std::uint8_t *result, std::size_t length) const
 
bool bitOn (std::uint8_t reg, std::uint8_t bit) const
 
bool bitOff (std::uint8_t reg, std::uint8_t bit) const
 
bool isEnabled (void) const
 

Static Public Attributes

static constexpr const std::uint8_t WHO_AM_I_ADDR = 0x00
 
static constexpr const std::uint8_t STATUS1_ADDR = 0x02
 
static constexpr const std::uint8_t XOUT_L_ADDR = 0x03
 
static constexpr const std::uint8_t CTRL_CMD_ADDR = 0x0A
 
static constexpr const std::uint8_t ASAX_ADDR = 0x10
 
static constexpr const std::uint8_t POWER_DOWN_CMD = 0x00
 
static constexpr const std::uint8_t SINGLE_MEASURE_CMD = 0x01
 
static constexpr const std::uint8_t SELF_TEST_CMD = 0x08
 
static constexpr const std::uint8_t FUSE_ROM_CMD = 0x0F
 
static constexpr std::uint8_t DEFAULT_ADDRESS = 0x0C
 

Additional Inherited Members

- Public Types inherited from m5::IMU_Base
enum  imu_spec_t { imu_spec_none = 0 , imu_spec_accel = 0b0001 , imu_spec_gyro = 0b0010 , imu_spec_mag = 0b0100 }
 
- Protected Attributes inherited from m5::I2C_Device
I2C_Class * _i2c
 
std::uint32_t _freq
 
std::uint8_t _addr
 
bool _init
 

Detailed Description

Definition at line 11 of file AK8963_Class.hpp.

Constructor & Destructor Documentation

◆ ~AK8963_Class()

virtual m5::AK8963_Class::~AK8963_Class ( )
virtual

◆ AK8963_Class()

m5::AK8963_Class::AK8963_Class ( std::uint8_t  i2c_addr = DEFAULT_ADDRESS,
std::uint32_t  freq = 400000,
I2C_Class *  i2c = &In_I2C 
)

Member Function Documentation

◆ begin()

imu_spec_t m5::AK8963_Class::begin ( I2C_Class *  i2c = nullptr)
overridevirtual

Implements m5::IMU_Base.

◆ getConvertParam()

void m5::AK8963_Class::getConvertParam ( imu_convert_param_t *  param) const
overridevirtual

Implements m5::IMU_Base.

◆ getImuRawData()

imu_spec_t m5::AK8963_Class::getImuRawData ( imu_raw_data_t *  data) const
overridevirtual

Implements m5::IMU_Base.

◆ WhoAmI()

std::uint8_t m5::AK8963_Class::WhoAmI ( void  )

Member Data Documentation

◆ ASAX_ADDR

constexpr const std::uint8_t m5::AK8963_Class::ASAX_ADDR = 0x10
staticconstexpr

Definition at line 18 of file AK8963_Class.hpp.

◆ CTRL_CMD_ADDR

constexpr const std::uint8_t m5::AK8963_Class::CTRL_CMD_ADDR = 0x0A
staticconstexpr

Definition at line 17 of file AK8963_Class.hpp.

◆ DEFAULT_ADDRESS

constexpr std::uint8_t m5::AK8963_Class::DEFAULT_ADDRESS = 0x0C
staticconstexpr

Definition at line 25 of file AK8963_Class.hpp.

◆ FUSE_ROM_CMD

constexpr const std::uint8_t m5::AK8963_Class::FUSE_ROM_CMD = 0x0F
staticconstexpr

Definition at line 23 of file AK8963_Class.hpp.

◆ POWER_DOWN_CMD

constexpr const std::uint8_t m5::AK8963_Class::POWER_DOWN_CMD = 0x00
staticconstexpr

Definition at line 20 of file AK8963_Class.hpp.

◆ SELF_TEST_CMD

constexpr const std::uint8_t m5::AK8963_Class::SELF_TEST_CMD = 0x08
staticconstexpr

Definition at line 22 of file AK8963_Class.hpp.

◆ SINGLE_MEASURE_CMD

constexpr const std::uint8_t m5::AK8963_Class::SINGLE_MEASURE_CMD = 0x01
staticconstexpr

Definition at line 21 of file AK8963_Class.hpp.

◆ STATUS1_ADDR

constexpr const std::uint8_t m5::AK8963_Class::STATUS1_ADDR = 0x02
staticconstexpr

Definition at line 15 of file AK8963_Class.hpp.

◆ WHO_AM_I_ADDR

constexpr const std::uint8_t m5::AK8963_Class::WHO_AM_I_ADDR = 0x00
staticconstexpr

Definition at line 14 of file AK8963_Class.hpp.

◆ XOUT_L_ADDR

constexpr const std::uint8_t m5::AK8963_Class::XOUT_L_ADDR = 0x03
staticconstexpr

Definition at line 16 of file AK8963_Class.hpp.

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