domovoy 0.11.0

No project description provided

Domovoy

Domovoy is a powerful application framework designed to drive automations for Home Assistant using Python. If you prefer writing your automations in pure Python rather than YAML, Node Red, or n8n, Domovoy provides a more flexible and developer-friendly approach to home automation.

Inspired by AppDaemon, Domovoy is a completely new codebase built from the ground up with Python's async/await throughout, resulting in significantly improved resource efficiency and performance.

Beta Status: This project is currently in beta. While I've been successfully running my home with Domovoy since 2023, you may still encounter bugs or rough edges. Feedback and contributions are welcome!

Key Features

• ServEnts Integration: When paired with ServEnts (a Home Assistant custom component), Domovoy can create devices and entities directly from Python code, eliminating the need for manually configuring helpers in HA.

• Type Safety: Full support for Python typing, including typechecking for entities and services on the Home Assistant instance it connects to, catching errors before they happen.

• Python-First Approach: Write all your automations in Python with full IDE support, and the ability to leverage Python's rich ecosystem of libraries.

• High Performance: Leverages Python's async/await for efficient, non-blocking operations that make the most of your system resources.

• Hot Reload: Automatic file watching and module reloading during development - make changes to your apps and see them take effect immediately without restarting.

Quickest Start

The fastest way to get started is with the Domovoy Starter Template. This prebuilt template has most of the pieces already in place—just update the config file with your Home Assistant details and run the included docker command.

Quick Start with Docker

The recommended way to run Domovoy is using Docker.

1. Create your configuration directory

mkdir -p ~/domovoy/apps

2. Create a configuration file

Create ~/domovoy/config.yml:

app_suffix: _apps
hass_access_token: YOUR_LONG_LIVED_ACCESS_TOKEN
hass_url: ws://homeassistant.local:8123
app_path: /config/apps
timezone: America/Chicago
install_pip_dependencies: true

Replace:

• YOUR_LONG_LIVED_ACCESS_TOKEN with a Home Assistant long-lived access token
• hass_url with your Home Assistant WebSocket URL
• timezone with your timezone

3. Install ServEnts Integration (Optional)

If you want to create Home Assistant entities directly from your Python code, install the ServEnts custom component in Home Assistant. This allows Domovoy to dynamically create sensors, switches, buttons, and other entities.

4. Run with Docker

docker run -d \
  --name domovoy \
  --restart unless-stopped \
  -v ~/domovoy:/config \
  ghcr.io/carlos-sarmiento/domovoy:latest

5. Create your first app

Create ~/domovoy/apps/my_first_apps.py:

from domovoy.applications import AppBase, EmptyAppConfig
from domovoy.applications.registration import register_app


class MyFirstApp(AppBase[EmptyAppConfig]):
    async def initialize(self):
        self.log.info("Hello from Domovoy!")

        # Listen to state changes
        self.callbacks.listen_state(
            "light.living_room"
            self.on_light_change,
        )

    async def on_light_change(self, entity_id, old, new):
        self.log.info(f"Light changed from {old} to {new}")


register_app(
    app_class=MyFirstApp,
    app_name="my_first_app",
    config=EmptyAppConfig(),
)

Documentation

Full documentation is available at domovoy.readthedocs.io

• Getting Started Guide - Installation and first steps
• Configuration Reference - Detailed configuration options
• Writing Your First App - Step-by-step tutorial
• Guides - In-depth guides on callbacks, state management, ServEnts, and more
• Examples - Real-world automation examples
• API Reference - Complete API documentation

License

This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0).