HADotNet.Entities 0.1.2

A Home Assistant library for .NET Standard to make use of strongly typed Home Assistant entities.

Install-Package HADotNet.Entities -Version 0.1.2
dotnet add package HADotNet.Entities --version 0.1.2
<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, C# scripting and .NET Interactive. 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

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();

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();

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
0.1.2 73 2/18/2021