Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ollieday/lifx

Library for controlling LIFX Wi-Fi Smart LED devices
https://github.com/ollieday/lifx

csharp dotnet iot library lifx

Last synced: about 20 hours ago
JSON representation

Library for controlling LIFX Wi-Fi Smart LED devices

Awesome Lists containing this project

README 

        
# Lifx

Library for controlling LIFX Wi-Fi Smart LED devices over the LAN.



## Overview

This library allows you to communicate with LIFX devices over the LAN without relying on the LIFX HTTP API.

All communication is done over UDP for low-latency device control using the LIFX LAN Protocol.



See [https://lan.developer.lifx.com/docs](https://lan.developer.lifx.com/docs) for more information about the LIFX LAN

Protocol.



## Getting started

Install the NuGet package into your application.



### Package Manager

```

Install-Package Lifx

```



### .NET CLI

```

dotnet add package Lifx

```



## Device creation

The `LightFactory` class provides functionality for creating `ILight` objects from a given IP address. The `ILight`

object contains the IP address, product (i.e. model) and version of the device and is used for all control operations.



```csharp

var lightFactory = new LightFactory();



using (var light = await lightFactory.CreateLightAsync(IPAddress.Parse("192.168.0.100")))

{

	// ...

}

```



The `LightFactory` class has an overloaded constructor that takes an `int` parameter used to specify the port number

used when communicating with lights. The default port number used with the parameterless constructor is 56700.



```csharp

var lightFactory = new LightFactory(1000);

```



## Device info

Use the overridden `ToString()` method of the `ILight` object to obtain a string representation of the device.



```csharp

Console.WriteLine(light);

```



### Output

`[Address: 192.168.0.100; Product: White800HightVoltage; Version: 0]`



## Device state

Use the `GetStateAsync()` method to retrieve the current state of the device, and the overridden `ToString()` method of

the returned `LightState` object to obtain a string representation of the device containing the label, power,

brightness, temperature and color.



```csharp

var state = await light.GetStateAsync();



Console.WriteLine(state);

```



### Output

`[Label: Office; Power: On; Brightness: 1; Temperature: 3000; Color: [Hue: 0; Saturation: 0]]`



## Device label

Use the `SetLabelAsync()` method of the `ILight` object to set the device label. A label should consist of no more than

32 bytes with UTF8 encoding.



```csharp

await light.SetLabelAsync("Office");

```



## Device power

Light power can be set using `SetPowerAsync(Power)` where the `Power` parameter is an enum with values `Off` and `On`.



```csharp

await light.SetPowerAsync(Power.Off);

await light.SetPowerAsync(Power.On);

```



The methods `OffAsync()` and `OnAsync()` provide the same functionality.



```csharp

await light.OffAsync();

await light.OnAsync();

```



## Device brightness

Light brightness can be set using `SetBrightnessAsync(Percentage)` where the `Percentage` parameter is a `float` between

0 and 1.



```csharp

await light.SetBrightnessAsync(0.5);

```



## Device temperature

Light temperature can be set using `SetTemperatureAsync(Temperature)` where the `Temperature` parameter is an `int`

between 1500 and 9000 representing kelvin value. The `Temperature` struct exposes static properties with named

temperature values.



```csharp

// Set temperature to explicit value

await light.SetTemperatureAsync(3500);



// Set temperature to named value

await light.SetTemperatureAsync(Temperature.Warm);

```



### Named temperature values

* `BlueIce`

* `BlueWater`

* `BlueOvercast`

* `BlueDaylight`

* `CloudyDaylight`

* `BrightDaylight`

* `NoonDaylight`

* `Daylight`

* `SoftDaylight`

* `CoolDaylight`

* `Cool`

* `Neutral`

* `NeutralWarm`

* `Warm`

* `Incandescent`

* `UltraWarm`



## Device color

Light color can be set using `SetColorAsync(Color)` where the `Color` parameter is a struct comprised of hue

(`int` between 0 and 360) and saturation (`float` between 0 and 1). The `Color` struct exposes static properties with

named color values.



```csharp

// Set color to explicit value

await light.SetColorAsync(new Color(180, 0.5));



// Set color to named value

await light.SetColorAsync(Color.Red);

```



### Named color values

* `White`

* `Red`

* `Orange`

* `Yellow`

* `Green`

* `Cyan`

* `Blue`

* `Purple`

* `Pink`



_Note: this method is only applicable to devices that support color. Calling this method on an unsupported device

will result in an `InvalidOperationException` being thrown._



## Device transition duration

The following methods of the `ILight` object have overloads that take a `uint` parameter used to specify the duration in

milliseconds for the transition.



* `SetPowerAsync(Power)`

* `OffAsync()`

* `OnAsync()`

* `SetBrightnessAsync(Percentage)`

* `SetTemperatureAsync(Temperature)`

* `SetColorAsync(Color)`



## Task cancellation

The following methods of the `LightFactory` and `ILight` object have overloads that take a `CancellationToken` parameter

used to cancel a running task.



### LightFactory

* `CreateLightAsync(IPAddress)`



### ILight

* `GetStateAsync()`

* `SetLabelAsync(Label)`

* `SetPowerAsync(Power)`

* `OffAsync()`

* `OnAsync()`

* `SetBrightnessAsync(Percentage)`

* `SetTemperatureAsync(Temperature)`

* `SetColorAsync(Color)`



_Note: all requests will be cancelled if the device does not respond after 5 seconds._