Skip to content

Latest commit

 

History

History
141 lines (105 loc) · 6.03 KB

README.rst

File metadata and controls

141 lines (105 loc) · 6.03 KB
Raw

Welcome to LedFx ✨ - Making music come alive!

Build Status License Documentation Status Discord Contributor Covenant

https://github.com/LedFx/LedFx/blob/b8e68beaa215d4308c74d0c7d657556ac894b707/icons/banner.png

LedFx website: https://ledfx.app/

What is LedFx?

Music to Light!

LedFx instantaneously transforms audio input into a realtime light show. No need to spend hours on syncing your LEDs to music - LedFx will do this all for you!

LedFx is a real-time music visualization program that streams audio reactive effects to networked LED strips. LedFx can control multiple devices and works great with cheap ESP8266/ESP32 nodes, allowing for cost effective synchronized effects across your entire house!

Demos

We are actively adding and perfecting the effects. Here are some of our favourites!

ledfx_demo.mp4

⚠ PHOTOSENSITIVE EPILEPSY WARNING ⚠ - The following videos contain rhythmic flashing lights

ledfx_demo_2.mp4
ledfx_demo_3.mov
ledfx_demo_4.mp4

📑 Quick start guide and documentation📖

Windows users can use the installer from the LedFx website: https://ledfx.app/download/

Mac and Linux are also supported, though currently do not have installers. For detailed installation instructions, see the installation 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://i.imgur.com/vzyHNwG.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: https://github.com/Aircoookie/WLED/wiki.
    • Flash WLED to the ESP device: https://github.com/Aircoookie/WLED/wiki/Install-WLED-binary
    • 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 left hand side, click on Device Management -> Find WLED devices button, or 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(Reactive), and press Set effect button.
    • 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

MIT