Public function

Functions
void	gyro4_cfg_setup (gyro4_cfg_t *cfg)
	Config Object Initialization function.
GYRO4_RETVAL	gyro4_init (gyro4_t *ctx, gyro4_cfg_t *cfg)
	Initialization function.
void	gyro4_generic_transfer (gyro4_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
	Generic transfer function.
uint8_t	gyro4_int_get (gyro4_t *ctx)
	Getting INT pin state.
void	gyro4_cs_set (gyro4_t *ctx, uint8_t pin_state)
	Setting CS pin state.
uint8_t	gyro4_spi_get (gyro4_t *ctx, uint8_t register_address, uint8_t *register_buffer, uint16_t n_registers)
	Getting register content.
uint8_t	gyro4_spi_set (gyro4_t *ctx, uint8_t register_address, uint8_t data_in)
	Setting register content.
uint8_t	gyro4_initialize (gyro4_t *ctx)
	Device initialization.
uint8_t	gyro4_get_temperature (gyro4_t *ctx, float *temperature)
	Getting die temperature value.
uint8_t	gyro4_get_axes (gyro4_t *ctx, float *x_axis, float *y_axis)
	Getting axes values.
uint8_t	gyro4_software_reset (gyro4_t *ctx)
	Performing software reset.
uint8_t	gyro4_set_power_mode (gyro4_t *ctx, uint8_t power_mode)
	Setting power mode.
uint8_t	gyro4_set_full_scale_range (gyro4_t *ctx, uint8_t full_scale_range)
	Settinf full scale range.

Detailed Description

Function Documentation

gyro4_cfg_setup()

void gyro4_cfg_setup

(

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

gyro4_cs_set()

void gyro4_cs_set	(	gyro4_t *	ctx,
		uint8_t	pin_state )

Setting CS pin state.

Parameters

ctx	Click object.
pin_state	pin state (0 for LOW and 1 for HIGH)

@description This function gets INT pin state

gyro4_generic_transfer()

void gyro4_generic_transfer	(	gyro4_t *	ctx,
		uint8_t *	wr_buf,
		uint16_t	wr_len,
		uint8_t *	rd_buf,
		uint16_t	rd_len )

Generic transfer function.

Parameters

ctx	Click object.
wr_buf	Write data buffer
wr_len	Number of byte in write data buffer
rd_buf	Read data buffer
rd_len	Number of byte in read data buffer

@description Generic SPI transfer, for sending and receiving packages

gyro4_get_axes()

uint8_t gyro4_get_axes	(	gyro4_t *	ctx,
		float *	x_axis,
		float *	y_axis )

Getting axes values.

Parameters

ctx	Click object.
x_axis	X axis value
y_axis	Y axis value

Returns

0 for successful operation

1 for unsuccessful operation

@description This function gets values from axes registers and converts those values to [deg/s]

gyro4_get_temperature()

uint8_t gyro4_get_temperature	(	gyro4_t *	ctx,
		float *	temperature )

Getting die temperature value.

Parameters

ctx	Click object.
temperature	temperature value

Returns

0 for successful operation

1 for unsuccessful operation

@desrciption This function gets values of temperature registers and convets those values to [deg C]

gyro4_init()

GYRO4_RETVAL gyro4_init	(	gyro4_t *	ctx,
		gyro4_cfg_t *	cfg )

Initialization function.

Parameters

gyro4	Click object.
cfg	Click configuration structure.

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

gyro4_initialize()

uint8_t gyro4_initialize

(

gyro4_t *

ctx

)

Device initialization.

Parameters

ctx	Click object.

Returns

0 for successful operation

1 for unsuccessful operation

Note

        This function initializes the device
        This function sets _GYRO4_REG_CTRL1_OIS register value to 0x4B
        This function sets _GYRO4_REG_CTRL2_OIS register value to 0x00
        This function sets _GYRO4_REG_CTRL3_OIS register value to 0x02
        This function sets _GYRO4_REG_CTRL4_OIS register value to 0x10
        This function sets _GYRO4_REG_OIS_CFG register value to 0x08
*

gyro4_int_get()

uint8_t gyro4_int_get

(

gyro4_t *

ctx

)

Getting INT pin state.

Parameters

ctx	Click object.

Returns

0 if INT pin is LOW

1 if INT pin is HIGH

@description This function gets INT pin state

gyro4_set_full_scale_range()

uint8_t gyro4_set_full_scale_range	(	gyro4_t *	ctx,
		uint8_t	full_scale_range )

Settinf full scale range.

Parameters

ctx	Click object.
full_scale_range	Full scale range (use macros)

Returns

0 for successful operation

1 for unsuccessful operation

@description This function sets full scale range to plus/minus 100 or plus/minus 200 degrees per second

gyro4_set_power_mode()

uint8_t gyro4_set_power_mode	(	gyro4_t *	ctx,
		uint8_t	power_mode )

Setting power mode.

Parameters

ctx	Click object.
power_mode	power mode (use macros)

Returns

0 for successful operation

1 for unsuccessful operation

@description This function sets power mode to POWER DOWN, SLEEP or NORMAL mode

gyro4_software_reset()

uint8_t gyro4_software_reset

(

gyro4_t *

ctx

)

Performing software reset.

Parameters

ctx	Click object.

Returns

0 for successful operation

1 for unsuccessful operation

@description This function activates software reset and makes 1 second delay

gyro4_spi_get()

uint8_t gyro4_spi_get	(	gyro4_t *	ctx,
		uint8_t	register_address,
		uint8_t *	register_buffer,
		uint16_t	n_registers )

Getting register content.

Parameters

ctx	Click object.
register_address	register address
register_buffer	register buffer
n_registers	number of registers

Returns

0 for successful operation

1 for unsuccessful operation

@description This function gets specified number of registers (max. 4 registers) starting at specified registered address and stores register values into register buffer

gyro4_spi_set()

uint8_t gyro4_spi_set	(	gyro4_t *	ctx,
		uint8_t	register_address,
		uint8_t	data_in )

Setting register content.

Parameters

ctx	Click object.
register_address	register address
data_in	register buffer

Returns

0 for successful operation

1 for unsuccessful operation

@description This function sets values from register buffer to specified number of registers (max. 1 registers) starting at specified registered address