c10dof 2.0.0.0
Public function

Functions

void c10dof_cfg_setup (c10dof_cfg_t *cfg)
 Config Object Initialization function.
 
C10DOF_RETVAL c10dof_init (c10dof_t *ctx, c10dof_cfg_t *cfg)
 Initialization function.
 
void c10dof_default_cfg (c10dof_t *ctx)
 Click Default Configuration function.
 
void c10dof_write_byte (c10dof_t *ctx, uint8_t reg, uint8_t data_in, uint8_t slave_addr)
 Generic write function.
 
uint8_t c10dof_read_byte (c10dof_t *ctx, uint8_t reg, uint8_t slave_addr)
 Generic read function.
 
uint16_t c10dof_read_data (c10dof_t *ctx, uint8_t msb_reg, uint8_t slave_addr)
 Generic read function.
 
void c10dof_hw_reset (c10dof_t *ctx)
 Reset function.
 
uint8_t c10dof_bmp180_chip_ID (c10dof_t *ctx)
 ID function.
 
uint8_t c10dof_bno055_chip_ID (c10dof_t *ctx)
 ID function.
 
uint8_t c10dof_get_accel_ID (c10dof_t *ctx)
 ID function.
 
uint8_t c10dof_get_mag_ID (c10dof_t *ctx)
 ID function.
 
uint8_t c10dof_get_gyro_ID (c10dof_t *ctx)
 ID function.
 
uint16_t c10dof_get_soft_ID (c10dof_t *ctx)
 ID function.
 
uint8_t c10dof_get_page_ID (c10dof_t *ctx)
 ID function.
 
void c10dof_default_configuration_BMP180 (c10dof_t *ctx)
 Configuration function.
 
void c10dof_default_configuration_BNO055 (c10dof_t *ctx)
 Configuration function.
 
void c10dof_set_config_mode (c10dof_t *ctx, uint8_t config_mode)
 Configuration function.
 
void c10dof_select_page (c10dof_t *ctx, uint8_t page_number)
 Page selection function.
 
void c10dof_config_accel (c10dof_t *ctx, uint8_t acc_cnfg)
 Accel configuration function.
 
void c10dof_config_gyro (c10dof_t *ctx, uint8_t gyro_cnfg)
 Gyro configuration function.
 
void c10dof_config_mag (c10dof_t *ctx, uint8_t mag_cnfg)
 Mag configuration function.
 
void c10dof_set_sensor_units (c10dof_t *ctx, uint8_t sensor_units)
 Sensor units function.
 
uint8_t c10dof_get_system_status (c10dof_t *ctx)
 System status code.
 
uint8_t c10dof_get_system_error (c10dof_t *ctx)
 System error code.
 
void c10dof_set_mode (c10dof_t *ctx, uint8_t mode_val)
 Mode.
 
void c10dof_set_normal_mode (c10dof_t *ctx)
 Normal mode.
 
void c10dof_start_temperature_measure (c10dof_t *ctx)
 Temperature reading start.
 
void c10dof_start_pressure_measure (c10dof_t *ctx)
 Pressure reading start.
 
int16_t c10dof_read_raw_temperature (c10dof_t *ctx, uint8_t msb_reg)
 Raw temperature reading.
 
int32_t c10dof_read_raw_pressure (c10dof_t *ctx, uint8_t msb_addr)
 Raw pressure reading.
 
void c10dof_get_calib_param (c10dof_t *ctx)
 Read the calibration parameter function.
 
void c10dof_get_measurements (c10dof_t *ctx, float *temperature, float *pressure)
 Get measurements value - temperature and pressure data function.
 
float c10dof_get_temperature (c10dof_t *ctx)
 Get temperature value function.
 
float c10dof_get_pressure (c10dof_t *ctx)
 Get pressure value function.
 
int16_t c10dof_get_axis (c10dof_t *ctx, uint8_t addr_reg_low)
 Function get axis data of BNO055 register.
 
void c10dof_read_accel (c10dof_t *ctx, int16_t *accelX, int16_t *accelY, int16_t *accelZ)
 Function read Accel X-axis, Y-axis and Z-axis.
 
void c10dof_read_mag (c10dof_t *ctx, int16_t *magX, int16_t *magY, int16_t *magZ)
 Function read Magnetometar X-axis, Y-axis and Z-axis.
 
void c10dof_read_gyro (c10dof_t *ctx, int16_t *gyroX, int16_t *gyroY, int16_t *gyroZ)
 Function read Gyro X-axis, Y-axis and Z-axis axis.
 
uint8_t c10dof_check_interrupt (c10dof_t *ctx)
 Check the state of interrupt function.
 

Detailed Description

Function Documentation

◆ c10dof_bmp180_chip_ID()

uint8_t c10dof_bmp180_chip_ID ( c10dof_t * ctx)

ID function.

Parameters
ctxClick object.
Returns
id_value BNO180 ID value.

@description This function reads the ID value od the BMP180 chip.

◆ c10dof_bno055_chip_ID()

uint8_t c10dof_bno055_chip_ID ( c10dof_t * ctx)

ID function.

Parameters
ctxClick object.
Returns
id_value BNO055 ID value.

@description This function reads the ID value od the BNO055 chip.

◆ c10dof_cfg_setup()

void c10dof_cfg_setup ( c10dof_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.

◆ c10dof_check_interrupt()

uint8_t c10dof_check_interrupt ( c10dof_t * ctx)

Check the state of interrupt function.

Parameters
ctxClick object
Returns
State of the INT pin: - ( 0 : inactive - 1 : active )

@description Function check the state of interrupt by gets states of INT pin of 10DOF Click board.

◆ c10dof_config_accel()

void c10dof_config_accel ( c10dof_t * ctx,
uint8_t acc_cnfg )

Accel configuration function.

Parameters
ctxClick object.
acc_cnfgAccel configuration register.

@description Set Accel configuration function.

◆ c10dof_config_gyro()

void c10dof_config_gyro ( c10dof_t * ctx,
uint8_t gyro_cnfg )

Gyro configuration function.

Parameters
ctxClick object.
gyro_cnfgGyro configuration register.

@description Set Gyro configuration function.

◆ c10dof_config_mag()

void c10dof_config_mag ( c10dof_t * ctx,
uint8_t mag_cnfg )

Mag configuration function.

Parameters
ctxClick object.
mag_cnfgMag configuration register.

@description Set Mag configuration function.

◆ c10dof_default_cfg()

void c10dof_default_cfg ( c10dof_t * ctx)

Click Default Configuration function.

Parameters
ctxClick object.

@description This function executes default configuration for C10Dof click.

◆ c10dof_default_configuration_BMP180()

void c10dof_default_configuration_BMP180 ( c10dof_t * ctx)

Configuration function.

Parameters
ctxClick object.

@description This function sets default configuration for the BMP180 sensor function.

◆ c10dof_default_configuration_BNO055()

void c10dof_default_configuration_BNO055 ( c10dof_t * ctx)

Configuration function.

Parameters
ctxClick object.

@description This function sets default configuration for the BNO055 sensor function.

◆ c10dof_get_accel_ID()

uint8_t c10dof_get_accel_ID ( c10dof_t * ctx)

ID function.

Parameters
ctxClick object.
Returns
id_value BNO055 Accel ID value.

@description This function reads the Accel ID value od the BNO055 chip.

◆ c10dof_get_axis()

int16_t c10dof_get_axis ( c10dof_t * ctx,
uint8_t addr_reg_low )

Function get axis data of BNO055 register.

Parameters
addr_reg_lowlow data register address
ctxClick object.
Returns
16-bit ( signed ) target axis value

@description Function get axis data by read two target register address of BNO055 chip on 10DOF Click board.

◆ c10dof_get_calib_param()

void c10dof_get_calib_param ( c10dof_t * ctx)

Read the calibration parameter function.

Parameters
ctxClick object.

@description Function get the calibration parameter values from the target register address of BMP180 chip on 10DOF Click board.

◆ c10dof_get_gyro_ID()

uint8_t c10dof_get_gyro_ID ( c10dof_t * ctx)

ID function.

Parameters
ctxClick object.
Returns
id_value BNO055 Gyro ID value.

@description This function reads the Gyro ID value od the BNO055 chip.

◆ c10dof_get_mag_ID()

uint8_t c10dof_get_mag_ID ( c10dof_t * ctx)

ID function.

Parameters
ctxClick object.
Returns
id_value BNO055 Mag ID value.

@description This function reads the Mag ID value od the BNO055 chip.

◆ c10dof_get_measurements()

void c10dof_get_measurements ( c10dof_t * ctx,
float * temperature,
float * pressure )

Get measurements value - temperature and pressure data function.

Parameters
temperaturepointer to measurements temperature value
pressurepointer to measurements pressure value

@description Function measurements the temperature and pressure value of BMP180 chip on 10DOF Click board.

◆ c10dof_get_page_ID()

uint8_t c10dof_get_page_ID ( c10dof_t * ctx)

ID function.

Parameters
ctxClick object.
Returns
id_value BNO055 Page ID value.

@description This function reads the page ID value od the BNO055 chip.

◆ c10dof_get_pressure()

float c10dof_get_pressure ( c10dof_t * ctx)

Get pressure value function.

Parameters
ctxClick object.
Returns
float measurements pressure value

@description Function measurements the pressure value of BMP180 chip on 10DOF Click board.

◆ c10dof_get_soft_ID()

uint16_t c10dof_get_soft_ID ( c10dof_t * ctx)

ID function.

Parameters
ctxClick object.
Returns
id_value BNO055 Software ID value.

@description This function reads the software ID value od the BNO055 chip.

◆ c10dof_get_system_error()

uint8_t c10dof_get_system_error ( c10dof_t * ctx)

System error code.

Parameters
ctxClick object.
Returns
error_code

@description Get the system error code of BNO055 function.

◆ c10dof_get_system_status()

uint8_t c10dof_get_system_status ( c10dof_t * ctx)

System status code.

Parameters
ctxClick object.
Returns
error_code Error Code.

@description Get the system status code of BNO055 function.

◆ c10dof_get_temperature()

float c10dof_get_temperature ( c10dof_t * ctx)

Get temperature value function.

Parameters
ctxClick object.
Returns
float measurements temperature value

@description Function measurements the temperature value of BMP180 chip on 10DOF Click board.

◆ c10dof_hw_reset()

void c10dof_hw_reset ( c10dof_t * ctx)

Reset function.

Parameters
ctxClick object.

@description This function resets the program.

◆ c10dof_init()

C10DOF_RETVAL c10dof_init ( c10dof_t * ctx,
c10dof_cfg_t * cfg )

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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

◆ c10dof_read_accel()

void c10dof_read_accel ( c10dof_t * ctx,
int16_t * accelX,
int16_t * accelY,
int16_t * accelZ )

Function read Accel X-axis, Y-axis and Z-axis.

Parameters
ctxClick object.
accelXpointer to read Accel X-axis data
accelYpointer to read Accel Y-axis data
accelZpointer to read Accel Z-axis data

@description Function read Accel X-axis, Y-axis and Z-axis axis of BNO055 chip on 10DOF Click board.

◆ c10dof_read_byte()

uint8_t c10dof_read_byte ( c10dof_t * ctx,
uint8_t reg,
uint8_t slave_addr )

Generic read function.

Parameters
ctxClick object.
regRegister address.
slave_addrAddress of the chip we're using.
Returns
result Output data.

@description This function reads data from the desired register.

◆ c10dof_read_data()

uint16_t c10dof_read_data ( c10dof_t * ctx,
uint8_t msb_reg,
uint8_t slave_addr )

Generic read function.

Parameters
ctxClick object.
msb_regRegister address.
slave_addrAddress of the chip we're using.
Returns
result Output data.

@description This function reads data from the desired register.

◆ c10dof_read_gyro()

void c10dof_read_gyro ( c10dof_t * ctx,
int16_t * gyroX,
int16_t * gyroY,
int16_t * gyroZ )

Function read Gyro X-axis, Y-axis and Z-axis axis.

Parameters
ctxClick object.
gyroXpointer to read Gyro X-axis data
gyroYpointer to read Gyro Y-axis data
gyroZpointer to read Gyro Z-axis data

@description Function read Gyro X-axis, Y-axis and Z-axis axis of BNO055 chip on 10DOF Click board.

◆ c10dof_read_mag()

void c10dof_read_mag ( c10dof_t * ctx,
int16_t * magX,
int16_t * magY,
int16_t * magZ )

Function read Magnetometar X-axis, Y-axis and Z-axis.

Parameters
ctxClick object.
magXpointer to read Mag X-axis data
magYpointer to read Mag Y-axis data
magZpointer to read Mag Z-axis data

@description Function read Mag X-axis, Y-axis and Z-axis axis of BNO055 chip on 10DOF Click board.

◆ c10dof_read_raw_pressure()

int32_t c10dof_read_raw_pressure ( c10dof_t * ctx,
uint8_t msb_addr )

Raw pressure reading.

Parameters
ctxClick object.
msb_addrRegister.

@description Function read the raw temperature data from the three target register address of BMP180 chip on 10DOF Click board.

◆ c10dof_read_raw_temperature()

int16_t c10dof_read_raw_temperature ( c10dof_t * ctx,
uint8_t msb_reg )

Raw temperature reading.

Parameters
ctxClick object.
msb_regRegister.

@description Function read the raw temperature data from the two target register address of BMP180 chip on 10DOF Click board.

◆ c10dof_select_page()

void c10dof_select_page ( c10dof_t * ctx,
uint8_t page_number )

Page selection function.

Parameters
ctxClick object.
page_numberPage number.

@description Select page number function.

◆ c10dof_set_config_mode()

void c10dof_set_config_mode ( c10dof_t * ctx,
uint8_t config_mode )

Configuration function.

Parameters
ctxClick object.
config_modeConfiguration mode.

@description Set configuration mode function.

◆ c10dof_set_mode()

void c10dof_set_mode ( c10dof_t * ctx,
uint8_t mode_val )

Mode.

Parameters
ctxClick object.
mode_valueMode value.

@description Set mode mode function.

◆ c10dof_set_normal_mode()

void c10dof_set_normal_mode ( c10dof_t * ctx)

Normal mode.

Parameters
ctxClick object.

@description Set normal mode mode function.

◆ c10dof_set_sensor_units()

void c10dof_set_sensor_units ( c10dof_t * ctx,
uint8_t sensor_units )

Sensor units function.

Parameters
ctxClick object.
sensor_unitsSensor units.

@description Configurate sensor units function.

◆ c10dof_start_pressure_measure()

void c10dof_start_pressure_measure ( c10dof_t * ctx)

Pressure reading start.

Parameters
ctxClick object.

@description Begin a pressure reading function.

◆ c10dof_start_temperature_measure()

void c10dof_start_temperature_measure ( c10dof_t * ctx)

Temperature reading start.

Parameters
ctxClick object.

@description Begin a temperature reading function.

◆ c10dof_write_byte()

void c10dof_write_byte ( c10dof_t * ctx,
uint8_t reg,
uint8_t data_in,
uint8_t slave_addr )

Generic write function.

Parameters
ctxClick object.
regRegister address.
data_inData to be written.
slave_addrAddress of the chip we're using.

@description This function writes data to the desired register.