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

This file contains API for Hall Current 22 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  hallcurrent22_t
 Hall Current 22 Click context object. More...
struct  hallcurrent22_cfg_t
 Hall Current 22 Click configuration object. More...

Macros

#define HALLCURRENT22_NUM_CONVERSIONS   200
 Hall Current 22 default ADC samples number for averaging.
#define HALLCURRENT22_ADC_RESOLUTION   0x0FFF
 Hall Current 22 ADC setting.
#define HALLCURRENT22_VREF_3V3   3.35
#define HALLCURRENT22_TIMEOUT_MS   2000
 Hall Current 22 timeout setting.
#define HALLCURRENT22_SET_DEV_ADDR   0x4D
 Hall Current 22 device address setting.
#define HALLCURRENT22_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.

Enumerations

enum  hallcurrent22_drv_t { HALLCURRENT22_DRV_SEL_ADC , HALLCURRENT22_DRV_SEL_I2C }
 Hall Current 22 Click driver selector. More...
enum  hallcurrent22_return_value_t { HALLCURRENT22_OK = 0 , HALLCURRENT22_ERROR = -1 }
 Hall Current 22 Click return value data. More...

Functions

void hallcurrent22_cfg_setup (hallcurrent22_cfg_t *cfg)
 Hall Current 22 configuration object setup function.
void hallcurrent22_drv_interface_sel (hallcurrent22_cfg_t *cfg, hallcurrent22_drv_t drv_sel)
 Hall Current 22 driver interface setup function.
err_t hallcurrent22_init (hallcurrent22_t *ctx, hallcurrent22_cfg_t *cfg)
 Hall Current 22 initialization function.
err_t hallcurrent22_read_raw_adc (hallcurrent22_t *ctx, uint16_t *raw_adc)
 Hall Current 22 read raw ADC value function.
err_t hallcurrent22_read_voltage (hallcurrent22_t *ctx, float *voltage)
 Hall Current 22 read voltage level function.
err_t hallcurrent22_read_voltage_avg (hallcurrent22_t *ctx, uint16_t num_conv, float *voltage_avg)
 Hall Current 22 read average voltage level function.
err_t hallcurrent22_set_vref (hallcurrent22_t *ctx, float vref)
 Hall Current 22 set vref function.
err_t hallcurrent22_calib_offset (hallcurrent22_t *ctx)
 Hall Current 22 calib offset function.
err_t hallcurrent22_calib_resolution (hallcurrent22_t *ctx, float calib_current)
 Hall Current 22 calib resolution function.
err_t hallcurrent22_read_current (hallcurrent22_t *ctx, float *current)
 Hall Current 22 read current function.

Detailed Description

This file contains API for Hall Current 22 Click Driver.

Enumeration Type Documentation

◆ hallcurrent22_drv_t

Hall Current 22 Click driver selector.

Selects target driver interface of Hall Current 22 Click driver.

Enumerator
HALLCURRENT22_DRV_SEL_ADC 

ADC driver descriptor.

HALLCURRENT22_DRV_SEL_I2C 

I2C driver descriptor.

◆ hallcurrent22_return_value_t

Hall Current 22 Click return value data.

Predefined enum values for driver return values.

Enumerator
HALLCURRENT22_OK 
HALLCURRENT22_ERROR