FastLED.h File Reference

Detailed Description

central include file for FastLED, defines the CFastLED class/object

Definition in file FastLED.h.

#include <stdint.h>
#include <SmartMatrix.h>
#include <OctoWS2811.h>
#include "fl/force_inline.h"
#include "cpp_compat.h"
#include "fastled_config.h"
#include "led_sysdefs.h"
#include "fastled_delay.h"
#include "bitswap.h"
#include "controller.h"
#include "fastpin.h"
#include "fastspi_types.h"
#include "dmx.h"
#include "platforms.h"
#include "fastled_progmem.h"
#include "lib8tion.h"
#include "pixeltypes.h"
#include "hsv2rgb.h"
#include "colorutils.h"
#include "pixelset.h"
#include "colorpalettes.h"
#include "noise.h"
#include "power_mgt.h"
#include "fastspi.h"
#include "chipsets.h"
#include "fl/engine_events.h"
#include "fl/leds.h"
#include "fl/sketch_macros.h"

Include dependency graph for FastLED.h:

Go to the source code of this file.

Classes
class	APA104< DATA_PIN, RGB_ORDER >
	APA104 controller class. More...
class	APA106< DATA_PIN, RGB_ORDER >
	APA106 controller class. More...
class	CFastLED
	High level controller interface for FastLED. More...
struct	CFastLED::ClockedChipsetHelper< CHIPSET, DATA_PIN, CLOCK_PIN >
class	DMXSERIAL< RGB_ORDER >
	DMX512 based LED controller class, using the DMXSerial library. More...
class	DMXSIMPLE< DATA_PIN, RGB_ORDER >
	DMX512 based LED controller class, using the DmxSimple library. More...
class	GE8822< DATA_PIN, RGB_ORDER >
	GE8822 controller class. More...
class	GS1903< DATA_PIN, RGB_ORDER >
	GS1903 controller class. More...
class	GW6205< DATA_PIN, RGB_ORDER >
	GW6205 controller class. More...
class	GW6205_400< DATA_PIN, RGB_ORDER >
	GW6205_400 controller class. More...
class	LPD1886< DATA_PIN, RGB_ORDER >
	LPD1886 controller class. More...
class	LPD1886_8BIT< DATA_PIN, RGB_ORDER >
	LPD1886_8BIT controller class. More...
class	NEOPIXEL< DATA_PIN >
	LED controller for WS2812 LEDs with GRB color order. More...
class	PL9823< DATA_PIN, RGB_ORDER >
	PL9823 controller class. More...
class	SK6812< DATA_PIN, RGB_ORDER >
	SK6812 controller class. More...
class	SK6822< DATA_PIN, RGB_ORDER >
	SK6822 controller class. More...
class	SM16703< DATA_PIN, RGB_ORDER >
	SM16703 controller class. More...
class	TM1803< DATA_PIN, RGB_ORDER >
	TM1803 controller class. More...
class	TM1804< DATA_PIN, RGB_ORDER >
	TM1804 controller class. More...
class	TM1809< DATA_PIN, RGB_ORDER >
	TM1809 controller class. More...
class	TM1812< DATA_PIN, RGB_ORDER >
	TM1812 controller class. More...
class	TM1829< DATA_PIN, RGB_ORDER >
	TM1829 controller class. More...
class	UCS1903< DATA_PIN, RGB_ORDER >
	UCS1903 controller class. More...
class	UCS1903B< DATA_PIN, RGB_ORDER >
	UCS1903B controller class. More...
class	UCS1904< DATA_PIN, RGB_ORDER >
	UCS1904 controller class. More...
class	UCS1912< DATA_PIN, RGB_ORDER >
	UCS1912 controller class. More...
class	UCS2903< DATA_PIN, RGB_ORDER >
	UCS2903 controller class. More...
class	WS2811< DATA_PIN, RGB_ORDER >
	WS2811 controller class. More...
class	WS2811_400< DATA_PIN, RGB_ORDER >
	WS2811_400 controller class. More...
class	WS2812< DATA_PIN, RGB_ORDER >
	WS2812 controller class. More...
class	WS2812B< DATA_PIN, RGB_ORDER >
	WS2812B controller class. More...
class	WS2813< DATA_PIN, RGB_ORDER >
	WS2813 controller class. More...
class	WS2815< DATA_PIN, RGB_ORDER >
	WS2815 controller class. More...
class	WS2816< DATA_PIN, RGB_ORDER >
	WS2816 controller class. More...
class	WS2852< DATA_PIN, RGB_ORDER >
	WS2852 controller class. More...

Macros
#define	__INC_FASTSPI_LED2_H
#define	__PROG_TYPES_COMPAT__
	avr-libc define to expose progmem typedefs.
#define	FASTLED_FAKE_SPI_FORWARDS_TO_FAKE_CLOCKLESS   0
#define	FASTLED_VERSION   301001
	Current FastLED version number, as an integer.
#define	FastSPI_LED   FastLED
	Alias of the FastLED instance for legacy purposes.
#define	FastSPI_LED2   FastLED
	Alias of the FastLED instance for legacy purposes.
#define	NO_HARDWARE_PIN_SUPPORT
	If no pin/port mappings are found, sends a warning message to the user during compilation.
Adding SPI-based controllers
Add an SPI based CLEDController instance to the world. There are two ways to call this method (as well as the other addLeds() variations). The first is with 2 arguments, in which case the arguments are a pointer to led data, and the number of leds used by this controller. The second is with 3 arguments, in which case the first argument is the same, the second argument is an offset into the CRGB data where this controller's CRGB data begins, and the third argument is the number of leds for this controller object. Parameters data base pointer to an array of CRGB data structures nLedsOrOffset number of leds (3 argument version) or offset into the data array nLedsIfOffset number of leds (4 argument version) Template Parameters CHIPSET the chipset type DATA_PIN the optional data pin for the leds (if omitted, will default to the first hardware SPI MOSI pin) CLOCK_PIN the optional clock pin for the leds (if omitted, will default to the first hardware SPI clock pin) RGB_ORDER the rgb ordering for the leds (e.g. what order red, green, and blue data is written out in) SPI_DATA_RATE the data rate to drive the SPI clock at, defined using DATA_RATE_MHZ or DATA_RATE_KHZ macros Returns a reference to the added controller
#define	_FL_MAP_CLOCKED_CHIPSET(CHIPSET_ENUM, CONTROLLER_CLASS)

Typedefs
typedef uint8_t(*	power_func) (uint8_t scale, uint32_t data)
	Typedef for a power consumption calculation function.

Enumerations
enum	EBlockChipsets
	Blockless output port enum. More...
enum	ESM { SMART_MATRIX }
	Smart Matrix Library controller type. More...
enum	ESPIChipsets {   LPD6803 , LPD8806 , WS2801 , WS2803 ,   SM16716 , P9813 , APA102 , SK9822 ,   SK9822HD , DOTSTAR , DOTSTARHD , APA102HD ,   HD107 , HD107HD }
	LED chipsets with SPI interface. More...
enum	OWS2811 { OCTOWS2811 , OCTOWS2811_400 , OCTOWS2813 }
	Octo WS2811 LED Library controller types. More...
enum	SWS2812 { WS2812SERIAL }
	WS2812Serial Library controller type. More...

Functions
FASTLED_NAMESPACE_BEGIN uint16_t	cled_contoller_size ()

Variables
CFastLED	FastLED
	Global LED strip management instance.