Metadata-Version: 1.2
Name: ledfx-dev
Version: 0.8.3.dev3
Summary: A network based light effect controller
Home-page: https://github.com/ahodges9/LedFx/tree/dev
Author: Austin Hodges
Author-email: austin.b.hodges@gmail.com
Maintainer: LedFx Devs
Maintainer-email: ledfx.app@gmail.com
License: The MIT License
Project-URL: Documentation, https://ledfx.readthedocs.io/en/docs/index.html
Project-URL: Source, https://github.com/ahodges9/LedFx
Project-URL: Discord, https://discord.gg/PqXMuthSNx
Description: =====================================================
           Welcome to LedFx ✨ *-Making music come alive!*
        =====================================================
        |Build Status| |License| |Build Status Docs| |Discord|
        
        .. 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 instantanously processes the audio into realtime lightshow 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 syncronised 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/ahodges9/LedFx/gh-pages/demos/ledfx_demo.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. Dont 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 5Ghz.
              - 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`_.
        
        #. **Direct computer audio output to LedFx.**
              - Follow guide, `How to: Enable Stereo Mix in Windows 10`_.
              - Alternatively use `Voicemeeter`_. `Voicemeeter tutorial`_.
              - Mac users can use `Loopback`_
              - 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|
        
        Contributing
        --------------
        Pull requests are welcome. Once tested, contact LedFx developer community on Discord to discuss the next step.
        
        Credits: `Contributors-&-About`_
        
        License
        ---------
        `MIT`_
        
        
        .. _`MIT`: https://choosealicense.com/licenses/mit/
        .. _`LedFx.exe`: https://ledfx.app/download/
        .. _`LedFx Guide`: https://ledfx.readthedocs.io/en/docs/index.html
        .. _`WLED`: https://github.com/Aircoookie/WLED/wiki
        .. _`installation documentation`: https://ledfx.readthedocs.io/en/docs/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
        .. _`Loopback`: https://rogueamoeba.com/loopback/
        
        .. |Build Status| image:: https://travis-ci.org/ahodges9/LedFx.svg?branch=master
           :target: https://github.com/THATDONFC/LedFx/tree/docs
           :alt: Build Status
        .. |Build Status Docs| image:: https://readthedocs.org/projects/ledfx/badge/?version=docs
           :target: https://ledfx.readthedocs.io/en/docs
           :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/wJ755dY
           :alt: Discord
        
Platform: any
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Requires-Python: >=3.7.0
