This file contains API for LIN Hall 2 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_analog_in.h"

Data Structures
struct	linhall2_t
	LIN Hall 2 Click context object. More...

struct	linhall2_cfg_t
	LIN Hall 2 Click configuration object. More...

Macros
#define	LINHALL2_VOLTAGE_AT_0_MT 1.65f
	LIN Hall 2 description setting.

#define	LINHALL2_SENSITIVITY 0.015f

#define	LINHALL2_ENABLE_DEVICE 0x01
	LIN Hall 2 EN pin setting.

#define	LINHALL2_DISABLE_DEVICE 0x00

#define	LINHALL2_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	linhall2_return_value_t { LINHALL2_OK = 0 , LINHALL2_ERROR = -1 }
	LIN Hall 2 Click return value data. More...

Functions
void	linhall2_cfg_setup (linhall2_cfg_t *cfg)
	LIN Hall 2 configuration object setup function.

err_t	linhall2_init (linhall2_t ctx, linhall2_cfg_t cfg)
	LIN Hall 2 initialization function.

err_t	linhall2_read_an_pin_value (linhall2_t ctx, uint16_t data_out)
	LIN Hall 2 read AN pin value function.

err_t	linhall2_read_an_pin_voltage (linhall2_t ctx, float data_out)
	LIN Hall 2 read AN pin voltage level function.

void	linhal2_set_en_pin (linhall2_t *ctx, uint8_t pin_state)
	LIN Hall 2 set EN pin state function.

err_t	linhal2_get_flux_density (linhall2_t ctx, float data_out)
	LIN Hall 2 read flux density function.

Detailed Description

This file contains API for LIN Hall 2 Click Driver.

Enumeration Type Documentation

LIN Hall 2 Click return value data.

Predefined enum values for driver return values.

Enumerator
LINHALL2_OK
LINHALL2_ERROR