Metadata-Version: 2.1
Name: LedFx
Version: 2.1.9
Summary: A network based light effect controller
Author: LedFx Developers
License: GPL-3.0 License
Requires-Python: <3.14,>=3.10
Requires-Dist: numpy<3.0.0,>=2.0.0
Requires-Dist: cffi>=0.16.0
Requires-Dist: wheel>=0.36.2
Requires-Dist: aiohttp<4.0.0,>=3.9.1
Requires-Dist: aiohttp-cors>=0.7.0
Requires-Dist: aubio-ledfx>=0.4.11
Requires-Dist: cython>=3.0.7
Requires-Dist: certifi>=2023.11.17
Requires-Dist: multidict>=6.0.4
Requires-Dist: openrgb-python>=0.2.15
Requires-Dist: paho-mqtt>=1.6.1
Requires-Dist: psutil>=5.9.7
Requires-Dist: pyserial>=3.5
Requires-Dist: pystray>=0.19.5
Requires-Dist: python-rtmidi>=1.5.8
Requires-Dist: requests>=2.31.0
Requires-Dist: sacn>=1.9.0
Requires-Dist: sentry-sdk>=1.40.4
Requires-Dist: sounddevice>=0.4.6
Requires-Dist: icmplib>=3.0.4
Requires-Dist: voluptuous>=0.14.1
Requires-Dist: zeroconf>=0.131.0
Requires-Dist: pillow>=10.1.0
Requires-Dist: flux-led>=1.0.4
Requires-Dist: lifx-async>=5.1.0
Requires-Dist: python-osc>=1.8.3
Requires-Dist: pybase64~=1.4.0
Requires-Dist: mss~=10.1.0
Requires-Dist: uvloop>=0.16.0; sys_platform != "win32"
Requires-Dist: winloop>=0.3.1; sys_platform == "win32"
Requires-Dist: rpi-ws281x>=4.3.0; sys_platform == "linux"
Requires-Dist: stupidartnet<2.0.0,>=1.6.0
Requires-Dist: python-dotenv<2.0.0,>=1.0.0
Requires-Dist: pyfastnoiselite>=0.0.7
Requires-Dist: netifaces2>=0.0.22
Requires-Dist: packaging>=21.0
Requires-Dist: xled>=0.7.0
Requires-Dist: samplerate-ledfx>=0.2.3
Requires-Dist: audio-hotplug>=0.1.0
Requires-Dist: aiosendspin>=4.0.0; python_version >= "3.12"
Requires-Dist: pyflac>=2.2.0; python_version >= "3.12"
Provides-Extra: hue
Requires-Dist: python-mbedtls==2.9.2; python_version <= "3.12" and ((platform_machine != "aarch64" and platform_machine != "armv7l") and sys_platform == "linux" or sys_platform == "win32" or sys_platform == "darwin") and extra == "hue"
Description-Content-Type: text/x-rst

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

   * - Component
     - Example
   * - Computer running LedFx
     - Windows 10, `LedFx.exe`_
   * - Browser to access the LedFx web interface
     - Chrome/Edge/Firefox/Safari

       http://127.0.0.1:8888
   * - 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-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
