Skip to main content

A Python based CLI to control Elgato Keylights

Project description

keylight-cli

A Python CLI module designed to control the Elgato brand Lights. Use this when you want a simple command line to control your keylight. Currently only tested with a Keylight Air.

This was originally created for my purposes, allowing me to control a Keylight Air using a Stream Deck under Linux (using the python streamdeck-ui module)

Dependencies

This uses the excellent leglight python module, and wraps it in a very simple CLI tool.

Usage

The CLI supports multiple keylights on a single network. You can target a specific light with a -s <serial number> parameter before any command. If no serial number is provided, then the CLI will use the first one found on the network (not necessarily guaranteed to be the same one each time). For best results, specify the serial number if you have multiple keylights to control

Run the command without any arguments to see the help

List

% keylight list
Found 1 lights
Light <SERIAL> at <IP>:<PORT>

Info

% keylight info
Getting information from <SERIAL>
Light <SERIAL> at <IP>:<PORT>
State             : ON
Brightness        : 10 %
Color Temperature : 4300.0 K

Control

% keylight on
Turning on <SERIAL>
% keylight off
Turning off <SERIAL>

Brightness

% keylight set-brightness 50
Setting brightness for <SERIAL> to 50%

Color Temperature

% keylight set-color-temperature 5000
Setting color temperature for <SERIAL> to 5000K

License

MIT

Copyright

Elgato, Key Light and other product names are copyright of their owner, CORSAIR.

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-cli-0.1.3.tar.gz (3.5 kB view details)

Uploaded Source

Built Distribution

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

keylight_cli-0.1.3-py3-none-any.whl (3.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: keylight-cli-0.1.3.tar.gz
  • Upload date:
  • Size: 3.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.4 Linux/5.13.0-39-generic

File hashes

Hashes for keylight-cli-0.1.3.tar.gz
Algorithm Hash digest
SHA256 a8d2619c77983869a05a2529c4884b537515997c90dd96b50a651caeeef17866
MD5 9f6e35011433a0b160be8936568a8134
BLAKE2b-256 a8448a00b37394e0b8531a7e211e80fb21c738cc3db6da69fdfa987db539ca5e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: keylight_cli-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 3.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.4 Linux/5.13.0-39-generic

File hashes

Hashes for keylight_cli-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ed12781d04d911190daaacb29946b0f31141a31db53f762abdd2b822a768eed8
MD5 68156a6ed3f3c8855d7b20f84bd13e9b
BLAKE2b-256 6a09575313c80e594581c8a605661d91455099e4f575f8c538cd42f9bd2b750d

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