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

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"

Data Structures
struct	hallcurrent17_t
	Hall Current 17 Click context object. More...

struct	hallcurrent17_cfg_t
	Hall Current 17 Click configuration object. More...

Macros
#define	HALLCURRENT17_ADDR_IN_CH_SEL_1 0x00
	Hall Current 17 input channel address selection.

#define	HALLCURRENT17_ADDR_IN_CH_SEL_2 0x08

#define	HALLCURRENT17_RESOLUTION_12BIT 0x0FFFu
	Hall Current 17 description setting.

#define	HALLCURRENT17_VREF_3V3 3.3f
	Hall Current 17 voltage reference selection.

#define	HALLCURRENT17_VREF_5V 5.0f

#define	HALLCURRENT17_RES_R5_R7_100_KOHM 100.0f
	Hall Current 17 resistance value (voltage divider calculation).

#define	HALLCURRENT17_RES_R6_R8_100_KOHM 100.0f

#define	HALLCURRENT17_NUM_OF_MEASURE 1000u
	Hall Current 17 data values to calculate.

#define	HALLCURRENT17_CONV_V_TO_MV 1000.0f

#define	HALLCURRENT17_SENSITIVITY_MV_A 40.0f
	Hall Current 17 sensitivity (mV/A) value.

#define	HALLCURRENT17_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
	Data sample selection.

#define	HALLCURRENT17_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE

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

Enumerations
enum	hallcurrent17_return_value_t { HALLCURRENT17_OK = 0 , HALLCURRENT17_ERROR = -1 }
	Hall Current 17 Click return value data. More...

Functions
void	hallcurrent17_cfg_setup (hallcurrent17_cfg_t *cfg)
	Hall Current 17 configuration object setup function.

err_t	hallcurrent17_init (hallcurrent17_t ctx, hallcurrent17_cfg_t cfg)
	Hall Current 17 initialization function.

err_t	hallcurrent17_default_cfg (hallcurrent17_t *ctx)
	Hall Current 17 default configuration function.

void	hallcurrent17_set_adc_vref (hallcurrent17_t *ctx, float vref)
	Hall Current 17 set voltage reference function.

err_t	hallcurrent17_get_voltage (hallcurrent17_t ctx, float voltage)
	Hall Current 17 get voltage function.

err_t	hallcurrent17_get_vref (hallcurrent17_t ctx, float adc_vref)
	Hall Current 17 get Vref function.

err_t	hallcurrent17_get_vout (hallcurrent17_t ctx, float adc_vout)
	Hall Current 17 get Vout function.

err_t	hallcurrent17_get_current (hallcurrent17_t ctx, float current)
	Hall Current 17 get current function.

Detailed Description

This file contains API for Hall Current 17 Click Driver.

Enumeration Type Documentation

Hall Current 17 Click return value data.

Predefined enum values for driver return values.

Enumerator
HALLCURRENT17_OK
HALLCURRENT17_ERROR