Public function

Functions
void	bihall_cfg_setup (bihall_cfg_t *cfg)
	Config Object Initialization function.
BIHALL_RETVAL	bihall_init (bihall_t *ctx, bihall_cfg_t *cfg)
	Initialization function.
uint8_t	bihall_det_mag_field (bihall_t *ctx)
	Detecting south & north pole magnetic fields status function.

Detailed Description

Function Documentation

bihall_cfg_setup()

void bihall_cfg_setup

(

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

bihall_det_mag_field()

uint8_t bihall_det_mag_field

(

bihall_t *

ctx

)

Detecting south & north pole magnetic fields status function.

Parameters

ctx	Click object.

Returns

State of INT pin:

 0 : north pole magnetic fields; 

 1 : south pole magnetic fields; 

@description This function detecting south & north pole magnetic fields status and returns the state of the INT pin. INT pin can be configured to show are data registers updated with the new values or not.

bihall_init()

BIHALL_RETVAL bihall_init	(	bihall_t *	ctx,
		bihall_cfg_t *	cfg )

Initialization function.

Parameters

bihall	Click object.
cfg	Click configuration structure.

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