Public function

Functions
void	hallcurrent_cfg_setup (hallcurrent_cfg_t *cfg)
	Config Object Initialization function.
err_t	hallcurrent_init (hallcurrent_t *ctx, hallcurrent_cfg_t *cfg)
	Initialization function.
uint16_t	hallcurrent_read_data (hallcurrent_t *ctx)
	Generic read 16-bit data function.
uint8_t	hallcurrent_check_status (hallcurrent_t *ctx)
	Check status of read data function.
float	hallcurrent_read_current (hallcurrent_t *ctx)
	Read electric current function.
uint8_t	hallcurrent_get_ocd_pin (hallcurrent_t *ctx)
	Read OCD pin state function.

Detailed Description

Function Documentation

hallcurrent_cfg_setup()

void hallcurrent_cfg_setup

(

hallcurrent_cfg_t *

cfg

)

Config Object Initialization function.

Parameters

cfg	Click configuration structure.

This function initializes click configuration structure to init state.

Note

All used pins will be set to unconnected state.

hallcurrent_check_status()

uint8_t hallcurrent_check_status

(

hallcurrent_t *

ctx

)

Check status of read data function.

Returns

status

• 0 : OK, Sensor Value Message.

• 1 : ERROR, Sensor Status Message.

  Function read the 16-bit data from the target register address and return 0 if data is valid or 1 of data not valid.

hallcurrent_get_ocd_pin()

uint8_t hallcurrent_get_ocd_pin

(

hallcurrent_t *

ctx

)

Read OCD pin state function.

Returns

Pin logic state

Reads the OCD pin logic state.

hallcurrent_init()

err_t hallcurrent_init	(	hallcurrent_t *	ctx,
		hallcurrent_cfg_t *	cfg )

Initialization function.

Parameters

hallcurrent	Click object.
cfg	Click configuration structure.

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

hallcurrent_read_current()

float hallcurrent_read_current

(

hallcurrent_t *

ctx

)

Read electric current function.

Returns

float electric current data

Function read the current data and return 0 if data is not valid.

hallcurrent_read_data()

uint16_t hallcurrent_read_data

(

hallcurrent_t *

ctx

)

Generic read 16-bit data function.

Returns

16-bit read data

Function read the 16-bit data from the target register address of TLI4970-D050T4 miniature magnetic digital current sensor