lifx library

Lifx-Library

C# .NET Standard Library to control the Lifx smart LED bulbs over the cloud

This project is a wrapper library that contains functionalities from the official Lifx API https://api.developer.lifx.com/reference/introduction

Use

Get the token key https://cloud.lifx.com/settings

Toggle Methods

Create an instance from the LifxBulbs class by providing the TOKENAPIKEY and the label name of the LED bulb as parameters.

using LifxLibrary;

LifxBulbs bedroom = new LifxBulbs("tokenKey", "Bedroom");

//synchronous
bedroom.LightToggle(3); //toggle with 3 seconds duration

//async
await bedroom.LightToggleAsync(3); //async toggle with 3 seconds duration

NOTE

It is not obligatory to specify a label name in the class constructor when using the SweepToggle methods. These methods will execute a general toggle operation across all connected devices.

using LifxLibrary;

LifxBulbs devices = new LifxBulbs("tokenKey");

//synchronous
devices.SweepToggle();

//async
await devices.SweepToggleAsync();

Power Methods

The PutPower methods allow you to change the state of the bulbs, setting them to either on or off, and providing an optional duration time parameter ranging from 0 to 100 seconds.

using LifxLibrary;

LifxBulbs bedroom = new LifxBulbs("tokenKey", "Bedroom");

//synchronous
bedroom.PutPower("on");

bedroom.PutPower("off");

bedroom.PutPower("on", 5); //with 5 seconds duration time

//async
await bedroom.PutPowerAsync("off");

Brightness Methods

The PutBrightness methods takes an integer parameter ranging from 0 to 100 to set the intensity of the brightness.

using LifxLibrary;

LifxBulbs bedroom = new LifxBulbs("tokenKey", "Bedroom");

//synchronous
bedroom.PutBrightness(50); //set the brightness at 50%

//async
await bedroom.PutBrightnessAsync(50);

Color Methods

The PutColor methods can receive a series of string values as parameter to define the color, brightness, saturation, and other attributes.

using LifxLibrary;

LifxBulbs bedroom = new LifxBulbs("tokenKey", "Bedroom");

//hexadecimal
bedroom.PutColor("#0000FF"); //blue color

//RGB
bedroom.PutColor("rgb:255,0,0"); //red color

//plain text
bedroom.PutColor("white"); //white color

//async
await bedroom.PutColorAsync("hue:120 saturation:1.0 brightness:0.5"); //Deep green 50% brightness

For a more detailed guide on defining colors, please visit the official Lifx API documentation at https://api.developer.lifx.com/reference/colors.

MultiUse Methods

The MultiUse methods accept a set of optional parameters to carry out diverse actions on the LED bulbs, such as changing the color, brightness, power, duration time, and activating fast mode.

NOTE

The fast mode execute the query fast, without initial state checks and wait for no results.

using LifxLibrary;

LifxBulbs bedroom = new LifxBulbs("tokenKey", "Bedroom");

//synchronous
bedroom.MultiUse("on", "blue", 50, 6, true); //power on, color blue, 50% brightness, 6 seconds duration with fast mode activated

//other ways to use it
bedroom.MultiUse(power:"on", color:"blue", brightness:100, duration:6, fast:true);

//duration time is 0 by default and fast mode is false by default
bedroom.MultiUse(power:"on", color:"white", brightness:80); 

//async
await bedroom.MultiUseAsync("off");

await bedroom.MultiUseAsync("on", "orange");

The LightSearcher class

LightSearcher Methods

The LightSearcher class is a static class that contains static async methods that helps to discover the LED bulbs and retrieve their properties such as LED bulb name, power status, connection status, brightness level, saturation level and more.

ShowConnectedDevicesAsync()

The ShowConnectedDevicesAsync method returns a list of string object with the label names of all connected devices.

using LifxLibrary;

//set the tokenkey
LightSearcher.SetTokenKey("tokenkey");

var devices = await LightSearcher.ShowConnectedDevicesAsync();

foreach(var device in devices)
{
    Console.WriteLine(device);
}

GetNamesAsync()

The GetNamesAsync method returns a list of string object with the label names of all devices linked to your account, regardless of their connection status or power status.

using LifxLibrary;

//set the tokenkey
LightSearcher.SetTokenKey("tokenkey");

var devices = await LightSearcher.GetNamesAsync();

foreach(var device in devices)
{
    Console.WriteLine(device);
}

ShowStateAsync()

The ShowStateAsync method returns a BulbState object with the power status, connection status, LED label name, brightness level, saturation level, UUID, ID, and HUE level.

using LifxLibrary;

//set the tokenkey
LightSearcher.SetTokenKey("tokenkey");

BulbState bedroom = await LightSearcher.ShowStateAsync("Bedroom");

Console.WriteLine(bedroom.Power); //the response would be off or on

Console.WriteLine(bedroom.Connected); //the response would be true or false

Console.WriteLine(bedroom.Brightness); //brightness level

Console.WriteLine(bedroom.Saturation); //saturation level

Console.WriteLine(bedroom.Id); //bulb ID

The LightGroup class

The LightGroup class contains methods to control a set of LED bulbs that belong in a specific group.

NOTE

Async and Synchronous methods available in the LightGroup class.

Toggle methods Brightness methods Color methods MultiUse methods

using LifxLibrary;

LightGroup bulbs = new LightGroup("tokenKey", "Kitchen"); //tokenKey and group name

bulbs.SweepToggle();

await bulbs.PutColorAsync("blue");

Please report any bugs [email protected]