c6dofimu6  2.0.0.0
Functions

Functions

void c6dofimu6_cfg_setup (c6dofimu6_cfg_t *cfg)
 Config Object Initialization function. More...
 
C6DOFIMU6_RETVAL c6dofimu6_init (c6dofimu6_t *ctx, c6dofimu6_cfg_t *cfg)
 Initialization function. More...
 
void c6dofimu6_default_cfg (c6dofimu6_t *ctx)
 Click Default Configuration function. More...
 
void c6dofimu6_generic_write (c6dofimu6_t *ctx, uint8_t reg, uint8_t *data_buf, uint16_t len)
 Generic write function. More...
 
void c6dofimu6_generic_read (c6dofimu6_t *ctx, uint8_t reg, uint8_t *data_buf, uint16_t len)
 Generic read function. More...
 
void c6dofimu6_power (c6dofimu6_t *ctx, uint8_t on_off)
 Power up function. More...
 
int16_t c6dofimu6_read_gyro_x (c6dofimu6_t *ctx)
 Read Gyroscope X-axis data function. More...
 
int16_t c6dofimu6_read_gyro_y (c6dofimu6_t *ctx)
 Read Gyroscope Y-axis data function. More...
 
int16_t c6dofimu6_read_gyro_z (c6dofimu6_t *ctx)
 Read Gyroscope Z-axis data function. More...
 
void c6dofimu6_read_gyroscope (c6dofimu6_t *ctx, int16_t *gyro_x, int16_t *gyro_y, int16_t *gyro_z)
 Read gyroscope data function. More...
 
void c6dofimu6_angular_rate (c6dofimu6_t *ctx, float *x_ang_rte, float *y_ang_rte, float *z_ang_rte)
 Read Angular Rate function. More...
 
int16_t c6dofimu6_read_accel_x (c6dofimu6_t *ctx)
 Read Accelerometer X-axis data function. More...
 
int16_t c6dofimu6_read_accel_y (c6dofimu6_t *ctx)
 Read Accelerometer Y-axis data function. More...
 
int16_t c6dofimu6_read_accel_z (c6dofimu6_t *ctx)
 Read Accelerometer Z-axis data function. More...
 
void c6dofimu6_read_accelerometer (c6dofimu6_t *ctx, int16_t *accel_x, int16_t *accel_y, int16_t *accel_z)
 Read accelerometer data function. More...
 
void c6dofimu6_acceleration_rate (c6dofimu6_t *ctx, float *x_accel_rte, float *y_accel_rte, float *z_accel_rte)
 Read acceleration Rate function. More...
 
float c6dofimu6_read_temp_out (c6dofimu6_t *ctx)
 Read temperture function. More...
 
uint8_t c6dofimu6_check_int_pin (c6dofimu6_t *ctx)
 Check Interrupt state function. More...
 

Detailed Description

Function Documentation

◆ c6dofimu6_acceleration_rate()

void c6dofimu6_acceleration_rate ( c6dofimu6_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 Function is used to calculate acceleration rate.

◆ c6dofimu6_angular_rate()

void c6dofimu6_angular_rate ( c6dofimu6_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.

◆ c6dofimu6_cfg_setup()

void c6dofimu6_cfg_setup ( c6dofimu6_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.

◆ c6dofimu6_check_int_pin()

uint8_t c6dofimu6_check_int_pin ( c6dofimu6_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.

◆ c6dofimu6_default_cfg()

void c6dofimu6_default_cfg ( c6dofimu6_t ctx)

Click Default Configuration function.

Parameters
ctxClick object.

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

◆ c6dofimu6_generic_read()

void c6dofimu6_generic_read ( c6dofimu6_t ctx,
uint8_t  reg,
uint8_t *  data_buf,
uint16_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.

◆ c6dofimu6_generic_write()

void c6dofimu6_generic_write ( c6dofimu6_t ctx,
uint8_t  reg,
uint8_t *  data_buf,
uint16_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.

◆ c6dofimu6_init()

C6DOFIMU6_RETVAL c6dofimu6_init ( c6dofimu6_t ctx,
c6dofimu6_cfg_t cfg 
)

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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

◆ c6dofimu6_power()

void c6dofimu6_power ( c6dofimu6_t ctx,
uint8_t  on_off 
)

Power up function.

Parameters
ctxClick object.
on_offValue defines power state of the device

@description Turns the device on or off.

Note
It is advisable to use predefined values.

◆ c6dofimu6_read_accel_x()

int16_t c6dofimu6_read_accel_x ( c6dofimu6_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.

◆ c6dofimu6_read_accel_y()

int16_t c6dofimu6_read_accel_y ( c6dofimu6_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.

◆ c6dofimu6_read_accel_z()

int16_t c6dofimu6_read_accel_z ( c6dofimu6_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.

◆ c6dofimu6_read_accelerometer()

void c6dofimu6_read_accelerometer ( c6dofimu6_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.

◆ c6dofimu6_read_gyro_x()

int16_t c6dofimu6_read_gyro_x ( c6dofimu6_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.

◆ c6dofimu6_read_gyro_y()

int16_t c6dofimu6_read_gyro_y ( c6dofimu6_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.

◆ c6dofimu6_read_gyro_z()

int16_t c6dofimu6_read_gyro_z ( c6dofimu6_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.

◆ c6dofimu6_read_gyroscope()

void c6dofimu6_read_gyroscope ( c6dofimu6_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.

◆ c6dofimu6_read_temp_out()

float c6dofimu6_read_temp_out ( c6dofimu6_t ctx)

Read temperture function.

Parameters
ctxClick object.
Returns
result float temperture data

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