unit_SCD41.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2024 M5Stack Technology CO LTD
 *
 * SPDX-License-Identifier: MIT
 */
#ifndef M5_UNIT_ENV_UNIT_SCD41_HPP
#define M5_UNIT_ENV_UNIT_SCD41_HPP
 
#include "unit_SCD40.hpp"
 
namespace m5 {
namespace unit {
namespace scd41 {
// Max command duration(ms)
// For SCD40/41
constexpr uint32_t POWER_DOWN_DURATION{1};
constexpr uint32_t GET_AUTOMATIC_SELF_CALIBRATION_INITIAL_PERIOD_DURATION{1};
constexpr uint32_t SET_AUTOMATIC_SELF_CALIBRATION_INITIAL_PERIOD_DURATION{1};
constexpr uint32_t GET_AUTOMATIC_SELF_CALIBRATION_STANDARD_PERIOD_DURATION{1};
constexpr uint32_t SET_AUTOMATIC_SELF_CALIBRATION_STANDARD_PERIOD_DURATION{1};
 
}  // namespace scd41
 
class UnitSCD41 : public UnitSCD40 {
    M5_UNIT_COMPONENT_HPP_BUILDER(UnitSCD41, 0x62);
 
public:
    explicit UnitSCD41(const uint8_t addr = DEFAULT_ADDRESS) : UnitSCD40(addr)
    {
        auto ccfg  = component_config();
        ccfg.clock = 400 * 1000U;
        component_config(ccfg);
    }
    virtual ~UnitSCD41()
    {
    }
 
 
    bool measureSingleshot(scd4x::Data& d);
    bool measureSingleshotRHT(scd4x::Data& d);
 
 
    bool powerDown(const uint32_t duration = scd41::POWER_DOWN_DURATION);
    bool wakeup();
 
 
    bool writeAutomaticSelfCalibrationInitialPeriod(
        const uint16_t hours, const uint32_t duration = scd41::SET_AUTOMATIC_SELF_CALIBRATION_INITIAL_PERIOD_DURATION);
    bool readAutomaticSelfCalibrationInitialPeriod(uint16_t& hours);
    bool writeAutomaticSelfCalibrationStandardPeriod(
        const uint16_t hours, const uint32_t duration = scd41::SET_AUTOMATIC_SELF_CALIBRATION_STANDARD_PERIOD_DURATION);
    bool readAutomaticSelfCalibrationStandardPeriod(uint16_t& hours);
 
protected:
    virtual bool is_valid_chip() override;
};
 
namespace scd41 {
namespace command {
// Low power single shot - SCD41 only
constexpr uint16_t MEASURE_SINGLE_SHOT{0x219d};
constexpr uint16_t MEASURE_SINGLE_SHOT_RHT_ONLY{0x2196};
constexpr uint16_t POWER_DOWN{0x36e0};
constexpr uint16_t WAKE_UP{0x36f6};
constexpr uint16_t SET_AUTOMATIC_SELF_CALIBRATION_INITIAL_PERIOD{0x2445};
constexpr uint16_t GET_AUTOMATIC_SELF_CALIBRATION_INITIAL_PERIOD{0x2340};
constexpr uint16_t SET_AUTOMATIC_SELF_CALIBRATION_STANDARD_PERIOD{0x244e};
constexpr uint16_t GET_AUTOMATIC_SELF_CALIBRATION_STANDARD_PERIOD{0x234b};
 
}  // namespace command
}  // namespace scd41
 
}  // namespace unit
}  // namespace m5
#endif