{{ message }}
Repository navigation
Expand file tree
/
Copy pathdata.py
More file actions
338 lines (286 loc) · 12.5 KB
/
Copy pathdata.py
File metadata and controls
338 lines (286 loc) · 12.5 KB
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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
"""Use of this source code is governed by the MIT license found in the LICENSE file.
Plugwise Smile protocol data-collection helpers.
"""
from __future__ import annotations
import re
from plugwise.constants import (
ADAM,
ANNA,
MAX_SETPOINT,
MIN_SETPOINT,
OFF,
ActuatorData,
GwEntityData,
)
from plugwise.helper import SmileHelper
from plugwise.util import remove_empty_platform_dicts
class SmileData(SmileHelper):
"""The Plugwise Smile main class."""
def __init__(self) -> None:
"""Init."""
super().__init__()
self._zones: dict[str, GwEntityData] = {}
def _all_entity_data(self) -> None:
"""Helper-function for get_all_gateway_entities().
Collect data for each entity and add to self.gw_entities.
"""
self._update_gw_entities()
if self.check_name(ADAM):
self._update_zones()
self.gw_entities.update(self._zones)
def _update_zones(self) -> None:
"""Helper-function for _all_entity_data() and async_update().
Collect data for each zone/location and add to self._zones.
"""
for location_id, zone in self._zones.items():
self._get_location_data(location_id, zone)
def _update_gw_entities(self) -> None:
"""Helper-function for _all_entities_data() and async_update().
Collect data for each entity and add to self.gw_entities.
"""
mac_list: list[str] = []
for entity_id, entity in self.gw_entities.items():
self._get_entity_data(entity_id, entity)
if entity_id == self._gateway_id:
mac_list = self._detect_low_batteries()
self._add_or_update_notifications(entity_id, entity)
is_battery_low = (
mac_list
and "low_battery" in entity["binary_sensors"]
and entity["zigbee_mac_address"] in mac_list
and entity["dev_class"]
in (
"thermo_sensor",
"thermostatic_radiator_valve",
"zone_thermometer",
"zone_thermostat",
)
)
if is_battery_low:
entity["binary_sensors"]["low_battery"] = True
self._update_for_cooling(entity)
remove_empty_platform_dicts(entity)
# Replace select_dhw_mode with dhw_mode when applicable
if (
"dhw_temperature" in entity
and (mode := entity.get("select_dhw_mode")) is not None
):
entity.pop("select_dhw_mode")
entity["dhw_mode"] = mode
def _detect_low_batteries(self) -> list[str]:
"""Helper-function updating the low-battery binary_sensor status from a Battery-is-low message."""
mac_address_list: list[str] = []
mac_pattern = re.compile(r"(?:[0-9A-F]{2}){8}")
matches = ["Battery", "below"]
if self._notifications:
for msg_id, notification in self._notifications.copy().items():
mac_address: str | None = None
message: str | None = notification.get("message")
warning: str | None = notification.get("warning")
notify = message or warning
if (
notify is not None
and all(x in notify for x in matches)
and (mac_addresses := mac_pattern.findall(notify))
):
mac_address = mac_addresses[0] # re.findall() outputs a list
if mac_address is not None:
mac_address_list.append(mac_address)
if message is not None: # only block message-type notifications
self._notifications.pop(msg_id)
return mac_address_list
def _add_or_update_notifications(
self, entity_id: str, entity: GwEntityData
) -> None:
"""Helper-function adding or updating the Plugwise notifications to the gateway."""
if entity_id != self._gateway_id:
return # pragma: no cover
if self._is_thermostat or self.smile.type == "power":
if "plugwise_notification" not in entity["binary_sensors"]:
entity["binary_sensors"].update(
{"plugwise_notification": bool(self._notifications)}
)
entity.update({"notifications": self._notifications})
self._count += 2
def _update_for_cooling(self, entity: GwEntityData) -> None:
"""Helper-function for adding/updating various cooling-related values."""
# For Anna and heating + cooling, replace setpoint with setpoint_high/_low
if (
self.check_name(ANNA)
and self._cooling_present
and entity["dev_class"] == "thermostat"
):
thermostat = entity["thermostat"]
temp_dict: ActuatorData = {
"setpoint_low": thermostat["setpoint"],
"setpoint_high": MAX_SETPOINT,
}
if self._cooling_enabled:
temp_dict = {
"setpoint_low": MIN_SETPOINT,
"setpoint_high": thermostat["setpoint"],
}
thermostat.pop("setpoint") # Add 2 keys, remove 1
temp_dict.update(thermostat)
entity["thermostat"] = temp_dict
sensors = entity["sensors"]
sensors["setpoint_low"] = temp_dict["setpoint_low"]
sensors["setpoint_high"] = temp_dict["setpoint_high"]
# Add 2 more keys, remove 1 when required
if "setpoint" in sensors:
sensors.pop("setpoint")
self._count -= 1
self._count += (
3 # add 4 total, remove 1, count the conditional remove separately
)
def _get_location_data(self, loc_id: str, zone: GwEntityData) -> None:
"""Helper-function for _all_entity_data() and async_update().
Provide entity-data, based on Location ID (= loc_id).
"""
self._get_zone_data(loc_id, zone)
self._regulation_control(zone)
zone["control_state"] = "idle"
self._count += 1
if (ctrl_state := self._control_state(zone)) and ctrl_state in (
"cooling",
"heating",
"preheating",
):
zone["control_state"] = str(ctrl_state)
if "setpoint" in zone["sensors"]:
zone["sensors"].pop("setpoint") # remove, only used in _control_state()
self._count -= 1
# Thermostat data (presets, temperatures etc)
self._climate_data(loc_id, zone)
def _get_entity_data(self, entity_id: str, entity: GwEntityData) -> None:
"""Helper-function for _update_gw_entities() and async_update().
Provide entity-data, based on appliance_id (= entity_id).
"""
self._get_measurement_data(entity_id, entity)
# Adam data
if self.check_name(ADAM):
self._get_adam_data(entity)
# Update switching-group status
self._entity_switching_group(entity)
# Thermostat data for Anna (presets, temperatures etc)
if self.check_name(ANNA) and entity["dev_class"] == "thermostat":
self._climate_data(entity_id, entity)
self._get_anna_control_state(entity)
# Check availability of wired entities:
# - Smartmeter
self._check_availability(
entity, "smartmeter", "P1 does not seem to be connected"
)
# - OpenTherm entity
if entity["name"] != "OnOff":
self._check_availability(
entity, "heater_central", "no OpenTherm communication"
)
def _check_availability(
self, entity: GwEntityData, dev_class: str, message: str
) -> None:
"""Helper-function for _get_entity_data().
Provide availability status for the wired-connected devices.
"""
if entity["dev_class"] == dev_class:
entity["available"] = True
self._count += 1
for item in self._notifications.values():
for msg in item.values():
if message in msg:
entity["available"] = False
break
def _get_adam_data(self, entity: GwEntityData) -> None:
"""Helper-function for _get_entity_data().
Determine Adam heating-status for on-off heating via valves,
available regulations_modes and thermostat control_states,
and add missing cooling_enabled when required.
"""
if entity["dev_class"] == "heater_central":
# Indicate heating_state based on valves being open in case of city-provided heating
if self._on_off_device and isinstance(self._heating_valves(), int):
entity["binary_sensors"]["heating_state"] = self._heating_valves() != 0
# Add cooling_enabled binary_sensor
if (
"binary_sensors" in entity
and "cooling_enabled" not in entity["binary_sensors"]
and self._cooling_present
):
entity["binary_sensors"]["cooling_enabled"] = self._cooling_enabled
self._count += 1
# Show the allowed regulation_modes and gateway_modes
if entity["dev_class"] == "gateway":
if self._reg_allowed_modes:
entity["regulation_modes"] = self._reg_allowed_modes
self._count += 1
if self._gw_allowed_modes:
entity["gateway_modes"] = self._gw_allowed_modes
self._count += 1
def _climate_data(self, location_id: str, entity: GwEntityData) -> None:
"""Helper-function for _get_entity_data().
Determine climate-control entity data.
"""
loc_id = location_id
if entity.get("location") is not None:
loc_id = entity["location"]
# Presets
entity["preset_modes"] = None
entity["active_preset"] = None
self._count += 2
if presets := self._presets(loc_id):
entity["preset_modes"] = list(presets)
entity["active_preset"] = self._preset(loc_id)
# Schedule
entity["available_schedules"] = [OFF]
entity["select_schedule"] = OFF
self._count += 2
avail_schedules, sel_schedule = self._schedules(loc_id)
if avail_schedules != [OFF]:
entity["available_schedules"] = avail_schedules
entity["select_schedule"] = sel_schedule
# Set HA climate HVACMode: auto, heat, heat_cool, cool and off
entity["climate_mode"] = "auto"
self._count += 1
if sel_schedule == OFF:
entity["climate_mode"] = "heat"
if self._cooling_present:
entity["climate_mode"] = (
"cool" if self.check_reg_mode("cooling") else "heat_cool"
)
if self.check_reg_mode("off"):
entity["climate_mode"] = "off"
self._get_schedule_states_with_off(
loc_id, avail_schedules, sel_schedule, entity
)
def check_reg_mode(self, mode: str) -> bool:
"""Helper-function for device_data_climate()."""
gateway = self.gw_entities[self._gateway_id]
return (
"regulation_modes" in gateway and gateway["select_regulation_mode"] == mode
)
def _get_anna_control_state(self, data: GwEntityData) -> None:
"""Set the thermostat control_state based on the opentherm/onoff device state."""
data["control_state"] = "idle"
self._count += 1
for entity in self.gw_entities.values():
if entity["dev_class"] != "heater_central":
continue
binary_sensors = entity["binary_sensors"]
if binary_sensors["heating_state"]:
data["control_state"] = "heating"
if binary_sensors.get("cooling_state"):
data["control_state"] = "cooling"
def _get_schedule_states_with_off(
self, location: str, schedules: list[str], selected: str, entity: GwEntityData
) -> None:
"""Collect schedules with states for each thermostat."""
all_off = True
self._schedule_old_states[location] = {}
for schedule in schedules:
self._schedule_old_states[location][schedule] = "off"
active: bool = schedule == selected and entity["climate_mode"] == "auto"
if active:
self._schedule_old_states[location][schedule] = "on"
all_off = False
if all_off:
entity["select_schedule"] = OFF
You can’t perform that action at this time.