unit_AW3641E.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2026 M5Stack Technology CO LTD
 *
 * SPDX-License-Identifier: MIT
 */
#ifndef M5_UNIT_FLASHLIGHT_UNIT_AW3641E_HPP
#define M5_UNIT_FLASHLIGHT_UNIT_AW3641E_HPP
 
#include <M5UnitComponent.hpp>
 
namespace m5 {
namespace unit {
 
namespace aw3641e {
 
enum class SwitchPosition : uint8_t {
    Flash,  
    Torch,  
};
 
enum class Brightness : uint8_t {
    Pct100,  
    Pct90,   
    Pct80,   
    Pct70,   
    Pct60,   
    Pct50,   
    Pct40,   
    Pct30,   
};
 
constexpr uint32_t PULSE_HIGH_US{4};
constexpr uint32_t PULSE_LOW_US{4};
constexpr uint32_t PULSE_OFF_US{600};
 
constexpr uint16_t FLASH_MAX_DURATION_MS{220};
 
constexpr uint32_t TORCH_DEFAULT_DURATION_MS{1300};
[[deprecated("Use TORCH_DEFAULT_DURATION_MS instead")]] constexpr uint16_t TORCH_MAX_DURATION_MS{1300};
 
constexpr uint8_t to_pulse_count(const Brightness b)
{
    return static_cast<uint8_t>(static_cast<uint8_t>(b) + 1u);
}
 
}  // namespace aw3641e
 
class UnitAW3641E : public Component {
    M5_UNIT_COMPONENT_HPP_BUILDER(UnitAW3641E, 0x00);
 
public:
    struct config_t {
        aw3641e::SwitchPosition switch_position{aw3641e::SwitchPosition::Flash};
    };
 
    explicit UnitAW3641E(const uint8_t addr = DEFAULT_ADDRESS) : Component(addr)
    {
    }
    virtual ~UnitAW3641E()
    {
    }
 
    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;
    }
 
 
    bool stop();
 
    bool flash(const aw3641e::Brightness brightness = aw3641e::Brightness::Pct100,
               const uint16_t duration_ms           = aw3641e::FLASH_MAX_DURATION_MS);
 
    bool torch(const uint32_t duration_ms = aw3641e::TORCH_DEFAULT_DURATION_MS);
 
    bool torchOn();
 
    inline uint32_t lastDurationMs() const
    {
        return _duration_ms;
    }
    inline bool active() const
    {
        return _active;
    }
 
protected:
    // @brief Send a 1-wire EN pulse train of the given count (1..8 for Brightness Pct100..Pct30)
    // @param pulse_count Number of rising edges (1..8). Final state is EN = HIGH.
    // @return True if the GPIO writes succeeded.
    bool send_pulse_train(const uint8_t pulse_count);
    // Cancel any in-flight operation (EN LOW for T_OFF), then drive EN HIGH in Torch mode.
    bool start_torch();
 
protected:
    config_t _cfg{};
    // Flash/torch timing tracker for non-blocking auto-shutdown in update().
    bool _active{false};
    bool _continuous{false};  // torchOn(): update() does not turn the LED off
    types::elapsed_time_t _start_ms{0};
    uint32_t _duration_ms{0};
};
 
}  // namespace unit
}  // namespace m5
 
#endif