lpd880x.h

Go to the documentation of this file.

#pragma once
 
#include "pixeltypes.h"
#include "fl/stl/compiler_control.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"
 
FL_DISABLE_WARNING_PUSH
FL_DISABLE_WARNING_DEPRECATED_REGISTER

//
// LPD8806 controller class - 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(12) >
class LPD8806Controller : public CPixelLEDController<RGB_ORDER> {
    typedef fl::SPIOutput<DATA_PIN, CLOCK_PIN, SPI_SPEED> SPI;
 
    class LPD8806_ADJUST {
    public:
        // LPD8806 spec wants the high bit of every rgb data byte sent out to be set.
        FASTLED_FORCE_INLINE static fl::u8 adjust(FASTLED_REGISTER fl::u8 data) FL_NO_EXCEPT { return ((data>>1) | 0x80) + ((data && (data<254)) & 0x01); }
        FASTLED_FORCE_INLINE static void postBlock(int len, void* context = nullptr) FL_NO_EXCEPT {
            SPI* pSPI = static_cast<SPI*>(context);
            pSPI->writeBytesValueRaw(0, ((len*3+63)>>6));
        }
 
    };
 
    SPI mSPI;
 
public:
    LPD8806Controller() 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();
    }
 
protected:

    virtual void showPixels(PixelController<RGB_ORDER> & pixels) FL_NO_EXCEPT {
        fl::writePixelsToSPI<0, LPD8806_ADJUST, RGB_ORDER>(pixels, mSPI, &mSPI);
    }
 
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
            0x80,  // Green = 0 (with MSB=1)
            0x80,  // Red = 0 (with MSB=1)
            0x80   // Blue = 0 (with MSB=1)
        };
        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 {
        // LPD8806 protocol:
        // - LED data: 3 bytes per LED (GRB with high bit set)
        // - Latch: ((num_leds * 3 + 63) / 64) bytes of 0x00
        return (num_leds * 3) + ((num_leds * 3 + 63) / 64);
    }
};

template <int DATA_PIN, fl::u8 CLOCK_PIN, EOrder RGB_ORDER = RGB, fl::u32 SPI_SPEED = DATA_RATE_MHZ(12)>
class LPD6803Controller : public CPixelLEDController<RGB_ORDER> {
    typedef fl::SPIOutput<DATA_PIN, CLOCK_PIN, SPI_SPEED> SPI;
    SPI mSPI;
 
    void startBoundary() FL_NO_EXCEPT { mSPI.writeByte(0); mSPI.writeByte(0); mSPI.writeByte(0); mSPI.writeByte(0); }
    void endBoundary(int nLeds) FL_NO_EXCEPT { int nDWords = (nLeds/32); do { mSPI.writeByte(0xFF); mSPI.writeByte(0x00); mSPI.writeByte(0x00); mSPI.writeByte(0x00); } while(nDWords--); }
 
public:
    LPD6803Controller() 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();
    }
 
protected:
    virtual void showPixels(PixelController<RGB_ORDER> & pixels) FL_NO_EXCEPT {
        mSPI.select();
 
        startBoundary();
        while(pixels.has(1)) {
            FASTLED_REGISTER fl::u16 command;
            command = 0x8000;
            command |= (pixels.loadAndScale0() & 0xF8) << 7; // red is the high 5 bits
            command |= (pixels.loadAndScale1() & 0xF8) << 2; // green is the middle 5 bits
            mSPI.writeByte((command >> 8) & 0xFF);
            command |= pixels.loadAndScale2() >> 3 ; // blue is the low 5 bits
            mSPI.writeByte(command & 0xFF);
 
            pixels.stepDithering();
            pixels.advanceData();
        }
        endBoundary(pixels.size());
        mSPI.endTransaction();
    }
 
};
 
FL_DISABLE_WARNING_POP