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.
 
 
 
Shaun Eccles-Smith dd652ea07c Removal of Redundant FXMatrix Device 2 weeks ago
.devcontainer Update ledfx-config.yml 5 months ago
.github Fix Sentry DSN issues 2 months ago
.vscode fix task to run on osx 4 months ago
docs Update Docs for Data Prefix 3 weeks ago
frontend Bump version, update changelog, for 10.5 2 weeks ago
icons Add startup image for iOS devices 3 months ago
ledfx Removal of Redundant FXMatrix Device 2 weeks ago
ledfx_frontend Rebuild Frontend 2 months ago
.coveragerc Spell Check 5 months ago
.env working on lots of compiler errors and lint errors, added . eslint and prettier configs for formating 1 year ago
.git-blame-ignore-revs Hopefully fix/catch browser errors 5 months ago
.gitignore Prepare for v0.10.0 Release! 2 months ago
.pre-commit-config.yaml Update Pre-commit config 4 months ago
.readthedocs.yml Rename requirements_docs to requirements-docs 5 months ago
AUTHORS.rst Update AUTHORS.rst 4 months ago
CHANGELOG.rst Bump version, update changelog, for 10.5 2 weeks ago
CODE_OF_CONDUCT.md Code of Conduct introduction 4 months ago
LICENSE.txt Initial commit 3 years ago
MANIFEST.in Rename default config from .yaml to .json 3 months ago
README.rst Version Bump & Docs Update 2 months ago
SECURITY.md Bump to 0.10.2, update security, update pypi docs 2 months ago
activate.ps1 Update activate.ps1 for python venv use 5 months ago
pyproject.toml Bump sentry_sdk, setuptools 2 months ago
release.py isort, flake8, black 5 months ago
requirements-dev.txt Prepare for v0.10.0 Release! 2 months ago
requirements.txt Pin Required versions 2 weeks ago
setup.cfg Update depreciated field names 2 weeks ago
setup.py Pin Required versions 2 weeks ago
win.spec Add COM port API & List COM ports for adalight 2 months ago

README.rst

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

.. image:: https://i.imgur.com/SFWfhFr.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
-------

We are actively adding and perfecting the effects, but here is a quick demo of LedFx running three different effects synced across three different ESP8266 devices:

.. image:: https://raw.githubusercontent.com/LedFx/LedFx/gh-pages-old/demos/ledfx_demo-small.gif

πŸ“‘ 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/master/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
---------
`MIT`_


.. _`MIT`: https://choosealicense.com/licenses/mit/
.. _`LedFx.exe`: https://ledfx.app/download/
.. _`LedFx Guide`: https://ledfx.readthedocs.io/en/master/index.html
.. _`WLED`: https://github.com/Aircoookie/WLED/wiki
.. _`installation documentation`: https://ledfx.readthedocs.io/en/master/installing.html
.. _`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=master
:target: https://ledfx.readthedocs.io/
:alt: Documentation Status
.. |License| image:: https://img.shields.io/badge/license-MIT-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