c13dof 2.0.0.0
Public function

Functions

void c13dof_cfg_setup (c13dof_cfg_t *cfg)
 Config Object Initialization function.
 
C13DOF_RETVAL c13dof_init (c13dof_t *ctx, c13dof_cfg_t *cfg)
 Initialization function.
 
void c13dof_default_cfg (c13dof_t *ctx)
 Click Default Configuration function.
 
void c13dof_bme680_write_byte (c13dof_t *ctx, uint8_t reg_address, uint8_t write_data)
 Generic BME680 write the byte of data function.
 
uint8_t c13dof_bme680_read_byte (c13dof_t *ctx, uint8_t reg_address)
 Generic BME680 read byte of data function.
 
C13DOF_BME680_RETVAL_T c13dof_bme680_check_id (c13dof_t *ctx)
 Check BME680 device ID function.
 
uint8_t c13dof_bme680_get_device_id (c13dof_t *ctx)
 Get BME680 device ID function.
 
void c13dof_bme680_soft_reset (c13dof_t *ctx)
 Software BME680 reset function.
 
void c13dof_bme680_get_calibration_data (c13dof_t *ctx)
 Get BME680 factory calibration parameters function.
 
float c13dof_bme680_get_ambient_data (c13dof_t *ctx, uint8_t data_in)
 Get BME680 ambient data function.
 
float c13dof_bme680_get_temperature (c13dof_t *ctx)
 Gets BME680 temperature in degrees Celsius function.
 
float c13dof_bme680_get_humidity (c13dof_t *ctx)
 Gets BME680 humidity in percentage [ % ] function.
 
float c13dof_bme680_get_pressure (c13dof_t *ctx)
 Gets BME680 pressure in degrees Celsius function.
 
uint32_t c13dof_bme680_get_gas_resistance (c13dof_t *ctx)
 Gets BME680 gas resistance data function.
 
C13DOF_BMM150_RETVAL_T c13dof_bmm150_write_byte (c13dof_t *ctx, uint8_t reg_address, uint8_t write_data)
 Generic BMM150 write the byte of data function.
 
uint8_t c13dof_bmm150_read_byte (c13dof_t *ctx, uint8_t reg_address)
 Generic BMM150 read byte of data function.
 
C13DOF_BMM150_RETVAL_T c13dof_bmm150_read_bytes (c13dof_t *ctx, uint8_t *data_out, uint8_t reg_address, uint8_t n_bytes)
 Generic BMM150 sequential data read function.
 
C13DOF_BMM150_RETVAL_T c13dof_bmm150_check_ready (c13dof_t *ctx)
 Check BMM150 data ready status function.
 
void c13dof_bmm150_read_geo_mag_data (c13dof_t *ctx, int16_t *mag_x, int16_t *mag_y, int16_t *mag_z, uint16_t *res_hall)
 Get BMM150 Geomagnetic sensors data function.
 
void c13dof_bmm150_soft_reset (c13dof_t *ctx)
 Software BMM150 reset function.
 
void c13dof_bmm150_power_on_reset (c13dof_t *ctx)
 BMM150 power ON reset function.
 
void c13dof_bmi088_gyro_write_byte (c13dof_t *ctx, uint8_t reg_address, uint8_t write_data)
 Generic BMI088 Gyro write data function.
 
void c13dof_bmi088_gyro_write_bytes (c13dof_t *ctx, uint8_t reg_address, uint8_t *write_data, uint8_t n_bytes)
 Generic sequential BMI088 Gyro write data function.
 
uint8_t c13dof_bmi088_gyro_read_byte (c13dof_t *ctx, uint8_t reg_address)
 Generic BMI088 Gyro read data function.
 
C13DOF_BMI088_RETVAL_T c13dof_bmi088_gyro_read_bytes (c13dof_t *ctx, uint8_t *data_out, uint8_t reg_address, uint8_t n_bytes)
 Generic BMI088 Gyro sequential data read function.
 
uint8_t c13dof_bmi088_get_gyro_id (c13dof_t *ctx)
 Get BMI088 Gyro ID function.
 
C13DOF_BMI088_RETVAL_T c13dof_bmi088_set_gyro_range (c13dof_t *ctx, uint8_t gyro_range)
 Set BMI088 Gyro range function.
 
C13DOF_BMI088_RETVAL_T c13dof_bmi088_set_gyro_bandwidth (c13dof_t *ctx, uint8_t gyro_bandwidth)
 Set BMI088 Gyro bandwidth function.
 
void c13dof_bmi088_soft_reset_giro (c13dof_t *ctx)
 Software BMI088 Gyro reset function.
 
int16_t c13dof_bmi088_get_gyro_axis (c13dof_t *ctx, uint8_t adr_reg_LSB, uint8_t adr_reg_MSB)
 Get BMI088 Gyro axis data function.
 
void c13dof_bmi088_read_gyro (c13dof_t *ctx, int16_t *gyro_x, int16_t *gyro_y, int16_t *gyro_z)
 Get BMI088 Gyro X-axis, Y-axis and Z-axis function.
 
void c13dof_bmi088_accel_write_byte (c13dof_t *ctx, uint8_t reg_address, uint8_t write_data)
 Generic BMI088 Accel write data function.
 
void c13dof_bmi088_accel_write_bytes (c13dof_t *ctx, uint8_t reg_address, uint8_t *write_data, uint8_t n_bytes)
 Generic sequential BMI088 Accel write data function.
 
uint8_t c13dof_bmi088_accel_read_byte (c13dof_t *ctx, uint8_t reg_address)
 Generic BMI088 Accel read data function.
 
C13DOF_BMI088_RETVAL_T c13dof_bmi088_accel_read_bytes (c13dof_t *ctx, uint8_t *data_out, uint8_t reg_address, uint8_t n_bytes)
 Generic BMI088 Accel sequential data read function.
 
uint8_t c13dof_bmi088_get_accel_id (c13dof_t *ctx)
 Get BMI088 Accel ID function.
 
uint8_t c13dof_bmi088_check_accel_data_ready (c13dof_t *ctx)
 Get BMI088 Accel error function.
 
void c13dof_bmi088_set_accel_config (c13dof_t *ctx, uint8_t accel_config)
 Set BMI088 Accel configuration function.
 
C13DOF_BMI088_RETVAL_T c13dof_bmi088_set_accel_range (c13dof_t *ctx, uint8_t accel_range)
 Set BMI088 Accel range function.
 
void c13dof_bmi088_soft_reset_accel (c13dof_t *ctx)
 Set BMI088 Accel soft reset function.
 
void c13dof_bmi088_set_accel_mode (c13dof_t *ctx, uint8_t active_mode)
 Set BMI088 Accel mode function.
 
C13DOF_BMI088_RETVAL_T c13dof_bmi088_enable_accel (c13dof_t *ctx)
 Enable BMI088 Accel function.
 
C13DOF_BMI088_RETVAL_T c13dof_bmi088_disable_accel (c13dof_t *ctx)
 Disable BMI088 Accel function.
 
int16_t c13dof_bmi088_get_accel_axis (c13dof_t *ctx, uint8_t adr_reg_LSB, uint8_t adr_reg_MSB)
 Get BMI088 Accel axis data function.
 
void c13dof_bmi088_read_accel (c13dof_t *ctx, int16_t *accel_x, int16_t *accel_y, int16_t *accel_z)
 Get BMI088 Accel X-axis, Y-axis and Z-axis function.
 
void c13dof_bmi088_default_config (c13dof_t *ctx)
 Set BMI088 Accel & Gyro default configuration fuction.
 

Detailed Description

Function Documentation

◆ c13dof_bme680_check_id()

C13DOF_BME680_RETVAL_T c13dof_bme680_check_id ( c13dof_t * ctx)

Check BME680 device ID function.

Parameters
ctxClick object.
Returns
status:
  • 0 : ERROR;
  • 1 : OK;

@description Function check device ID by read ID value from the sensor ID register address of BME680 sensor on 13DOF Click board.

◆ c13dof_bme680_get_ambient_data()

float c13dof_bme680_get_ambient_data ( c13dof_t * ctx,
uint8_t data_in )

Get BME680 ambient data function.

Parameters
ctxClick object.
data_inData for reading:
  • Temperature : _C13DOF_BME680_DATA_TEMPERATURE ( 0x01 );
  • Pressure : _C13DOF_BME680_DATA_PRESSURE ( 0x02 );
  • Humidity : _C13DOF_BME680_DATA_HUMIDITY ( 0x03 );
Returns
float ambient ( temperature, pressure or humidity ) data

@description Function get ambient data by sets device force mode and read data from the sensor temperature, pressure or humidity register address of BME680 sensor on 13DOF Click board.

◆ c13dof_bme680_get_calibration_data()

void c13dof_bme680_get_calibration_data ( c13dof_t * ctx)

Get BME680 factory calibration parameters function.

Parameters
ctxClick object.

Function read factory calibration parameters value from the sensor calibration registers address of BME680 sensor on 13DOF Click board.

Note
@description This function must be called at least once at the beginning of the program to read and store the calibration parameters in the memory.

◆ c13dof_bme680_get_device_id()

uint8_t c13dof_bme680_get_device_id ( c13dof_t * ctx)

Get BME680 device ID function.

Parameters
ctxClick object.
Returns
8-bit device ID value

@description Function read device ID from the sensor ID register address of BME680 sensor on 13DOF Click board.

Note
Default device: ID = 0x61.

◆ c13dof_bme680_get_gas_resistance()

uint32_t c13dof_bme680_get_gas_resistance ( c13dof_t * ctx)

Gets BME680 gas resistance data function.

Parameters
ctxClick object.
Returns
32-bite gas resistance data

@description Function get gas resistance value from the sensor gas resistance register address of BME680 sensor on 13DOF Click board.

◆ c13dof_bme680_get_humidity()

float c13dof_bme680_get_humidity ( c13dof_t * ctx)

Gets BME680 humidity in percentage [ % ] function.

Parameters
ctxClick object.
Returns
float value of humidity in percentage [ % ]

@description Function get humidity value in percentage [ % ] from the sensor humidity register address of BME680 sensor on 13DOF Click board.

◆ c13dof_bme680_get_pressure()

float c13dof_bme680_get_pressure ( c13dof_t * ctx)

Gets BME680 pressure in degrees Celsius function.

Parameters
ctxClick object.
Returns
float value of pressure in [ mbar ]

@description Function get pressure value in [ mbar ] from the sensor pressure register address of BME680 sensor on 13DOF Click board.

◆ c13dof_bme680_get_temperature()

float c13dof_bme680_get_temperature ( c13dof_t * ctx)

Gets BME680 temperature in degrees Celsius function.

Parameters
ctxClick object.
Returns
float value of temperature in degrees Celsius

@description Function get temperature value in degrees Celsius [ �C ] from the sensor temperature register address of BME680 sensor on 13DOF Click board.

◆ c13dof_bme680_read_byte()

uint8_t c13dof_bme680_read_byte ( c13dof_t * ctx,
uint8_t reg_address )

Generic BME680 read byte of data function.

Parameters
ctxClick object.
reg_address8-bit BME680 register address
Returns
8-bit read data

@description Function read the 8-bit of data from the target 8-bit register address of BME680 sensor on 13DOF Click board.

◆ c13dof_bme680_soft_reset()

void c13dof_bme680_soft_reset ( c13dof_t * ctx)

Software BME680 reset function.

Parameters
ctxClick object.

@description Function software reset by write value of 0xB6 to the sensor reset register address of BME680 sensor on 13DOF Click board.

◆ c13dof_bme680_write_byte()

void c13dof_bme680_write_byte ( c13dof_t * ctx,
uint8_t reg_address,
uint8_t write_data )

Generic BME680 write the byte of data function.

Parameters
ctxClick object.
reg_address8-bit BME680 register address
write_dataByte of data to write

@description Function write the 8-bit of data to the target 8-bit register address of BME680 sensor on 13DOF Click board.

◆ c13dof_bmi088_accel_read_byte()

uint8_t c13dof_bmi088_accel_read_byte ( c13dof_t * ctx,
uint8_t reg_address )

Generic BMI088 Accel read data function.

Parameters
ctxClick object.
reg_address8-bit BMI088 Accel register address
Returns
8-bit read data

@description Function read the 8-bit of data from the target 8-bit register address of BMI088 Accel sensor on 13DOF Click board.

◆ c13dof_bmi088_accel_read_bytes()

C13DOF_BMI088_RETVAL_T c13dof_bmi088_accel_read_bytes ( c13dof_t * ctx,
uint8_t * data_out,
uint8_t reg_address,
uint8_t n_bytes )

Generic BMI088 Accel sequential data read function.

Parameters
ctxClick object.
data_outpointer to memory location where dataOut data be stored
reg_address8-bit BMI088 Gyro register address
n_bytesnumber of bytes to be written
Returns
status:
  • 0 : OK;
  • 1 : ERROR;

Function read a sequential data starting from the targeted 8-bit register address of BMI088 Accel sensor on 13DOF Click board.

◆ c13dof_bmi088_accel_write_byte()

void c13dof_bmi088_accel_write_byte ( c13dof_t * ctx,
uint8_t reg_address,
uint8_t write_data )

Generic BMI088 Accel write data function.

Parameters
ctxClick object.
reg_address8-bit BMI088 Gyro register address
write_dataByte of data to write

@description Function write the 8-bit of data to the target 8-bit register address of BMI088 Accel sensor on 13DOF Click board.

◆ c13dof_bmi088_accel_write_bytes()

void c13dof_bmi088_accel_write_bytes ( c13dof_t * ctx,
uint8_t reg_address,
uint8_t * write_data,
uint8_t n_bytes )

Generic sequential BMI088 Accel write data function.

Parameters
ctxClick object.
reg_address8-bit BMI088 Accel register address
write_datapointer to memory location where writeData data be stored
n_bytesnumber of bytes to be written

@description Function writes a sequential data starting from the targeted 8-bit register address of BMI088 Accel sensor on 13DOF Click board.

◆ c13dof_bmi088_check_accel_data_ready()

uint8_t c13dof_bmi088_check_accel_data_ready ( c13dof_t * ctx)

Get BMI088 Accel error function.

Parameters
ctxClick object.
Returns
BMI088 Accel error data:

@description Function read the 8-bit of data from the target _C13DOF_BMI088_ACCEL_ERR_REG register address of BMI088 Accel sensor on 13DOF Click board.

Get BMI088 check Accel data ready function

Parameters
ctxClick object.
Returns
status:
  • 0 : data is not ready;
  • 1 : data is ready;

@description Function read the 8-bit of data from the target _C13DOF_BMI088_ACCEL_STATUS_REG register address of BMI088 Accel sensor on 13DOF Click board.

◆ c13dof_bmi088_default_config()

void c13dof_bmi088_default_config ( c13dof_t * ctx)

Set BMI088 Accel & Gyro default configuration fuction.

Parameters
ctxClick object.

@description Function Set BMI088 Accel & Gyro default configuration of BMI088 Accel sensor on 13DOF Click board.

◆ c13dof_bmi088_disable_accel()

C13DOF_BMI088_RETVAL_T c13dof_bmi088_disable_accel ( c13dof_t * ctx)

Disable BMI088 Accel function.

Parameters
ctxClick object.
Returns
status:
  • 0 : OK;
  • 1 : ERROR;

@description Function disable BMI088 Accel by write 0x00 data to the targeted _C13DOF_BMI088_ACCEL_PWR_CTRL_REG register address of BMI088 Accel sensor on 13DOF Click board.

Note
delay is 5 ms.

◆ c13dof_bmi088_enable_accel()

C13DOF_BMI088_RETVAL_T c13dof_bmi088_enable_accel ( c13dof_t * ctx)

Enable BMI088 Accel function.

Parameters
ctxClick object.
Returns
status:
  • 0 : OK;
  • 1 : ERROR;

@description Function enable BMI088 Accel by write 0x04 data to the targeted _C13DOF_BMI088_ACCEL_PWR_CTRL_REG register address of BMI088 Accel sensor on 13DOF Click board.

Note
delay is 5 ms.

◆ c13dof_bmi088_get_accel_axis()

int16_t c13dof_bmi088_get_accel_axis ( c13dof_t * ctx,
uint8_t adr_reg_LSB,
uint8_t adr_reg_MSB )

Get BMI088 Accel axis data function.

Parameters
ctxClick object.
adr_reg_LSBleast significant bit register address
adr_reg_MSBmost significant bit register address
Returns
16-bit ( signed ) target axis value

@description Function get axis data by read two target register address of BMI088 Accel sensor on 13DOF Click board.

◆ c13dof_bmi088_get_accel_id()

uint8_t c13dof_bmi088_get_accel_id ( c13dof_t * ctx)

Get BMI088 Accel ID function.

Parameters
ctxClick object.
Returns
8-bit read BMI088 Accel ID data

@description Function read the 8-bit of data from the target _C13DOF_BMI088_ACCEL_CHIP_ID_REG register address of BMI088 Accel sensor on 13DOF Click board.

◆ c13dof_bmi088_get_gyro_axis()

int16_t c13dof_bmi088_get_gyro_axis ( c13dof_t * ctx,
uint8_t adr_reg_LSB,
uint8_t adr_reg_MSB )

Get BMI088 Gyro axis data function.

Parameters
ctxClick object.
adr_reg_LSBleast significant bit register address
adr_reg_MSBmost significant bit register address
Returns
16-bit ( signed ) target axis value

@description Function get axis data by read two target register address of BMI088 Gyro sensor on 13DOF Click board.

◆ c13dof_bmi088_get_gyro_id()

uint8_t c13dof_bmi088_get_gyro_id ( c13dof_t * ctx)

Get BMI088 Gyro ID function.

Parameters
ctxClick object.
Returns
8-bit read BMI088 Gyro ID data

@description Function read the 8-bit of data from the target _C13DOF_BMI088_GYRO_CHIP_ID_REG register address of BMI088 Gyro sensor on 13DOF Click board.

◆ c13dof_bmi088_gyro_read_byte()

uint8_t c13dof_bmi088_gyro_read_byte ( c13dof_t * ctx,
uint8_t reg_address )

Generic BMI088 Gyro read data function.

Parameters
ctxClick object.
reg_address8-bit BMI088 Gyro register address
Returns
8-bit read data

@description Function read the 8-bit of data from the target 8-bit register address of BMI088 Gyro sensor on 13DOF Click board.

◆ c13dof_bmi088_gyro_read_bytes()

C13DOF_BMI088_RETVAL_T c13dof_bmi088_gyro_read_bytes ( c13dof_t * ctx,
uint8_t * data_out,
uint8_t reg_address,
uint8_t n_bytes )

Generic BMI088 Gyro sequential data read function.

Parameters
ctxClick object.
data_outpointer to memory location where dataOut data be stored
reg_address8-bit BMI088 Gyro register address
n_bytesnumber of bytes to be written
Returns
status:
  • 0 : OK;
  • 1 : ERROR;

@description Function read a sequential data starting from the targeted 8-bit register address of BMI088 Gyro sensor on 13DOF Click board.

◆ c13dof_bmi088_gyro_write_byte()

void c13dof_bmi088_gyro_write_byte ( c13dof_t * ctx,
uint8_t reg_address,
uint8_t write_data )

Generic BMI088 Gyro write data function.

Parameters
ctxClick object.
reg_address8-bit BMI088 Gyro register address
write_dataByte of data to write

@description Function write the 8-bit of data to the target 8-bit register address of BMI088 Gyro sensor on 13DOF Click board.

◆ c13dof_bmi088_gyro_write_bytes()

void c13dof_bmi088_gyro_write_bytes ( c13dof_t * ctx,
uint8_t reg_address,
uint8_t * write_data,
uint8_t n_bytes )

Generic sequential BMI088 Gyro write data function.

Parameters
ctxClick object.
reg_address8-bit BMI088 Gyro register address
write_datapointer to memory location where writeData data be stored
n_bytesnumber of bytes to be written

@description Function writes a sequential data starting from the targeted 8-bit register address of BMI088 Gyro sensor on 13DOF Click board.

◆ c13dof_bmi088_read_accel()

void c13dof_bmi088_read_accel ( c13dof_t * ctx,
int16_t * accel_x,
int16_t * accel_y,
int16_t * accel_z )

Get BMI088 Accel X-axis, Y-axis and Z-axis function.

Parameters
ctxClick object.
accel_xpointer to memory location where Accel X-axis data be stored
accel_ypointer to memory location where Accel Y-axis data be stored
accel_zpointer to memory location where Accel Z-axis data be stored

Function reads 16-bit X-axis, Y-axis data and Z-axis data from the targeted starts from _C13DOF_BMI088_ACCEL_X_LSB_REG to the _C13DOF_BMI088_ACCEL_Z_MSB_REG register address of BMM150 sensor on 13DOF Click board.

◆ c13dof_bmi088_read_gyro()

void c13dof_bmi088_read_gyro ( c13dof_t * ctx,
int16_t * gyro_x,
int16_t * gyro_y,
int16_t * gyro_z )

Get BMI088 Gyro X-axis, Y-axis and Z-axis function.

Parameters
ctxClick object.
gyro_xpointer to memory location where Mag X-axis data be stored
gyro_ypointer to memory location where Mag Y-axis data be stored
gyro_zpointer to memory location where Mag Z-axis data be stored

@description Function reads 16-bit X-axis, Y-axis data and Z-axis data from the targeted starts from _C13DOF_BMI088_GYRO_X_LSB_REG to the _C13DOF_BMI088_GYRO_Z_MSB_REG register address of BMM150 sensor on 13DOF Click board.

◆ c13dof_bmi088_set_accel_config()

void c13dof_bmi088_set_accel_config ( c13dof_t * ctx,
uint8_t accel_config )

Set BMI088 Accel configuration function.

Parameters
ctxClick object.
Returns
BMI088 Accel configuration data:

@description Function set BMI088 Accel configurationread by write accelConfig value to the 8-bit of data from the _C13DOF_BMI088_ACCEL_CONF_REG register address of BMI088 Accel sensor on 13DOF Click board.

◆ c13dof_bmi088_set_accel_mode()

void c13dof_bmi088_set_accel_mode ( c13dof_t * ctx,
uint8_t active_mode )

Set BMI088 Accel mode function.

Parameters
ctxClick object.
Filtersetting:
  • 0x00 : Suspend mode;
  • 0x01 : Active mode;
Returns
status:
  • 0 : OK;
  • 1 : ERROR;

@description Function set BMI088 Accel mode by write activeMode data to the targeted _C13DOF_BMI088_ACCEL_PWR_CONF_REG register address of BMI088 Accel sensor on 13DOF Click board.

Note
delay is 5 ms.

◆ c13dof_bmi088_set_accel_range()

C13DOF_BMI088_RETVAL_T c13dof_bmi088_set_accel_range ( c13dof_t * ctx,
uint8_t accel_range )

Set BMI088 Accel range function.

Parameters
ctxClick object.
Returns
BMI088 Accel Range setting:

@description Function set BMI088 Accel range by write accelRange value to the 8-bit of data from the _C13DOF_BMI088_ACCEL_RANGE_REG register address of BMI088 Accel sensor on 13DOF Click board.

◆ c13dof_bmi088_set_gyro_bandwidth()

C13DOF_BMI088_RETVAL_T c13dof_bmi088_set_gyro_bandwidth ( c13dof_t * ctx,
uint8_t gyro_bandwidth )

Set BMI088 Gyro bandwidth function.

Parameters
ctxClick object.
8-bitgyro_bandwidth value:
Returns
status:
  • 0 : OK;
  • 1 : ERROR;

@description Function set BMI088 Gyro range by write gyroBandwidth data to the targeted _C13DOF_BMI088_GYRO_BANDWIDTH_REG register address of BMI088 Gyro sensor on 13DOF Click board.

◆ c13dof_bmi088_set_gyro_range()

C13DOF_BMI088_RETVAL_T c13dof_bmi088_set_gyro_range ( c13dof_t * ctx,
uint8_t gyro_range )

Set BMI088 Gyro range function.

Parameters
ctxClick object.
8-bitgyro_range value:
Returns
status:
  • 0 : OK;
  • 1 : ERROR;

@description Function set BMI088 Gyro range by write gyroRange data to the targeted _C13DOF_BMI088_GYRO_RANGE_REG register address of BMI088 Gyro sensor on 13DOF Click board.

◆ c13dof_bmi088_soft_reset_accel()

void c13dof_bmi088_soft_reset_accel ( c13dof_t * ctx)

Set BMI088 Accel soft reset function.

Parameters
ctxClick object.

@description Function performs a BMI088 Accel software reset and after that puts device to normal operation mode of BMI088 Accel sensor on 13DOF Click board.

Note
delay is 1 ms.

◆ c13dof_bmi088_soft_reset_giro()

void c13dof_bmi088_soft_reset_giro ( c13dof_t * ctx)

Software BMI088 Gyro reset function.

Parameters
ctxClick object.

@description Function performs a software reset and after that puts device to normal operation mode of BMI088 Gyro sensor on 13DOF Click board.

◆ c13dof_bmm150_check_ready()

C13DOF_BMM150_RETVAL_T c13dof_bmm150_check_ready ( c13dof_t * ctx)

Check BMM150 data ready status function.

Parameters
ctxClick object.
Returns
status:
  • 0 : OK;
  • 1 : ERROR;

@description Function check data ready status by read from the targeted 8-bit register address of BMM150 sensor on 13DOF Click board.

◆ c13dof_bmm150_power_on_reset()

void c13dof_bmm150_power_on_reset ( c13dof_t * ctx)

BMM150 power ON reset function.

Parameters
ctxClick object.

@description Function performs a reset by putting device first to suspend mode and after that to sleep mode. When power on reset is performed, function puts device to normal operation mode of BMM150 sensor on 13DOF Click board.

◆ c13dof_bmm150_read_byte()

uint8_t c13dof_bmm150_read_byte ( c13dof_t * ctx,
uint8_t reg_address )

Generic BMM150 read byte of data function.

Parameters
ctxClick object.
reg_address8-bit BMM150 register address
Returns
8-bit read data

@description Function read the 8-bit of data from the target 8-bit register address of BMM150 sensor on 13DOF Click board.

◆ c13dof_bmm150_read_bytes()

C13DOF_BMM150_RETVAL_T c13dof_bmm150_read_bytes ( c13dof_t * ctx,
uint8_t * data_out,
uint8_t reg_address,
uint8_t n_bytes )

Generic BMM150 sequential data read function.

Parameters
ctxClick object.
data_outpointer to memory location where dataOut data be stored
reg_address8-bit BMM150 register address
n_bytesnumber of bytes to be written
Returns
status:
  • 0 : OK;
  • 1 : ERROR;

@description Function read a sequential data starting from the targeted 8-bit register address of BMM150 sensor on 13DOF Click board.

◆ c13dof_bmm150_read_geo_mag_data()

void c13dof_bmm150_read_geo_mag_data ( c13dof_t * ctx,
int16_t * mag_x,
int16_t * mag_y,
int16_t * mag_z,
uint16_t * res_hall )

Get BMM150 Geomagnetic sensors data function.

Parameters
ctxClick object.
mag_xpointer to memory location where Mag X-axis data be stored
mag_ypointer to memory location where Mag Y-axis data be stored
mag_zpointer to memory location where Mag Z-axis data be stored
res_hallpointer to memory location where hall resistance data be stored

@description Function reads 16-bit X-axis and Y-axis data, 15-bit Z-axis data and 14-bit hall resistance data from the targeted 8-bit register address of BMM150 sensor on 13DOF Click board.

◆ c13dof_bmm150_soft_reset()

void c13dof_bmm150_soft_reset ( c13dof_t * ctx)

Software BMM150 reset function.

Parameters
ctxClick object.

@description Function performs a software reset and after that puts device to normal operation mode of BMM150 sensor on 13DOF Click board.

◆ c13dof_bmm150_write_byte()

C13DOF_BMM150_RETVAL_T c13dof_bmm150_write_byte ( c13dof_t * ctx,
uint8_t reg_address,
uint8_t write_data )

Generic BMM150 write the byte of data function.

Parameters
ctxClick object.
reg_address8-bit BMM150 register address
write_dataByte of data to write

Function write the 8-bit of data to the target 8-bit register address of BMM150 sensor on 13DOF Click board.

◆ c13dof_cfg_setup()

void c13dof_cfg_setup ( c13dof_cfg_t * cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

@description This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ c13dof_default_cfg()

void c13dof_default_cfg ( c13dof_t * ctx)

Click Default Configuration function.

Parameters
ctxClick object.

@description This function executes default configuration for c13DOF click.

◆ c13dof_init()

C13DOF_RETVAL c13dof_init ( c13dof_t * ctx,
c13dof_cfg_t * cfg )

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

@description This function initializes all necessary pins and peripherals used for this click.