BatteryMonitorHardware.hpp

Go to the documentation of this file.

 
#pragma once
 
#include "InternalTypes.hpp"
#include "SimWheelTypes.hpp"
 
//-------------------------------------------------------------------
// Abstract hardware interface
//-------------------------------------------------------------------
 
class BatteryMonitorInterface
{
public:
    virtual void getStatus(BatteryStatus &currentStatus);
 
    virtual void onStart() {};
 
protected:
    virtual bool read_soc(uint8_t &soc) = 0;
};
 
//-------------------------------------------------------------------
// Optional hardware witnesses
//-------------------------------------------------------------------
 
class BatteryCharger
{
public:
    static void setExternalPowerWitness(
        InputGPIO sensePin,
        bool negativeLogic,
        bool enableInternalPullResistor);
 
    static void setChargingWitness(
        InputGPIO sensePin,
        bool negativeLogic,
        bool enableInternalPullResistor);
 
    static void update(BatteryStatus &status);
 
private:
    inline static InputGPIO _powerSensePin{};
    inline static bool _powerSenseNegativeLogic = false;
    inline static InputGPIO _chargingSensePin{};
    inline static bool _chargingSenseNegativeLogic = false;
};
 
//-------------------------------------------------------------------
// Testing
//-------------------------------------------------------------------
 
class FakeBatteryMonitor : public BatteryMonitorInterface
{
public:
    BatteryStatus *status = nullptr;
 
public:
    FakeBatteryMonitor(BatteryStatus *fakeStatus)
    {
        this->status = fakeStatus;
    }
 
    virtual void getStatus(BatteryStatus &currentStatus) override
    {
        if (status != nullptr)
            currentStatus = *status;
    }
 
    virtual bool read_soc(uint8_t &soc) override { return false; }
};
 
//-------------------------------------------------------------------
// MAX1704x hardware
//-------------------------------------------------------------------
 
class MAX1704x : public BatteryMonitorInterface
{
protected:
    void *device = nullptr;
 
    bool read(uint8_t regAddress, uint16_t &value);
 
    bool write(uint8_t regAddress, uint16_t value);
 
    bool quickStart();
 
    virtual bool read_soc(uint8_t &currentSoC) override;
 
public:
    MAX1704x(I2CBus bus = I2CBus::PRIMARY, uint8_t i2c_address = 0xFF);
 
    virtual ~MAX1704x();
 
    virtual void onStart() override
    {
        quickStart();
    }
 
}; // class MAX1704x
 
//-------------------------------------------------------------------
// Voltage divider hardware
//-------------------------------------------------------------------
 
class VoltageDividerMonitor : public BatteryMonitorInterface
{
protected:
    OutputGPIO _batteryENPin;
    ADC_GPIO _batteryREADPin;
    int CHARGING_ADC_READING = 3442;
 
    virtual bool read_soc(uint8_t &currentSoC) override;
 
public:
    // NOTE: these public members are for testing. Do not tamper with them.
 
    int lastBatteryReading = 0;
 
    int read();
 
public:
    VoltageDividerMonitor(
        ADC_GPIO battREADPin,
        OutputGPIO battENPin,
        uint32_t resistorToGND = 200,
        uint32_t resistorToBattery = 110);
 
    static uint8_t readingToSoC(int reading);
 
}; // class VoltageDividerMonitor
 
//-------------------------------------------------------------------