HADotNet.Entities
0.1.2
dotnet add package HADotNet.Entities --version 0.1.2
NuGet\Install-Package HADotNet.Entities -Version 0.1.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="HADotNet.Entities" Version="0.1.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add HADotNet.Entities --version 0.1.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: HADotNet.Entities, 0.1.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install HADotNet.Entities as a Cake Addin #addin nuget:?package=HADotNet.Entities&version=0.1.2 // Install HADotNet.Entities as a Cake Tool #tool nuget:?package=HADotNet.Entities&version=0.1.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
HADotNet.Entities
A wrapper around the excellent HADotNet.Core REST api by @qJake with strongly typed Entity classes
Features
- .NET Standard 2.0 cross-platform library
- DI-friendly initialization
- Home Assistant entities represented by strongly typed C# classes
- Strongly typed methods (TurnOn, TurnOff etc.)
- Strongly typed attributes (climate.CurrentTemperature, mediaPlayer.IsMuted etc.)
Does NOT (yet?) include
- Websockets or any real-time update strategy
Currently (partially) implemented HA domains
- binary_sensor
- climate (TurnOn, TurnOff, SetTemperature, SetHvacMode)
- light (TurnOn, TurnOff, Toggle)
- switch
- media_player (TurnOn, TurnOff, Toggle, SelectSource, Play, Pause, Stop, Mute, VolumeUp, VolumeDown, VolumeSet)
- sensor
- switch (TurnOn, TurnOff, Toggle)
Example usage
Initialization
// Initialize the HADotNet.Core clients
ClientFactory.Initialize("https://my-ha-instance.duckdns.org", "long-lived-access-token");
var entityClient = ClientFactory.GetClient<EntityClient>();
var statesClient = ClientFactory.GetClient<StatesClient>();
// Initialize an instance of the EntitiesService
var entitiesService = new EntitiesService(entityClient, statesClient);
Toggle a light
// Get all light entities
var lights = await entitiesService.GetEntities<Light>();
// Turn on all lights
await Task.WhenAll(lights.Select(light => light.TurnOn()));
Set the temperature of a climate entity
// Get a single climate entity
var climate = await entitiesService.GetEntity<Climate>("living_room"); // climate.living_room
Console.WriteLine($"Current target temperature: {climate.Temperature}");
await climate.SetTemperature(20);
Console.WriteLine($"New target temperature: {climate.Temperature}");
Explicitly sync an entity after 10 seconds
var light = await entitiesService.GetEntity<Light>("living_room"); // light.living_room
Thread.Sleep(10000);
await light.Update();
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.0
- HADotNet.Core (>= 1.5.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
0.1.2 | 666 | 2/18/2021 |