5 releases (stable)
1.1.2 | Mar 14, 2024 |
---|---|
1.1.1 | Mar 12, 2024 |
1.1.0 | Feb 24, 2024 |
1.0.0 | Feb 20, 2024 |
0.3.0 | Feb 12, 2024 |
#2 in #glow
39 downloads per month
35KB
723 lines
litra-rs
💡 Control your Logitech Litra light from the command line
Features
With this tool, you can:
- Turn your light on and off
- Check if the light is on or off
- Set and get the brightness of your light
- Set and get the temperature of your light
- Automatically turn the light on and off when your webcam turns on or off (Linux only)
Supported devices
The following Logitech Litra devices, connected via USB, are supported:
Installation
macOS with Homebrew
- Install the latest version by running
brew tap timrogers/tap && brew install litra
. - Run
litra --help
to check that everything is working and see the available commands.
All other platforms (using Cargo)
- Install Rust on your machine, if it isn't already installed.
- Install the
litra
crate by runningcargo install litra
. - Run
litra --help
to check that everything is working and see the available commands.
All other platforms (via binary)
- Download the latest release for your platform. macOS, Linux and Windows devices are supported.
- Add the binary to
$PATH
, so you can execute it from your shell. For the best experience, call itlitra
on macOS and Linux, andlitra.exe
on Windows. - Run
litra --help
to check that everything is working and see the available commands.
Configuring udev
permissions on Linux
On most Linux operating systems, you will need to manually configure permissions using udev
to allow non-root
users to access and manage Litra devices.
To allow all users that are part of the video
group to access the Litra devices, copy the 99-litra.rules
file into /etc/udev/rules.d
.
Next, reboot your computer or run the following commands as root
:
# udevadm control --reload-rules
# udevadm trigger
Usage
From the command line
The following commands are available for controlling your devices:
litra on
: Turn your Logitech Litra device onlitra off
: Turn your Logitech Litra device offlitra toggle
: Toggles your Logitech Litra device on or offlitra brightness
: Sets the brightness of your Logitech Litra device, using either--value
(measured in lumens) or--percentage
(as a percentage of the device's maximum brightness). The brightness can be set to any value between the minimum and maximum for the device returned by thedevices
command.litra temperature
: Sets the temperature of your Logitech Litra device, using a--value
measured in kelvin (K). The temperature be set to any multiple of 100 between the minimum and maximum for the device returned by thedevices
command.litra auto-toggle
(Linux only): Automatically turns your Logitech Litra device on when your webcam starts capturing video, and off when it stops capturing video. This command should be left running in the background.
All of the these commands support a --serial-number
/-s
argument to specify the serial number of the device you want to target. If you only have one Litra device, you can omit this argument. If you have multiple devices, we recommend specifying it. If it isn't specified, the "first" device will be picked, but this isn't guaranteed to be stable between command runs.
The following commands are also included:
litra devices
: List Logitech Litra devices connected to your computer. This will be returned in human-readable format by default, or you can get JSON output with the--json
flag.
Each CLI command can also be called with --help
for more detailed documentation.
From a Rust application
The litra
crate includes functions for interacting with Litra devices from your Rust applications.
To see the full API, check out the documentation on Docs.rs or read through src/lib.rs
.
Dependencies
~0.4–11MB
~73K SLoC