Skip to content

A Python client to control a WLED device with the E131 protocol

License

Notifications You must be signed in to change notification settings

samermashaan/WLED_E131_PC_Client

 
 

Repository files navigation

WLED_E131_PC_client

GUI screenshot

This is a personal project to control from my computer my RGB led strip+ESP8266+WLED setup. It was not built for the general public, so I will add documentation/update it only if I need or if there are some requests to do it. The program was built on Windows 10/11 with Python 3.7 (but I might make it available for linux as well in the future)

Basic concepts:

  • E131 communication
  • full WLED compatible
  • RGB effects available:
    • Rainbow
    • Audio Visualizer
    • Screen Mirroring
  • Tkinter GUI

This code is just a GUI module based on Tkinter that allows you to synchronize your leds with the computer audio, or to mirror the average color of your screen. These are the effects I was mostly interested in, because WLED already offers a good library of "static" effects (so that don't require a connection to a pc). However, this code makes it easier to add any effect to your WLED device, because you can just add a Python function on your pc, instead of having to modify a C++ program and flash the WLED device every time you make a change

E131

It uses the E131 protocol to control a WLED device, so as soon as you start this program it will seamlessly take control of the leds. It should easily be able to control any other framework that supports E131. The E131 communication is done thanks to the sacn module, which was slightly modified under its MIT license.

Documentation

At the moment, there is no extensive documentation on all the available features or on how to modify the code, but I think it is quite straightforward to understand. Feel free to ask for clarifications.

Build

Right now the code is not properly tested and validated, so binaries are not publicly available.
Follow these instructions to install all the needed python libraries and run it in Python (the code is written for Python 3.7, other version should work fine as well)

  1. (Optional) create a venv or Conda environment
  2. Install the dependencies using the requirements.txt file:
    pip install -r requirements.txt
  3. install PyAudio.
    • Windows:
      • Download the wheel for your python version, available at this page.
      • install it with
        pip install path/to/wheel 
    • Debian/Ubuntu:
      • try pip install pyaudio
      • if it doesn't work, make sure you have necessary dependencies:
          sudo apt install libpython3.7-dev
          sudo apt-get install libasound-dev portaudio19-dev libportaudio2 libportaudiocpp0
          sudo apt-get install ffmpeg libav-tools
      • if it still doesn't work, try building portaudio using these instructions
      • If later you see that no audio device is actually detecting the computer audio, you can create an audio monitor (https://stackoverflow.com/a/56612274)

To run it, run main.py with Python. Again, I have no idea how it behaves on different machines, so be ready to work a bit to fix eventual errors. If you have problems, send a message in the issue section.

About

A Python client to control a WLED device with the E131 protocol

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%