Public function

Functions
void	hallswitch_cfg_setup (hallswitch_cfg_t *cfg)
	Config Object Initialization function.
HALLSWITCH_RETVAL	hallswitch_init (hallswitch_t *ctx, hallswitch_cfg_t *cfg)
	Initialization function.
void	hallswitch_set_npole (hallswitch_t *ctx, uint8_t state)
	Function for turn on and turn off N Pole.
void	hallswitch_set_spole (hallswitch_t *ctx, uint8_t state)
	Function for turn on and turn off S Pole.

Detailed Description

Function Documentation

hallswitch_cfg_setup()

void hallswitch_cfg_setup

(

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

hallswitch_init()

HALLSWITCH_RETVAL hallswitch_init	(	hallswitch_t *	ctx,
		hallswitch_cfg_t *	cfg )

Initialization function.

Parameters

hallswitch	Click object.
cfg	Click configuration structure.

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

hallswitch_set_npole()

void hallswitch_set_npole	(	hallswitch_t *	ctx,
		uint8_t	state )

Function for turn on and turn off N Pole.

Parameters

ctx	Click object.

@description This function setst N pole

hallswitch_set_spole()

void hallswitch_set_spole	(	hallswitch_t *	ctx,
		uint8_t	state )

Function for turn on and turn off S Pole.

Parameters

ctx	Click object.

@description This function sets S pole