Detailed Description

template<uint8_t DATA_PIN, uint8_t 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_PIN	the data pin for these LEDs
CLOCK_PIN	the clock pin for these LEDs
RGB_ORDER	the RGB ordering for these LEDs
SPI_SPEED	the 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 445 of file chipsets.h.

#include <chipsets.h>

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

Public Member Functions
	APA102ControllerHD (const APA102ControllerHD &)=delete

Public Member Functions inherited from APA102Controller< DATA_PIN, CLOCK_PIN, RGB, DATA_RATE_MHZ(6), kFiveBitGammaCorrectionMode_BitShift, uint32_t(0x00000000), uint32_t(0x00000000)>
virtual void	init ()
	Initialize the LED controller.

Public Member Functions inherited from CPixelLEDController< RGB_ORDER, LANES, MASK >
virtual void	showPixels (PixelController< RGB_ORDER, LANES, MASK > &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
CLEDController &	setRgbw (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)
	Clear out/zero out the given number of LEDs.

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.

void	showColor (const struct CRGB &data, int nLeds, uint8_t brightness)
	Set all the LEDs to a given color.

void	showLeds (uint8_t brightness=255)
	Write the data to the LEDs managed by this controller.

void	showColor (const struct CRGB &data, uint8_t brightness=255)
	Set all the LEDs to a given color.

CLEDController *	next ()
	Get the next controller in the linked list after this one.

CLEDController &	setLeds (CRGB *data, int nLeds)
	Set the default array of LEDs to be used by this controller.

void	clearLedData ()
	Zero out the LED data managed by this controller.

virtual int	size ()
	How many LEDs does this controller manage?

CRGB *	leds ()
	Pointer to the CRGB array for this controller.

CRGB &	operator[] (int x)
	Reference to the n'th LED managed by the controller.

CLEDController &	setDither (uint8_t ditherMode=BINARY_DITHER)
	Set the dithering mode for this controller to use.

uint8_t	getDither ()
	Get the dithering option currently set for this controller.

virtual void *	beginShowLeds ()

virtual void	endShowLeds (void *data)

CLEDController &	setCorrection (CRGB correction)
	The color corrction to use for this controller, expressed as a CRGB object.

CLEDController &	setCorrection (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.

CLEDController &	setTemperature (CRGB temperature)
	Set the color temperature, aka white point, for this controller.

CLEDController &	setTemperature (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.

Additional Inherited Members
Static Public Member Functions inherited from CLEDController
static CLEDController *	head ()
	Get the first LED controller in the linked list of controllers.

static CRGB	computeAdjustment (uint8_t scale, const CRGB &colorCorrection, const CRGB &colorTemperature)
	Calculates the combined color adjustment to the LEDs at a given scale, color correction, and color temperature.

Public Attributes inherited from CLEDController
Rgbw	mRgbMode = RgbwInvalid::value()

Static Public Attributes inherited from CPixelLEDController< RGB_ORDER, LANES, MASK >
static const EOrder	RGB_ORDER_VALUE = RGB_ORDER
	The RGB ordering for this controller.

static const int	LANES_VALUE = LANES
	The number of lanes for this controller.

static const uint32_t	MASK_VALUE = MASK
	The mask for the lanes for this controller.

Protected Member Functions inherited from APA102Controller< DATA_PIN, CLOCK_PIN, RGB, DATA_RATE_MHZ(6), kFiveBitGammaCorrectionMode_BitShift, uint32_t(0x00000000), uint32_t(0x00000000)>
virtual void	showPixels (PixelController< RGB_ORDER > &pixels)
	Send the LED data to the strip.

Protected Member Functions inherited from CPixelLEDController< RGB_ORDER, LANES, MASK >
virtual void	showColor (const struct CRGB &data, int nLeds, CRGB scale_pre_mixed)
	Set all the LEDs on the controller to a given color.

virtual void	show (const struct CRGB *data, int nLeds, CRGB scale_pre_mixed)
	Write the passed in RGB data out to the LEDs managed by this controller.

Protected Attributes inherited from CLEDController
CRGB *	m_Data
	pointer to the LED data used by this controller

CLEDController *	m_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 CLEDController *	m_pHead = NULL
	pointer to the first LED controller in the linked list

static CLEDController *	m_pTail = NULL
	pointer to the last LED controller in the linked list

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

/home/runner/work/FastLED/FastLED/src/chipsets.h

Detailed Description

Public Member Functions

Additional Inherited Members