This file contains API for Hall Current 15 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	hallcurrent15_t
	Hall Current 15 Click context object. More...

struct	hallcurrent15_cfg_t
	Hall Current 15 Click configuration object. More...

Macros
#define	HALLCURRENT15_REG_CONVERSION_RESULT 0x00
	Hall Current 15 register map.

#define	HALLCURRENT15_REG_ALERT_STATUS 0x01

#define	HALLCURRENT15_REG_CONFIGURATION 0x02

#define	HALLCURRENT15_REG_LOW_LIMIT 0x03

#define	HALLCURRENT15_REG_HIGH_LIMIT 0x04

#define	HALLCURRENT15_REG_HYSTERESIS 0x05

#define	HALLCURRENT15_REG_LOWEST_CONVERSION 0x06

#define	HALLCURRENT15_REG_HIGHEST_CONVERSION 0x07

#define	HALLCURRENT15_SENSITIVITY_V_TO_A 0.05
	Hall Current 15 Current calculation values.

#define	HALLCURRENT15_ZERO_CURRENT_OFFSET 0.1

#define	HALLCURRENT15_NUM_CONVERSIONS 1000

#define	HALLCURRENT15_ADC_RESOLUTION 0x03FF
	Hall Current 15 ADC setting.

#define	HALLCURRENT15_VREF_3V3 3.3

#define	HALLCURRENT15_VREF_5V 5.0

#define	HALLCURRENT15_SET_DEV_ADDR 0x54
	Hall Current 15 device address setting.

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

Enumerations
enum	hallcurrent15_drv_t { HALLCURRENT15_DRV_SEL_ADC , HALLCURRENT15_DRV_SEL_I2C }
	Hall Current 15 Click driver selector. More...

enum	hallcurrent15_return_value_t { HALLCURRENT15_OK = 0 , HALLCURRENT15_ERROR = -1 }
	Hall Current 15 Click return value data. More...

Functions
void	hallcurrent15_cfg_setup (hallcurrent15_cfg_t *cfg)
	Hall Current 15 configuration object setup function.

void	hallcurrent15_drv_interface_selection (hallcurrent15_cfg_t *cfg, hallcurrent15_drv_t drv_sel)
	Hall Current 15 driver interface setup function.

err_t	hallcurrent15_init (hallcurrent15_t ctx, hallcurrent15_cfg_t cfg)
	Hall Current 15 initialization function.

err_t	hallcurrent15_write_register (hallcurrent15_t *ctx, uint8_t reg, uint16_t data_in)
	Hall Current 15 write register function.

err_t	hallcurrent15_read_register (hallcurrent15_t ctx, uint8_t reg, uint16_t data_out)
	Hall Current 15 read register function.

uint8_t	hallcurrent15_get_alert_pin (hallcurrent15_t *ctx)
	Hall Current 15 get alert pin function.

err_t	hallcurrent15_read_raw_adc (hallcurrent15_t ctx, uint16_t raw_adc)
	Hall Current 15 read raw ADC value function.

err_t	hallcurrent15_read_voltage (hallcurrent15_t ctx, float voltage)
	Hall Current 15 read voltage level function.

err_t	hallcurrent15_set_vref (hallcurrent15_t *ctx, float vref)
	Hall Current 15 set vref function.

err_t	hallcurrent15_read_current (hallcurrent15_t ctx, float current)
	Hall Current 15 read current function.

Detailed Description

This file contains API for Hall Current 15 Click Driver.

Enumeration Type Documentation

Hall Current 15 Click driver selector.

Selects target driver interface of Hall Current 15 Click driver.

Enumerator
HALLCURRENT15_DRV_SEL_ADC	ADC driver descriptor.
HALLCURRENT15_DRV_SEL_I2C	I2C driver descriptor.

Hall Current 15 Click return value data.

Predefined enum values for driver return values.

Enumerator
HALLCURRENT15_OK
HALLCURRENT15_ERROR