This file contains API for Hall Current 18 Click Driver. More...

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

Data Structures
struct	hallcurrent18_t
	Hall Current 18 Click context object. More...

struct	hallcurrent18_cfg_t
	Hall Current 18 Click configuration object. More...

Macros
#define	HALLCURRENT18_ADC_RESOLUTION 0x0FFFu
	Hall Current 18 ADC setting.

#define	HALLCURRENT18_VREF_3V3 3.3f

#define	HALLCURRENT18_VREF_5V 5.0f

#define	HALLCURRENT18_HALF_SCALE_3V3 1.65f

#define	HALLCURRENT18_SENSITIVITY_MV_A 33.0f
	Hall Current 18 data values to calculate.

#define	HALLCURRENT18_CONV_TO_MILI 1000.0f

#define	HALLCURRENT18_ADC_NUM_OF_MEASURE 500u

#define	HALLCURRENT18_SET_DEV_ADDR 0x4D
	Hall Current 18 device address setting.

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

Enumerations
enum	hallcurrent18_drv_t { HALLCURRENT18_DRV_SEL_ADC , HALLCURRENT18_DRV_SEL_I2C }
	Hall Current 18 Click driver selector. More...

enum	hallcurrent18_return_value_t { HALLCURRENT18_OK = 0 , HALLCURRENT18_ERROR = -1 }
	Hall Current 18 Click return value data. More...

Functions
void	hallcurrent18_cfg_setup (hallcurrent18_cfg_t *cfg)
	Hall Current 18 configuration object setup function.

void	hallcurrent18_drv_interface_selection (hallcurrent18_cfg_t *cfg, hallcurrent18_drv_t drv_sel)
	Hall Current 18 driver interface setup function.

err_t	hallcurrent18_init (hallcurrent18_t ctx, hallcurrent18_cfg_t cfg)
	Hall Current 18 initialization function.

err_t	hallcurrent18_default_cfg (hallcurrent18_t *ctx)
	Hall Current 18 default configuration function.

err_t	hallcurrent18_read_raw_adc (hallcurrent18_t ctx, uint16_t raw_adc)
	Hall Current 18 read raw ADC value function.

err_t	hallcurrent18_read_voltage (hallcurrent18_t ctx, float voltage)
	Hall Current 18 read voltage level function.

err_t	hallcurrent18_set_vref (hallcurrent18_t *ctx, float vref)
	Hall Current 18 set vref function.

err_t	hallcurrent18_read_current (hallcurrent18_t ctx, float current)
	Hall Current 18 get current function.

err_t	hallcurrent18_set_zero_ref (hallcurrent18_t *ctx)
	Hall Current 18 set zero reference function.

Detailed Description

This file contains API for Hall Current 18 Click Driver.

Enumeration Type Documentation

Hall Current 18 Click driver selector.

Selects target driver interface of Hall Current 18 Click driver.

Enumerator
HALLCURRENT18_DRV_SEL_ADC	ADC driver descriptor.
HALLCURRENT18_DRV_SEL_I2C	I2C driver descriptor.

Hall Current 18 Click return value data.

Predefined enum values for driver return values.

Enumerator
HALLCURRENT18_OK
HALLCURRENT18_ERROR