hallswitch.h File Reference

This file contains API for Hall Switch Click driver. More...

#include "drv_digital_out.h"

Go to the source code of this file.

Data Structures
struct	hallswitch_t
	Click ctx object definition. More...
struct	hallswitch_cfg_t
	Click configuration structure definition. More...

Macros
#define	HALLSWITCH_MAP_MIKROBUS(cfg, mikrobus)
#define	HALLSWITCH_RETVAL   uint8_t
#define	HALLSWITCH_OK   0x00
#define	HALLSWITCH_INIT_ERROR   0xFF
#define	HALLSWITCH_POLE_ACTIVE   0x00
#define	HALLSWITCH_POLE_NO_ACTIVE   0x01

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

This file contains API for Hall Switch Click driver.