C++ C Objective-C
Clone or download

README.md

WS2812FX library

WS2812FX - More Blinken for your LEDs!

This library features a variety of blinken effects for the WS2811/WS2812/NeoPixel LEDs. It is meant to be a drop-in replacement for the Adafruit NeoPixel library with additional features.

Features

  • 53 different effects. And counting.
  • Tested on Arduino Nano, Uno, Micro and ESP8266.
  • All effects with printable names - easy to use in user interfaces.
  • FX, speed and brightness controllable on the fly.
  • Ready for sound-to-light (see external trigger example)

Download, Install and Example

You can search for WS2812FX in the Arduino IDE Library Manager or install the latest (or development) version manually:

  • Install the famous Adafruit NeoPixel library (v1.1.4 or newer)
  • Download this repository.
  • Extract to your Arduino libraries directory.
  • Open Arduino IDE.
  • Now you can choose File > Examples > WS2812FX > ...

See examples for basic usage.

In it's most simple form, here's the code to get you started!

#include <WS2812FX.h>

#define LED_COUNT 30
#define LED_PIN 12

WS2812FX ws2812fx = WS2812FX(LED_COUNT, LED_PIN, NEO_GRB + NEO_KHZ800);

void setup() {
  ws2812fx.init();
  ws2812fx.setBrightness(100);
  ws2812fx.setSpeed(200);
  ws2812fx.setMode(FX_MODE_RAINBOW_CYCLE);
  ws2812fx.start();
}

void loop() {
  ws2812fx.service();
}

More complex effects can be created by dividing your string of LEDs into segments (up to ten) and programming each segment independently. Use the setSegment() function to program each segment's mode, color, speed and direction (normal or reverse):

  • setSegment(segment index, start LED, stop LED, mode, color, speed, reverse);

Note, some effects make use of more then one color (up to three) and are programmed by specifying an array of colors:

  • setSegment(segment index, start LED, stop LED, mode, colors[], speed, reverse);
// divide the string of LEDs into two independent segments
uint32_t colors[] = {RED, GREEN};
ws2812fx.setSegment(0, 0,           (LED_COUNT/2)-1, FX_MODE_BLINK, colors, 1000, false);
ws2812fx.setSegment(1, LED_COUNT/2, LED_COUNT-1,     FX_MODE_BLINK, (const uint32_t[]) {ORANGE, PURPLE}, 1000, false);

Effects

  1. Static - No blinking. Just plain old static light.
  2. Blink - Normal blinking. 50% on/off time.
  3. Breath - Does the "standby-breathing" of well known i-Devices. Fixed Speed.
  4. Color Wipe - Lights all LEDs after each other up. Then turns them in that order off. Repeat.
  5. Color Wipe Inverse - Same as Color Wipe, except swaps on/off colors.
  6. Color Wipe Reverse - Lights all LEDs after each other up. Then turns them in reverse order off. Repeat.
  7. Color Wipe Reverse Inverse - Same as Color Wipe Reverse, except swaps on/off colors.
  8. Color Wipe Random - Turns all LEDs after each other to a random color. Then starts over with another color.
  9. Random Color - Lights all LEDs in one random color up. Then switches them to the next random color.
  10. Single Dynamic - Lights every LED in a random color. Changes one random LED after the other to a random color.
  11. Multi Dynamic - Lights every LED in a random color. Changes all LED at the same time to new random colors.
  12. Rainbow - Cycles all LEDs at once through a rainbow.
  13. Rainbow Cycle - Cycles a rainbow over the entire string of LEDs.
  14. Scan - Runs a single pixel back and forth.
  15. Dual Scan - Runs two pixel back and forth in opposite directions.
  16. Fade - Fades the LEDs on and (almost) off again.
  17. Theater Chase - Theatre-style crawling lights. Inspired by the Adafruit examples.
  18. Theater Chase Rainbow - Theatre-style crawling lights with rainbow effect. Inspired by the Adafruit examples.
  19. Running Lights - Running lights effect with smooth sine transition.
  20. Twinkle - Blink several LEDs on, reset, repeat.
  21. Twinkle Random - Blink several LEDs in random colors on, reset, repeat.
  22. Twinkle Fade - Blink several LEDs on, fading out.
  23. Twinkle Fade Random - Blink several LEDs in random colors on, fading out.
  24. Sparkle - Blinks one LED at a time.
  25. Flash Sparkle - Lights all LEDs in the selected color. Flashes single white pixels randomly.
  26. Hyper Sparkle - Like flash sparkle. With more flash.
  27. Strobe - Classic Strobe effect.
  28. Strobe Rainbow - Classic Strobe effect. Cycling through the rainbow.
  29. Multi Strobe - Strobe effect with different strobe count and pause, controlled by speed setting.
  30. Blink Rainbow - Classic Blink effect. Cycling through the rainbow.
  31. Chase White - Color running on white.
  32. Chase Color - White running on color.
  33. Chase Random - White running followed by random color.
  34. Chase Rainbow - White running on rainbow.
  35. Chase Flash - White flashes running on color.
  36. Chase Flash Random - White flashes running, followed by random color.
  37. Chase Rainbow White - Rainbow running on white.
  38. Chase Blackout - Black running on color.
  39. Chase Blackout Rainbow - Black running on rainbow.
  40. Color Sweep Random - Random color introduced alternating from start and end of strip.
  41. Running Color - Alternating color/white pixels running.
  42. Running Red Blue - Alternating red/blue pixels running.
  43. Running Random - Random colored pixels running.
  44. Larson Scanner - K.I.T.T.
  45. Comet - Firing comets from one end.
  46. Fireworks - Firework sparks.
  47. Fireworks Random - Random colored firework sparks.
  48. Merry Christmas - Alternating green/red pixels running.
  49. Fire Flicker - Fire flickering effect. Like in harsh wind.
  50. Fire Flicker (soft) - Fire flickering effect. Runs slower/softer.
  51. Fire Flicker (intense) - Fire flickering effect. More range of color.
  52. Circus Combustus - Alternating white/red/black pixels running.
  53. Halloween - Alternating orange/purple pixels running.
  54. Bicolor Chase - Two LEDs running on a background color (set three colors).
  55. Tricolor Chase - Alternating three color pixels running (set three colors).
  56. ICU - Two eyes looking around.
  57. Custom - User created custom effect.

Projects using WS2812FX