Public function

Functions
void	hallcurrent3_cfg_setup (hallcurrent3_cfg_t *cfg)
	Config Object Initialization function.
HALLCURRENT3_RETVAL	hallcurrent3_init (hallcurrent3_t *ctx, hallcurrent3_cfg_t *cfg)
	Initialization function.
void	hallcurrent3_generic_read (hallcurrent3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
	Generic read function.
uint16_t	hallcurrent3_read_data (hallcurrent3_t *ctx, uint8_t reg)
	Data read function.
float	hallcurrent3_get_current (hallcurrent3_t *ctx)
	Get current function.

Detailed Description

Function Documentation

hallcurrent3_cfg_setup()

void hallcurrent3_cfg_setup

(

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

hallcurrent3_generic_read()

void hallcurrent3_generic_read	(	hallcurrent3_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.

hallcurrent3_get_current()

float hallcurrent3_get_current

(

hallcurrent3_t *

ctx

)

Get current function.

Parameters

ctx	Click object.

@description This function calculates the current value.

hallcurrent3_init()

HALLCURRENT3_RETVAL hallcurrent3_init	(	hallcurrent3_t *	ctx,
		hallcurrent3_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.

hallcurrent3_read_data()

uint16_t hallcurrent3_read_data	(	hallcurrent3_t *	ctx,
		uint8_t	reg )

Data read function.

Parameters

ctx	Click object.
reg	Register address.

@description This function read two bytes of data from the specified register.