ErriezINA219.h

Go to the documentation of this file.

/*
 * MIT License
 *
 * Copyright (c) 2020 Erriez
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#ifndef ERRIEZ_INA219_H_
#define ERRIEZ_INA219_H_

#include <stdint.h>

// INA219 configuration
#define INA219_I2C_ADDRESS          0x40    
#define INA219_SHUNT_RESISTOR       0.1     

// INA219 registers
#define INA219_REG_CONFIG           0x00    
#define INA219_REG_SHUNTVOLTAGE     0x01    
#define INA219_REG_BUSVOLTAGE       0x02    
#define INA219_REG_POWER            0x03    
#define INA219_REG_CURRENT          0x04    
#define INA219_REG_CALIBRATION      0x05    

// INA219 register bit defines
#define INA219_CONFIG_RST                   15          

#define INA219_CONFIG_BRNG                  13          
#define INA219_CONFIG_BRNG_16V              (0 << 13)   
#define INA219_CONFIG_BRNG_32V              (1 << 13)   

#define INA219_CONFIG_GAIN_MASK             (3 << 12)   
#define INA219_CONFIG_GAIN_1                (0 << 12)   
#define INA219_CONFIG_GAIN_2                (1 << 12)   
#define INA219_CONFIG_GAIN_4                (2 << 12)   
#define INA219_CONFIG_GAIN_8                (3 << 12)   

#define INA219_CONFIG_BADC_MASK             0x0780      
#define INA219_CONFIG_BADC(adc)             ((adc & INA219_CONFIG_BADC_MASK) << 7) 

#define INA219_CONFIG_SADC_MASK             0x0078      
#define INA219_CONFIG_SADC(adc)             ((adc & INA219_CONFIG_BADC_MASK) << 3) 

#define INA219_CONFIG_xADC_9B               0           
#define INA219_CONFIG_xADC_10B              1           
#define INA219_CONFIG_xADC_11B              2           
#define INA219_CONFIG_xADC_12B              3           
#define INA219_CONFIG_xADC_2S               9           
#define INA219_CONFIG_xADC_4S               10          
#define INA219_CONFIG_xADC_8S               11          
#define INA219_CONFIG_xADC_16S              12          
#define INA219_CONFIG_xADC_32S              13          
#define INA219_CONFIG_xADC_64S              14          
#define INA219_CONFIG_xADC_128S             15          

#define INA219_CONFIG_MODE_MASK             0x0007      
#define INA219_CONFIG_MODE(mode)            ((mode & INA219_CONFIG_MODE_MASK) << 0) 
#define INA219_CONFIG_MODE_POWER_DOWN       0           
#define INA219_CONFIG_MODE_SHUNT_TRG        1           
#define INA219_CONFIG_MODE_BUS_TRG          2           
#define INA219_CONFIG_MODE_SHUNT_BUS_TRG    3           
#define INA219_CONFIG_MODE_ADC_OFF          4           
#define INA219_CONFIG_MODE_SHUNT_CNT        5           
#define INA219_CONFIG_MODE_BUS_CNT          6           
#define INA219_CONFIG_MODE_SHUNT_BUS_CNT    7           


#define REG_CONFIG_VALUE            0x399F


class INA219
{
public:
    // Constructor
    INA219(uint8_t i2cAddress=INA219_I2C_ADDRESS, float shuntResistor=INA219_SHUNT_RESISTOR);

    // INA219 functions
    bool begin();
    bool powerDown();
    bool powerUp();
    bool read();

    // I2C register access
    void registerWrite(uint8_t reg, uint16_t val);
    uint16_t registerRead(uint8_t reg);
    uint8_t getI2CStatus();

    // Debug functions
    void dumpRegisters(Stream *serial);

    float busVoltage;       
    float shuntVoltage;     
    float current;          
    float power;            
    bool overflow;          
    bool available;         

private:
    void clear();

    uint8_t _i2cAddress;        
    uint8_t _i2cStatus;
    float _shuntResistor;   
    bool _powerDown;        
};


#endif // ERRIEZ_INA219_H_