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

Detailed Description

template<fl::u8 DATA_PIN, fl::u8 CLOCK_PIN, EOrder RGB_ORDER = RGB, uint32_t SPI_SPEED = DATA_RATE_MHZ(6)>
class APA102ControllerHD< DATA_PIN, CLOCK_PIN, RGB_ORDER, SPI_SPEED >

APA102 high definition 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(24)

Definition at line 563 of file chipsets.h.

#include <chipsets.h>

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

Public Member Functions

 APA102ControllerHD ()=default
 
 APA102ControllerHD (const APA102ControllerHD &)=delete
 
- Public Member Functions inherited from APA102Controller< DATA_PIN, CLOCK_PIN, RGB, DATA_RATE_MHZ(6), fl::kFiveBitGammaCorrectionMode_BitShift, uint32_t(0x00000000), uint32_t(0x00000000)>
 APA102Controller ()
 
virtual void init () override
 Initialize the LED controller.
 
- Public Member Functions inherited from CPixelLEDController< RGB_ORDER, LANES, MASK >
 CPixelLEDController ()
 
int lanes () override
 Get the number of lanes of the Controller.
 
virtual void showPixels (PixelController< RGB_ORDER, LANES, MASK > &pixels)=0
 Send the LED data to the strip.
 
- Public Member Functions inherited from CLEDController
 CLEDController ()
 Create an led controller object, add it to the chain of controllers.
 
VIRTUAL_IF_NOT_AVR ~CLEDController ()
 
virtual void * beginShowLeds (int size)
 
void clearLedDataInternal (int nLeds=-1)
 Zero out the LED data managed by this controller.
 
VIRTUAL_IF_NOT_AVR void clearLeds (int nLeds=-1)
 Clear out/zero out the given number of LEDs.
 
virtual void endShowLeds (void *data)
 
CRGB getAdjustment (fl::u8 scale)
 Get the combined brightness/color adjustment for this controller.
 
ColorAdjustment getAdjustmentData (fl::u8 brightness)
 
CRGB getCorrection ()
 Get the correction value used by this controller.
 
fl::u8 getDither ()
 Get the dithering option currently set for this controller.
 
bool getEnabled ()
 
virtual fl::u16 getMaxRefreshRate () const
 Gets the maximum possible refresh rate of the strip.
 
Rgbw getRgbw () const
 
CRGB getTemperature ()
 Get the color temperature, aka white point, for this controller.
 
CRGBleds ()
 Pointer to the CRGB array for this controller.
 
CLEDControllernext ()
 Get the next controller in the linked list after this one.
 
CRGBoperator[] (int x)
 Reference to the n'th LED managed by the controller.
 
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.
 
CLEDControllersetDither (fl::u8 ditherMode=BINARY_DITHER)
 Set the dithering mode for this controller to use.
 
void setEnabled (bool enabled)
 
CLEDControllersetLeds (CRGB *data, int nLeds)
 Set the default array of LEDs to be used by this controller.
 
CLEDControllersetRgbw (const Rgbw &arg=RgbwDefault::value())
 
CLEDControllersetScreenMap (const fl::ScreenMap &map)
 
CLEDControllersetScreenMap (const fl::XYMap &map, float diameter=-1.f)
 
CLEDControllersetScreenMap (fl::u16 width, fl::u16 height, float diameter=-1.f)
 
CLEDControllersetTemperature (ColorTemperature temperature)
 Set the color temperature, aka white point, for this controller.
 
CLEDControllersetTemperature (CRGB temperature)
 Set the color temperature, aka white point, for this controller.
 
void showColorInternal (const struct CRGB &data, fl::u8 brightness)
 
void showColorInternal (const struct CRGB &data, int nLeds, fl::u8 brightness)
 
void showInternal (const struct CRGB *data, int nLeds, fl::u8 brightness)
 
VIRTUAL_IF_NOT_AVR void showLeds (fl::u8 brightness)
 
void showLedsInternal (fl::u8 brightness)
 Write the data to the LEDs managed by this controller.
 
virtual int size ()
 How many LEDs does this controller manage?
 

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_ORDER, LANES, MASK >
static const int LANES_VALUE = LANES
 The number of lanes for this controller.
 
static const fl::u32 MASK_VALUE = MASK
 The mask for the lanes for this controller.
 
static const EOrder RGB_ORDER_VALUE = RGB_ORDER
 The RGB ordering for this controller.
 
- Protected Member Functions inherited from APA102Controller< DATA_PIN, CLOCK_PIN, RGB, DATA_RATE_MHZ(6), fl::kFiveBitGammaCorrectionMode_BitShift, uint32_t(0x00000000), uint32_t(0x00000000)>
virtual void showPixels (PixelController< RGB_ORDER > &pixels) override
 Send the LED data to the strip.
 
- Protected Member Functions inherited from CPixelLEDController< RGB_ORDER, LANES, MASK >
virtual void show (const struct CRGB *data, int nLeds, fl::u8 brightness) override
 Write the passed in RGB data out to the LEDs managed by this controller.
 
virtual void showColor (const CRGB &data, int nLeds, fl::u8 brightness) override
 Set all the LEDs on the controller to a given color.
 
- Protected Attributes inherited from CLEDController
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()
 
CRGBm_Data
 pointer to the LED data used by this controller
 
EDitherMode m_DitherMode
 the current dither mode of the controller
 
bool m_enabled = true
 
int m_nLeds
 the number of LEDs in the LED data array
 
CLEDControllerm_pNext
 pointer to the next LED controller in the linked list
 
- 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
 

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