unit_EEPROM.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2024 M5Stack Technology CO LTD
 *
 * SPDX-License-Identifier: MIT
 */
#ifndef M5_UNIT_METER_UNIT_EEPROM_HPP
#define M5_UNIT_METER_UNIT_EEPROM_HPP
 
#include "unit_ADS111x.hpp"
#include <M5UnitComponent.hpp>
#include <m5_utility/stl/extension.hpp>
#include <array>
 
namespace m5 {
namespace unit {
namespace meter {
 
class UnitEEPROM : public Component {
    M5_UNIT_COMPONENT_HPP_BUILDER(UnitEEPROM, 0x00);
 
public:
    explicit UnitEEPROM(const uint8_t addr = DEFAULT_ADDRESS) : Component(addr)
    {
        // 400 kHz, the same as the ADS1115 on the same bus (the official driver also reads this EEPROM at 400 kHz)
        auto ccfg  = component_config();
        ccfg.clock = 400 * 1000U;
        component_config(ccfg);
    }
    virtual ~UnitEEPROM()
    {
    }
 
    inline int16_t hope(m5::unit::ads111x::Gain gain) const
    {
        return _calibration[m5::stl::to_underlying(gain)].hope;
    }
    inline int16_t actual(m5::unit::ads111x::Gain gain) const
    {
        return _calibration[m5::stl::to_underlying(gain)].actual;
    }
    inline float calibrationFactor(m5::unit::ads111x::Gain gain) const
    {
        return actual(gain) ? static_cast<float>(hope(gain)) / actual(gain) : 1.0f;
    }
 
    bool readCalibration();
 
protected:
    bool read_calibration(const m5::unit::ads111x::Gain gain, int16_t& hope, int16_t& actual);
 
private:
    struct Calibration {
        int16_t hope{1};
        int16_t actual{1};
    };
    std::array<Calibration, 8 /*Gain*/> _calibration{};
};
 
}  // namespace meter
}  // namespace unit
}  // namespace m5
#endif