1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
|
# -*- coding: utf-8 -*-
"""
(C) 2022 by Jan Schneider (oss@janschneider.net)
Released under the GNU General Public License v3.0
"""
import asyncio
import logging
import re
import time
from datetime import datetime
from typing import Generator
import aiohttp
import xmltodict
logger = logging.getLogger(__name__)
__version__ = "1.4.0"
class Alpha2Base:
"""Class representing one alpha2 base"""
_TYPES = {
"IODEVICE": {
"IODEVICE_TYPE": int,
"IODEVICE_ID": int,
"IODEVICE_VERS_HW": str,
"IODEVICE_VERS_SW": str,
"HEATAREA_NR": int,
"SIGNALSTRENGTH": int,
"BATTERY": int, # 0=empty, 1=weak, 2=good
"IODEVICE_STATE": int,
"IODEVICE_COMERROR": int,
"ISON": bool,
},
"HEATCTRL": {
"INUSE": bool,
"HEATAREA_NR": int,
"ACTOR": int,
"ACTOR_PERCENT": int,
"HEATCTRL_STATE": int,
},
"HEATAREA": {
"BLOCK_HC": bool,
"HEATAREA_NAME": str,
"HEATAREA_MODE": int,
"HEATAREA_STATE": int,
"HEATINGSYSTEM": int, # 0 FBH Standard - 1 FBH Niedrigenergie - 2 Radiator - 3 Konvektor passiv - 4 Konvektor aktiv
"ISLOCKED": bool,
"LIGHT": int,
"LOCK_AVAILABLE": bool,
"LOCK_CODE": str,
"OFFSET": float,
"PARTY": bool,
"PARTY_REMAININGTIME": int,
"PRESENCE": bool,
"PROGRAM_SOURCE": int,
"PROGRAM_WEEK": int,
"PROGRAM_WEEKEND": int,
"RPM_MOTOR": int,
"SENSOR_EXT": int, # 0 kein zusätzlicher Sensor - 1 Taupunktsensor - 2 Bodensensor - 3 Raumsensor
"T_ACTUAL": float,
"T_ACTUAL_EXT": float,
"T_COOL_DAY": float,
"T_COOL_NIGHT": float,
"T_FLOOR_DAY": float,
"T_HEAT_DAY": float,
"T_HEAT_NIGHT": float,
"T_TARGET": float,
"T_TARGET_ADJUSTABLE": bool,
"T_TARGET_BASE": float,
"T_TARGET_MIN": float,
"T_TARGET_MAX": float,
},
}
def __init__(
self, host: str, *, command_poll_interval: float = 2.0, command_timeout: float = 10.0, request_timeout: float = 10.0
) -> None:
match = re.search(r"[^:]+://([^/]+)/?", host)
if match:
host = match.group(1)
self.base_url = f"http://{host}"
self._static_data: dict | None = None
self._update_lock = asyncio.Lock()
self._command_poll_interval = command_poll_interval
self._command_timeout = command_timeout
self._client_timeout = aiohttp.ClientTimeout(total=request_timeout)
@classmethod
def convert_types_from_xml(cls, entity_type: str, data: dict) -> dict:
"""Convert types in data structure from xlm"""
_types = cls._TYPES.get(entity_type)
if not _types:
raise ValueError(f"Invalid entity type '{entity_type}'")
data = data.copy()
for attribute in data:
if attribute in _types:
if _types[attribute] is bool:
data[attribute] = bool(int(data[attribute]))
else:
data[attribute] = _types[attribute](data[attribute])
return data
@classmethod
def convert_types_for_xml(cls, entity_type: str, data: dict) -> dict:
"""Convert types in data structure for xlm"""
_types = cls._TYPES.get(entity_type)
if not _types:
raise ValueError(f"Invalid entity type '{entity_type}'")
data = data.copy()
for attribute in data:
if attribute in _types:
if _types[attribute] is bool:
data[attribute] = "1" if data[attribute] and data[attribute] != "0" else "0"
continue
if _types[attribute] is float:
data[attribute] = f"{float(data[attribute]):0.1f}"
continue
data[attribute] = str(data[attribute])
return data
async def _send_command(self, device_id: str, command: str) -> str:
"""Send a command to the base with device_id"""
xml = f'<?xml version="1.0" encoding="UTF-8"?>\n<Devices><Device><ID>{device_id}</ID>{command}</Device></Devices>'
async with aiohttp.ClientSession(timeout=self._client_timeout) as session:
for trynum in (1, 2):
try:
async with session.post(f"{self.base_url}/data/changes.xml", data=xml.encode("utf-8")) as response:
response.raise_for_status()
return await response.text()
except (UnicodeDecodeError, aiohttp.ClientError):
if trynum == 2:
raise
raise RuntimeError("Send command failed")
async def send_command(self, command: str) -> str:
"""Send a command to the base"""
async with self._update_lock:
return await self._send_command(self.id, command)
@property
def static_data(self) -> dict:
"""Ensure that static data is available"""
if not self._static_data:
raise RuntimeError("Static data not available")
return self._static_data
async def _fetch_static_data(self) -> str:
async with aiohttp.ClientSession(timeout=self._client_timeout) as session:
for trynum in (1, 2):
try:
async with session.get(f"{self.base_url}/data/static.xml") as response:
response.raise_for_status()
return await response.text()
except (UnicodeDecodeError, aiohttp.ClientError):
if trynum == 2:
raise
raise RuntimeError("Failed to fetch static data")
async def _get_static_data(self) -> dict:
"""Get and process static data"""
str_data = await self._fetch_static_data()
data = xmltodict.parse(str_data)
for _type in ("HEATAREA", "HEATCTRL", "IODEVICE"):
if not isinstance(data["Devices"]["Device"][_type], list):
data["Devices"]["Device"][_type] = [data["Devices"]["Device"][_type]]
return data
async def update_data(self) -> None:
"""Update local data"""
async with self._update_lock:
self._static_data = await self._get_static_data()
logger.debug(
"Static data updated from '%s', device name is '%s', %d heat areas, %d heat controls and %d io devices found",
self.base_url,
self.name,
len(self.static_data["Devices"]["Device"]["HEATAREA"]),
len(self.static_data["Devices"]["Device"]["HEATCTRL"]),
len(self.static_data["Devices"]["Device"]["IODEVICE"]),
)
@property
def name(self) -> str:
"""Return the name of the base"""
return self.static_data["Devices"]["Device"]["NAME"]
@property
def id(self) -> str:
"""Return the id of the base"""
return self.static_data["Devices"]["Device"]["ID"]
@property
def io_devices(self) -> Generator[dict, None, None]:
"""Return all io devices"""
device = self.static_data["Devices"]["Device"]
for io_device in device["IODEVICE"]:
io_device = self.convert_types_from_xml("IODEVICE", io_device)
io_device["NR"] = int(io_device["@nr"])
del io_device["@nr"]
io_device["ID"] = f"{device['ID']}:{io_device['NR']}"
io_device["_HEATAREA_ID"] = f"{device['ID']}:{io_device['HEATAREA_NR']}" if io_device["HEATAREA_NR"] else None
yield io_device
@property
def heat_controls(self) -> Generator[dict, None, None]:
"""Return all heat controls"""
device = self.static_data["Devices"]["Device"]
for heat_control in device["HEATCTRL"]:
heat_control = self.convert_types_from_xml("HEATCTRL", heat_control)
heat_control["NR"] = int(heat_control["@nr"])
del heat_control["@nr"]
heat_control["ID"] = f"{device['ID']}:{heat_control['NR']}"
heat_control["_HEATAREA_ID"] = f"{device['ID']}:{heat_control['HEATAREA_NR']}" if heat_control["HEATAREA_NR"] else None
yield heat_control
@property
def heat_areas(self) -> Generator[dict, None, None]:
"""Return all heat areas"""
device = self.static_data["Devices"]["Device"]
for heat_area in device["HEATAREA"]:
heat_area = self.convert_types_from_xml("HEATAREA", heat_area)
heat_area["NR"] = int(heat_area["@nr"])
del heat_area["@nr"]
heat_area["ID"] = f"{device['ID']}:{heat_area['NR']}"
heat_area["_HEATCTRL_STATE"] = 0
for heatctrl in device["HEATCTRL"]:
if heatctrl["INUSE"] and int(heatctrl["HEATAREA_NR"]) == heat_area["NR"]:
heat_area["_HEATCTRL_STATE"] = int(heatctrl["HEATCTRL_STATE"])
if heat_area["_HEATCTRL_STATE"]:
break
yield heat_area
@property
def cooling(self) -> bool:
"""Return if cooling mode is active"""
return int(self.static_data["Devices"]["Device"]["COOLING"]) == 1
async def set_cooling(self, value: bool) -> None:
"""Set cooling mode"""
# Needs <RELAIS><FUNCTION>1</FUNCTION></RELAIS>
cooling = 1 if value else 0
self.static_data["Devices"]["Device"]["COOLING"] = cooling
command = f"<COOLING>{cooling}</COOLING>"
async with self._update_lock:
await self._send_command(self.id, command)
start = time.time()
while True:
await asyncio.sleep(self._command_poll_interval)
data = await self._get_static_data()
if int(data["Devices"]["Device"]["COOLING"]) == cooling:
self._static_data = data
break
elapsed = time.time() - start
if elapsed > self._command_timeout:
raise TimeoutError(f"Timed out after {elapsed:0.0f} seconds while waiting for command to take effect")
async def update_heat_area(self, heat_area_id: str | int, attributes: dict) -> None:
"""Update heat area attributes on base"""
heat_area_id = str(heat_area_id)
device_id = None
ha_nr = None
if ":" in heat_area_id:
device_id, ha_nr = heat_area_id.split(":")
else:
device_id = self.id
ha_nr = heat_area_id
command = f'<HEATAREA nr="{ha_nr}">'
attributes = self.convert_types_for_xml("HEATAREA", attributes)
for attr, val in attributes.items():
command += f"<{attr}>{val}</{attr}>"
command += "</HEATAREA>"
async with self._update_lock:
await self._send_command(device_id, command)
async def set_datetime(self, value: datetime | None = None) -> None:
"""Set base date and time"""
value = value or datetime.now()
command = f"<DATETIME>{value.strftime('%Y-%m-%dT%H:%M:%S')}</DATETIME>"
async with self._update_lock:
await self._send_command(self.id, command)
|
