The BMX160 is a highly integrated, low power 9-axis sensor that provides precise acceleration and angular rate (gyroscopic) and geomagnetic measurement in each spatial direction.
The BMX160 contains 16 bit digtial,triaxial accelerometer 16 bit digital, triaxial gyroscope and geomagnetic sensor.
This library provides basic support for configuring functions and reading data.
- Product Repository - Product repository for the RAKWireless RAK12034 module.
- Documentation - Documentation and Quick Start Guide for the RAK12034 module.
In Arduino IDE, open Sketch->Include Library->Manage Libraries then search for RAK12034 .
In PlatformIO open PlatformIO Home, switch to libraries and search for RAK12034 . Or install the library project dependencies by adding:
lib_deps = rakwireless/RAK12034-BMX160 library
into platformio.ini
For manual installation, download the archive, unzip it and place the RAK12034-BMX160 folder into the library directory. In Arduino IDE this is usually /libraries/ In PlatformIO this is usually <user/.platformio/lib>
The library provides an BMX160 class that allows you to communicate with BMX160 and get the chip data. Check out the examples how to get the chip data.
bool begin();
Set the i2c addr and init the i2c.
Parameters:
Direction | Name | Function |
---|---|---|
return | true Initialization succeeded,false Initialization failed |
void readReg(uint8_t reg, uint8_t *pBuf, uint16_t len);
Get the sensor IIC data.
Parameters:
Direction | Name | Function |
---|---|---|
in | reg | reg register |
out | pBuf | get the store and buffer of the data |
in | len | len data length to be readed |
return | none |
void writeReg(uint8_t reg, uint8_t *pBuf, uint16_t len);
write the sensor IIC data.
Parameters:
Direction | Name | Function |
---|---|---|
in | reg | reg register |
in | pBuf | write the store and buffer of the data |
in | len | len data length to be readed |
return | none |
void writeBmxReg(uint8_t reg, uint8_t value);
Write data to the BMX register.
Parameters:
Direction | Name | Function |
---|---|---|
in | reg | reg register |
in | value | data written to the BMX register |
return | none |
void setGyroRange(eGyroRange_t bits);
Set gyroscope angular rate range and resolution.
Parameters:
Direction | Name | Function |
---|---|---|
in | bits | set gyroscope angular rate range and resolution |
return | none |
void setAccelRange(eAccelRange_t bits);
Allow the selection of the accelerometer g-range.
Parameters:
Direction | Name | Function |
---|---|---|
in | bits | set the accelerometer g-range |
return | none |
void getAllData( sBmx160SensorData_t *magn, sBmx160SensorData_t *gyro, sBmx160SensorData_t *accel);
Get the magn, gyro and accel data
Parameters:
Direction | Name | Function |
---|---|---|
in | magn | to store the magn data |
in | gyro | to store the gyro data |
in | accel | to store the accel data |
return | none |
bool softReset();
Reset bmx160 hardware.
Parameters:
Direction | Name | Function |
---|---|---|
return | true reset succeeded, false reset failed |
void setLowPower();
Disabled the the magn, gyro sensor to reduce power consumption.
Parameters:
Direction | Name | Function |
---|---|---|
return | none |
void wakeUp();
Enabled the the magn, gyro sensor.
Parameters:
Direction | Name | Function |
---|---|---|
return | none |
int32_t getTemperature(float *temp);
Get BMX160 Temperature.
Parameters:
Direction | Name | Function |
---|---|---|
out | temp | get BMX160 Temperature |
return | none |
void InterruptConfig(uint8_t interrupt_enable, uint8_t interrupt_high_th);
Set BMX160 Interrupt.
Parameters:
Direction | Name | Function |
---|---|---|
in | interrupt_enable | enable HIGH_G_Interrupt |
in | interrupt_high_th | set the accelerometer threshold |
return | none |
void ODR_Config(uint8_t accelCfg_odr, uint8_t gyroCfg_odr);
Set BMX160 Output data rate.
Parameters:
Direction | Name | Function |
---|---|---|
in | accelCfg_odr | set accelerometer output data rate |
in | gyroCfg_odr | set gyroscope output data rate |
return | none |
void get_ORD_Config(float *accelCfg_odr, float *gyroCfg_odr);
Get BMX160 Output data rate.
Parameters:
Direction | Name | Function |
---|---|---|
out | accelCfg_odr | get accelerometer output data rate |
out | gyroCfg_odr | get gyroscope output data rate |
return | none |
Original documentation from DFRobot
The BMX160 is a highly integrated, low power 9-axis sensor that provides precise acceleration and angular rate (gyroscopic) and geomagnetic measurement in each spatial direction.
The BMX160 contains 16 bit digtial,triaxial accelerometer 16 bit digital, triaxial gyroscope and geomagnetic sensor.
This example is for BMX160 sensor and it oprated via Arduino I2C.
Product Link(https://www.dfrobot.com/product-2141.html)
SKU:SEN0373
Provide an Arduino library to control the bmx160 to get magnetometer accelerometer, gyroscope and step counter, via I2C communication.
There are two ways to use the library:
- Open the Arduino IDE, search for "DFRobot_BMX160" in Tools --> Manager Libraries on the status bar, and install the library.
- First download the library file, paste it into the \Arduino\libraries directory, then open the examples folder and run the demo in that folder.
/**
* @fn begin
* @brief set the i2c addr and init the i2c.
* @return returns the initialization status
* @retval true Initialization succeeded
* @retval false Initialization failed
*/
bool begin();
/**
* @fn setGyroRange
* @brief set gyroscope angular rate range and resolution.
* @param bits
* @n eGyroRange_2000DPS Gyroscope sensitivity at 2000dps
* @n eGyroRange_1000DPS Gyroscope sensitivity at 1000dps
* @n eGyroRange_500DPS Gyroscope sensitivity at 500dps
* @n eGyroRange_250DPS Gyroscope sensitivity at 250dps
* @n eGyroRange_125DPS Gyroscope sensitivity at 125dps
*/
void setGyroRange(eGyroRange_t bits);
/**
* @fn setAccelRange
* @brief allow the selection of the accelerometer g-range.
* @param bits
* @n eAccelRange_2G Macro for mg per LSB at +/- 2g sensitivity (1 LSB = 0.000061035mg)
* @n eAccelRange_4G Macro for mg per LSB at +/- 4g sensitivity (1 LSB = 0.000122070mg)
* @n eAccelRange_8G Macro for mg per LSB at +/- 8g sensitivity (1 LSB = 0.000244141mg)
* @n eAccelRange_16G Macro for mg per LSB at +/- 16g sensitivity (1 LSB = 0.000488281mg)
*/
void setAccelRange(eAccelRange_t bits);
/**
* @fn getAllData
* @brief get the magn, gyro and accel data
* @param magn to store the magn data
* @param gyro to store the gyro data
* @param accel to store the accel data
*/
void getAllData( sBmx160SensorData_t *magn, sBmx160SensorData_t *gyro, sBmx160SensorData_t *accel);
/**
* @fn softReset
* @brief reset bmx160 hardware
* @return returns the reset status
* @retval true reset succeeded
* @retval false reset failed
*/
bool softReset();
/**
* @fn setLowPower
* @brief disabled the the magn, gyro sensor to reduce power consumption
*/
void setLowPower();
/**
* @fn wakeUp
* @brief enabled the the magn, gyro sensor
*/
void wakeUp();
Board | Work Well | Work Wrong | Untested | Remarks |
---|---|---|---|---|
Arduino uno | v | |||
Mega2560 | v | |||
Leonardo | v | |||
ESP32 | v | |||
micro:bit | v | |||
FireBeetle M0 | v |
- 2021/10/20 - Version 1.0.1 released.
- 2019/06/25 - Version 1.0.0 released.
Written by Fary([email protected]), 2021. (Welcome to our website)