Public function

Functions
void	gyro5_cfg_setup (gyro5_cfg_t *cfg)
	Config Object Initialization function.
GYRO5_RETVAL	gyro5_init (gyro5_t *ctx, gyro5_cfg_t *cfg)
	Initialization function.
void	gyro5_default_cfg (gyro5_t *ctx)
	Click Default Configuration function.
void	gyro5_generic_write (gyro5_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
	Generic write function.
void	gyro5_generic_read (gyro5_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
	Generic read function.
uint8_t	gyro5_get_int (gyro5_t *ctx)
	Getting INT pin state.
uint8_t	gyro5_int_status (gyro5_t *ctx, uint8_t int_type)
	Getting interrupt status.
void	gyro5_get_temperature (gyro5_t *ctx, float *temperature)
	Getting temperature value.
void	gyro5_get_axes (gyro5_t *ctx, float *x_axis, float *y_axis, float *z_axis)
	Getting gyroscope axes values.
void	gyro5_sleep (gyro5_t *ctx, uint8_t en_sleep)
	Set sleep mode.

Detailed Description

Function Documentation

gyro5_cfg_setup()

void gyro5_cfg_setup

(

gyro5_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.

gyro5_default_cfg()

void gyro5_default_cfg

(

gyro5_t *

ctx

)

Click Default Configuration function.

Parameters

ctx	Click object.

@description This function executes default configuration for Gyro 5 click.

gyro5_generic_read()

void gyro5_generic_read	(	gyro5_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.

gyro5_generic_write()

void gyro5_generic_write	(	gyro5_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.

gyro5_get_axes()

void gyro5_get_axes	(	gyro5_t *	ctx,
		float *	x_axis,
		float *	y_axis,
		float *	z_axis )

Getting gyroscope axes values.

Parameters

ctx	Click object.
x_axis	pointer to memory location where float x axis value be stored
y_axis	pointer to memory location where float y axis value be stored
z_axis	pointer to memory location where float z axis value be stored

@description This function reads axes measurement registers. This function converts raw axes measurement data to get gyroscope data in [deg/s]

gyro5_get_int()

uint8_t gyro5_get_int

(

gyro5_t *

ctx

)

Getting INT pin state.

Parameters

ctx	Click object.

Returns

• 0 : if INT pin state is LOW
• 1 : if INT pin state is HIGH

@description This function returns INT pin state

gyro5_get_temperature()

void gyro5_get_temperature	(	gyro5_t *	ctx,
		float *	temperature )

Getting temperature value.

Parameters

ctx	Click object.
temperature	pointer to memory location where float temperature data be stored

@description This function reads temperature measurement registers. This function converts raw temperature data to get die temperature in [deg C]

gyro5_init()

GYRO5_RETVAL gyro5_init	(	gyro5_t *	ctx,
		gyro5_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.

gyro5_int_status()

uint8_t gyro5_int_status	(	gyro5_t *	ctx,
		uint8_t	int_type )

Getting interrupt status.

Parameters

ctx	Click object.
int_type	uint8_t interrupt_type - interrupt type (data ready, fsync or fifo overflow)

Returns

• 0 : for successful operations
• 1 : for unsuccessful operations

@description This function returns state of specified interrupt bit

gyro5_sleep()

void gyro5_sleep	(	gyro5_t *	ctx,
		uint8_t	en_sleep )

Set sleep mode.

Parameters

ctx	Click object.
en_sleep	0 : disable sleep mode 1 : enable sleep mode

@description This function set sleep mode