max/rofaxul
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Fork of luxafor-rs with modern libs
9 Commits 1 Branch 0 Tags 76 KiB
Rust 100%
636a1722f8
Go to file
Simon Johnston 636a1722f8 Added repository and documentation links
2020-08-18 12:04:12 -07:00
.github/workflows Initial commit. 2020-08-17 16:06:18 -07:00
.idea Initial commit. 2020-08-17 16:06:18 -07:00
src Gated test case to work in CI 2020-08-18 12:00:21 -07:00
.gitignore Initial commit. 2020-08-17 16:06:18 -07:00
Cargo.toml Added repository and documentation links 2020-08-18 12:04:12 -07:00
LICENSE Initial commit. 2020-08-17 16:06:18 -07:00
README.md Refactored to support multiple Device implementations. 2020-08-18 11:59:11 -07:00

README.md

Crate luxafor

Library, and CLI, for Luxafor lights via webhooks or USB.

Rust Minimum Rust Version crates.io docs.rs MIT License GitHub stars

This has been tested with the USB connected flag as well as the Bluetooth lights.

Examples

The following shows the command line tool setting the color to red.

❯ 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.

❯ export LUX_DEVICE=2a0f2c73b72
❯ lux blink green

The following shows the command line tool turning the light off.

❯ 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.