Public function

Functions
void	hallcurrent5_cfg_setup (hallcurrent5_cfg_t *cfg)
	Config Object Initialization function.
HALLCURRENT5_RETVAL	hallcurrent5_init (hallcurrent5_t *ctx, hallcurrent5_cfg_t *cfg)
	Initialization function.
hallcurrent5_data_t	hallcurrent5_generic_read (hallcurrent5_t *ctx)
	Generic read function.
float	hallcurrent5_generic_read_voltage (hallcurrent5_t *ctx)
	Generic function for read voltage.
float	hallcurrent5_get_current (hallcurrent5_t *ctx)
	Get ADC current value function.
uint8_t	hallcurrent5_get_fault (hallcurrent5_t *ctx)
	Get ADC fault function.
void	hallcurrent5_set_init_voltage (hallcurrent5_t *ctx, uint16_t voltage)
	Get ADC current value function.

Detailed Description

Function Documentation

hallcurrent5_cfg_setup()

void hallcurrent5_cfg_setup

(

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

hallcurrent5_generic_read()

hallcurrent5_data_t hallcurrent5_generic_read

(

hallcurrent5_t *

ctx

)

Generic read function.

Parameters

ctx	Click object.

Returns

ADC data

@description This function read ADC data.

hallcurrent5_generic_read_voltage()

float hallcurrent5_generic_read_voltage

(

hallcurrent5_t *

ctx

)

Generic function for read voltage.

Parameters

ctx	Click object.

Returns

voltage value

@description This function read voltage value.

hallcurrent5_get_current()

float hallcurrent5_get_current

(

hallcurrent5_t *

ctx

)

Get ADC current value function.

Parameters

ctx	Click object.

@description This function gets ADC current value.

hallcurrent5_get_fault()

uint8_t hallcurrent5_get_fault

(

hallcurrent5_t *

ctx

)

Get ADC fault function.

Parameters

ctx	Click object.

@description This function gets fault.

hallcurrent5_init()

HALLCURRENT5_RETVAL hallcurrent5_init	(	hallcurrent5_t *	ctx,
		hallcurrent5_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.

hallcurrent5_set_init_voltage()

void hallcurrent5_set_init_voltage	(	hallcurrent5_t *	ctx,
		uint16_t	voltage )

Get ADC current value function.

Parameters

ctx	Click object.
voltage	Voltage

@description This function gets ADC value.