wlc - wled cli
A simple commandline tool for controlling a wled host.
Capabilities
wlc can control common settings of your wled device, such as:
- brightness
- hue and saturation
- effect type, speed and intensity
- color palette
These settings can also be only applied to a specified LED-segment.
Furthermore, wlc can query the host for current light settings.
Configuration
Configuration is done through editing config.h
, located in the include
directory. The default IP address will most likely have to be edited to match your host's address.
Installation
Dependencies
The build dependencies are:
- make
- libcurl
Installing
Clone this repo to your system and navigate into it's directory. Edit the IP address in config.h
. Then:
make && make install
This will install wlc into ~/.local/bin/
. Thus, make sure the directory is in your $PATH
to be able to execute the program in your shell.
To install it globally, move or copy the binary to /usr/bin/
.
since wlc needs to be configured pre-compilation, no binary download is provided
Use case examples
Setting a color / effect / palette profile at system startup
This can be done by calling wlc from .xinitrc
# ...
wlc <flags and values> &
# ...
Synchronize LEDs with daylight
This can be done by running a hourly cronjob from wlc with the -t
flag. wlc will match the light temperature to the system's time.
How it works
wlc controls the wled host through the wled http api by making GET requests. The official wled wiki page on this topic explains the inner-workings in greater detail.