Compare commits
30 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
b6b441c0ca
|
|||
|
d3d96ed3e9
|
|||
|
2e2963488b
|
|||
|
7928bc596f
|
|||
|
3874eaed83
|
|||
|
0f43f37823
|
|||
|
93e70da97d
|
|||
|
62d302bf41
|
|||
|
3d6130f2c2
|
|||
|
2a8d569bb5
|
|||
|
6a5f814cb4
|
|||
|
cc3c15078c
|
|||
|
7772dac000
|
|||
|
97ea853483
|
|||
|
86d1933c1f
|
|||
|
9458381593
|
|||
|
f389115841
|
|||
|
19a6a603d5
|
|||
|
e728dd58e4
|
|||
|
6310fedeea
|
|||
|
e113616abf
|
|||
|
e8cd34f88f
|
|||
|
1bd175c912
|
|||
|
cc566c9e73
|
|||
|
2eb4f3c376
|
|||
|
b57ddb1589
|
|||
|
a49d56df60
|
|||
|
5a7b16f7aa
|
|||
|
e69822719a
|
|||
|
25a6b98d41
|
41
DEVICES_BY_ROOM.md
Normal file
41
DEVICES_BY_ROOM.md
Normal 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
|
||||
223
MAX_INTEGRATION.md
Normal file
223
MAX_INTEGRATION.md
Normal 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)
|
||||
54
ZIGBEE_DEVICES_UNSUPPORTED.md
Normal file
54
ZIGBEE_DEVICES_UNSUPPORTED.md
Normal 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.
|
||||
@@ -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")
|
||||
|
||||
@@ -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,
|
||||
}
|
||||
|
||||
|
||||
|
||||
@@ -15,7 +15,18 @@ 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
|
||||
)
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
@@ -137,7 +148,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
|
||||
}
|
||||
}
|
||||
|
||||
@@ -331,6 +345,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 +361,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 +385,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,
|
||||
|
||||
53
apps/rules/Dockerfile
Normal file
53
apps/rules/Dockerfile
Normal 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"]
|
||||
371
apps/rules/RULE_INTERFACE.md
Normal file
371
apps/rules/RULE_INTERFACE.md
Normal 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.
|
||||
15
apps/rules/impl/__init__.py
Normal file
15
apps/rules/impl/__init__.py
Normal 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.
|
||||
"""
|
||||
256
apps/rules/impl/window_setback.py
Normal file
256
apps/rules/impl/window_setback.py
Normal 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,
|
||||
}
|
||||
@@ -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__":
|
||||
|
||||
5
apps/rules/requirements.txt
Normal file
5
apps/rules/requirements.txt
Normal file
@@ -0,0 +1,5 @@
|
||||
# Rules Engine Dependencies
|
||||
pydantic>=2.0
|
||||
redis>=5.0.1
|
||||
aiomqtt>=2.0.1
|
||||
pyyaml>=6.0.1
|
||||
742
apps/rules/rule_interface.py
Normal file
742
apps/rules/rule_interface.py
Normal file
@@ -0,0 +1,742 @@
|
||||
"""
|
||||
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 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
122
apps/rules/rules_config.py
Normal 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}")
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -358,27 +358,6 @@
|
||||
color: #999;
|
||||
}
|
||||
|
||||
.mode-display {
|
||||
background: #f8f9fa;
|
||||
border-radius: 8px;
|
||||
padding: 0.75rem;
|
||||
text-align: center;
|
||||
margin-bottom: 1rem;
|
||||
}
|
||||
|
||||
.mode-label {
|
||||
font-size: 0.75rem;
|
||||
color: #666;
|
||||
text-transform: uppercase;
|
||||
}
|
||||
|
||||
.mode-value {
|
||||
font-size: 1rem;
|
||||
font-weight: 600;
|
||||
color: #667eea;
|
||||
text-transform: uppercase;
|
||||
}
|
||||
|
||||
.temp-controls {
|
||||
display: flex;
|
||||
gap: 0.5rem;
|
||||
@@ -407,39 +386,96 @@
|
||||
transform: scale(0.95);
|
||||
}
|
||||
|
||||
.mode-controls {
|
||||
display: grid;
|
||||
grid-template-columns: repeat(3, 1fr);
|
||||
gap: 0.5rem;
|
||||
}
|
||||
|
||||
.mode-button {
|
||||
padding: 0.75rem;
|
||||
border: 2px solid #ddd;
|
||||
/* Contact Sensor Styles */
|
||||
.contact-status {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.75rem;
|
||||
padding: 1rem;
|
||||
background: #f8f9fa;
|
||||
border-radius: 8px;
|
||||
font-size: 0.875rem;
|
||||
margin: 1rem 0;
|
||||
}
|
||||
|
||||
.contact-badge {
|
||||
padding: 0.5rem 1rem;
|
||||
border-radius: 6px;
|
||||
font-weight: 600;
|
||||
cursor: pointer;
|
||||
transition: all 0.2s;
|
||||
background: white;
|
||||
color: #666;
|
||||
min-height: 44px;
|
||||
font-size: 0.875rem;
|
||||
text-transform: uppercase;
|
||||
letter-spacing: 0.5px;
|
||||
}
|
||||
|
||||
.mode-button:hover {
|
||||
border-color: #667eea;
|
||||
color: #667eea;
|
||||
}
|
||||
|
||||
.mode-button.active {
|
||||
background: #667eea;
|
||||
border-color: #667eea;
|
||||
.contact-badge.open {
|
||||
background: #dc3545;
|
||||
color: white;
|
||||
}
|
||||
|
||||
.mode-button:active {
|
||||
transform: scale(0.95);
|
||||
.contact-badge.closed {
|
||||
background: #28a745;
|
||||
color: white;
|
||||
}
|
||||
|
||||
.contact-info {
|
||||
font-size: 0.75rem;
|
||||
color: #999;
|
||||
margin-top: 1rem;
|
||||
padding: 0.5rem;
|
||||
background: #f8f9fa;
|
||||
border-radius: 4px;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
/* Temperature & Humidity Sensor Styles */
|
||||
.temp-humidity-display {
|
||||
padding: 1rem;
|
||||
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
|
||||
border-radius: 12px;
|
||||
color: white;
|
||||
margin: 1rem 0;
|
||||
}
|
||||
|
||||
.temp-humidity-row {
|
||||
display: flex;
|
||||
justify-content: space-between;
|
||||
align-items: center;
|
||||
padding: 0.75rem 0;
|
||||
}
|
||||
|
||||
.temp-humidity-row:not(:last-child) {
|
||||
border-bottom: 1px solid rgba(255, 255, 255, 0.2);
|
||||
}
|
||||
|
||||
.temp-humidity-label {
|
||||
font-size: 0.875rem;
|
||||
font-weight: 500;
|
||||
opacity: 0.9;
|
||||
}
|
||||
|
||||
.temp-humidity-value {
|
||||
font-size: 1.5rem;
|
||||
font-weight: 700;
|
||||
letter-spacing: -0.5px;
|
||||
}
|
||||
|
||||
.temp-humidity-battery {
|
||||
font-size: 0.75rem;
|
||||
color: rgba(255, 255, 255, 0.8);
|
||||
text-align: center;
|
||||
padding: 0.5rem;
|
||||
margin-top: 0.5rem;
|
||||
background: rgba(0, 0, 0, 0.1);
|
||||
border-radius: 6px;
|
||||
}
|
||||
|
||||
.temp-humidity-info {
|
||||
font-size: 0.75rem;
|
||||
color: #999;
|
||||
margin-top: 1rem;
|
||||
padding: 0.5rem;
|
||||
background: #f8f9fa;
|
||||
border-radius: 4px;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.events {
|
||||
@@ -512,7 +548,7 @@
|
||||
<span class="refresh-icon" id="refresh-icon">↻</span>
|
||||
</button>
|
||||
<button class="collapse-all-btn" onclick="toggleAllRooms()" title="Alle Räume ein-/ausklappen">
|
||||
<span class="collapse-all-icon" id="collapse-all-icon">▼</span>
|
||||
<span class="collapse-all-icon collapsed" id="collapse-all-icon">▼</span>
|
||||
</button>
|
||||
</div>
|
||||
</header>
|
||||
@@ -522,10 +558,10 @@
|
||||
<section class="room">
|
||||
<div class="room-header" onclick="toggleRoom('room-{{ loop.index }}')">
|
||||
<h2 class="room-title">{{ room.name }}</h2>
|
||||
<span class="room-toggle" id="toggle-room-{{ loop.index }}">▼</span>
|
||||
<span class="room-toggle collapsed" id="toggle-room-{{ loop.index }}">▼</span>
|
||||
</div>
|
||||
|
||||
<div class="room-content" id="room-{{ loop.index }}">
|
||||
<div class="room-content collapsed" id="room-{{ loop.index }}">
|
||||
<div class="devices">
|
||||
{% for device in room.devices %}
|
||||
<div class="device-card" data-device-id="{{ device.device_id }}">
|
||||
@@ -535,8 +571,12 @@
|
||||
{% if device.type == "light" %}
|
||||
Light
|
||||
{% if device.features.brightness %}• Dimmbar{% endif %}
|
||||
{% elif device.type == "relay" %}
|
||||
Relay
|
||||
{% elif device.type == "thermostat" %}
|
||||
Thermostat
|
||||
{% elif device.type == "contact" or device.type == "contact_sensor" %}
|
||||
Contact Sensor • Read-Only
|
||||
{% else %}
|
||||
{{ device.type or "Unknown" }}
|
||||
{% endif %}
|
||||
@@ -583,6 +623,21 @@
|
||||
</div>
|
||||
{% endif %}
|
||||
|
||||
{% elif device.type == "relay" %}
|
||||
<div class="device-state">
|
||||
<span class="state-label">Status:</span>
|
||||
<span class="state-value off" id="state-{{ device.device_id }}">off</span>
|
||||
</div>
|
||||
|
||||
<div class="controls">
|
||||
<button
|
||||
class="toggle-button off"
|
||||
id="toggle-{{ device.device_id }}"
|
||||
onclick="toggleDevice('{{ device.device_id }}')">
|
||||
Einschalten
|
||||
</button>
|
||||
</div>
|
||||
|
||||
{% elif device.type == "thermostat" %}
|
||||
<div class="thermostat-display">
|
||||
<div class="temp-reading">
|
||||
@@ -601,40 +656,48 @@
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="mode-display">
|
||||
<div class="mode-label">Modus</div>
|
||||
<div class="mode-value" id="state-{{ device.device_id }}-mode">OFF</div>
|
||||
</div>
|
||||
|
||||
<div class="temp-controls">
|
||||
<button class="temp-button" onclick="adjustTarget('{{ device.device_id }}', -0.5)">
|
||||
-0.5
|
||||
<button class="temp-button" onclick="adjustTarget('{{ device.device_id }}', -1.0)">
|
||||
-1.0
|
||||
</button>
|
||||
<button class="temp-button" onclick="adjustTarget('{{ device.device_id }}', 0.5)">
|
||||
+0.5
|
||||
<button class="temp-button" onclick="adjustTarget('{{ device.device_id }}', 1.0)">
|
||||
+1.0
|
||||
</button>
|
||||
</div>
|
||||
|
||||
<div class="mode-controls">
|
||||
<button
|
||||
class="mode-button"
|
||||
id="mode-{{ device.device_id }}-off"
|
||||
onclick="setMode('{{ device.device_id }}', 'off')">
|
||||
Off
|
||||
</button>
|
||||
<button
|
||||
class="mode-button"
|
||||
id="mode-{{ device.device_id }}-heat"
|
||||
onclick="setMode('{{ device.device_id }}', 'heat')">
|
||||
Heat
|
||||
</button>
|
||||
<button
|
||||
class="mode-button"
|
||||
id="mode-{{ device.device_id }}-auto"
|
||||
onclick="setMode('{{ device.device_id }}', 'auto')">
|
||||
Auto
|
||||
</button>
|
||||
{% elif device.type == "contact" or device.type == "contact_sensor" %}
|
||||
<div class="contact-status">
|
||||
<span class="contact-badge closed" id="state-{{ device.device_id }}">
|
||||
Geschlossen
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<div class="contact-info">
|
||||
🔒 Nur-Lesen Gerät • Keine Steuerung möglich
|
||||
</div>
|
||||
|
||||
{% elif device.type == "temp_humidity" or device.type == "temp_humidity_sensor" %}
|
||||
<div class="temp-humidity-display">
|
||||
<div class="temp-humidity-row">
|
||||
<span class="temp-humidity-label">🌡️ Temperatur:</span>
|
||||
<span class="temp-humidity-value" id="th-{{ device.device_id }}-t">--</span>
|
||||
<span style="font-size: 1.25rem; font-weight: 600;">°C</span>
|
||||
</div>
|
||||
<div class="temp-humidity-row">
|
||||
<span class="temp-humidity-label">💧 Luftfeuchte:</span>
|
||||
<span class="temp-humidity-value" id="th-{{ device.device_id }}-h">--</span>
|
||||
<span style="font-size: 1.25rem; font-weight: 600;">%</span>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="temp-humidity-battery" id="th-{{ device.device_id }}-battery" style="display: none;">
|
||||
🔋 <span id="th-{{ device.device_id }}-battery-value">--</span>%
|
||||
</div>
|
||||
|
||||
<div class="temp-humidity-info">
|
||||
🔒 Nur-Lesen Gerät • Keine Steuerung möglich
|
||||
</div>
|
||||
|
||||
{% endif %}
|
||||
</div>
|
||||
{% endfor %}
|
||||
@@ -761,16 +824,16 @@
|
||||
let eventSource = null;
|
||||
let currentState = {};
|
||||
let thermostatTargets = {};
|
||||
let thermostatModes = {};
|
||||
let deviceTypes = {};
|
||||
|
||||
// Initialize device states
|
||||
{% for room in rooms %}
|
||||
{% for device in room.devices %}
|
||||
{% if device.type == "light" %}
|
||||
deviceTypes['{{ device.device_id }}'] = '{{ device.type }}';
|
||||
{% if device.type == "light" or device.type == "relay" %}
|
||||
currentState['{{ device.device_id }}'] = 'off';
|
||||
{% elif device.type == "thermostat" %}
|
||||
thermostatTargets['{{ device.device_id }}'] = 21.0;
|
||||
thermostatModes['{{ device.device_id }}'] = 'off';
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
{% endfor %}
|
||||
@@ -778,6 +841,7 @@
|
||||
// Toggle device state
|
||||
async function toggleDevice(deviceId) {
|
||||
const newState = currentState[deviceId] === 'on' ? 'off' : 'on';
|
||||
const deviceType = deviceTypes[deviceId] || 'light';
|
||||
|
||||
try {
|
||||
const response = await fetch(api(`/devices/${deviceId}/set`), {
|
||||
@@ -786,7 +850,7 @@
|
||||
'Content-Type': 'application/json'
|
||||
},
|
||||
body: JSON.stringify({
|
||||
type: 'light',
|
||||
type: deviceType,
|
||||
payload: {
|
||||
power: newState
|
||||
}
|
||||
@@ -846,7 +910,6 @@
|
||||
// Adjust thermostat target temperature
|
||||
async function adjustTarget(deviceId, delta) {
|
||||
const currentTarget = thermostatTargets[deviceId] || 21.0;
|
||||
const currentMode = thermostatModes[deviceId] || 'off';
|
||||
const newTarget = Math.max(5.0, Math.min(30.0, currentTarget + delta));
|
||||
|
||||
try {
|
||||
@@ -858,7 +921,6 @@
|
||||
body: JSON.stringify({
|
||||
type: 'thermostat',
|
||||
payload: {
|
||||
mode: currentMode,
|
||||
target: newTarget
|
||||
}
|
||||
})
|
||||
@@ -877,38 +939,6 @@
|
||||
}
|
||||
}
|
||||
|
||||
// Set thermostat mode
|
||||
async function setMode(deviceId, mode) {
|
||||
const currentTarget = thermostatTargets[deviceId] || 21.0;
|
||||
|
||||
try {
|
||||
const response = await fetch(api(`/devices/${deviceId}/set`), {
|
||||
method: 'POST',
|
||||
headers: {
|
||||
'Content-Type': 'application/json'
|
||||
},
|
||||
body: JSON.stringify({
|
||||
type: 'thermostat',
|
||||
payload: {
|
||||
mode: mode,
|
||||
target: currentTarget
|
||||
}
|
||||
})
|
||||
});
|
||||
|
||||
if (response.ok) {
|
||||
console.log(`Sent mode ${mode} to ${deviceId}`);
|
||||
addEvent({
|
||||
action: 'mode_set',
|
||||
device_id: deviceId,
|
||||
mode: mode
|
||||
});
|
||||
}
|
||||
} catch (error) {
|
||||
console.error('Failed to set mode:', error);
|
||||
}
|
||||
}
|
||||
|
||||
// Update device UI
|
||||
function updateDeviceUI(deviceId, power, brightness) {
|
||||
currentState[deviceId] = power;
|
||||
@@ -955,7 +985,6 @@
|
||||
function updateThermostatUI(deviceId, current, target, mode) {
|
||||
const currentSpan = document.getElementById(`state-${deviceId}-current`);
|
||||
const targetSpan = document.getElementById(`state-${deviceId}-target`);
|
||||
const modeSpan = document.getElementById(`state-${deviceId}-mode`);
|
||||
|
||||
if (current !== undefined && currentSpan) {
|
||||
currentSpan.textContent = current.toFixed(1);
|
||||
@@ -967,24 +996,56 @@
|
||||
}
|
||||
thermostatTargets[deviceId] = target;
|
||||
}
|
||||
}
|
||||
|
||||
// Update contact sensor UI
|
||||
function updateContactUI(deviceId, contactState) {
|
||||
const badge = document.getElementById(`state-${deviceId}`);
|
||||
if (!badge) {
|
||||
console.warn(`No contact badge found for device ${deviceId}`);
|
||||
return;
|
||||
}
|
||||
|
||||
if (mode !== undefined) {
|
||||
if (modeSpan) {
|
||||
modeSpan.textContent = mode.toUpperCase();
|
||||
}
|
||||
thermostatModes[deviceId] = mode;
|
||||
|
||||
// Update mode button states
|
||||
['off', 'heat', 'auto'].forEach(m => {
|
||||
const btn = document.getElementById(`mode-${deviceId}-${m}`);
|
||||
if (btn) {
|
||||
if (m === mode.toLowerCase()) {
|
||||
btn.classList.add('active');
|
||||
} else {
|
||||
btn.classList.remove('active');
|
||||
}
|
||||
}
|
||||
});
|
||||
// contactState is either "open" or "closed"
|
||||
if (contactState === "open") {
|
||||
badge.textContent = "Geöffnet";
|
||||
badge.className = "contact-badge open";
|
||||
} else if (contactState === "closed") {
|
||||
badge.textContent = "Geschlossen";
|
||||
badge.className = "contact-badge closed";
|
||||
}
|
||||
}
|
||||
|
||||
// Update temperature & humidity sensor UI
|
||||
function updateTempHumidityUI(deviceId, payload) {
|
||||
const tempSpan = document.getElementById(`th-${deviceId}-t`);
|
||||
const humiditySpan = document.getElementById(`th-${deviceId}-h`);
|
||||
const batteryDiv = document.getElementById(`th-${deviceId}-battery`);
|
||||
const batteryValueSpan = document.getElementById(`th-${deviceId}-battery-value`);
|
||||
|
||||
if (!tempSpan || !humiditySpan) {
|
||||
console.warn(`No temp/humidity elements found for device ${deviceId}`);
|
||||
return;
|
||||
}
|
||||
|
||||
// Update temperature (rounded to 1 decimal)
|
||||
if (payload.temperature !== undefined && payload.temperature !== null) {
|
||||
tempSpan.textContent = payload.temperature.toFixed(1);
|
||||
}
|
||||
|
||||
// Update humidity (rounded to 0-1 decimals)
|
||||
if (payload.humidity !== undefined && payload.humidity !== null) {
|
||||
// Round to 1 decimal if has decimals, otherwise integer
|
||||
const humidity = payload.humidity;
|
||||
humiditySpan.textContent = (humidity % 1 === 0) ? humidity.toFixed(0) : humidity.toFixed(1);
|
||||
}
|
||||
|
||||
// Update battery if present
|
||||
if (payload.battery !== undefined && payload.battery !== null && batteryDiv && batteryValueSpan) {
|
||||
batteryValueSpan.textContent = payload.battery;
|
||||
batteryDiv.style.display = 'block';
|
||||
} else if (batteryDiv) {
|
||||
batteryDiv.style.display = 'none';
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1043,20 +1104,26 @@
|
||||
}
|
||||
|
||||
// Check if it's a thermostat
|
||||
if (data.payload.mode !== undefined || data.payload.target !== undefined || data.payload.current !== undefined) {
|
||||
if (data.payload.mode !== undefined) {
|
||||
thermostatModes[data.device_id] = data.payload.mode;
|
||||
}
|
||||
if (data.payload.target !== undefined || data.payload.current !== undefined) {
|
||||
if (data.payload.target !== undefined) {
|
||||
thermostatTargets[data.device_id] = data.payload.target;
|
||||
}
|
||||
updateThermostatUI(
|
||||
data.device_id,
|
||||
data.payload.current,
|
||||
data.payload.target,
|
||||
data.payload.mode
|
||||
data.payload.target
|
||||
);
|
||||
}
|
||||
|
||||
// Check if it's a contact sensor
|
||||
if (data.payload.contact !== undefined) {
|
||||
updateContactUI(data.device_id, data.payload.contact);
|
||||
}
|
||||
|
||||
// Check if it's a temp/humidity sensor
|
||||
if (data.payload.temperature !== undefined || data.payload.humidity !== undefined) {
|
||||
updateTempHumidityUI(data.device_id, data.payload);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
@@ -1171,11 +1238,16 @@
|
||||
// It's a light
|
||||
currentState[deviceId] = state.power;
|
||||
updateDeviceUI(deviceId, state.power, state.brightness);
|
||||
} else if (state.mode !== undefined || state.target !== undefined) {
|
||||
} else if (state.target !== undefined) {
|
||||
// It's a thermostat
|
||||
if (state.mode) thermostatModes[deviceId] = state.mode;
|
||||
if (state.target) thermostatTargets[deviceId] = state.target;
|
||||
updateThermostatUI(deviceId, state.current, state.target, state.mode);
|
||||
updateThermostatUI(deviceId, state.current, state.target);
|
||||
} else if (state.contact !== undefined) {
|
||||
// It's a contact sensor
|
||||
updateContactUI(deviceId, state.contact);
|
||||
} else if (state.temperature !== undefined || state.humidity !== undefined) {
|
||||
// It's a temp/humidity sensor
|
||||
updateTempHumidityUI(deviceId, state);
|
||||
}
|
||||
}
|
||||
} catch (error) {
|
||||
|
||||
@@ -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"
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
66
config/devices.yaml-20251110
Normal file
66
config/devices.yaml-20251110
Normal 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"
|
||||
66
config/devices.yaml.backup-20251110-110730
Normal file
66
config/devices.yaml.backup-20251110-110730
Normal 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"
|
||||
@@ -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
|
||||
|
||||
|
||||
35
config/layout.yaml.backup-20251110-122723
Normal file
35
config/layout.yaml.backup-20251110-122723
Normal 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
|
||||
|
||||
|
||||
|
||||
23
config/max-thermostats.txt
Normal file
23
config/max-thermostats.txt
Normal 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
31
config/raeume.txt
Normal 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
94
config/rules.yaml
Normal 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
|
||||
62
docker-compose.yaml
Normal file
62
docker-compose.yaml
Normal 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
|
||||
@@ -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"
|
||||
@@ -4,6 +4,12 @@ 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.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
|
||||
|
||||
__all__ = [
|
||||
@@ -11,6 +17,12 @@ __all__ = [
|
||||
"LIGHT_VERSION",
|
||||
"ThermostatState",
|
||||
"THERMOSTAT_VERSION",
|
||||
"ContactState",
|
||||
"CONTACT_SENSOR_VERSION",
|
||||
"TempHumidityState",
|
||||
"TEMP_HUMIDITY_SENSOR_VERSION",
|
||||
"RelayState",
|
||||
"RELAY_VERSION",
|
||||
"DeviceTile",
|
||||
"Room",
|
||||
"UiLayout",
|
||||
|
||||
96
packages/home_capabilities/contact_sensor.py
Normal file
96
packages/home_capabilities/contact_sensor.py
Normal 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"]
|
||||
21
packages/home_capabilities/relay.py
Normal file
21
packages/home_capabilities/relay.py
Normal 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")
|
||||
37
packages/home_capabilities/temp_humidity_sensor.py
Normal file
37
packages/home_capabilities/temp_humidity_sensor.py
Normal 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"
|
||||
@@ -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(
|
||||
|
||||
Reference in New Issue
Block a user