current10  2.1.0.0
Data Structures | Macros | Enumerations | Functions
current10.h File Reference

This file contains API for Current 10 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  current10_t
 Current 10 Click context object. More...
 
struct  current10_cfg_t
 Current 10 Click configuration object. More...
 

Macros

#define CURRENT10_NUM_CONVERSIONS   200
 Current 10 default ADC samples number for averaging. More...
 
#define CURRENT10_ADC_RESOLUTION   0x0FFF
 Current 10 ADC setting. More...
 
#define CURRENT10_VREF_3V3   3.3
 
#define CURRENT10_VREF_5V   5.0
 
#define CURRENT10_TIMEOUT_MS   2000
 Current 10 timeout setting. More...
 
#define CURRENT10_SET_DEV_ADDR   0x4D
 Current 10 device address setting. More...
 
#define CURRENT10_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  current10_drv_t { CURRENT10_DRV_SEL_ADC, CURRENT10_DRV_SEL_I2C }
 Current 10 Click driver selector. More...
 
enum  current10_return_value_t { CURRENT10_OK = 0, CURRENT10_ERROR = -1 }
 Current 10 Click return value data. More...
 

Functions

void current10_cfg_setup (current10_cfg_t *cfg)
 Current 10 configuration object setup function. More...
 
void current10_drv_interface_sel (current10_cfg_t *cfg, current10_drv_t drv_sel)
 Current 10 driver interface setup function. More...
 
err_t current10_init (current10_t *ctx, current10_cfg_t *cfg)
 Current 10 initialization function. More...
 
err_t current10_read_raw_adc (current10_t *ctx, uint16_t *raw_adc)
 Current 10 read raw ADC value function. More...
 
err_t current10_read_voltage (current10_t *ctx, float *voltage)
 Current 10 read voltage level function. More...
 
err_t current10_read_voltage_avg (current10_t *ctx, uint16_t num_conv, float *voltage_avg)
 Current 10 read average voltage level function. More...
 
err_t current10_set_vref (current10_t *ctx, float vref)
 Current 10 set vref function. More...
 
err_t current10_calib_offset (current10_t *ctx)
 Current 10 calib offset function. More...
 
err_t current10_calib_resolution (current10_t *ctx, float calib_current)
 Current 10 calib resolution function. More...
 
err_t current10_read_current (current10_t *ctx, float *current)
 Current 10 read current function. More...
 

Detailed Description

This file contains API for Current 10 Click Driver.

Enumeration Type Documentation

◆ current10_drv_t

Current 10 Click driver selector.

Selects target driver interface of Current 10 Click driver.

Enumerator
CURRENT10_DRV_SEL_ADC 

ADC driver descriptor.

CURRENT10_DRV_SEL_I2C 

I2C driver descriptor.

◆ current10_return_value_t

Current 10 Click return value data.

Predefined enum values for driver return values.

Enumerator
CURRENT10_OK 
CURRENT10_ERROR