Developer Guide¶

Welcome to the HAEO developer documentation! This section covers architecture, development setup, and contribution guidelines.

Quick Start¶

git clone https://github.com/hass-energy/haeo.git
cd haeo
uv sync
uv run pytest

Architecture¶

HAEO uses a layered architecture separating user configuration from optimization modeling:

• Architecture - System design overview
• Adapter Layer - Device Layer to Model Layer transformation

Component Guides¶

• Horizon Manager - Synchronized forecast time windows
• Input Entities - Intermediate input entity layer
• Data Loading - Sensor data extraction and loading
• Coordinator - Event-driven optimization coordinator
• Config Flow - Configuration UI patterns
• Energy Models - Creating new element types

Development¶

• Setup - Development environment with uv
• Units & Stability - Unit system and numerical considerations
• Testing - Running and writing tests
• Contributing - Contribution workflow
• Documentation Guidelines - Writing and maintaining docs