# majamassarini/automate-home architecture

> Architecture diagram of the GitHub repository majamassarini/automate-home, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/majamassarini/automate-home
- Repository: https://github.com/majamassarini/automate-home

## Overview

Automate Home models appliance behaviour as event-driven, layered state machines, then connects that behaviour to physical devices through Performers and protocol gateways. The principal workflow is to load appliance, Performer and trigger configuration; build the home and scheduler; route incoming events through Process; update appliance state; and execute resulting commands through protocol writers while publishing updates to Redis. The README documents richer protocol triggers and varied appliance types. Several implementation files were not sampled, so edges for those capabilities rely on README statements or are omitted.

Main entry points: [`home/process.py`](https://github.com/majamassarini/automate-home/blob/main/home/process.py) (Event process), [`home/appliance/__init__.py`](https://github.com/majamassarini/automate-home/blob/main/home/appliance/__init__.py) (Appliance state), [`home/builder/__init__.py`](https://github.com/majamassarini/automate-home/blob/main/home/builder/__init__.py) (YAML builders), [`home/performer.py`](https://github.com/majamassarini/automate-home/blob/main/home/performer.py) (Performers)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_config["Configuration"]
  node_configs["Runtime options<br/>[configs.py]"]
  node_builder["YAML builders<br/>[__init__.py]"]
  node_performer_config["Performer config<br/>[performers.py]"]
  node_trigger_config["Trigger config<br/>[__init__.py]"]
  node_home_instance["Home assembly<br/>[my_home.py]"]
end

subgraph group_runtime["Event runtime"]
  node_process["Event process<br/>[process.py]"]
  node_scheduler["Scheduler triggers"]
  node_protocol_triggers["Stream triggers"]
  node_redis["Redis gateway<br/>[__init__.py]"]
  node_redis_state["State serialization<br/>[state.py]"]
end

subgraph group_domain["Appliance behaviour"]
  node_appliance["Appliance state<br/>[__init__.py]"]
  node_appliance_types["Appliance types"]
  node_attributes["State attributes<br/>[mixin.py]"]
  node_events["Domain events"]
end

subgraph group_integration["Device integration"]
  node_performers["Performers<br/>[performer.py]"]
  node_protocols["Protocol gateways<br/>[gateway.py]"]
end

node_operator(("Home operator"))
node_device_world(("Device protocols"))

node_operator -.->|"configures"| node_builder
node_builder -->|"loads"| node_performer_config
node_builder -->|"loads"| node_trigger_config
node_builder -.->|"assembles"| node_home_instance
node_performer_config -->|"resolves appliance"| node_appliance
node_home_instance -.->|"runs"| node_process
node_appliance -->|"specializes"| node_appliance_types
node_appliance -->|"uses"| node_attributes
node_events -.->|"updates state"| node_appliance
node_process -->|"updates and executes"| node_performers
node_process -->|"schedules transitions"| node_scheduler
node_process -->|"publishes updates"| node_redis
node_process -->|"dispatches commands"| node_protocols
node_performers -.->|"models behaviour"| node_appliance
node_performers -.->|"maps commands and feedback"| node_protocols
node_protocol_triggers -.->|"emits events"| node_events
node_scheduler -.->|"includes"| node_protocol_triggers
node_redis -.->|"serializes state"| node_redis_state
node_protocols -.->|"reads and writes"| node_device_world

click node_configs "https://github.com/majamassarini/automate-home/blob/main/home/configs.py"
click node_builder "https://github.com/majamassarini/automate-home/blob/main/home/builder/__init__.py"
click node_performer_config "https://github.com/majamassarini/automate-home/blob/main/home/builder/performers.py"
click node_trigger_config "https://github.com/majamassarini/automate-home/blob/main/home/builder/scheduler/trigger/__init__.py"
click node_home_instance "https://github.com/majamassarini/automate-home/blob/main/home/my_home.py"
click node_appliance "https://github.com/majamassarini/automate-home/blob/main/home/appliance/__init__.py"
click node_appliance_types "https://github.com/majamassarini/automate-home/tree/main/home/appliance"
click node_attributes "https://github.com/majamassarini/automate-home/blob/main/home/appliance/attribute/mixin.py"
click node_events "https://github.com/majamassarini/automate-home/tree/main/home/event"
click node_performers "https://github.com/majamassarini/automate-home/blob/main/home/performer.py"
click node_protocols "https://github.com/majamassarini/automate-home/blob/main/home/protocol/gateway.py"
click node_process "https://github.com/majamassarini/automate-home/blob/main/home/process.py"
click node_scheduler "https://github.com/majamassarini/automate-home/tree/main/home/scheduler/trigger"
click node_protocol_triggers "https://github.com/majamassarini/automate-home/tree/main/home/scheduler/trigger/protocol"
click node_redis "https://github.com/majamassarini/automate-home/blob/main/home/redis/gateway/__init__.py"
click node_redis_state "https://github.com/majamassarini/automate-home/blob/main/home/redis/gateway/serialization/state.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_configs,node_builder,node_performer_config,node_trigger_config,node_home_instance toneBlue
class node_process,node_scheduler,node_protocol_triggers,node_redis,node_redis_state toneAmber
class node_appliance,node_appliance_types,node_attributes,node_events toneMint
class node_performers,node_protocols toneRose
class node_operator,node_device_world toneIndigo
```

## Components

### Configuration

- [Runtime options](https://github.com/majamassarini/automate-home/blob/main/home/configs.py): `home/configs.py`
- [YAML builders](https://github.com/majamassarini/automate-home/blob/main/home/builder/__init__.py): `home/builder/__init__.py`
- [Performer config](https://github.com/majamassarini/automate-home/blob/main/home/builder/performers.py): `home/builder/performers.py`
- [Trigger config](https://github.com/majamassarini/automate-home/blob/main/home/builder/scheduler/trigger/__init__.py): `home/builder/scheduler/trigger/__init__.py`
- [Home assembly](https://github.com/majamassarini/automate-home/blob/main/home/my_home.py): `home/my_home.py`

### Event runtime

- [Event process](https://github.com/majamassarini/automate-home/blob/main/home/process.py): `home/process.py`
- [Scheduler triggers](https://github.com/majamassarini/automate-home/tree/main/home/scheduler/trigger): `home/scheduler/trigger`
- [Stream triggers](https://github.com/majamassarini/automate-home/tree/main/home/scheduler/trigger/protocol): `home/scheduler/trigger/protocol`
- [Redis gateway](https://github.com/majamassarini/automate-home/blob/main/home/redis/gateway/__init__.py): `home/redis/gateway/__init__.py`
- [State serialization](https://github.com/majamassarini/automate-home/blob/main/home/redis/gateway/serialization/state.py): `home/redis/gateway/serialization/state.py`

### Appliance behaviour

- [Appliance state](https://github.com/majamassarini/automate-home/blob/main/home/appliance/__init__.py): `home/appliance/__init__.py`
- [Appliance types](https://github.com/majamassarini/automate-home/tree/main/home/appliance): `home/appliance`
- [State attributes](https://github.com/majamassarini/automate-home/blob/main/home/appliance/attribute/mixin.py): `home/appliance/attribute/mixin.py`
- [Domain events](https://github.com/majamassarini/automate-home/tree/main/home/event): `home/event`

### Device integration

- [Performers](https://github.com/majamassarini/automate-home/blob/main/home/performer.py): `home/performer.py`
- [Protocol gateways](https://github.com/majamassarini/automate-home/blob/main/home/protocol/gateway.py): `home/protocol/gateway.py`

### Other components

- **Home operator**
- **Device protocols**

## Connections

- Home operator → YAML builders: configures (evidence: `README.md`)
- YAML builders → Performer config: loads (evidence: `home/builder/__init__.py`)
- YAML builders → Trigger config: loads (evidence: `home/builder/__init__.py`)
- YAML builders → Home assembly: assembles (evidence: `home/builder/__init__.py`)
- Performer config → Appliance state: resolves appliance (evidence: `home/builder/performers.py`)
- Home assembly → Event process: runs (evidence: `README.md`)
- Appliance state → Appliance types: specializes (evidence: `home/appliance/__init__.py`)
- Appliance state → State attributes: uses (evidence: `home/appliance/attribute/mixin.py`)
- Domain events → Appliance state: updates state (evidence: `README.md`)
- Event process → Performers: updates and executes (evidence: `home/process.py`)
- Event process → Scheduler triggers: schedules transitions (evidence: `home/process.py`)
- Event process → Redis gateway: publishes updates (evidence: `home/process.py`)
- Event process → Protocol gateways: dispatches commands (evidence: `home/process.py`)
- Performers → Appliance state: models behaviour (evidence: `README.md`)
- Performers → Protocol gateways: maps commands and feedback (evidence: `README.md`)
- Stream triggers → Domain events: emits events (evidence: `README.md`)
- Scheduler triggers → Stream triggers: includes (evidence: `README.md`)
- Redis gateway → State serialization: serializes state (evidence: `home/redis/gateway/__init__.py`)
- Protocol gateways → Device protocols: reads and writes (evidence: `README.md`)
