Public function

Functions
void	unihall_cfg_setup (unihall_cfg_t *cfg)
	Config Object Initialization function.
UNIHALL_RETVAL	unihall_init (unihall_t *ctx, unihall_cfg_t *cfg)
	Initialization function.
uint8_t	unihall_detecting_magnetic_fields (unihall_t *ctx)
	Detecting north pole magnetic fields status function.

Detailed Description

Function Documentation

unihall_cfg_setup()

void unihall_cfg_setup

(

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

unihall_detecting_magnetic_fields()

uint8_t unihall_detecting_magnetic_fields

(

unihall_t *

ctx

)

Detecting north pole magnetic fields status function.

Parameters

ctx	Click object.

Returns

State of INT pin:

 0 - detected; 

 1 - not detected; 

@description This function detecting 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.

unihall_init()

UNIHALL_RETVAL unihall_init	(	unihall_t *	ctx,
		unihall_cfg_t *	cfg )

Initialization function.

Parameters

unihall	Click object.
cfg	Click configuration structure.

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