Home

Welcome to the ha-kafka-net wiki and official documentation for HaKafkaNet.

Documentation is currently being updated to reflect version 5.5.

Practical Examples and Information

Getting Started - Provides information on setting up your environment.
Tutorial: Creating Automations - Once you're up and running, this page will help you create automations.
State Extension Methods - Access your strongly typed properties in automations and make the mundane easy.
Entity Provider Extension Methods - Retrieve strongly typed entities from cache or Home Assistant
Utility classes - Helper classes and enums to ease development
Tips and Tricks - Build with confidence.

Automation Metadata - Add information to your automations to help you manage them.
Automation Registry - Used for registering all automations with the framework.
Automation Types - Detailed information about various types of automations.
Configuration - Configuring your environment.
Data Persistence - How HaKafkaNet stores data.
Entity States - Working with state
Event Timings - Control startup behavior
Helper services - Interacting with Home Assistant
System Monitor - Global exception handling and monitoring non-responsive entities
Tracing - Observability through tracing. Configure log tracing to get the most benefit.

Durable Automations - Scheduled automations that survive restarts.
Parallelism and threads - Understand how tasks are scheduled.
Automated Testing - Information about unit testing and component testing with the Test Harness
Scheduling - Working with scheduling automations
UI - Information about the dashboard