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 our website to see LedFx in action!

You can also join our Discord where community members show off their projects. Check out the #projects or #showcase channels.

📑 Quick start guide and documentation📖

Head over to LedFx Builds to get the latest releases for Windows, Mac and Linux. If you are in a hurry, grab the latest Core version for your operating system and off you go. For more info on what the different versions do, read the release description on the releases page

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 LedFx-Builds 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.
  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.93.tar.gz (25.3 MB view details)

Uploaded Source

Built Distribution

ledfx-2.0.93-py3-none-any.whl (25.4 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ledfx-2.0.93.tar.gz
  • Upload date:
  • Size: 25.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for ledfx-2.0.93.tar.gz
Algorithm Hash digest
SHA256 037e0663bba190772ba1f8de1732b797f533afe6a8410e491112be1d4868a2c3
MD5 2dc104383a439ea6c501fd035bd45699
BLAKE2b-256 4d4145690f6b168a94c9f0288775333c029a5ae23f3454c18f35ddf3b501cac7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ledfx-2.0.93-py3-none-any.whl
  • Upload date:
  • Size: 25.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for ledfx-2.0.93-py3-none-any.whl
Algorithm Hash digest
SHA256 3e4a1d27c08afb843206569df1fbca7cfa36f6747d5dc355b16ceebb0a0ead40
MD5 16ecb1f3592f00867b1dbb23608d6b5b
BLAKE2b-256 b11932554015f79ea9a77501f28c6fa1775d866547960e489dff549bca539fe5

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