HaKafkaNet 10.1.0

Prefix Reserved

There is a newer version of this package available.
See the version list below for details.

dotnet add package HaKafkaNet --version 10.1.0

NuGet\Install-Package HaKafkaNet -Version 10.1.0

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="HaKafkaNet" Version="10.1.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add HaKafkaNet --version 10.1.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: HaKafkaNet, 10.1.0"

#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 HaKafkaNet as a Cake Addin
#addin nuget:?package=HaKafkaNet&version=10.1.0

// Install HaKafkaNet as a Cake Tool
#tool nuget:?package=HaKafkaNet&version=10.1.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

HaKafkaNet

A framework for creating Home Assistant automations in .NET and C#.

Kafka ensures automations are durable and state is restored between restarts.

It was created with the following goals:

Create Home Assistant automations in .NET / C# with abilities to:
- track/retrieve states of all entities in Home Assistant
- respond to Home Assistant state changes
- call Home Assistant RESTful services
Enable all automation code to be fully unit testable

Why ha-kafka-net ?

Strongly typed access to entities
Durable - Automations that survive restarts. See also Event Timings
Fast - Automations run in parallel and asynchronously.
UI to manage your automations and inspect Kafka consumers.
Observability through
Pre-built automations
Extensible framework - create your own reusable automations
- Extend automation factory with extension methods
- Create your own automamtions from scratch
Automation builder with fluent syntax for quickly creating automations.
Full unit testability and componet level testing with Test Harness
MIT license

Example

Example of multiple durable automations. See Tutorial for more examples.

registrar.TryRegister(
    _factory.SunRiseAutomation(
        cancelToken => _api.TurnOff("light.night_light", cancelToken)),
    _factory.SunSetAutomation(
        cancelToken => _api.TurnOn("light.night_light", cancelToken),
        TimeSpan.FromMinutes(-10))
);

See Documentation for full details.

Product	Compatible and additional computed target framework versions.
.NET	net8.0 is compatible. 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.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net8.0
- FastEndpoints (>= 5.29.0)
- KafkaFlow (>= 3.0.10)
- KafkaFlow.Admin (>= 3.0.10)
- KafkaFlow.Admin.Dashboard (>= 3.0.10)
- KafkaFlow.Admin.WebApi (>= 3.0.10)
- KafkaFlow.Extensions.Hosting (>= 3.0.10)
- KafkaFlow.LogHandler.Console (>= 3.0.10)
- KafkaFlow.LogHandler.Microsoft (>= 3.0.10)
- KafkaFlow.Microsoft.DependencyInjection (>= 3.0.10)
- KafkaFlow.Serializer.JsonCore (>= 3.0.10)
- Microsoft.Extensions.Configuration.Binder (>= 8.0.2)
- NLog (>= 5.3.4)
- NLog.Web.AspNetCore (>= 5.3.14)
- OpenTelemetry (>= 1.9.0)

NuGet packages (1)

Showing the top 1 NuGet packages that depend on HaKafkaNet:

Package	Downloads
HaKafkaNet.TestHarness A library containing test helpers for HaKafkaNet.	2.4K

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on HaKafkaNet:

Repository	Stars
leosperry/ha-kafka-net Integration that uses Home Assistant Kafka integration for creating home automations in .NET and C#	125