Public function

Topics
	Driver Functions

Functions
void	hallcurrent2_cfg_setup (hallcurrent2_cfg_t *cfg)
	Config Object Initialization function.
HALLCURRENT2_RETVAL	hallcurrent2_init (hallcurrent2_t *ctx, hallcurrent2_cfg_t *cfg)
	Initialization function.
uint16_t	hallcurrent2_generic_read (hallcurrent2_t *ctx)
	Generic read function.

Detailed Description

Function Documentation

hallcurrent2_cfg_setup()

void hallcurrent2_cfg_setup

(

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

hallcurrent2_generic_read()

uint16_t hallcurrent2_generic_read

(

hallcurrent2_t *

ctx

)

Generic read function.

Parameters

ctx	Click object.

Returns

current (12 bits) adc value

@description This function reads data from the desired register.

Note

On 0A loads at the input returns vcc / 2 (1.65V).

hallcurrent2_init()

HALLCURRENT2_RETVAL hallcurrent2_init	(	hallcurrent2_t *	ctx,
		hallcurrent2_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.