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

poetry shell

poetry build

poetry run keylight --on

poetry version patch
poetry publish

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.3.tar.gz (4.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

keylight-0.1.3-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

Details for the file keylight-0.1.3.tar.gz.

File metadata

  • Download URL: keylight-0.1.3.tar.gz
  • Upload date:
  • Size: 4.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.12.2 Linux/6.8.0-11-generic

File hashes

Hashes for keylight-0.1.3.tar.gz
Algorithm Hash digest
SHA256 cd077ec58ddf4d0bb225b500e7eb315b8a6be016516f3c8f6f0d07949894b788
MD5 11a44c0f19a8af58eb08014cec22c6fe
BLAKE2b-256 1dc1b2dfafce3f2fac1163ef98776ff48d4c4c38c82a8a0ee2ae006bcbb01d23

See more details on using hashes here.

File details

Details for the file keylight-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: keylight-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 5.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.12.2 Linux/6.8.0-11-generic

File hashes

Hashes for keylight-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f82eb4b4602eb874fd4d24f7a60c3e7ab2d5987839804071d8145881c0cf7a8a
MD5 478a8f9cea4a8ad41420decf149d125b
BLAKE2b-256 b6c2e307ed6fa1468dfd85b594922d8fc418b89705079a5c4136491c955d070f

See more details on using hashes here.

Supported by

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