ina2xx.h

Go to the documentation of this file.

/*
 * Copyright (C) 2015 Eistec AB
 *               2019 Otto-von-Guericke-Universität Magdeburg
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#ifndef INA2XX_H
#define INA2XX_H
 
#include <stdint.h>
 
#include "periph/i2c.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum ina2xx_mode {
    INA2XX_MODE_POWERDOWN             = 0x0000, 
    INA2XX_MODE_TRIGGER_SHUNT_ONLY    = 0x0001, 
    INA2XX_MODE_TRIGGER_BUS_ONLY      = 0x0002, 
    INA2XX_MODE_TRIGGER_SHUNT_BUS     = 0x0003, 
    INA2XX_MODE_ADC_DISABLE           = 0x0004, 
    INA2XX_MODE_CONTINUOUS_SHUNT_ONLY = 0x0005, 
    INA2XX_MODE_CONTINUOUS_BUS_ONLY   = 0x0006, 
    INA2XX_MODE_CONTINUOUS_SHUNT_BUS  = 0x0007, 
} ina2xx_mode_t;
 
typedef enum ina2xx_sadc {
    INA2XX_SADC_9BIT            = 0x0000,
    INA2XX_SADC_10BIT           = 0x0008,
    INA2XX_SADC_11BIT           = 0x0010,
    INA2XX_SADC_12BIT           = 0x0018,
    INA2XX_SADC_AVG_1_SAMPLE    = 0x0040,
    INA2XX_SADC_AVG_2_SAMPLES   = 0x0048,
    INA2XX_SADC_AVG_4_SAMPLES   = 0x0050,
    INA2XX_SADC_AVG_8_SAMPLES   = 0x0058,
    INA2XX_SADC_AVG_16_SAMPLES  = 0x0060,
    INA2XX_SADC_AVG_32_SAMPLES  = 0x0068,
    INA2XX_SADC_AVG_64_SAMPLES  = 0x0070,
    INA2XX_SADC_AVG_128_SAMPLES = 0x0078,
} ina2xx_sadc_t;
 
typedef enum ina2xx_badc {
    INA2XX_BADC_9BIT            = 0x0000,
    INA2XX_BADC_10BIT           = 0x0080,
    INA2XX_BADC_11BIT           = 0x0100,
    INA2XX_BADC_12BIT           = 0x0180,
    INA2XX_BADC_AVG_1_SAMPLE    = 0x0400,
    INA2XX_BADC_AVG_2_SAMPLES   = 0x0480,
    INA2XX_BADC_AVG_4_SAMPLES   = 0x0500,
    INA2XX_BADC_AVG_8_SAMPLES   = 0x0580,
    INA2XX_BADC_AVG_16_SAMPLES  = 0x0600,
    INA2XX_BADC_AVG_32_SAMPLES  = 0x0680,
    INA2XX_BADC_AVG_64_SAMPLES  = 0x0700,
    INA2XX_BADC_AVG_128_SAMPLES = 0x0780,
} ina2xx_badc_t;
 
typedef enum ina2xx_pga {
    INA2XX_SHUNT_RANGE_40MV     = 0x0000, 
    INA2XX_SHUNT_RANGE_80MV     = 0x0800, 
    INA2XX_SHUNT_RANGE_160MV    = 0x1000, 
    INA2XX_SHUNT_RANGE_320MV    = 0x1800, 
} ina2xx_pga_t;
 
typedef enum ina2xx_brng {
    INA2XX_BUS_RANGE_16V        = 0x0000, 
    INA2XX_BUS_RANGE_32V        = 0x2000, 
} ina2xx_brng_t;
 
typedef enum ina2xx_i_range {
    INA2XX_CURRENT_RANGE_327_MA,     
    INA2XX_CURRENT_RANGE_655_MA,     
    INA2XX_CURRENT_RANGE_1310_MA,    
    INA2XX_CURRENT_RANGE_2621_MA,    
    INA2XX_CURRENT_RANGE_5242_MA,    
    INA2XX_CURRENT_RANGE_10485_MA,   
} ina2xx_i_range_t;
 
typedef struct {
    i2c_t i2c;                  
    uint8_t addr;               
    uint16_t config;            
    uint16_t rshunt_mohm;       
    ina2xx_i_range_t i_range;   
} ina2xx_params_t;
 
typedef struct {
    ina2xx_params_t params;     
} ina2xx_t;
 
int ina2xx_init(ina2xx_t *dev, const ina2xx_params_t *params);
 
int ina2xx_read_shunt(const ina2xx_t *dev, int16_t *voltage);
 
int ina2xx_read_bus(const ina2xx_t *dev, uint16_t *voltage);
 
int ina2xx_read_current(const ina2xx_t *dev, int32_t *current);
 
int ina2xx_read_power(const ina2xx_t *dev, uint32_t *power);
 
#ifdef __cplusplus
}
#endif
 
#endif /* INA2XX_H */