sfDevINA228.h

Go to the documentation of this file.

 
#pragma once
 
#include "sfDevINA2XX.h"
 
class sfDevINA228 : public sfDevINA2XX
{
  public:
    sfDevINA228() : sfDevINA2XX()
    {
    }
 
    // ========================= Calibration ==================================
 
    sfTkError_t calibrate(float shuntResOhms, float maxCurrentA)
    {
        return calibrateImpl(shuntResOhms, maxCurrentA, kCalScale, kCurrentFullScale);
    }
 
    // ========================= Measurements (Engineering Units) ==============
 
    sfTkError_t getShuntVoltage_mV(float &milliVolts)
    {
        return shuntVoltageToMilliVolts<int32_t, true>(milliVolts, kShuntLSBDefault, kShuntLSBReduced);
    }
 
    sfTkError_t getBusVoltage_V(float &volts)
    {
        return busVoltageToVolts<uint32_t, true>(volts, kBusLSB);
    }
 
    sfTkError_t getCurrent_A(float &amps)
    {
        return currentToAmps<int32_t, true>(amps);
    }
 
    sfTkError_t getPower_W(float &watts)
    {
        return powerToWatts(watts, kPowerLSBScale);
    }
 
    sfTkError_t getDieTemp_C(float &celsius)
    {
        return dieTemperatureToCelsius(celsius, kDieTempShift, kTempLSB);
    }
 
    // ========================= Raw Register Access ===========================
 
    sfTkError_t getShuntVoltageRaw(int32_t &value)
    {
        return readSignedMeasurementRaw<int32_t, true>(kRegVShunt, value);
    }
 
    sfTkError_t getBusVoltageRaw(uint32_t &value)
    {
        return readUnsignedMeasurementRaw<uint32_t, true>(kRegVBus, value);
    }
 
    sfTkError_t getCurrentRaw(int32_t &value)
    {
        return readSignedMeasurementRaw<int32_t, true>(kRegCurrent, value);
    }
 
    sfTkError_t getPowerRaw(uint32_t &value)
    {
        return readPowerRaw(value);
    }
 
    // ========================= Energy & Charge (INA228 Only) ================
 
    sfTkError_t getEnergy_J(double &joules);
 
    sfTkError_t getCharge_C(double &coulombs);
 
  protected:
    // --- INA228 scaling and calibration constants ---
    static constexpr float kCalScale = 13107.2e6f;        
    static constexpr float kShuntLSBDefault = 312.5e-9f;  
    static constexpr float kShuntLSBReduced = 78.125e-9f; 
    static constexpr float kBusLSB = 195.3125e-6f;        
    static constexpr float kTempLSB = 7.8125e-3f;         
    static constexpr float kCurrentFullScale = 524288.0f; 
    static constexpr float kPowerLSBScale = 3.2f;         
    static constexpr uint8_t kDieTempShift = 0;           
    static constexpr double kEnergyLSBScale = 16.0 * 3.2; 
};