Skip to main content

A network based light effect controller

Project description

Build Status License Documentation Status Discord Contributor Covenant

https://raw.githubusercontent.com/LedFx/LedFx/main/ledfx_assets/banner.png

What is LedFx?

LedFx makes your LEDs dance to audio! What LedFx offers is the ability to take audio input, and instantaneously processes the audio into realtime light show to multiple LED strips/matrix. No need to spend hours on end to program one song to program your LEDs, as LedFx will do this all for you!

LedFx real-time LED strip music visualization effect controller using is a network based devices (ESP8266/ESP32/Raspberry Pi 4) with support for advanced real-time audio effects! LedFx can control multiple devices and works great with cheap ESP8266/ESP32 nodes allowing for cost effective synchronized effects across your entire house!

Demos

Visit and join our Discord where community members show off their projects. Check out the #projects or #show-and-tell channels.

📑 Quick start guide and documentation📖

Head over to releases to get the latest releases for Windows and Mac. For linux, use pip.

Bleeding edge (Experimental)

If you want the absolute bleeding edge and are not afraid of using the terminal, take a look at the detailed installation instructions here: Installation documentation.

Documentation

Documentation for the latest release can be found here: Stable documentation

Documentation built against this repository can be found here: Latest documentation

😍 Show me how to make one!

The below image describes a basic setup - LedFx running on PC, communicating with a WLED Device controlling an LED strip.

https://raw.githubusercontent.com/LedFx/LedFx/main/docs/_static/topology.png

Component

Example

Computer running LedFx

Windows 10, LedFx.exe

Networked device controlling LED Strip

ESP8266 NODEMCU v3 running WLED

Addressable LED strip

DC5V WS2812B 5 meters 60LED/m IP67

Power supply for LED Strip and ESP

5V 10 amps LED Power Supply

Something to connect the wires together!

Soldering iron/solder

  1. Build your networked LED Strip.
    • For most, this is the difficult step. Don’t worry! There’s guides here and online, and plenty of people able to help on WLED and LedFx Discord.

    • Follow the WLED guide to connect the LED strip and ESP together.

    • Flash WLED to the ESP device.

    • Ensure all WLED devices are powered on, and connected to your Wi-Fi.

    • Test you can access the WLED web interface from your PC. If so, then you’re good to go!

  2. Install LedFx.
  3. Direct computer audio output to LedFx.
    • By default on Windows LedFx will attempt to listen to your system audio.

    • More information for Linux and macOS users here.

    • Play some music in the background.

  4. Start LedFx.
    • Your WLED devices should appear in LedFx, automagically configured and ready to go! 🎆🔥

    • If not, on the bottom click Home, -> Scan for WLED devices button, or click on the big plus sign and Add Device to add them manually.

    • If they’re still not showing up, make sure they’re powered on and properly connected to your WiFi.

  5. Start using effects!
    • Click on the device, select an effect eg scroll under Classic

    • Your lights should now be reacting realtime to your music! Enjoy the show 🌈

🧑‍💻 Join the LedFx Community

Join the Discord server to discuss everything about LedFx! Discord

To join, click on the Discord button below:

https://discordapp.com/api/guilds/469985374052286474/widget.png?style=banner2

Contributing

Pull requests are welcome. Once tested, contact LedFx developer community on Discord to discuss the next step. We expect and require all contributors to read, understand and follow our code of conduct.

Credits: Contributors-&-About

License

GPL-3

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ledfx-2.0.109.tar.gz (25.8 MB view details)

Uploaded Source

Built Distribution

ledfx-2.0.109-py3-none-any.whl (26.0 MB view details)

Uploaded Python 3

File details

Details for the file ledfx-2.0.109.tar.gz.

File metadata

  • Download URL: ledfx-2.0.109.tar.gz
  • Upload date:
  • Size: 25.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for ledfx-2.0.109.tar.gz
Algorithm Hash digest
SHA256 7d26f73419756d809fc0391623bfca7852157174cf0ca05b2ded2c4219de5fa0
MD5 7ccbc7c8b2d0affb6dd4deacafd01700
BLAKE2b-256 d7ad53f39e319fbecf103a4e544722acd462b39ee734b503ac1a37ae18f238df

See more details on using hashes here.

File details

Details for the file ledfx-2.0.109-py3-none-any.whl.

File metadata

  • Download URL: ledfx-2.0.109-py3-none-any.whl
  • Upload date:
  • Size: 26.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for ledfx-2.0.109-py3-none-any.whl
Algorithm Hash digest
SHA256 0fafaae6a71f5aec33a638e046edd9b4c307ef5872bf64933d70c8de129995dd
MD5 bcc6b8e837312e7f6b37dace003cae85
BLAKE2b-256 545c7096490dd79d66c9ab17a5739fe0af3f28053e37926e955033d991664821

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page