{"id":14962039,"url":"https://github.com/kitesurfer1404/ws2812fx","last_synced_at":"2025-05-14T08:08:03.485Z","repository":{"id":41053403,"uuid":"59408743","full_name":"kitesurfer1404/WS2812FX","owner":"kitesurfer1404","description":"WS2812 FX Library for Arduino and ESP8266","archived":false,"fork":false,"pushed_at":"2024-12-01T21:23:30.000Z","size":1564,"stargazers_count":1650,"open_issues_count":3,"forks_count":356,"subscribers_count":100,"default_branch":"master","last_synced_at":"2025-05-14T01:22:09.365Z","etag":null,"topics":["adafruit-neopixel-library","arduino","arduino-library","esp8266","led","neopixel","ws2812"],"latest_commit_sha":null,"homepage":null,"language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kitesurfer1404.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-05-22T11:27:21.000Z","updated_at":"2025-05-10T01:31:48.000Z","dependencies_parsed_at":"2024-12-26T06:16:41.612Z","dependency_job_id":null,"html_url":"https://github.com/kitesurfer1404/WS2812FX","commit_stats":{"total_commits":149,"total_committers":23,"mean_commits":6.478260869565218,"dds":0.7248322147651007,"last_synced_commit":"ca19d320217afb970163c4771d62a183f761202a"},"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kitesurfer1404%2FWS2812FX","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kitesurfer1404%2FWS2812FX/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kitesurfer1404%2FWS2812FX/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kitesurfer1404%2FWS2812FX/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kitesurfer1404","download_url":"https://codeload.github.com/kitesurfer1404/WS2812FX/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254101558,"owners_count":22014908,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["adafruit-neopixel-library","arduino","arduino-library","esp8266","led","neopixel","ws2812"],"created_at":"2024-09-24T13:28:50.250Z","updated_at":"2025-05-14T08:08:03.461Z","avatar_url":"https://github.com/kitesurfer1404.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"![WS2812FX library](https://raw.githubusercontent.com/kitesurfer1404/WS2812FX/master/WS2812FX_logo.png)\n\nWS2812FX - More Blinken for your LEDs!\n======================================\n\nThis 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.\n\nFeatures\n--------\n\n* 55 different effects. And counting.\n* Tested on Arduino Uno/Micro/Nano/Leonardo and ESP8266/ESP32.\n* All effects with printable names - easy to use in user interfaces.\n* FX, speed and brightness controllable on the fly.\n* Ready for sound-to-light (see external trigger example)\n\n\nDownload, Install and Example\n-----------------------------\n\n[![arduino-library-badge](https://www.ardu-badge.com/badge/WS2812FX.svg)](https://www.ardu-badge.com/WS2812FX)\n\nYou can **search for WS2812FX in the Arduino IDE Library Manager** or install the latest (or development) version manually:\n\n\n* Install the famous [Adafruit NeoPixel library](https://github.com/adafruit/Adafruit_NeoPixel) (v1.1.7 or newer)\n* Download this repository.\n* Extract to your Arduino libraries directory.\n* Open Arduino IDE.\n* Now you can choose File \u003e Examples \u003e WS2812FX \u003e ...\n\nSee examples for basic usage.\n\nIn it's most simple form, here's the code to get you started!\n\n```cpp\n#include \u003cWS2812FX.h\u003e\n\n#define LED_COUNT 30\n#define LED_PIN 12\n\nWS2812FX ws2812fx = WS2812FX(LED_COUNT, LED_PIN, NEO_GRB + NEO_KHZ800);\n\nvoid setup() {\n  ws2812fx.init();\n  ws2812fx.setBrightness(100);\n  ws2812fx.setSpeed(200);\n  ws2812fx.setMode(FX_MODE_RAINBOW_CYCLE);\n  ws2812fx.start();\n}\n\nvoid loop() {\n  ws2812fx.service();\n}\n```\n\nMore 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):\n  * setSegment(segment index, start LED, stop LED, mode, color, speed, reverse);\n\nNote, some effects make use of more than one color (up to three) and are programmed by specifying an array of colors:\n  * setSegment(segment index, start LED, stop LED, mode, colors[], speed, reverse);\n\n```cpp\n// divide the string of LEDs into two independent segments\nuint32_t colors[] = {RED, GREEN};\nws2812fx.setSegment(0, 0,           (LED_COUNT/2)-1, FX_MODE_BLINK, colors, 1000, false);\nws2812fx.setSegment(1, LED_COUNT/2, LED_COUNT-1,     FX_MODE_BLINK, COLORS(ORANGE, PURPLE), 1000, false);\n```\n\n\nEffects\n-------\n\n0. **Static** - No blinking. Just plain old static light.\n1. **Blink** - Normal blinking. 50% on/off time.\n2. **Breath** - Does the \"standby-breathing\" of well known i-Devices. Fixed Speed.\n3. **Color Wipe** - Lights all LEDs after each other up. Then turns them in that order off. Repeat.\n4. **Color Wipe Inverse** - Same as Color Wipe, except swaps on/off colors.\n5. **Color Wipe Reverse** - Lights all LEDs after each other up. Then turns them in reverse order off. Repeat.\n6. **Color Wipe Reverse Inverse** - Same as Color Wipe Reverse, except swaps on/off colors.\n7. **Color Wipe Random** - Turns all LEDs after each other to a random color. Then starts over with another color.\n8. **Random Color** - Lights all LEDs in one random color up. Then switches them to the next random color.\n9. **Single Dynamic** - Lights every LED in a random color. Changes one random LED after the other to a random color.\n10. **Multi Dynamic** - Lights every LED in a random color. Changes all LED at the same time to new random colors.\n11. **Rainbow** - Cycles all LEDs at once through a rainbow.\n12. **Rainbow Cycle** - Cycles a rainbow over the entire string of LEDs.\n13. **Scan** - Runs a single pixel back and forth.\n14. **Dual Scan** - Runs two pixel back and forth in opposite directions.\n15. **Fade** - Fades the LEDs on and (almost) off again.\n16. **Theater Chase** - Theatre-style crawling lights. Inspired by the Adafruit examples.\n17. **Theater Chase Rainbow** - Theatre-style crawling lights with rainbow effect. Inspired by the Adafruit examples.\n18. **Running Lights** - Running lights effect with smooth sine transition.\n19. **Twinkle** - Blink several LEDs on, reset, repeat.\n20. **Twinkle Random** - Blink several LEDs in random colors on, reset, repeat.\n21. **Twinkle Fade** - Blink several LEDs on, fading out.\n22. **Twinkle Fade Random** - Blink several LEDs in random colors on, fading out.\n23. **Sparkle** - Blinks one LED at a time.\n24. **Flash Sparkle** - Lights all LEDs in the selected color. Flashes single white pixels randomly.\n25. **Hyper Sparkle** - Like flash sparkle. With more flash.\n26. **Strobe** - Classic Strobe effect.\n27. **Strobe Rainbow** - Classic Strobe effect. Cycling through the rainbow.\n28. **Multi Strobe** - Strobe effect with different strobe count and pause, controlled by speed setting.\n29. **Blink Rainbow** - Classic Blink effect. Cycling through the rainbow.\n30. **Chase White** - Color running on white.\n31. **Chase Color** - White running on color.\n32. **Chase Random** - White running followed by random color.\n33. **Chase Rainbow** - White running on rainbow.\n34. **Chase Flash** - White flashes running on color.\n35. **Chase Flash Random** - White flashes running, followed by random color.\n36. **Chase Rainbow White** - Rainbow running on white.\n37. **Chase Blackout** - Black running on color.\n38. **Chase Blackout Rainbow** - Black running on rainbow.\n39. **Color Sweep Random** - Random color introduced alternating from start and end of strip.\n40. **Running Color** - Alternating color/white pixels running.\n41. **Running Red Blue** - Alternating red/blue pixels running.\n42. **Running Random** - Random colored pixels running.\n43. **Larson Scanner** - K.I.T.T.\n44. **Comet** - Firing comets from one end.\n45. **Fireworks** - Firework sparks.\n46. **Fireworks Random** - Random colored firework sparks.\n47. **Merry Christmas** - Alternating green/red pixels running.\n48. **Fire Flicker** - Fire flickering effect. Like in harsh wind.\n49. **Fire Flicker (soft)** - Fire flickering effect. Runs slower/softer.\n50. **Fire Flicker (intense)** - Fire flickering effect. More range of color.\n51. **Circus Combustus** - Alternating white/red/black pixels running.\n52. **Halloween** - Alternating orange/purple pixels running.\n53. **Bicolor Chase** - Two LEDs running on a background color.\n54. **Tricolor Chase** - Alternating three color pixels running.\n55. **TwinkleFOX** - Lights fading in and out randomly.\n56. thru 63. **Custom** - Up to eight user created custom effects.\n\n\nProjects using WS2812FX\n-----------------------\n\n* [Smart Home project by renat2985](https://github.com/renat2985/rgb) using the ESP8266. Including a nice webinterface in the demo video!\n* [WiFi LED Star by kitesurfer1404](http://www.kitesurfer1404.de/tech/led-star/en)\n* [McLighting by toblum](https://github.com/toblum/McLighting) is a multi-client lighting gadget for ESP8266\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkitesurfer1404%2Fws2812fx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkitesurfer1404%2Fws2812fx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkitesurfer1404%2Fws2812fx/lists"}