50 Commits

Author SHA1 Message Date
aaee480e57 seems to work 2025-11-17 11:36:19 +01:00
d0b5184270 start script 2025-11-17 10:23:42 +01:00
5bf37a19ad homekit bridge initial 2025-11-17 10:18:27 +01:00
2e24c259cb fix 4 2025-11-17 08:42:26 +01:00
bbf280bdf4 fix 3 2025-11-17 08:39:50 +01:00
a7d778b211 fix 2 2025-11-17 08:37:02 +01:00
a7d8afc98b fix 2025-11-17 08:10:11 +01:00
a4ae8a2f6c slider for thermostats 2025-11-17 08:05:58 +01:00
6152385339 fix 8 2025-11-14 15:14:48 +01:00
c2b7328219 fix 7 2025-11-14 15:13:37 +01:00
99362b346f fix 6 2025-11-14 15:01:49 +01:00
77d29c3a42 fix 5 2025-11-14 14:31:03 +01:00
ef3b1177d2 fix 4 2025-11-14 14:18:59 +01:00
8bbe9c164f fix 3 2025-11-14 14:14:49 +01:00
65f8a0c7cb fix 2 2025-11-14 11:34:32 +01:00
cbe7e11cf2 fix 2025-11-14 11:30:10 +01:00
9bf336fa11 groups and scenes 3 2025-11-13 21:56:13 +01:00
b82217a666 groups and scenes 2 2025-11-13 21:54:09 +01:00
5851414ba5 groups and scenes initial 2025-11-13 21:29:04 +01:00
4c5475e930 favicon 2025-11-13 11:14:43 +01:00
b6b441c0ca rules 2 2025-11-11 19:58:06 +01:00
d3d96ed3e9 enabled for rules 2025-11-11 17:08:18 +01:00
2e2963488b rules initial 2025-11-11 16:38:41 +01:00
7928bc596f compose file 2025-11-11 12:40:53 +01:00
3874eaed83 compose file added 2025-11-11 12:34:49 +01:00
0f43f37823 shellies 2025-11-11 11:39:10 +01:00
93e70da97d add spuele 3 2025-11-11 11:11:14 +01:00
62d302bf41 add spuele 2 2025-11-11 11:10:31 +01:00
3d6130f2c2 add spuele 2025-11-11 11:09:08 +01:00
2a8d569bb5 shelly 2025-11-11 11:01:52 +01:00
6a5f814cb4 fix in layout, drop test entry 2025-11-11 10:28:27 +01:00
cc3c15078c change relays to type relay 2025-11-11 10:24:09 +01:00
7772dac000 medusa lampe to relay 2025-11-11 10:12:25 +01:00
97ea853483 add type relay 2025-11-11 10:10:22 +01:00
86d1933c1f sensoren 2 2025-11-11 09:13:46 +01:00
9458381593 sensoren 2025-11-11 09:12:35 +01:00
f389115841 kontakte 2025-11-10 21:20:43 +01:00
19a6a603d5 window contact first try 2025-11-10 19:41:08 +01:00
e728dd58e4 all collapsed at load/refresh 2025-11-10 17:11:50 +01:00
6310fedeea zigbee2mqtt thermostat transformation 2025-11-10 17:07:41 +01:00
e113616abf fix 2025-11-10 16:58:46 +01:00
e8cd34f88f thermostat mode optional 2025-11-10 16:54:09 +01:00
1bd175c912 fix 2025-11-10 16:42:15 +01:00
cc566c9e73 drop mode from thermostat ui 2025-11-10 16:36:20 +01:00
2eb4f3c376 max thermostats added 2025-11-10 16:19:55 +01:00
b57ddb1589 MAX transformation added 2025-11-10 16:11:28 +01:00
a49d56df60 temperaturschrittweite 1.0 2025-11-10 16:04:44 +01:00
5a7b16f7aa mode buttons removed from thermostat 2025-11-10 16:02:23 +01:00
e69822719a fix 2025-11-10 12:35:06 +01:00
25a6b98d41 alle lampen 2025-11-10 12:28:23 +01:00
54 changed files with 8750 additions and 376 deletions

3
.gitignore vendored
View File

@@ -61,3 +61,6 @@ Thumbs.db
# Poetry
poetry.lock
apps/homekit/homekit.state

41
DEVICES_BY_ROOM.md Normal file
View File

@@ -0,0 +1,41 @@
Schlafzimmer:
- Bettlicht Patty | 0x0017880108158b32
- Bettlicht Wolfgang | 0x00178801081570bf
- Deckenlampe Schlafzimmer | 0x0017880108a406a7
- Medusa-Lampe Schlafzimmer | 0xf0d1b80000154c7c
Esszimmer:
- Deckenlampe Esszimmer | 0x0017880108a03e45
- Leselampe Esszimmer | 0xec1bbdfffe7b84f2
- Standlampe Esszimmer | 0xbc33acfffe21f547
- kleine Lampe links Esszimmer | 0xf0d1b80000153099
- kleine Lampe rechts Esszimmer | 0xf0d1b80000156645
Wohnzimmer:
- Lampe Naehtischchen Wohnzimmer | 0x842e14fffee560ee
- Lampe Semeniere Wohnzimmer | 0xf0d1b8000015480b
- Sterne Wohnzimmer | 0xf0d1b80000155fc2
- grosse Lampe Wohnzimmer | 0xf0d1b80000151aca
Küche:
- Küche Deckenlampe | 0x001788010d2c40c4
- Kueche | 0x94deb8fffe2e5c06
Arbeitszimmer Patty:
- Leselampe Patty | 0x001788010600ec9d
- Schranklicht hinten Patty | 0x0017880106e29571
- Schranklicht vorne Patty | 0xf0d1b80000154cf5
Arbeitszimmer Wolfgang:
- Wolfgang | 0x540f57fffe7e3cfe
- ExperimentLabTest | 0xf0d1b80000195038
Flur:
- Deckenlampe Flur oben | 0x001788010d2123a7
- Haustür | 0xec1bbdfffea6a3da
- Licht Flur oben am Spiegel | 0x842e14fffefe4ba4
Sportzimmer:
- Sportlicht Regal | 0xf0d1b8be2409f569
- Sportlicht Tisch | 0xf0d1b8be2409f31b
- Sportlicht am Fernseher, Studierzimmer | 0x842e14fffe76a23a

View File

@@ -0,0 +1,553 @@
# HomeKit-Bridge API-Modell: Analyse der bestehenden Implementierung
**Analysedatum:** 17. November 2025
**Analysierte Dateien:**
- `apps/api/main.py`
- `apps/api/routes/groups_scenes.py`
- `config/devices.yaml`
---
## Zusammenfassung
Die bestehende API-Implementierung erfüllt **~60%** der Anforderungen des HomeKit-Bridge Ziel-Modells. Die meisten Kernfunktionalitäten sind vorhanden, aber es fehlen wichtige Metadaten-Felder und ein dedizierter State-Endpoint.
---
## 1. GET /devices
### Status: ✅ **VORHANDEN** mit Abweichungen
### Implementierung (apps/api/main.py:325-343)
```python
@app.get("/devices")
async def get_devices() -> list[DeviceInfo]:
devices = load_devices()
return [
DeviceInfo(
device_id=device["device_id"],
type=device["type"],
name=device.get("name", device["device_id"]),
features=device.get("features", {})
)
for device in devices
]
```
### Response-Modell (DeviceInfo)
```python
class DeviceInfo(BaseModel):
device_id: str
type: str
name: str
features: dict[str, Any] = {}
```
### Abweichungen vom Ziel-Modell
| Feld | Ziel-Modell | Ist-Zustand | Status |
|------|-------------|-------------|---------|
| `device_id` | ✅ Erforderlich | ✅ Vorhanden | OK |
| `type` | ✅ Erforderlich | ✅ Vorhanden | OK |
| `cap_version` | ✅ Erforderlich | ❌ **FEHLT** | FEHLT |
| `room` | ✅ Erforderlich | ❌ **FEHLT** | FEHLT |
| `friendly_name` | ✅ Erforderlich | ⚠️ Heißt `name` | UMBENENNUNG |
| `technology` | ✅ Erforderlich | ❌ **FEHLT** | FEHLT |
| `features` | ✅ Erforderlich | ✅ Vorhanden | OK |
| `read_only` | ✅ Erforderlich | ❌ **FEHLT** | FEHLT |
| `tags` | Optional | ❌ **FEHLT** | FEHLT |
### Details zu fehlenden Feldern
#### ❌ `cap_version`
- **Vorhanden in devices.yaml:** Ja, als `cap_version` (z.B. `"light@1.2.0"`)
- **Problem:** Wird von `load_devices()` geladen, aber nicht in `DeviceInfo` exponiert
- **Lösung:** Feld zu `DeviceInfo` hinzufügen und aus `device["cap_version"]` befüllen
#### ❌ `room`
- **Vorhanden in layout.yaml:** Ja, indirekt über Raum-Zuordnung
- **Problem:** Aktuell nur über separaten Endpoint `/devices/{device_id}/room` verfügbar
- **Lösung:** Room-Mapping in `/devices` integrieren (Resolver bereits vorhanden in `apps/api/resolvers.py`)
#### ⚠️ `friendly_name` vs. `name`
- **Vorhanden in devices.yaml:** Ja, als `metadata.friendly_name`
- **Problem:** Aktuell wird `device.get("name", device["device_id"])` verwendet, nicht `metadata.friendly_name`
- **Lösung:** Priorisierung: `metadata.friendly_name` > `name` > `device_id`
#### ❌ `technology`
- **Vorhanden in devices.yaml:** Ja, als `technology` (z.B. `"zigbee2mqtt"`)
- **Problem:** Wird nicht in Response exponiert
- **Lösung:** Feld zu `DeviceInfo` hinzufügen
#### ❌ `read_only`
- **Implizit vorhanden:** Ja, über `topics.set` (wenn fehlt → read-only)
- **Problem:** Muss berechnet werden
- **Lösung:** `read_only = "set" not in device.get("topics", {})`
#### ❌ `tags`
- **Vorhanden in devices.yaml:** Nein
- **Status:** Nicht kritisch, kann später ergänzt werden
---
## 2. GET /devices/{device_id}
### Status: ❌ **FEHLT KOMPLETT**
### Aktuell vorhanden
- `/devices/{device_id}/room` (liefert nur `{"device_id": str, "room": str | None}`)
### Erforderlich
Ein Endpoint, der das gleiche Schema wie ein Eintrag aus `/devices` zurückgibt:
```python
@app.get("/devices/{device_id}")
async def get_device(device_id: str) -> DeviceInfo:
# Load device, enrich with room, return DeviceInfo
```
### Implementierung
- Device aus `load_devices()` filtern
- Mit `get_room(device_id)` anreichern
- Als `DeviceInfo` zurückgeben
- 404 bei nicht gefunden
---
## 3. GET /devices/{device_id}/state
### Status: ❌ **FEHLT KOMPLETT**
### Aktuell vorhanden
- `/devices/states` (liefert **alle** Device-States als Dict)
```python
@app.get("/devices/states")
async def get_device_states() -> dict[str, dict[str, Any]]:
return device_states # In-memory cache
```
### Ziel-Format
```json
{
"device_id": "thermostat_wolfgang",
"type": "thermostat",
"room": "Schlafzimmer",
"payload": {
"current": 19.5,
"target": 21.0,
"mode": "heat"
},
"ts": "2025-11-17T14:23:45.123Z"
}
```
### Erforderlich
```python
@app.get("/devices/{device_id}/state")
async def get_device_state(device_id: str) -> DeviceStateResponse:
# Get from device_states cache
# Enrich with metadata (type, room)
# Add timestamp
# Return structured response
```
### Problem
- Aktuell wird nur `payload` im Cache gespeichert
- Timestamp fehlt im Cache (müsste bei SSE-Updates mitgespeichert werden)
- Metadaten (type, room) müssen aus devices.yaml/layout.yaml ergänzt werden
---
## 4. SSE-Endpoint /realtime
### Status: ✅ **VORHANDEN** mit kleineren Abweichungen
### Implementierung (apps/api/main.py:608-637)
```python
@app.get("/realtime")
async def realtime_events(request: Request) -> StreamingResponse:
return StreamingResponse(
event_generator(request),
media_type="text/event-stream",
# ... headers
)
```
### Aktuelles Event-Format (aus Redis)
```json
{
"type": "state",
"device_id": "thermostat_wolfgang",
"payload": {
"current": 19.5,
"target": 21.0
}
}
```
### Ziel-Format
```json
{
"type": "state",
"device_id": "thermostat_wolfgang",
"device_type": "thermostat", // ← FEHLT
"room": "Schlafzimmer", // ← FEHLT
"payload": {
"current": 19.5,
"target": 21.0
},
"ts": "2025-11-17T14:23:45.123Z", // ← FEHLT
"source": "zigbee2mqtt" // ← FEHLT (optional)
}
```
### Abweichungen
| Feld | Ziel-Modell | Ist-Zustand | Status |
|------|-------------|-------------|---------|
| `type` | ✅ | ✅ | OK |
| `device_id` | ✅ | ✅ | OK |
| `device_type` | ✅ | ❌ **FEHLT** | FEHLT |
| `room` | ✅ | ❌ **FEHLT** | FEHLT |
| `payload` | ✅ | ✅ | OK |
| `ts` | ✅ | ❌ **FEHLT** | FEHLT |
| `source` | Optional | ❌ **FEHLT** | FEHLT |
### Problem
Events werden direkt aus Redis weitergeleitet ohne Enrichment.
### Lösungsansätze
**Option A: Enrichment im SSE-Generator**
```python
# Im event_generator() nach JSON-Parse:
state_data = json.loads(data)
if state_data.get("type") == "state":
# Enrich with metadata
device_id = state_data["device_id"]
device = get_device_from_cache(device_id)
state_data["device_type"] = device["type"]
state_data["room"] = get_room(device_id)
if "ts" not in state_data:
state_data["ts"] = datetime.utcnow().isoformat()
data = json.dumps(state_data)
```
**Option B: Enrichment im Publisher (apps/abstraction)**
- Besser: Events bereits vollständig beim Publizieren
- Würde auch `/devices/{id}/state` helfen
---
## 5. POST /devices/{device_id}/set
### Status: ✅ **VORHANDEN** mit kleinen Abweichungen
### Implementierung (apps/api/main.py:406-504)
```python
@app.post("/devices/{device_id}/set", status_code=status.HTTP_202_ACCEPTED)
async def set_device(device_id: str, request: SetDeviceRequest) -> dict[str, str]:
# Validierung, MQTT publish
```
### Request-Modell
```python
class SetDeviceRequest(BaseModel):
type: str
payload: dict[str, Any]
```
### Vergleich mit Ziel-Modell
| Aspekt | Ziel-Modell | Ist-Zustand | Status |
|--------|-------------|-------------|---------|
| Body-Format | `{type, payload}` | `{type, payload}` | ✅ OK |
| Type-Validierung | ✅ Erforderlich | ✅ Vorhanden | OK |
| Payload-Validierung | ✅ Per Device-Type | ✅ Vorhanden | OK |
| Read-Only Check | ✅ → 405 | ✅ → 405 | OK |
| Response Code | 200/202 | 202 | OK |
### Validierungs-Details
**✅ Gut implementiert:**
- Type-spezifische Pydantic-Validierung (LightState, ThermostatState, etc.)
- Whitelist für erlaubte Felder bei Thermostaten
- Read-only Detection über `topics.set`
- Proper HTTP Status Codes (404, 405, 422)
**⚠️ Kleine Abweichung:**
- Thermostat-Validierung erlaubt nur `{mode, target}` beim SET
- Ziel-Modell erwähnt dies nicht explizit
- **Bewertung:** Ist sinnvolle Einschränkung, kein Problem
### MQTT-Publishing
```python
topic = f"home/{request.type}/{device_id}/set"
mqtt_payload = {
"type": request.type,
"payload": request.payload
}
await publish_mqtt(topic, mqtt_payload)
```
✅ Korrekt implementiert
---
## 6. Zusätzliche Endpoints (nicht im Ziel-Modell)
### Vorhanden, aber nicht gefordert
- **GET /spec** - Capability-Versionen
- **GET /devices/states** - Alle States (könnte nützlich für Bridge sein)
- **GET /layout** - UI-spezifisch
- **GET /devices/{device_id}/room** - Wird obsolet wenn `/devices` `room` hat
- **GET /groups**, **POST /groups/{id}/set** - Gruppen-Feature
- **GET /scenes**, **POST /scenes/{id}/run** - Szenen-Feature
**Bewertung:** Nicht störend, können bleiben. Bridge muss diese nicht nutzen.
---
## 7. Datenquellen-Analyse
### devices.yaml
**✅ Enthält alle benötigten Felder:**
```yaml
- device_id: leselampe_esszimmer
type: light
cap_version: "light@1.2.0" # ← Vorhanden
technology: zigbee2mqtt # ← Vorhanden
features:
power: true
brightness: true
topics:
state: "..."
set: "..." # ← Für read_only Detection
metadata:
friendly_name: "Leselampe Esszimmer" # ← Vorhanden
ieee_address: "..."
model: "LED1842G3"
vendor: "IKEA"
```
### layout.yaml
**✅ Enthält Room-Mapping:**
```yaml
rooms:
- name: "Schlafzimmer"
devices:
- device_id: thermostat_wolfgang
```
**✅ Resolver bereits vorhanden:** `apps/api/resolvers.py::get_room(device_id)`
---
## 8. Priorisierte To-Do-Liste
### 🔴 **Kritisch** (Bridge funktioniert nicht ohne)
1. **GET /devices: Fehlende Felder ergänzen**
- `cap_version` aus devices.yaml
- `room` via `get_room()`
- `friendly_name` aus `metadata.friendly_name`
- `technology` aus devices.yaml
- `read_only` berechnen
2. **GET /devices/{device_id}/state implementieren**
- Neuer Endpoint
- State aus Cache + Metadaten
- Timestamp hinzufügen
### 🟡 **Wichtig** (Bridge funktioniert, aber eingeschränkt)
3. **SSE /realtime: Events enrichen**
- `device_type` hinzufügen
- `room` hinzufügen
- `ts` sicherstellen
4. **GET /devices/{device_id} implementieren**
- Einzelgerät-Abfrage
- Gleiche Struktur wie `/devices`-Eintrag
### 🟢 **Nice-to-have**
5. **State-Cache mit Timestamps erweitern**
- Aktuell: `device_states[id] = payload`
- Ziel: `device_states[id] = {payload, ts}`
6. **SSE: source-Feld hinzufügen**
- Aus `device["technology"]` ableiten
---
## 9. Implementierungs-Reihenfolge
### Phase 1: GET /devices erweitern
**Dateien:**
- `apps/api/main.py` (DeviceInfo-Modell, get_devices())
**Änderungen:**
```python
class DeviceInfo(BaseModel):
device_id: str
type: str
cap_version: str
room: str | None
friendly_name: str
technology: str
features: dict[str, Any]
read_only: bool
tags: list[str] | None = None
@app.get("/devices")
async def get_devices() -> list[DeviceInfo]:
devices = load_devices()
return [
DeviceInfo(
device_id=device["device_id"],
type=device["type"],
cap_version=device["cap_version"],
room=get_room(device["device_id"]),
friendly_name=device.get("metadata", {}).get("friendly_name", device["device_id"]),
technology=device["technology"],
features=device.get("features", {}),
read_only="set" not in device.get("topics", {}),
tags=device.get("tags")
)
for device in devices
]
```
### Phase 2: GET /devices/{device_id}/state
**Dateien:**
- `apps/api/main.py`
**Neues Modell:**
```python
class DeviceStateResponse(BaseModel):
device_id: str
type: str
room: str | None
payload: dict[str, Any]
ts: str
@app.get("/devices/{device_id}/state")
async def get_device_state(device_id: str) -> DeviceStateResponse:
if device_id not in device_states:
raise HTTPException(404, f"No state for {device_id}")
devices = load_devices()
device = next((d for d in devices if d["device_id"] == device_id), None)
if not device:
raise HTTPException(404, f"Device {device_id} not found")
return DeviceStateResponse(
device_id=device_id,
type=device["type"],
room=get_room(device_id),
payload=device_states[device_id],
ts=datetime.utcnow().isoformat() + "Z"
)
```
### Phase 3: SSE Enrichment
**Dateien:**
- `apps/api/main.py` (event_generator())
**Im event_generator() nach JSON-Parse:**
```python
if message and message["type"] == "message":
data = message["data"]
state_data = json.loads(data)
# Enrich events
if state_data.get("type") == "state" and state_data.get("device_id"):
device_id = state_data["device_id"]
devices = load_devices()
device = next((d for d in devices if d["device_id"] == device_id), None)
if device:
state_data["device_type"] = device["type"]
state_data["room"] = get_room(device_id)
if "ts" not in state_data:
state_data["ts"] = datetime.utcnow().isoformat() + "Z"
state_data["source"] = device.get("technology")
data = json.dumps(state_data)
yield f"event: message\ndata: {data}\n\n"
```
### Phase 4: GET /devices/{device_id}
**Dateien:**
- `apps/api/main.py`
```python
@app.get("/devices/{device_id}")
async def get_device(device_id: str) -> DeviceInfo:
devices = load_devices()
device = next((d for d in devices if d["device_id"] == device_id), None)
if not device:
raise HTTPException(404, f"Device {device_id} not found")
return DeviceInfo(
device_id=device["device_id"],
type=device["type"],
cap_version=device["cap_version"],
room=get_room(device["device_id"]),
friendly_name=device.get("metadata", {}).get("friendly_name", device["device_id"]),
technology=device["technology"],
features=device.get("features", {}),
read_only="set" not in device.get("topics", {}),
tags=device.get("tags")
)
```
---
## 10. Zusammenfassung der Abweichungen
### ✅ Bereits konform (40%)
- POST /devices/{id}/set - Vollständig implementiert
- SSE /realtime - Grundfunktion vorhanden
- GET /devices - Grundstruktur vorhanden
### ⚠️ Teilweise konform (40%)
- GET /devices - Fehlen wichtige Felder (cap_version, room, friendly_name, technology, read_only)
- SSE /realtime - Events ohne device_type, room, ts
### ❌ Nicht vorhanden (20%)
- GET /devices/{device_id}/state - Komplett fehlend
- GET /devices/{device_id} - Komplett fehlend
---
## 11. Risiko-Bewertung
### 🟢 **Geringes Risiko**
- Alle Daten sind in devices.yaml/layout.yaml vorhanden
- Resolver-Funktionen existieren bereits
- Pydantic-Modelle sind etabliert
- Keine Breaking Changes an bestehenden Endpoints nötig
### 🟡 **Mittleres Risiko**
- SSE-Enrichment könnte Performance beeinflussen (load_devices() bei jedem Event)
- **Mitigation:** Device-Lookup cachen
- Timestamp-Handling muss konsistent sein
- **Mitigation:** UTC + ISO8601 + "Z" Suffix
### 🔴 **Kein hohes Risiko identifiziert**
---
## 12. Nächste Schritte
1. **Freigabe einholen:** Sollen wir mit Phase 1 (GET /devices erweitern) starten?
2. **Testing-Strategie:** Sollen Tests für die neuen Endpoints geschrieben werden?
3. **Backward Compatibility:** GET /devices ändert Response-Struktur - ist das OK? (Vermutlich ja, da UI diese Felder ignorieren kann)
4. **Performance:** Device-Lookup-Cache implementieren vor SSE-Enrichment?
---
**Ende der Analyse**

223
MAX_INTEGRATION.md Normal file
View File

@@ -0,0 +1,223 @@
# MAX! (eQ-3) Thermostat Integration
## Overview
This document describes the integration of MAX! (eQ-3) thermostats via Homegear into the home automation system.
## Protocol Characteristics
MAX! thermostats use a **simple integer-based protocol** (not JSON):
- **SET messages**: Plain integer temperature value (e.g., `22`)
- **STATE messages**: Plain integer temperature value (e.g., `22`)
- **Topics**: Homegear MQTT format
### MQTT Topics
**SET Command:**
```
homegear/instance1/set/<peerId>/<channel>/SET_TEMPERATURE
Payload: "22" (plain integer as string)
```
**STATE Update:**
```
homegear/instance1/plain/<peerId>/<channel>/SET_TEMPERATURE
Payload: "22" (plain integer as string)
```
## Transformation Layer
The abstraction layer provides automatic transformation between the abstract home protocol and MAX! format.
### Abstract → MAX! (SET)
**Input (Abstract):**
```json
{
"mode": "heat",
"target": 22.5
}
```
**Output (MAX!):**
```
22
```
**Transformation Rules:**
- Extract `target` temperature
- Convert float → integer (round to nearest)
- Return as plain string (no JSON)
- Ignore `mode` field (MAX! always in heating mode)
### MAX! → Abstract (STATE)
**Input (MAX!):**
```
22
```
**Output (Abstract):**
```json
{
"target": 22.0,
"mode": "heat"
}
```
**Transformation Rules:**
- Parse plain string/integer value
- Convert to float
- Add default `mode: "heat"` (MAX! always heating)
- Wrap in abstract payload structure
## Device Configuration
### Example devices.yaml Entry
```yaml
- device_id: "thermostat_wolfgang"
type: "thermostat"
cap_version: "thermostat@1.0.0"
technology: "max"
features:
mode: true
target: true
current: false # SET_TEMPERATURE doesn't report current temp
topics:
set: "homegear/instance1/set/39/1/SET_TEMPERATURE"
state: "homegear/instance1/plain/39/1/SET_TEMPERATURE"
metadata:
friendly_name: "Thermostat Wolfgang"
location: "Arbeitszimmer Wolfgang"
vendor: "eQ-3"
model: "MAX! Thermostat"
peer_id: "39"
channel: "1"
```
### Configuration Notes
1. **technology**: Must be set to `"max"` to activate MAX! transformations
2. **topics.set**: Use Homegear's `/set/` path with `/SET_TEMPERATURE` parameter
3. **topics.state**: Use Homegear's `/plain/` path with `/SET_TEMPERATURE` parameter
4. **features.current**: Set to `false` - SET_TEMPERATURE topic doesn't provide current temperature
5. **metadata**: Include `peer_id` and `channel` for reference
## Temperature Rounding
MAX! only supports **integer temperatures**. The system uses standard rounding:
| Abstract Input | MAX! Output |
|----------------|-------------|
| 20.4°C | 20 |
| 20.5°C | 20 |
| 20.6°C | 21 |
| 21.5°C | 22 |
| 22.5°C | 22 |
Python's `round()` function uses "banker's rounding" (round half to even).
## Limitations
1. **No current temperature**: SET_TEMPERATURE topic only reports target, not actual temperature
2. **No mode control**: MAX! thermostats are always in heating mode
3. **Integer only**: Temperature precision limited to 1°C steps
4. **No battery status**: Not available via SET_TEMPERATURE topic
5. **No window detection**: Not available via SET_TEMPERATURE topic
## Testing
Test the transformation functions:
```bash
poetry run python /tmp/test_max_transform.py
```
Expected output:
```
✅ PASS: Float 22.5 -> Integer string
✅ PASS: Integer string -> Abstract dict
✅ PASS: Integer -> Abstract dict
✅ PASS: Rounding works correctly
🎉 All MAX! transformation tests passed!
```
## Implementation Details
### Files Modified
1. **apps/abstraction/transformation.py**
- Added `_transform_thermostat_max_to_vendor()` - converts abstract → plain integer
- Added `_transform_thermostat_max_to_abstract()` - converts plain integer → abstract
- Registered handlers in `TRANSFORM_HANDLERS` registry
2. **apps/abstraction/main.py**
- Modified `handle_abstract_set()` to send plain string for MAX! devices (not JSON)
- Modified message processing to handle plain text payloads from MAX! STATE topics
### Transformation Functions
```python
def _transform_thermostat_max_to_vendor(payload: dict[str, Any]) -> str:
"""Convert {"target": 22.5} → "22" """
target_temp = payload.get("target", 21.0)
return str(int(round(target_temp)))
def _transform_thermostat_max_to_abstract(payload: str | int | float) -> dict[str, Any]:
"""Convert "22" → {"target": 22.0, "mode": "heat"} """
target_temp = float(payload)
return {"target": target_temp, "mode": "heat"}
```
## Usage Example
### Setting Temperature via API
```bash
curl -X POST http://localhost:8001/devices/thermostat_wolfgang/set \
-H "Content-Type: application/json" \
-d '{
"type": "thermostat",
"payload": {
"mode": "heat",
"target": 22.5
}
}'
```
**Flow:**
1. API receives abstract payload: `{"mode": "heat", "target": 22.5}`
2. Abstraction transforms to MAX!: `"22"`
3. Publishes to: `homegear/instance1/set/39/1/SET_TEMPERATURE` with payload `22`
### Receiving State Updates
**Homegear publishes:**
```
Topic: homegear/instance1/plain/39/1/SET_TEMPERATURE
Payload: 22
```
**Flow:**
1. Abstraction receives plain text: `"22"`
2. Transforms to abstract: `{"target": 22.0, "mode": "heat"}`
3. Publishes to: `home/thermostat/thermostat_wolfgang/state`
4. Publishes to Redis: `ui:updates` channel for real-time UI updates
## Future Enhancements
Potential improvements for better MAX! integration:
1. **Current Temperature**: Subscribe to separate Homegear topic for actual temperature
2. **Battery Status**: Subscribe to LOWBAT or battery level topics
3. **Valve Position**: Monitor actual valve opening percentage
4. **Window Detection**: Subscribe to window open detection status
5. **Mode Control**: Support comfort/eco temperature presets
## Related Documentation
- [Homegear MAX! Documentation](https://doc.homegear.eu/data/homegear-max/)
- [Abstract Protocol Specification](docs/PROTOCOL.md)
- [Transformation Layer Design](apps/abstraction/README.md)

View File

@@ -0,0 +1,54 @@
# Nicht berücksichtigte Zigbee-Geräte
## Switches (0)
~~Gerät "Sterne Wohnzimmer" wurde als Light zu devices.yaml hinzugefügt~~
## Sensoren und andere Geräte (22)
### Tür-/Fenstersensoren (7)
- Wolfgang (MCCGQ11LM) - 0x00158d008b3328da
- Terassentür (MCCGQ11LM) - 0x00158d008b332788
- Garten Kueche (MCCGQ11LM) - 0x00158d008b332785
- Strasse rechts Kueche (MCCGQ11LM) - 0x00158d008b151803
- Strasse links Kueche (MCCGQ11LM) - 0x00158d008b331d0b
- Fenster Bad oben (MCCGQ11LM) - 0x00158d008b333aec
- Fenster Patty Strasse (MCCGQ11LM) - 0x00158d000af457cf
### Temperatur-/Feuchtigkeitssensoren (11)
- Kueche (WSDCGQ11LM) - 0x00158d00083299bb
- Wolfgang (WSDCGQ11LM) - 0x00158d000543fb99
- Patty (WSDCGQ11LM) - 0x00158d0003f052b7
- Schlafzimmer (WSDCGQ01LM) - 0x00158d00043292dc
- Bad oben (WSDCGQ11LM) - 0x00158d00093e8987
- Flur (WSDCGQ11LM) - 0x00158d000836ccc6
- Wohnzimmer (WSDCGQ11LM) - 0x00158d0008975707
- Bad unten (WSDCGQ11LM) - 0x00158d00093e662a
- Waschkueche (WSDCGQ11LM) - 0x00158d000449f3bc
- Studierzimmer (WSDCGQ11LM) - 0x00158d0009421422
- Wolfgang (SONOFF SNZB-02D) - 0x0ceff6fffe39a196
### Schalter (2)
- Schalter Schlafzimmer (Philips 929003017102) - 0x001788010cc490d4
- Schalter Bettlicht Patty (WXKG11LM) - 0x00158d000805d165
### Bewegungsmelder (1)
- Bewegungsmelder 8 (Philips 9290012607) - 0x001788010867d420
### Wasserleck-Sensor (1)
- unter Therme (SJCGQ11LM) - 0x00158d008b3a83a9
## Zusammenfassung
**Unterstützt in devices.yaml:**
- 24 Lampen (lights)
- 2 Thermostate
**Nicht unterstützt:**
- 0 Switches
- 7 Tür-/Fenstersensoren
- 11 Temperatur-/Feuchtigkeitssensoren
- 2 Schalter (Button-Devices)
- 1 Bewegungsmelder
- 1 Wasserleck-Sensor
Die nicht unterstützten Geräte könnten in Zukunft durch Erweiterung des Systems integriert werden.

View File

@@ -15,7 +15,7 @@ import uuid
from aiomqtt import Client
from pydantic import ValidationError
from packages.home_capabilities import LightState, ThermostatState
from packages.home_capabilities import LightState, ThermostatState, ContactState, TempHumidityState, RelayState
from apps.abstraction.transformation import (
transform_abstract_to_vendor,
transform_vendor_to_abstract
@@ -89,11 +89,12 @@ def validate_devices(devices: list[dict[str, Any]]) -> None:
if "topics" not in device:
raise ValueError(f"Device {device_id} missing 'topics'")
if "set" not in device["topics"]:
raise ValueError(f"Device {device_id} missing 'topics.set'")
# 'state' topic is required for all devices
if "state" not in device["topics"]:
raise ValueError(f"Device {device_id} missing 'topics.state'")
# 'set' topic is optional (read-only devices like contact sensors don't have it)
# No validation needed for topics.set
# Log loaded devices
device_ids = [d["device_id"] for d in devices]
@@ -153,6 +154,9 @@ async def handle_abstract_set(
if device_type == "light":
# Validate light SET payload (power and/or brightness)
LightState.model_validate(abstract_payload)
elif device_type == "relay":
# Validate relay SET payload (power only)
RelayState.model_validate(abstract_payload)
elif device_type == "thermostat":
# For thermostat SET: only allow mode and target fields
allowed_set_fields = {"mode", "target"}
@@ -166,6 +170,10 @@ async def handle_abstract_set(
# Validate against ThermostatState (current/battery/window_open are optional)
ThermostatState.model_validate(abstract_payload)
elif device_type in {"contact", "contact_sensor"}:
# Contact sensors are read-only - SET commands should not occur
logger.warning(f"Contact sensor {device_id} received SET command - ignoring (read-only device)")
return
except ValidationError as e:
logger.error(f"Validation failed for {device_type} SET {device_id}: {e}")
return
@@ -173,7 +181,13 @@ async def handle_abstract_set(
# Transform abstract payload to vendor-specific format
vendor_payload = transform_abstract_to_vendor(device_type, device_technology, abstract_payload)
vendor_message = json.dumps(vendor_payload)
# For MAX! thermostats and Shelly relays, vendor_payload is a plain string
# For other devices, it's a dict that needs JSON encoding
if (device_technology == "max" and device_type == "thermostat") or \
(device_technology == "shelly" and device_type == "relay"):
vendor_message = vendor_payload # Already a string
else:
vendor_message = json.dumps(vendor_payload)
logger.info(f"→ vendor SET {device_id}: {vendor_topic}{vendor_message}")
await mqtt_client.publish(vendor_topic, vendor_message, qos=1)
@@ -206,15 +220,27 @@ async def handle_vendor_state(
try:
if device_type == "light":
LightState.model_validate(abstract_payload)
elif device_type == "relay":
RelayState.model_validate(abstract_payload)
elif device_type == "thermostat":
# Validate thermostat state: mode, target, current (required), battery, window_open
ThermostatState.model_validate(abstract_payload)
elif device_type in {"contact", "contact_sensor"}:
# Validate contact sensor state
ContactState.model_validate(abstract_payload)
elif device_type in {"temp_humidity", "temp_humidity_sensor"}:
# Validate temperature & humidity sensor state
TempHumidityState.model_validate(abstract_payload)
except ValidationError as e:
logger.error(f"Validation failed for {device_type} STATE {device_id}: {e}")
return
# Normalize device type for topic (use 'contact' for both 'contact' and 'contact_sensor')
topic_type = "contact" if device_type in {"contact", "contact_sensor"} else device_type
topic_type = "temp_humidity" if device_type in {"temp_humidity", "temp_humidity_sensor"} else topic_type
# Publish to abstract state topic (retained)
abstract_topic = f"home/{device_type}/{device_id}/state"
abstract_topic = f"home/{topic_type}/{device_id}/state"
abstract_message = json.dumps(abstract_payload)
logger.info(f"← abstract STATE {device_id}: {abstract_topic}{abstract_message}")
@@ -268,15 +294,22 @@ async def mqtt_worker(config: dict[str, Any], redis_client: aioredis.Redis) -> N
keepalive=keepalive,
timeout=10.0 # Add explicit timeout for operations
) as client:
logger.info(f"Connected to MQTT broker as {client_id}")
logger.info(f"Connected to MQTT broker as {unique_client_id}")
# Subscribe to abstract SET topics for all devices
# Subscribe to topics for all devices
for device in devices.values():
abstract_set_topic = f"home/{device['type']}/{device['device_id']}/set"
await client.subscribe(abstract_set_topic)
logger.info(f"Subscribed to abstract SET: {abstract_set_topic}")
device_id = device['device_id']
device_type = device['type']
# Subscribe to vendor STATE topics
# Subscribe to abstract SET topic only if device has a SET topic (not read-only)
if "set" in device["topics"]:
abstract_set_topic = f"home/{device_type}/{device_id}/set"
await client.subscribe(abstract_set_topic)
logger.info(f"Subscribed to abstract SET: {abstract_set_topic}")
else:
logger.info(f"Skipping SET subscription for read-only device: {device_id}")
# Subscribe to vendor STATE topics (all devices have state)
vendor_state_topic = device["topics"]["state"]
await client.subscribe(vendor_state_topic)
logger.info(f"Subscribed to vendor STATE: {vendor_state_topic}")
@@ -294,11 +327,42 @@ async def mqtt_worker(config: dict[str, Any], redis_client: aioredis.Redis) -> N
topic = str(message.topic)
payload_str = message.payload.decode()
try:
payload = json.loads(payload_str)
except json.JSONDecodeError:
logger.warning(f"Invalid JSON on {topic}: {payload_str}")
continue
# Determine if message is from a MAX! device (requires plain text handling)
is_max_device = False
max_device_id = None
max_device_type = None
# Check if topic matches any MAX! device state topic
for device_id, device in devices.items():
if device.get("technology") == "max" and topic == device["topics"]["state"]:
is_max_device = True
max_device_id = device_id
max_device_type = device["type"]
break
# Check for Shelly relay (also sends plain text)
is_shelly_relay = False
shelly_device_id = None
shelly_device_type = None
for device_id, device in devices.items():
if device.get("technology") == "shelly" and device.get("type") == "relay":
if topic == device["topics"]["state"]:
is_shelly_relay = True
shelly_device_id = device_id
shelly_device_type = device["type"]
break
# Parse payload based on device technology
if is_max_device or is_shelly_relay:
# MAX! and Shelly send plain text, not JSON
payload = payload_str.strip()
else:
# All other technologies use JSON
try:
payload = json.loads(payload_str)
except json.JSONDecodeError:
logger.warning(f"Invalid JSON on {topic}: {payload_str}")
continue
# Check if this is an abstract SET message
if topic.startswith("home/") and topic.endswith("/set"):
@@ -318,15 +382,32 @@ async def mqtt_worker(config: dict[str, Any], redis_client: aioredis.Redis) -> N
# Check if this is a vendor STATE message
else:
# Find device by vendor state topic
for device_id, device in devices.items():
if topic == device["topics"]["state"]:
device_technology = device.get("technology", "unknown")
await handle_vendor_state(
client, redis_client, device_id, device["type"],
device_technology, payload, redis_channel
)
break
# For MAX! devices, we already identified them above
if is_max_device:
device = devices[max_device_id]
device_technology = device.get("technology", "unknown")
await handle_vendor_state(
client, redis_client, max_device_id, max_device_type,
device_technology, payload, redis_channel
)
# For Shelly relay devices, we already identified them above
elif is_shelly_relay:
device = devices[shelly_device_id]
device_technology = device.get("technology", "unknown")
await handle_vendor_state(
client, redis_client, shelly_device_id, shelly_device_type,
device_technology, payload, redis_channel
)
else:
# Find device by vendor state topic for other technologies
for device_id, device in devices.items():
if topic == device["topics"]["state"]:
device_technology = device.get("technology", "unknown")
await handle_vendor_state(
client, redis_client, device_id, device["type"],
device_technology, payload, redis_channel
)
break
except asyncio.CancelledError:
logger.info("MQTT worker cancelled")

View File

@@ -111,19 +111,345 @@ def _transform_light_zigbee2mqtt_to_abstract(payload: dict[str, Any]) -> dict[st
def _transform_thermostat_zigbee2mqtt_to_vendor(payload: dict[str, Any]) -> dict[str, Any]:
"""Transform abstract thermostat payload to zigbee2mqtt format.
zigbee2mqtt uses same format as abstract protocol (no transformation needed).
Transformations:
- target -> current_heating_setpoint (as string)
- mode is ignored (zigbee2mqtt thermostats use system_mode in state only)
Example:
- Abstract: {'target': 22.0}
- zigbee2mqtt: {'current_heating_setpoint': '22.0'}
"""
return payload
vendor_payload = {}
if "target" in payload:
# zigbee2mqtt expects current_heating_setpoint as string
vendor_payload["current_heating_setpoint"] = str(payload["target"])
return vendor_payload
def _transform_thermostat_zigbee2mqtt_to_abstract(payload: dict[str, Any]) -> dict[str, Any]:
"""Transform zigbee2mqtt thermostat payload to abstract format.
zigbee2mqtt uses same format as abstract protocol (no transformation needed).
Transformations:
- current_heating_setpoint -> target (as float)
- local_temperature -> current (as float)
- system_mode -> mode
Example:
- zigbee2mqtt: {'current_heating_setpoint': 15, 'local_temperature': 23, 'system_mode': 'heat'}
- Abstract: {'target': 15.0, 'current': 23.0, 'mode': 'heat'}
"""
abstract_payload = {}
# Extract target temperature
if "current_heating_setpoint" in payload:
setpoint = payload["current_heating_setpoint"]
abstract_payload["target"] = float(setpoint)
# Extract current temperature
if "local_temperature" in payload:
current = payload["local_temperature"]
abstract_payload["current"] = float(current)
# Extract mode
if "system_mode" in payload:
abstract_payload["mode"] = payload["system_mode"]
return abstract_payload
# ============================================================================
# HANDLER FUNCTIONS: contact_sensor - zigbee2mqtt technology
# ============================================================================
def _transform_contact_sensor_zigbee2mqtt_to_vendor(payload: dict[str, Any]) -> dict[str, Any]:
"""Transform abstract contact sensor payload to zigbee2mqtt format.
Contact sensors are read-only, so this should not be called for SET commands.
Returns payload as-is for compatibility.
"""
logger.warning("Contact sensors are read-only - SET commands should not be used")
return payload
def _transform_contact_sensor_zigbee2mqtt_to_abstract(payload: dict[str, Any]) -> dict[str, Any]:
"""Transform zigbee2mqtt contact sensor payload to abstract format.
Transformations:
- contact: bool -> "open" | "closed"
- zigbee2mqtt semantics: False = OPEN, True = CLOSED (inverted!)
- battery: pass through (already 0-100)
- linkquality: pass through
- device_temperature: pass through (if present)
- voltage: pass through (if present)
Example:
- zigbee2mqtt: {"contact": false, "battery": 100, "linkquality": 87}
- Abstract: {"contact": "open", "battery": 100, "linkquality": 87}
"""
abstract_payload = {}
# Transform contact state (inverted logic!)
if "contact" in payload:
contact_bool = payload["contact"]
# zigbee2mqtt: False = OPEN, True = CLOSED
abstract_payload["contact"] = "closed" if contact_bool else "open"
# Pass through optional fields
if "battery" in payload:
abstract_payload["battery"] = payload["battery"]
if "linkquality" in payload:
abstract_payload["linkquality"] = payload["linkquality"]
if "device_temperature" in payload:
abstract_payload["device_temperature"] = payload["device_temperature"]
if "voltage" in payload:
abstract_payload["voltage"] = payload["voltage"]
return abstract_payload
# ============================================================================
# HANDLER FUNCTIONS: contact_sensor - max technology (Homegear MAX!)
# ============================================================================
def _transform_contact_sensor_max_to_vendor(payload: dict[str, Any]) -> dict[str, Any]:
"""Transform abstract contact sensor payload to MAX! format.
Contact sensors are read-only, so this should not be called for SET commands.
Returns payload as-is for compatibility.
"""
logger.warning("Contact sensors are read-only - SET commands should not be used")
return payload
def _transform_contact_sensor_max_to_abstract(payload: str | bool | dict[str, Any]) -> dict[str, Any]:
"""Transform MAX! (Homegear) contact sensor payload to abstract format.
MAX! sends "true"/"false" (string or bool) on STATE topic.
Transformations:
- "true" or True -> "open" (window/door open)
- "false" or False -> "closed" (window/door closed)
Example:
- MAX!: "true" or True
- Abstract: {"contact": "open"}
"""
try:
# Handle string, bool, or dict input
if isinstance(payload, dict):
# If already a dict, extract contact field
contact_value = payload.get("contact", False)
elif isinstance(payload, str):
# Parse string to bool
contact_value = payload.strip().lower() == "true"
elif isinstance(payload, bool):
# Use bool directly
contact_value = payload
else:
logger.warning(f"MAX! contact sensor unexpected payload type: {type(payload)}, value: {payload}")
contact_value = False
# MAX! semantics: True = OPEN, False = CLOSED
return {
"contact": "open" if contact_value else "closed"
}
except (ValueError, TypeError) as e:
logger.error(f"MAX! contact sensor failed to parse: {payload}, error: {e}")
return {
"contact": "closed" # Default to closed on error
}
# ============================================================================
# HANDLER FUNCTIONS: temp_humidity_sensor - zigbee2mqtt technology
# ============================================================================
def _transform_temp_humidity_sensor_zigbee2mqtt_to_vendor(payload: dict[str, Any]) -> dict[str, Any]:
"""Transform abstract temp/humidity sensor payload to zigbee2mqtt format.
Temp/humidity sensors are read-only, so this should not be called for SET commands.
Returns payload as-is for compatibility.
"""
return payload
def _transform_temp_humidity_sensor_zigbee2mqtt_to_abstract(payload: dict[str, Any]) -> dict[str, Any]:
"""Transform zigbee2mqtt temp/humidity sensor payload to abstract format.
Passthrough - zigbee2mqtt provides temperature, humidity, battery, linkquality directly.
"""
return payload
# ============================================================================
# HANDLER FUNCTIONS: temp_humidity_sensor - MAX! technology
# ============================================================================
def _transform_temp_humidity_sensor_max_to_vendor(payload: dict[str, Any]) -> dict[str, Any]:
"""Transform abstract temp/humidity sensor payload to MAX! format.
Temp/humidity sensors are read-only, so this should not be called for SET commands.
Returns payload as-is for compatibility.
"""
return payload
def _transform_temp_humidity_sensor_max_to_abstract(payload: dict[str, Any]) -> dict[str, Any]:
"""Transform MAX! temp/humidity sensor payload to abstract format.
Passthrough - MAX! provides temperature, humidity, battery directly.
"""
return payload
# ============================================================================
# HANDLER FUNCTIONS: relay - zigbee2mqtt technology
# ============================================================================
def _transform_relay_zigbee2mqtt_to_vendor(payload: dict[str, Any]) -> dict[str, Any]:
"""Transform abstract relay payload to zigbee2mqtt format.
Relay only has power on/off, same transformation as light.
- power: 'on'/'off' -> state: 'ON'/'OFF'
"""
vendor_payload = payload.copy()
if "power" in vendor_payload:
power_value = vendor_payload.pop("power")
vendor_payload["state"] = power_value.upper() if isinstance(power_value, str) else power_value
return vendor_payload
def _transform_relay_zigbee2mqtt_to_abstract(payload: dict[str, Any]) -> dict[str, Any]:
"""Transform zigbee2mqtt relay payload to abstract format.
Relay only has power on/off, same transformation as light.
- state: 'ON'/'OFF' -> power: 'on'/'off'
"""
abstract_payload = payload.copy()
if "state" in abstract_payload:
state_value = abstract_payload.pop("state")
abstract_payload["power"] = state_value.lower() if isinstance(state_value, str) else state_value
return abstract_payload
# ============================================================================
# HANDLER FUNCTIONS: relay - shelly technology
# ============================================================================
def _transform_relay_shelly_to_vendor(payload: dict[str, Any]) -> str:
"""Transform abstract relay payload to Shelly format.
Shelly expects plain text 'on' or 'off' (not JSON).
- power: 'on'/'off' -> 'on'/'off' (plain string)
Example:
- Abstract: {'power': 'on'}
- Shelly: 'on'
"""
power = payload.get("power", "off")
return power
def _transform_relay_shelly_to_abstract(payload: str) -> dict[str, Any]:
"""Transform Shelly relay payload to abstract format.
Shelly sends plain text 'on' or 'off' (not JSON).
- 'on'/'off' -> power: 'on'/'off'
Example:
- Shelly: 'on'
- Abstract: {'power': 'on'}
"""
# Shelly payload is a plain string, not a dict
if isinstance(payload, str):
return {"power": payload.strip()}
# Fallback if it's already a dict (shouldn't happen)
return payload
# ============================================================================
# HANDLER FUNCTIONS: max technology (Homegear MAX!)
# ============================================================================
def _transform_thermostat_max_to_vendor(payload: dict[str, Any]) -> str:
"""Transform abstract thermostat payload to MAX! (Homegear) format.
MAX! expects only the integer temperature value (no JSON).
Transformations:
- Extract 'target' temperature from payload
- Convert float to integer (MAX! only accepts integers)
- Return as plain string value
Example:
- Abstract: {'mode': 'heat', 'target': 22.5}
- MAX!: "22"
Note: MAX! ignores mode - it's always in heating mode
"""
if "target" not in payload:
logger.warning(f"MAX! thermostat payload missing 'target': {payload}")
return "21" # Default fallback
target_temp = payload["target"]
# Convert to integer (MAX! protocol requirement)
if isinstance(target_temp, (int, float)):
int_temp = int(round(target_temp))
return str(int_temp)
logger.warning(f"MAX! invalid target temperature type: {type(target_temp)}, value: {target_temp}")
return "21"
def _transform_thermostat_max_to_abstract(payload: str | int | float) -> dict[str, Any]:
"""Transform MAX! (Homegear) thermostat payload to abstract format.
MAX! sends only the integer temperature value (no JSON).
Transformations:
- Parse plain string/int value
- Convert to float for abstract protocol
- Wrap in abstract payload structure with mode='heat'
Example:
- MAX!: "22" or 22
- Abstract: {'target': 22.0, 'mode': 'heat'}
Note: MAX! doesn't send current temperature via SET_TEMPERATURE topic
"""
try:
# Handle both string and numeric input
if isinstance(payload, str):
target_temp = float(payload.strip())
elif isinstance(payload, (int, float)):
target_temp = float(payload)
else:
logger.warning(f"MAX! unexpected payload type: {type(payload)}, value: {payload}")
target_temp = 21.0
return {
"target": target_temp,
"mode": "heat" # MAX! is always in heating mode
}
except (ValueError, TypeError) as e:
logger.error(f"MAX! failed to parse temperature: {payload}, error: {e}")
return {
"target": 21.0,
"mode": "heat"
}
# ============================================================================
# REGISTRY: Maps (device_type, technology, direction) -> handler function
# ============================================================================
@@ -142,6 +468,34 @@ TRANSFORM_HANDLERS: dict[tuple[str, str, str], TransformHandler] = {
("thermostat", "simulator", "to_abstract"): _transform_thermostat_simulator_to_abstract,
("thermostat", "zigbee2mqtt", "to_vendor"): _transform_thermostat_zigbee2mqtt_to_vendor,
("thermostat", "zigbee2mqtt", "to_abstract"): _transform_thermostat_zigbee2mqtt_to_abstract,
("thermostat", "max", "to_vendor"): _transform_thermostat_max_to_vendor,
("thermostat", "max", "to_abstract"): _transform_thermostat_max_to_abstract,
# Contact sensor transformations (support both 'contact' and 'contact_sensor' types)
("contact_sensor", "zigbee2mqtt", "to_vendor"): _transform_contact_sensor_zigbee2mqtt_to_vendor,
("contact_sensor", "zigbee2mqtt", "to_abstract"): _transform_contact_sensor_zigbee2mqtt_to_abstract,
("contact_sensor", "max", "to_vendor"): _transform_contact_sensor_max_to_vendor,
("contact_sensor", "max", "to_abstract"): _transform_contact_sensor_max_to_abstract,
("contact", "zigbee2mqtt", "to_vendor"): _transform_contact_sensor_zigbee2mqtt_to_vendor,
("contact", "zigbee2mqtt", "to_abstract"): _transform_contact_sensor_zigbee2mqtt_to_abstract,
("contact", "max", "to_vendor"): _transform_contact_sensor_max_to_vendor,
("contact", "max", "to_abstract"): _transform_contact_sensor_max_to_abstract,
# Temperature & humidity sensor transformations (support both type aliases)
("temp_humidity_sensor", "zigbee2mqtt", "to_vendor"): _transform_temp_humidity_sensor_zigbee2mqtt_to_vendor,
("temp_humidity_sensor", "zigbee2mqtt", "to_abstract"): _transform_temp_humidity_sensor_zigbee2mqtt_to_abstract,
("temp_humidity_sensor", "max", "to_vendor"): _transform_temp_humidity_sensor_max_to_vendor,
("temp_humidity_sensor", "max", "to_abstract"): _transform_temp_humidity_sensor_max_to_abstract,
("temp_humidity", "zigbee2mqtt", "to_vendor"): _transform_temp_humidity_sensor_zigbee2mqtt_to_vendor,
("temp_humidity", "zigbee2mqtt", "to_abstract"): _transform_temp_humidity_sensor_zigbee2mqtt_to_abstract,
("temp_humidity", "max", "to_vendor"): _transform_temp_humidity_sensor_max_to_vendor,
("temp_humidity", "max", "to_abstract"): _transform_temp_humidity_sensor_max_to_abstract,
# Relay transformations
("relay", "zigbee2mqtt", "to_vendor"): _transform_relay_zigbee2mqtt_to_vendor,
("relay", "zigbee2mqtt", "to_abstract"): _transform_relay_zigbee2mqtt_to_abstract,
("relay", "shelly", "to_vendor"): _transform_relay_shelly_to_vendor,
("relay", "shelly", "to_abstract"): _transform_relay_shelly_to_abstract,
}

View File

@@ -1,4 +1,144 @@
"""API main entry point."""
"""API main entry point.
API-Analyse für HomeKit-Bridge Kompatibilität
==============================================
1) GET /devices
Status: ✅ VORHANDEN (Zeile 325-343)
Aktuelles Response-Modell (DeviceInfo, Zeile 189-194):
{
"device_id": str, ✅ OK
"type": str, ✅ OK
"name": str, ⚠️ ABWEICHUNG: Erwartet wurde "short_name" (optional)
"features": dict ✅ OK
}
Bewertung:
- ✅ Liefert device_id, type, features wie erwartet
- ⚠️ Verwendet "name" statt "short_name"
- ✅ Fallback auf device_id wenn name nicht vorhanden
- Kompatibilität: HOCH - einfach "name" als "short_name" verwenden
2) GET /layout
Status: ✅ VORHANDEN (Zeile 354-387)
Aktuelles Response-Format:
{
"rooms": [
{
"name": "Schlafzimmer",
"devices": [
{
"device_id": "thermostat_wolfgang",
"title": "Thermostat Wolfgang", ← friendly_name
"icon": "thermometer",
"rank": 1
}
]
}
]
}
Mapping device_id -> room, friendly_name:
- room: Durch Iteration über rooms[].devices[] ableitbar
- friendly_name: Im Feld "title" enthalten
Bewertung:
- ✅ Alle erforderlichen Informationen vorhanden
- ⚠️ ABWEICHUNG: Verschachtelte Struktur (rooms -> devices)
- ⚠️ ABWEICHUNG: friendly_name heißt "title"
- Kompatibilität: HOCH - einfache Transformation möglich:
```python
for room in layout["rooms"]:
for device in room["devices"]:
mapping[device["device_id"]] = {
"room": room["name"],
"friendly_name": device["title"]
}
```
3) POST /devices/{device_id}/set
Status: ✅ VORHANDEN (Zeile 406-504)
Aktuelles Request-Modell (SetDeviceRequest, Zeile 182-185):
{
"type": str, ✅ OK - muss zum Gerätetyp passen
"payload": dict ✅ OK - abstraktes Kommando
}
Beispiel Light:
POST /devices/leselampe_esszimmer/set
{"type": "light", "payload": {"power": "on", "brightness": 80}}
Beispiel Thermostat:
POST /devices/thermostat_wolfgang/set
{"type": "thermostat", "payload": {"target": 21.0}}
Validierung:
- ✅ Type-spezifische Payload-Validierung (Zeile 437-487)
- ✅ Read-only Check → 405 METHOD_NOT_ALLOWED (Zeile 431-435)
- ✅ Ungültige Payload → 422 UNPROCESSABLE_ENTITY
- ✅ Device nicht gefunden → 404 NOT_FOUND
Bewertung:
- ✅ Exakt wie erwartet implementiert
- ✅ Alle geforderten Error Codes vorhanden
- Kompatibilität: PERFEKT
4) Realtime-Endpoint (SSE)
Status: ✅ VORHANDEN als GET /realtime (Zeile 608-632)
Implementierung:
- ✅ Server-Sent Events (media_type="text/event-stream")
- ✅ Redis Pub/Sub basiert (event_generator, Zeile 510-607)
- ✅ Safari-kompatibel (Heartbeats, Retry-Hints)
Aktuelles Event-Format (aus apps/abstraction/main.py:250-256):
{
"type": "state", ✅ OK
"device_id": str, ✅ OK
"payload": dict, ✅ OK - z.B. {"power":"on","brightness":80}
"ts": str ✅ OK - ISO-8601 format von datetime.now(timezone.utc)
}
Beispiel-Event:
{
"type": "state",
"device_id": "thermostat_wolfgang",
"payload": {"current": 19.5, "target": 21.0},
"ts": "2025-11-17T14:23:45.123456+00:00"
}
Bewertung:
- ✅ Alle geforderten Felder vorhanden
- ✅ Timestamp im korrekten Format
- ✅ SSE mit proper headers und error handling
- Kompatibilität: PERFEKT
ZUSAMMENFASSUNG
===============
Alle 4 geforderten Endpunkte sind implementiert!
Kompatibilität mit HomeKit-Bridge Anforderungen:
- GET /devices: HOCH (nur Name-Feld unterschiedlich)
- GET /layout: HOCH (Struktur-Transformation nötig)
- POST /devices/{id}/set: PERFEKT (1:1 wie gefordert)
- GET /realtime (SSE): PERFEKT (1:1 wie gefordert)
Erforderliche Anpassungen für Bridge:
1. GET /devices: "name" als "short_name" interpretieren ✓ trivial
2. GET /layout: Verschachtelte Struktur zu flat mapping umwandeln ✓ einfach
Keine Code-Änderungen in der API erforderlich!
Die Bridge kann die bestehenden Endpoints direkt nutzen.
"""
import asyncio
import json
@@ -15,10 +155,37 @@ from fastapi.middleware.cors import CORSMiddleware
from fastapi.responses import StreamingResponse
from pydantic import BaseModel, ValidationError
from packages.home_capabilities import LIGHT_VERSION, THERMOSTAT_VERSION, LightState, ThermostatState
from packages.home_capabilities import (
LIGHT_VERSION,
THERMOSTAT_VERSION,
CONTACT_SENSOR_VERSION,
TEMP_HUMIDITY_SENSOR_VERSION,
RELAY_VERSION,
LightState,
ThermostatState,
ContactState,
TempHumidityState,
RelayState,
load_layout,
)
# Import resolvers (must be before router imports to avoid circular dependency)
from apps.api.resolvers import (
DeviceDTO,
resolve_group_devices,
resolve_scene_step_devices,
load_device_rooms,
get_room,
clear_room_cache,
)
logger = logging.getLogger(__name__)
# ============================================================================
# STATE CACHES
# ============================================================================
# In-memory cache for last known device states
# Will be populated from Redis pub/sub messages
device_states: dict[str, dict[str, Any]] = {}
@@ -46,6 +213,13 @@ app.add_middleware(
)
@app.on_event("startup")
async def startup_event():
"""Include routers after app is initialized to avoid circular imports."""
from apps.api.routes.groups_scenes import router as groups_scenes_router
app.include_router(groups_scenes_router, prefix="")
@app.get("/health")
async def health() -> dict[str, str]:
"""Health check endpoint.
@@ -137,7 +311,10 @@ async def spec() -> dict[str, dict[str, str]]:
return {
"capabilities": {
"light": LIGHT_VERSION,
"thermostat": THERMOSTAT_VERSION
"thermostat": THERMOSTAT_VERSION,
"contact": CONTACT_SENSOR_VERSION,
"temp_humidity": TEMP_HUMIDITY_SENSOR_VERSION,
"relay": RELAY_VERSION
}
}
@@ -193,6 +370,50 @@ def get_mqtt_settings() -> tuple[str, int]:
return host, port
# ============================================================================
# MQTT PUBLISH
# ============================================================================
async def publish_abstract_set(device_type: str, device_id: str, payload: dict[str, Any]) -> None:
"""
Publish an abstract set command via MQTT.
This function encapsulates MQTT publishing logic so that group/scene
execution doesn't need to know MQTT topic details.
Topic format: home/{device_type}/{device_id}/set
Message format: {"type": device_type, "payload": payload}
Args:
device_type: Device type (light, thermostat, relay, etc.)
device_id: Device identifier
payload: Command payload (e.g., {"power": "on", "brightness": 50})
Example:
>>> await publish_abstract_set("light", "kueche_deckenlampe", {"power": "on", "brightness": 35})
# Publishes to: home/light/kueche_deckenlampe/set
# Message: {"type": "light", "payload": {"power": "on", "brightness": 35}}
"""
mqtt_host, mqtt_port = get_mqtt_settings()
topic = f"home/{device_type}/{device_id}/set"
message = {
"type": device_type,
"payload": payload
}
try:
async with Client(hostname=mqtt_host, port=mqtt_port) as client:
await client.publish(
topic=topic,
payload=json.dumps(message),
qos=1
)
logger.info(f"Published to {topic}: {message}")
except Exception as e:
logger.error(f"Failed to publish to {topic}: {e}")
raise
def get_redis_settings() -> tuple[str, str]:
"""Get Redis settings from configuration.
@@ -277,8 +498,6 @@ async def get_layout() -> dict[str, Any]:
Returns:
dict: Layout configuration with rooms and device tiles
"""
from packages.home_capabilities import load_layout
try:
layout = load_layout()
@@ -307,6 +526,23 @@ async def get_layout() -> dict[str, Any]:
return {"rooms": []}
@app.get("/devices/{device_id}/room")
async def get_device_room(device_id: str) -> dict[str, str | None]:
"""Get the room name for a specific device.
Args:
device_id: Device identifier
Returns:
dict: {"device_id": str, "room": str | null}
"""
room = get_room(device_id)
return {
"device_id": device_id,
"room": room
}
@app.post("/devices/{device_id}/set", status_code=status.HTTP_202_ACCEPTED)
async def set_device(device_id: str, request: SetDeviceRequest) -> dict[str, str]:
"""Set device state.
@@ -331,6 +567,13 @@ async def set_device(device_id: str, request: SetDeviceRequest) -> dict[str, str
detail=f"Device {device_id} not found"
)
# Check if device is read-only (contact sensors, etc.)
if "topics" in device and "set" not in device["topics"]:
raise HTTPException(
status_code=status.HTTP_405_METHOD_NOT_ALLOWED,
detail="Device is read-only"
)
# Validate payload based on device type
if request.type == "light":
try:
@@ -340,6 +583,14 @@ async def set_device(device_id: str, request: SetDeviceRequest) -> dict[str, str
status_code=status.HTTP_422_UNPROCESSABLE_ENTITY,
detail=f"Invalid payload for light: {e}"
)
elif request.type == "relay":
try:
RelayState(**request.payload)
except ValidationError as e:
raise HTTPException(
status_code=status.HTTP_422_UNPROCESSABLE_ENTITY,
detail=f"Invalid payload for relay: {e}"
)
elif request.type == "thermostat":
try:
# For thermostat SET: only allow mode and target
@@ -356,6 +607,18 @@ async def set_device(device_id: str, request: SetDeviceRequest) -> dict[str, str
status_code=status.HTTP_422_UNPROCESSABLE_ENTITY,
detail=f"Invalid payload for thermostat: {e}"
)
elif request.type in {"contact", "contact_sensor"}:
# Contact sensors are read-only
raise HTTPException(
status_code=status.HTTP_405_METHOD_NOT_ALLOWED,
detail="Contact sensors are read-only devices"
)
elif request.type in {"temp_humidity", "temp_humidity_sensor"}:
# Temperature & humidity sensors are read-only
raise HTTPException(
status_code=status.HTTP_405_METHOD_NOT_ALLOWED,
detail="Temperature & humidity sensors are read-only devices"
)
else:
raise HTTPException(
status_code=status.HTTP_422_UNPROCESSABLE_ENTITY,

286
apps/api/resolvers.py Normal file
View File

@@ -0,0 +1,286 @@
"""Group and scene resolution logic."""
import logging
from pathlib import Path
from typing import Any, TypedDict
from packages.home_capabilities import (
GroupConfig,
GroupsConfigRoot,
SceneStep,
get_group_by_id,
load_layout,
)
logger = logging.getLogger(__name__)
# ============================================================================
# TYPE DEFINITIONS
# ============================================================================
class DeviceDTO(TypedDict, total=False):
"""Device Data Transfer Object.
Represents a device as returned by /devices endpoint or load_devices().
Required fields:
device_id: Unique device identifier
type: Device type (light, thermostat, relay, etc.)
Optional fields:
name: Human-readable device name
features: Device capabilities (power, brightness, etc.)
technology: MQTT, zigbee2mqtt, simulator, etc.
topics: MQTT topic configuration
metadata: Additional device information
"""
device_id: str
type: str
name: str
features: dict[str, Any]
technology: str
topics: dict[str, str]
metadata: dict[str, Any]
# ============================================================================
# DEVICE-ROOM MAPPING
# ============================================================================
# Global cache for device -> room mapping
_device_room_cache: dict[str, str] = {}
def load_device_rooms(path: str | Path | None = None) -> dict[str, str]:
"""
Load device-to-room mapping from layout configuration.
This function extracts a mapping of device_id -> room_name from the layout.yaml
file, which is useful for resolving selectors like {room: "Küche"}.
Args:
path: Optional path to layout.yaml. If None, uses default path
(config/layout.yaml relative to workspace root)
Returns:
Dictionary mapping device_id to room_name. Returns empty dict if:
- layout.yaml doesn't exist
- layout.yaml is malformed
- layout.yaml is empty
Example:
>>> mapping = load_device_rooms()
>>> mapping['kueche_lampe1']
'Küche'
"""
global _device_room_cache
try:
# Load the layout using existing function
layout = load_layout(path)
# Build device -> room mapping
device_rooms: dict[str, str] = {}
for room in layout.rooms:
for device in room.devices:
device_rooms[device.device_id] = room.name
# Update global cache
_device_room_cache = device_rooms.copy()
logger.info(f"Loaded device-room mapping: {len(device_rooms)} devices")
return device_rooms
except (FileNotFoundError, ValueError, Exception) as e:
logger.warning(f"Failed to load device-room mapping: {e}")
logger.warning("Returning empty device-room mapping")
_device_room_cache = {}
return {}
def get_room(device_id: str) -> str | None:
"""
Get the room name for a given device ID.
This function uses the cached device-room mapping loaded by load_device_rooms().
If the cache is empty, it will attempt to load it first.
Args:
device_id: The device identifier to lookup
Returns:
Room name if device is found, None otherwise
Example:
>>> get_room('kueche_lampe1')
'Küche'
>>> get_room('nonexistent_device')
None
"""
# Check if cache is populated
if not _device_room_cache:
logger.debug("Device-room cache empty, loading from layout...")
# Load mapping (this updates the global _device_room_cache)
load_device_rooms()
# Access the cache after potential reload
return _device_room_cache.get(device_id)
def clear_room_cache() -> None:
"""
Clear the cached device-room mapping.
This is useful for testing or when the layout configuration has changed
and needs to be reloaded.
"""
_device_room_cache.clear()
logger.debug("Cleared device-room cache")
# ============================================================================
# GROUP & SCENE RESOLUTION
# ============================================================================
def resolve_group_devices(
group: GroupConfig,
devices: list[DeviceDTO],
device_rooms: dict[str, str]
) -> list[DeviceDTO]:
"""
Resolve devices for a group based on device_ids or selector.
Args:
group: Group configuration with device_ids or selector
devices: List of all available devices
device_rooms: Mapping of device_id -> room_name
Returns:
List of devices matching the group criteria (no duplicates)
Example:
>>> # Group with explicit device_ids
>>> group = GroupConfig(id="test", name="Test", device_ids=["lamp1", "lamp2"])
>>> resolve_group_devices(group, all_devices, {})
[{"device_id": "lamp1", ...}, {"device_id": "lamp2", ...}]
>>> # Group with selector (all lights in kitchen)
>>> group = GroupConfig(
... id="kitchen_lights",
... name="Kitchen Lights",
... selector=GroupSelector(type="light", room="Küche")
... )
>>> resolve_group_devices(group, all_devices, device_rooms)
[{"device_id": "kueche_deckenlampe", ...}, ...]
"""
# Case 1: Explicit device_ids
if group.device_ids:
device_id_set = set(group.device_ids)
return [d for d in devices if d["device_id"] in device_id_set]
# Case 2: Selector-based filtering
if group.selector:
filtered = []
for device in devices:
# Filter by type (required in selector)
if device["type"] != group.selector.type:
continue
# Filter by room (optional)
if group.selector.room:
device_room = device_rooms.get(device["device_id"])
if device_room != group.selector.room:
continue
# Filter by tags (optional, future feature)
# if group.selector.tags:
# device_tags = device.get("metadata", {}).get("tags", [])
# if not any(tag in device_tags for tag in group.selector.tags):
# continue
filtered.append(device)
return filtered
# No device_ids and no selector → empty list
return []
def resolve_scene_step_devices(
step: SceneStep,
groups_config: GroupsConfigRoot,
devices: list[DeviceDTO],
device_rooms: dict[str, str]
) -> list[DeviceDTO]:
"""
Resolve devices for a scene step based on group_id or selector.
Args:
step: Scene step with group_id or selector
groups_config: Groups configuration for group lookup
devices: List of all available devices
device_rooms: Mapping of device_id -> room_name
Returns:
List of devices matching the step criteria
Raises:
ValueError: If group_id is specified but group not found
Example:
>>> # Step with group_id
>>> step = SceneStep(group_id="kitchen_lights", action={...})
>>> resolve_scene_step_devices(step, groups_cfg, all_devices, device_rooms)
[{"device_id": "kueche_deckenlampe", ...}, ...]
>>> # Step with selector
>>> step = SceneStep(
... selector=SceneSelector(type="light", room="Küche"),
... action={...}
... )
>>> resolve_scene_step_devices(step, groups_cfg, all_devices, device_rooms)
[{"device_id": "kueche_deckenlampe", ...}, ...]
"""
# Case 1: Group reference
if step.group_id:
# Look up the group
group = get_group_by_id(groups_config, step.group_id)
if not group:
raise ValueError(
f"Scene step references unknown group_id: '{step.group_id}'. "
f"Available groups: {[g.id for g in groups_config.groups]}"
)
# Resolve the group's devices
return resolve_group_devices(group, devices, device_rooms)
# Case 2: Direct selector
if step.selector:
filtered = []
for device in devices:
# Filter by type (optional in scene selector)
if step.selector.type and device["type"] != step.selector.type:
continue
# Filter by room (optional)
if step.selector.room:
device_room = device_rooms.get(device["device_id"])
if device_room != step.selector.room:
continue
# Filter by tags (optional, future feature)
# if step.selector.tags:
# device_tags = device.get("metadata", {}).get("tags", [])
# if not any(tag in device_tags for tag in step.selector.tags):
# continue
filtered.append(device)
return filtered
# Should not reach here due to SceneStep validation (must have group_id or selector)
return []

View File

@@ -0,0 +1 @@
"""API routes package."""

View File

@@ -0,0 +1,454 @@
"""Groups and Scenes API routes."""
import asyncio
import logging
from pathlib import Path
from typing import Any
from fastapi import APIRouter, HTTPException, status
from pydantic import BaseModel
from packages.home_capabilities import (
GroupConfig,
GroupsConfigRoot,
SceneConfig,
ScenesConfigRoot,
get_group_by_id,
get_scene_by_id,
load_groups,
load_scenes,
)
# Import from parent modules
import sys
sys.path.insert(0, str(Path(__file__).parent.parent))
from resolvers import (
DeviceDTO,
resolve_group_devices,
resolve_scene_step_devices,
load_device_rooms,
)
from main import load_devices, publish_abstract_set
logger = logging.getLogger(__name__)
router = APIRouter()
# ============================================================================
# REQUEST/RESPONSE MODELS
# ============================================================================
class GroupResponse(BaseModel):
"""Response model for a group."""
id: str
name: str
device_count: int
devices: list[str]
selector: dict[str, Any] | None = None
capabilities: dict[str, bool]
class GroupSetRequest(BaseModel):
"""Request to set state for all devices in a group."""
action: dict[str, Any] # e.g., {"type": "light", "payload": {"power": "on", "brightness": 50}}
class SceneResponse(BaseModel):
"""Response model for a scene."""
id: str
name: str
steps: int
class SceneRunRequest(BaseModel):
"""Request to execute a scene (currently empty, future: override params)."""
pass
class SceneExecutionResponse(BaseModel):
"""Response after scene execution."""
scene_id: str
scene_name: str
steps_executed: int
devices_affected: int
execution_plan: list[dict[str, Any]]
# ============================================================================
# GROUPS ENDPOINTS
# ============================================================================
@router.get("/groups", response_model=list[GroupResponse], tags=["groups"])
async def list_groups() -> list[GroupResponse]:
"""
List all available groups.
Returns:
list[GroupResponse]: List of groups with their devices
"""
try:
# Load configuration
groups_config = load_groups(Path(__file__).parent.parent.parent.parent / "config" / "groups.yaml")
devices = load_devices()
device_rooms = load_device_rooms()
# Build response for each group
response = []
for group in groups_config.groups:
# Resolve devices for this group
resolved_devices = resolve_group_devices(group, devices, device_rooms)
device_ids = [d["device_id"] for d in resolved_devices]
# Convert selector to dict if present
selector_dict = None
if group.selector:
selector_dict = {
"type": group.selector.type,
"room": group.selector.room,
"tags": group.selector.tags,
}
response.append(GroupResponse(
id=group.id,
name=group.name,
device_count=len(device_ids),
devices=device_ids,
selector=selector_dict,
capabilities=group.capabilities,
))
return response
except Exception as e:
logger.error(f"Error loading groups: {e}")
raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
detail=f"Failed to load groups: {str(e)}"
)
@router.get("/groups/{group_id}", response_model=GroupResponse, tags=["groups"])
async def get_group(group_id: str) -> GroupResponse:
"""
Get details for a specific group.
Args:
group_id: Group identifier
Returns:
GroupResponse: Group details with resolved devices
"""
try:
# Load configuration
groups_config = load_groups(Path(__file__).parent.parent.parent.parent / "config" / "groups.yaml")
devices = load_devices()
device_rooms = load_device_rooms()
# Find the group
group = get_group_by_id(groups_config, group_id)
if not group:
available_groups = [g.id for g in groups_config.groups]
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND,
detail=f"Group '{group_id}' not found. Available groups: {available_groups}"
)
# Resolve devices
resolved_devices = resolve_group_devices(group, devices, device_rooms)
device_ids = [d["device_id"] for d in resolved_devices]
# Convert selector to dict if present
selector_dict = None
if group.selector:
selector_dict = {
"type": group.selector.type,
"room": group.selector.room,
"tags": group.selector.tags,
}
return GroupResponse(
id=group.id,
name=group.name,
device_count=len(device_ids),
devices=device_ids,
selector=selector_dict,
capabilities=group.capabilities,
)
except HTTPException:
raise
except Exception as e:
logger.error(f"Error getting group {group_id}: {e}")
raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
detail=f"Failed to get group: {str(e)}"
)
@router.post("/groups/{group_id}/set", status_code=status.HTTP_202_ACCEPTED, tags=["groups"])
async def set_group(group_id: str, request: GroupSetRequest) -> dict[str, Any]:
"""
Set state for all devices in a group.
This endpoint resolves the group to its devices and would send
the action to each device. Currently returns execution plan.
Args:
group_id: Group identifier
request: Action to apply to all devices in the group
Returns:
dict: Execution plan (devices and actions to be executed)
"""
try:
# Load configuration
groups_config = load_groups(Path(__file__).parent.parent.parent.parent / "config" / "groups.yaml")
devices = load_devices()
device_rooms = load_device_rooms()
# Find the group
group = get_group_by_id(groups_config, group_id)
if not group:
available_groups = [g.id for g in groups_config.groups]
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND,
detail=f"Group '{group_id}' not found. Available groups: {available_groups}"
)
# Resolve devices
resolved_devices = resolve_group_devices(group, devices, device_rooms)
if not resolved_devices:
logger.warning(f"Group '{group_id}' resolved to 0 devices")
# Execute actions via MQTT
execution_plan = []
for device in resolved_devices:
device_type = device["type"]
device_id = device["device_id"]
payload = request.action.get("payload", {})
# Publish MQTT command
try:
await publish_abstract_set(device_type, device_id, payload)
execution_plan.append({
"device_id": device_id,
"device_type": device_type,
"action": request.action,
"status": "published"
})
except Exception as e:
logger.error(f"Failed to publish to {device_id}: {e}")
execution_plan.append({
"device_id": device_id,
"device_type": device_type,
"action": request.action,
"status": "failed",
"error": str(e)
})
return {
"group_id": group_id,
"group_name": group.name,
"devices_affected": len(resolved_devices),
"execution_plan": execution_plan,
"status": "executed"
}
except HTTPException:
raise
except Exception as e:
logger.error(f"Error setting group {group_id}: {e}")
raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
detail=f"Failed to set group: {str(e)}"
)
# ============================================================================
# SCENES ENDPOINTS
# ============================================================================
@router.get("/scenes", response_model=list[SceneResponse], tags=["scenes"])
async def list_scenes() -> list[SceneResponse]:
"""
List all available scenes.
Returns:
list[SceneResponse]: List of scenes
"""
try:
# Load configuration
scenes_config = load_scenes(Path(__file__).parent.parent.parent.parent / "config" / "scenes.yaml")
# Build response for each scene
response = []
for scene in scenes_config.scenes:
response.append(SceneResponse(
id=scene.id,
name=scene.name,
steps=len(scene.steps),
))
return response
except Exception as e:
logger.error(f"Error loading scenes: {e}")
raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
detail=f"Failed to load scenes: {str(e)}"
)
@router.get("/scenes/{scene_id}", response_model=SceneResponse, tags=["scenes"])
async def get_scene(scene_id: str) -> SceneResponse:
"""
Get details for a specific scene.
Args:
scene_id: Scene identifier
Returns:
SceneResponse: Scene details
"""
try:
# Load configuration
scenes_config = load_scenes(Path(__file__).parent.parent.parent.parent / "config" / "scenes.yaml")
# Find the scene
scene = get_scene_by_id(scenes_config, scene_id)
if not scene:
available_scenes = [s.id for s in scenes_config.scenes]
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND,
detail=f"Scene '{scene_id}' not found. Available scenes: {available_scenes}"
)
return SceneResponse(
id=scene.id,
name=scene.name,
steps=len(scene.steps),
)
except HTTPException:
raise
except Exception as e:
logger.error(f"Error getting scene {scene_id}: {e}")
raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
detail=f"Failed to get scene: {str(e)}"
)
@router.post("/scenes/{scene_id}/run", response_model=SceneExecutionResponse, tags=["scenes"])
async def run_scene(scene_id: str, request: SceneRunRequest | None = None) -> SceneExecutionResponse:
"""
Execute a scene.
This endpoint resolves each step in the scene to its target devices
and would execute the actions. Currently returns execution plan.
Args:
scene_id: Scene identifier
request: Optional execution parameters (reserved for future use)
Returns:
SceneExecutionResponse: Execution plan and summary
"""
try:
# Load configuration
scenes_config = load_scenes(Path(__file__).parent.parent.parent.parent / "config" / "scenes.yaml")
groups_config = load_groups(Path(__file__).parent.parent.parent.parent / "config" / "groups.yaml")
devices = load_devices()
device_rooms = load_device_rooms()
# Find the scene
scene = get_scene_by_id(scenes_config, scene_id)
if not scene:
available_scenes = [s.id for s in scenes_config.scenes]
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND,
detail=f"Scene '{scene_id}' not found. Available scenes: {available_scenes}"
)
# Execute scene steps
execution_plan = []
total_devices = 0
for i, step in enumerate(scene.steps, 1):
# Resolve devices for this step
resolved_devices = resolve_scene_step_devices(step, groups_config, devices, device_rooms)
total_devices += len(resolved_devices)
# Extract action payload
action_payload = step.action.get("payload", {})
# Execute for each device
step_executions = []
for device in resolved_devices:
device_type = device["type"]
device_id = device["device_id"]
try:
await publish_abstract_set(device_type, device_id, action_payload)
step_executions.append({
"device_id": device_id,
"status": "published"
})
except Exception as e:
logger.error(f"Failed to publish to {device_id} in step {i}: {e}")
step_executions.append({
"device_id": device_id,
"status": "failed",
"error": str(e)
})
# Build step info
step_info = {
"step": i,
"devices_affected": len(resolved_devices),
"device_ids": [d["device_id"] for d in resolved_devices],
"action": step.action,
"executions": step_executions,
}
# Add targeting info
if step.group_id:
step_info["target"] = {"type": "group_id", "value": step.group_id}
elif step.selector:
step_info["target"] = {
"type": "selector",
"selector_type": step.selector.type,
"room": step.selector.room,
}
if step.delay_ms:
step_info["delay_ms"] = step.delay_ms
# Apply delay before next step
await asyncio.sleep(step.delay_ms / 1000.0)
execution_plan.append(step_info)
return SceneExecutionResponse(
scene_id=scene.id,
scene_name=scene.name,
steps_executed=len(scene.steps),
devices_affected=total_devices,
execution_plan=execution_plan,
)
except HTTPException:
raise
except ValueError as e:
# Handle unknown group_id in scene step
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=str(e)
)
except Exception as e:
logger.error(f"Error running scene {scene_id}: {e}")
raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
detail=f"Failed to run scene: {str(e)}"
)

465
apps/homekit/README.md Normal file
View File

@@ -0,0 +1,465 @@
# HomeKit Bridge
HomeKit Accessory Protocol (HAP) Bridge für das Home Automation System.
## Überblick
Diese HomeKit-Bridge ermöglicht die Steuerung aller Geräte über Apple HomeKit / Home-App auf iPhone/iPad/Mac.
**Architektur:**
- Läuft auf Raspberry Pi im lokalen Netzwerk
- Kommuniziert ausschließlich über REST-API (kein direkter MQTT/Redis-Zugriff)
- Verwendet [HAP-Python](https://github.com/ikalchev/HAP-python) für HomeKit-Protokoll
- Unterstützt Echtzeit-Updates über Server-Sent Events (SSE)
## Implementierungsanleitung für Copilot
<details>
<summary>Copilot-Aufgabe: Implementiere die HomeKit-Bridge (HAP-Python) für unser System</summary>
### Kontext
- Wir verwenden HAP-Python als HomeKit-Bridge.
- Die Bridge läuft auf einem Raspberry Pi im gleichen LAN wie die iPhones.
- Die Bridge kommuniziert AUSSCHLIESSLICH über die REST-API mit dem restlichen System (KEIN direkter MQTT-/Redis-Zugriff).
- Geräte- und Raum-Infos kommen aus:
- `GET /devices`
- `GET /layout`
und werden über `device_id` gejoint.
- Die Abbildung von abstrakten Gerätetypen/Features auf HomeKit-Services/Characteristics steht in der Datei `apps/homekit/homekit_mapping.md` (Markdown-Tabelle). Bitte orientiere dich daran.
### Ziel
Implementiere eine lauffähige HomeKit-Bridge in `apps/homekit`, die:
- beim Start Geräte & Räume über die API lädt,
- daraus anhand der Mapping-Tabelle HomeKit-Accessories erzeugt,
- Zustandsänderungen über einen Realtime-Endpoint der API empfängt und in HomeKit spiegeln kann,
- Set-Kommandos aus HomeKit (z.B. Licht an/aus, Helligkeit, Zieltemperatur) per `POST /devices/{id}/set` an die API sendet,
- saubere Start-/Stop-Logs ausgibt,
- einfache Test-/Startanweisungen für den Raspberry Pi und die Home-App (iPhone) in Kommentaren dokumentiert.
### WICHTIG
- Bitte benutze HAP-Python (pyhap).
- Keine direkte MQTT- oder Redis-Kommunikation in der Bridge.
- Nutze HTTP(S) zur API (z.B. mit requests oder httpx; gerne sync, HAP-Python ist selbst eventloop-orientiert).
- Nutze die Mapping-Tabelle in `apps/homekit/homekit_mapping.md` als Leitlinie für die Accessory-Typen.
### Paketstruktur
```
apps/homekit/
├── __init__.py
├── main.py # Einstiegspunkt
├── api_client.py # REST-Client zur API
├── device_registry.py # Join /devices + /layout → internes Device-Modell
├── accessories/
│ ├── base.py # gemeinsame Basisklasse/n für Accessories
│ ├── light.py # Light-Accessories
│ ├── thermostat.py
│ ├── contact.py
│ ├── sensor.py # temp_humidity etc.
│ └── cover.py # optional, Rollladen
└── tests/ # rudimentäre Tests/Checks
```
## Teil 1: Internes Gerätemodell / Device-Registry
### 1.1 Erstelle in `apps/homekit/device_registry.py`:
**Dataklasse/Model Device:**
- `device_id: str`
- `type: str` - "light","thermostat","outlet","contact","temp_humidity","cover",...
- `name: str` - Kurzname aus `GET /devices.name`
- `friendly_name: str` - title aus `GET /layout` (fallback name)
- `room: str | None` - Raumname aus layout
- `features: dict[str, bool]`
- `read_only: bool` - heuristisch: Sensor-/Kontakt-Typen sind read_only
**Klasse DeviceRegistry mit Funktionen:**
- `def load_from_api(api: ApiClient) -> DeviceRegistry`:
- ruft `GET /devices` und `GET /layout` auf,
- joint über `device_id`,
- erstellt Device-Instanzen.
- `get_all(): list[Device]`
- `get_by_id(device_id: str) -> Device | None`
**Akzeptanz:**
- `load_from_api` funktioniert mit der bestehenden Struktur von `/devices` und `/layout`:
- `/devices` liefert mindestens `{device_id, type, name, features}`
- `/layout` liefert eine Struktur, aus der `device_id → room + title` ableitbar ist
- Der Join über `device_id` klappt; fehlende Layout-Einträge werden toleriert
## Teil 2: API-Client
### 2.1 Erstelle in `apps/homekit/api_client.py`:
**Klasse ApiClient mit:**
- `__init__(self, base_url: str, token: str | None = None, timeout: int = 5)`
- **Methoden:**
- `get_devices() -> list[dict]`: GET /devices
- `get_layout() -> dict`: GET /layout
- `get_device_state(device_id: str) -> dict`: GET /devices/{id}/state
- `post_device_set(device_id: str, type: str, payload: dict) -> None`: POST /devices/{id}/set
- `stream_realtime() -> Iterator[dict]`:
- GET /realtime als SSE, yield jedes Event als dict:
`{"type":"state","device_id":...,"payload":{...},"ts":...}`
**Auth:**
- Wenn ein API-Token via ENV `HOMEKIT_API_TOKEN` gesetzt ist, nutze HTTP-Header:
`Authorization: Bearer <token>`
**Akzeptanz:**
- ApiClient ist robust:
- bei Netzwerkfehlern gibt es sinnvolle Exceptions/Logs,
- `stream_realtime` behandelt Reconnect (z.B. einfache Endlosschleife mit Backoff).
- Es werden keine MQTT-Details verwendet, nur HTTP.
## Teil 3: HomeKit-Accessory-Klassen (HAP-Python)
### 3.1 Erstelle in `apps/homekit/accessories/base.py`:
**Basisklasse BaseDeviceAccessory(Accessory) mit:**
- Referenz auf Device (aus DeviceRegistry)
- Referenz auf ApiClient
- Methoden zum:
- Registrieren von HAP-Characteristics und Set-Handlern
- Aktualisieren von Characteristics bei eingehenden Events
- Logging
### 3.2 Erstelle spezifische Accessory-Klassen basierend auf homekit_mapping.md:
**LightAccessories (`apps/homekit/accessories/light.py`):**
- On/Off (nur power)
- Dimmable (power + brightness)
- Color (power + brightness + color_hsb)
**ThermostatAccessory:**
- CurrentTemperature, TargetTemperature, Mode (so weit in Mapping definiert)
**ContactAccessory:**
- ContactSensorState (open/closed)
**TempHumidityAccessory:**
- TemperatureSensor (CurrentTemperature)
- HumiditySensor (CurrentRelativeHumidity)
**OutletAccessory:**
- On/Off
**CoverAccessory (optional):**
- WindowCovering mit CurrentPosition/TargetPosition
**Die Mapping-Tabelle in `homekit_mapping.md` ist die normative Referenz:**
- Bitte lies die Tabelle und mappe `abstract_type + Features → passende Accessory-Klasse und Characteristics`
- Wo die Tabelle `Status=TODO/REVIEW` hat:
- Implementiere nur das, was eindeutig ist,
- lasse TODO-Kommentare an den entsprechenden Stellen im Code.
**Akzeptanz:**
- Für die abstrakten Typen, die bereits in `devices.yaml` und Mapping-Tabelle klar definiert sind (z.B. light, thermostat, contact, temp_humidity), existieren passende Accessory-Klassen.
- Set-Operationen erzeugen korrekte Payloads für `POST /devices/{id}/set`:
- Light: `{"type":"light","payload":{"power":"on"/"off", "brightness":..., "hue":..., "sat":...}}`
- Thermostat: `{"type":"thermostat","payload":{"target":...}}`
- Contact: read_only → keine Set-Handler
- Temp/Humidity: read_only → keine Set-Handler
## Teil 4: Bridge-Setup mit HAP-Python
### 4.1 Implementiere in `apps/homekit/main.py`:
**env-Konfiguration:**
- `HOMEKIT_NAME` (default: "Home Automation Bridge")
- `HOMEKIT_PIN` (z.B. "031-45-154")
- `HOMEKIT_PORT` (default 51826)
- `API_BASE` (z.B. "http://api:8001" oder extern)
- `HOMEKIT_API_TOKEN` (optional)
**Funktion `build_bridge(driver, api_client: ApiClient) -> Bridge`:**
- DeviceRegistry via `load_from_api(api_client)` laden.
- Für jedes Device anhand Mapping-Tabelle die passende Accessory-Klasse instanziieren.
- Einen Bridge-Accessory (`pyhap.accessory.Bridge`) erstellen.
- Alle Device-Accessories der Bridge hinzufügen.
**Realtime-Event-Loop:**
- In einem Hintergrund-Thread oder ThreadPool:
- `api_client.stream_realtime()` iterieren,
- für jedes Event `device_id → Accessory` finden,
- Characteristics updaten.
- Thread wird beim Shutdown sauber beendet.
**`main()`:**
- Logging einrichten.
- ApiClient erstellen.
- `AccessoryDriver(port=HOMEKIT_PORT, persist_file="homekit.state")` erstellen.
- Bridge via `build_bridge(driver, api_client)` bauen.
- Bridge dem Driver hinzufügen.
- Realtime-Thread starten.
- `driver.start()` aufrufen.
- Auf KeyboardInterrupt reagieren und sauber stoppen.
**Akzeptanz:**
- Beim Start loggt die Bridge:
- Anzahl Devices,
- auf welchem Port sie als HomeKit-Bridge lauscht,
- welches API_BASE verwendet wird.
- Die Datei `homekit.state` wird im Arbeitsverzeichnis bzw. einem konfigurierbaren Ordner abgelegt (um Pairing-Info persistent zu halten).
- Die Bridge übersteht API-Neustarts (Realtime-Loop reconnectet) und Netzwerkflaps.
## Teil 5: Tests & Testanweisungen
### 5.1 Lege in `apps/homekit/tests/` einfache Tests/Checks an:
**Unit-Tests (pytest), soweit ohne echtes HomeKit möglich:**
- Test für `DeviceRegistry.load_from_api()` mit Mock-Antworten aus `/devices` und `/layout`:
- Korrekte Join-Logik,
- Korrekte room/friendly_name-Zuordnung.
- Test für set-Payload-Erzeugung pro Accessory:
- z.B. LightAccessory: On=True → POST /devices/{id}/set wird mit korrektem Payload aufgerufen (über Mock ApiClient).
### Allgemein
- Nutze möglichst sinnvolle Typannotationen und Docstrings.
- Hinterlasse TODO-Kommentare an Stellen, wo die Mapping-Tabelle explizit Status=TODO/REVIEW hat.
- Ändere KEINE bestehenden API-Endpunkte; verlasse dich nur auf deren aktuelles Verhalten (GET /devices, GET /layout, /realtime, POST /devices/{id}/set).
## Installation & Setup
### Voraussetzungen
- Python 3.9+
- Raspberry Pi im gleichen LAN wie iPhone/iPad
- API-Server erreichbar (z.B. `http://api:8001`)
### Installation
```bash
cd apps/homekit
pip install -r requirements.txt
```
### Umgebungsvariablen
Erstelle eine `.env` Datei oder setze folgende Variablen:
```bash
export API_BASE="http://YOUR_API_IP:8001"
export HOMEKIT_API_TOKEN="your-token-if-needed" # optional
export HOMEKIT_PIN="031-45-154"
export HOMEKIT_NAME="Home Automation Bridge"
export HOMEKIT_PORT="51826"
export HOMEKIT_PERSIST_FILE="homekit.state"
```
## Start
```bash
python -m apps.homekit.main
```
**Erwartete Logs:**
```
Loading devices from API...
Loaded X devices from API
Bridge built with Y accessories
HomeKit Bridge started on port 51826
Starting realtime event loop...
```
## Pairing mit iPhone (Home-App)
1. **Voraussetzungen:**
- iPhone im gleichen WLAN wie Raspberry Pi
- Bridge läuft und zeigt "started on port 51826"
2. **Home-App öffnen:**
- Öffne die Home-App auf dem iPhone
- Tippe auf "+" → "Gerät hinzufügen"
- Wähle "Weitere Optionen..." oder "Code fehlt oder kann nicht gescannt werden"
3. **Bridge auswählen:**
- Die Bridge sollte in der Nähe-Liste erscheinen (z.B. "Home Automation Bridge")
- Tippe auf die Bridge
4. **PIN eingeben:**
- Gib den PIN ein: `031-45-154` (oder dein `HOMEKIT_PIN`)
- Format: `XXX-XX-XXX`
5. **Konfiguration abschließen:**
- Geräte werden geladen
- Räume werden automatisch aus `layout.yaml` übernommen
- Geräte können nun über Home-App gesteuert werden
## Funktionstests
### Test 1: Licht einschalten
**Aktion:** Lampe in Home-App antippen (On)
**Erwartung:**
- API-Log zeigt: `POST /devices/{id}/set` mit `{"type":"light","payload":{"power":"on"}}`
- Physische Lampe oder Simulator schaltet ein
### Test 2: Helligkeit ändern (dimmbare Lampe)
**Aktion:** Helligkeits-Slider bewegen (z.B. 75%)
**Erwartung:**
- `POST /devices/{id}/set` mit `brightness` ca. 75
- Lampe dimmt entsprechend
### Test 3: Farbe ändern (Farblampe)
**Aktion:** Farbe in Home-App wählen
**Erwartung:**
- `POST /devices/{id}/set` mit `hue`/`sat` Werten
- Lampe wechselt Farbe
### Test 4: Thermostat Zieltemperatur
**Aktion:** Zieltemperatur auf 22°C setzen
**Erwartung:**
- `POST /devices/{id}/set` mit `target=22`
- `CurrentTemperature` wird über `/realtime` aktualisiert
### Test 5: Kontaktsensor (read-only)
**Aktion:** Fenster physisch öffnen/schließen
**Erwartung:**
- `/realtime` sendet Event
- Home-App zeigt "Offen" oder "Geschlossen"
### Test 6: Temperatur-/Feuchtigkeitssensor
**Aktion:** Werte ändern sich (z.B. Heizung an)
**Erwartung:**
- `/realtime` Events aktualisieren Werte
- Home-App zeigt aktuelle Temperatur/Luftfeuchtigkeit
## Troubleshooting
### Bridge erscheint nicht in Home-App
- **Netzwerk prüfen:** iPhone und RPi im gleichen Subnet?
- **Firewall prüfen:** Port 51826 muss erreichbar sein
- **Logs prüfen:** Fehler beim Start?
- **mDNS/Bonjour:** Funktioniert Bonjour im Netzwerk?
### Geräte reagieren nicht
- **API-Logs prüfen:** Kommen POST-Requests an?
- **Realtime-Verbindung:** Läuft `/realtime` Event-Loop? (Log-Meldungen)
- **API-Endpoints testen:** Manuell mit `curl` testen
### Pairing schlägt fehl
- **State-Datei löschen:** `rm homekit.state` und Bridge neu starten
- **PIN-Format prüfen:** Muss `XXX-XX-XXX` Format haben
- **Alte Pairings löschen:** In Home-App unter "Home-Einstellungen" → "HomeKit-Geräte zurücksetzen"
### Realtime-Updates funktionieren nicht
- **SSE-Verbindung prüfen:** Logs zeigen "Starting realtime event loop..."?
- **API-Endpoint testen:** `curl -N http://api:8001/realtime`
- **Firewall/Proxy:** Blockiert etwas SSE-Streams?
## Docker Deployment
### Dockerfile
```dockerfile
FROM python:3.11-slim
WORKDIR /app
COPY requirements.txt .
RUN pip install --no-cache-dir -r requirements.txt
COPY . .
CMD ["python", "-m", "apps.homekit.main"]
```
### docker-compose.yml
```yaml
services:
homekit:
build: ./apps/homekit
environment:
- API_BASE=http://api:8001
- HOMEKIT_PIN=031-45-154
- HOMEKIT_NAME=Home Automation Bridge
ports:
- "51826:51826"
volumes:
- ./data/homekit:/data
network_mode: "host" # Wichtig für mDNS/Bonjour Discovery
restart: unless-stopped
```
**Wichtig:** `network_mode: "host"` ist erforderlich für mDNS/Bonjour Discovery, damit die Bridge im lokalen Netzwerk gefunden werden kann.
## Architektur
```
┌─────────────┐
│ iPhone/ │
│ Home-App │
└──────┬──────┘
│ HomeKit (HAP)
│ Port 51826
┌──────▼──────────────────┐
│ HomeKit Bridge │
│ (HAP-Python) │
│ - Device Registry │
│ - Accessory Mapping │
│ - SSE Event Loop │
└──────┬──────────────────┘
│ HTTP REST API
│ (GET /devices, POST /set, SSE /realtime)
┌──────▼──────────────────┐
│ API Server │
│ (FastAPI) │
└──────┬──────────────────┘
│ MQTT
┌──────▼──────────────────┐
│ Abstraction Layer │
│ (Zigbee2MQTT, MAX!) │
└─────────────────────────┘
```
## Weitere Dokumentation
- **API-Mapping:** Siehe `homekit_mapping.md` für Device-Type → HomeKit-Service Mapping
- **API-Dokumentation:** Siehe API-Server README für Endpoint-Dokumentation
- **HAP-Python Docs:** https://github.com/ikalchev/HAP-python
## Entwicklung
### Tests ausführen
```bash
pytest apps/homekit/tests/
```
### Logs
Die Bridge gibt detaillierte Logs aus:
- `INFO`: Normale Betriebsmeldungen (Start, Device-Anzahl, etc.)
- `DEBUG`: Detaillierte State-Updates und API-Calls
- `ERROR`: Fehler bei API-Kommunikation oder Accessory-Updates
Log-Level über Environment-Variable steuern:
```bash
export LOG_LEVEL=DEBUG
```
## Lizenz
Siehe Hauptprojekt-Lizenz.

View File

@@ -0,0 +1,5 @@
"""
HomeKit Accessories Package
This package contains HomeKit accessory implementations for different device types.
"""

View File

@@ -0,0 +1,48 @@
"""
Contact Sensor Accessory Implementation for HomeKit
Implements contact sensor (window/door sensors):
- ContactSensorState (read-only): 0=Detected, 1=Not Detected
"""
from pyhap.accessory import Accessory
from pyhap.const import CATEGORY_SENSOR
class ContactAccessory(Accessory):
"""Contact sensor for doors and windows."""
category = CATEGORY_SENSOR
def __init__(self, driver, device, api_client, display_name=None, *args, **kwargs):
"""
Initialize the contact sensor accessory.
Args:
driver: HAP driver instance
device: Device object from DeviceRegistry
api_client: ApiClient for sending commands
display_name: Optional display name (defaults to device.friendly_name)
"""
name = display_name or device.friendly_name or device.name
super().__init__(driver, name, *args, **kwargs)
self.device = device
self.api_client = api_client
# Add ContactSensor service
self.contact_service = self.add_preload_service('ContactSensor')
# Get ContactSensorState characteristic
self.contact_state_char = self.contact_service.get_characteristic('ContactSensorState')
# Initialize with "not detected" (closed)
self.contact_state_char.set_value(1)
def update_state(self, state_payload):
"""Update state from API event."""
if "contact" in state_payload:
# API sends: "open" or "closed"
# HomeKit: 0=Contact Detected (closed), 1=Contact Not Detected (open)
is_open = state_payload["contact"] == "open"
homekit_state = 1 if is_open else 0
self.contact_state_char.set_value(homekit_state)

View File

@@ -0,0 +1,177 @@
"""
Light Accessory Implementations for HomeKit
Implements different light types:
- OnOffLightAccessory: Simple on/off light
- DimmableLightAccessory: Light with brightness control
- ColorLightAccessory: RGB light with full color control
"""
from pyhap.accessory import Accessory
from pyhap.const import CATEGORY_LIGHTBULB
class OnOffLightAccessory(Accessory):
"""Simple On/Off Light without dimming or color."""
category = CATEGORY_LIGHTBULB
def __init__(self, driver, device, api_client, display_name=None, *args, **kwargs):
"""
Initialize the light accessory.
Args:
driver: HAP driver instance
device: Device object from DeviceRegistry
api_client: ApiClient for sending commands
display_name: Optional display name (defaults to device.friendly_name)
"""
name = display_name or device.friendly_name or device.name
super().__init__(driver, name, *args, **kwargs)
self.device = device
self.api_client = api_client
# Add Lightbulb service with On characteristic
self.lightbulb_service = self.add_preload_service('Lightbulb')
# Get the On characteristic and set callback
self.on_char = self.lightbulb_service.get_characteristic('On')
self.on_char.setter_callback = self.set_on
def set_on(self, value):
"""Called when HomeKit wants to turn light on/off."""
power_state = "on" if value else "off"
payload = {
"type": "light",
"payload": {"power": power_state}
}
self.api_client.post_device_set(self.device.device_id, payload["type"], payload["payload"])
def update_state(self, state_payload):
"""Update state from API event."""
if "power" in state_payload:
is_on = state_payload["power"] == "on"
self.on_char.set_value(is_on)
class DimmableLightAccessory(OnOffLightAccessory):
"""Dimmable Light with brightness control."""
def __init__(self, driver, device, api_client, display_name=None, *args, **kwargs):
# Don't call super().__init__() yet - we need to set up service first
name = display_name or device.friendly_name or device.name
Accessory.__init__(self, driver, name, *args, **kwargs)
self.device = device
self.api_client = api_client
self.category = CATEGORY_LIGHTBULB
# Create Lightbulb service with all characteristics at once
from pyhap.loader import Loader
loader = Loader()
# Create the service
lightbulb_service = loader.get_service('Lightbulb')
# Add On characteristic
on_char = lightbulb_service.get_characteristic('On')
on_char.setter_callback = self.set_on
self.on_char = on_char
# Add Brightness characteristic
brightness_char = loader.get_char('Brightness')
brightness_char.set_value(0)
brightness_char.setter_callback = self.set_brightness
lightbulb_service.add_characteristic(brightness_char)
self.brightness_char = brightness_char
# Now add the complete service to the accessory
self.add_service(lightbulb_service)
self.lightbulb_service = lightbulb_service
def set_brightness(self, value):
"""Called when HomeKit wants to change brightness."""
payload = {
"type": "light",
"payload": {"brightness": int(value)}
}
self.api_client.post_device_set(self.device.device_id, payload["type"], payload["payload"])
def update_state(self, state_payload):
"""Update state from API event."""
super().update_state(state_payload)
if "brightness" in state_payload:
self.brightness_char.set_value(state_payload["brightness"])
class ColorLightAccessory(DimmableLightAccessory):
"""RGB Light with full color control."""
def __init__(self, driver, device, api_client, display_name=None, *args, **kwargs):
# Don't call super().__init__() - build everything from scratch
name = display_name or device.friendly_name or device.name
Accessory.__init__(self, driver, name, *args, **kwargs)
self.device = device
self.api_client = api_client
self.category = CATEGORY_LIGHTBULB
# Create Lightbulb service with all characteristics at once
from pyhap.loader import Loader
loader = Loader()
# Create the service
lightbulb_service = loader.get_service('Lightbulb')
# Add On characteristic
on_char = lightbulb_service.get_characteristic('On')
on_char.setter_callback = self.set_on
self.on_char = on_char
# Add Brightness characteristic
brightness_char = loader.get_char('Brightness')
brightness_char.set_value(0)
brightness_char.setter_callback = self.set_brightness
lightbulb_service.add_characteristic(brightness_char)
self.brightness_char = brightness_char
# Add Hue characteristic
hue_char = loader.get_char('Hue')
hue_char.set_value(0)
hue_char.setter_callback = self.set_hue
lightbulb_service.add_characteristic(hue_char)
self.hue_char = hue_char
# Add Saturation characteristic
saturation_char = loader.get_char('Saturation')
saturation_char.set_value(0)
saturation_char.setter_callback = self.set_saturation
lightbulb_service.add_characteristic(saturation_char)
self.saturation_char = saturation_char
# Now add the complete service to the accessory
self.add_service(lightbulb_service)
self.lightbulb_service = lightbulb_service
def set_hue(self, value):
"""Called when HomeKit wants to change hue."""
payload = {
"type": "light",
"payload": {"hue": int(value)}
}
self.api_client.post_device_set(self.device.device_id, payload["type"], payload["payload"])
def set_saturation(self, value):
"""Called when HomeKit wants to change saturation."""
payload = {
"type": "light",
"payload": {"sat": int(value)}
}
self.api_client.post_device_set(self.device.device_id, payload["type"], payload["payload"])
def update_state(self, state_payload):
"""Update state from API event."""
super().update_state(state_payload)
if "hue" in state_payload:
self.hue_char.set_value(state_payload["hue"])
if "sat" in state_payload:
self.saturation_char.set_value(state_payload["sat"])

View File

@@ -0,0 +1,57 @@
"""
Outlet/Relay Accessory Implementation for HomeKit
Implements simple relay/outlet (on/off switch):
- On (read/write)
- OutletInUse (always true)
"""
from pyhap.accessory import Accessory
from pyhap.const import CATEGORY_OUTLET
class OutletAccessory(Accessory):
"""Relay/Outlet for simple on/off control."""
category = CATEGORY_OUTLET
def __init__(self, driver, device, api_client, display_name=None, *args, **kwargs):
"""
Initialize the outlet accessory.
Args:
driver: HAP driver instance
device: Device object from DeviceRegistry
api_client: ApiClient for sending commands
display_name: Optional display name (defaults to device.friendly_name)
"""
name = display_name or device.friendly_name or device.name
super().__init__(driver, name, *args, **kwargs)
self.device = device
self.api_client = api_client
# Add Outlet service
self.outlet_service = self.add_preload_service('Outlet')
# Get On characteristic and set callback
self.on_char = self.outlet_service.get_characteristic('On')
self.on_char.setter_callback = self.set_on
# OutletInUse is always true (relay is always functional)
self.in_use_char = self.outlet_service.get_characteristic('OutletInUse')
self.in_use_char.set_value(True)
def set_on(self, value):
"""Called when HomeKit wants to turn outlet on/off."""
power_state = "on" if value else "off"
payload = {
"type": "relay",
"payload": {"power": power_state}
}
self.api_client.post_device_set(self.device.device_id, payload["type"], payload["payload"])
def update_state(self, state_payload):
"""Update state from API event."""
if "power" in state_payload:
is_on = state_payload["power"] == "on"
self.on_char.set_value(is_on)

View File

@@ -0,0 +1,46 @@
"""
Temperature & Humidity Sensor Accessory Implementation for HomeKit
Implements combined temperature and humidity sensor:
- CurrentTemperature (read-only)
- CurrentRelativeHumidity (read-only)
"""
from pyhap.accessory import Accessory
from pyhap.const import CATEGORY_SENSOR
class TempHumidityAccessory(Accessory):
"""Combined temperature and humidity sensor."""
category = CATEGORY_SENSOR
def __init__(self, driver, device, api_client, display_name=None, *args, **kwargs):
"""
Initialize the temp/humidity sensor accessory.
Args:
driver: HAP driver instance
device: Device object from DeviceRegistry
api_client: ApiClient for sending commands
display_name: Optional display name (defaults to device.friendly_name)
"""
name = display_name or device.friendly_name or device.name
super().__init__(driver, name, *args, **kwargs)
self.device = device
self.api_client = api_client
# Add TemperatureSensor service
self.temp_service = self.add_preload_service('TemperatureSensor')
self.current_temp_char = self.temp_service.get_characteristic('CurrentTemperature')
# Add HumiditySensor service
self.humidity_service = self.add_preload_service('HumiditySensor')
self.current_humidity_char = self.humidity_service.get_characteristic('CurrentRelativeHumidity')
def update_state(self, state_payload):
"""Update state from API event."""
if "temperature" in state_payload:
self.current_temp_char.set_value(float(state_payload["temperature"]))
if "humidity" in state_payload:
self.current_humidity_char.set_value(float(state_payload["humidity"]))

View File

@@ -0,0 +1,72 @@
"""
Thermostat Accessory Implementation for HomeKit
Implements thermostat control according to homekit_mapping.md:
- CurrentTemperature (read-only)
- TargetTemperature (read/write)
- CurrentHeatingCoolingState (fixed: 1 = heating)
- TargetHeatingCoolingState (fixed: 3 = auto)
"""
from pyhap.accessory import Accessory
from pyhap.const import CATEGORY_THERMOSTAT
class ThermostatAccessory(Accessory):
"""Thermostat with temperature control."""
category = CATEGORY_THERMOSTAT
def __init__(self, driver, device, api_client, display_name=None, *args, **kwargs):
"""
Initialize the thermostat accessory.
Args:
driver: HAP driver instance
device: Device object from DeviceRegistry
api_client: ApiClient for sending commands
display_name: Optional display name (defaults to device.friendly_name)
"""
name = display_name or device.friendly_name or device.name
super().__init__(driver, name, *args, **kwargs)
self.device = device
self.api_client = api_client
# Add Thermostat service
self.thermostat_service = self.add_preload_service('Thermostat')
# Get characteristics
self.current_temp_char = self.thermostat_service.get_characteristic('CurrentTemperature')
self.target_temp_char = self.thermostat_service.get_characteristic('TargetTemperature')
self.current_heating_cooling_char = self.thermostat_service.get_characteristic('CurrentHeatingCoolingState')
self.target_heating_cooling_char = self.thermostat_service.get_characteristic('TargetHeatingCoolingState')
# Set callback for target temperature
self.target_temp_char.setter_callback = self.set_target_temperature
# Set fixed heating/cooling states (mode is always "auto")
# CurrentHeatingCoolingState: 0=Off, 1=Heat, 2=Cool
self.current_heating_cooling_char.set_value(1) # Always heating
# TargetHeatingCoolingState: 0=Off, 1=Heat, 2=Cool, 3=Auto
self.target_heating_cooling_char.set_value(3) # Always auto
# Set temperature range (5-30°C as per UI)
self.target_temp_char.properties['minValue'] = 5
self.target_temp_char.properties['maxValue'] = 30
self.target_temp_char.properties['minStep'] = 0.5
def set_target_temperature(self, value):
"""Called when HomeKit wants to change target temperature."""
payload = {
"type": "thermostat",
"payload": {"target": float(value)}
}
self.api_client.post_device_set(self.device.device_id, payload["type"], payload["payload"])
def update_state(self, state_payload):
"""Update state from API event."""
if "current" in state_payload:
self.current_temp_char.set_value(float(state_payload["current"]))
if "target" in state_payload:
self.target_temp_char.set_value(float(state_payload["target"]))

161
apps/homekit/api_client.py Normal file
View File

@@ -0,0 +1,161 @@
"""
API Client for HomeKit Bridge
Handles all HTTP communication with the REST API backend.
"""
import logging
from typing import Dict, List, Iterator, Optional
import httpx
import json
import time
logger = logging.getLogger(__name__)
class ApiClient:
"""HTTP client for communicating with the home automation API."""
def __init__(self, base_url: str, token: Optional[str] = None, timeout: int = 5):
"""
Initialize API client.
Args:
base_url: Base URL of the API (e.g., "http://192.168.1.100:8001")
token: Optional API token for authentication
timeout: Request timeout in seconds
"""
self.base_url = base_url.rstrip('/')
self.timeout = timeout
self.headers = {}
if token:
self.headers['Authorization'] = f'Bearer {token}'
def get_devices(self) -> List[Dict]:
"""
Get list of all devices.
Returns:
List of device dictionaries
"""
try:
response = httpx.get(
f'{self.base_url}/devices',
headers=self.headers,
timeout=self.timeout
)
response.raise_for_status()
return response.json()
except Exception as e:
logger.error(f"Failed to get devices: {e}")
raise
def get_layout(self) -> Dict:
"""
Get layout information (rooms and device assignments).
Returns:
Layout dictionary with room structure
"""
try:
response = httpx.get(
f'{self.base_url}/layout',
headers=self.headers,
timeout=self.timeout
)
response.raise_for_status()
return response.json()
except Exception as e:
logger.error(f"Failed to get layout: {e}")
raise
def get_device_state(self, device_id: str) -> Dict:
"""
Get current state of a specific device.
Args:
device_id: Device identifier
Returns:
Device state dictionary
"""
try:
response = httpx.get(
f'{self.base_url}/devices/{device_id}/state',
headers=self.headers,
timeout=self.timeout
)
response.raise_for_status()
return response.json()
except Exception as e:
logger.error(f"Failed to get state for {device_id}: {e}")
raise
def post_device_set(self, device_id: str, device_type: str, payload: Dict) -> None:
"""
Send command to a device.
Args:
device_id: Device identifier
device_type: Device type (e.g., "light", "thermostat")
payload: Command payload (e.g., {"power": "on", "brightness": 75})
"""
try:
data = {
"type": device_type,
"payload": payload
}
response = httpx.post(
f'{self.base_url}/devices/{device_id}/set',
headers=self.headers,
json=data,
timeout=self.timeout
)
response.raise_for_status()
logger.debug(f"Set {device_id}: {payload}")
except Exception as e:
logger.error(f"Failed to set {device_id}: {e}")
raise
def stream_realtime(self, reconnect_delay: int = 5) -> Iterator[Dict]:
"""
Stream real-time events from the API using Server-Sent Events (SSE).
Automatically reconnects on connection loss.
Args:
reconnect_delay: Seconds to wait before reconnecting
Yields:
Event dictionaries: {"type": "state", "device_id": "...", "payload": {...}, "ts": ...}
"""
while True:
try:
logger.info("Connecting to realtime event stream...")
with httpx.stream(
'GET',
f'{self.base_url}/realtime',
headers=self.headers,
timeout=None # No timeout for streaming
) as response:
response.raise_for_status()
logger.info("Connected to realtime event stream")
for line in response.iter_lines():
if line.startswith('data: '):
data_str = line[6:] # Remove 'data: ' prefix
try:
event = json.loads(data_str)
yield event
except json.JSONDecodeError as e:
logger.warning(f"Failed to parse SSE event: {e}")
except httpx.HTTPError as e:
logger.error(f"Realtime stream error: {e}")
logger.info(f"Reconnecting in {reconnect_delay} seconds...")
time.sleep(reconnect_delay)
except Exception as e:
logger.error(f"Unexpected error in realtime stream: {e}")
logger.info(f"Reconnecting in {reconnect_delay} seconds...")
time.sleep(reconnect_delay)

View File

@@ -0,0 +1,138 @@
"""
Device Registry for HomeKit Bridge
Loads devices from API and joins with layout information.
"""
import logging
from typing import Dict, List, Optional
from dataclasses import dataclass
logger = logging.getLogger(__name__)
@dataclass
class Device:
"""Represents a device with combined info from /devices and /layout."""
device_id: str
type: str # "light", "thermostat", "relay", "contact", "temp_humidity", "cover"
name: str # Short name from /devices
friendly_name: str # Display title from /layout (fallback to name)
room: Optional[str] # Room name from layout
features: Dict[str, bool] # Feature flags (e.g., {"power": true, "brightness": true})
read_only: bool # True for sensors that don't accept commands
class DeviceRegistry:
"""Registry of all devices loaded from the API."""
def __init__(self, devices: List[Device]):
"""
Initialize registry with devices.
Args:
devices: List of Device objects
"""
self._devices = devices
self._by_id = {d.device_id: d for d in devices}
@classmethod
def load_from_api(cls, api_client) -> 'DeviceRegistry':
"""
Load devices from API and join with layout information.
Args:
api_client: ApiClient instance
Returns:
DeviceRegistry with all devices
"""
# Get devices and layout
devices_data = api_client.get_devices()
layout_data = api_client.get_layout()
# Build lookup: device_id -> (room_name, title)
layout_map = {}
if isinstance(layout_data, dict) and 'rooms' in layout_data:
rooms_list = layout_data['rooms']
if isinstance(rooms_list, list):
for room in rooms_list:
if isinstance(room, dict):
room_name = room.get('name', 'Unknown')
devices_in_room = room.get('devices', [])
for device_info in devices_in_room:
if isinstance(device_info, dict):
device_id = device_info.get('device_id')
title = device_info.get('title', '')
if device_id:
layout_map[device_id] = (room_name, title)
# Create Device objects
devices = []
for dev_data in devices_data:
device_id = dev_data.get('device_id')
if not device_id:
logger.warning(f"Device without device_id: {dev_data}")
continue
# Get layout info
room_name, title = layout_map.get(device_id, (None, ''))
# Determine if read-only (sensors don't accept set commands)
device_type = dev_data.get('type', '')
read_only = device_type in ['contact', 'temp_humidity', 'motion', 'smoke']
device = Device(
device_id=device_id,
type=device_type,
name=dev_data.get('name', device_id),
friendly_name=title or dev_data.get('name', device_id),
room=room_name,
features=dev_data.get('features', {}),
read_only=read_only
)
devices.append(device)
logger.info(f"Loaded {len(devices)} devices from API")
return cls(devices)
def get_all(self) -> List[Device]:
"""Get all devices."""
return self._devices.copy()
def get_by_id(self, device_id: str) -> Optional[Device]:
"""
Get device by ID.
Args:
device_id: Device identifier
Returns:
Device or None if not found
"""
return self._by_id.get(device_id)
def get_by_type(self, device_type: str) -> List[Device]:
"""
Get all devices of a specific type.
Args:
device_type: Device type (e.g., "light", "thermostat")
Returns:
List of matching devices
"""
return [d for d in self._devices if d.type == device_type]
def get_by_room(self, room: str) -> List[Device]:
"""
Get all devices in a specific room.
Args:
room: Room name
Returns:
List of devices in the room
"""
return [d for d in self._devices if d.room == room]

View File

@@ -0,0 +1,111 @@
<!--
Copilot-Aufgabe: HomeKit-Accessory-Mapping-Tabelle aus bestehender Implementierung ableiten
Ziel:
Erstelle eine Mapping-Tabelle, die beschreibt, wie unsere abstrakten Gerätetypen
(type/Features aus devices.yaml, apps/abstraction und apps/api) auf HomeKit-Accessories
und Characteristics (HAP-Python) abgebildet werden sollen.
Die Tabelle soll:
- sich an der bestehenden Implementierung und Konfiguration orientieren:
- devices.yaml (Typen, Features)
- apps/abstraction (Capabilities, Payload-Strukturen, Topics)
- apps/api (DTOs, /devices-Response, /devices/{id}/set, /realtime-Events)
- für jeden bekannten Gerätetyp (z.B. light, thermostat, outlet, contact, temp_humidity, cover, switch)
festhalten:
- Abstract Type (type)
- Relevante Features (Features-Flags, z.B. power, brightness, color_hsb, target, current, contact, humidity)
- HomeKit Service (z.B. LightBulb, Thermostat, Outlet, ContactSensor, TemperatureSensor, HumiditySensor, WindowCovering)
- HomeKit Characteristics (z.B. On, Brightness, Hue, Saturation, CurrentTemperature, TargetTemperature, ContactSensorState, CurrentPosition, TargetPosition)
- State-Mapping (abstraktes payload → HomeKit-Characteristics)
- Set-Mapping (HomeKit-Characteristics → HTTP POST /devices/{id}/set Payload)
- Status (OK / REVIEW / TODO)
Vorgehen für Copilot:
1. Analysiere die bestehenden Typen und Features:
- devices.yaml → "type" und "features" pro Gerät
- apps/abstraction → Capabilities, State-/Set-Modelle (z.B. light@1.2.0, thermostat, contact, temp_humidity)
- apps/api:
- Response-Modell von GET /devices (device_id, type, name, features)
- Struktur von GET /devices/{id}/state (payload-Felder je Typ)
- Struktur der Events in /realtime (payload-Felder je Typ)
- Body von POST /devices/{id}/set (type, payload)
2. Lege aufgrund dieser Analyse alle aktuell verwendeten abstrakten Typen an, z.B.:
- light (mit power, brightness, color_hsb)
- thermostat (mit current, target, mode)
- outlet
- contact
- temp_humidity
- ggf. cover, switch, etc., falls vorhanden
3. Erstelle eine Tabelle in Markdown mit folgenden Spalten:
| Abstract Type | Features (aus devices.yaml) | HomeKit Service | HomeKit Characteristics | State-Mapping (payload → HK) | Set-Mapping (HK → payload) | Status |
|---------------|-----------------------------|-----------------|-------------------------|------------------------------|----------------------------|--------|
Beispiele für Inhalte:
- Abstract Type: `light`
- Features: `power, brightness, color_hsb`
- HomeKit Service: `LightBulb`
- HomeKit Characteristics: `On, Brightness, Hue, Saturation`
- State-Mapping: `payload.power -> On; payload.brightness -> Brightness; payload.hue -> Hue; payload.sat -> Saturation`
- Set-Mapping: `On -> {"type":"light","payload":{"power":"on"/"off"}} ...`
- Status: `OK` wenn Mapping klar, `REVIEW` wenn du unsicher bist, `TODO` wenn Informationen fehlen
4. Nutze vorhandene Informationen aus dem Code:
- Wenn ein Gerätetyp in apps/abstraction bereits ein klares State-/Set-Modell hat, übernimm das in State-/Set-Mapping.
- Wenn bestimmte Features noch nicht im Code genutzt werden, markiere die entsprechenden Mapping-Zeilen mit Status=TODO.
- Falls unklar ist, welcher HomeKit-Service für einen Typ am besten passt, mache einen Vorschlag und setze Status=REVIEW.
5. Markiere explizit, wo man später noch eingreifen muss:
- In der Spalte "Status" mit `REVIEW` oder `TODO`.
- Optional zusätzliche kurze Kommentare unter der Tabelle wie:
- `<!-- TODO: RGBW-Unterstützung prüfen -->`
- `<!-- REVIEW: Soll temp_humidity als zwei Accessories oder kombiniert abgebildet werden? -->`
Akzeptanz-Kriterien:
- Es existiert am Ende dieses Dokuments eine Markdown-Tabelle mit mindestens allen abstrakten Gerätetypen, die aktuell in devices.yaml / apps/abstraction / apps/api verwendet werden.
- Für jeden Typ sind HomeKit Service und Characteristics ausgefüllt oder mit Status=REVIEW/TODO markiert.
- State-/Set-Mapping ist für alle bereits gut verstandenen Typen (z.B. einfache Lichter, Thermostate, Kontakte, Temp/Humidity-Sensoren) konkret beschrieben.
- Stellen, an denen die aktuelle Implementierung keine klaren Informationen liefert, sind sichtbar mit Status=REVIEW oder TODO gekennzeichnet.
- Copilot ändert an keiner anderen Stelle des Codes etwas, sondern erzeugt nur diese Tabelle/Dokumentation.
-->
# HomeKit-Accessory-Mapping-Tabelle
Dieses Dokument beschreibt das Mapping zwischen unseren abstrakten Gerätetypen (aus `devices.yaml`, `apps/abstraction` und `apps/api`) und HomeKit-Accessories/Characteristics (HAP-Python).
## Mapping-Tabelle
| Abstract Type | Features (aus devices.yaml) | HomeKit Service | HomeKit Characteristics | State-Mapping (payload → HK) | Set-Mapping (HK → payload) | Status |
|---------------|-----------------------------|-----------------|-------------------------|------------------------------|----------------------------|--------|
| `light` | `power, brightness, color_hsb` | `LightBulb` | `On, Brightness, Hue, Saturation` | `payload.power -> On (true/false)`<br>`payload.brightness -> Brightness (0-100)`<br>`payload.hue -> Hue (0-360)`<br>`payload.sat -> Saturation (0-100)` | `On -> {"type":"light","payload":{"power":"on"/"off"}}`<br>`Brightness -> {"type":"light","payload":{"brightness":0-100}}`<br>`Hue/Saturation -> {"type":"light","payload":{"hue":0-360,"sat":0-100}}` | OK |
| `light` | `power, brightness` | `LightBulb` | `On, Brightness` | `payload.power -> On (true/false)`<br>`payload.brightness -> Brightness (0-100)` | `On -> {"type":"light","payload":{"power":"on"/"off"}}`<br>`Brightness -> {"type":"light","payload":{"brightness":0-100}}` | OK |
| `light` | `power` | `LightBulb` | `On` | `payload.power -> On (true/false)` | `On -> {"type":"light","payload":{"power":"on"/"off"}}` | OK |
| `thermostat` | `current, target` | `Thermostat` | `CurrentTemperature, TargetTemperature, CurrentHeatingCoolingState, TargetHeatingCoolingState` | `payload.current -> CurrentTemperature (°C)`<br>`payload.target -> TargetTemperature (°C)`<br>`CurrentHeatingCoolingState -> 1 (heat, fest)`<br>`TargetHeatingCoolingState -> 3 (auto, fest)` | `TargetTemperature -> {"type":"thermostat","payload":{"target":temp}}`<br>**Hinweis:** Mode ist immer "auto", keine Mode-Änderung über HomeKit | OK |
| `relay` | `power` | `Outlet` | `On, OutletInUse` | `payload.power -> On (true/false)`<br>`payload.power -> OutletInUse (true/false)` | `On -> {"type":"relay","payload":{"power":"on"/"off"}}` | OK |
| `contact` | `contact` | `ContactSensor` | `ContactSensorState` | `payload.contact -> ContactSensorState (0=detected, 1=not detected)` | N/A (read-only sensor) | OK |
| `temp_humidity` | `temperature, humidity` | `TemperatureSensor` + `HumiditySensor` | `CurrentTemperature, CurrentRelativeHumidity` | `payload.temperature -> CurrentTemperature (°C)`<br>`payload.humidity -> CurrentRelativeHumidity (%)` | N/A (read-only sensors) | REVIEW |
| `cover` | `position, tilt` | `WindowCovering` | `CurrentPosition, TargetPosition, CurrentHorizontalTiltAngle, TargetHorizontalTiltAngle` | `payload.position -> CurrentPosition (0-100)`<br>`payload.tilt -> CurrentHorizontalTiltAngle (-90 to 90)` | `TargetPosition -> {"type":"cover","payload":{"position":0-100}}`<br>`TargetHorizontalTiltAngle -> {"type":"cover","payload":{"tilt":-90 to 90}}` | TODO |
| `switch` | `power` | `Switch` | `On` | `payload.power -> On (true/false)` | `On -> {"type":"switch","payload":{"power":"on"/"off"}}` | OK |
## Offene Punkte und Kommentare
<!-- OK: thermostat - Verwendet nur Mode "auto" (TargetHeatingCoolingState=3, CurrentHeatingCoolingState=1). Keine Mode-Änderung über HomeKit möglich. -->
<!-- REVIEW: temp_humidity - Soll als ein kombiniertes Accessory oder zwei separate Accessories (TemperatureSensor + HumiditySensor) abgebildet werden? HAP-Python erlaubt beides -->
<!-- TODO: cover - Position/Tilt-Mapping validieren. Sind die Wertebereiche korrekt? Gibt es zusätzliche Features wie PositionState (opening/closing/stopped)? -->
<!-- TODO: RGBW-Unterstützung - Prüfen, ob separate ColorTemperature-Characteristic für Warmweiß/Kaltweiß benötigt wird -->
<!-- TODO: Prüfen, ob weitere Gerätetypen in devices.yaml existieren (z.B. motion, door, lock, fan, etc.) und diese ergänzen -->
## Hinweise zur Implementierung
- **State-Updates**: Alle State-Änderungen von MQTT/API werden auf entsprechende HomeKit-Characteristics gemappt und via `set_value()` aktualisiert
- **Set-Befehle**: HomeKit-Charakteristik-Änderungen werden in HTTP POST-Requests an `/devices/{id}/set` umgewandelt
- **Read-only Sensors**: Sensoren (contact, temp_humidity) unterstützen nur State-Updates, keine Set-Befehle
- **Bidirektionales Mapping**: Änderungen müssen in beide Richtungen synchronisiert werden (HomeKit ↔ Abstraction Layer)

272
apps/homekit/main.py Normal file
View File

@@ -0,0 +1,272 @@
"""
HomeKit Bridge Main Module
Implementiert eine HAP-Python Bridge, die Geräte über die REST-API lädt
und über HomeKit verfügbar macht.
Für detaillierte Implementierungsanweisungen, Tests und Deployment-Informationen
siehe README.md in diesem Verzeichnis.
"""
import os
import logging
import signal
import sys
import threading
from typing import Optional
from pyhap.accessory_driver import AccessoryDriver
from pyhap.accessory import Bridge
from .accessories.light import (
OnOffLightAccessory,
DimmableLightAccessory,
ColorLightAccessory,
)
from .accessories.thermostat import ThermostatAccessory
from .accessories.contact import ContactAccessory
from .accessories.sensor import TempHumidityAccessory
from .accessories.outlet import OutletAccessory
from .api_client import ApiClient
from .device_registry import DeviceRegistry
# Configure logging
logging.basicConfig(
level=logging.INFO,
format='%(asctime)s - %(name)s - %(levelname)s - %(message)s'
)
logger = logging.getLogger(__name__)
# Environment configuration
HOMEKIT_NAME = os.getenv("HOMEKIT_NAME", "Home Automation Bridge")
HOMEKIT_PIN = os.getenv("HOMEKIT_PIN", "031-45-154")
HOMEKIT_PORT = int(os.getenv("HOMEKIT_PORT", "51826"))
API_BASE = os.getenv("API_BASE", "http://api:8001")
HOMEKIT_API_TOKEN = os.getenv("HOMEKIT_API_TOKEN")
PERSIST_FILE = os.getenv("HOMEKIT_PERSIST_FILE", "homekit.state")
def build_bridge(driver: AccessoryDriver, api_client: ApiClient) -> Bridge:
"""
Build the HomeKit Bridge with all device accessories.
Args:
driver: HAP-Python AccessoryDriver
api_client: API client for communication with backend
Returns:
Bridge accessory with all device accessories attached
"""
logger.info("Loading devices from API...")
registry = DeviceRegistry.load_from_api(api_client)
devices = registry.get_all()
logger.info(f"Loaded {len(devices)} devices from API")
# Create bridge
bridge = Bridge(driver, HOMEKIT_NAME)
accessory_map = {} # device_id -> Accessory instance
for device in devices:
try:
accessory = create_accessory_for_device(device, api_client, driver)
if accessory:
# Set room information in the accessory (HomeKit will use this for suggestions)
if device.room:
# Store room info for potential future use
accessory._room_name = device.room
bridge.add_accessory(accessory)
accessory_map[device.device_id] = accessory
logger.info(f"Added accessory: {device.friendly_name} ({device.type}) in room: {device.room or 'Unknown'}")
else:
logger.warning(f"No accessory mapping for device: {device.name} ({device.type})")
except Exception as e:
logger.error(f"Failed to create accessory for {device.name}: {e}", exc_info=True)
# Store accessory_map on bridge for realtime updates
bridge._accessory_map = accessory_map
logger.info(f"Bridge built with {len(accessory_map)} accessories")
return bridge
def get_accessory_name(device) -> str:
"""
Build accessory name including room information.
Args:
device: Device object from DeviceRegistry
Returns:
Name string like "Device Name (Room)" or just "Device Name" if no room
"""
base_name = device.friendly_name or device.name
if device.room:
return f"{base_name} ({device.room})"
return base_name
def create_accessory_for_device(device, api_client: ApiClient, driver: AccessoryDriver):
"""
Create appropriate HomeKit accessory based on device type and features.
Maps device types to HomeKit accessories according to homekit_mapping.md.
"""
device_type = device.type
features = device.features
display_name = get_accessory_name(device)
# Light accessories
if device_type == "light":
if features.get("color_hsb"):
return ColorLightAccessory(driver, device, api_client, display_name=display_name)
elif features.get("brightness"):
return DimmableLightAccessory(driver, device, api_client, display_name=display_name)
else:
return OnOffLightAccessory(driver, device, api_client, display_name=display_name)
# Thermostat
elif device_type == "thermostat":
return ThermostatAccessory(driver, device, api_client, display_name=display_name)
# Contact sensor
elif device_type == "contact":
return ContactAccessory(driver, device, api_client, display_name=display_name)
# Temperature/Humidity sensor
elif device_type == "temp_humidity_sensor":
return TempHumidityAccessory(driver, device, api_client, display_name=display_name)
# Relay/Outlet
elif device_type == "relay":
return OutletAccessory(driver, device, api_client, display_name=display_name)
# Cover/Blinds (optional)
elif device_type == "cover":
# TODO: Implement CoverAccessory based on homekit_mapping.md
logger.warning(f"Cover accessory not yet implemented for {device.name}")
return None
# TODO: Add more device types as needed (lock, motion, etc.)
return None
def realtime_event_loop(api_client: ApiClient, bridge: Bridge, stop_event: threading.Event):
"""
Background thread that listens to realtime events and updates accessories.
Args:
api_client: API client
bridge: HomeKit bridge with accessories
stop_event: Threading event to signal shutdown
"""
logger.info("Starting realtime event loop...")
while not stop_event.is_set():
try:
for event in api_client.stream_realtime():
if stop_event.is_set():
break
# Handle state update events
if event.get("type") == "state":
device_id = event.get("device_id")
payload = event.get("payload", {})
# Find corresponding accessory
accessory = bridge._accessory_map.get(device_id)
if accessory and hasattr(accessory, 'update_state'):
try:
accessory.update_state(payload)
logger.debug(f"Updated state for {device_id}: {payload}")
except Exception as e:
logger.error(f"Error updating accessory {device_id}: {e}")
except Exception as e:
if not stop_event.is_set():
logger.error(f"Realtime stream error: {e}. Reconnecting in 5s...")
stop_event.wait(5) # Backoff before reconnect
logger.info("Realtime event loop stopped")
def main():
logger.info("=" * 60)
logger.info(f"Starting HomeKit Bridge: {HOMEKIT_NAME}")
logger.info(f"API Base: {API_BASE}")
logger.info(f"HomeKit Port: {HOMEKIT_PORT}")
logger.info(f"PIN: {HOMEKIT_PIN}")
logger.info("=" * 60)
# Create API client
api_client = ApiClient(
base_url=API_BASE,
token=HOMEKIT_API_TOKEN,
timeout=10
)
# Test API connectivity
try:
devices = api_client.get_devices()
logger.info(f"API connectivity OK - {len(devices)} devices available")
except Exception as e:
logger.error(f"Failed to connect to API at {API_BASE}: {e}")
logger.error("Please check API_BASE and network connectivity")
sys.exit(1)
# Create AccessoryDriver
driver = AccessoryDriver(
port=HOMEKIT_PORT,
persist_file=PERSIST_FILE
)
# Build bridge with all accessories
try:
bridge = build_bridge(driver, api_client)
except Exception as e:
logger.error(f"Failed to build bridge: {e}", exc_info=True)
sys.exit(1)
# Add bridge to driver
driver.add_accessory(accessory=bridge)
# Setup realtime event thread
stop_event = threading.Event()
realtime_thread = threading.Thread(
target=realtime_event_loop,
args=(api_client, bridge, stop_event),
daemon=True
)
# Signal handlers for graceful shutdown
def signal_handler(sig, frame):
logger.info("Received shutdown signal, stopping...")
stop_event.set()
driver.stop()
signal.signal(signal.SIGINT, signal_handler)
signal.signal(signal.SIGTERM, signal_handler)
# Start realtime thread
realtime_thread.start()
# Start the bridge
logger.info(f"HomeKit Bridge started on port {HOMEKIT_PORT}")
logger.info(f"Pair with PIN: {HOMEKIT_PIN}")
logger.info("Press Ctrl+C to stop")
try:
driver.start()
except KeyboardInterrupt:
logger.info("KeyboardInterrupt received")
finally:
logger.info("Stopping bridge...")
stop_event.set()
realtime_thread.join(timeout=5)
logger.info("Bridge stopped")
if __name__ == "__main__":
main()

View File

@@ -0,0 +1,13 @@
# HomeKit Bridge Dependencies
# HAP-Python - HomeKit Accessory Protocol implementation
HAP-python>=4.9.0
# HTTP client for API communication (REST API only - no MQTT)
httpx>=0.24.0
# Utilities
python-dotenv>=1.0.0 # For .env file support
pydantic>=2.0.0 # For data validation (shared with main app)
# Logging and monitoring (optional)
# sentry-sdk>=1.0.0 # Optional: Error tracking

76
apps/homekit/start_bridge.sh Executable file
View File

@@ -0,0 +1,76 @@
#!/bin/bash
# HomeKit Bridge Startup Script
# This script sets up the virtual environment, installs dependencies, and starts the bridge
set -e # Exit on error
# Determine script directory (apps/homekit)
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
# Navigate to workspace root (two levels up from apps/homekit)
WORKSPACE_ROOT="$(cd "$SCRIPT_DIR/../.." && pwd)"
cd "$WORKSPACE_ROOT"
echo "🏠 HomeKit Bridge Startup"
echo "========================="
echo " Working dir: $WORKSPACE_ROOT"
echo ""
# Virtual environment path
VENV_DIR="$SCRIPT_DIR/venv"
# Check if virtual environment exists
if [ ! -d "$VENV_DIR" ]; then
echo "📦 Virtual environment not found. Creating..."
# Try to use Python 3.12 or 3.13 (3.14 has compatibility issues with HAP-Python)
if command -v python3.13 &> /dev/null; then
PYTHON_CMD=python3.13
elif command -v python3.12 &> /dev/null; then
PYTHON_CMD=python3.12
elif command -v python3.11 &> /dev/null; then
PYTHON_CMD=python3.11
else
PYTHON_CMD=python3
echo "⚠️ Warning: Using default python3. HAP-Python may not work with Python 3.14+"
fi
echo " Using: $PYTHON_CMD"
$PYTHON_CMD -m venv "$VENV_DIR"
echo "✅ Virtual environment created at $VENV_DIR"
fi
# Activate virtual environment
echo "🔧 Activating virtual environment..."
source "$VENV_DIR/bin/activate"
# Install/update dependencies
echo "📥 Installing dependencies from requirements.txt..."
pip install --upgrade pip -q
pip install -r "$SCRIPT_DIR/requirements.txt" -q
echo "✅ Dependencies installed"
# Set environment variables (with defaults)
export HOMEKIT_NAME="${HOMEKIT_NAME:-Home Automation Bridge}"
export HOMEKIT_PIN="${HOMEKIT_PIN:-031-45-154}"
export HOMEKIT_PORT="${HOMEKIT_PORT:-51826}"
export API_BASE="${API_BASE:-http://172.19.1.11:8001}"
export HOMEKIT_API_TOKEN="${HOMEKIT_API_TOKEN:-}"
export HOMEKIT_PERSIST_FILE="${HOMEKIT_PERSIST_FILE:-$SCRIPT_DIR/homekit.state}"
# Display configuration
echo ""
echo "⚙️ Configuration:"
echo " Bridge Name: $HOMEKIT_NAME"
echo " Bridge PIN: $HOMEKIT_PIN"
echo " Bridge Port: $HOMEKIT_PORT"
echo " API Base URL: $API_BASE"
echo " Persist File: $HOMEKIT_PERSIST_FILE"
echo ""
# Start the bridge
echo "🚀 Starting HomeKit Bridge..."
echo " (Press Ctrl+C to stop)"
echo ""
# Run the bridge from workspace root with correct module path
python -m apps.homekit.main

53
apps/rules/Dockerfile Normal file
View File

@@ -0,0 +1,53 @@
# Rules Engine Dockerfile
# Event-driven automation rules processor with MQTT and Redis
FROM python:3.14-alpine
# Prevent Python from writing .pyc files and enable unbuffered output
ENV PYTHONDONTWRITEBYTECODE=1 \
PYTHONUNBUFFERED=1 \
RULES_CONFIG=config/rules.yaml \
MQTT_BROKER=172.16.2.16 \
MQTT_PORT=1883 \
REDIS_HOST=localhost \
REDIS_PORT=6379 \
REDIS_DB=8 \
LOG_LEVEL=INFO
# Create non-root user
RUN addgroup -g 10001 -S app && \
adduser -u 10001 -S app -G app
# Set working directory
WORKDIR /app
# Install system dependencies
RUN apk add --no-cache \
gcc \
musl-dev \
linux-headers
# Install Python dependencies
COPY apps/rules/requirements.txt /app/requirements.txt
RUN pip install --no-cache-dir -r requirements.txt
# Copy application code
COPY apps/__init__.py /app/apps/
COPY apps/rules/ /app/apps/rules/
COPY packages/ /app/packages/
COPY config/ /app/config/
# Change ownership to non-root user
RUN chown -R app:app /app
# Switch to non-root user
USER app
# Expose no ports (MQTT/Redis client only)
# Health check (check if process is running)
HEALTHCHECK --interval=30s --timeout=10s --start-period=5s --retries=3 \
CMD pgrep -f "apps.rules.main" || exit 1
# Run the rules engine
CMD ["python", "-m", "apps.rules.main"]

View File

@@ -0,0 +1,371 @@
# Rule Interface Documentation
## Overview
The rule interface provides a clean abstraction for implementing automation rules. Rules respond to device state changes and can publish commands, persist state, and log diagnostics.
## Core Components
### 1. RuleDescriptor
Configuration data for a rule instance (loaded from `rules.yaml`):
```python
RuleDescriptor(
id="window_setback_wohnzimmer", # Unique rule ID
name="Fensterabsenkung Wohnzimmer", # Optional display name
type="window_setback@1.0", # Rule type + version
targets={ # Rule-specific targets
"rooms": ["Wohnzimmer"],
"contacts": ["kontakt_wohnzimmer_..."],
"thermostats": ["thermostat_wohnzimmer"]
},
params={ # Rule-specific parameters
"eco_target": 16.0,
"open_min_secs": 20
}
)
```
### 2. RedisState
Async state persistence with automatic reconnection and retry logic:
```python
# Initialize (done by rule engine)
redis_state = RedisState("redis://172.23.1.116:6379/8")
# Simple key-value with TTL
await ctx.redis.set("rules:my_rule:temp", "22.5", ttl_secs=3600)
value = await ctx.redis.get("rules:my_rule:temp") # Returns "22.5" or None
# Hash storage (for multiple related values)
await ctx.redis.hset("rules:my_rule:sensors", "bedroom", "open")
await ctx.redis.hset("rules:my_rule:sensors", "kitchen", "closed")
value = await ctx.redis.hget("rules:my_rule:sensors", "bedroom") # "open"
# TTL management
await ctx.redis.expire("rules:my_rule:temp", 7200) # Extend to 2 hours
# JSON helpers (for complex data)
import json
data = {"temp": 22.5, "humidity": 45}
await ctx.redis.set("rules:my_rule:data", ctx.redis._dumps(data))
stored = await ctx.redis.get("rules:my_rule:data")
parsed = ctx.redis._loads(stored) if stored else None
```
**Key Conventions:**
- Use prefix `rules:{rule_id}:` for all keys
- Example: `rules:window_setback_wohnzimmer:thermo:device_123:previous`
- TTL recommended for temporary state (previous temperatures, timers)
**Robustness Features:**
- Automatic retry with exponential backoff (default: 3 retries)
- Connection pooling (max 10 connections)
- Automatic reconnection on Redis restart
- Health checks every 30 seconds
- All operations wait and retry, no exceptions on temporary outages
### 3. MQTTClient
Async MQTT client with event normalization and command publishing:
```python
# Initialize (done by rule engine)
mqtt_client = MQTTClient(
broker="172.16.2.16",
port=1883,
client_id="rule_engine"
)
# Subscribe and receive normalized events
async for event in mqtt_client.connect():
# Event structure:
# {
# "topic": "home/contact/sensor_1/state",
# "type": "state",
# "cap": "contact", # Capability (contact, thermostat, etc.)
# "device_id": "sensor_1",
# "payload": {"contact": "open"},
# "ts": "2025-11-11T10:30:45.123456"
# }
if event['cap'] == 'contact':
handle_contact(event)
elif event['cap'] == 'thermostat':
handle_thermostat(event)
# Publish commands (within async context)
await mqtt_client.publish_set_thermostat("thermostat_id", 22.5)
```
**Subscriptions:**
- `home/contact/+/state` - All contact sensor state changes
- `home/thermostat/+/state` - All thermostat state changes
**Publishing:**
- Topic: `home/thermostat/{device_id}/set`
- Payload: `{"type":"thermostat","payload":{"target":22.5}}`
- QoS: 1 (at least once delivery)
**Robustness:**
- Automatic reconnection with exponential backoff
- Connection logging (connect/disconnect events)
- Clean session handling
### 4. MQTTPublisher (Legacy)
Simplified wrapper around MQTTClient for backward compatibility:
```python
# Set thermostat temperature
await ctx.mqtt.publish_set_thermostat("thermostat_wohnzimmer", 21.5)
```
### 5. RuleContext
Runtime context provided to rules:
```python
class RuleContext:
logger # Logger instance
mqtt # MQTTPublisher
redis # RedisState
now() -> datetime # Current timestamp
```
### 5. Rule Abstract Base Class
All rules extend this:
```python
class MyRule(Rule):
async def on_event(self, evt: dict, desc: RuleDescriptor, ctx: RuleContext) -> None:
# Event structure:
# {
# "topic": "home/contact/device_id/state",
# "type": "state",
# "cap": "contact",
# "device_id": "kontakt_wohnzimmer",
# "payload": {"contact": "open"},
# "ts": "2025-11-11T10:30:45.123456"
# }
device_id = evt['device_id']
cap = evt['cap']
if cap == 'contact':
contact_state = evt['payload'].get('contact')
# ... implement logic
```
## Implementing a New Rule
### Step 1: Create Rule Class
```python
from packages.rule_interface import Rule, RuleDescriptor, RuleContext
from typing import Any
class MyCustomRule(Rule):
"""My custom automation rule."""
async def on_event(
self,
evt: dict[str, Any],
desc: RuleDescriptor,
ctx: RuleContext
) -> None:
"""Process device state changes."""
# 1. Extract event data
device_id = evt['device_id']
cap = evt['cap']
payload = evt['payload']
# 2. Filter to relevant devices
if device_id not in desc.targets.get('my_devices', []):
return
# 3. Implement logic
if cap == 'contact':
if payload.get('contact') == 'open':
# Do something
await ctx.mqtt.publish_set_thermostat(
'some_thermostat',
desc.params.get('temp', 20.0)
)
# 4. Persist state if needed
state_key = f"rule:{desc.id}:device:{device_id}:state"
await ctx.redis.set(state_key, payload.get('contact'))
```
### Step 2: Register in RULE_IMPLEMENTATIONS
```python
# In your rule module (e.g., my_custom_rule.py)
RULE_IMPLEMENTATIONS = {
'my_custom@1.0': MyCustomRule,
}
```
### Step 3: Configure in rules.yaml
```yaml
rules:
- id: my_custom_living_room
name: My Custom Rule for Living Room
type: my_custom@1.0
targets:
my_devices:
- device_1
- device_2
params:
temp: 22.0
duration_secs: 300
```
## Best Practices
### Idempotency
Rules MUST be idempotent - processing the same event multiple times should be safe:
```python
# Good: Idempotent
async def on_event(self, evt, desc, ctx):
if evt['payload'].get('contact') == 'open':
await ctx.mqtt.publish_set_thermostat('thermo', 16.0)
# Bad: Not idempotent (increments counter)
async def on_event(self, evt, desc, ctx):
counter = await ctx.redis.get('counter') or '0'
await ctx.redis.set('counter', str(int(counter) + 1))
```
### Error Handling
Handle errors gracefully - the engine will catch and log exceptions:
```python
async def on_event(self, evt, desc, ctx):
try:
await ctx.mqtt.publish_set_thermostat('thermo', 16.0)
except Exception as e:
ctx.logger.error(f"Failed to set thermostat: {e}")
# Don't raise - let event processing continue
```
### State Keys
Use consistent naming for Redis keys:
```python
# Pattern: rule:{rule_id}:{category}:{device_id}:{field}
state_key = f"rule:{desc.id}:contact:{device_id}:state"
ts_key = f"rule:{desc.id}:contact:{device_id}:ts"
prev_key = f"rule:{desc.id}:thermo:{device_id}:previous"
```
### Logging
Use appropriate log levels:
```python
ctx.logger.debug("Detailed diagnostic info")
ctx.logger.info("Normal operation milestones")
ctx.logger.warning("Unexpected but handled situations")
ctx.logger.error("Errors that prevent operation")
```
## Event Structure Reference
### Contact Sensor Event
```python
{
"topic": "home/contact/kontakt_wohnzimmer/state",
"type": "state",
"cap": "contact",
"device_id": "kontakt_wohnzimmer",
"payload": {
"contact": "open" # or "closed"
},
"ts": "2025-11-11T10:30:45.123456"
}
```
### Thermostat Event
```python
{
"topic": "home/thermostat/thermostat_wohnzimmer/state",
"type": "state",
"cap": "thermostat",
"device_id": "thermostat_wohnzimmer",
"payload": {
"target": 21.0,
"current": 20.5,
"mode": "heat"
},
"ts": "2025-11-11T10:30:45.123456"
}
```
## Testing Rules
Rules can be tested independently of the engine:
```python
import pytest
from unittest.mock import AsyncMock, MagicMock
from packages.my_custom_rule import MyCustomRule
from packages.rule_interface import RuleDescriptor, RuleContext
@pytest.mark.asyncio
async def test_my_rule():
# Setup
rule = MyCustomRule()
desc = RuleDescriptor(
id="test_rule",
type="my_custom@1.0",
targets={"my_devices": ["device_1"]},
params={"temp": 22.0}
)
# Mock context
ctx = RuleContext(
logger=MagicMock(),
mqtt_publisher=AsyncMock(),
redis_state=AsyncMock(),
now_fn=lambda: datetime.now()
)
# Test event
evt = {
"device_id": "device_1",
"cap": "contact",
"payload": {"contact": "open"},
"ts": "2025-11-11T10:30:45.123456"
}
# Execute
await rule.on_event(evt, desc, ctx)
# Assert
ctx.mqtt.publish_set_thermostat.assert_called_once_with('some_thermostat', 22.0)
```
## Extension Points
The interface is designed to be extended without modifying the engine:
1. **New rule types**: Just implement `Rule` and register in `RULE_IMPLEMENTATIONS`
2. **New MQTT commands**: Extend `MQTTPublisher` with new methods
3. **New state backends**: Implement `RedisState` interface with different storage
4. **Custom context**: Extend `RuleContext` with additional utilities
The engine only depends on the abstract interfaces, not specific implementations.

View File

@@ -0,0 +1,15 @@
"""
Rule Implementations Package
This package contains all rule implementation modules.
Naming Convention:
- Module name: snake_case matching the rule type name
Example: window_setback.py for type 'window_setback@1.0'
- Class name: PascalCase + 'Rule' suffix
Example: WindowSetbackRule
The rule engine uses load_rule() from rule_interface to dynamically
import modules from this package based on the 'type' field in rules.yaml.
"""

View File

@@ -0,0 +1,256 @@
"""
Example Rule Implementation: Window Setback
Demonstrates how to implement a Rule using the rule_interface.
This rule lowers thermostat temperature when a window is opened.
"""
from typing import Any
from pydantic import BaseModel, Field, ValidationError
from apps.rules.rule_interface import Rule, RuleDescriptor, RuleContext
class WindowSetbackObjects(BaseModel):
"""Object structure for window setback rule"""
contacts: list[str] = Field(..., min_length=1, description="Contact sensors to monitor")
thermostats: list[str] = Field(..., min_length=1, description="Thermostats to control")
class WindowSetbackRule(Rule):
"""
Window setback automation rule.
When a window/door contact opens, set thermostats to eco temperature.
When closed for a minimum duration, restore previous target temperature.
Configuration:
objects:
contacts: List of contact sensor device IDs to monitor (required, min 1)
thermostats: List of thermostat device IDs to control (required, min 1)
params:
eco_target: Temperature to set when window opens (default: 16.0)
open_min_secs: Minimum seconds window must be open before triggering (default: 20)
close_min_secs: Minimum seconds window must be closed before restoring (default: 20)
previous_target_ttl_secs: How long to remember previous temperature (default: 86400)
State storage (Redis keys):
rule:{rule_id}:contact:{device_id}:state -> "open" | "closed"
rule:{rule_id}:contact:{device_id}:ts -> ISO timestamp of last change
rule:{rule_id}:thermo:{device_id}:current_target -> Current target temp (updated on every STATE)
rule:{rule_id}:thermo:{device_id}:previous -> Previous target temp (saved on window open, deleted on restore)
Logic:
1. Thermostat STATE events → update current_target in Redis
2. Window opens → copy current_target to previous, then set to eco_target
3. Window closes → restore from previous, then delete previous key
"""
def __init__(self):
super().__init__()
self._validated_objects: dict[str, WindowSetbackObjects] = {}
async def setup(self, desc: RuleDescriptor, ctx: RuleContext) -> None:
"""Validate objects structure during setup"""
try:
validated = WindowSetbackObjects(**desc.objects)
self._validated_objects[desc.id] = validated
ctx.logger.info(
f"Rule {desc.id} validated: {len(validated.contacts)} contacts, "
f"{len(validated.thermostats)} thermostats"
)
except ValidationError as e:
raise ValueError(
f"Invalid objects configuration for rule {desc.id}: {e}"
) from e
def get_subscriptions(self, desc: RuleDescriptor) -> list[str]:
"""
Return MQTT topics to subscribe to.
Subscribe to:
- Contact sensor state changes (to detect window open/close)
- Thermostat state changes (to track current target temperature)
"""
topics = []
# Subscribe to contact sensors
contacts = desc.objects.get('contacts', [])
for contact_id in contacts:
topics.append(f"home/contact/{contact_id}/state")
# Subscribe to thermostats to track their current target temperature
thermostats = desc.objects.get('thermostats', [])
for thermo_id in thermostats:
topics.append(f"home/thermostat/{thermo_id}/state")
return topics
async def on_event(
self,
evt: dict[str, Any],
desc: RuleDescriptor,
ctx: RuleContext
) -> None:
"""
Process contact sensor or thermostat state changes.
Logic:
1. If contact opened → remember current thermostat targets, set to eco
2. If contact closed for min_secs → restore previous targets
3. If thermostat target changed → update stored previous value
"""
device_id = evt['device_id']
cap = evt['cap']
payload = evt['payload']
# Only process events for devices in our objects
target_contacts = desc.objects.get('contacts', [])
target_thermostats = desc.objects.get('thermostats', [])
if cap == 'contact' and device_id in target_contacts:
await self._handle_contact_event(evt, desc, ctx)
elif cap == 'thermostat' and device_id in target_thermostats:
await self._handle_thermostat_event(evt, desc, ctx)
async def _handle_contact_event(
self,
evt: dict[str, Any],
desc: RuleDescriptor,
ctx: RuleContext
) -> None:
"""Handle contact sensor state change."""
device_id = evt['device_id']
contact_state = evt['payload'].get('contact') # "open" or "closed"
event_ts = evt.get('ts', ctx.now().isoformat())
if not contact_state:
ctx.logger.warning(f"Contact event missing 'contact' field: {evt}")
return
# Store current state and timestamp
state_key = f"rule:{desc.id}:contact:{device_id}:state"
ts_key = f"rule:{desc.id}:contact:{device_id}:ts"
await ctx.redis.set(state_key, contact_state)
await ctx.redis.set(ts_key, event_ts)
if contact_state == 'open':
await self._on_window_opened(desc, ctx)
elif contact_state == 'closed':
await self._on_window_closed(desc, ctx)
async def _on_window_opened(self, desc: RuleDescriptor, ctx: RuleContext) -> None:
"""
Window opened - save current temperatures, then set thermostats to eco.
Important: We must save the current target BEFORE setting to eco,
otherwise we'll save the eco temperature instead of the original.
"""
eco_target = desc.params.get('eco_target', 16.0)
target_thermostats = desc.objects.get('thermostats', [])
ttl_secs = desc.params.get('previous_target_ttl_secs', 86400)
ctx.logger.info(
f"Rule {desc.id}: Window opened, setting {len(target_thermostats)} "
f"thermostats to eco temperature {eco_target}°C"
)
# FIRST: Save current target temperatures as "previous" (before we change them!)
for thermo_id in target_thermostats:
current_key = f"rule:{desc.id}:thermo:{thermo_id}:current_target"
current_temp_str = await ctx.redis.get(current_key)
if current_temp_str:
# Save current as previous (with TTL)
prev_key = f"rule:{desc.id}:thermo:{thermo_id}:previous"
await ctx.redis.set(prev_key, current_temp_str, ttl_secs=ttl_secs)
ctx.logger.debug(
f"Saved previous target for {thermo_id}: {current_temp_str}°C"
)
else:
ctx.logger.warning(
f"No current target found for {thermo_id}, cannot save previous"
)
# THEN: Set all thermostats to eco temperature
for thermo_id in target_thermostats:
try:
await ctx.mqtt.publish_set_thermostat(thermo_id, eco_target)
ctx.logger.debug(f"Set {thermo_id} to {eco_target}°C")
except Exception as e:
ctx.logger.error(f"Failed to set {thermo_id}: {e}")
async def _on_window_closed(self, desc: RuleDescriptor, ctx: RuleContext) -> None:
"""
Window closed - restore previous temperatures.
Note: This is simplified. A production implementation would check
close_min_secs and use a timer/scheduler.
"""
target_thermostats = desc.objects.get('thermostats', [])
ctx.logger.info(
f"Rule {desc.id}: Window closed, restoring {len(target_thermostats)} "
f"thermostats to previous temperatures"
)
# Restore previous temperatures
for thermo_id in target_thermostats:
prev_key = f"rule:{desc.id}:thermo:{thermo_id}:previous"
prev_temp_str = await ctx.redis.get(prev_key)
if prev_temp_str:
try:
prev_temp = float(prev_temp_str)
await ctx.mqtt.publish_set_thermostat(thermo_id, prev_temp)
ctx.logger.debug(f"Restored {thermo_id} to {prev_temp}°C")
# Delete the previous key after restoring
await ctx.redis.delete(prev_key)
except Exception as e:
ctx.logger.error(f"Failed to restore {thermo_id}: {e}")
else:
ctx.logger.warning(
f"No previous target found for {thermo_id}, cannot restore"
)
async def _handle_thermostat_event(
self,
evt: dict[str, Any],
desc: RuleDescriptor,
ctx: RuleContext
) -> None:
"""
Handle thermostat state change - track current target temperature.
This keeps a record of the thermostat's current target, so we can
save it as "previous" when a window opens.
Important: We store in "current_target", NOT "previous". The "previous"
key is only written when a window opens, to avoid race conditions.
"""
device_id = evt['device_id']
payload = evt['payload']
current_target = payload.get('target')
if current_target is None:
return # No target in this state update
# Store current target (always update, even if it's the eco temperature)
current_key = f"rule:{desc.id}:thermo:{device_id}:current_target"
ttl_secs = desc.params.get('previous_target_ttl_secs', 86400)
await ctx.redis.set(current_key, str(current_target), ttl_secs=ttl_secs)
ctx.logger.debug(
f"Rule {desc.id}: Updated current target for {device_id}: {current_target}°C"
)
# Rule registry - maps rule type to implementation class
RULE_IMPLEMENTATIONS = {
'window_setback@1.0': WindowSetbackRule,
}

View File

@@ -1,83 +1,374 @@
"""Rules main entry point."""
"""
Rules Engine
Loads rules configuration, subscribes to MQTT events, and dispatches events
to registered rule implementations.
"""
import asyncio
import logging
import os
import signal
import sys
import time
from typing import NoReturn
from datetime import datetime
from typing import Any
from apscheduler.schedulers.background import BackgroundScheduler
from apps.rules.rules_config import load_rules_config
from apps.rules.rule_interface import (
RuleDescriptor,
RuleContext,
MQTTClient,
RedisState,
load_rule
)
# Configure logging
logging.basicConfig(
level=logging.INFO,
level=logging.DEBUG,
format="%(asctime)s - %(name)s - %(levelname)s - %(message)s"
)
logger = logging.getLogger(__name__)
# Global scheduler instance
scheduler: BackgroundScheduler | None = None
def rule_tick() -> None:
"""Example job that runs every minute.
This is a placeholder for actual rule evaluation logic.
class RuleEngine:
"""
logger.info("Rule tick")
def shutdown_handler(signum: int, frame: object) -> NoReturn:
"""Handle shutdown signals gracefully.
Args:
signum: Signal number
frame: Current stack frame
Rule engine that loads rules, subscribes to MQTT events,
and dispatches them to registered rule implementations.
"""
logger.info(f"Received signal {signum}, shutting down...")
if scheduler:
scheduler.shutdown(wait=True)
logger.info("Scheduler stopped")
sys.exit(0)
def __init__(
self,
rules_config_path: str,
mqtt_broker: str,
mqtt_port: int,
redis_url: str
):
"""
Initialize rule engine.
Args:
rules_config_path: Path to rules.yaml
mqtt_broker: MQTT broker hostname/IP
mqtt_port: MQTT broker port
redis_url: Redis connection URL
"""
self.rules_config_path = rules_config_path
self.mqtt_broker = mqtt_broker
self.mqtt_port = mqtt_port
self.redis_url = redis_url
# Will be initialized in setup()
self.rule_descriptors: list[RuleDescriptor] = []
self.rules: dict[str, Any] = {} # rule_id -> Rule instance
self.mqtt_client: MQTTClient | None = None
self.redis_state: RedisState | None = None
self.context: RuleContext | None = None
self._mqtt_topics: list[str] = [] # Topics to subscribe to
# For graceful shutdown
self._shutdown_event = asyncio.Event()
async def setup(self) -> None:
"""
Load configuration and instantiate rules.
Raises:
ImportError: If rule implementation not found
ValueError: If configuration is invalid
"""
logger.info(f"Loading rules configuration from {self.rules_config_path}")
# Load rules configuration
config = load_rules_config(self.rules_config_path)
self.rule_descriptors = config.rules
logger.info(f"Loaded {len(self.rule_descriptors)} rule(s) from configuration")
# Instantiate each rule
for desc in self.rule_descriptors:
if not desc.enabled:
logger.info(f" - {desc.id} (type: {desc.type}) [DISABLED]")
continue
try:
rule_instance = load_rule(desc)
self.rules[desc.id] = rule_instance
logger.info(f" - {desc.id} (type: {desc.type})")
except Exception as e:
logger.error(f"Failed to load rule {desc.id} (type: {desc.type}): {e}")
raise
enabled_count = len(self.rules)
total_count = len(self.rule_descriptors)
disabled_count = total_count - enabled_count
logger.info(f"Successfully loaded {enabled_count} rule implementation(s) ({disabled_count} disabled)")
# Call setup on each rule for validation
for rule_id, rule_instance in self.rules.items():
desc = next((d for d in self.rule_descriptors if d.id == rule_id), None)
if desc:
try:
ctx = RuleContext(
logger=logger,
mqtt_publisher=self.mqtt_client,
redis_state=self.redis_state
)
await rule_instance.setup(desc, ctx)
except Exception as e:
logger.error(f"Failed to setup rule {rule_id}: {e}")
raise
# Collect MQTT subscriptions from all enabled rules
all_topics = set()
for rule_id, rule_instance in self.rules.items():
desc = next((d for d in self.rule_descriptors if d.id == rule_id), None)
if desc:
try:
topics = rule_instance.get_subscriptions(desc)
all_topics.update(topics)
logger.debug(f"Rule {rule_id} subscribes to {len(topics)} topic(s)")
except Exception as e:
logger.error(f"Failed to get subscriptions for rule {rule_id}: {e}")
raise
logger.info(f"Total MQTT subscriptions needed: {len(all_topics)}")
# Create unique client ID to avoid conflicts
import uuid
import os
client_id_base = "rule_engine"
client_suffix = os.environ.get("MQTT_CLIENT_ID_SUFFIX") or uuid.uuid4().hex[:6]
unique_client_id = f"{client_id_base}-{client_suffix}"
# Initialize MQTT client
self.mqtt_client = MQTTClient(
broker=self.mqtt_broker,
port=self.mqtt_port,
client_id=unique_client_id
)
self.mqtt_client.set_logger(logger)
# Store topics for connection
self._mqtt_topics = list(all_topics)
# Initialize Redis state
self.redis_state = RedisState(self.redis_url)
# Create MQTT publisher wrapper for RuleContext
from apps.rules.rule_interface import MQTTPublisher
mqtt_publisher = MQTTPublisher(mqtt_client=self.mqtt_client)
# Create rule context
self.context = RuleContext(
logger=logger,
mqtt_publisher=mqtt_publisher,
redis_state=self.redis_state,
now_fn=datetime.now
)
def _filter_rules_for_event(self, event: dict[str, Any]) -> list[tuple[str, RuleDescriptor]]:
"""
Filter rules that should receive this event.
Rules match if the event's device_id is in the rule's objects.
Args:
event: Normalized MQTT event
Returns:
List of (rule_id, descriptor) tuples that should process this event
"""
matching_rules = []
device_id = event.get('device_id')
cap = event.get('cap')
if not device_id or not cap:
return matching_rules
logger.debug(f"Filtering for cap={cap}, device_id={device_id}")
# Only check enabled rules (rules in self.rules dict)
for rule_id, rule_instance in self.rules.items():
desc = next((d for d in self.rule_descriptors if d.id == rule_id), None)
if not desc:
continue
objects = desc.objects
# Check if this device is in the rule's objects
matched = False
if cap == 'contact' and objects.get('contacts'):
logger.debug(f"Rule {rule_id}: checking contacts {objects.get('contacts')}")
if device_id in objects.get('contacts', []):
matched = True
elif cap == 'thermostat' and objects.get('thermostats'):
logger.debug(f"Rule {rule_id}: checking thermostats {objects.get('thermostats')}")
if device_id in objects.get('thermostats', []):
matched = True
elif cap == 'light' and objects.get('lights'):
logger.debug(f"Rule {rule_id}: checking lights {objects.get('lights')}")
if device_id in objects.get('lights', []):
matched = True
elif cap == 'relay' and objects.get('relays'):
logger.debug(f"Rule {rule_id}: checking relays {objects.get('relays')}")
if device_id in objects.get('relays', []):
matched = True
if matched:
matching_rules.append((rule_id, desc))
return matching_rules
async def _dispatch_event(self, event: dict[str, Any]) -> None:
"""
Dispatch event to matching rules.
Calls rule.on_event() for each matching rule sequentially
to preserve order and avoid race conditions.
Args:
event: Normalized MQTT event
"""
# Debug logging
logger.debug(f"Received event: {event}")
matching_rules = self._filter_rules_for_event(event)
if not matching_rules:
# No rules interested in this event
logger.debug(f"No matching rules for {event.get('cap')}/{event.get('device_id')}")
return
logger.info(
f"Event {event['cap']}/{event['device_id']}: "
f"{len(matching_rules)} matching rule(s)"
)
# Process rules sequentially to preserve order
for rule_id, desc in matching_rules:
rule = self.rules.get(rule_id)
if not rule:
logger.warning(f"Rule instance not found for {rule_id}")
continue
try:
await rule.on_event(event, desc, self.context)
except Exception as e:
logger.error(
f"Error in rule {rule_id} processing event "
f"{event['cap']}/{event['device_id']}: {e}",
exc_info=True
)
# Continue with other rules
async def run(self) -> None:
"""
Main event loop - subscribe to MQTT and process events.
Runs until shutdown signal received.
"""
logger.info("Starting event processing loop")
try:
async for event in self.mqtt_client.connect(topics=self._mqtt_topics):
# Check for shutdown
if self._shutdown_event.is_set():
logger.info("Shutdown signal received, stopping event loop")
break
# Dispatch event to matching rules
await self._dispatch_event(event)
except asyncio.CancelledError:
logger.info("Event loop cancelled")
raise
except Exception as e:
logger.error(f"Fatal error in event loop: {e}", exc_info=True)
raise
async def shutdown(self) -> None:
"""Graceful shutdown - close connections."""
logger.info("Shutting down rule engine...")
self._shutdown_event.set()
if self.redis_state:
await self.redis_state.close()
logger.info("Redis connection closed")
logger.info("Shutdown complete")
async def main_async() -> None:
"""Async main function."""
# Read configuration from environment
rules_config = os.getenv('RULES_CONFIG', 'config/rules.yaml')
mqtt_broker = os.getenv('MQTT_BROKER', '172.16.2.16')
mqtt_port = int(os.getenv('MQTT_PORT', '1883'))
redis_host = os.getenv('REDIS_HOST', '172.23.1.116')
redis_port = int(os.getenv('REDIS_PORT', '6379'))
redis_db = int(os.getenv('REDIS_DB', '8'))
redis_url = f'redis://{redis_host}:{redis_port}/{redis_db}'
logger.info("=" * 60)
logger.info("Rules Engine Starting")
logger.info("=" * 60)
logger.info(f"Config: {rules_config}")
logger.info(f"MQTT: {mqtt_broker}:{mqtt_port}")
logger.info(f"Redis: {redis_url}")
logger.info("=" * 60)
# Initialize engine
engine = RuleEngine(
rules_config_path=rules_config,
mqtt_broker=mqtt_broker,
mqtt_port=mqtt_port,
redis_url=redis_url
)
# Load rules
try:
await engine.setup()
except Exception as e:
logger.error(f"Failed to setup engine: {e}", exc_info=True)
sys.exit(1)
# Setup signal handlers for graceful shutdown
loop = asyncio.get_running_loop()
main_task = None
def signal_handler():
logger.info("Received shutdown signal")
engine._shutdown_event.set()
if main_task and not main_task.done():
main_task.cancel()
for sig in (signal.SIGTERM, signal.SIGINT):
loop.add_signal_handler(sig, signal_handler)
# Run engine
try:
main_task = asyncio.create_task(engine.run())
await main_task
except asyncio.CancelledError:
logger.info("Main task cancelled")
finally:
await engine.shutdown()
def main() -> None:
"""Run the rules application."""
global scheduler
logger.info("Rules engine starting...")
# Register signal handlers
signal.signal(signal.SIGINT, shutdown_handler)
signal.signal(signal.SIGTERM, shutdown_handler)
# Initialize scheduler
scheduler = BackgroundScheduler()
# Add example job - runs every minute
scheduler.add_job(
rule_tick,
'interval',
minutes=1,
id='rule_tick',
name='Rule Tick Job'
)
# Start scheduler
scheduler.start()
logger.info("Scheduler started with rule_tick job (every 1 minute)")
# Run initial tick immediately
rule_tick()
# Keep the application running
"""Entry point for rule engine."""
try:
while True:
time.sleep(1)
asyncio.run(main_async())
except KeyboardInterrupt:
logger.info("KeyboardInterrupt received, shutting down...")
scheduler.shutdown(wait=True)
logger.info("Scheduler stopped")
logger.info("Keyboard interrupt received")
except Exception as e:
logger.error(f"Fatal error: {e}", exc_info=True)
sys.exit(1)
if __name__ == "__main__":

View File

@@ -0,0 +1,5 @@
# Rules Engine Dependencies
pydantic>=2.0
redis>=5.0.1
aiomqtt>=2.0.1
pyyaml>=6.0.1

View File

@@ -0,0 +1,759 @@
"""
Rule Interface and Context Objects
Provides the core abstractions for implementing automation rules:
- RuleDescriptor: Configuration data for a rule instance
- RedisState: State persistence interface
- RuleContext: Runtime context provided to rules
- Rule: Abstract base class for all rule implementations
"""
from abc import ABC, abstractmethod
from datetime import datetime
from typing import Any, Awaitable, Optional
from pydantic import BaseModel, Field
class RuleDescriptor(BaseModel):
"""
Configuration descriptor for a rule instance.
This is the validated representation of a rule from rules.yaml.
The engine loads these and passes them to rule implementations.
The 'objects' field is intentionally flexible (dict) to allow different
rule types to define their own object structures.
"""
id: str = Field(..., description="Unique identifier for this rule instance")
name: Optional[str] = Field(None, description="Optional human-readable name")
type: str = Field(..., description="Rule type with version (e.g., 'window_setback@1.0')")
enabled: bool = Field(default=True, description="Whether this rule is enabled")
objects: dict[str, Any] = Field(
default_factory=dict,
description="Objects this rule monitors or controls (structure varies by rule type)"
)
params: dict[str, Any] = Field(
default_factory=dict,
description="Rule-specific parameters"
)
class RedisState:
"""
Async Redis-backed state persistence for rules with automatic reconnection.
Provides a simple key-value and hash storage interface for rules to persist
state across restarts. All operations are asynchronous and include retry logic
for robustness against temporary Redis outages.
Key Convention:
- Callers should use keys like: f"rules:{rule_id}:contact:{device_id}"
- This class does NOT enforce key prefixes - caller controls the full key
"""
def __init__(self, url: str, max_retries: int = 3, retry_delay: float = 0.5):
"""
Initialize RedisState with connection URL.
Args:
url: Redis connection URL (e.g., 'redis://172.23.1.116:6379/8')
max_retries: Maximum number of retry attempts for operations (default: 3)
retry_delay: Initial delay between retries in seconds, uses exponential backoff (default: 0.5)
Note:
Connection is lazy - actual connection happens on first operation.
Uses connection pooling with automatic reconnection on failure.
"""
self._url = url
self._max_retries = max_retries
self._retry_delay = retry_delay
self._redis: Optional[Any] = None # redis.asyncio.Redis instance
async def _get_client(self):
"""
Get or create Redis client with connection pool.
Lazy initialization ensures we don't connect until first use.
Uses decode_responses=True for automatic UTF-8 decoding.
"""
if self._redis is None:
import redis.asyncio as aioredis
self._redis = await aioredis.from_url(
self._url,
decode_responses=True, # Automatic UTF-8 decode
encoding='utf-8',
max_connections=10, # Connection pool size
socket_connect_timeout=5,
socket_keepalive=True,
health_check_interval=30 # Auto-check connection health
)
return self._redis
async def _execute_with_retry(self, operation, *args, **kwargs):
"""
Execute Redis operation with exponential backoff retry.
Handles temporary connection failures gracefully by retrying
with exponential backoff. On permanent failure, raises the
original exception.
Args:
operation: Async callable (Redis method)
*args, **kwargs: Arguments to pass to operation
Returns:
Result of the operation
Raises:
Exception: If all retries are exhausted
"""
import asyncio
last_exception = None
for attempt in range(self._max_retries):
try:
client = await self._get_client()
return await operation(client, *args, **kwargs)
except Exception as e:
last_exception = e
if attempt < self._max_retries - 1:
# Exponential backoff: 0.5s, 1s, 2s, ...
delay = self._retry_delay * (2 ** attempt)
await asyncio.sleep(delay)
# Reset client to force reconnection
if self._redis:
try:
await self._redis.close()
except:
pass
self._redis = None
# All retries exhausted
raise last_exception
# JSON helpers for complex data structures
def _dumps(self, obj: Any) -> str:
"""Serialize Python object to JSON string."""
import json
return json.dumps(obj, ensure_ascii=False)
def _loads(self, s: str) -> Any:
"""Deserialize JSON string to Python object."""
import json
return json.loads(s)
async def get(self, key: str) -> Optional[str]:
"""
Get a string value by key.
Args:
key: Redis key (e.g., "rules:my_rule:contact:sensor_1")
Returns:
String value or None if key doesn't exist
Example:
>>> state = RedisState("redis://localhost:6379/0")
>>> await state.set("rules:r1:temp", "22.5")
>>> temp = await state.get("rules:r1:temp")
>>> print(temp) # "22.5"
"""
async def _get(client, k):
return await client.get(k)
return await self._execute_with_retry(_get, key)
async def set(self, key: str, value: str, ttl_secs: Optional[int] = None) -> None:
"""
Set a string value with optional TTL.
Args:
key: Redis key
value: String value to store
ttl_secs: Optional time-to-live in seconds. If None, key persists indefinitely.
Example:
>>> state = RedisState("redis://localhost:6379/0")
>>> # Store with 1 hour TTL
>>> await state.set("rules:r1:previous_temp", "20.0", ttl_secs=3600)
"""
async def _set(client, k, v, ttl):
if ttl is not None:
await client.setex(k, ttl, v)
else:
await client.set(k, v)
await self._execute_with_retry(_set, key, value, ttl_secs)
async def hget(self, key: str, field: str) -> Optional[str]:
"""
Get a hash field value.
Args:
key: Redis hash key
field: Field name within the hash
Returns:
String value or None if field doesn't exist
Example:
>>> state = RedisState("redis://localhost:6379/0")
>>> await state.hset("rules:r1:device_states", "sensor_1", "open")
>>> value = await state.hget("rules:r1:device_states", "sensor_1")
>>> print(value) # "open"
"""
async def _hget(client, k, f):
return await client.hget(k, f)
return await self._execute_with_retry(_hget, key, field)
async def hset(self, key: str, field: str, value: str) -> None:
"""
Set a hash field value.
Args:
key: Redis hash key
field: Field name within the hash
value: String value to store
Example:
>>> state = RedisState("redis://localhost:6379/0")
>>> await state.hset("rules:r1:sensors", "bedroom", "open")
>>> await state.hset("rules:r1:sensors", "kitchen", "closed")
"""
async def _hset(client, k, f, v):
await client.hset(k, f, v)
await self._execute_with_retry(_hset, key, field, value)
async def expire(self, key: str, ttl_secs: int) -> None:
"""
Set or update TTL on an existing key.
Args:
key: Redis key
ttl_secs: Time-to-live in seconds
Example:
>>> state = RedisState("redis://localhost:6379/0")
>>> await state.set("rules:r1:temp", "22.5")
>>> await state.expire("rules:r1:temp", 3600) # Expire in 1 hour
"""
async def _expire(client, k, ttl):
await client.expire(k, ttl)
await self._execute_with_retry(_expire, key, ttl_secs)
async def delete(self, key: str) -> None:
"""
Delete a key from Redis.
Args:
key: Redis key to delete
Example:
>>> state = RedisState("redis://localhost:6379/0")
>>> await state.set("rules:r1:temp", "22.5")
>>> await state.delete("rules:r1:temp")
"""
async def _delete(client, k):
await client.delete(k)
await self._execute_with_retry(_delete, key)
async def close(self) -> None:
"""
Close Redis connection and cleanup resources.
Should be called when shutting down the application.
"""
if self._redis:
await self._redis.close()
self._redis = None
class MQTTClient:
"""
Async MQTT client for rule engine with event normalization and publishing.
Subscribes to device state topics, normalizes events to a consistent format,
and provides high-level publishing methods for device commands.
Event Normalization:
All incoming MQTT messages are parsed into a normalized event structure:
{
"topic": "home/contact/sensor_1/state",
"type": "state",
"cap": "contact", # Capability type (contact, thermostat, light, etc.)
"device_id": "sensor_1",
"payload": {"contact": "open"},
"ts": "2025-11-11T10:30:45.123456"
}
"""
def __init__(
self,
broker: str,
port: int = 1883,
client_id: str = "rule_engine",
reconnect_interval: int = 5,
max_reconnect_delay: int = 300
):
"""
Initialize MQTT client.
Args:
broker: MQTT broker hostname or IP
port: MQTT broker port (default: 1883)
client_id: Unique client ID for this connection
reconnect_interval: Initial reconnect delay in seconds (default: 5)
max_reconnect_delay: Maximum reconnect delay in seconds (default: 300)
"""
self._broker = broker
self._port = port
self._client_id = client_id
self._reconnect_interval = reconnect_interval
self._max_reconnect_delay = max_reconnect_delay
self._client = None
self._logger = None # Set externally
def set_logger(self, logger):
"""Set logger instance for connection status messages."""
self._logger = logger
def _log(self, level: str, msg: str):
"""Internal logging helper."""
if self._logger:
getattr(self._logger, level)(msg)
else:
print(f"[{level.upper()}] {msg}")
async def connect(self, topics: list[str] = None):
"""
Connect to MQTT broker with automatic reconnection.
This method manages the connection and automatically reconnects
with exponential backoff if the connection is lost.
Args:
topics: List of MQTT topics to subscribe to. If None, subscribes to nothing.
"""
import aiomqtt
from aiomqtt import Client
if topics is None:
topics = []
reconnect_delay = self._reconnect_interval
while True:
try:
self._log("info", f"Connecting to MQTT broker {self._broker}:{self._port} (client_id={self._client_id})")
async with Client(
hostname=self._broker,
port=self._port,
identifier=self._client_id,
) as client:
self._client = client
self._log("info", f"Connected to MQTT broker {self._broker}:{self._port}")
# Subscribe to provided topics
if topics:
for topic in topics:
await client.subscribe(topic)
self._log("info", f"Subscribed to {len(topics)} topic(s): {', '.join(topics[:5])}{'...' if len(topics) > 5 else ''}")
# Reset reconnect delay on successful connection
reconnect_delay = self._reconnect_interval
# Process messages - this is a generator that yields messages
async for message in client.messages:
yield self._normalize_event(message)
except aiomqtt.MqttError as e:
self._log("error", f"MQTT connection error: {e}")
self._log("info", f"Reconnecting in {reconnect_delay} seconds...")
import asyncio
await asyncio.sleep(reconnect_delay)
# Exponential backoff
reconnect_delay = min(reconnect_delay * 2, self._max_reconnect_delay)
def _normalize_event(self, message) -> dict[str, Any]:
"""
Normalize MQTT message to standard event format.
Parses topic to extract capability type and device_id,
adds timestamp, and structures payload.
Args:
message: aiomqtt.Message instance
Returns:
Normalized event dictionary
Example:
Topic: home/contact/sensor_bedroom/state
Payload: {"contact": "open"}
Returns:
{
"topic": "home/contact/sensor_bedroom/state",
"type": "state",
"cap": "contact",
"device_id": "sensor_bedroom",
"payload": {"contact": "open"},
"ts": "2025-11-11T10:30:45.123456"
}
"""
from datetime import datetime
import json
topic = str(message.topic)
topic_parts = topic.split('/')
# Parse topic: home/{capability}/{device_id}/state
if len(topic_parts) >= 4 and topic_parts[0] == 'home' and topic_parts[3] == 'state':
cap = topic_parts[1] # contact, thermostat, light, etc.
device_id = topic_parts[2]
else:
# Fallback for unexpected topic format
cap = "unknown"
device_id = topic_parts[-2] if len(topic_parts) >= 2 else "unknown"
# Parse payload
try:
payload = json.loads(message.payload.decode('utf-8'))
except (json.JSONDecodeError, UnicodeDecodeError):
payload = {"raw": message.payload.decode('utf-8', errors='replace')}
# Generate timestamp
ts = datetime.now().isoformat()
return {
"topic": topic,
"type": "state",
"cap": cap,
"device_id": device_id,
"payload": payload,
"ts": ts
}
async def publish_set_thermostat(self, device_id: str, target: float) -> None:
"""
Publish thermostat target temperature command.
Publishes to: home/thermostat/{device_id}/set
QoS: 1 (at least once delivery)
Args:
device_id: Thermostat device identifier
target: Target temperature in degrees Celsius
Example:
>>> mqtt = MQTTClient("172.16.2.16", 1883)
>>> await mqtt.publish_set_thermostat("thermostat_wohnzimmer", 22.5)
Published to: home/thermostat/thermostat_wohnzimmer/set
Payload: {"type":"thermostat","payload":{"target":22.5}}
"""
import json
if self._client is None:
raise RuntimeError("MQTT client not connected. Call connect() first.")
topic = f"home/thermostat/{device_id}/set"
payload = {
"type": "thermostat",
"payload": {
"target": target
}
}
payload_str = json.dumps(payload)
await self._client.publish(
topic,
payload=payload_str.encode('utf-8'),
qos=1 # At least once delivery
)
self._log("debug", f"Published SET to {topic}: {payload_str}")
# Legacy alias for backward compatibility
class MQTTPublisher:
"""
Legacy MQTT publishing interface - DEPRECATED.
Use MQTTClient instead for new code.
This class is kept for backward compatibility with existing documentation.
"""
def __init__(self, mqtt_client):
"""
Initialize MQTT publisher.
Args:
mqtt_client: MQTTClient instance
"""
self._mqtt = mqtt_client
async def publish_set_thermostat(self, device_id: str, target: float) -> None:
"""
Publish a thermostat target temperature command.
Args:
device_id: Thermostat device identifier
target: Target temperature in degrees Celsius
"""
await self._mqtt.publish_set_thermostat(device_id, target)
class RuleContext:
"""
Runtime context provided to rules during event processing.
Contains all external dependencies and utilities a rule needs:
- Logger for diagnostics
- MQTT client for publishing commands
- Redis client for state persistence
- Current timestamp function
"""
def __init__(
self,
logger,
mqtt_publisher: MQTTPublisher,
redis_state: RedisState,
now_fn=None
):
"""
Initialize rule context.
Args:
logger: Logger instance (e.g., logging.Logger)
mqtt_publisher: MQTTPublisher instance for device commands
redis_state: RedisState instance for persistence
now_fn: Optional callable returning current datetime (defaults to datetime.now)
"""
self.logger = logger
self.mqtt = mqtt_publisher
self.redis = redis_state
self._now_fn = now_fn or datetime.now
def now(self) -> datetime:
"""
Get current timestamp.
Returns:
Current datetime (timezone-aware if now_fn provides it)
"""
return self._now_fn()
class Rule(ABC):
"""
Abstract base class for all automation rule implementations.
Rules implement event-driven automation logic. The engine calls on_event()
for each relevant device state change, passing the event data, rule configuration,
and runtime context.
Implementations must be idempotent - processing the same event multiple times
should produce the same result.
Example implementation:
class WindowSetbackRule(Rule):
def get_subscriptions(self, desc: RuleDescriptor) -> list[str]:
# Subscribe to contact sensor state topics
topics = []
for contact_id in desc.objects.contacts or []:
topics.append(f"home/contact/{contact_id}/state")
return topics
async def on_event(self, evt: dict, desc: RuleDescriptor, ctx: RuleContext) -> None:
device_id = evt['device_id']
cap = evt['cap']
if cap == 'contact':
contact_state = evt['payload'].get('contact')
if contact_state == 'open':
# Window opened - set thermostats to eco
for thermo_id in desc.objects.thermostats or []:
eco_temp = desc.params.get('eco_target', 16.0)
await ctx.mqtt.publish_set_thermostat(thermo_id, eco_temp)
"""
@abstractmethod
def get_subscriptions(self, desc: RuleDescriptor) -> list[str]:
"""
Return list of MQTT topics this rule needs to subscribe to.
Called once during rule engine setup. The rule examines its configuration
(desc.objects) and returns the specific state topics it needs to monitor.
Args:
desc: Rule configuration from rules.yaml
Returns:
List of MQTT topic patterns/strings to subscribe to
Example:
For a window setback rule monitoring 2 contacts:
['home/contact/sensor_bedroom/state', 'home/contact/sensor_kitchen/state']
"""
pass
@abstractmethod
async def on_event(
self,
evt: dict[str, Any],
desc: RuleDescriptor,
ctx: RuleContext
) -> None:
"""
Process a device state change event.
This method is called by the rule engine whenever a device state changes
that is relevant to this rule. The implementation should examine the event
and take appropriate actions (e.g., publish MQTT commands, update state).
MUST be idempotent: Processing the same event multiple times should be safe.
Args:
evt: Event dictionary with the following structure:
{
"topic": "home/contact/device_id/state", # MQTT topic
"type": "state", # Message type
"cap": "contact", # Capability type
"device_id": "kontakt_wohnzimmer", # Device identifier
"payload": {"contact": "open"}, # Capability-specific payload
"ts": "2025-11-11T10:30:45.123456" # ISO timestamp
}
desc: Rule configuration from rules.yaml
ctx: Runtime context with logger, MQTT, Redis, and timestamp utilities
Returns:
None
Raises:
Exception: Implementation may raise exceptions for errors.
The engine will log them but continue processing.
"""
pass
# ============================================================================
# Dynamic Rule Loading
# ============================================================================
import importlib
import re
from typing import Type
# Cache for loaded rule classes (per process)
_RULE_CLASS_CACHE: dict[str, Type[Rule]] = {}
def load_rule(desc: RuleDescriptor) -> Rule:
"""
Dynamically load and instantiate a rule based on its type descriptor.
Convention:
- Rule type format: 'name@version' (e.g., 'window_setback@1.0')
- Module path: apps.rules.impl.{name}
- Class name: PascalCase version of name + 'Rule'
Example: 'window_setback''WindowSetbackRule'
Args:
desc: Rule descriptor from rules.yaml
Returns:
Instantiated Rule object
Raises:
ValueError: If type format is invalid
ImportError: If rule module cannot be found
AttributeError: If rule class cannot be found in module
Examples:
>>> desc = RuleDescriptor(
... id="test_rule",
... type="window_setback@1.0",
... targets={},
... params={}
... )
>>> rule = load_rule(desc)
>>> isinstance(rule, Rule)
True
"""
rule_type = desc.type
# Check cache first
if rule_type in _RULE_CLASS_CACHE:
rule_class = _RULE_CLASS_CACHE[rule_type]
return rule_class()
# Parse type: 'name@version'
if '@' not in rule_type:
raise ValueError(
f"Invalid rule type '{rule_type}': must be in format 'name@version' "
f"(e.g., 'window_setback@1.0')"
)
name, version = rule_type.split('@', 1)
# Validate name (alphanumeric and underscores only)
if not re.match(r'^[a-z][a-z0-9_]*$', name):
raise ValueError(
f"Invalid rule name '{name}': must start with lowercase letter "
f"and contain only lowercase letters, numbers, and underscores"
)
# Convert snake_case to PascalCase for class name
# Example: 'window_setback' → 'WindowSetbackRule'
class_name = ''.join(word.capitalize() for word in name.split('_')) + 'Rule'
# Construct module path
module_path = f'apps.rules.impl.{name}'
# Try to import the module
try:
module = importlib.import_module(module_path)
except ImportError as e:
raise ImportError(
f"Cannot load rule type '{rule_type}': module '{module_path}' not found.\n"
f"Hint: Create file 'apps/rules/impl/{name}.py' with class '{class_name}'.\n"
f"Original error: {e}"
) from e
# Try to get the class from the module
try:
rule_class = getattr(module, class_name)
except AttributeError as e:
raise AttributeError(
f"Cannot load rule type '{rule_type}': class '{class_name}' not found in module '{module_path}'.\n"
f"Hint: Define 'class {class_name}(Rule):' in 'apps/rules/impl/{name}.py'.\n"
f"Available classes in module: {[name for name in dir(module) if not name.startswith('_')]}"
) from e
# Validate that it's a Rule subclass
if not issubclass(rule_class, Rule):
raise TypeError(
f"Class '{class_name}' in '{module_path}' is not a subclass of Rule. "
f"Ensure it inherits from apps.rules.rule_interface.Rule"
)
# Cache the class
_RULE_CLASS_CACHE[rule_type] = rule_class
# Instantiate and return
return rule_class()

122
apps/rules/rules_config.py Normal file
View File

@@ -0,0 +1,122 @@
"""
Rules Configuration Schema and Loader
Provides Pydantic models for validating rules.yaml configuration.
"""
from pathlib import Path
from typing import Any, Optional
import yaml
from pydantic import BaseModel, Field, field_validator
class Rule(BaseModel):
"""Single rule configuration"""
id: str = Field(..., description="Unique rule identifier")
name: Optional[str] = Field(None, description="Optional human-readable name")
type: str = Field(..., description="Rule type (e.g., 'window_setback@1.0')")
enabled: bool = Field(default=True, description="Whether this rule is enabled")
objects: dict[str, Any] = Field(default_factory=dict, description="Objects this rule monitors or controls")
params: dict[str, Any] = Field(default_factory=dict, description="Rule-specific parameters")
@field_validator('id')
@classmethod
def validate_id(cls, v: str) -> str:
if not v or not v.strip():
raise ValueError("Rule ID cannot be empty")
return v.strip()
@field_validator('type')
@classmethod
def validate_type(cls, v: str) -> str:
if not v or not v.strip():
raise ValueError("Rule type cannot be empty")
if '@' not in v:
raise ValueError(f"Rule type must include version (e.g., 'window_setback@1.0'), got: {v}")
return v.strip()
class RulesConfig(BaseModel):
"""Root configuration object"""
rules: list[Rule] = Field(..., description="List of all rules")
@field_validator('rules')
@classmethod
def validate_unique_ids(cls, rules: list[Rule]) -> list[Rule]:
"""Ensure all rule IDs are unique"""
ids = [rule.id for rule in rules]
duplicates = [id for id in ids if ids.count(id) > 1]
if duplicates:
raise ValueError(f"Duplicate rule IDs found: {set(duplicates)}")
return rules
def load_rules_config(config_path: str | Path = "config/rules.yaml") -> RulesConfig:
"""
Load and validate rules configuration from YAML file.
Args:
config_path: Path to rules.yaml file
Returns:
Validated RulesConfig object
Raises:
FileNotFoundError: If config file doesn't exist
ValueError: If YAML is invalid or validation fails
"""
config_path = Path(config_path)
if not config_path.exists():
raise FileNotFoundError(f"Rules configuration not found: {config_path}")
with open(config_path, 'r', encoding='utf-8') as f:
try:
data = yaml.safe_load(f)
except yaml.YAMLError as e:
raise ValueError(f"Invalid YAML in {config_path}: {e}") from e
if not data:
raise ValueError(f"Empty configuration file: {config_path}")
if 'rules' not in data:
raise ValueError(
f"Missing 'rules:' key in {config_path}. "
"Configuration must start with 'rules:' followed by a list of rule definitions."
)
try:
return RulesConfig(**data)
except Exception as e:
raise ValueError(f"Configuration validation failed: {e}") from e
def get_rule_by_id(config: RulesConfig, rule_id: str) -> Rule | None:
"""Get a specific rule by ID"""
for rule in config.rules:
if rule.id == rule_id:
return rule
return None
def get_rules_by_type(config: RulesConfig, rule_type: str) -> list[Rule]:
"""Get all rules of a specific type"""
return [rule for rule in config.rules if rule.type == rule_type]
if __name__ == "__main__":
# Test configuration loading
try:
config = load_rules_config()
print(f"✅ Loaded {len(config.rules)} rules:")
for rule in config.rules:
name = f" ({rule.name})" if rule.name else ""
enabled = "" if rule.enabled else ""
print(f" [{enabled}] {rule.id}{name}: {rule.type}")
if rule.objects:
obj_summary = ", ".join(f"{k}: {len(v) if isinstance(v, list) else v}"
for k, v in rule.objects.items())
print(f" Objects: {obj_summary}")
except Exception as e:
print(f"❌ Configuration error: {e}")

View File

@@ -59,13 +59,9 @@ docker run --rm -p 8010:8010 \
simulator:dev
```
**Mit Docker Network (optional):**
```bash
docker run --rm -p 8010:8010 \
--name simulator \
-e MQTT_BROKER=172.23.1.102 \
simulator:dev
```
**Note for finch/nerdctl users:**
- finch binds ports to `127.0.0.1` by default
- The web interface will be accessible at `http://127.0.0.1:8010`
#### Environment Variables

View File

@@ -37,17 +37,6 @@ docker build -t ui:dev -f apps/ui/Dockerfile .
#### Run Container
**Linux Server (empfohlen):**
```bash
# Mit Docker Network für Container-to-Container Kommunikation
docker run --rm -p 8002:8002 \
-e UI_PORT=8002 \
-e API_BASE=http://172.19.1.11:8001 \
-e BASE_PATH=/ \
ui:dev
```
**macOS mit finch/nerdctl:**
```bash
docker run --rm -p 8002:8002 \
--add-host=host.docker.internal:host-gateway \
@@ -57,11 +46,10 @@ docker run --rm -p 8002:8002 \
ui:dev
```
**Hinweise:**
- **Linux**: Verwende Docker Network und Service-Namen (`http://api:8001`)
- **macOS/finch**: Verwende `host.docker.internal` mit `--add-host` flag
- Die UI macht Server-Side API-Aufrufe beim Rendern der Seite
- Browser-seitige Realtime-Updates (SSE) gehen direkt vom Browser zur API
**Note for finch/nerdctl users:**
- finch binds ports to `127.0.0.1` by default (not `0.0.0.0`)
- Use `--add-host=host.docker.internal:host-gateway` to allow container-to-host communication
- Set `API_BASE=http://host.docker.internal:8001` to reach the API container
#### Environment Variables

View File

@@ -0,0 +1,13 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100">
<!-- Roof -->
<path d="M50 10 L90 45 L85 45 L85 50 L15 50 L15 45 L10 45 Z" fill="#667eea" stroke="#4c51bf" stroke-width="2" stroke-linejoin="round"/>
<!-- House body -->
<rect x="15" y="45" width="70" height="45" fill="#764ba2" stroke="#4c51bf" stroke-width="2"/>
<!-- Door -->
<rect x="35" y="60" width="15" height="30" fill="#4c51bf" rx="2"/>
<!-- Window -->
<rect x="60" y="60" width="20" height="15" fill="#fbbf24" stroke="#f59e0b" stroke-width="1"/>
<!-- Window panes -->
<line x1="70" y1="60" x2="70" y2="75" stroke="#f59e0b" stroke-width="1"/>
<line x1="60" y1="67.5" x2="80" y2="67.5" stroke="#f59e0b" stroke-width="1"/>
</svg>

After

Width:  |  Height:  |  Size: 721 B

File diff suppressed because it is too large Load Diff

View File

@@ -1,5 +1,4 @@
version: 1
mqtt:
broker: "172.16.2.16"
port: 1883
@@ -7,60 +6,756 @@ mqtt:
username: null
password: null
keepalive: 60
redis:
url: "redis://172.23.1.116:6379/8"
channel: "ui:updates"
devices:
- device_id: test_lampe_1
type: light
cap_version: "light@1.2.0"
technology: simulator
features:
power: true
brightness: true
topics:
set: "vendor/test_lampe_1/set"
state: "vendor/test_lampe_1/state"
- device_id: test_lampe_2
type: light
cap_version: "light@1.2.0"
technology: simulator
features:
power: true
topics:
set: "vendor/test_lampe_2/set"
state: "vendor/test_lampe_2/state"
- device_id: test_lampe_3
type: light
cap_version: "light@1.2.0"
technology: simulator
features:
power: true
brightness: true
topics:
set: "vendor/test_lampe_3/set"
state: "vendor/test_lampe_3/state"
- device_id: test_thermo_1
type: thermostat
cap_version: "thermostat@2.0.0"
technology: simulator
features:
mode: false
target: true
current: true
battery: true
topics:
set: "vendor/test_thermo_1/set"
state: "vendor/test_thermo_1/state"
- device_id: experiment_light_1
type: light
cap_version: "light@1.2.0"
technology: zigbee2mqtt
features:
power: true
brightness: true
topics:
set: "zigbee2mqtt/0xf0d1b80000195038/set"
state: "zigbee2mqtt/0xf0d1b80000195038"
- device_id: lampe_semeniere_wohnzimmer
type: relay
cap_version: "relay@1.0.0"
technology: zigbee2mqtt
features:
power: true
topics:
state: "zigbee2mqtt/0xf0d1b8000015480b"
set: "zigbee2mqtt/0xf0d1b8000015480b/set"
metadata:
friendly_name: "Lampe Semeniere Wohnzimmer"
ieee_address: "0xf0d1b8000015480b"
model: "AC10691"
vendor: "OSRAM"
- device_id: grosse_lampe_wohnzimmer
type: relay
cap_version: "relay@1.0.0"
technology: zigbee2mqtt
features:
power: true
topics:
state: "zigbee2mqtt/0xf0d1b80000151aca"
set: "zigbee2mqtt/0xf0d1b80000151aca/set"
metadata:
friendly_name: "grosse Lampe Wohnzimmer"
ieee_address: "0xf0d1b80000151aca"
model: "AC10691"
vendor: "OSRAM"
- device_id: lampe_naehtischchen_wohnzimmer
type: relay
cap_version: "relay@1.0.0"
technology: zigbee2mqtt
features:
power: true
topics:
state: "zigbee2mqtt/0x842e14fffee560ee"
set: "zigbee2mqtt/0x842e14fffee560ee/set"
metadata:
friendly_name: "Lampe Naehtischchen Wohnzimmer"
ieee_address: "0x842e14fffee560ee"
model: "HG06337"
vendor: "Lidl"
- device_id: kleine_lampe_rechts_esszimmer
type: relay
cap_version: "relay@1.0.0"
technology: zigbee2mqtt
features:
power: true
topics:
state: "zigbee2mqtt/0xf0d1b80000156645"
set: "zigbee2mqtt/0xf0d1b80000156645/set"
metadata:
friendly_name: "kleine Lampe rechts Esszimmer"
ieee_address: "0xf0d1b80000156645"
model: "AC10691"
vendor: "OSRAM"
- device_id: kleine_lampe_links_esszimmer
type: relay
cap_version: "relay@1.0.0"
technology: zigbee2mqtt
features:
power: true
topics:
state: "zigbee2mqtt/0xf0d1b80000153099"
set: "zigbee2mqtt/0xf0d1b80000153099/set"
metadata:
friendly_name: "kleine Lampe links Esszimmer"
ieee_address: "0xf0d1b80000153099"
model: "AC10691"
vendor: "OSRAM"
- device_id: leselampe_esszimmer
type: light
cap_version: "light@1.2.0"
technology: zigbee2mqtt
features:
power: true
brightness: true
topics:
state: "zigbee2mqtt/0xec1bbdfffe7b84f2"
set: "zigbee2mqtt/0xec1bbdfffe7b84f2/set"
metadata:
friendly_name: "Leselampe Esszimmer"
ieee_address: "0xec1bbdfffe7b84f2"
model: "LED1842G3"
vendor: "IKEA"
- device_id: medusalampe_schlafzimmer
type: relay
cap_version: "relay@1.0.0"
technology: zigbee2mqtt
features:
power: true
topics:
state: "zigbee2mqtt/0xf0d1b80000154c7c"
set: "zigbee2mqtt/0xf0d1b80000154c7c/set"
metadata:
friendly_name: "Medusa-Lampe Schlafzimmer"
ieee_address: "0xf0d1b80000154c7c"
model: "AC10691"
vendor: "OSRAM"
- device_id: sportlicht_am_fernseher_studierzimmer
type: light
cap_version: "light@1.2.0"
technology: zigbee2mqtt
features:
power: true
brightness: true
color_temperature: true
topics:
state: "zigbee2mqtt/0x842e14fffe76a23a"
set: "zigbee2mqtt/0x842e14fffe76a23a/set"
metadata:
friendly_name: "Sportlicht am Fernseher, Studierzimmer"
ieee_address: "0x842e14fffe76a23a"
model: "LED1733G7"
vendor: "IKEA"
- device_id: deckenlampe_schlafzimmer
type: light
cap_version: "light@1.2.0"
technology: zigbee2mqtt
features:
power: true
brightness: true
topics:
state: "zigbee2mqtt/0x0017880108a406a7"
set: "zigbee2mqtt/0x0017880108a406a7/set"
metadata:
friendly_name: "Deckenlampe Schlafzimmer"
ieee_address: "0x0017880108a406a7"
model: "8718699688882"
vendor: "Philips"
- device_id: bettlicht_wolfgang
type: light
cap_version: "light@1.2.0"
technology: zigbee2mqtt
features:
power: true
brightness: true
topics:
state: "zigbee2mqtt/0x00178801081570bf"
set: "zigbee2mqtt/0x00178801081570bf/set"
metadata:
friendly_name: "Bettlicht Wolfgang"
ieee_address: "0x00178801081570bf"
model: "9290020399"
vendor: "Philips"
- device_id: bettlicht_patty
type: light
cap_version: "light@1.2.0"
technology: zigbee2mqtt
features:
power: true
brightness: true
topics:
state: "zigbee2mqtt/0x0017880108158b32"
set: "zigbee2mqtt/0x0017880108158b32/set"
metadata:
friendly_name: "Bettlicht Patty"
ieee_address: "0x0017880108158b32"
model: "9290020399"
vendor: "Philips"
- device_id: schranklicht_hinten_patty
type: light
cap_version: "light@1.2.0"
technology: zigbee2mqtt
features:
power: true
brightness: true
topics:
state: "zigbee2mqtt/0x0017880106e29571"
set: "zigbee2mqtt/0x0017880106e29571/set"
metadata:
friendly_name: "Schranklicht hinten Patty"
ieee_address: "0x0017880106e29571"
model: "8718699673147"
vendor: "Philips"
- device_id: schranklicht_vorne_patty
type: relay
cap_version: "relay@1.0.0"
technology: zigbee2mqtt
features:
power: true
topics:
state: "zigbee2mqtt/0xf0d1b80000154cf5"
set: "zigbee2mqtt/0xf0d1b80000154cf5/set"
metadata:
friendly_name: "Schranklicht vorne Patty"
ieee_address: "0xf0d1b80000154cf5"
model: "AC10691"
vendor: "OSRAM"
- device_id: leselampe_patty
type: light
cap_version: "light@1.2.0"
technology: zigbee2mqtt
features:
power: true
brightness: true
topics:
state: "zigbee2mqtt/0x001788010600ec9d"
set: "zigbee2mqtt/0x001788010600ec9d/set"
metadata:
friendly_name: "Leselampe Patty"
ieee_address: "0x001788010600ec9d"
model: "8718699673147"
vendor: "Philips"
- device_id: deckenlampe_esszimmer
type: light
cap_version: "light@1.2.0"
technology: zigbee2mqtt
features:
power: true
brightness: true
topics:
state: "zigbee2mqtt/0x0017880108a03e45"
set: "zigbee2mqtt/0x0017880108a03e45/set"
metadata:
friendly_name: "Deckenlampe Esszimmer"
ieee_address: "0x0017880108a03e45"
model: "929002241201"
vendor: "Philips"
- device_id: standlampe_esszimmer
type: light
cap_version: "light@1.2.0"
technology: zigbee2mqtt
features:
power: true
brightness: true
color_temperature: true
topics:
state: "zigbee2mqtt/0xbc33acfffe21f547"
set: "zigbee2mqtt/0xbc33acfffe21f547/set"
metadata:
friendly_name: "Standlampe Esszimmer"
ieee_address: "0xbc33acfffe21f547"
model: "LED1732G11"
vendor: "IKEA"
- device_id: haustuer
type: light
cap_version: "light@1.2.0"
technology: zigbee2mqtt
features:
power: true
brightness: true
topics:
state: "zigbee2mqtt/0xec1bbdfffea6a3da"
set: "zigbee2mqtt/0xec1bbdfffea6a3da/set"
metadata:
friendly_name: "Haustür"
ieee_address: "0xec1bbdfffea6a3da"
model: "LED1842G3"
vendor: "IKEA"
- device_id: deckenlampe_flur_oben
type: light
cap_version: "light@1.2.0"
technology: zigbee2mqtt
features:
power: true
brightness: true
color_temperature: true
topics:
state: "zigbee2mqtt/0x001788010d2123a7"
set: "zigbee2mqtt/0x001788010d2123a7/set"
metadata:
friendly_name: "Deckenlampe Flur oben"
ieee_address: "0x001788010d2123a7"
model: "929003099001"
vendor: "Philips"
- device_id: kueche_deckenlampe
type: light
cap_version: "light@1.2.0"
technology: zigbee2mqtt
features:
power: true
brightness: true
topics:
state: "zigbee2mqtt/0x001788010d2c40c4"
set: "zigbee2mqtt/0x001788010d2c40c4/set"
metadata:
friendly_name: "Küche Deckenlampe"
ieee_address: "0x001788010d2c40c4"
model: "929002469202"
vendor: "Philips"
- device_id: sportlicht_tisch
type: light
cap_version: "light@1.2.0"
technology: zigbee2mqtt
features:
power: true
brightness: true
topics:
state: "zigbee2mqtt/0xf0d1b8be2409f31b"
set: "zigbee2mqtt/0xf0d1b8be2409f31b/set"
metadata:
friendly_name: "Sportlicht Tisch"
ieee_address: "0xf0d1b8be2409f31b"
model: "4058075729063"
vendor: "LEDVANCE"
- device_id: sportlicht_regal
type: light
cap_version: "light@1.2.0"
technology: zigbee2mqtt
features:
power: true
brightness: true
topics:
state: "zigbee2mqtt/0xf0d1b8be2409f569"
set: "zigbee2mqtt/0xf0d1b8be2409f569/set"
metadata:
friendly_name: "Sportlicht Regal"
ieee_address: "0xf0d1b8be2409f569"
model: "4058075729063"
vendor: "LEDVANCE"
- device_id: licht_flur_oben_am_spiegel
type: light
cap_version: "light@1.2.0"
technology: zigbee2mqtt
features:
power: true
brightness: true
color_temperature: true
topics:
state: "zigbee2mqtt/0x842e14fffefe4ba4"
set: "zigbee2mqtt/0x842e14fffefe4ba4/set"
metadata:
friendly_name: "Licht Flur oben am Spiegel"
ieee_address: "0x842e14fffefe4ba4"
model: "LED1732G11"
vendor: "IKEA"
- device_id: experimentlabtest
type: light
cap_version: "light@1.2.0"
technology: zigbee2mqtt
features:
power: true
brightness: true
topics:
state: "zigbee2mqtt/0xf0d1b80000195038"
set: "zigbee2mqtt/0xf0d1b80000195038/set"
metadata:
friendly_name: "ExperimentLabTest"
ieee_address: "0xf0d1b80000195038"
model: "4058075208421"
vendor: "LEDVANCE"
- device_id: thermostat_wolfgang
type: thermostat
cap_version: "thermostat@1.0.0"
technology: zigbee2mqtt
features:
heating: true
temperature_range:
- 5
- 30
temperature_step: 0.5
topics:
state: "zigbee2mqtt/0x540f57fffe7e3cfe"
set: "zigbee2mqtt/0x540f57fffe7e3cfe/set"
metadata:
friendly_name: "Wolfgang"
ieee_address: "0x540f57fffe7e3cfe"
model: "GS361A-H04"
vendor: "Siterwell"
- device_id: thermostat_kueche
type: thermostat
cap_version: "thermostat@1.0.0"
technology: zigbee2mqtt
features:
heating: true
temperature_range:
- 5
- 30
temperature_step: 0.5
topics:
state: "zigbee2mqtt/0x94deb8fffe2e5c06"
set: "zigbee2mqtt/0x94deb8fffe2e5c06/set"
metadata:
friendly_name: "Kueche"
ieee_address: "0x94deb8fffe2e5c06"
model: "GS361A-H04"
vendor: "Siterwell"
- device_id: thermostat_schlafzimmer
type: thermostat
cap_version: "thermostat@1.0.0"
technology: max
features:
mode: true
target: true
current: false
topics:
set: "homegear/instance1/set/42/1/SET_TEMPERATURE"
state: "homegear/instance1/plain/42/1/SET_TEMPERATURE"
metadata:
friendly_name: "Thermostat Schlafzimmer"
location: "Schlafzimmer"
vendor: "eQ-3"
model: "MAX! Thermostat"
peer_id: "42"
channel: "1"
- device_id: thermostat_esszimmer
type: thermostat
cap_version: "thermostat@1.0.0"
technology: max
features:
mode: true
target: true
current: false
topics:
set: "homegear/instance1/set/45/1/SET_TEMPERATURE"
state: "homegear/instance1/plain/45/1/SET_TEMPERATURE"
metadata:
friendly_name: "Thermostat Esszimmer"
location: "Esszimmer"
vendor: "eQ-3"
model: "MAX! Thermostat"
peer_id: "45"
channel: "1"
- device_id: thermostat_wohnzimmer
type: thermostat
cap_version: "thermostat@1.0.0"
technology: max
features:
mode: true
target: true
current: false
topics:
set: "homegear/instance1/set/46/1/SET_TEMPERATURE"
state: "homegear/instance1/plain/46/1/SET_TEMPERATURE"
metadata:
friendly_name: "Thermostat Wohnzimmer"
location: "Wohnzimmer"
vendor: "eQ-3"
model: "MAX! Thermostat"
peer_id: "46"
channel: "1"
- device_id: thermostat_patty
type: thermostat
cap_version: "thermostat@1.0.0"
technology: max
features:
mode: true
target: true
current: false
topics:
set: "homegear/instance1/set/39/1/SET_TEMPERATURE"
state: "homegear/instance1/plain/39/1/SET_TEMPERATURE"
metadata:
friendly_name: "Thermostat Patty"
location: "Arbeitszimmer Patty"
vendor: "eQ-3"
model: "MAX! Thermostat"
peer_id: "39"
channel: "1"
- device_id: thermostat_bad_oben
type: thermostat
cap_version: "thermostat@1.0.0"
technology: max
features:
mode: true
target: true
current: false
topics:
set: "homegear/instance1/set/41/1/SET_TEMPERATURE"
state: "homegear/instance1/plain/41/1/SET_TEMPERATURE"
metadata:
friendly_name: "Thermostat Bad Oben"
location: "Bad Oben"
vendor: "eQ-3"
model: "MAX! Thermostat"
peer_id: "41"
channel: "1"
- device_id: thermostat_bad_unten
type: thermostat
cap_version: "thermostat@1.0.0"
technology: max
features:
mode: true
target: true
current: false
topics:
set: "homegear/instance1/set/48/1/SET_TEMPERATURE"
state: "homegear/instance1/plain/48/1/SET_TEMPERATURE"
metadata:
friendly_name: "Thermostat Bad Unten"
location: "Bad Unten"
vendor: "eQ-3"
model: "MAX! Thermostat"
peer_id: "48"
channel: "1"
- device_id: sterne_wohnzimmer
type: relay
cap_version: "relay@1.0.0"
technology: zigbee2mqtt
features:
power: true
topics:
state: "zigbee2mqtt/0xf0d1b80000155fc2"
set: "zigbee2mqtt/0xf0d1b80000155fc2/set"
metadata:
friendly_name: "Sterne Wohnzimmer"
ieee_address: "0xf0d1b80000155fc2"
model: "AC10691"
vendor: "OSRAM"
- device_id: kontakt_schlafzimmer_strasse
type: contact
name: Kontakt Schlafzimmer Straße
cap_version: contact_sensor@1.0.0
technology: max
topics:
state: homegear/instance1/plain/52/1/STATE
features: {}
- device_id: kontakt_esszimmer_strasse_rechts
type: contact
name: Kontakt Esszimmer Straße rechts
cap_version: contact_sensor@1.0.0
technology: max
topics:
state: homegear/instance1/plain/26/1/STATE
features: {}
- device_id: kontakt_esszimmer_strasse_links
type: contact
name: Kontakt Esszimmer Straße links
cap_version: contact_sensor@1.0.0
technology: max
topics:
state: homegear/instance1/plain/27/1/STATE
features: {}
- device_id: kontakt_wohnzimmer_garten_rechts
type: contact
name: Kontakt Wohnzimmer Garten rechts
cap_version: contact_sensor@1.0.0
technology: max
topics:
state: homegear/instance1/plain/28/1/STATE
features: {}
- device_id: kontakt_wohnzimmer_garten_links
type: contact
name: Kontakt Wohnzimmer Garten links
cap_version: contact_sensor@1.0.0
technology: max
topics:
state: homegear/instance1/plain/29/1/STATE
features: {}
- device_id: kontakt_kueche_garten_fenster
type: contact
name: Kontakt Küche Garten Fenster
cap_version: contact_sensor@1.0.0
technology: zigbee2mqtt
topics:
state: zigbee2mqtt/0x00158d008b332785
features: {}
- device_id: kontakt_kueche_garten_tuer
type: contact
name: Kontakt Küche Garten Tür
cap_version: contact_sensor@1.0.0
technology: zigbee2mqtt
topics:
state: zigbee2mqtt/0x00158d008b332788
features: {}
- device_id: kontakt_kueche_strasse_rechts
type: contact
name: Kontakt Küche Straße rechts
cap_version: contact_sensor@1.0.0
technology: zigbee2mqtt
topics:
state: zigbee2mqtt/0x00158d008b151803
features: {}
- device_id: kontakt_kueche_strasse_links
type: contact
name: Kontakt Küche Straße links
cap_version: contact_sensor@1.0.0
technology: zigbee2mqtt
topics:
state: zigbee2mqtt/0x00158d008b331d0b
features: {}
- device_id: kontakt_patty_garten_rechts
type: contact
name: Kontakt Patty Garten rechts
cap_version: contact_sensor@1.0.0
technology: max
topics:
state: homegear/instance1/plain/18/1/STATE
features: {}
- device_id: kontakt_patty_garten_links
type: contact
name: Kontakt Patty Garten links
cap_version: contact_sensor@1.0.0
technology: max
topics:
state: homegear/instance1/plain/22/1/STATE
features: {}
- device_id: kontakt_patty_strasse
type: contact
name: Kontakt Patty Straße
cap_version: contact_sensor@1.0.0
technology: zigbee2mqtt
topics:
state: zigbee2mqtt/0x00158d000af457cf
features: {}
- device_id: kontakt_wolfgang_garten
type: contact
name: Kontakt Wolfgang Garten
cap_version: contact_sensor@1.0.0
technology: zigbee2mqtt
topics:
state: zigbee2mqtt/0x00158d008b3328da
features: {}
- device_id: kontakt_bad_oben_strasse
type: contact
name: Kontakt Bad Oben Straße
cap_version: contact_sensor@1.0.0
technology: zigbee2mqtt
topics:
state: zigbee2mqtt/0x00158d008b333aec
features: {}
- device_id: kontakt_bad_unten_strasse
type: contact
name: Kontakt Bad Unten Straße
cap_version: contact_sensor@1.0.0
technology: max
topics:
state: homegear/instance1/plain/44/1/STATE
features: {}
- device_id: sensor_schlafzimmer
type: temp_humidity_sensor
name: Temperatur & Luftfeuchte
cap_version: temp_humidity_sensor@1.0.0
technology: zigbee2mqtt
topics:
state: zigbee2mqtt/0x00158d00043292dc
features: {}
- device_id: sensor_wohnzimmer
type: temp_humidity_sensor
name: Temperatur & Luftfeuchte
cap_version: temp_humidity_sensor@1.0.0
technology: zigbee2mqtt
topics:
state: zigbee2mqtt/0x00158d0008975707
features: {}
- device_id: sensor_kueche
type: temp_humidity_sensor
name: Temperatur & Luftfeuchte
cap_version: temp_humidity_sensor@1.0.0
technology: zigbee2mqtt
topics:
state: zigbee2mqtt/0x00158d00083299bb
features: {}
- device_id: sensor_arbeitszimmer_patty
type: temp_humidity_sensor
name: Temperatur & Luftfeuchte
cap_version: temp_humidity_sensor@1.0.0
technology: zigbee2mqtt
topics:
state: zigbee2mqtt/0x00158d0003f052b7
features: {}
- device_id: sensor_arbeitszimmer_wolfgang
type: temp_humidity_sensor
name: Temperatur & Luftfeuchte
cap_version: temp_humidity_sensor@1.0.0
technology: zigbee2mqtt
topics:
state: zigbee2mqtt/0x00158d000543fb99
features: {}
- device_id: sensor_bad_oben
type: temp_humidity_sensor
name: Temperatur & Luftfeuchte
cap_version: temp_humidity_sensor@1.0.0
technology: zigbee2mqtt
topics:
state: zigbee2mqtt/0x00158d00093e8987
features: {}
- device_id: sensor_bad_unten
type: temp_humidity_sensor
name: Temperatur & Luftfeuchte
cap_version: temp_humidity_sensor@1.0.0
technology: zigbee2mqtt
topics:
state: zigbee2mqtt/0x00158d00093e662a
features: {}
- device_id: sensor_flur
type: temp_humidity_sensor
name: Temperatur & Luftfeuchte
cap_version: temp_humidity_sensor@1.0.0
technology: zigbee2mqtt
topics:
state: zigbee2mqtt/0x00158d000836ccc6
features: {}
- device_id: sensor_waschkueche
type: temp_humidity_sensor
name: Temperatur & Luftfeuchte
cap_version: temp_humidity_sensor@1.0.0
technology: zigbee2mqtt
topics:
state: zigbee2mqtt/0x00158d000449f3bc
features: {}
- device_id: sensor_sportzimmer
type: temp_humidity_sensor
name: Temperatur & Luftfeuchte
cap_version: temp_humidity_sensor@1.0.0
technology: zigbee2mqtt
topics:
state: zigbee2mqtt/0x00158d0009421422
features: {}
- device_id: licht_spuele_kueche
type: relay
cap_version: "relay@1.0.0"
technology: shelly
features:
power: true
topics:
set: "shellies/LightKitchenSink/relay/0/command"
state: "shellies/LightKitchenSink/relay/0"
- device_id: licht_schrank_esszimmer
type: relay
cap_version: "relay@1.0.0"
technology: shelly
features:
power: true
topics:
set: "shellies/schrankesszimmer/relay/0/command"
state: "shellies/schrankesszimmer/relay/0"
- device_id: licht_regal_wohnzimmer
type: relay
cap_version: "relay@1.0.0"
technology: shelly
features:
power: true
topics:
set: "shellies/wohnzimmer-regal/relay/0/command"
state: "shellies/wohnzimmer-regal/relay/0"
- device_id: licht_flur_schrank
type: relay
cap_version: "relay@1.0.0"
technology: shelly
features:
power: true
topics:
set: "shellies/schrankflur/relay/0/command"
state: "shellies/schrankflur/relay/0"
- device_id: licht_terasse
type: relay
cap_version: "relay@1.0.0"
technology: shelly
features:
power: true
topics:
set: "shellies/lichtterasse/relay/0/command"
state: "shellies/lichtterasse/relay/0"

View File

@@ -0,0 +1,66 @@
version: 1
mqtt:
broker: "172.16.2.16"
port: 1883
client_id: "home-automation-abstraction"
username: null
password: null
keepalive: 60
redis:
url: "redis://172.23.1.116:6379/8"
channel: "ui:updates"
devices:
- device_id: test_lampe_1
type: light
cap_version: "light@1.2.0"
technology: simulator
features:
power: true
brightness: true
topics:
set: "vendor/test_lampe_1/set"
state: "vendor/test_lampe_1/state"
- device_id: test_lampe_2
type: light
cap_version: "light@1.2.0"
technology: simulator
features:
power: true
topics:
set: "vendor/test_lampe_2/set"
state: "vendor/test_lampe_2/state"
- device_id: test_lampe_3
type: light
cap_version: "light@1.2.0"
technology: simulator
features:
power: true
brightness: true
topics:
set: "vendor/test_lampe_3/set"
state: "vendor/test_lampe_3/state"
- device_id: test_thermo_1
type: thermostat
cap_version: "thermostat@2.0.0"
technology: simulator
features:
mode: false
target: true
current: true
battery: true
topics:
set: "vendor/test_thermo_1/set"
state: "vendor/test_thermo_1/state"
- device_id: experiment_light_1
type: light
cap_version: "light@1.2.0"
technology: zigbee2mqtt
features:
power: true
brightness: true
topics:
set: "zigbee2mqtt/0xf0d1b80000195038/set"
state: "zigbee2mqtt/0xf0d1b80000195038"

View File

@@ -0,0 +1,66 @@
version: 1
mqtt:
broker: "172.16.2.16"
port: 1883
client_id: "home-automation-abstraction"
username: null
password: null
keepalive: 60
redis:
url: "redis://172.23.1.116:6379/8"
channel: "ui:updates"
devices:
- device_id: test_lampe_1
type: light
cap_version: "light@1.2.0"
technology: simulator
features:
power: true
brightness: true
topics:
set: "vendor/test_lampe_1/set"
state: "vendor/test_lampe_1/state"
- device_id: test_lampe_2
type: light
cap_version: "light@1.2.0"
technology: simulator
features:
power: true
topics:
set: "vendor/test_lampe_2/set"
state: "vendor/test_lampe_2/state"
- device_id: test_lampe_3
type: light
cap_version: "light@1.2.0"
technology: simulator
features:
power: true
brightness: true
topics:
set: "vendor/test_lampe_3/set"
state: "vendor/test_lampe_3/state"
- device_id: test_thermo_1
type: thermostat
cap_version: "thermostat@2.0.0"
technology: simulator
features:
mode: false
target: true
current: true
battery: true
topics:
set: "vendor/test_thermo_1/set"
state: "vendor/test_thermo_1/state"
- device_id: experiment_light_1
type: light
cap_version: "light@1.2.0"
technology: zigbee2mqtt
features:
power: true
brightness: true
topics:
set: "zigbee2mqtt/0xf0d1b80000195038/set"
state: "zigbee2mqtt/0xf0d1b80000195038"

36
config/groups.yaml Normal file
View File

@@ -0,0 +1,36 @@
version: 1
groups:
- id: "kueche_lichter"
name: "Küche alle Lampen"
selector:
type: "light"
room: "Küche"
capabilities:
power: true
brightness: true
- id: "alles_lichter"
name: "Alle Lichter"
selector:
type: "light"
capabilities:
power: true
- id: "schlafzimmer_lichter"
name: "Schlafzimmer alle Lampen"
selector:
type: "light"
room: "Schlafzimmer"
capabilities:
power: true
brightness: true
- id: "schlafzimmer_schlummer_licht"
name: "Schlafzimmer Schlummerlicht"
device_ids:
- bettlicht_patty
- bettlicht_wolfgang
- medusalampe_schlafzimmer
capabilities:
power: true
brightness: true

View File

@@ -1,35 +1,274 @@
# UI Layout Configuration
# Defines rooms and device tiles for the home automation UI
rooms:
- name: Wohnzimmer
devices:
- device_id: test_lampe_2
title: Deckenlampe
icon: "💡"
rank: 5
- device_id: test_lampe_1
title: Stehlampe
icon: "🔆"
rank: 10
- device_id: test_thermo_1
title: Thermostat
icon: "🌡️"
rank: 15
- name: Schlafzimmer
devices:
- device_id: test_lampe_3
title: Nachttischlampe
icon: "🛏️"
rank: 10
- name: Lab
devices:
- device_id: experiment_light_1
title: Experimentierlampe
icon: "💡"
rank: 10
- name: Schlafzimmer
devices:
- device_id: bettlicht_patty
title: Bettlicht Patty
icon: 🛏️
rank: 10
- device_id: bettlicht_wolfgang
title: Bettlicht Wolfgang
icon: 🛏️
rank: 20
- device_id: deckenlampe_schlafzimmer
title: Deckenlampe Schlafzimmer
icon: 💡
rank: 30
- device_id: medusalampe_schlafzimmer
title: Medusa-Lampe Schlafzimmer
icon: 💡
rank: 40
- device_id: thermostat_schlafzimmer
title: Thermostat Schlafzimmer
icon: 🌡️
rank: 45
- device_id: kontakt_schlafzimmer_strasse
title: Kontakt Straße
icon: 🪟
rank: 46
- device_id: sensor_schlafzimmer
title: Temperatur & Luftfeuchte
icon: 🌡️
rank: 47
- name: Esszimmer
devices:
- device_id: deckenlampe_esszimmer
title: Deckenlampe Esszimmer
icon: 💡
rank: 50
- device_id: leselampe_esszimmer
title: Leselampe Esszimmer
icon: 💡
rank: 60
- device_id: standlampe_esszimmer
title: Standlampe Esszimmer
icon: 💡
rank: 70
- device_id: kleine_lampe_links_esszimmer
title: kleine Lampe links Esszimmer
icon: 💡
rank: 80
- device_id: kleine_lampe_rechts_esszimmer
title: kleine Lampe rechts Esszimmer
icon: 💡
rank: 90
- device_id: licht_schrank_esszimmer
title: Schranklicht Esszimmer
icon: 💡
rank: 92
- device_id: thermostat_esszimmer
title: Thermostat Esszimmer
icon: 🌡️
rank: 95
- device_id: kontakt_esszimmer_strasse_rechts
title: Kontakt Straße rechtsFtest
icon: 🪟
rank: 96
- device_id: kontakt_esszimmer_strasse_links
title: Kontakt Straße links
icon: 🪟
rank: 97
- name: Wohnzimmer
devices:
- device_id: lampe_naehtischchen_wohnzimmer
title: Lampe Naehtischchen Wohnzimmer
icon: 💡
rank: 100
- device_id: lampe_semeniere_wohnzimmer
title: Lampe Semeniere Wohnzimmer
icon: 💡
rank: 110
- device_id: sterne_wohnzimmer
title: Sterne Wohnzimmer
icon: 💡
rank: 120
- device_id: grosse_lampe_wohnzimmer
title: grosse Lampe Wohnzimmer
icon: 💡
rank: 130
- device_id: licht_regal_wohnzimmer
title: Regallicht Wohnzimmer
icon: 💡
rank: 132
- device_id: thermostat_wohnzimmer
title: Thermostat Wohnzimmer
icon: 🌡️
rank: 135
- device_id: kontakt_wohnzimmer_garten_rechts
title: Kontakt Garten rechts
icon: 🪟
rank: 136
- device_id: kontakt_wohnzimmer_garten_links
title: Kontakt Garten links
icon: 🪟
rank: 137
- device_id: sensor_wohnzimmer
title: Temperatur & Luftfeuchte
icon: 🌡️
rank: 138
- name: Küche
devices:
- device_id: kueche_deckenlampe
title: Küche Deckenlampe
icon: 💡
rank: 140
- device_id: licht_spuele_kueche
title: Küche Spüle
icon: 💡
rank: 142
- device_id: thermostat_kueche
title: Kueche
icon: 🌡️
rank: 150
- device_id: kontakt_kueche_garten_fenster
title: Kontakt Garten Fenster
icon: 🪟
rank: 151
- device_id: kontakt_kueche_garten_tuer
title: Kontakt Garten Tür
icon: 🪟
rank: 152
- device_id: kontakt_kueche_strasse_rechts
title: Kontakt Straße rechts
icon: 🪟
rank: 153
- device_id: kontakt_kueche_strasse_links
title: Kontakt Straße links
icon: 🪟
rank: 154
- device_id: sensor_kueche
title: Temperatur & Luftfeuchte
icon: 🌡️
rank: 155
- name: Arbeitszimmer Patty
devices:
- device_id: leselampe_patty
title: Leselampe Patty
icon: 💡
rank: 160
- device_id: schranklicht_hinten_patty
title: Schranklicht hinten Patty
icon: 💡
rank: 170
- device_id: schranklicht_vorne_patty
title: Schranklicht vorne Patty
icon: 💡
rank: 180
- device_id: thermostat_patty
title: Thermostat Patty
icon: 🌡️
rank: 185
- device_id: kontakt_patty_garten_rechts
title: Kontakt Garten rechts
icon: 🪟
rank: 186
- device_id: kontakt_patty_garten_links
title: Kontakt Garten links
icon: 🪟
rank: 187
- device_id: kontakt_patty_strasse
title: Kontakt Straße
icon: 🪟
rank: 188
- device_id: sensor_arbeitszimmer_patty
title: Temperatur & Luftfeuchte
icon: 🌡️
rank: 189
- name: Arbeitszimmer Wolfgang
devices:
- device_id: thermostat_wolfgang
title: Wolfgang
icon: 🌡️
rank: 190
- device_id: experimentlabtest
title: ExperimentLabTest
icon: 💡
rank: 200
- device_id: kontakt_wolfgang_garten
title: Kontakt Garten
icon: 🪟
rank: 201
- device_id: sensor_arbeitszimmer_wolfgang
title: Temperatur & Luftfeuchte
icon: 🌡️
rank: 202
- name: Flur
devices:
- device_id: deckenlampe_flur_oben
title: Deckenlampe Flur oben
icon: 💡
rank: 210
- device_id: haustuer
title: Haustür
icon: 💡
rank: 220
- device_id: licht_flur_schrank
title: Schranklicht Flur
icon: 💡
rank: 222
- device_id: licht_flur_oben_am_spiegel
title: Licht Flur oben am Spiegel
icon: 💡
rank: 230
- device_id: sensor_flur
title: Temperatur & Luftfeuchte
icon: 🌡️
rank: 235
- name: Sportzimmer
devices:
- device_id: sportlicht_regal
title: Sportlicht Regal
icon: 🏃
rank: 240
- device_id: sportlicht_tisch
title: Sportlicht Tisch
icon: 🏃
rank: 250
- device_id: sportlicht_am_fernseher_studierzimmer
title: Sportlicht am Fernseher, Studierzimmer
icon: 🏃
rank: 260
- device_id: sensor_sportzimmer
title: Temperatur & Luftfeuchte
icon: 🌡️
rank: 265
- name: Bad Oben
devices:
- device_id: thermostat_bad_oben
title: Thermostat Bad Oben
icon: 🌡️
rank: 270
- device_id: kontakt_bad_oben_strasse
title: Kontakt Straße
icon: 🪟
rank: 271
- device_id: sensor_bad_oben
title: Temperatur & Luftfeuchte
icon: 🌡️
rank: 272
- name: Bad Unten
devices:
- device_id: thermostat_bad_unten
title: Thermostat Bad Unten
icon: 🌡️
rank: 280
- device_id: kontakt_bad_unten_strasse
title: Kontakt Straße
icon: 🪟
rank: 281
- device_id: sensor_bad_unten
title: Temperatur & Luftfeuchte
icon: 🌡️
rank: 282
- name: Waschküche
devices:
- device_id: sensor_waschkueche
title: Temperatur & Luftfeuchte
icon: 🌡️
rank: 290
- name: Outdoor
devices:
- device_id: licht_terasse
title: Licht Terasse
icon: 💡
rank: 290

View File

@@ -0,0 +1,35 @@
# UI Layout Configuration
# Defines rooms and device tiles for the home automation UI
rooms:
- name: Wohnzimmer
devices:
- device_id: test_lampe_2
title: Deckenlampe
icon: "💡"
rank: 5
- device_id: test_lampe_1
title: Stehlampe
icon: "🔆"
rank: 10
- device_id: test_thermo_1
title: Thermostat
icon: "🌡️"
rank: 15
- name: Schlafzimmer
devices:
- device_id: test_lampe_3
title: Nachttischlampe
icon: "🛏️"
rank: 10
- name: Lab
devices:
- device_id: experiment_light_1
title: Experimentierlampe
icon: "💡"
rank: 10

View File

@@ -0,0 +1,23 @@
# MAX! Thermostats - Room Assignment
#
# Extracted from layout.yaml
# Format: Room Name | Device ID (if thermostat exists)
#
Schlafzimmer
42
Esszimmer
45
Wohnzimmer
46
Arbeitszimmer Patty
39
Bad Oben
41
Bad Unten
48

31
config/raeume.txt Normal file
View File

@@ -0,0 +1,31 @@
Schlafzimmer
0x00158d00043292dc
Esszimmer
Wohnzimmer
0x00158d0008975707
Küche
0x00158d00083299bb
Arbeitszimmer Patty
0x00158d0003f052b7
Arbeitszimmer Wolfgang
0x00158d000543fb99
Bad Oben
0x00158d00093e8987
Bad Unten
0x00158d00093e662a
Flur
0x00158d000836ccc6
Waschküche
0x00158d000449f3bc
Sportzimmer
0x00158d0009421422

94
config/rules.yaml Normal file
View File

@@ -0,0 +1,94 @@
# Rules Configuration
# Auto-generated from devices.yaml
rules:
- id: window_setback_esszimmer
enabled: false
name: Fensterabsenkung Esszimmer
type: window_setback@1.0
objects:
contacts:
- kontakt_esszimmer_strasse_links
- kontakt_esszimmer_strasse_rechts
thermostats:
- thermostat_esszimmer
params:
eco_target: 16.0
open_min_secs: 20
close_min_secs: 20
previous_target_ttl_secs: 86400
- id: window_setback_kueche
enabled: false
name: Fensterabsenkung Küche
type: window_setback@1.0
objects:
contacts:
- kontakt_kueche_garten_fenster
- kontakt_kueche_garten_tuer
- kontakt_kueche_strasse_links
- kontakt_kueche_strasse_rechts
thermostats:
- thermostat_kueche
params:
eco_target: 16.0
open_min_secs: 20
close_min_secs: 20
previous_target_ttl_secs: 86400
- id: window_setback_patty
enabled: false
name: Fensterabsenkung Arbeitszimmer Patty
type: window_setback@1.0
objects:
contacts:
- kontakt_patty_garten_links
- kontakt_patty_garten_rechts
- kontakt_patty_strasse
thermostats:
- thermostat_patty
params:
eco_target: 16.0
open_min_secs: 20
close_min_secs: 20
previous_target_ttl_secs: 86400
- id: window_setback_schlafzimmer
enabled: false
name: Fensterabsenkung Schlafzimmer
type: window_setback@1.0
objects:
contacts:
- kontakt_schlafzimmer_strasse
thermostats:
- thermostat_schlafzimmer
params:
eco_target: 16.0
open_min_secs: 20
close_min_secs: 20
previous_target_ttl_secs: 86400
- id: window_setback_wohnzimmer
enabled: false
name: Fensterabsenkung Wohnzimmer
type: window_setback@1.0
objects:
contacts:
- kontakt_wohnzimmer_garten_links
- kontakt_wohnzimmer_garten_rechts
thermostats:
- thermostat_wohnzimmer
params:
eco_target: 16.0
open_min_secs: 20
close_min_secs: 20
previous_target_ttl_secs: 86400
- id: window_setback_wolfgang
enabled: true
name: Fensterabsenkung Arbeitszimmer Wolfgang
type: window_setback@1.0
objects:
contacts:
- kontakt_wolfgang_garten
thermostats:
- thermostat_wolfgang
params:
eco_target: 16.0
open_min_secs: 20
close_min_secs: 20

24
config/scenes.yaml Normal file
View File

@@ -0,0 +1,24 @@
version: 1
scenes:
- id: "alles_aus"
name: "Alles aus"
steps:
- selector: { type: "light" }
action:
type: "light"
payload: { power: "off" }
- selector: { type: "relay" }
action:
type: "relay"
payload: { power: "off" }
- id: "kueche_gemuetlich"
name: "Küche gemütlich"
steps:
- group_id: "kueche_lichter"
action:
type: "light"
payload:
power: "on"
brightness: 35

62
docker-compose.yaml Normal file
View File

@@ -0,0 +1,62 @@
version: "3.9"
x-environment: &default-env
MQTT_BROKER: "172.23.1.102"
MQTT_PORT: 1883
REDIS_HOST: "172.23.1.116"
REDIS_PORT: 6379
REDIS_DB: 8
services:
ui:
build:
context: .
dockerfile: apps/ui/Dockerfile
container_name: ui
environment:
UI_PORT: 8002
API_BASE: "http://172.19.1.11:8001"
BASE_PATH: "/"
ports:
- "8002:8002"
depends_on:
- api
api:
build:
context: .
dockerfile: apps/api/Dockerfile
container_name: api
environment:
<<: *default-env
REDIS_CHANNEL: "ui:updates"
volumes:
- ./config:/app/config:ro
ports:
- "8001:8001"
depends_on:
- abstraction
abstraction:
build:
context: .
dockerfile: apps/abstraction/Dockerfile
container_name: abstraction
environment:
<<: *default-env
volumes:
- ./config:/app/config:ro
rules:
build:
context: .
dockerfile: apps/rules/Dockerfile
container_name: rules
environment:
<<: *default-env
RULES_CONFIG: "/app/config/rules.yaml"
volumes:
- ./config:/app/config:ro
depends_on:
- abstraction

View File

@@ -1,15 +0,0 @@
version: '3.8'
services:
# Placeholder for future services
# Example:
# api:
# build:
# context: ..
# dockerfile: apps/api/Dockerfile
# ports:
# - "8000:8000"
placeholder:
image: alpine:latest
command: echo "Docker Compose placeholder - add your services here"

View File

@@ -4,15 +4,56 @@ from packages.home_capabilities.light import CAP_VERSION as LIGHT_VERSION
from packages.home_capabilities.light import LightState
from packages.home_capabilities.thermostat import CAP_VERSION as THERMOSTAT_VERSION
from packages.home_capabilities.thermostat import ThermostatState
from packages.home_capabilities.layout import DeviceTile, Room, UiLayout, load_layout
from packages.home_capabilities.contact_sensor import CAP_VERSION as CONTACT_SENSOR_VERSION
from packages.home_capabilities.contact_sensor import ContactState
from packages.home_capabilities.temp_humidity_sensor import CAP_VERSION as TEMP_HUMIDITY_SENSOR_VERSION
from packages.home_capabilities.temp_humidity_sensor import TempHumidityState
from packages.home_capabilities.relay import CAP_VERSION as RELAY_VERSION
from packages.home_capabilities.relay import RelayState
from packages.home_capabilities.layout import (
DeviceTile,
Room,
UiLayout,
load_layout,
)
from packages.home_capabilities.groups_scenes import (
GroupConfig,
GroupsConfigRoot,
GroupSelector,
SceneConfig,
ScenesConfigRoot,
SceneSelector,
SceneStep,
get_group_by_id,
get_scene_by_id,
load_groups,
load_scenes,
)
__all__ = [
"LightState",
"LIGHT_VERSION",
"ThermostatState",
"THERMOSTAT_VERSION",
"ContactState",
"CONTACT_SENSOR_VERSION",
"TempHumidityState",
"TEMP_HUMIDITY_SENSOR_VERSION",
"RelayState",
"RELAY_VERSION",
"DeviceTile",
"Room",
"UiLayout",
"load_layout",
"GroupConfig",
"GroupsConfigRoot",
"GroupSelector",
"SceneConfig",
"ScenesConfigRoot",
"SceneSelector",
"SceneStep",
"get_group_by_id",
"get_scene_by_id",
"load_groups",
"load_scenes",
]

View File

@@ -0,0 +1,96 @@
"""Contact Sensor Capability - Fensterkontakt (read-only).
This module defines the ContactState model for door/window contact sensors.
These sensors report their open/closed state and are read-only devices.
Capability Version: contact_sensor@1.0.0
"""
from datetime import datetime
from typing import Annotated, Literal
from pydantic import BaseModel, Field, field_validator
# Capability metadata
CAP_VERSION = "contact_sensor@1.0.0"
DISPLAY_NAME = "Contact Sensor"
class ContactState(BaseModel):
"""State model for contact sensors (door/window sensors).
Contact sensors are read-only devices that report whether a door or window
is open or closed. They typically also report battery level and signal quality.
Attributes:
contact: Current state of the contact ("open" or "closed")
battery: Battery level percentage (0-100), optional
linkquality: MQTT link quality indicator, optional
device_temperature: Internal device temperature in °C, optional
voltage: Battery voltage in mV, optional
ts: Timestamp of the state reading, optional
Examples:
>>> ContactState(contact="open")
ContactState(contact='open', battery=None, ...)
>>> ContactState(contact="closed", battery=95, linkquality=87)
ContactState(contact='closed', battery=95, linkquality=87, ...)
"""
contact: Literal["open", "closed"] = Field(
...,
description="Contact state: 'open' for open door/window, 'closed' for closed"
)
battery: Annotated[int, Field(ge=0, le=100)] | None = Field(
None,
description="Battery level in percent (0-100)"
)
linkquality: int | None = Field(
None,
description="Link quality indicator (typically 0-255)"
)
device_temperature: float | None = Field(
None,
description="Internal device temperature in degrees Celsius"
)
voltage: int | None = Field(
None,
description="Battery voltage in millivolts"
)
ts: datetime | None = Field(
None,
description="Timestamp of the state reading"
)
@staticmethod
def normalize_bool(is_open: bool) -> "ContactState":
"""Convert boolean to ContactState.
Helper method to convert a boolean value to a ContactState instance.
Useful when integrating with systems that use True/False for contact state.
Args:
is_open: True if contact is open, False if closed
Returns:
ContactState instance with appropriate contact value
Examples:
>>> ContactState.normalize_bool(True)
ContactState(contact='open', ...)
>>> ContactState.normalize_bool(False)
ContactState(contact='closed', ...)
"""
return ContactState(contact="open" if is_open else "closed")
# Public API
__all__ = ["ContactState", "CAP_VERSION", "DISPLAY_NAME"]

View File

@@ -0,0 +1,229 @@
"""
Configuration models and loaders for groups and scenes.
This module provides Pydantic models for validating groups.yaml and scenes.yaml,
along with loader functions that parse YAML files into typed configuration objects.
"""
from pathlib import Path
from typing import Any
import yaml
from pydantic import BaseModel, Field, field_validator, model_validator
# ============================================================================
# GROUP MODELS
# ============================================================================
class GroupSelector(BaseModel):
"""Selector for automatically adding devices to a group."""
type: str = Field(..., description="Device type (e.g., 'light', 'thermostat')")
room: str | None = Field(None, description="Filter by room name")
tags: list[str] | None = Field(None, description="Filter by device tags")
class GroupConfig(BaseModel):
"""Configuration for a device group."""
id: str = Field(..., description="Unique group identifier")
name: str = Field(..., description="Human-readable group name")
selector: GroupSelector | None = Field(None, description="Auto-select devices by criteria")
device_ids: list[str] = Field(default_factory=list, description="Explicit device IDs")
capabilities: dict[str, bool] = Field(
default_factory=dict,
description="Supported capabilities (e.g., {'brightness': True})"
)
class GroupsConfigRoot(BaseModel):
"""Root configuration for groups.yaml."""
version: int = Field(..., description="Configuration schema version")
groups: list[GroupConfig] = Field(default_factory=list, description="List of groups")
@field_validator('groups')
@classmethod
def validate_unique_ids(cls, groups: list[GroupConfig]) -> list[GroupConfig]:
"""Ensure all group IDs are unique."""
ids = [g.id for g in groups]
duplicates = [id for id in ids if ids.count(id) > 1]
if duplicates:
raise ValueError(f"Duplicate group IDs found: {set(duplicates)}")
return groups
# ============================================================================
# SCENE MODELS
# ============================================================================
class SceneSelector(BaseModel):
"""Selector for targeting devices in a scene step."""
type: str | None = Field(None, description="Device type (e.g., 'light', 'outlet')")
room: str | None = Field(None, description="Filter by room name")
tags: list[str] | None = Field(None, description="Filter by device tags")
class SceneStep(BaseModel):
"""A single step in a scene execution."""
selector: SceneSelector | None = Field(None, description="Select devices by criteria")
group_id: str | None = Field(None, description="Target a specific group")
action: dict[str, Any] = Field(..., description="Action to execute (type + payload)")
delay_ms: int | None = Field(None, description="Delay before next step (milliseconds)")
@model_validator(mode='after')
def validate_selector_or_group(self) -> 'SceneStep':
"""Ensure either selector OR group_id is specified, but not both."""
has_selector = self.selector is not None
has_group = self.group_id is not None
if not has_selector and not has_group:
raise ValueError("SceneStep must have either 'selector' or 'group_id'")
if has_selector and has_group:
raise ValueError("SceneStep cannot have both 'selector' and 'group_id'")
return self
class SceneConfig(BaseModel):
"""Configuration for a scene."""
id: str = Field(..., description="Unique scene identifier")
name: str = Field(..., description="Human-readable scene name")
steps: list[SceneStep] = Field(..., description="Ordered list of actions")
class ScenesConfigRoot(BaseModel):
"""Root configuration for scenes.yaml."""
version: int = Field(..., description="Configuration schema version")
scenes: list[SceneConfig] = Field(default_factory=list, description="List of scenes")
@field_validator('scenes')
@classmethod
def validate_unique_ids(cls, scenes: list[SceneConfig]) -> list[SceneConfig]:
"""Ensure all scene IDs are unique."""
ids = [s.id for s in scenes]
duplicates = [id for id in ids if ids.count(id) > 1]
if duplicates:
raise ValueError(f"Duplicate scene IDs found: {set(duplicates)}")
return scenes
# ============================================================================
# LOADER FUNCTIONS
# ============================================================================
def load_groups(path: Path | str) -> GroupsConfigRoot:
"""
Load and validate groups configuration from YAML file.
Args:
path: Path to groups.yaml file
Returns:
Validated GroupsConfigRoot object
Raises:
FileNotFoundError: If config file doesn't exist
ValidationError: If configuration is invalid
ValueError: If duplicate group IDs are found or YAML is empty
"""
path = Path(path)
if not path.exists():
raise FileNotFoundError(f"Groups config file not found: {path}")
with open(path, 'r', encoding='utf-8') as f:
data = yaml.safe_load(f)
if data is None:
raise ValueError(f"Groups config file is empty: {path}")
return GroupsConfigRoot.model_validate(data)
def load_scenes(path: Path | str) -> ScenesConfigRoot:
"""
Load and validate scenes configuration from YAML file.
Args:
path: Path to scenes.yaml file
Returns:
Validated ScenesConfigRoot object
Raises:
FileNotFoundError: If config file doesn't exist
ValidationError: If configuration is invalid
ValueError: If duplicate scene IDs, invalid steps, or empty YAML are found
"""
path = Path(path)
if not path.exists():
raise FileNotFoundError(f"Scenes config file not found: {path}")
with open(path, 'r', encoding='utf-8') as f:
data = yaml.safe_load(f)
if data is None:
raise ValueError(f"Scenes config file is empty: {path}")
return ScenesConfigRoot.model_validate(data)
# ============================================================================
# CONVENIENCE FUNCTIONS
# ============================================================================
def get_group_by_id(config: GroupsConfigRoot, group_id: str) -> GroupConfig | None:
"""Find a group by its ID."""
for group in config.groups:
if group.id == group_id:
return group
return None
def get_scene_by_id(config: ScenesConfigRoot, scene_id: str) -> SceneConfig | None:
"""Find a scene by its ID."""
for scene in config.scenes:
if scene.id == scene_id:
return scene
return None
# ============================================================================
# EXAMPLE USAGE
# ============================================================================
if __name__ == "__main__":
from pathlib import Path
# Example: Load groups configuration
try:
groups_path = Path(__file__).parent.parent / "config" / "groups.yaml"
groups = load_groups(groups_path)
print(f"✓ Loaded {len(groups.groups)} groups (version {groups.version})")
for group in groups.groups:
print(f" - {group.id}: {group.name}")
if group.selector:
print(f" Selector: type={group.selector.type}, room={group.selector.room}")
if group.device_ids:
print(f" Devices: {', '.join(group.device_ids)}")
except Exception as e:
print(f"✗ Error loading groups: {e}")
print()
# Example: Load scenes configuration
try:
scenes_path = Path(__file__).parent.parent / "config" / "scenes.yaml"
scenes = load_scenes(scenes_path)
print(f"✓ Loaded {len(scenes.scenes)} scenes (version {scenes.version})")
for scene in scenes.scenes:
print(f" - {scene.id}: {scene.name} ({len(scene.steps)} steps)")
for i, step in enumerate(scene.steps, 1):
if step.selector:
print(f" Step {i}: selector type={step.selector.type}")
elif step.group_id:
print(f" Step {i}: group_id={step.group_id}")
print(f" Action: {step.action}")
except Exception as e:
print(f"✗ Error loading scenes: {e}")

View File

@@ -0,0 +1,21 @@
"""
Relay capability model.
A relay is essentially a simple on/off switch, like a light with only power control.
"""
from pydantic import BaseModel, Field
from typing import Literal
# Capability version
CAP_VERSION = "relay@1.0.0"
DISPLAY_NAME = "Relay"
class RelayState(BaseModel):
"""State model for relay devices (on/off only)"""
power: Literal["on", "off"] = Field(..., description="Power state: on or off")
class RelaySetPayload(BaseModel):
"""Payload for setting relay state"""
power: Literal["on", "off"] = Field(..., description="Desired power state: on or off")

View File

@@ -0,0 +1,37 @@
"""
Temperature & Humidity Sensor Capability - temp_humidity_sensor@1.0.0
Read-only sensor for temperature and humidity measurements.
"""
from datetime import datetime
from typing import Annotated
from pydantic import BaseModel, Field
class TempHumidityState(BaseModel):
"""
State model for temperature & humidity sensors.
Required fields:
- temperature: Temperature in degrees Celsius
- humidity: Relative humidity in percent
Optional fields:
- battery: Battery level 0-100%
- linkquality: Signal quality indicator
- voltage: Battery voltage in mV
- ts: Timestamp of measurement
"""
temperature: float = Field(..., description="Temperature in degrees Celsius")
humidity: float = Field(..., description="Relative humidity in percent (0-100)")
battery: Annotated[int, Field(ge=0, le=100)] | None = None
linkquality: int | None = None
voltage: int | None = None
ts: datetime | None = None
# Capability metadata
CAP_VERSION = "temp_humidity_sensor@1.0.0"
DISPLAY_NAME = "Temperature & Humidity Sensor"

View File

@@ -16,16 +16,16 @@ class ThermostatState(BaseModel):
Thermostat state model with validation.
Attributes:
mode: Operating mode (off, heat, auto)
mode: Operating mode (off, heat, auto) - optional for SET commands
target: Target temperature in °C [5.0..30.0]
current: Current temperature in °C (optional in SET, required in STATE)
battery: Battery level 0-100% (optional)
window_open: Window open detection (optional)
"""
mode: Literal["off", "heat", "auto"] = Field(
...,
description="Operating mode of the thermostat"
mode: Literal["off", "heat", "auto"] | None = Field(
None,
description="Operating mode of the thermostat (optional for SET commands)"
)
target: float | Decimal = Field(