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
|
"""Use of this source code is governed by the MIT license found in the LICENSE file.
Plugwise Smile protocol helpers.
"""
from __future__ import annotations
from typing import cast
from plugwise.constants import (
ANNA,
NONE,
SPECIAL_PLUG_TYPES,
SWITCH_GROUP_TYPES,
ApplianceType,
GwEntityData,
ModuleData,
)
from plugwise.util import (
check_heater_central,
check_model,
get_vendor_name,
return_valid,
)
from defusedxml import ElementTree as etree
from munch import Munch
def get_zigbee_data(
module: etree.Element, module_data: ModuleData, legacy: bool
) -> None:
"""Helper-function for _get_module_data()."""
if legacy:
# Stretches
if (router := module.find("./protocols/network_router")) is not None:
module_data["zigbee_mac_address"] = router.find("mac_address").text
# Also look for the Circle+/Stealth M+
if (coord := module.find("./protocols/network_coordinator")) is not None:
module_data["zigbee_mac_address"] = coord.find("mac_address").text
# Adam
elif (zb_node := module.find("./protocols/zig_bee_node")) is not None:
module_data["zigbee_mac_address"] = zb_node.find("mac_address").text
module_data["reachable"] = zb_node.find("reachable").text == "true"
class SmileCommon:
"""The SmileCommon class."""
def __init__(self) -> None:
"""Init."""
self._cooling_present: bool
self._count: int
self._domain_objects: etree.Element
self._heater_id: str = NONE
self._on_off_device: bool
self.gw_entities: dict[str, GwEntityData] = {}
self.smile_name: str
self.smile_type: str
@property
def heater_id(self) -> str:
"""Return the heater-id."""
return self._heater_id
def smile(self, name: str) -> bool:
"""Helper-function checking the smile-name."""
return self.smile_name == name
def _appl_heater_central_info(
self,
appl: Munch,
xml_1: etree.Element,
legacy: bool,
xml_2: etree.Element = None,
xml_3: etree.Element = None,
) -> Munch:
"""Helper-function for _appliance_info_finder()."""
# Find the valid heater_central
# xml_2 self._appliances for legacy, self._domain_objects for actual
xml_2 = return_valid(xml_2, self._domain_objects)
self._heater_id = check_heater_central(xml_2)
if self._heater_id == NONE:
return Munch() # pragma: no cover
# Info for On-Off device
if self._on_off_device:
appl.name = "OnOff" # pragma: no cover
appl.model = "Unknown" # pragma: no cover
appl.vendor_name = None # pragma: no cover
return appl # pragma: no cover
# Info for OpenTherm device
appl.name = "OpenTherm"
locator_1 = "./logs/point_log[type='flame_state']/boiler_state"
locator_2 = "./services/boiler_state"
# xml_1: appliance
# xml_3: self._modules for legacy, self._domain_objects for actual
xml_3 = return_valid(xml_3, self._domain_objects)
module_data = self._get_module_data(xml_1, locator_1, xml_3)
if not module_data["contents"]:
module_data = self._get_module_data(xml_1, locator_2, xml_3)
appl.vendor_name = module_data["vendor_name"]
appl.hardware = module_data["hardware_version"]
appl.model_id = module_data["vendor_model"] if not legacy else None
appl.model = (
"Generic heater/cooler" if self._cooling_present else "Generic heater"
)
return appl
def _appl_thermostat_info(
self, appl: Munch, xml_1: etree.Element, xml_2: etree.Element = None
) -> Munch:
"""Helper-function for _appliance_info_finder()."""
locator = "./logs/point_log[type='thermostat']/thermostat"
xml_2 = return_valid(xml_2, self._domain_objects)
module_data = self._get_module_data(xml_1, locator, xml_2)
appl.vendor_name = module_data["vendor_name"]
appl.model = module_data["vendor_model"]
if (
appl.model != "ThermoTouch"
): # model_id for Anna not present as stand-alone device
appl.model_id = appl.model
appl.model = check_model(appl.model, appl.vendor_name)
appl.available = module_data["reachable"]
appl.hardware = module_data["hardware_version"]
appl.firmware = module_data["firmware_version"]
appl.zigbee_mac = module_data["zigbee_mac_address"]
return appl
def _create_gw_entities(self, appl: Munch) -> None:
"""Helper-function for creating/updating gw_entities."""
self.gw_entities[appl.entity_id] = {"dev_class": appl.pwclass}
self._count += 1
for key, value in {
"available": appl.available,
"firmware": appl.firmware,
"hardware": appl.hardware,
"location": appl.location,
"mac_address": appl.mac,
"model": appl.model,
"model_id": appl.model_id,
"name": appl.name,
"zigbee_mac_address": appl.zigbee_mac,
"vendor": appl.vendor_name,
}.items():
if value is not None or key == "location":
appl_key = cast(ApplianceType, key)
self.gw_entities[appl.entity_id][appl_key] = value
self._count += 1
def _entity_switching_group(self, entity: GwEntityData, data: GwEntityData) -> None:
"""Helper-function for _get_device_zone_data().
Determine switching group device data.
"""
if entity["dev_class"] in SWITCH_GROUP_TYPES:
counter = 0
for member in entity["members"]:
if self.gw_entities[member]["switches"].get("relay"):
counter += 1
data["switches"]["relay"] = counter != 0
self._count += 1
def _get_group_switches(self) -> dict[str, GwEntityData]:
"""Helper-function for smile.py: get_all_gateway_entities().
Collect switching- or pump-group info.
"""
switch_groups: dict[str, GwEntityData] = {}
# P1 and Anna don't have switchgroups
if self.smile_type == "power" or self.smile(ANNA):
return switch_groups
for group in self._domain_objects.findall("./group"):
members: list[str] = []
group_id = group.attrib["id"]
group_name = group.find("name").text
group_type = group.find("type").text
group_appliances = group.findall("appliances/appliance")
for item in group_appliances:
# Check if members are not orphaned - stretch
if item.attrib["id"] in self.gw_entities:
members.append(item.attrib["id"])
if group_type in SWITCH_GROUP_TYPES and members:
switch_groups[group_id] = {
"dev_class": group_type,
"model": "Switchgroup",
"name": group_name,
"members": members,
"vendor": "Plugwise",
}
self._count += 4
return switch_groups
def _get_lock_state(
self, xml: etree.Element, data: GwEntityData, stretch_v2: bool = False
) -> None:
"""Helper-function for _get_measurement_data().
Adam & Stretches: obtain the relay-switch lock state.
"""
actuator = "actuator_functionalities"
func_type = "relay_functionality"
if stretch_v2:
actuator = "actuators"
func_type = "relay"
if xml.find("type").text not in SPECIAL_PLUG_TYPES:
locator = f"./{actuator}/{func_type}/lock"
if (found := xml.find(locator)) is not None:
data["switches"]["lock"] = found.text == "true"
self._count += 1
def _get_module_data(
self,
xml_1: etree.Element,
locator: str,
xml_2: etree.Element = None,
legacy: bool = False,
) -> ModuleData:
"""Helper-function for _energy_device_info_finder() and _appliance_info_finder().
Collect requested info from MODULES.
"""
module_data: ModuleData = {
"contents": False,
"firmware_version": None,
"hardware_version": None,
"reachable": None,
"vendor_name": None,
"vendor_model": None,
"zigbee_mac_address": None,
}
if (appl_search := xml_1.find(locator)) is not None:
link_tag = appl_search.tag
link_id = appl_search.attrib["id"]
loc = f".//services/{link_tag}[@id='{link_id}']...."
# Not possible to walrus for some reason...
# xml_2: self._modules for legacy, self._domain_objects for actual
search = return_valid(xml_2, self._domain_objects)
module = search.find(loc)
if module is not None: # pylint: disable=consider-using-assignment-expr
module_data["contents"] = True
get_vendor_name(module, module_data)
module_data["vendor_model"] = module.find("vendor_model").text
module_data["hardware_version"] = module.find("hardware_version").text
module_data["firmware_version"] = module.find("firmware_version").text
get_zigbee_data(module, module_data, legacy)
return module_data
|
