Ws2812Handler.h

Go to the documentation of this file.

 
#ifndef COMPONENT_HANDLER_WS2812_HANDLER_H_
#define COMPONENT_HANDLER_WS2812_HANDLER_H_
 
#include <cstdint>
#include <memory>
#include <type_traits>
#include <utility>
#include "core/hf-core-drivers/external/hf-ws2812-rmt-driver/inc/ws2812_cpp.hpp"
#include "core/hf-core-drivers/external/hf-ws2812-rmt-driver/inc/ws2812_effects.hpp"
#include "RtosMutex.h"
 
#if defined(ESP_PLATFORM)
#include "driver/gpio.h"
#else
using gpio_num_t = int;
#endif
 
 
class Ws2812Handler {
public:
    struct Config {
        gpio_num_t gpio_pin{};                
        uint32_t num_leds{1};                 
        LedType led_type{LedType::RGB};
        uint8_t brightness{255};              
        int rmt_channel{0};                   
        uint16_t t0h{400};                    
        uint16_t t1h{800};                    
        uint16_t t0l{850};                    
        uint16_t t1l{450};                    
    };
 
    //=========================================================================
    // Construction
    //=========================================================================
 
    explicit Ws2812Handler(const Config& config) noexcept;
 
    ~Ws2812Handler() noexcept;
 
    // Non-copyable
    Ws2812Handler(const Ws2812Handler&) = delete;
    Ws2812Handler& operator=(const Ws2812Handler&) = delete;
 
    // Non-movable
    Ws2812Handler(Ws2812Handler&&) = delete;
    Ws2812Handler& operator=(Ws2812Handler&&) = delete;
 
    //=========================================================================
    // Initialization
    //=========================================================================
 
    esp_err_t Initialize() noexcept;
 
    bool EnsureInitialized() noexcept;
 
    bool Deinitialize() noexcept;
 
    [[nodiscard]] bool IsInitialized() const noexcept { return initialized_; }
 
    //=========================================================================
    // Direct Access
    //=========================================================================
 
    [[nodiscard]] uint32_t GetNumLeds() const noexcept { return config_.num_leds; }
 
    [[nodiscard]] WS2812Strip* GetStrip() noexcept;
    [[nodiscard]] const WS2812Strip* GetStrip() const noexcept;
 
    [[nodiscard]] WS2812Strip* GetDriver() noexcept;
    [[nodiscard]] const WS2812Strip* GetDriver() const noexcept;
 
    [[nodiscard]] WS2812Animator* GetAnimator() noexcept;
    [[nodiscard]] const WS2812Animator* GetAnimator() const noexcept;
 
    template <typename Fn>
    auto visitDriver(Fn&& fn) noexcept -> decltype(fn(std::declval<WS2812Strip&>())) {
        using ReturnType = decltype(fn(std::declval<WS2812Strip&>()));
        MutexLockGuard lock(mutex_);
        if (!EnsureInitializedLocked() || !strip_) {
            if constexpr (std::is_void_v<ReturnType>) {
                return;
            } else {
                return ReturnType{};
            }
        }
        return fn(*strip_);
    }
 
    template <typename Fn>
    auto visitAnimator(Fn&& fn) noexcept -> decltype(fn(std::declval<WS2812Animator&>())) {
        using ReturnType = decltype(fn(std::declval<WS2812Animator&>()));
        MutexLockGuard lock(mutex_);
        if (!EnsureInitializedLocked() || !animator_) {
            if constexpr (std::is_void_v<ReturnType>) {
                return;
            } else {
                return ReturnType{};
            }
        }
        return fn(*animator_);
    }
 
    void DumpDiagnostics() noexcept;
 
    const char* GetDescription() const noexcept;
 
    static Config GetDefaultConfig() noexcept { return Config{}; }
 
private:
    bool EnsureInitializedLocked() noexcept;
 
    Config config_;
    bool initialized_{false};
    mutable RtosMutex mutex_;
    std::unique_ptr<WS2812Strip> strip_;
    std::unique_ptr<WS2812Animator> animator_;
    char description_[64]{};   
};
 
 
#endif // COMPONENT_HANDLER_WS2812_HANDLER_H_