Aircoookie / LedFx

An extensible network based LED effect controller

LedFxController

LedFx is a network based LED effect controller with support for a wide range of effects. Effect range from simple static gradients all the way to audio reactive effects that dance to music!

To get started with LedFx run the following from the project root:

python setup.py install
ledfx --open-ui

Device Support

LedFx currently supports E1.31 capable devices, including the ESPixelStick firmware for any ESP8266 based controller. Upon first launch LedFx will create a default configuration file in the '.ledfx' folder inside the active user profile. The exact path will be printed to the command window. To add a device modify config.yaml as follows:

devices:
  sample_device_1:
    type: e131
    name: Sample Device
    host: 192.168.1.100
    universe: 1
    channel_offset: 0
    channel_count: 300
    max_brightness: 1.0

Optionally, the config can be simplified down to:

devices:
  sample_device_1:
    type: e131
    name: Sample Device
    host: 192.168.1.100
    pixel_count: 100

Also, connecting devices via an UDP packet with 8-bit RGB data is now supported. Just use the simplified config, but change the device type and specify the network port:

type: udp_rgb
port: 21324

Web-Interface

LedFx is intended to be ran on a small PC such as a Raspberry Pi, thus all configuration is done through a web-interface. The current UI is very simple and enable control of an individual device's effect, as well as providers a way to visualize the effect.