Skip to content

The FastLED library for colored LED animation on Arduino. Please direct questions/requests for help to the FastLED Reddit community: http://fastled.io/r We'd like to use github "issues" just for tracking library bugs / enhancements.

License

Notifications You must be signed in to change notification settings

FastLED/FastLED

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FastLED Library

arduino-library-badge build status unit tests Arduino Library Lint Documentation Reddit

A robust and massively parallel-led driver for Arduino/Esp32/RaspberryPi/Atmega/Teensy and more. Also runs on dirt cheap sub $1 devices. Drives 10's-of-thousands of LEDS on Teensy and ESP32. Supports nearly every single LED chipset in existence. Background rendering (ESP32/Teensy/RaspberriPi) means you can respond to user input while the leds render.

Star History Chart

About

This is a driver library for easily & efficiently controlling a wide variety of LED chipsets, like the ones sold by Adafruit (NeoPixel, DotStar, LPD8806), Sparkfun (WS2801), and AliExpress.

The 3.9.x series introduced:

  • Massive parallel rendering to drive thousands of LEDs.
  • Background rendering of LEDs so that your program/sketch can prepare the next frame and respond to user input without affect frame rate.

In addition to writing to the LEDs, this library also includes a number of functions for high-performing 8-bit math for manipulating your RGB values, as well as low level classes for abstracting out access to pins and SPI hardware, while still keeping things as fast as possible.

We have multiple goals with this library:

  • Quick start for new developers - hook up your LEDs and go, no need to think about specifics of the LED chipsets being used
  • Zero pain switching LED chipsets - you get some new LEDs that the library supports, just change the definition of LEDs you're using, et. voila! Your code is running with the new LEDs.
  • High performance - with features like zero cost global brightness scaling, high performance 8-bit math for RGB manipulation, and some of the fastest bit-bang'd SPI support around, FastLED wants to keep as many CPU cycles available for your LED patterns as possible

Example

This is an Arduino Sketch that will run on Arduino Uno/Esp32/Raspberri Pi

// New feature! Overclocking WS2812
// #define FASTLED_OVERCLOCK 1.2 // 20% overclock ~ 960 khz.
#include <FastLED.h>
#define NUM_LEDS 60
#define DATA_PIN 6
CRGB leds[NUM_LEDS];
void setup() { FastLED.addLeds<NEOPIXEL, DATA_PIN>(leds, NUM_LEDS); }
void loop() {
	leds[0] = CRGB::White; FastLED.show(); delay(30);
	leds[0] = CRGB::Black; FastLED.show(); delay(30);
}

For more examples see this link. Web compiled examples.

Supported Platforms

Arduino

uno

attiny13 needs pin definitions for this board

attiny85

attiny88

attiny1604

attiny1616

attiny4313 needs pin definitions for this board

yun

digix

uno_r4_wifi

nano_every

Arduino Giga-R1 Multiple issues with this board. Pins aren't defined, F_CPU is not defined nor is it constant. And lots of other issues. Help wanted!

Teensy

teensy30

teensy31

teensyLC

teensy40

teensy41

Specific Features

teensy_octoWS2811

teensy41 ObjectFLED

NRF

nrf52840_sense

nordicnrf52_dk

adafruit_xiaoblesense

nrf52_xiaoblesense (This board has mbed engine but doesn't compile against Arduino.h right now for some unknown reason.)

STM

bluepill

maple_mini

stm103tb (PlatformIO doesn't support this board yet and we don't know what the build info is to support this is yet)

Raspberry Pi

rp2040

rp2350

Esp

esp32-8266

esp32dev

esp32wroom

esp32c2 Now supported as of FastLED 3.9.10!

esp32c3

esp32s3

esp32c6

esp32h2

Specific features

esp32_i2s_ws2812

esp32 extra libs

Espressif's current evaluation of FastLED's compatibility with their product sheet can be found here

x86

linux_native

Wasm

wasm

wasm_compile_test

Compiled Library Size Check

attiny85_binary_size

uno_binary_size

esp32dev_binary_size

teensy41_binary_size

Install

Arduino IDE

After the ArduinoIDE is installed then add the library to your IDE

image

image

PlatformIO

Follow our guide here. Our template will allow your project to be compiled by both PlatformIO and ArduinoIDE

https://github.com/FastLED/PlatformIO-Starter

New Feature Announcements

New in 3.9.10: Super Stable WS2812 SPI driver for ESP32

image (2)

New in 3.9.9: 16-way Yves I2S parallel driver for the ESP32-S3

perpetualmaniac_an_led_display_in_a_room_lots_of_refaction_of_t_eb7c170a-7b2c-404a-b114-d33794b4954b

New in 3.9.8 - Massive Teensy 4.1 & 4.0 LED output

New Project

New in 3.9.2 - Overclocking of WS2812

image Update: max overclock has been reported at +70%: https://www.reddit.com/r/FastLED/comments/1gkcb6m/fastled_FASTLED_OVERCLOCK_17/

Development

clone and compile

Zero pain setup and install/test/run. Can be done from the command line in seconds if uv or python are installed. See our contributing guide guide for more information.

image

When changes are made then push to your fork to your repo and git will give you a url to trigger a pull request into the master repo.

Testing other devices

  • run compile and then select your board
Available boards:
[0]: ATtiny1616
[1]: adafruit_feather_nrf52840_sense
[2]: attiny85
[3]: bluepill
[4]: digix
[5]: esp01
[6]: esp32c2
[7]: esp32c3
[8]: esp32c6
[9]: esp32s3
[10]: esp32dev
[11]: esp32dev_i2s
[12]: esp32dev_idf44
[13]: esp32rmt_51
[14]: nano_every
[15]: rpipico
[16]: rpipico2
[17]: teensy30
[18]: teensy41
[19]: uno
[20]: uno_r4_wifi
[21]: xiaoblesense_adafruit
[22]: yun
[all]: All boards
Enter the number of the board you want to use: 0

Help and Support

If you need help with using the library, please consider visiting the Reddit community at https://reddit.com/r/FastLED. There are thousands of knowledgeable FastLED users in that group and a plethora of solutions in the post history.

If you are looking for documentation on how something in the library works, please see the Doxygen documentation online at http://fastled.io/docs.

If you run into bugs with the library, or if you'd like to request support for a particular platform or LED chipset, please submit an issue at http://fastled.io/issues.

Supported LED Chipsets

Here's a list of all the LED chipsets are supported. More details on the LED chipsets are included on our wiki page

  • WS281x Clockless family
    • WS2811 (Old style 400khz & 800khz)
    • WS2812 (NeoPixel)
    • WS2812-V5B (250 uS reset)
    • WS2815
  • APA102 / SK9822 / HD107s (turbo->40mhz) / Adafruit DotStars (SPI)
  • HD107s, same thing as the APA102, but runs at turbo 40 Mhz
  • SmartMatrix panels - needs the SmartMatrix library (https://github.com/pixelmatix/SmartMatrix)
  • TM1809/4 - 3 wire chipset, cheaply available on aliexpress.com
  • TM1803 - 3 wire chipset, sold by RadioShack
  • UCS1903 - another 3-wire LED chipset, cheap
  • GW6205 - another 3-wire LED chipset
  • LPD8806 - SPI-based chipset, very high speed
  • WS2801 - SPI-based chipset, cheap and widely available
  • SM16716 - SPI-based chipset
  • APA102 - SPI-based chipset
    • APA102HD - Same as APA102 but with a high-definition gamma correction function applied at the driver level.
  • P9813 - aka Cool Neon's Total Control Lighting
  • DMX - send rgb data out over DMX using Arduino DMX libraries
  • LPD6803 - SPI-based chipset, chip CMODE pin must be set to 1 (inside oscillator mode)

APA102 and the 'High Definition' Mode in FastLED

FastLED features driver-level gamma correction for the APA102 and SK9822 chipsets, using our "pseudo-13-bit mixing" algorithm.

Read about it here: https://github.com/FastLED/FastLED/blob/master/APA102.md

Enable it like by using the APA102HD type. Example:

#define LED_TYPE APA102HD  // "HD" suffix for APA102 family enables hardware gamma correction
void setup() {
  FastLED.addLeds<LED_TYPE, DATA_PIN, CLOCK_PIN, RGB>(leds_hd, NUM_LEDS);
}

image

Check out thr rust port of this algorithm:

smart-leds-rs/apa102-spi-rs#15

Getting Started

Arduino IDE / PlatformIO Dual Repo

We've created a custom repo you can try to start your projects. This repo is designed to be used with VSCode + PlatformIO but is also backwards compatible with the Arduino IDE.

PlatformIO is an extension to VSCode and is generally viewed as a much better experience than the Arduino IDE. You get auto completion tools like intellisense and CoPilot and the ability to install tools like crash decoding. Anything you can do in Arduino IDE you can do with PlatformIO.

Get started here:

https://github.com/FastLED/PlatformIO-Starter

ArduinoIDE

When running the Arduino IDE you need to do the additional installation step of installing FastLED in the global Arduino IDE package manager.

Install the library using either the .zip file from the latest release or by searching for "FastLED" in the libraries manager of the Arduino IDE. See the Arduino documentation on how to install libraries for more information.

Porting FastLED to a new platform

Information on porting FastLED can be found in the file PORTING.md.

What about that name?

Wait, what happened to FastSPI_LED and FastSPI_LED2? The library was initially named FastSPI_LED because it was focused on very fast and efficient SPI access. However, since then, the library has expanded to support a number of LED chipsets that don't use SPI, as well as a number of math and utility functions for LED processing across the board. We decided that the name FastLED more accurately represents the totality of what the library provides, everything fast, for LEDs.

For more information

Check out the official site http://fastled.io for links to documentation, issues, and news.

Daniel Garcia, Founder of FastLED

In Memory of Daniel Garcia Daniel Garcia, the brilliant founder of FastLED, tragically passed away in September 2019 in the Conception dive boat fire alongside his partner, Yulia. This heartbreaking loss was felt deeply by the maker and developer community, where Daniel's contributions had left an indelible mark.

Daniel was more than just a talented programmer; he was a passionate innovator who transformed the way creators interacted with LED technology. His work on FastLED brought high-performance LED control to countless projects, empowering developers to craft breathtaking installations.

In his personal life, Daniel was known for his kindness and creativity. His pride in FastLED and the vibrant community it fostered was a testament to his dedication to open-source development and his commitment to helping others bring light into the world.

While Daniel is no longer with us, his legacy continues through the FastLED library and the countless makers who use it. The community he built serves as a living tribute to his ingenuity, generosity, and the joy he found in sharing his work with the world.

About the Current Contributor

Zach Vorhies, the current main contributor to FastLED, briefly worked with Dan in 2011 in San Francisco and was an avid user of the FastLED library for over 13 years. After Daniel Garcia’s untimely passing, Zach stepped up to ensure FastLED’s continued growth and development.

Zach has this to say about FastLED:

"The true power of FastLED lies in its ability to transform programmers into LED artists. Free space becomes their canvas. Its impact on ai-humanity will transcend that of your own. To contribute to FastLED is to leave behind a piece of something immortal."

Contributing

See our easy to use guide here:

https://github.com/FastLED/FastLED/blob/master/CONTRIBUTING.md

Reminder

More stars for this repo equals more features for you. It's simple, go to the top of the page and click the ⭐and watch buttons.

About

The FastLED library for colored LED animation on Arduino. Please direct questions/requests for help to the FastLED Reddit community: http://fastled.io/r We'd like to use github "issues" just for tracking library bugs / enhancements.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published
  NODES
Bugs 4
COMMUNITY 8
Note 2
Project 10
todo 2
USERS 2