Skip to content

Latest commit

 

History

History

README.md

BusyLight Project Logo

Control USB LED status lights from the command line and HTTP.
26 devices · 9 vendors · CLI · HTTP API

Test & Publish Version Python Version License Monthly Downloads

BusyLight for Humans™ controls USB LED lights from multiple vendors. Use the command-line interface or HTTP API to turn lights on/off, change colors, and apply effects.

Built on busylight-core, the Python library for USB status light communication.

All Supported Lights

Flag1, Busylight Alpha2, Blynclight Plus3, Blink(1)4, Mute5, Blynclight6, Orb7, BusyLight Omega8, BlinkStick Square9, Blynclight Mini10, MuteMe Original11, fit-statUSB12, MuteSync13, Status Indicator14

Quick Start

# Turn on a green light right now
uvx --from busylight-for-humans busylight on

# Red, blinking, then off
uvx --from busylight-for-humans busylight blink red
uvx --from busylight-for-humans busylight off

Installation

# Basic install (CLI only)
pip install busylight-for-humans

# With web API support
pip install busylight-for-humans[webapi]

Linux requires udev rules for USB device access:

busylight udev-rules -o 99-busylights.rules
sudo cp 99-busylights.rules /etc/udev/rules.d/
sudo udevadm control -R
# Unplug and reconnect your device

Supported Hardware

Vendor Models
Agile Innovative BlinkStick, BlinkStick Pro, Square, Strip, Nano, Flex
CompuLab fit-statUSB
EPOS Busylight
Embrava Blynclight, Blynclight Mini, Blynclight Plus, BLYNCUSB10, BLYNCUSB20
Kuando Busylight Alpha, Busylight Omega
Luxafor Flag, Orb, Mute, Busy Tag, Bluetooth
MuteMe MuteMe Original, MuteMe Mini, MuteSync
Plantronics Status Indicator
ThingM Blink(1), Blink(1) mk2

Multi-LED targeting supported on BlinkStick variants, Luxafor Flag, and Blink(1) mk2.

Command Line

busylight on              # green light
busylight on red          # red light
busylight blink blue      # blinking blue
busylight rainbow         # cycle through colors
busylight off             # turn off

# Multi-LED devices
busylight on red --led 1  # first LED only
busylight on blue --led 2 # second LED only

Web API

# Start the server
busyserve

# Control via HTTP
curl "http://localhost:8000/light/0/on?color=red"
curl "http://localhost:8000/light/0/blink?color=blue&count=5"
curl "http://localhost:8000/lights/off"

Platform Support

  • macOS -- works out of the box
  • Linux -- requires udev rules (see Installation)
  • Windows -- may work, untested, patches welcome

Contributing

Contributions welcome. See CONTRIBUTING.md for development setup and guidelines. This project is part of a uv workspace monorepo.

Gratitude

Thank you to @todbot and ThingM for gifting blink(1) mk3 lights to support this project.

License

Apache License 2.0