busylight-core 2.4.0

Busylight Core Implementation for Humans, presumably like you!

Busylight Core for Humans™

A unified Python library for controlling USB status lights from multiple vendors.

busylight-core provides a consistent interface to control USB LED status lights. If you want a command-line interface or HTTP API, see Busylight for Humans™.

Quick Start

from busylight_core import Light

light = Light.first_light()
light.on((0, 128, 0))   # green
light.off()

Installation

uv add busylight_core

pip install busylight_core

Features

• Multi-vendor support -- 26 devices from 9 vendors
• HID and serial -- multiple connection types
• Async effects -- blink, pulse, rainbow, spectrum
• Multi-LED targeting -- devices with 1-192 individual LEDs
• Input detection -- button press handling on interactive devices
• Extensible -- plugin architecture for adding new devices

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, Bluetooth
MuteMe	MuteMe Original, MuteMe Mini, MuteSync
Plantronics	Status Indicator
ThingM	Blink(1), Blink(1) mk2

Usage

Find and control all connected lights:

from busylight_core import Light

for light in Light.all_lights():
    print(f"{light.name} by {light.vendor}")
    light.on((255, 0, 0))  # red

Vendor-specific access:

from busylight_core import EmbravaLights, LuxaforLights

embrava = EmbravaLights.all_lights()
if embrava:
    embrava[0].on((255, 0, 0))

luxafor = LuxaforLights.all_lights()
for light in luxafor:
    light.on((0, 255, 0))

Async effects:

import asyncio
from busylight_core import Light

light = Light.first_light()
asyncio.run(light.blink(color=(0, 0, 255), speed=1))

Meeting status indicator:

from busylight_core import Light

light = Light.first_light()

light.on((0, 128, 0))    # available (green)
light.on((255, 0, 0))    # in meeting (red)
light.on((255, 255, 0))  # away (yellow)
light.off()

Platform Support

• macOS -- works out of the box
• Linux -- requires udev rules for USB access
• Windows -- may work, untested, patches welcome

Development

This project is part of a uv workspace monorepo. Virtual environment activation is supported via direnv. Development tasks (linting, testing) are automated with Poe the Poet -- run poe for a list of tasks.

See CONTRIBUTING.md for development details.

License

Apache License 2.0