unit_SK6812.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2025 M5Stack Technology CO LTD
 *
 * SPDX-License-Identifier: MIT
 */
#ifndef M5_UNIT_RGB_UNIT_SK6812_HPP
#define M5_UNIT_RGB_UNIT_SK6812_HPP
 
#include "unit_LED.hpp"
 
namespace m5 {
namespace unit {
 
class UnitSK6812 : public UnitLED {
    M5_UNIT_COMPONENT_HPP_BUILDER(UnitSK6812, 0x00);
 
protected:
    UnitSK6812(const uint16_t num_of_pixels, const rgb::Order order) : UnitLED(num_of_pixels, order)
    {
    }
 
public:
    virtual ~UnitSK6812()
    {
    }
 
protected:
    virtual gpio::adapter_config_t rmt_config() override;
    // Timing in ns (rgb::timing), converted to ticks at the actual RMT resolution.
    // Same as WS2812 so SK6812 and WS2812 units can share one daisy chain
    inline virtual gpio::m5_rmt_item_t rmt_item_one() override
    {
        return rmt_item_from_ns(rgb::timing::T1H_NS, rgb::timing::T1L_NS);
    }
    inline virtual gpio::m5_rmt_item_t rmt_item_zero() override
    {
        return rmt_item_from_ns(rgb::timing::T0H_NS, rgb::timing::T0L_NS);
    }
    inline virtual gpio::m5_rmt_item_t rmt_item_reset() override
    {
        return rmt_item_low_from_ns(rgb::timing::RESET_NS);
    }
};
 
class UnitSK6812GRB : public UnitSK6812 {
    M5_UNIT_COMPONENT_HPP_BUILDER(UnitSK6812GRB, 0x00);
 
public:
    explicit UnitSK6812GRB(const uint16_t num_of_pixels) : UnitSK6812(num_of_pixels, rgb::Order::grb24)
    {
    }
    virtual ~UnitSK6812GRB()
    {
    }
};
 
class UnitSK6812GRBW : public UnitSK6812 {
    M5_UNIT_COMPONENT_HPP_BUILDER(UnitSK6812GRBW, 0x00);
 
public:
    explicit UnitSK6812GRBW(const uint16_t num_of_pixels) : UnitSK6812(num_of_pixels, rgb::Order::grbw32)
    {
    }
    virtual ~UnitSK6812GRBW()
    {
    }
};
 
}  // namespace unit
}  // namespace m5
#endif