sfDevINA237.h

Go to the documentation of this file.

 
#pragma once
 
#include "sfDevINA2XX.h"
 
class sfDevINA237 : public sfDevINA2XX
{
  public:
    sfDevINA237() : 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<int16_t, false>(milliVolts, kShuntLSBDefault, kShuntLSBReduced);
    }
 
    sfTkError_t getBusVoltage_V(float &volts)
    {
        return busVoltageToVolts<uint16_t, false>(volts, kBusLSB);
    }
 
    sfTkError_t getCurrent_A(float &amps)
    {
        return currentToAmps<int16_t, false>(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(int16_t &value)
    {
        return readSignedMeasurementRaw<int16_t, false>(kRegVShunt, value);
    }
 
    sfTkError_t getBusVoltageRaw(uint16_t &value)
    {
        return readUnsignedMeasurementRaw<uint16_t, false>(kRegVBus, value);
    }
 
    sfTkError_t getCurrentRaw(int16_t &value)
    {
        return readSignedMeasurementRaw<int16_t, false>(kRegCurrent, value);
    }
 
    sfTkError_t getPowerRaw(uint32_t &value)
    {
        return readPowerRaw(value);
    }
 
  protected:
    // --- INA237 scaling and calibration constants ---
    static constexpr float kCalScale = 819.2e6f;         
    static constexpr float kShuntLSBDefault = 5.0e-6f;   
    static constexpr float kShuntLSBReduced = 1.25e-6f;  
    static constexpr float kBusLSB = 3.125e-3f;          
    static constexpr float kTempLSB = 125.0e-3f;         
    static constexpr float kCurrentFullScale = 32768.0f; 
    static constexpr float kPowerLSBScale = 0.2f;        
    static constexpr uint8_t kDieTempShift = 4;          
};