ws2801.h

Go to the documentation of this file.

#pragma once
 
#include "pixeltypes.h"
#include "pixel_iterator.h"
#include "crgb.h"
#include "eorder.h"
// IWYU pragma: begin_keep
#include "platforms/shared/spi_pixel_writer.h"  // ok platform headers
// IWYU pragma: end_keep
#include "platforms/spi_output_template.h"
#include "fl/stl/noexcept.h"

//
// WS2801 definition - takes data/clock/select pin values (N.B. should take an SPI definition?)
//

template <int DATA_PIN, fl::u8 CLOCK_PIN, EOrder RGB_ORDER = RGB, fl::u32 SPI_SPEED = DATA_RATE_MHZ(1)>
class WS2801Controller : public CPixelLEDController<RGB_ORDER> {
    typedef fl::SPIOutput<DATA_PIN, CLOCK_PIN, SPI_SPEED> SPI;
    SPI mSPI;
    CMinWait<1000>  mWaitDelay;
 
public:
    WS2801Controller() FL_NO_EXCEPT {}
    #if defined(FL_IS_ESP32)
    CLEDController &setSpiBus(fl::Esp32SpiBus bus) FL_NO_EXCEPT override {
        mSPI.setBus(bus);
        return *this;
    }
    #endif

    virtual void init() FL_NO_EXCEPT {
        mSPI.init();
      mWaitDelay.mark();
    }
 
protected:

    virtual void showPixels(PixelController<RGB_ORDER> & pixels) FL_NO_EXCEPT {
        mWaitDelay.wait();
        fl::writePixelsToSPI<0, DATA_NOP, RGB_ORDER>(pixels, mSPI, nullptr);
        mWaitDelay.mark();
    }
 
public:
    static constexpr fl::u8 getPaddingByte() FL_NO_EXCEPT { return 0x00; }

    static fl::span<const fl::u8> getPaddingLEDFrame() FL_NO_EXCEPT {  // okay static in header
        static const fl::u8 frame[] = {  // okay static in header
            0x00,  // Red = 0
            0x00,  // Green = 0
            0x00   // Blue = 0
        };
        return fl::span<const fl::u8>(frame, 3);
    }

    static constexpr size_t getPaddingLEDFrameSize() FL_NO_EXCEPT {
        return 3;
    }

    static constexpr size_t calculateBytes(size_t num_leds) FL_NO_EXCEPT {
        // WS2801 protocol:
        // - LED data: 3 bytes per LED (RGB)
        // - No frame overhead (latch is timing-based, not data-based)
        return num_leds * 3;
    }
};

template <int DATA_PIN, fl::u8 CLOCK_PIN, EOrder RGB_ORDER = RGB, fl::u32 SPI_SPEED = DATA_RATE_MHZ(25)>
class WS2803Controller : public WS2801Controller<DATA_PIN, CLOCK_PIN, RGB_ORDER, SPI_SPEED> {};