unit_HatYun.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2026 M5Stack Technology CO LTD
 *
 * SPDX-License-Identifier: MIT
 */
#ifndef M5_UNIT_ENV_UNIT_HATYUN_HPP
#define M5_UNIT_ENV_UNIT_HATYUN_HPP
 
#include <M5UnitComponent.hpp>
#include <m5_utility/container/circular_buffer.hpp>
#include "unit_SHT20.hpp"
#include "unit_BMP280.hpp"
 
namespace m5 {
namespace unit {
 
namespace hatyun {
constexpr uint8_t NUM_LEDS{14};  
 
struct Data {
    uint16_t light{};  
};
 
}  // namespace hatyun
 
class HatYun : public Component, public PeriodicMeasurementAdapter<HatYun, hatyun::Data> {
    M5_UNIT_COMPONENT_HPP_BUILDER(HatYun, 0x38);
 
public:
    struct config_t {
        bool start_periodic{true};
        uint32_t periodic_interval{1000};
    };
 
    UnitSHT20 sht20;    
    UnitBMP280 bmp280;  
 
    explicit HatYun(const uint8_t addr = DEFAULT_ADDRESS);
    virtual ~HatYun()
    {
    }
 
    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 uint16_t light() const
    {
        return !empty() ? oldest().light : 0;
    }
 
 
    inline bool startPeriodicMeasurement(const uint32_t interval = 1000)
    {
        return PeriodicMeasurementAdapter<HatYun, hatyun::Data>::startPeriodicMeasurement(interval);
    }
    inline bool stopPeriodicMeasurement()
    {
        return PeriodicMeasurementAdapter<HatYun, hatyun::Data>::stopPeriodicMeasurement();
    }
 
 
    bool writeLED(const uint8_t num, const uint8_t r, const uint8_t g, const uint8_t b);
    bool writeAllLED(const uint8_t r, const uint8_t g, const uint8_t b);
    bool writeRainbow(const uint8_t offset = 0, const uint8_t brightness = 255);
 
 
    bool readLight(uint16_t& value);
 
protected:
    bool start_periodic_measurement(const uint32_t interval);
    bool stop_periodic_measurement();
    bool read_measurement(hatyun::Data& d);
 
    M5_UNIT_COMPONENT_PERIODIC_MEASUREMENT_ADAPTER_HPP_BUILDER(HatYun, hatyun::Data);
 
    virtual std::shared_ptr<Adapter> ensure_adapter(const uint8_t ch);
 
protected:
    std::unique_ptr<m5::container::CircularBuffer<hatyun::Data>> _data{};
    config_t _cfg{};
 
private:
    bool _valid{};  // Did the constructor correctly add the child unit?
    Component* _children[2]{&sht20, &bmp280};
};
 
namespace hatyun {
namespace command {
constexpr uint8_t LIGHT_REG{0x00};
constexpr uint8_t LED_REG{0x01};
}  // namespace command
}  // namespace hatyun
 
}  // namespace unit
}  // namespace m5
#endif