Public function

Functions
void	c6dofimu3_cfg_setup (c6dofimu3_cfg_t *cfg)
	Config Object Initialization function.
C6DOFIMU3_RETVAL	c6dofimu3_init (c6dofimu3_t *ctx, c6dofimu3_cfg_t *cfg)
	Initialization function.
void	c6dofimu3_default_cfg (c6dofimu3_t *ctx)
	Click Default Configuration function.
void	c6dofimu3_generic_write (c6dofimu3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
	Generic write function.
void	c6dofimu3_generic_read (c6dofimu3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
	Generic read function.
void	c6dofimu3_set_rst (c6dofimu3_t *ctx, uint8_t rst_state)
	Set RST pin state function.
void	c6dofimu3_multi_write (c6dofimu3_t *ctx, uint8_t reg, uint8_t *p_tx_data, uint8_t n_bytes)
	Multi data write function.
void	c6dofimu3_multi_read (c6dofimu3_t *ctx, uint8_t reg, uint8_t *p_rx_data, uint8_t n_bytes)
	Multi data read function.
C6DOFIMU3_RETVAL_T	c6dofimu3_check_id (c6dofimu3_t *ctx)
	Check ID function.
C6DOFIMU3_RETVAL_T	c6dofimu3_check_data_ready (c6dofimu3_t *ctx)
	Check data ready function.
void	c6dofimu3_standby (c6dofimu3_t *ctx)
	Set standby mode function.
void	c6dofimu3_active (c6dofimu3_t *ctx)
	Set active mode function.
void	c6dofimu3_read_accel_data (c6dofimu3_t *ctx, c6dofimu3_accel_t *accel_data)
	Read Accel data function.
void	c6dofimu3_read_mag_data (c6dofimu3_t *ctx, c6dofimu3_mag_t *mag_data)
	Read Magnetometer data function.
void	c6dofimu3_get_data (c6dofimu3_t *ctx, c6dofimu3_accel_t *accel_data, c6dofimu3_mag_t *mag_data)
	Read Accel and Magnetometer data function.
uint8_t	c6dofimu3_check_int1 (c6dofimu3_t *ctx)
	Get interrupt ststus function.

Detailed Description

Function Documentation

c6dofimu3_active()

void c6dofimu3_active

(

c6dofimu3_t *

ctx

)

Set active mode function.

Parameters

ctx	Click object. @description Function set active mode ( read mode ) of FXOS8700CQ 6-axis sensor with integrated linear accelerometer and magnetometer on 6DOF IMU 3 Click board.

c6dofimu3_cfg_setup()

void c6dofimu3_cfg_setup

(

c6dofimu3_cfg_t *

cfg

)

Config Object Initialization function.

Parameters

cfg	Click configuration structure.

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

Note

All used pins will be set to unconnected state.

c6dofimu3_check_data_ready()

C6DOFIMU3_RETVAL_T c6dofimu3_check_data_ready

(

c6dofimu3_t *

ctx

)

Check data ready function.

Parameters

ctx	Click object.

Returns

Init status: 0 - Check ID Error; 1 - Check ID Success;

@description Function check status if new data ready of FXOS8700CQ 6-axis sensor with integrated linear accelerometer and magnetometer on 6DOF IMU 3 Click board.

c6dofimu3_check_id()

C6DOFIMU3_RETVAL_T c6dofimu3_check_id

(

c6dofimu3_t *

ctx

)

Check ID function.

Parameters

ctx	Click object.

Returns

ID status: 0 - Check ID Error; 1 - Check ID Success;

@description Function check device ID by read ID value from the sensor ID register address of FXOS8700CQ 6-axis sensor with integrated linear accelerometer and magnetometer on 6DOF IMU 3 Click board.

c6dofimu3_check_int1()

uint8_t c6dofimu3_check_int1

(

c6dofimu3_t *

ctx

)

Get interrupt ststus function.

Parameters

ctx	Click object.

Returns

Interrupt state

Interrupt posible state:
- 0 : No active;
- 1 : Active;

@description Function check interrupt state by return state of the INT pin of 6DOF IMU 3 Click board.

c6dofimu3_default_cfg()

void c6dofimu3_default_cfg

(

c6dofimu3_t *

ctx

)

Click Default Configuration function.

Parameters

ctx	Click object.

@description This function executes default configuration for 6 Dof imu 3 click.

c6dofimu3_generic_read()

void c6dofimu3_generic_read	(	c6dofimu3_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_buf,
		uint8_t	len )

Generic read function.

Parameters

ctx	Click object.
reg	Register address.
data_buf	Data buf to be written.
len	Number of the bytes in data buf.

@description This function reads data from the desired register.

c6dofimu3_generic_write()

void c6dofimu3_generic_write	(	c6dofimu3_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_buf,
		uint8_t	len )

Generic write function.

Parameters

ctx	Click object.
reg	Register address.
data_buf	Output data buf
len	Number of the bytes to be read

@description This function writes data to the desired register.

c6dofimu3_get_data()

void c6dofimu3_get_data	(	c6dofimu3_t *	ctx,
		c6dofimu3_accel_t *	accel_data,
		c6dofimu3_mag_t *	mag_data )

Read Accel and Magnetometer data function.

Parameters

ctx	Click object.
accel_data	pointer to memory location where Accel data be stored
gyro_data	pointer to memory location where Magnetometer data be stored

@description Function read Accel and Magnetometer X-axis, Y-axis data and Z-axis data from of FXOS8700CQ 6-axis sensor with integrated linear accelerometer and magnetometer on 6DOF IMU 3 Click board.

c6dofimu3_init()

C6DOFIMU3_RETVAL c6dofimu3_init	(	c6dofimu3_t *	ctx,
		c6dofimu3_cfg_t *	cfg )

Initialization function.

Parameters

ctx	Click object.
cfg	Click configuration structure.

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

c6dofimu3_multi_read()

void c6dofimu3_multi_read	(	c6dofimu3_t *	ctx,
		uint8_t	reg,
		uint8_t *	p_rx_data,
		uint8_t	n_bytes )

Multi data read function.

Parameters

ctx	Click object.
reg	8-bit register address
p_tx_data	pointer to the memory location where data be stored
n_bytes	number of bytes to be written

@description Function read a sequential data starting from the targeted 8-bit register address of of FXOS8700CQ 6-axis sensor with integrated linear accelerometer and magnetometer on 6DOF IMU 3 Click board.

c6dofimu3_multi_write()

void c6dofimu3_multi_write	(	c6dofimu3_t *	ctx,
		uint8_t	reg,
		uint8_t *	p_tx_data,
		uint8_t	n_bytes )

Multi data write function.

Parameters

ctx	Click object.
reg	8-bit register address
p_tx_data	pointer to the data to be written
n_bytes	number of bytes to be written

@description Function writes a sequential data starting from the targeted 8-bit register address of of FXOS8700CQ 6-axis sensor with integrated linear accelerometer and magnetometer on 6DOF IMU 3 Click board.

c6dofimu3_read_accel_data()

void c6dofimu3_read_accel_data	(	c6dofimu3_t *	ctx,
		c6dofimu3_accel_t *	accel_data )

Read Accel data function.

Parameters

ctx	Click object.
accel_data	pointer to memory location where Accel data be stored

@description Function read 14-bit ( signed ) Accel X-axis, Y-axis data and Z-axis data from the 6 targeted starts from C6DOFIMU3_OUT_X_MSB register address of FXOS8700CQ 6-axis sensor with integrated linear accelerometer and magnetometer on 6DOF IMU 3 Click board.

c6dofimu3_read_mag_data()

void c6dofimu3_read_mag_data	(	c6dofimu3_t *	ctx,
		c6dofimu3_mag_t *	mag_data )

Read Magnetometer data function.

Parameters

ctx	Click object.
mag_data	pointer to memory location where Magnetometer data be stored

@description Function read 16-bit ( signed ) Magnetometer X-axis, Y-axis data and Z-axis data from the 6 targeted starts from C6DOFIMU3_M_OUT_X_MSB register address of FXOS8700CQ 6-axis sensor with integrated linear accelerometer and magnetometer on 6DOF IMU 3 Click board.

c6dofimu3_set_rst()

void c6dofimu3_set_rst	(	c6dofimu3_t *	ctx,
		uint8_t	rst_state )

Set RST pin state function.

Parameters

ctx	Click object.
rst_state	0 : RST pin state low. 1 : RST pin state high.

@description Function set state of RST pin on 6DOF IMU 3 Click board.

c6dofimu3_standby()

void c6dofimu3_standby

(

c6dofimu3_t *

ctx

)

Set standby mode function.

Parameters

ctx	Click object.

@description Function set standby mode ( configuration mode ) of FXOS8700CQ 6-axis sensor with integrated linear accelerometer and magnetometer on 6DOF IMU 3 Click board.