hallcurrent20 2.2.0
Loading...
Searching...
No Matches
hallcurrent20.h File Reference

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

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

Go to the source code of this file.

Data Structures

struct  hallcurrent20_t
 Hall Current 20 Click context object. More...
struct  hallcurrent20_cfg_t
 Hall Current 20 Click configuration object. More...

Macros

#define HALLCURRENT20_NUM_CONVERSIONS   200
 Hall Current 20 default ADC samples number for averaging.
#define HALLCURRENT20_ADC_RESOLUTION   0x0FFF
 Hall Current 20 ADC setting.
#define HALLCURRENT20_VREF_3V3   3.3
#define HALLCURRENT20_VREF_5V   5.0
#define HALLCURRENT20_TIMEOUT_MS   2000
 Hall Current 20 timeout setting.
#define HALLCURRENT20_SET_DEV_ADDR   0x4D
 Hall Current 20 device address setting.
#define HALLCURRENT20_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.

Enumerations

enum  hallcurrent20_drv_t { HALLCURRENT20_DRV_SEL_ADC , HALLCURRENT20_DRV_SEL_I2C }
 Hall Current 20 Click driver selector. More...
enum  hallcurrent20_return_value_t { HALLCURRENT20_OK = 0 , HALLCURRENT20_ERROR = -1 }
 Hall Current 20 Click return value data. More...

Functions

void hallcurrent20_cfg_setup (hallcurrent20_cfg_t *cfg)
 Hall Current 20 configuration object setup function.
void hallcurrent20_drv_interface_sel (hallcurrent20_cfg_t *cfg, hallcurrent20_drv_t drv_sel)
 Hall Current 20 driver interface setup function.
err_t hallcurrent20_init (hallcurrent20_t *ctx, hallcurrent20_cfg_t *cfg)
 Hall Current 20 initialization function.
err_t hallcurrent20_read_raw_adc (hallcurrent20_t *ctx, uint16_t *raw_adc)
 Hall Current 20 read raw ADC value function.
err_t hallcurrent20_read_voltage (hallcurrent20_t *ctx, float *voltage)
 Hall Current 20 read voltage level function.
err_t hallcurrent20_read_voltage_avg (hallcurrent20_t *ctx, uint16_t num_conv, float *voltage_avg)
 Hall Current 20 read average voltage level function.
err_t hallcurrent20_set_vref (hallcurrent20_t *ctx, float vref)
 Hall Current 20 set vref function.
uint8_t hallcurrent20_get_fault_pin (hallcurrent20_t *ctx)
 Hall Current 20 get fault pin function.
err_t hallcurrent20_calib_offset (hallcurrent20_t *ctx)
 Hall Current 20 calib offset function.
err_t hallcurrent20_calib_resolution (hallcurrent20_t *ctx, float calib_current)
 Hall Current 20 calib resolution function.
err_t hallcurrent20_read_current (hallcurrent20_t *ctx, float *current)
 Hall Current 20 read current function.

Detailed Description

This file contains API for Hall Current 20 Click Driver.

Enumeration Type Documentation

◆ hallcurrent20_drv_t

Hall Current 20 Click driver selector.

Selects target driver interface of Hall Current 20 Click driver.

Enumerator
HALLCURRENT20_DRV_SEL_ADC 

ADC driver descriptor.

HALLCURRENT20_DRV_SEL_I2C 

I2C driver descriptor.

◆ hallcurrent20_return_value_t

Hall Current 20 Click return value data.

Predefined enum values for driver return values.

Enumerator
HALLCURRENT20_OK 
HALLCURRENT20_ERROR