Simple.HAApi
1.0.5
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package Simple.HAApi --version 1.0.5
NuGet\Install-Package Simple.HAApi -Version 1.0.5
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.0.5" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Simple.HAApi --version 1.0.5
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Simple.HAApi, 1.0.5"
#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.0.5 // Install Simple.HAApi as a Cake Tool #tool nuget:?package=Simple.HAApi&version=1.0.5
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Simple.HA
A simple c# Home-Assistant library
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: https://developers.home-assistant.io/docs/api/rest/
How do I use it?
- Create an Instance
var instance = new Instance(new Uri("https://myHA.io:8123"), yourToken);
- Basic diagnostics
bool isRunning = await instance.CheckRunningAsync();
string myErrors = await instance.ErrorLogsAsync();
- 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();
- 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");
// Or get EVERYTHING
var all = await statesSource.GetStatesAsync();
- 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
await srvSource.CallServiceForEntities("switch.turn_on", "switch.office");
- 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();
// Get the enumerable
var stream = eventSource.GetEvents(canSource.Token);
// Show data
Console.WriteLine("Continuous stream of events");
foreach(var e in stream)
{
Console.WriteLine($" {e}");
}
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
- Simple.API (>= 1.5.2)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.