Adafruit_INA260.h

Go to the documentation of this file.

#ifndef _ADAFRUIT_INA260_H
#define _ADAFRUIT_INA260_H

#include "Arduino.h"
#include <Adafruit_I2CDevice.h>
#include <Adafruit_I2CRegister.h>
#include <Wire.h>

#define INA260_I2CADDR_DEFAULT 0x40 
#define INA260_REG_CONFIG 0x00      
#define INA260_REG_CURRENT 0x01 
#define INA260_REG_BUSVOLTAGE 0x02 
#define INA260_REG_POWER 0x03      
#define INA260_REG_MASK_ENABLE                                                 \
  0x06 
#define INA260_REG_ALERT_LIMIT 0x07 
#define INA260_REG_MFG_UID 0xFE     
#define INA260_REG_DIE_UID 0xFF     


typedef enum _mode {
  INA260_MODE_SHUTDOWN = 0x00,   
  INA260_MODE_TRIGGERED = 0x03,  
  INA260_MODE_CONTINUOUS = 0x07, 
} INA260_MeasurementMode;

typedef enum _conversion_time {
  INA260_TIME_140_us,   
  INA260_TIME_204_us,   
  INA260_TIME_332_us,   
  INA260_TIME_558_us,   
  INA260_TIME_1_1_ms,   
  INA260_TIME_2_116_ms, 
  INA260_TIME_4_156_ms, 
  INA260_TIME_8_244_ms, 
} INA260_ConversionTime;

typedef enum _count {
  INA260_COUNT_1,    
  INA260_COUNT_4,    
  INA260_COUNT_16,   
  INA260_COUNT_64,   
  INA260_COUNT_128,  
  INA260_COUNT_256,  
  INA260_COUNT_512,  
  INA260_COUNT_1024, 
} INA260_AveragingCount;

typedef enum _alert_type {
  INA260_ALERT_CONVERSION_READY = 0x1, 
  INA260_ALERT_OVERPOWER = 0x2,        
  INA260_ALERT_UNDERVOLTAGE = 0x4,     
  INA260_ALERT_OVERVOLTAGE = 0x8,      
  INA260_ALERT_UNDERCURRENT = 0x10,    
  INA260_ALERT_OVERCURRENT = 0x20,     
  INA260_ALERT_NONE = 0x0,             
} INA260_AlertType;

typedef enum _alert_polarity {
  INA260_ALERT_POLARITY_NORMAL = 0x0, 
  INA260_ALERT_POLARITY_INVERTED = 0x1, 
} INA260_AlertPolarity;

typedef enum _alert_latch {
  INA260_ALERT_LATCH_ENABLED = 0x1,     
  INA260_ALERT_LATCH_TRANSPARENT = 0x0, 
} INA260_AlertLatch;

class Adafruit_INA260 {
public:
  Adafruit_INA260();
  bool begin(uint8_t i2c_addr = INA260_I2CADDR_DEFAULT,
             TwoWire *theWire = &Wire);
  void reset(void);
  float readCurrent(void);
  float readBusVoltage(void);
  float readPower(void);
  void setMode(INA260_MeasurementMode mode);
  INA260_MeasurementMode getMode(void);

  bool conversionReady(void);
  bool alertFunctionFlag(void);

  float getAlertLimit(void);
  void setAlertLimit(float limit);
  INA260_AlertLatch getAlertLatch(void);
  void setAlertLatch(INA260_AlertLatch state);
  INA260_AlertPolarity getAlertPolarity(void);
  void setAlertPolarity(INA260_AlertPolarity polarity);
  INA260_AlertType getAlertType(void);
  void setAlertType(INA260_AlertType alert);

  INA260_ConversionTime getCurrentConversionTime(void);
  void setCurrentConversionTime(INA260_ConversionTime time);
  INA260_ConversionTime getVoltageConversionTime(void);
  void setVoltageConversionTime(INA260_ConversionTime time);
  INA260_AveragingCount getAveragingCount(void);
  void setAveragingCount(INA260_AveragingCount count);

  Adafruit_I2CRegister *Config, 
      *MaskEnable,              
      *AlertLimit;              

private:
  Adafruit_I2CDevice *i2c_dev;
};

#endif