=====================================================
Welcome to LedFx ✨ Making music come alive!
|Build Status| |License| |Build Status Docs| |Discord|
|Contributor Covenant|
.. image:: 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!
Ledfx comes with a browser based front end for configuration, control and live visualisation on port 8888 by default.
| http://localhost:8888
| http://127.0.0.1:8888
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.
.. image:: https://raw.githubusercontent.com/LedFx/LedFx/main/docs/_static/topology.png
.. list-table::
:widths: 75 75
:header-rows: 1
-
-
- 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
#. 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://kno.wled.ge/basics/getting-started/>.
- Flash WLED to the ESP device <https://kno.wled.ge/basics/install-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!
#. Install LedFx.
- For PC and Mac, see our releases, or see the installation documentation for more information.
- For linux, you can use pip to install ledfx - however you may need to install some dependencies first. See the installation documentation_ for more information.
#. 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 <https://ledfx.readthedocs.io/en/latest/settings/directing_audio.html>_.
- Play some music in the background.
#. Start LedFx.
- With any desired launch options. See Command Line Options <https://ledfx.readthedocs.io/en/latest/launch.html>_.
- Use --open-ui to open the web interface automatically in your default browser, or navigate to http://127.0.0.1:8888 directly.
- 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.
#. 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:
.. image:: https://discordapp.com/api/guilds/469985374052286474/widget.png?style=banner2
:width: 30%
:target: https://discord.com/invite/xyyHEquZKQ
Contributing
Pull requests are welcome. Once tested, contact LedFx developer community on Discord to discuss the next step.
Please read our Contributing Guidelines <https://ledfx.readthedocs.io/en/latest/contributing.html>_ for detailed information on contribution expectations, code quality requirements, and community standards.
We expect and require all contributors to read, understand and follow our Code of Conduct <https://github.com/LedFx/LedFx/blob/main/CODE_OF_CONDUCT.md>_.
Credits: Contributors-&-About_
License
GPL-3_
.. _GPL-3: https://choosealicense.com/licenses/gpl-3.0/
.. _LedFx.exe: https://github.com/LedFx/LedFx/releases/latest
.. _LedFx Guide: https://ledfx.readthedocs.io/en/latest/index.html
.. _WLED: https://kno.wled.ge
.. _releases: https://github.com/LedFx/LedFx/releases/latest
.. _Installation documentation: https://ledfx.readthedocs.io/en/latest/installing.html
.. _Stable documentation: https://ledfx.readthedocs.io/en/stable/
.. _Latest documentation: https://ledfx.readthedocs.io/en/latest/
.. _our website: https://ledfx.app
.. _Discord: https://discord.gg/xyyHEquZKQ
.. _Contributors-&-About: https://ledfx.app/about/
.. _How to: Enable Stereo Mix in Windows 10: https://thegeekpage.com/stereo-mix/
.. |Build Status| image:: https://github.com/LedFx/LedFx/actions/workflows/ci.yml/badge.svg
:target: https://github.com/LedFx/LedFx/actions/workflows/ci.yml
:alt: Build Status
.. |Build Status Docs| image:: https://readthedocs.org/projects/ledfx/badge/?version=main
:target: https://ledfx.readthedocs.io/
:alt: Documentation Status
.. |License| image:: https://img.shields.io/badge/license-GPL3-blue.svg
:alt: License
.. |Discord| image:: https://img.shields.io/badge/chat-on%20discord-7289da.svg
:target: https://discord.gg/xyyHEquZKQ
:alt: Discord
.. |Contributor Covenant| image:: https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg
:target: CODE_OF_CONDUCT.md
