Angle Click Driver

Topics
	Macros
	Types

Functions
void	angle_cfg_setup (angle_cfg_t *cfg)
	Config Object Initialization function.
ANGLE_RETVAL	angle_init (angle_t *ctx, angle_cfg_t *cfg)
	Initialization function.
void	angle_default_cfg (angle_t *ctx)
	Click Default Configuration function.
void	angle_generic_write (angle_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
	Generic write function.
void	angle_generic_read (angle_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
	Generic read function.
uint16_t	angle_get_angle (angle_t *ctx)
	Read angle.
uint16_t	angle_get_temperature (angle_t *ctx)
	Read temperature.
uint16_t	angle_get_magnetics (angle_t *ctx)
	Read magnetics.
uint16_t	angle_get_status (angle_t *ctx, uint8_t reg)
	Read angle status.
void	angle_set_config (angle_t *ctx, uint16_t set_value)
	Setting angle configuration.

Detailed Description

Function Documentation

angle_cfg_setup()

void angle_cfg_setup

(

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

angle_default_cfg()

void angle_default_cfg

(

angle_t *

ctx

)

Click Default Configuration function.

Parameters

ctx	Click object.

@description This function executes default configuration for Angle click.

angle_generic_read()

void angle_generic_read	(	angle_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_buf,
		uint8_t	len )

Generic read function.

Parameters

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

@description This function reads data from the desired register.

angle_generic_write()

void angle_generic_write	(	angle_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_buf,
		uint8_t	len )

Generic write 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 writes data to the desired register.

angle_get_angle()

uint16_t angle_get_angle

(

angle_t *

ctx

)

Read angle.

Parameters

ctx	Click object.

Returns

Angle value.

@description This function reads angle value.

angle_get_magnetics()

uint16_t angle_get_magnetics

(

angle_t *

ctx

)

Read magnetics.

Parameters

ctx	Click object.

Returns

Magnetics value.

@description This function reads magnetics value.

angle_get_status()

uint16_t angle_get_status	(	angle_t *	ctx,
		uint8_t	reg )

Read angle status.

Parameters

ctx	Click object.

Returns

@description This function reads the angle status.

angle_get_temperature()

uint16_t angle_get_temperature

(

angle_t *

ctx

)

Read temperature.

Parameters

ctx	Click object.

Returns

Temperature value. @description This function reads temperature value.

angle_init()

ANGLE_RETVAL angle_init	(	angle_t *	ctx,
		angle_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.

angle_set_config()

void angle_set_config	(	angle_t *	ctx,
		uint16_t	set_value )

Setting angle configuration.

Parameters

ctx	Click object.
set_value	Configuration value.

@description This function sets desired configuration.