c6dofimu15  2.0.0.0
Functions

Functions

void c6dofimu15_cfg_setup (c6dofimu15_cfg_t *cfg)
 Config Object Initialization function. More...
 
C6DOFIMU15_RETVAL c6dofimu15_init (c6dofimu15_t *ctx, c6dofimu15_cfg_t *cfg)
 Initialization function. More...
 
void c6dofimu15_default_cfg (c6dofimu15_t *ctx)
 Click Default Configuration function. More...
 
void c6dofimu15_generic_write (c6dofimu15_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic write function. More...
 
void c6dofimu15_generic_read (c6dofimu15_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic read function. More...
 
uint8_t c6dofimu15_check_int_pin (c6dofimu15_t *ctx)
 Check Interrupt state function. More...
 
int16_t c6dofimu15_read_gyro_x (c6dofimu15_t *ctx)
 Read Gyroscope X-axis data function. More...
 
int16_t c6dofimu15_read_gyro_y (c6dofimu15_t *ctx)
 Read Gyroscope Y-axis data function. More...
 
int16_t c6dofimu15_read_gyro_z (c6dofimu15_t *ctx)
 Read Gyroscope Z-axis data function. More...
 
void c6dofimu15_read_gyroscope (c6dofimu15_t *ctx, int16_t *gyro_x, int16_t *gyro_y, int16_t *gyro_z)
 Read gyroscope data function. More...
 
void c6dofimu15_angular_rate (c6dofimu15_t *ctx, float *x_ang_rte, float *y_ang_rte, float *z_ang_rte)
 Read Angular Rate function. More...
 
int16_t c6dofimu15_read_accel_x (c6dofimu15_t *ctx)
 Read Accelerometer X-axis data function. More...
 
int16_t c6dofimu15_read_accel_y (c6dofimu15_t *ctx)
 Read Accelerometer Y-axis data function. More...
 
int16_t c6dofimu15_read_accel_z (c6dofimu15_t *ctx)
 Read Accelerometer Z-axis data function. More...
 
void c6dofimu15_read_accelerometer (c6dofimu15_t *ctx, int16_t *accel_x, int16_t *accel_y, int16_t *accel_z)
 Read accelerometer data function. More...
 
void c6dofimu15_acceleration_rate (c6dofimu15_t *ctx, float *x_acel_rte, float *y_acel_rte, float *z_acel_rte)
 Read Acceleration Rate function. More...
 
float c6dofimu15_read_temp_out (c6dofimu15_t *ctx)
 Read temperture function. More...
 
void c6dofimu15_i2c_disable (c6dofimu15_t *ctx, uint8_t com_sel)
 Disable I2C block function. More...
 
void c6dofimu15_device_conf_set (c6dofimu15_t *ctx, uint8_t dev_cfg)
 Enable the proper device configuration function. More...
 
void c6dofimu15_auto_inc_set (c6dofimu15_t *ctx, uint8_t inc_set)
 Enable register address incrementation function. More...
 
void c6dofimu15_sw_rst (c6dofimu15_t *ctx, uint8_t rst_en)
 Perform software reset function. More...
 
void c6dofimu15_block_data_update_set (c6dofimu15_t *ctx, uint8_t blk_set)
 Block Data Update function. More...
 
void c6dofimu15_fifo_mode_set (c6dofimu15_t *ctx, uint8_t fifo_set)
 Set FIFO Mode function. More...
 
void c6dofimu15_accel_data_rate (c6dofimu15_t *ctx, uint8_t data_rate)
 Accelerometer data rate selection function. More...
 
void c6dofimu15_accel_full_scale (c6dofimu15_t *ctx, uint8_t fs_sel)
 Accelerometer full-scale selection function. More...
 
void c6dofimu15_gyro_data_rate (c6dofimu15_t *ctx, uint8_t data_rate)
 Gyroscope data rate selection function. More...
 
void c6dofimu15_gyro_full_scale (c6dofimu15_t *ctx, uint8_t fs_sel)
 Gyroscope full-scale selection function. More...
 
uint8_t c6dofimu15_accel_data_rdy (c6dofimu15_t *ctx)
 Accelerometer new data available function. More...
 
uint8_t c6dofimu15_gyro_data_rdy (c6dofimu15_t *ctx)
 Gyroscope new data available function. More...
 
uint8_t c6dofimu15_temp_data_rdy (c6dofimu15_t *ctx)
 Temperature new data available function. More...
 
uint8_t c6dofimu15_who_im_i (c6dofimu15_t *ctx)
 Who Am I function. More...
 

Detailed Description

Function Documentation

◆ c6dofimu15_accel_data_rate()

void c6dofimu15_accel_data_rate ( c6dofimu15_t ctx,
uint8_t  data_rate 
)

Accelerometer data rate selection function.

Parameters
ctxClick object.
data_ratedesired accelerometer output data rate

@description Function is used to set desired output data rate.

◆ c6dofimu15_accel_data_rdy()

uint8_t c6dofimu15_accel_data_rdy ( c6dofimu15_t ctx)

Accelerometer new data available function.

Parameters
ctxClick object.
Returns
new data available flag

@description Function gets the accelerometer new data available flag.

◆ c6dofimu15_accel_full_scale()

void c6dofimu15_accel_full_scale ( c6dofimu15_t ctx,
uint8_t  fs_sel 
)

Accelerometer full-scale selection function.

Parameters
ctxClick object.
data_ratedesired accelerometer full-scale range

@description Function is used to set desired full-scale range.

◆ c6dofimu15_acceleration_rate()

void c6dofimu15_acceleration_rate ( c6dofimu15_t ctx,
float *  x_acel_rte,
float *  y_acel_rte,
float *  z_acel_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 Function is used to calculate acceleration rate in milligravities.

◆ c6dofimu15_angular_rate()

void c6dofimu15_angular_rate ( c6dofimu15_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 Function is used to calculate angular rate in milidegrees per second.

◆ c6dofimu15_auto_inc_set()

void c6dofimu15_auto_inc_set ( c6dofimu15_t ctx,
uint8_t  inc_set 
)

Enable register address incrementation function.

Parameters
ctxClick object.
inc_setvalue enables or disables the property.

@description Function is used to enable or disable automatical register address incrementation during a multiple byte access with a serial interface.

◆ c6dofimu15_block_data_update_set()

void c6dofimu15_block_data_update_set ( c6dofimu15_t ctx,
uint8_t  blk_set 
)

Block Data Update function.

Parameters
ctxClick object.
blk_setvalue enables or disables the property.

@description Function is used to enable or disable block data update.

◆ c6dofimu15_cfg_setup()

void c6dofimu15_cfg_setup ( c6dofimu15_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.

◆ c6dofimu15_check_int_pin()

uint8_t c6dofimu15_check_int_pin ( c6dofimu15_t ctx)

Check Interrupt state function.

Parameters
ctxClick object.
Returns
  • 0 : Interrupt has not occured
  • 1 : Interrupt has occured

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

◆ c6dofimu15_default_cfg()

void c6dofimu15_default_cfg ( c6dofimu15_t ctx)

Click Default Configuration function.

Parameters
ctxClick object.

@description This function executes default configuration for 6DOF-IMU-15 Click.

◆ c6dofimu15_device_conf_set()

void c6dofimu15_device_conf_set ( c6dofimu15_t ctx,
uint8_t  dev_cfg 
)

Enable the proper device configuration function.

Parameters
ctxClick object.
dev_cfgvalue enables or disables the property.

@description Function enables the proper device configuration.

◆ c6dofimu15_fifo_mode_set()

void c6dofimu15_fifo_mode_set ( c6dofimu15_t ctx,
uint8_t  fifo_set 
)

Set FIFO Mode function.

Parameters
ctxClick object.
fifo_setdesired FIFO mode

@description Function is used to set FIFO mode.

◆ c6dofimu15_generic_read()

void c6dofimu15_generic_read ( c6dofimu15_t ctx,
uint8_t  reg,
uint8_t *  data_buf,
uint8_t  len 
)

Generic read function.

Parameters
ctxClick object.
regRegister address.
data_bufData buf to be written.
lenNumber of the bytes in data buf.

@description This function reads data from the desired register.

◆ c6dofimu15_generic_write()

void c6dofimu15_generic_write ( c6dofimu15_t ctx,
uint8_t  reg,
uint8_t *  data_buf,
uint8_t  len 
)

Generic write function.

Parameters
ctxClick object.
regRegister address.
data_bufOutput data buf
lenNumber of the bytes to be read

@description This function writes data to the desired register.

◆ c6dofimu15_gyro_data_rate()

void c6dofimu15_gyro_data_rate ( c6dofimu15_t ctx,
uint8_t  data_rate 
)

Gyroscope data rate selection function.

Parameters
ctxClick object.
data_ratedesired gyroscope output data rate

@description Function is used to set desired output data rate.

◆ c6dofimu15_gyro_data_rdy()

uint8_t c6dofimu15_gyro_data_rdy ( c6dofimu15_t ctx)

Gyroscope new data available function.

Parameters
ctxClick object.
Returns
new data available flag

@description Function gets the gyroscope new data available flag.

◆ c6dofimu15_gyro_full_scale()

void c6dofimu15_gyro_full_scale ( c6dofimu15_t ctx,
uint8_t  fs_sel 
)

Gyroscope full-scale selection function.

Parameters
ctxClick object.
data_ratedesired gyroscope full-scale range

@description Function is used to set desired full-scale range.

◆ c6dofimu15_i2c_disable()

void c6dofimu15_i2c_disable ( c6dofimu15_t ctx,
uint8_t  com_sel 
)

Disable I2C block function.

Parameters
ctxClick object.
com_selvalue enables or disables the property.

@description Function is used to enable or disable I2C block.

◆ c6dofimu15_init()

C6DOFIMU15_RETVAL c6dofimu15_init ( c6dofimu15_t ctx,
c6dofimu15_cfg_t cfg 
)

Initialization function.

Parameters
c6dofimu15Click object.
cfgClick configuration structure.

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

◆ c6dofimu15_read_accel_x()

int16_t c6dofimu15_read_accel_x ( c6dofimu15_t ctx)

Read Accelerometer X-axis data function.

Parameters
ctxClick object.
Returns
result 16-bit accelerometer X-axis data

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

◆ c6dofimu15_read_accel_y()

int16_t c6dofimu15_read_accel_y ( c6dofimu15_t ctx)

Read Accelerometer Y-axis data function.

Parameters
ctxClick object.
Returns
result 16-bit accelerometer Y-axis data

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

◆ c6dofimu15_read_accel_z()

int16_t c6dofimu15_read_accel_z ( c6dofimu15_t ctx)

Read Accelerometer Z-axis data function.

Parameters
ctxClick object.
Returns
result 16-bit accelerometer Z-axis data

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

◆ c6dofimu15_read_accelerometer()

void c6dofimu15_read_accelerometer ( c6dofimu15_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 Function is used to read accelerometer data.

◆ c6dofimu15_read_gyro_x()

int16_t c6dofimu15_read_gyro_x ( c6dofimu15_t ctx)

Read Gyroscope X-axis data function.

Parameters
ctxClick object.
Returns
result 16-bit gyroscope X-axis data

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

◆ c6dofimu15_read_gyro_y()

int16_t c6dofimu15_read_gyro_y ( c6dofimu15_t ctx)

Read Gyroscope Y-axis data function.

Parameters
ctxClick object.
Returns
result 16-bit gyroscope Y-axis data

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

◆ c6dofimu15_read_gyro_z()

int16_t c6dofimu15_read_gyro_z ( c6dofimu15_t ctx)

Read Gyroscope Z-axis data function.

Parameters
ctxClick object.
Returns
result 16-bit gyroscope Z-axis data

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

◆ c6dofimu15_read_gyroscope()

void c6dofimu15_read_gyroscope ( c6dofimu15_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 Function is used to read gyroscope data.

◆ c6dofimu15_read_temp_out()

float c6dofimu15_read_temp_out ( c6dofimu15_t ctx)

Read temperture function.

Parameters
ctxClick object.
Returns
result float temperture data

@description Function is used to read temperture in degree Centigrade.

◆ c6dofimu15_sw_rst()

void c6dofimu15_sw_rst ( c6dofimu15_t ctx,
uint8_t  rst_en 
)

Perform software reset function.

Parameters
ctxClick object.
rst_envalue enables or disables the property.

@description Function is used to perform software reset.

◆ c6dofimu15_temp_data_rdy()

uint8_t c6dofimu15_temp_data_rdy ( c6dofimu15_t ctx)

Temperature new data available function.

Parameters
ctxClick object.
Returns
new data available flag

@description Function gets the temperature new data available flag.

◆ c6dofimu15_who_im_i()

uint8_t c6dofimu15_who_im_i ( c6dofimu15_t ctx)

Who Am I function.

Parameters
ctxClick object.
Returns
Fixed value that identifies the device

@description Function gets the fixed value that identifies the device.

Note
The value is fixed at 0x6B.