FastLED 3.9.3
Loading...
Searching...
No Matches
WS2801Controller< DATA_PIN, CLOCK_PIN, RGB_ORDER, SPI_SPEED > Class Template Reference

Detailed Description

template<uint8_t DATA_PIN, uint8_t CLOCK_PIN, EOrder RGB_ORDER = RGB, uint32_t SPI_SPEED = DATA_RATE_MHZ(1)>
class WS2801Controller< DATA_PIN, CLOCK_PIN, RGB_ORDER, SPI_SPEED >

WS2801 controller class.

Template Parameters
DATA_PINthe data pin for these LEDs
CLOCK_PINthe clock pin for these LEDs
RGB_ORDERthe RGB ordering for these LEDs
SPI_SPEEDthe clock divider used for these LEDs. Set using the DATA_RATE_MHZ / DATA_RATE_KHZ macros. Defaults to DATA_RATE_MHZ(1)

Definition at line 230 of file chipsets.h.

#include <chipsets.h>

+ Inheritance diagram for WS2801Controller< DATA_PIN, CLOCK_PIN, RGB_ORDER, SPI_SPEED >:

Public Member Functions

virtual void init ()
 Initialize the controller.
 
- Public Member Functions inherited from CPixelLEDController< RGB >
virtual void showPixels (PixelController< RGB_ORDER, 1, 0xFFFFFFFF > &pixels)=0
 Send the LED data to the strip.
 
int lanes ()
 Get the number of lanes of the Controller.
 
- Public Member Functions inherited from CLEDController
CLEDControllersetRgbw (const Rgbw &arg=RgbwDefault::value())
 
Rgbw getRgbw () const
 
 CLEDController ()
 Create an led controller object, add it to the chain of controllers.
 
virtual void clearLeds (int nLeds=-1)
 Clear out/zero out the given number of LEDs.
 
ColorAdjustment getAdjustmentData (uint8_t brightness)
 
void showInternal (const struct CRGB *data, int nLeds, uint8_t brightness)
 
void showColorInternal (const struct CRGB &data, int nLeds, uint8_t brightness)
 
void showLedsInternal (uint8_t brightness)
 Write the data to the LEDs managed by this controller.
 
void showColorInternal (const struct CRGB &data, uint8_t brightness)
 
CLEDControllernext ()
 Get the next controller in the linked list after this one.
 
CLEDControllersetLeds (CRGB *data, int nLeds)
 Set the default array of LEDs to be used by this controller.
 
void clearLedDataInternal (int nLeds=-1)
 Zero out the LED data managed by this controller.
 
virtual int size ()
 How many LEDs does this controller manage?
 
CRGBleds ()
 Pointer to the CRGB array for this controller.
 
CRGBoperator[] (int x)
 Reference to the n'th LED managed by the controller.
 
CLEDControllersetDither (uint8_t ditherMode=BINARY_DITHER)
 Set the dithering mode for this controller to use.
 
CLEDControllersetScreenMap (const XYMap &map)
 
CLEDControllersetScreenMap (const ScreenMap &map)
 
CLEDControllersetScreenMap (uint16_t width, uint16_t height)
 
uint8_t getDither ()
 Get the dithering option currently set for this controller.
 
virtual void * beginShowLeds ()
 
virtual void endShowLeds (void *data)
 
CLEDControllersetCorrection (CRGB correction)
 The color corrction to use for this controller, expressed as a CRGB object.
 
CLEDControllersetCorrection (LEDColorCorrection correction)
 The color corrction to use for this controller, expressed as a CRGB object.
 
CRGB getCorrection ()
 Get the correction value used by this controller.
 
CLEDControllersetTemperature (CRGB temperature)
 Set the color temperature, aka white point, for this controller.
 
CLEDControllersetTemperature (ColorTemperature temperature)
 Set the color temperature, aka white point, for this controller.
 
CRGB getTemperature ()
 Get the color temperature, aka whipe point, for this controller.
 
CRGB getAdjustment (uint8_t scale)
 Get the combined brightness/color adjustment for this controller.
 
virtual uint16_t getMaxRefreshRate () const
 Gets the maximum possible refresh rate of the strip.
 

Protected Member Functions

virtual void showPixels (PixelController< RGB_ORDER > &pixels)
 Send the LED data to the strip.
 
- Protected Member Functions inherited from CPixelLEDController< RGB >
virtual void showColor (const CRGB &data, int nLeds, uint8_t brightness)
 Set all the LEDs on the controller to a given color.
 
virtual void show (const struct CRGB *data, int nLeds, uint8_t brightness)
 Write the passed in RGB data out to the LEDs managed by this controller.
 

Additional Inherited Members

- Static Public Member Functions inherited from CLEDController
static CLEDControllerhead ()
 Get the first LED controller in the linked list of controllers.
 
- Public Attributes inherited from CLEDController
Rgbw mRgbMode = RgbwInvalid::value()
 
- Static Public Attributes inherited from CPixelLEDController< RGB >
static const EOrder RGB_ORDER_VALUE
 The RGB ordering for this controller.
 
static const int LANES_VALUE
 The number of lanes for this controller.
 
static const uint32_t MASK_VALUE
 The mask for the lanes for this controller.
 
- Protected Attributes inherited from CLEDController
CRGBm_Data
 pointer to the LED data used by this controller
 
CLEDControllerm_pNext
 pointer to the next LED controller in the linked list
 
CRGB m_ColorCorrection
 CRGB object representing the color correction to apply to the strip on show()
 
CRGB m_ColorTemperature
 CRGB object representing the color temperature to apply to the strip on show()
 
EDitherMode m_DitherMode
 the current dither mode of the controller
 
int m_nLeds
 the number of LEDs in the LED data array
 
- Static Protected Attributes inherited from CLEDController
static CLEDControllerm_pHead = NULL
 pointer to the first LED controller in the linked list
 
static CLEDControllerm_pTail = NULL
 pointer to the last LED controller in the linked list
 

Constructor & Destructor Documentation

◆ WS2801Controller()

template<uint8_t DATA_PIN, uint8_t CLOCK_PIN, EOrder RGB_ORDER = RGB, uint32_t SPI_SPEED = DATA_RATE_MHZ(1)>
WS2801Controller< DATA_PIN, CLOCK_PIN, RGB_ORDER, SPI_SPEED >::WS2801Controller ( )
inline

Definition at line 236 of file chipsets.h.

Member Function Documentation

◆ init()

template<uint8_t DATA_PIN, uint8_t CLOCK_PIN, EOrder RGB_ORDER = RGB, uint32_t SPI_SPEED = DATA_RATE_MHZ(1)>
virtual void WS2801Controller< DATA_PIN, CLOCK_PIN, RGB_ORDER, SPI_SPEED >::init ( )
inlinevirtual

Initialize the controller.

Implements CLEDController.

Definition at line 239 of file chipsets.h.

◆ showPixels()

template<uint8_t DATA_PIN, uint8_t CLOCK_PIN, EOrder RGB_ORDER = RGB, uint32_t SPI_SPEED = DATA_RATE_MHZ(1)>
virtual void WS2801Controller< DATA_PIN, CLOCK_PIN, RGB_ORDER, SPI_SPEED >::showPixels ( PixelController< RGB_ORDER > & pixels)
inlineprotectedvirtual

Send the LED data to the strip.

Parameters
pixelsthe PixelController object for the LED data

Definition at line 247 of file chipsets.h.


The documentation for this class was generated from the following file: