Simple.HAApi 1.1.4

dotnet add package Simple.HAApi --version 1.1.4
NuGet\Install-Package Simple.HAApi -Version 1.1.4
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="Simple.HAApi" Version="1.1.4" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Simple.HAApi --version 1.1.4
#r "nuget: Simple.HAApi, 1.1.4"
#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 Simple.HAApi as a Cake Addin
#addin nuget:?package=Simple.HAApi&version=1.1.4

// Install Simple.HAApi as a Cake Tool
#tool nuget:?package=Simple.HAApi&version=1.1.4


A simple c# Home-Assistant library

Simple.HAApi: NuGet

Simple.HAMQTT: NuGet

What is?

This is a C# library to interact with HomeAssitant

Home-Assitant has a developer docs webpage, but with almost nothing in it.
There are only some endpoints (eg the api/stream is not documented) with no model specification

Some (almost none) source documentation:

How do I use it?

  1. Create an Instance
var instance = new Instance(new Uri(""), yourToken);
// You can ignore SSL errors if needed:
instance.IgnoreCertificatErrors = true;
  1. Basic diagnostics
bool isRunning = await instance.CheckRunningAsync();
string myErrors = await instance.ErrorLogsAsync();
  1. Get configuration data
// Get a source
var cfgSource = instance.Get<Simple.HAApi.Sources.Configuration>();
// Get info as needed
var config = await cfgSource.GetConfigurationAsync();
var entries = await cfgSource.GetConfigurationEntriesAsync();
  1. Get entity states
// Get a source
var statesSource = instance.Get<Simple.HAApi.Sources.States>();
// Get info as needed
var sun = await statesSource.GetStateAsync("sun.sun");
var all = await statesSource.GetStatesAsync();
  1. Get information from and call Services
// Get a source
var srvSource = instance.Get<Simple.HAApi.Sources.Service>();
// Get all services
var services = await srvSource.GetServicesAsync();
// Or call a service for a single entity
await srvSource.CallService(Service.Light.TurnOn, "");
// or multiple
await srvSource.CallService(Service.Light.TurnOn, "switch.office1", "switch.office2", ..., "switch.officeN");
  1. Get a continuous stream of events
// Get a source
var eventSource = instance.Get<Simple.HAApi.Sources.Events>();
// Get a cancellation token to stop the process anytime
var canSource = new CancellationTokenSource();
eventSource.OnNewEvent += (s, e) =>
    Console.WriteLine($" {e}");
var t = eventSource.CollectEventsAsync(canSource.Token);
Product 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.

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
1.1.4 127 1/4/2024
1.1.3 296 4/1/2023
1.1.2 197 4/1/2023
1.1.1 186 3/23/2023
1.1.0 401 7/13/2022
1.0.5 407 7/13/2022
1.0.4 396 6/14/2022
1.0.3 384 6/5/2022
1.0.2 383 6/3/2022
1.0.1 392 6/3/2022
1.0.0 385 6/2/2022