c6dofimu5 2.0.0.0

Functions

void c6dofimu5_cfg_setup (c6dofimu5_cfg_t *cfg)
 Config Object Initialization function.
 
C6DOFIMU5_RETVAL c6dofimu5_init (c6dofimu5_t *ctx, c6dofimu5_cfg_t *cfg)
 Initialization function.
 
void c6dofimu5_default_cfg (c6dofimu5_t *ctx)
 Click Default Configuration function.
 
void c6dofimu5_write_bytes (c6dofimu5_t *ctx, uint8_t reg, uint8_t *wr_data, uint16_t n_bytes)
 Generic write function.
 
void c6dofimu5_read_bytes (c6dofimu5_t *ctx, uint8_t reg, uint8_t *rd_data, uint16_t n_bytes)
 Generic read function.
 
void c6dofimu5_power (c6dofimu5_t *ctx, uint8_t on_off)
 Power up function.
 
int16_t c6dofimu5_read_gyro_x (c6dofimu5_t *ctx)
 Read Gyroscope X-axis data function.
 
int16_t c6dofimu5_read_gyro_y (c6dofimu5_t *ctx)
 Read Gyroscope Y-axis data function.
 
int16_t c6dofimu5_read_gyro_z (c6dofimu5_t *ctx)
 Read Gyroscope Z-axis data function.
 
void c6dofimu5_read_gyroscope (c6dofimu5_t *ctx, int16_t *gyro_x, int16_t *gyro_y, int16_t *gyro_z)
 Read gyroscope data function.
 
void c6dofimu5_angular_rate (c6dofimu5_t *ctx, float *x_ang_rte, float *y_ang_rte, float *z_ang_rte)
 Read Angular Rate function.
 
int16_t c6dofimu5_read_accel_x (c6dofimu5_t *ctx)
 Read Accelerometer X-axis data function.
 
int16_t c6dofimu5_read_accel_y (c6dofimu5_t *ctx)
 Read Accelerometer Y-axis data function.
 
int16_t c6dofimu5_read_accel_z (c6dofimu5_t *ctx)
 Read Accelerometer Z-axis data function.
 
void c6dofimu5_read_accelerometer (c6dofimu5_t *ctx, int16_t *accel_x, int16_t *accel_y, int16_t *accel_z)
 Read accelerometer data function.
 
void c6dofimu5_acceleration_rate (c6dofimu5_t *ctx, float *x_accel_rte, float *y_accel_rte, float *z_accel_rte)
 Read acceleration Rate function.
 
float c6dofimu5_read_temp_out (c6dofimu5_t *ctx)
 Read temperture function.
 
void c6dofimu5_baro_read (c6dofimu5_t *ctx, uint16_t cmd, uint8_t *data_out, uint16_t n_bytes)
 Barometer Read function.
 
void c6dofimu5_baro_write (c6dofimu5_t *ctx, uint8_t *data_in, uint16_t n_bytes)
 Barometer Write function.
 
void c6dofimu5_baro_settings (c6dofimu5_t *ctx)
 I2C Barometer Settings function.
 
uint8_t c6dofimu5_baro_id_read (c6dofimu5_t *ctx)
 Barometer ID Readout function.
 
void c6dofimu5_baro_soft_rst (c6dofimu5_t *ctx)
 Soft Reset Command function.
 
void c6dofimu5_process_data (c6dofimu5_t *ctx, c6dofimu5_process_data_t *process_d)
 Process data function.
 
void c6dofimu5_read_raw_data (c6dofimu5_t *ctx, uint32_t *pres, uint16_t *temp)
 Read raw data function.
 
uint8_t c6dofimu5_check_int_pin (c6dofimu5_t *ctx)
 Check Interrupt state function.
 

Detailed Description

Function Documentation

◆ c6dofimu5_acceleration_rate()

void c6dofimu5_acceleration_rate ( c6dofimu5_t * ctx,
float * x_accel_rte,
float * y_accel_rte,
float * z_accel_rte )

Read acceleration Rate function.

Parameters
ctxClick object.
x_accel_rtefloat X-axis acceleration rate.
y_accel_rtefloat Y-axis acceleration rate.
z_accel_rtefloat Z-axis acceleration rate.

@description This function is used to calculate acceleration rate.

◆ c6dofimu5_angular_rate()

void c6dofimu5_angular_rate ( c6dofimu5_t * ctx,
float * x_ang_rte,
float * y_ang_rte,
float * z_ang_rte )

Read Angular Rate function.

Parameters
ctxClick object.
x_ang_rtefloat X-axis angular rate.
y_ang_rtefloat Y-axis angular rate.
z_ang_rtefloat Z-axis angular rate.

@description This function is used to calculate angular rate.

◆ c6dofimu5_baro_id_read()

uint8_t c6dofimu5_baro_id_read ( c6dofimu5_t * ctx)

Barometer ID Readout function.

Parameters
ctxClick object.

@description This function is used to read barometer ID number.

◆ c6dofimu5_baro_read()

void c6dofimu5_baro_read ( c6dofimu5_t * ctx,
uint16_t cmd,
uint8_t * data_out,
uint16_t n_bytes )

Barometer Read function.

Parameters
ctxClick object.
cmd16-bit command.
rd_data8-bit read data.
n_bytes16-bit number of bytes.

@description This function reads response to the command given by user.

◆ c6dofimu5_baro_settings()

void c6dofimu5_baro_settings ( c6dofimu5_t * ctx)

I2C Barometer Settings function.

Parameters
ctxClick object.

@description This function is used to apply barometer settings.

Note
Should be used in order to get temperature and pressure readings from the device.

◆ c6dofimu5_baro_soft_rst()

void c6dofimu5_baro_soft_rst ( c6dofimu5_t * ctx)

Soft Reset Command function.

Parameters
ctxClick object.

@description This function is used to perform soft rest.

◆ c6dofimu5_baro_write()

void c6dofimu5_baro_write ( c6dofimu5_t * ctx,
uint8_t * data_in,
uint16_t n_bytes )

Barometer Write function.

Parameters
ctxClick object.
data_in8-bit write data.
n_bytes16-bit number of bytes.

@description This function writes user defined number of bytes.

◆ c6dofimu5_cfg_setup()

void c6dofimu5_cfg_setup ( c6dofimu5_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.

◆ c6dofimu5_check_int_pin()

uint8_t c6dofimu5_check_int_pin ( c6dofimu5_t * ctx)

Check Interrupt state function.

Parameters
ctxClick object.

@description This function is used to check if an interrupt has occured.

◆ c6dofimu5_default_cfg()

void c6dofimu5_default_cfg ( c6dofimu5_t * ctx)

Click Default Configuration function.

Parameters
ctxClick object.

@description This function executes default configuration for C6DOF IMU 5 click.

◆ c6dofimu5_init()

C6DOFIMU5_RETVAL c6dofimu5_init ( c6dofimu5_t * ctx,
c6dofimu5_cfg_t * cfg )

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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

◆ c6dofimu5_power()

void c6dofimu5_power ( c6dofimu5_t * ctx,
uint8_t on_off )

Power up function.

Parameters
ctxClick object.
on_offValue defines power state of the device.

@description This function turns the device on or off.

Note
It is advisable to use predefined values.

◆ c6dofimu5_process_data()

void c6dofimu5_process_data ( c6dofimu5_t * ctx,
c6dofimu5_process_data_t * process_d )

Process data function.

Parameters
ctxClick object.
process_dProcess data structure.

@description This function processes raw data in order to get presure(in Pascals) and temperature(in degree Centigrade).

◆ c6dofimu5_read_accel_x()

int16_t c6dofimu5_read_accel_x ( c6dofimu5_t * ctx)

Read Accelerometer X-axis data function.

Parameters
ctxClick object.

@description This function is used to read accelerometer X-axis data.

◆ c6dofimu5_read_accel_y()

int16_t c6dofimu5_read_accel_y ( c6dofimu5_t * ctx)

Read Accelerometer Y-axis data function.

Parameters
ctxClick object.

@description This function is used to read accelerometer Y-axis data.

◆ c6dofimu5_read_accel_z()

int16_t c6dofimu5_read_accel_z ( c6dofimu5_t * ctx)

Read Accelerometer Z-axis data function.

Parameters
ctxClick object.

@description This function is used to read accelerometer Z-axis data.

◆ c6dofimu5_read_accelerometer()

void c6dofimu5_read_accelerometer ( c6dofimu5_t * ctx,
int16_t * accel_x,
int16_t * accel_y,
int16_t * accel_z )

Read accelerometer data function.

Parameters
ctxClick object.
accel_x16-bit accelerometer X-axis data.
accel_y16-bit accelerometer Y-axis data.
accel_z16-bit accelerometer Z-axis data.

@description This function is used to read accelerometer data.

◆ c6dofimu5_read_bytes()

void c6dofimu5_read_bytes ( c6dofimu5_t * ctx,
uint8_t reg,
uint8_t * rd_data,
uint16_t n_bytes )

Generic read function.

Parameters
ctxClick object.
reg8-bit register address.
rd_data8-bit read data.
n_bytes16-bit number of bytes.

@description This function reads user defined number of bytes from registers defined by 8-bit register address.

◆ c6dofimu5_read_gyro_x()

int16_t c6dofimu5_read_gyro_x ( c6dofimu5_t * ctx)

Read Gyroscope X-axis data function.

Parameters
ctxClick object.

@description This function is used to read gyroscope X-axis data.

◆ c6dofimu5_read_gyro_y()

int16_t c6dofimu5_read_gyro_y ( c6dofimu5_t * ctx)

Read Gyroscope Y-axis data function.

Parameters
ctxClick object.

@description This function is used to read gyroscope Y-axis data.

◆ c6dofimu5_read_gyro_z()

int16_t c6dofimu5_read_gyro_z ( c6dofimu5_t * ctx)

Read Gyroscope Z-axis data function.

Parameters
ctxClick object.

@description This function is used to read gyroscope Z-axis data.

◆ c6dofimu5_read_gyroscope()

void c6dofimu5_read_gyroscope ( c6dofimu5_t * ctx,
int16_t * gyro_x,
int16_t * gyro_y,
int16_t * gyro_z )

Read gyroscope data function.

Parameters
ctxClick object.
gyro_x16-bit gyroscope X-axis data.
gyro_y16-bit gyroscope Y-axis data.
gyro_z16-bit gyroscope Z-axis data.

@description This function is used to read gyroscope data.

◆ c6dofimu5_read_raw_data()

void c6dofimu5_read_raw_data ( c6dofimu5_t * ctx,
uint32_t * pres,
uint16_t * temp )

Read raw data function.

Parameters
ctxClick object.
pres32-bit raw pressure data.
temp16-bit raw temperature data.

@description This function is used to get raw temperature and pressure values.

◆ c6dofimu5_read_temp_out()

float c6dofimu5_read_temp_out ( c6dofimu5_t * ctx)

Read temperture function.

Parameters
ctxClick object.

@description This function is used to read temperture in degree Centigrade.

◆ c6dofimu5_write_bytes()

void c6dofimu5_write_bytes ( c6dofimu5_t * ctx,
uint8_t reg,
uint8_t * wr_data,
uint16_t n_bytes )

Generic write function.

Parameters
ctxClick object.
reg8-bit register address.
wr_data8-bit write data.
n_bytes16-bit number of bytes.

@description This function writes user defined number of bytes into registers defined by 8-bit register address.