Skip to content

Latest commit

 

History

History
91 lines (81 loc) · 5.12 KB

README.md

File metadata and controls

91 lines (81 loc) · 5.12 KB
Raw

WS2812FX library

WS2812FX - More Blinken for your LEDs!

This library features a variety of blinken effects for the WS2811/WS2812/NeoPixel LEDs. It uses ws2812_i2s extra library from esp-open-rtos to output to the leds.

NOTE:

  1. the ws2812_i2s library uses hardware I2S so output pin is GPIO3 and cannot be changed.
  2. on some ESP8266 such as the Wemos D1 mini, GPIO3 is the same pin used for serial RX.

Features

  • 53 different effects. And counting.
  • Free of any delay()
  • Tested on ESP8266.
  • FX, speed and brightness controllable on the fly.

Effects

  • Static - No blinking. Just plain old static light.
  • Blink - Normal blinking. 50% on/off time.
  • Breath - Does the "standby-breathing" of well known i-Devices. Fixed Speed.
  • Color Wipe - Lights all LEDs after each other up. Then turns them in that order off. Repeat.
  • Color Wipe Inverse - Same as Color Wipe, except swaps on/off colors.
  • Color Wipe Reverse - Lights all LEDs after each other up. Then turns them in reverse order off. Repeat.
  • Color Wipe Reverse Inverse - Same as Color Wipe Reverse, except swaps on/off colors.
  • Color Wipe Random - Turns all LEDs after each other to a random color. Then starts over with another color.
  • Random Color - Lights all LEDs in one random color up. Then switches them to the next random color.
  • Single Dynamic - Lights every LED in a random color. Changes one random LED after the other to another random color.
  • Multi Dynamic - Lights every LED in a random color. Changes all LED at the same time to new random colors.
  • Rainbow - Cycles all LEDs at once through a rainbow.
  • Rainbow Cycle - Cycles a rainbow over the entire string of LEDs.
  • Scan - Runs a single pixel back and forth.
  • Dual Scan - Runs two pixel back and forth in opposite directions.
  • Fade - Fades the LEDs on and (almost) off again.
  • Theater Chase - Theatre-style crawling lights. Inspired by the Adafruit examples.
  • Theater Chase Rainbow - Theatre-style crawling lights with rainbow effect. Inspired by the Adafruit examples.
  • Running Lights - Running lights effect with smooth sine transition.
  • Twinkle - Blink several LEDs on, reset, repeat.
  • Twinkle Random - Blink several LEDs in random colors on, reset, repeat.
  • Twinkle Fade - Blink several LEDs on, fading out.
  • Twinkle Fade Random - Blink several LEDs in random colors on, fading out.
  • Sparkle - Blinks one LED at a time.
  • Flash Sparkle - Lights all LEDs in the selected color. Flashes single white pixels randomly.
  • Hyper Sparkle - Like flash sparkle. With more flash.
  • Strobe - Classic Strobe effect.
  • Strobe Rainbow - Classic Strobe effect. Cycling through the rainbow.
  • Multi Strobe - Strobe effect with different strobe count and pause, controlled by speed setting.
  • Blink Rainbow - Classic Blink effect. Cycling through the rainbow.
  • Chase White - Color running on white.
  • Chase Color - White running on color.
  • Chase Random - White running followed by random color.
  • Chase Rainbow - White running on rainbow.
  • Chase Flash - White flashes running on color.
  • Chase Flash Random - White flashes running, followed by random color.
  • Chase Rainbow White - Rainbow running on white.
  • Chase Blackout - Black running on color.
  • Chase Blackout Rainbow - Black running on rainbow.
  • Color Sweep Random - Random color introduced alternating from start and end of strip.
  • Running Color - Alternating color/white pixels running.
  • Running Red Blue - Alternating red/blue pixels running.
  • Running Random - Random colored pixels running.
  • Larson Scanner - K.I.T.T.
  • Comet - Firing comets from one end.
  • Fireworks - Firework sparks.
  • Fireworks Random - Random colored firework sparks.
  • Merry Christmas - Alternating green/red pixels running.
  • Fire Flicker - Fire flickering effect. Like in harsh wind.
  • Fire Flicker (soft) - Fire flickering effect. Runs slower/softer.
  • Fire Flicker (intense) - Fire flickering effect. More range of color.
  • Circus Combustus - Alternating white/red/black pixels running.
  • Halloween - Alternating orange/purple pixels running.
  • Bicolor Chase - Two LEDs running on a background color (set three colors).
  • Tricolor Chase - Alternating three color pixels running (set three colors).
  • ICU - Two eyes looking around.
  • Custom - User created custom effect.

Projects using WS2812FX-rtos

  • esp-homekit-demo led_strip_animation example using a standalone ESP8266. Control your strip with Apple HomeKit!

Projects using the original WS2812FX