HADotNet.Entities 0.1.2

.NET Standard 2.0
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
#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

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

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
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48 net481
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

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 358 2/18/2021