Skip to main content

A CLI to control an Elgato Key Light

Project description

Keylight

A CLI to control an Elgato Key Light for Linux, macOS, and Windows.

Leverages the pyleglight library.

Requirements

  • Python >= 3.6

Installation

Keylight can be downloaded from pypi.org.

pip3 install keylight

Usage

$ keylight
usage: keylight [-h] [-b BRIGHTNESS] [-c COLOR] [--host HOST] [--on] [--off]

A CLI to control an Elgato Key Light

optional arguments:
  -h, --help            show this help message and exit
  -b BRIGHTNESS, --brightness BRIGHTNESS
                        0 <= brightness <= 100
  -c COLOR, --color COLOR
                        2900 <= color temperature <= 6987
  --host HOST           hostname of the Key Light (omit to use auto-discovery)
  --on                  turn the Key Light on
  --off                 turn the Key Light off

Examples

$ keylight --brightness 45 --color 5500 --on
Auto-discovering Key Light ...
Connected to: Elgato Light @ 192.168.1.100:9123
Brightness: 45%
Color: 5500k
Turning On

$ keylight --host=keylight --off
Connected to: Elgato Light @ keylight:9123
Turning Off

Aliases

You may find it convenient to use shell aliases:

alias koff='keylight --host keylight --off'
alias kon='keylight --host keylight --on'

Example usage:

# Turn on and set brightness to 20%
$ kon -b20
Connected to: Elgato Light BW42J1A06055 @ keylight:9123
Brightness: 20%
Turning On

Developing

# Initialize venv
python3 -m venv .venv
source .venv/bin/activate

# Build
pip3 install --upgrade build
python3 -m build
pip3 install --upgrade dist/*.whl

# If the version hasn't changed, then specify --force-reinstall
pip3 install --upgrade --force-reinstall dist/*.whl

# Run
python3 -m keylight.main --on

# Publish
pip3 install twine
twine upload dist/*

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

keylight-0.1.0.tar.gz (4.2 kB view hashes)

Uploaded Source

Built Distribution

keylight-0.1.0-py3-none-any.whl (5.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page