Reefact.LuxaforLightingDeviceController 2.0.1

Version française - Nederlandse versie - Svensk version - Deutsche Version - Versión española - Ελληνική έκδοση - Wersja polska

Luxafor Device Controller

Drive your Luxafor availability indicators from your own .NET applications, speaking their USB HID protocol directly: no Luxafor server, no webhook, no third-party software to install.

• A direct API: SetColor, FadeColor, Strobe, PlayPattern, down to driving one LED at a time.
• .NET Standard 2.0 and .NET Framework 4.6.2, for a single dependency (HidLibrary).
• Windows only: the devices are driven through the Windows HID stack. The package installs on any platform, but the devices can only be enumerated and controlled on Windows.

Installation

dotnet add package Reefact.LuxaforLightingDeviceController

Quick start

using System.Linq;

using Reefact.LuxaforLightingDeviceController;

namespace MyApplication {

    public static class BuildStatusLight {

        public static void Show(bool buildSucceeded) {
            using ILuxaforDevice device = Luxafor.GetDevices().First();

            if (buildSucceeded) {
                device.SetColor(BrightColor.Green);
            } else {
                device.Strobe(BrightColor.Red, Speed.FromByte(20), Repeat.Count(3));
            }
        }

    }

}

Luxafor.GetDevices() enumerates the Luxafor devices plugged into the USB ports of the machine; the enumeration is empty when none is plugged in. ILuxaforDevice implements IDisposable: the using statement releases the device handle at the end of the block. Every command returns a bool: true when the device accepted the command, false when the write failed.

Compatible devices

The library drives, through their USB HID protocol, the Luxafor devices identified by the vendor id 1240 (0x04D8) and the product id 62322 (0xF372).

Feedback about an untested device is very welcome: please open an issue.

Features

• Solid color (SetColor) from a named color, a hexadecimal code or red / green / blue components.
• Fade (FadeColor) to a color, over a chosen transition duration.
• Strobe (Strobe) at a chosen speed and for a chosen number of repetitions.
• Patterns (PlayPattern): colored waves, or patterns built into the device (Police, Rainbow, TrafficLight, ...).
• Turning off (TurnOff), all the LEDs or only some of them.
• LED targeting: all of them, one side (TabSide, BackSide) or a single LED (Led_1 to Led_6).
• Reusable commands: LightingCommand describes a command once, to replay it later with Send.

Detailed documentation

• API reference: every command, its parameters and its errors.
• Luxafor, the company and its devices: what these indicators are for, and which ones this library drives.
• Changelog and contributing guide.

License

This library is distributed under the Apache-2.0 license.