60 lines
2.0 KiB
Markdown
60 lines
2.0 KiB
Markdown
# Crate luxafor
|
||
|
||
Library, and CLI, for [Luxafor](https://luxafor.com/products/) lights via webhooks or USB.
|
||
|
||
|
||
|
||
[](https://crates.io/crates/luxafor)
|
||
[](https://docs.rs/luxafor)
|
||
|
||
[](https://github.com/johnstonskj/rust-luxafor/stargazers)
|
||
|
||
This has been tested with the USB connected [flag](https://luxafor.com/flag-usb-busylight-availability-indicator/)
|
||
as well as the [Bluetooth](https://luxafor.com/bluetooth-busy-light-availability-indicator/) lights.
|
||
|
||
## Examples
|
||
|
||
The following shows the command line tool setting the color to red.
|
||
|
||
```bash
|
||
❯ lux -d 2a0f2c73b72 solid red
|
||
```
|
||
|
||
The following shows the command line tool setting the color to a blinking green. This example uses the environment
|
||
variable `LUX_DEVICE` to save repeating the device identifier on each call.
|
||
|
||
```bash
|
||
❯ export LUX_DEVICE=2a0f2c73b72
|
||
❯ lux blink green
|
||
```
|
||
|
||
The following shows the command line tool turning the light off.
|
||
|
||
```bash
|
||
❯ lux -vvv -d 2a0f2c73b72 off
|
||
INFO luxafor > Setting the color of device '2a0f2c73b72e' to 000000
|
||
INFO luxafor > call successful
|
||
```
|
||
|
||
## Features
|
||
|
||
* **command-line**; provides the command line tool `lux`, it is not on by default for library clients.
|
||
* **usb**; provides access to USB connected devices.
|
||
* **webhook** (default); provides access to USB, or Bluetooth, devices via webhooks.
|
||
|
||
## Changes
|
||
|
||
**Version 0.2.0**
|
||
|
||
* Refactored to provide a new `Device` trait
|
||
* Implemented the trait for webhook connected lights
|
||
* Added a new implementation for HID connected lights
|
||
|
||
**Version 0.1.0**
|
||
|
||
* Initial commit, supports flag and bluetooth lights.
|
||
|
||
|
||
## TODO
|
||
|
||
* The webhook API is not as rich as the USB, need to find a way to manage this. |