Home

Official Documentation

Image of dashboard

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.
Best Practices - Learnings from the creator's experience.

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 for automations. See also Startup Routines
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.
Updating Entity Provider - Get access to entities that automatically update as Home Assistant reports state changes.

Automated Testing - Information about unit testing and component testing with the Test Harness
Durable Automations - Scheduled automations that survive restarts.
Open Telemetry - Send metric and trace information to the telemetry system of your choosing
Parallelism and threads - Understand how tasks are scheduled.
Scheduling - Working with scheduling automations
Startup Routines - Detailed information about how HaKafkaNet starts
Tutorial (advanced) - Working with long running automations and cancellation tokens
UI - Information about the dashboard