unit_SGP30.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2024 M5Stack Technology CO LTD
 *
 * SPDX-License-Identifier: MIT
 */
#ifndef M5_UNIT_TVOC_UNIT_SGP30_HPP
#define M5_UNIT_TVOC_UNIT_SGP30_HPP
 
#include <M5UnitComponent.hpp>
#include <m5_utility/container/circular_buffer.hpp>
#include <array>
 
namespace m5 {
namespace unit {
 
namespace sgp30 {
 
// Max command duration(ms)
// Max measurement duration (ms)
constexpr uint16_t IAQ_INIT_DURATION{10};
constexpr uint16_t MEASURE_IAQ_DURATION{12};
constexpr uint16_t GET_IAQ_BASELINE_DURATION{10};
constexpr uint16_t SET_IAQ_BASELINE_DURATION{10};
constexpr uint16_t SET_ABSOLUTE_HUMIDITY_DURATION{10};
constexpr uint16_t MEASURE_TEST_DURATION{220};
constexpr uint16_t GET_FEATURE_SET_DURATION{10};
constexpr uint16_t MEASURE_RAW_DURATION{25};
constexpr uint16_t GET_TVOC_INCEPTIVE_BASELINE_DURATION{10};
constexpr uint16_t SET_TVOC_INCEPTIVE_BASELINE_DURATION{10};
constexpr uint16_t GET_SERIAL_ID_DURATION{10};
 
struct Feature {
    uint8_t productType() const
    {
        return (value >> 12) & 0x0F;
    }
    uint8_t productVersion() const
    {
        return value & 0xFF;
    }
    uint16_t value{};
};
 
struct Data {
    std::array<uint8_t, 6> raw{};  
    uint16_t co2eq() const;        
    uint16_t tvoc() const;         
};
 
}  // namespace sgp30
 
class UnitSGP30 : public Component, public PeriodicMeasurementAdapter<UnitSGP30, sgp30::Data> {
    M5_UNIT_COMPONENT_HPP_BUILDER(UnitSGP30, 0x58);
 
public:
    struct config_t {
        bool start_periodic{true};
        uint16_t baseline_co2eq{};
        uint16_t baseline_tvoc{};
        uint16_t humidity{};
        uint16_t inceptive_tvoc{};
        int32_t interval{1000};
    };
 
    explicit UnitSGP30(const uint8_t addr = DEFAULT_ADDRESS)
        : Component(addr), _data{new m5::container::CircularBuffer<sgp30::Data>(1)}
    {
        auto ccfg  = component_config();
        ccfg.clock = 400 * 1000U;
        component_config(ccfg);
    }
    virtual ~UnitSGP30()
    {
    }
 
    virtual bool begin() override;
    virtual void update(const bool force = false) override;
 
 
    inline config_t config() const
    {
        return _cfg;
    }
    inline void config(const config_t& cfg)
    {
        _cfg = cfg;
    }
 
 
    inline uint8_t productVersion() const
    {
        return _version;
    }
    inline bool canMeasurePeriodic() const
    {
        return inPeriodic() && !_waiting;
    }
 
    inline uint16_t co2eq() const
    {
        return !empty() ? oldest().co2eq() : 0xFFFF;
    }
    inline uint16_t tvoc() const
    {
        return !empty() ? oldest().tvoc() : 0xFFFF;
    }
 
 
    inline bool startPeriodicMeasurement(const uint16_t co2eq, const uint16_t tvoc, const uint16_t humidity,
                                         const uint32_t interval = 1000U,
                                         const uint32_t duration = sgp30::IAQ_INIT_DURATION)
    {
        return PeriodicMeasurementAdapter<UnitSGP30, sgp30::Data>::startPeriodicMeasurement(co2eq, tvoc, humidity,
                                                                                            interval, duration);
    }
    inline bool startPeriodicMeasurement(const uint32_t interval = 1000U,
                                         const uint32_t duration = sgp30::IAQ_INIT_DURATION)
    {
        return PeriodicMeasurementAdapter<UnitSGP30, sgp30::Data>::startPeriodicMeasurement(interval, duration);
    }
    inline bool stopPeriodicMeasurement()
    {
        return PeriodicMeasurementAdapter<UnitSGP30, sgp30::Data>::stopPeriodicMeasurement();
    }
 
 
    bool readIaqBaseline(uint16_t& co2eq, uint16_t& tvoc);
    bool writeAbsoluteHumidity(const uint16_t raw, const uint32_t duration = sgp30::SET_ABSOLUTE_HUMIDITY_DURATION);
    bool writeAbsoluteHumidity(const float gm3, const uint32_t duration = sgp30::SET_ABSOLUTE_HUMIDITY_DURATION);
 
#if 0
    bool readTvocInceptiveBaseline(uint16_t& inceptive_tvoc);
    bool writeTvocInceptiveBaseline(const uint16_t inceptive_tvoc,
                                    const uint32_t duration = sgp30::SET_TVOC_INCEPTIVE_BASELINE_DURATION);
#endif
 
    bool readRaw(uint16_t& h2, uint16_t& ethanol);
 
    bool readRaw(float& h2, float& ethanol);
 
    bool measureTest(uint16_t& result);
    bool generalReset();
    bool readFeatureSet(sgp30::Feature& feature);
    bool readSerialNumber(uint64_t& number);
    bool readSerialNumber(char* number);
 
protected:
    bool start_periodic_measurement(const uint16_t co2eq, const uint16_t tvoc, const uint16_t humidity,
                                    const uint32_t interval, const uint32_t duration = sgp30::IAQ_INIT_DURATION);
    bool start_periodic_measurement(const uint32_t interval, const uint32_t duration = sgp30::IAQ_INIT_DURATION);
    bool stop_periodic_measurement();
 
    bool write_iaq_baseline(const uint16_t co2eq, const uint16_t tvoc);
    bool read_measurement(sgp30::Data& d);
 
    M5_UNIT_COMPONENT_PERIODIC_MEASUREMENT_ADAPTER_HPP_BUILDER(UnitSGP30, sgp30::Data);
 
protected:
    uint8_t _version{};  // Chip version
 
    bool _waiting{};
    types::elapsed_time_t _can_measure_time{};
    std::unique_ptr<m5::container::CircularBuffer<sgp30::Data>> _data{};
 
    config_t _cfg{};
};
 
namespace sgp30 {
namespace command {
constexpr uint16_t IAQ_INIT{0x2003};
constexpr uint16_t MEASURE_IAQ{0x2008};
constexpr uint16_t GET_IAQ_BASELINE{0x2015};
constexpr uint16_t SET_IAQ_BASELINE{0x201E};
constexpr uint16_t SET_ABSOLUTE_HUMIDITY{0x2061};
constexpr uint16_t MEASURE_TEST{0x2032};
constexpr uint16_t GET_FEATURE_SET{0x202F};
constexpr uint16_t MEASURE_RAW{0x2050};
constexpr uint16_t GET_TVOC_INCEPTIVE_BASELINE{0x20B3};
constexpr uint16_t SET_TVOC_INCEPTIVE_BASELINE{0x2077};
constexpr uint16_t GET_SERIAL_ID{0x3682};
}  // namespace command
}  // namespace sgp30
 
}  // namespace unit
}  // namespace m5
#endif