YeelightAPI 1.0.4
See the version list below for details.
dotnet add package YeelightAPI --version 1.0.4
NuGet\Install-Package YeelightAPI -Version 1.0.4
<PackageReference Include="YeelightAPI" Version="1.0.4" />
paket add YeelightAPI --version 1.0.4
#r "nuget: YeelightAPI, 1.0.4"
// Install YeelightAPI as a Cake Addin #addin nuget:?package=YeelightAPI&version=1.0.4 // Install YeelightAPI as a Cake Tool #tool nuget:?package=YeelightAPI&version=1.0.4
YeelightAPI
C# API to control Xiaomi Yeelight Color Bulbs
Prerequisites
The console project uses C# 7.1 "Async Main Method" Feature, make sure your visual studio version is up to date !
Usage
The YeelightAPI.DeviceManager
allows you to connect to a bulb. Just instanciate the manager : DeviceManager manager = new DeviceManager();
and initiate connection to your bulb IP adress : manager.Connect("XXX.XXX.XXX.XXX");
.
Then you can use the manager to control the bulb :
- Power on / off :
manager.SetPower(true);
- Toggle State :
manager.Toggle();
- Change brightness level :
manager.SetBrightness(100);
- Change color :
manager.SetRGBColor(80, 244, 255);
Some methods use an optional parameter named "smooth", it refers to the duration in milliseconds of the effect you want to apply. For a progressive brightness change, use manager.SetBrightness(100, 3000);
.
If you need a method that is not implemented, you can use the folowing methods :
ExecuteCommandWithResponse(METHODS method, int id = 0, List<object> parameters = null, int? smooth = null)
(with response)ExecuteCommand(METHODS method, int id = 0, List<object> parameters = null, int? smooth = null)
(without response).
These methods are generic and use the METHODS
enumeration and a list of parameters, which allows you to call any known method with any parameter.
Event
When you call a method that changes the state of the bulb, it sends a notification to inform that its state really change. You can receive these notification using the "NotificationReceived" Example :
manager.NotificationReceived += (object sender, NotificationReceivedEventArgs arg) =>
{
Console.WriteLine("Notification received !! value : " + JsonConvert.SerializeObject(arg.Result));
};
VNext
- turn into a nuget package
- handle dns host name for bulb discovery
- add device discovery method in the DeviceManager
- add more native methods in the DeviceManager
- correct bugs if needed
Help
If there is a functionality that you need which is not implemented, or even worse if there is a bug, you can create a pull request.
Licence
Apache Licence
Source
This code is an implementation of the "Yeelight WiFi Light Inter-Operation Specification" as defined on January 1st, 2018
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET Framework | net45 is compatible. net451 was computed. net452 was computed. net46 was computed. net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
-
- Newtonsoft.Json (>= 10.0.3)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories (2)
Showing the top 2 popular GitHub repositories that depend on YeelightAPI:
Repository | Stars |
---|---|
RonSijm/ButtFish
Effortlessly transmitting Morse Code of chess moves to your butthole 💝
|
|
isaacrlevin/presencelight
PresenceLight is a solution to broadcast your various statuses to light bulbs.
|
Version | Downloads | Last updated |
---|---|---|
1.11.0-beta-CI-20221212-082524 | 214 | 12/12/2022 |
1.10.2 | 12,966 | 3/21/2021 |
1.10.1 | 1,431 | 2/8/2021 |
1.10.0 | 2,467 | 12/28/2020 |
1.9.0 | 3,871 | 8/11/2020 |
1.8.0 | 1,148 | 7/1/2020 |
1.7.0 | 1,450 | 12/15/2019 |
1.6.0 | 532 | 12/7/2019 |
1.5.2 | 671 | 10/14/2019 |
1.5.1 | 532 | 10/10/2019 |
1.5.0 | 2,508 | 8/25/2018 |
1.4.1 | 837 | 8/7/2018 |
1.4.0 | 1,070 | 7/13/2018 |
1.3.3 | 1,036 | 4/29/2018 |
1.3.2 | 861 | 4/3/2018 |
1.3.1 | 961 | 3/22/2018 |
1.3.0 | 951 | 3/5/2018 |
1.2.3 | 948 | 2/25/2018 |
1.2.2 | 956 | 2/22/2018 |
1.2.1 | 1,043 | 2/15/2018 |
1.2.0 | 979 | 2/15/2018 |
1.1.5 | 994 | 2/9/2018 |
1.1.4 | 940 | 2/7/2018 |
1.1.3 | 928 | 2/4/2018 |
1.1.2 | 861 | 1/28/2018 |
1.1.1 | 856 | 1/28/2018 |
1.1.0 | 959 | 1/27/2018 |
1.0.6 | 994 | 1/7/2018 |
1.0.5 | 1,089 | 1/7/2018 |
1.0.4 | 1,038 | 1/6/2018 |
1.0.2 | 1,003 | 1/3/2018 |
1.0.1 | 975 | 1/3/2018 |
1.0.0 | 990 | 1/3/2018 |
Refactoring and lock during tcp calls to prevent multiple-thread access