👁 Image
HaKafkaNet 11.3.0

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 testable with automated tests

Why ha-kafka-net ?

• Strongly typed access to entities
• Strongly typed automations
• 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
  • ISystemMonitor
  • Tracing with log capturing
  • Open Telemetry Instrumentation
• Pre-built automations
• Extensible framework - create your own reusable automations
  • Extend automation factory with extension methods
  • Create your own automations from scratch
• Automation builder with fluent syntax for quickly creating automations.
• Full unit testability for custom automations and integration testing for all registered integrations.
• 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.