Skip to content

JnyJny/busylight

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

BusyLight Project Logo

Test & Publish Version Release Date Python Version License Code Style: ruff 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.

All Supported Lights

What is BusyLight?

BusyLight provides simple control over USB LED status lights to show your availability, build status, system health, or any other visual indicator. Perfect for home offices, development workflows, and team collaboration.

Key Features:

  • 23 supported devices from 9 vendors (Blink1, BlinkStick, Luxafor, etc.)
  • Command-line interface with intuitive color and effect controls
  • HTTP API with full documentation for automation and integration
  • Multi-LED targeting for devices with multiple independent LEDs
  • Cross-platform support for macOS and Linux (and maybe Windows, it's spotty).

Supported Hardware

Vendor Models LED Support
Agile Innovative BlinkStick, BlinkStick Pro, BlinkStick Square, BlinkStick Strip, BlinkStick Nano, BlinkStick Flex Multi-LED targeting
Compulab fit-statUSB Single LED
EPOS Busylight Single LED
Embrava Blynclight, Blynclight Mini, Blynclight Plus Single LED
Kuando Busylight Alpha, Busylight Omega Single LED
Luxafor Flag, Orb, Mute, Busy Tag, Bluetooth variants Flag: Multi-LED, Others: Single LED
MuteMe MuteMe Original, Mute Mini, MuteSync Single LED
Plantronics Status Indicator Single LED
ThingM Blink(1), Blink(1) mk2 mk2: Multi-LED

๐Ÿ“– Device setup guides โ†’

Installation

Basic Install (CLI only)

# Using uvx (recommended)
uvx --from busylight-for-humans busylight list
# Using pip
pip install busylight-for-humans

Web API Install

# Using uvx
uvx --from "busylight-for-humans[webapi]" busyserve
# Using pip
pip install busylight-for-humans[webapi]

Linux Setup

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

Quick Start

Command Line

# Basic usage
busylight on              # Green light
busylight on red          # Red light
busylight blink blue      # Blinking blue
busylight off             # Turn off

# Multi-LED devices (Blink1 mk2, BlinkStick, etc.)
busylight on red --led 1          # First LED only
busylight on blue --led 2         # Second LED only
busylight rainbow --led 1         # Rainbow on first LED
busylight pulse green --led 2     # Pulse on second LED

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"

# Multi-LED targeting
curl "http://localhost:8000/lights/on?color=red&led=1"
curl "http://localhost:8000/lights/rainbow?led=2"

Documentation

๐Ÿ“– Complete Documentation โ†’

Contributing

๐Ÿ› ๏ธ Contributing Guide โ†’

  • Development environment setup
  • Testing and code quality guidelines
  • Architecture overview and design patterns
  • Pull request process and coding standards

Support

Gratitude

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