bihall 2.0.0.0
bihall.h File Reference

This file contains API for BI HALL Click driver. More...

#include "drv_digital_in.h"

Go to the source code of this file.

Data Structures

struct  bihall_t
 Click ctx object definition. More...
 
struct  bihall_cfg_t
 Click configuration structure definition. More...
 

Macros

#define BIHALL_MAP_MIKROBUS(cfg, mikrobus)    cfg.int_pin= MIKROBUS( mikrobus, MIKROBUS_INT );
 
#define BIHALL_RETVAL   uint8_t
 
#define BIHALL_OK   0x00
 
#define BIHALL_INIT_ERROR   0xFF
 
#define BIHALL_MAG_POLE_NORTH   0
 
#define BIHALL_MAG_POLE_SOUTH   1
 

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

This file contains API for BI HALL Click driver.