Domovoy Documentation

Welcome to the Domovoy documentation! Domovoy is a Python-based automation framework for Home Assistant, built from the ground up with modern async/await patterns.

Note

Domovoy is designed for users who prefer writing home automations in pure Python rather than YAML, Node Red, or n8n, providing a more flexible and developer-friendly approach.

Key Features

• ServEnts Integration: Create Home Assistant devices and entities directly from Python code

• Type Safety: Full typing support including auto-generated type stubs for Home Assistant entities and services

• Hot Reload: Automatic file watching and module reloading during development

• High Performance: Leverages Python’s async/await for efficient, non-blocking operations

• Plugin Architecture: Access functionality through well-designed plugins

Contents

Getting Started

• Getting Started
  • Prerequisites
  • Installation
  • Quickest Start
  • Quick Start with Docker
  • Next Steps
• Creating Your First App
  • App Structure
  • Basic App Template
  • File Naming Convention
  • Available Plugins
  • A Complete Example
  • Registering Multiple Instances
  • App Lifecycle
  • Best Practices
  • Next Steps
• Configuration Reference
  • Required Settings
  • Optional Settings
  • Astral Configuration
  • Logging Configuration
  • Complete Example
  • Command Line Options
  • Next Steps

Guides

• Guides
  • Plugin Guides
  • Development Guides
  • Quick Reference
• Callbacks Plugin Guide
  • Event Listening
  • Scheduling
  • Canceling Callbacks
  • Extended Callbacks
  • Best Practices
• Home Assistant Integration Guide
  • Reading Entity State
  • Calling Services
  • Automation Triggers
  • Firing Events
  • Waiting for State
  • Finding Entities
  • Entity ID Typing
  • Development Helpers
  • Advanced: Raw Commands
  • Best Practices
• ServEnts Guide
  • Overview
  • Creating Entities
  • Entity State Management
  • Device Configuration
  • Concurrent Entity Creation
  • Diagnostic Entities
  • Entity Categories
  • Best Practices
• State Management Guide
  • State Caching
  • State vs Attributes
  • State Types
  • Checking State Duration
  • Waiting for State
  • Listening to State Changes
  • Entity Lookup
  • Working with Typed States
  • State Patterns
  • Best Practices
• Type Stubs Configuration
  • Overview
  • Installation
  • Using the Generated Types
  • Stub Updater Configuration
  • Troubleshooting
  • Next Steps
• Hot Reload Guide
  • How Hot Reload Works
  • Development Workflow
  • Making Apps Reload-Safe
  • Dependency Tracking
  • Reload Triggers
  • Debugging Reloads
  • Common Issues
  • Best Practices
  • Production Considerations
• Mixins Guide
  • What Are Mixins?
  • Creating a Mixin
  • Mixin Patterns
  • Best Practices
• Installing Additional Dependencies
  • Enabling Dependency Installation
  • Creating Requirements Files
  • How It Works
  • Best Practices
  • Troubleshooting
  • Docker Considerations
  • Next Steps

Examples

• Examples
  • Example Categories
  • Quick Reference
  • Source Code
• Simple Toggle Examples
  • Toggle at Specific Times
  • Toggle Based on Schedule Entity
  • Toggle with Button Press
  • Multiple Instances
  • Key Concepts
• State Listener Examples
  • Basic State Listener
  • Alert When State Persists
  • Listen to Multiple Entities
  • Listen to Attributes
  • Conditional State Logic
  • One-Shot Listener
  • Extended Callback with Extra Data
  • Key Concepts
• Scheduling Examples
  • Daily Schedule
  • Sun-Based Schedule
  • Interval-Based Schedule
  • Delayed Execution
  • Schedule at Specific DateTime
  • Sprinkler Control (Complex Scheduling)
  • Cancel Scheduled Tasks
  • Key Concepts
• Entity Creation Examples
  • Basic Sensor
  • Button with Callback
  • Switch for Automation Control
  • Binary Sensor
  • Select Input
  • Number Input
  • Concurrent Entity Creation
  • Dynamic Entity Creation
  • State with Attributes
  • Diagnostic Entities
  • Key Concepts
• Climate Control Examples
  • Basic Thermostat Control
  • Smart HVAC with Priority Sensors
  • Pause HVAC When Windows Open
  • Mode Selection with ServEnts
  • Freeze Protection
  • Key Concepts
• Advanced Patterns
  • Using Mixins
  • Mixin Composition
  • Concurrent Operations
  • State Machine Pattern
  • External API Integration
  • TypeGuard Validation
  • Persistent Storage
  • Event-Driven Architecture
  • Key Concepts

API Reference

• API Reference
  • Quick Links
• Plugins API Reference
  • Hass Plugin
  • Callbacks Plugin
  • ServEnts Plugin
  • Logger Plugin
  • Meta Plugin
  • Time Plugin
  • Utils Plugin
• Applications API Reference
  • App Base Classes
  • Registration Functions
  • App Infrastructure
• Types Reference
  • Home Assistant Types
  • Entity ID Types
  • Application Types
  • ServEnts Entity Types

Indices and tables

• Index

• Module Index

• Search Page