mag3110/mag3110_8hpp_source.html

 #ifndef MAG3110_HPP
 #define MAG3110_HPP
 #include <cstdint>

 class MAG3110
 {
 public:

   static uint8_t const MAG3110_I2C_ADDRESS;
   static uint8_t const MAG3110_WHO_AM_I_RSP;
   static int const MAG3110_DIE_TEMP_OFFSET;


   static uint8_t const MAG3110_DR_STATUS;
   static uint8_t const MAG3110_OUT_X_MSB;
   static uint8_t const MAG3110_OUT_X_LSB;
   static uint8_t const MAG3110_OUT_Y_MSB;
   static uint8_t const MAG3110_OUT_Y_LSB;
   static uint8_t const MAG3110_OUT_Z_MSB;
   static uint8_t const MAG3110_OUT_Z_LSB;
   static uint8_t const MAG3110_WHO_AM_I;
   static uint8_t const MAG3110_SYSMOD;
   static uint8_t const MAG3110_OFF_X_MSB;
   static uint8_t const MAG3110_OFF_X_LSB;
   static uint8_t const MAG3110_OFF_Y_MSB;
   static uint8_t const MAG3110_OFF_Y_LSB;
   static uint8_t const MAG3110_OFF_Z_MSB;
   static uint8_t const MAG3110_OFF_Z_LSB;
   static uint8_t const MAG3110_DIE_TEMP;
   static uint8_t const MAG3110_CTRL_REG1;
   static uint8_t const MAG3110_CTRL_REG2;


   static uint8_t const MAG3110_DR_OS_80_16;
   static uint8_t const MAG3110_DR_OS_40_32;
   static uint8_t const MAG3110_DR_OS_20_64;
   static uint8_t const MAG3110_DR_OS_10_128;
   static uint8_t const MAG3110_DR_OS_40_16;
   static uint8_t const MAG3110_DR_OS_20_32;
   static uint8_t const MAG3110_DR_OS_10_64;
   static uint8_t const MAG3110_DR_OS_5_128;
   static uint8_t const MAG3110_DR_OS_20_16;
   static uint8_t const MAG3110_DR_OS_10_32;
   static uint8_t const MAG3110_DR_OS_5_64;
   static uint8_t const MAG3110_DR_OS_2_5_128;
   static uint8_t const MAG3110_DR_OS_10_16;
   static uint8_t const MAG3110_DR_OS_5_32;
   static uint8_t const MAG3110_DR_OS_2_5_64;
   static uint8_t const MAG3110_DR_OS_1_25_128;
   static uint8_t const MAG3110_DR_OS_5_16;
   static uint8_t const MAG3110_DR_OS_2_5_32;
   static uint8_t const MAG3110_DR_OS_1_25_64;
   static uint8_t const MAG3110_DR_OS_0_63_128;
   static uint8_t const MAG3110_DR_OS_2_5_16;
   static uint8_t const MAG3110_DR_OS_1_25_32;
   static uint8_t const MAG3110_DR_OS_0_63_64;
   static uint8_t const MAG3110_DR_OS_0_31_128;
   static uint8_t const MAG3110_DR_OS_1_25_16;
   static uint8_t const MAG3110_DR_OS_0_63_32;
   static uint8_t const MAG3110_DR_OS_0_31_64;
   static uint8_t const MAG3110_DR_OS_0_16_128;
   static uint8_t const MAG3110_DR_OS_0_63_16;
   static uint8_t const MAG3110_DR_OS_0_31_32;
   static uint8_t const MAG3110_DR_OS_0_16_64;
   static uint8_t const MAG3110_DR_OS_0_08_128;


   static uint8_t const MAG3110_FAST_READ;
   static uint8_t const MAG3110_TRIGGER_MEASUREMENT;
   static uint8_t const MAG3110_ACTIVE_MODE;


   static uint8_t const MAG3110_AUTO_MRST_EN;
   static uint8_t const MAG3110_RAW_MODE;
   static uint8_t const MAG3110_MAG_RST;


   static uint8_t const MAG3110_SYSMOD_STANDBY;
   static uint8_t const MAG3110_SYSMOD_ACTIVE_RAW;
   static uint8_t const MAG3110_SYSMOD_ACTIVE;


   static uint8_t const MAG3110_DR_STATUS_XDR;
   static uint8_t const MAG3110_DR_STATUS_YDR;
   static uint8_t const MAG3110_DR_STATUS_ZDR;
   static uint8_t const MAG3110_DR_STATUS_XYZDR;
   static uint8_t const MAG3110_DR_STATUS_XOW;
   static uint8_t const MAG3110_DR_STATUS_YOW;
   static uint8_t const MAG3110_DR_STATUS_ZOW;
   static uint8_t const MAG3110_DR_STATUS_XYZOW;


   static uint8_t const MAG3110_X_AXIS;
   static uint8_t const MAG3110_Y_AXIS;
   static uint8_t const MAG3110_Z_AXIS;

   MAG3110(void);
   ~MAG3110(void);
   void getVersion(void) const;
   void setDebug(bool t_debug);
   void initialize(const char* t_bus);
   uint8_t readRegister(uint8_t const& t_addr) const;
   void writeRegister(uint8_t const& t_addr, uint8_t const& t_val) const;
   void standby(void);
   void start(void) const;
   void reset(void);
   bool isActive(void) const;
   bool isRaw(void) const;
   void setRawMode(bool const t_raw) const;
   void setFastRead(bool const t_fast) const;
   void triggerMeasurement(void) const;
   bool isDataReady(void) const;
   void setDR_OS(uint8_t const t_DROS);
   uint8_t getDR_OS(void) const;
   void setDelay(uint8_t t_DROS);
   void setDelay(int t_delay);
   int getDelay(void) const;
   void setOffset(int const& t_bxoff, int const& t_byoff,
     int const& t_bzoff) const;
   void getOffset(int* t_bxoff, int* t_byoff, int* t_bzoff) const;
   void calibrate(void);
   void getMag(int* t_bx, int* t_by, int* t_bz) const;
   void getMagDelayed(int* t_bx, int* t_by, int* t_bz) const;
   void getMagPoll(int* t_bx, int* t_by, int* t_bz) const;
   double getMagnitude(int const& t_bx, int const& t_by,
     int const& t_bz) const;
   void displayMag(int const& t_bx, int const& t_by, int const& t_bz) const;
   void displayMag(int const& t_bx, int const& t_by, int const& t_bz,
     double const& t_mag) const;
   int getTemperature(void) const;

 private:
   bool m_debug;
   int m_fd;
   int m_delay;
 };

 #endif // MAG3110_HPP
MAG3110::MAG3110_AUTO_MRST_EN
static uint8_t const MAG3110_AUTO_MRST_EN
Automatic magnetic sensor reset.
Definition: mag3110.hpp:151

MAG3110::setDebug
void setDebug(bool t_debug)
Control debug output.
Definition: mag3110.cpp:121

MAG3110::MAG3110_DR_OS_1_25_16
static uint8_t const MAG3110_DR_OS_1_25_16
Output rate = 1.25 Hz, oversampling ratio = 16.
Definition: mag3110.hpp:119

MAG3110::MAG3110_DR_OS_10_128
static uint8_t const MAG3110_DR_OS_10_128
Output rate = 10 Hz, oversampling ratio = 128.
Definition: mag3110.hpp:77

MAG3110::setOffset
void setOffset(int const &t_bxoff, int const &t_byoff, int const &t_bzoff) const
Set magnetic offset.
Definition: mag3110.cpp:319

MAG3110::MAG3110_OFF_Y_MSB
static uint8_t const MAG3110_OFF_Y_MSB
Bits [14:7] of user Y offset.
Definition: mag3110.hpp:52

MAG3110::MAG3110_DR_STATUS_YDR
static uint8_t const MAG3110_DR_STATUS_YDR
Y-axis new data available.
Definition: mag3110.hpp:175

MAG3110::MAG3110_DR_OS_1_25_32
static uint8_t const MAG3110_DR_OS_1_25_32
Output rate = 1.25 Hz, oversampling ratio = 32.
Definition: mag3110.hpp:113

MAG3110::MAG3110_DR_OS_2_5_128
static uint8_t const MAG3110_DR_OS_2_5_128
Output rate = 2.5 Hz, oversampling ratio = 128.
Definition: mag3110.hpp:93

MAG3110::MAG3110_OUT_Y_LSB
static uint8_t const MAG3110_OUT_Y_LSB
Bits [7:0] of Y measurement.
Definition: mag3110.hpp:38

MAG3110::getMagDelayed
void getMagDelayed(int *t_bx, int *t_by, int *t_bz) const
Get magnetic field strength (delayed)
Definition: mag3110.cpp:411

MAG3110::standby
void standby(void)
Standby.
Definition: mag3110.cpp:173

MAG3110::MAG3110_DR_OS_5_32
static uint8_t const MAG3110_DR_OS_5_32
Output rate = 5 Hz, oversampling ratio = 32.
Definition: mag3110.hpp:97

MAG3110::MAG3110_DR_OS_20_32
static uint8_t const MAG3110_DR_OS_20_32
Output rate = 20 Hz, oversampling ratio = 32.
Definition: mag3110.hpp:81

MAG3110::getDR_OS
uint8_t getDR_OS(void) const
Get data rate and oversampling ratio.
Definition: mag3110.cpp:259

MAG3110::calibrate
void calibrate(void)
Calibrate magnetic reading.
Definition: mag3110.cpp:348

MAG3110::MAG3110_DR_OS_20_64
static uint8_t const MAG3110_DR_OS_20_64
Output rate = 20 Hz, oversampling ratio = 64.
Definition: mag3110.hpp:75

MAG3110::displayMag
void displayMag(int const &t_bx, int const &t_by, int const &t_bz) const
Display magnetic field strength.
Definition: mag3110.cpp:440

MAG3110::getTemperature
int getTemperature(void) const
Get temperature.
Definition: mag3110.cpp:458

MAG3110::MAG3110_Z_AXIS
static uint8_t const MAG3110_Z_AXIS
Z-axis base address.
Definition: mag3110.hpp:198

MAG3110::MAG3110_DR_OS_1_25_128
static uint8_t const MAG3110_DR_OS_1_25_128
Output rate = 1.25 Hz, oversampling ratio = 128.
Definition: mag3110.hpp:101

MAG3110::getMagPoll
void getMagPoll(int *t_bx, int *t_by, int *t_bz) const
Poll magnetic field strength.
Definition: mag3110.cpp:417

MAG3110::MAG3110_DR_STATUS_XYZDR
static uint8_t const MAG3110_DR_STATUS_XYZDR
X-,Y- or Z-axis new data available.
Definition: mag3110.hpp:179

MAG3110::MAG3110_DR_STATUS_XYZOW
static uint8_t const MAG3110_DR_STATUS_XYZOW
X-, Y- or Z-axis data overwrite.
Definition: mag3110.hpp:187

MAG3110::getOffset
void getOffset(int *t_bxoff, int *t_byoff, int *t_bzoff) const
Get magnetic offset.
Definition: mag3110.cpp:332

MAG3110::MAG3110_X_AXIS
static uint8_t const MAG3110_X_AXIS
X-axis base address.
Definition: mag3110.hpp:194

MAG3110::MAG3110_DR_OS_0_31_128
static uint8_t const MAG3110_DR_OS_0_31_128
Output rate = 0.31 Hz, oversampling ratio = 128.
Definition: mag3110.hpp:117

MAG3110::setDelay
void setDelay(uint8_t t_DROS)
Set delay.
Definition: mag3110.cpp:265

MAG3110::isActive
bool isActive(void) const
Test if active.
Definition: mag3110.cpp:201

MAG3110::MAG3110_OUT_Z_LSB
static uint8_t const MAG3110_OUT_Z_LSB
Bits [7:0] of Z measurement.
Definition: mag3110.hpp:42

MAG3110::MAG3110_DR_OS_10_64
static uint8_t const MAG3110_DR_OS_10_64
Output rate = 10 Hz, oversampling ratio = 64.
Definition: mag3110.hpp:83

MAG3110::MAG3110_DR_STATUS
static uint8_t const MAG3110_DR_STATUS
Data ready status per axis.
Definition: mag3110.hpp:30

MAG3110::MAG3110_DR_OS_5_16
static uint8_t const MAG3110_DR_OS_5_16
Output rate = 5 Hz, oversampling ratio = 16.
Definition: mag3110.hpp:103

MAG3110::reset
void reset(void)
Reset.
Definition: mag3110.cpp:188

MAG3110::MAG3110_DR_OS_0_31_64
static uint8_t const MAG3110_DR_OS_0_31_64
Output rate = 0.31 Hz, oversampling ratio = 64.
Definition: mag3110.hpp:123

MAG3110::setRawMode
void setRawMode(bool const t_raw) const
Set raw mode.
Definition: mag3110.cpp:213

MAG3110::MAG3110_DR_STATUS_XOW
static uint8_t const MAG3110_DR_STATUS_XOW
X-axis data overwrite.
Definition: mag3110.hpp:181

MAG3110::MAG3110_OUT_Y_MSB
static uint8_t const MAG3110_OUT_Y_MSB
Bits [15:8] of Y measurement.
Definition: mag3110.hpp:36

MAG3110::MAG3110_OFF_X_MSB
static uint8_t const MAG3110_OFF_X_MSB
Bits [14:7] of user X offset.
Definition: mag3110.hpp:48

MAG3110::MAG3110_DR_STATUS_XDR
static uint8_t const MAG3110_DR_STATUS_XDR
X-axis new data available.
Definition: mag3110.hpp:173

MAG3110::MAG3110_I2C_ADDRESS
static uint8_t const MAG3110_I2C_ADDRESS
I2C address of the chip.
Definition: mag3110.hpp:19

MAG3110::MAG3110_DR_OS_0_63_16
static uint8_t const MAG3110_DR_OS_0_63_16
Output rate = 0.63 Hz, oversampling ratio = 16.
Definition: mag3110.hpp:127

MAG3110::getMagnitude
double getMagnitude(int const &t_bx, int const &t_by, int const &t_bz) const
Calculate magnetic field strength.
Definition: mag3110.cpp:432

MAG3110::MAG3110_OFF_Z_MSB
static uint8_t const MAG3110_OFF_Z_MSB
Bits [14:7] of user Z offset.
Definition: mag3110.hpp:56

MAG3110::MAG3110_DR_OS_0_16_64
static uint8_t const MAG3110_DR_OS_0_16_64
Output rate = 0.16 Hz, oversampling ratio = 64.
Definition: mag3110.hpp:131

MAG3110::MAG3110_DR_OS_80_16
static uint8_t const MAG3110_DR_OS_80_16
Output rate = 80 Hz, oversampling ratio = 16.
Definition: mag3110.hpp:71

MAG3110::setDR_OS
void setDR_OS(uint8_t const t_DROS)
Set data rate and oversampling ratio.
Definition: mag3110.cpp:245

MAG3110::MAG3110_DR_OS_10_32
static uint8_t const MAG3110_DR_OS_10_32
Output rate = 10 Hz, oversampling ratio = 32.
Definition: mag3110.hpp:89

MAG3110::start
void start(void) const
Start.
Definition: mag3110.cpp:182

MAG3110::MAG3110_OUT_Z_MSB
static uint8_t const MAG3110_OUT_Z_MSB
Bits [15:8] of Z measurement.
Definition: mag3110.hpp:40

MAG3110::triggerMeasurement
void triggerMeasurement(void) const
Trigger measurement.
Definition: mag3110.cpp:231

MAG3110::MAG3110_DR_OS_0_31_32
static uint8_t const MAG3110_DR_OS_0_31_32
Output rate = 0.31 Hz, oversampling ratio = 32.
Definition: mag3110.hpp:129

MAG3110::MAG3110_OUT_X_LSB
static uint8_t const MAG3110_OUT_X_LSB
Bits [7:0] of X measurement.
Definition: mag3110.hpp:34

MAG3110::MAG3110_DR_OS_0_08_128
static uint8_t const MAG3110_DR_OS_0_08_128
Output rate = 0.08 Hz, oversampling ratio = 128.
Definition: mag3110.hpp:133

MAG3110::MAG3110_DR_OS_20_16
static uint8_t const MAG3110_DR_OS_20_16
Output rate = 20 Hz, oversampling ratio = 16.
Definition: mag3110.hpp:87

MAG3110::MAG3110_DR_OS_10_16
static uint8_t const MAG3110_DR_OS_10_16
Output rate = 10 Hz, oversampling ratio = 16.
Definition: mag3110.hpp:95

MAG3110::MAG3110_RAW_MODE
static uint8_t const MAG3110_RAW_MODE
Data output correction.
Definition: mag3110.hpp:153

MAG3110::MAG3110_DR_OS_2_5_32
static uint8_t const MAG3110_DR_OS_2_5_32
Output rate = 2.5 Hz, oversampling ratio = 32.
Definition: mag3110.hpp:105

MAG3110::MAG3110_SYSMOD_ACTIVE_RAW
static uint8_t const MAG3110_SYSMOD_ACTIVE_RAW
Active mode, raw data.
Definition: mag3110.hpp:164

MAG3110::MAG3110_CTRL_REG2
static uint8_t const MAG3110_CTRL_REG2
Operation modes.
Definition: mag3110.hpp:64

MAG3110::MAG3110_DR_OS_40_16
static uint8_t const MAG3110_DR_OS_40_16
Output rate = 40 Hz, oversampling ratio = 16.
Definition: mag3110.hpp:79

MAG3110::setFastRead
void setFastRead(bool const t_fast) const
Set fast read.
Definition: mag3110.cpp:222

MAG3110::MAG3110_DR_OS_40_32
static uint8_t const MAG3110_DR_OS_40_32
Output rate = 40 Hz, oversampling ratio = 32.
Definition: mag3110.hpp:73

MAG3110::MAG3110_Y_AXIS
static uint8_t const MAG3110_Y_AXIS
Y-axis base address.
Definition: mag3110.hpp:196

MAG3110::MAG3110_DR_OS_0_16_128
static uint8_t const MAG3110_DR_OS_0_16_128
Output rate = 0.16 Hz, oversampling ratio = 128.
Definition: mag3110.hpp:125

MAG3110::MAG3110_DR_OS_5_128
static uint8_t const MAG3110_DR_OS_5_128
Output rate = 5 Hz, oversampling ratio = 128.
Definition: mag3110.hpp:85

MAG3110::getDelay
int getDelay(void) const
Get delay.
Definition: mag3110.cpp:314

MAG3110::MAG3110_OFF_X_LSB
static uint8_t const MAG3110_OFF_X_LSB
Bits [6:0] of user X offset.
Definition: mag3110.hpp:50

MAG3110::MAG3110_WHO_AM_I
static uint8_t const MAG3110_WHO_AM_I
Device identification.
Definition: mag3110.hpp:44

MAG3110::readRegister
uint8_t readRegister(uint8_t const &t_addr) const
Read a register.
Definition: mag3110.cpp:145

MAG3110::MAG3110_DIE_TEMP
static uint8_t const MAG3110_DIE_TEMP
Temperature, signed 8 bits in °C.
Definition: mag3110.hpp:60

MAG3110::MAG3110_FAST_READ
static uint8_t const MAG3110_FAST_READ
Fast read mode.
Definition: mag3110.hpp:140

MAG3110::MAG3110_MAG_RST
static uint8_t const MAG3110_MAG_RST
Magnetic sensor reset (one-shot).
Definition: mag3110.hpp:155

MAG3110::isRaw
bool isRaw(void) const
Test if raw mode.
Definition: mag3110.cpp:207

MAG3110::initialize
void initialize(const char *t_bus)
Initialize I2C communication.
Definition: mag3110.cpp:126

MAG3110::isDataReady
bool isDataReady(void) const
Test if new data are ready.
Definition: mag3110.cpp:239

MAG3110::MAG3110_OFF_Y_LSB
static uint8_t const MAG3110_OFF_Y_LSB
Bits [6:0] of user Y offset.
Definition: mag3110.hpp:54

MAG3110::MAG3110_DR_OS_0_63_128
static uint8_t const MAG3110_DR_OS_0_63_128
Output rate = 0.63 Hz, oversampling ratio = 128.
Definition: mag3110.hpp:109

MAG3110::MAG3110_TRIGGER_MEASUREMENT
static uint8_t const MAG3110_TRIGGER_MEASUREMENT
Trigger immediate measurement.
Definition: mag3110.hpp:142

MAG3110::MAG3110_DR_OS_2_5_16
static uint8_t const MAG3110_DR_OS_2_5_16
Output rate = 2.5 Hz, oversampling ratio = 16.
Definition: mag3110.hpp:111

MAG3110::MAG3110_OUT_X_MSB
static uint8_t const MAG3110_OUT_X_MSB
Bits [15:8] of X measurement.
Definition: mag3110.hpp:32

MAG3110::MAG3110_CTRL_REG1
static uint8_t const MAG3110_CTRL_REG1
Operation modes.
Definition: mag3110.hpp:62

MAG3110::MAG3110
MAG3110(void)
Default constructor.
Definition: mag3110.cpp:100

MAG3110::MAG3110_WHO_AM_I_RSP
static uint8_t const MAG3110_WHO_AM_I_RSP
Device identifier.
Definition: mag3110.hpp:21

MAG3110::writeRegister
void writeRegister(uint8_t const &t_addr, uint8_t const &t_val) const
Write a register.
Definition: mag3110.cpp:160

MAG3110::MAG3110_DR_STATUS_ZDR
static uint8_t const MAG3110_DR_STATUS_ZDR
Z-axis new data available.
Definition: mag3110.hpp:177

MAG3110::MAG3110_SYSMOD_ACTIVE
static uint8_t const MAG3110_SYSMOD_ACTIVE
Active mode, user corrected data.
Definition: mag3110.hpp:166

MAG3110::~MAG3110
~MAG3110(void)
Default destcructor.
Definition: mag3110.cpp:106

MAG3110::MAG3110_SYSMOD_STANDBY
static uint8_t const MAG3110_SYSMOD_STANDBY
Standby mode.
Definition: mag3110.hpp:162

MAG3110::getVersion
void getVersion(void) const
Definition: mag3110.cpp:113

MAG3110::MAG3110_OFF_Z_LSB
static uint8_t const MAG3110_OFF_Z_LSB
Bits [6:0] of user Z offset.
Definition: mag3110.hpp:58

MAG3110::MAG3110_DR_STATUS_ZOW
static uint8_t const MAG3110_DR_STATUS_ZOW
Z-axis data overwrite.
Definition: mag3110.hpp:185

MAG3110::getMag
void getMag(int *t_bx, int *t_by, int *t_bz) const
Get magnetic field strength.
Definition: mag3110.cpp:388

MAG3110
A class to drive the MAG3110 3-axis magnetometer.
Definition: mag3110.hpp:12

MAG3110::MAG3110_SYSMOD
static uint8_t const MAG3110_SYSMOD
Current System Mode.
Definition: mag3110.hpp:46

MAG3110::MAG3110_DR_STATUS_YOW
static uint8_t const MAG3110_DR_STATUS_YOW
Y-axis data overwrite.
Definition: mag3110.hpp:183

MAG3110::MAG3110_DR_OS_2_5_64
static uint8_t const MAG3110_DR_OS_2_5_64
Output rate = 2.5 Hz, oversampling ratio = 64.
Definition: mag3110.hpp:99

MAG3110::MAG3110_DR_OS_0_63_64
static uint8_t const MAG3110_DR_OS_0_63_64
Output rate = 0.63 Hz, oversampling ratio = 64.
Definition: mag3110.hpp:115

MAG3110::MAG3110_DR_OS_1_25_64
static uint8_t const MAG3110_DR_OS_1_25_64
Output rate = 1.25 Hz, oversampling ratio = 64.
Definition: mag3110.hpp:107

MAG3110::MAG3110_ACTIVE_MODE
static uint8_t const MAG3110_ACTIVE_MODE
Operation mode.
Definition: mag3110.hpp:144

MAG3110::MAG3110_DIE_TEMP_OFFSET
static int const MAG3110_DIE_TEMP_OFFSET
Temperature offset.
Definition: mag3110.hpp:23

MAG3110::MAG3110_DR_OS_0_63_32
static uint8_t const MAG3110_DR_OS_0_63_32
Output rate = 0.63 Hz, oversampling ratio = 32.
Definition: mag3110.hpp:121

MAG3110::MAG3110_DR_OS_5_64
static uint8_t const MAG3110_DR_OS_5_64
Output rate = 5 Hz, oversampling ratio = 64.
Definition: mag3110.hpp:91