Crate luxafor

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

The main entry point for clients is the trait Device that has implementations for USB connected devices such as the flag as well as webhooks for both the flag and bluetooth lights.

Each connection has its own discovery or connection methods but will provide a Device implementation for the manipulation of the light state.

API Examples

The following example shows a function that sets the light to a solid red color. It demonstrates the use of a USB connected device.

use luxafor::usb_hid::USBDeviceDiscovery;
use luxafor::{Device, SolidColor};
use luxafor::error::Result;

fn set_do_not_disturb() -> Result<()> {
    let discovery = USBDeviceDiscovery::new()?;
    let device = discovery.device()?;
    println!("USB device: '{}'", device.id());
    device.set_solid_color(SolidColor::Red, false)
}

The following shows the same function but using the webhook connection.

use luxafor::webhook::new_device_for;
use luxafor::{Device, SolidColor};
use luxafor::error::Result;

fn set_do_not_disturb(device_id: &str) -> Result<()> {
    let device = new_device_for(device_id)?;
    println!("Webhook device: '{}'", device.id());
    device.set_solid_color(SolidColor::Red, false)
}

CLI 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.3.0

• Build: Updated dependency versions.
• Refactor: Using own, explicit, Error type.

Version 0.2.2

• Documentation: Added HID specification documents to the usb_hid module.
• Feature: Added new Wave enum
• Feature: Added new methods to Device.
  • Fully supported on USB HID,
  • Not all are supported on webooks.
• Feature: Added new TargetedDevice trait and USB implementation.

Version 0.2.1

• Feature: Removed the DeviceIdentifier trait, and Device now returns a String.

Version 0.2.0

• Refactor: To provide a new Device trait
• Feature: Implemented the trait for webhook connected lights
• Feature: 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.