You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Go to file
YeonV 08e8023ba3
adjusting defaults
3 hours ago
.devcontainer Remove yaml migration, start work on preset config 2 years ago
.github Trigger HomeAssistant Build 4 days ago
.vscode Fix QLC+ Integration 1 year ago
devices [pre-commit.ci] auto fixes from pre-commit.com hooks 2 weeks ago
docs Adding windows 10 more info in troubleshooting doc 7 months ago
icons square icon 1 year ago
ledfx adjusting defaults 3 hours ago
ledfx_frontend Linting 1 week ago
.coveragerc Spell Check 2 years ago
.env Trying to fix node check 2 years ago
.git-blame-ignore-revs Add Black Update to git-blame-ignore 1 month ago
.gitignore Add .venv to gitignore 3 months ago
.pre-commit-config.yaml [pre-commit.ci] pre-commit autoupdate 1 month ago
.readthedocs.yml Rename requirements_docs to requirements-docs 2 years ago
AUTHORS.rst Update AUTHORS.rst 2 years ago
CHANGELOG.rst Precommit 2 years ago
CODE_OF_CONDUCT.md Update to v2.1 9 months ago
LICENSE.txt Update License, Readme and installing 9 months ago
MANIFEST.in Update CI and fix some wheel warnings 2 years ago
README.rst Update README.rst 2 months ago
SECURITY.md Add LedFx debugger for VS Code 2 years ago
activate.ps1 Update activate.ps1 for python venv use 2 years ago
droplet_creator.py Update droplet_creator.py 1 year ago
hiddenimports.py remove notifypy. only show notifications via pystray 1 day ago
pyproject.toml Bump sentry_sdk, setuptools 2 years ago
release.py [pre-commit.ci] auto fixes from pre-commit.com hooks 4 months ago
requirements-dev.txt Bump pre-commit hook versions 1 year ago
requirements.txt Merge branch 'main' into led-strips/zengge-magichome 4 days ago
setup.cfg Update CI and fix some wheel warnings 2 years ago
setup.py remove notifypy. only show notifications via pystray 1 day ago
win-gh.spec win-gh.spec 9 months ago
win.spec Move hidden imports to seperate file 4 days ago
yarn.lock Spotify Graph song audio analysis 1 year ago

README.rst

=====================================================
   Welcome to LedFx ✨ *-Making music come alive!*
=====================================================
|Build Status| |License| |Build Status Docs| |Discord|
|Contributor Covenant|

.. image:: https://raw.githubusercontent.com/LedFx/LedFx/b8e68beaa215d4308c74d0c7d657556ac894b707/icons/banner.png

LedFx website: https://ledfx.app/

What is LedFx?
----------------

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.

📑 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.

.. image:: https://i.imgur.com/vzyHNwG.png

.. list-table::
   :widths: 75 75
   :header-rows: 1

   * - 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

#. **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!

#. **Install LedFx.**
      - After you have WLED installed on your ESP device, download: `LedFx.exe`_ and install LedFx.
      - For Mac and Linux, see the `installation documentation`_ or `LedFx Guide`_.

#. **Direct computer audio output to LedFx.**
      - Follow guide, `How to: Enable Stereo Mix in Windows 10`_.
      - Alternatively use `Voicemeeter`_. `Voicemeeter tutorial`_.
      - More information for `Linux and macOS users here <https://ledfx.readthedocs.io/en/latest/directing_audio.html>`_.
      - Play some music in the background.

#. **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.

#. **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:

.. 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.
We expect and require all contributors to read, understand and follow our code of conduct.

Credits: `Contributors-&-About`_

License
---------
`GPL-3`_


.. _`GPL-3`: https://choosealicense.com/licenses/gpl-3.0/
.. _`LedFx.exe`: https://ledfx.app/download/
.. _`LedFx Guide`: https://ledfx.readthedocs.io/en/latest/index.html
.. _`WLED`: https://github.com/Aircoookie/WLED/wiki
.. _`installation documentation`: https://ledfx.readthedocs.io/en/latest/installing.html
.. _`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/
.. _`Voicemeeter`: https://vb-audio.com/Voicemeeter/index.htm
.. _`Voicemeeter tutorial`: https://youtu.be/ZXKDzYXS60o?start=27&end=163

.. |Build Status| image:: https://github.com/LedFx/LedFx/actions/workflows/ci-build.yml/badge.svg
   :target: https://github.com/LedFx/LedFx/actions/workflows/ci-build.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