forked from wlcrs/huawei_solar
-
Notifications
You must be signed in to change notification settings - Fork 0
/
__init__.py
352 lines (289 loc) · 10.9 KB
/
__init__.py
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
339
340
341
342
343
344
345
346
347
348
349
350
351
352
"""The Huawei Solar integration."""
from __future__ import annotations
from collections.abc import Awaitable, Callable
from datetime import timedelta
import logging
from typing import TypedDict, TypeVar
import async_timeout
from huawei_solar import (
AsyncHuaweiSolar,
HuaweiSolarException,
register_names as rn,
register_values as rv,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import CONF_HOST, CONF_PORT, Platform
from homeassistant.core import HomeAssistant
from homeassistant.exceptions import ConfigEntryNotReady
from homeassistant.helpers.debounce import Debouncer
from homeassistant.helpers.entity import DeviceInfo
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
from .const import (
BATTERY_UPDATE_INTERVAL,
CONF_SLAVE_IDS,
DATA_DEVICE_INFOS,
DATA_MODBUS_CLIENT,
DATA_SLAVE_IDS,
DATA_UPDATE_COORDINATORS,
DOMAIN,
INVERTER_UPDATE_INTERVAL,
LEGACY_CONF_SLAVE,
METER_UPDATE_INTERVAL,
)
from .entity_descriptions import (
BATTERY_ENTITY_DESCRIPTIONS,
INVERTER_ENTITY_DESCRIPTIONS,
SINGLE_PHASE_METER_ENTITY_DESCRIPTIONS,
THREE_PHASE_METER_ENTITY_DESCRIPTIONS,
HuaweiSolarEntityDescriptionMixin,
get_pv_entity_descriptions,
)
_LOGGER = logging.getLogger(__name__)
T = TypeVar("T")
PLATFORMS: list[Platform] = [Platform.SENSOR]
async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
"""Set up Huawei Solar from a config entry."""
if CONF_SLAVE_IDS not in entry.data:
_LOGGER.info("Migrating %s to new conflayout",
entry.data.get(LEGACY_CONF_SLAVE))
hass.config_entries.async_update_entry(
entry, data={**entry.data, CONF_SLAVE_IDS: [entry.data.get(LEGACY_CONF_SLAVE)]})
try:
inverter = await AsyncHuaweiSolar.create(
host=entry.data[CONF_HOST],
port=entry.data[CONF_PORT],
slave=entry.data[CONF_SLAVE_IDS][0],
)
primary_slave_devices = await _find_slave_devices(
inverter,
slave_id=entry.data[CONF_SLAVE_IDS][0],
connecting_inverter_device_id=None,
)
slave_device_infos = [primary_slave_devices]
inverter_device_info = primary_slave_devices["inverter"]
inverter_device_id = next(iter(inverter_device_info["identifiers"]))
for extra_slave_id in entry.data[CONF_SLAVE_IDS][1:]:
slave_device_infos.append(
await _find_slave_devices(
inverter,
slave_id=extra_slave_id,
connecting_inverter_device_id=inverter_device_id,
)
)
# Now create update coordinators for the detected devices
update_coordinators = []
for device_info in slave_device_infos:
update_coordinators.extend(
await _create_update_coordinators(hass, inverter, device_info)
)
hass.data.setdefault(DOMAIN, {})[entry.entry_id] = {
DATA_MODBUS_CLIENT: inverter,
DATA_SLAVE_IDS: entry.data[CONF_SLAVE_IDS],
DATA_DEVICE_INFOS: slave_device_infos,
DATA_UPDATE_COORDINATORS: update_coordinators,
}
except HuaweiSolarException as err:
raise ConfigEntryNotReady from err
hass.config_entries.async_setup_platforms(entry, PLATFORMS)
return True
async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
"""Unload a config entry."""
if unload_ok := await hass.config_entries.async_unload_platforms(entry, PLATFORMS):
client = hass.data[DOMAIN][entry.entry_id][DATA_MODBUS_CLIENT]
await client.stop()
hass.data[DOMAIN].pop(entry.entry_id)
return unload_ok
class HuaweiInverterSlaveDeviceInfos(TypedDict):
"""Device Infos from a slave."""
# When None, we are using the default slave-id from the inverter that we're directly connected to.
slave_id: int | None
inverter: DeviceInfo
power_meter: DeviceInfo | None
connected_energy_storage: DeviceInfo | None
class HuaweiSolarRegisterUpdateCoordinator(DataUpdateCoordinator):
"""A specialised DataUpdateCoordinator.
It also has information on the entity descriptions of which it has information.
This allows the platforms to discover which entities they should create from
this coordinator during setup.
"""
def __init__(
self,
hass: HomeAssistant,
logger: logging.Logger,
entity_descriptions: list[HuaweiSolarEntityDescriptionMixin],
device_info: DeviceInfo,
slave_id: int | None,
name: str,
update_interval: timedelta | None = None,
update_method: Callable[[], Awaitable[T]] | None = None,
request_refresh_debouncer: Debouncer | None = None,
) -> None:
"""Create a HuaweiSolarRegisterUpdateCoordinator."""
super().__init__(
hass,
logger,
name=name,
update_interval=update_interval,
update_method=update_method,
request_refresh_debouncer=request_refresh_debouncer,
)
self.entity_descriptions = entity_descriptions
self.device_info = device_info
self.slave_id = slave_id
async def _find_slave_devices(
inverter: AsyncHuaweiSolar,
slave_id: int | None,
connecting_inverter_device_id: tuple[str, str] | None,
) -> HuaweiInverterSlaveDeviceInfos:
"""Discover the child devices of this inverter."""
model_name, serial_number = await inverter.get_multiple(
[rn.MODEL_NAME, rn.SERIAL_NUMBER], slave_id
)
current_inverter_unique_id = serial_number.value
if slave_id is not None:
current_inverter_unique_id = f"{current_inverter_unique_id}/{slave_id}"
inverter_device_info = DeviceInfo(
identifiers={(DOMAIN, current_inverter_unique_id)},
name=model_name.value,
manufacturer="Huawei",
model=model_name.value,
via_device=connecting_inverter_device_id, # type: ignore
)
# Add power meter device if a power meter is detected
power_meter_device_info = None
has_power_meter = (
await inverter.get(rn.METER_STATUS, slave_id)
).value == rv.MeterStatus.NORMAL
if has_power_meter:
power_meter_device_info = DeviceInfo(
identifiers={
(DOMAIN, f"{current_inverter_unique_id}/power_meter"),
},
name="Power Meter",
via_device=current_inverter_unique_id, # type: ignore
)
# Add battery device if a battery is detected
battery_device_info = None
has_battery = inverter.battery_type != rv.StorageProductModel.NONE
if has_battery:
battery_device_info = DeviceInfo(
identifiers={
(DOMAIN, f"{current_inverter_unique_id}/connected_energy_storage"),
},
name=f"{inverter_device_info['name']} Connected Energy Storage",
manufacturer=inverter_device_info["manufacturer"],
model=f"{inverter_device_info['model']} Connected Energy Storage",
via_device=current_inverter_unique_id, # type: ignore
)
return HuaweiInverterSlaveDeviceInfos(
slave_id=slave_id,
inverter=inverter_device_info,
power_meter=power_meter_device_info,
connected_energy_storage=battery_device_info,
)
async def _create_update_coordinators(
hass: HomeAssistant,
inverter: AsyncHuaweiSolar,
slave_device_info: HuaweiInverterSlaveDeviceInfos,
) -> list[HuaweiSolarRegisterUpdateCoordinator]:
"""Create the relevant HuaweiSolarRegisterUpdateCoordinator-instances as well."""
update_coordinators = []
slave_id = slave_device_info["slave_id"]
update_coordinators.append(
await _create_update_coordinator(
hass,
inverter,
slave_id,
INVERTER_ENTITY_DESCRIPTIONS,
slave_device_info["inverter"],
"inverter",
INVERTER_UPDATE_INTERVAL,
)
)
pv_string_count = (await inverter.get(rn.NB_PV_STRINGS, slave_id)).value
pv_string_entity_descriptions = []
for idx in range(1, pv_string_count + 1):
pv_string_entity_descriptions.extend(get_pv_entity_descriptions(idx))
update_coordinators.append(
await _create_update_coordinator(
hass,
inverter,
slave_id,
pv_string_entity_descriptions,
slave_device_info["inverter"],
"pv_strings",
INVERTER_UPDATE_INTERVAL,
)
)
if slave_device_info["power_meter"]:
power_meter_type = (await inverter.get(rn.METER_TYPE, slave_id)).value
meter_entity_descriptions = (
THREE_PHASE_METER_ENTITY_DESCRIPTIONS
if power_meter_type == rv.MeterType.THREE_PHASE
else SINGLE_PHASE_METER_ENTITY_DESCRIPTIONS
)
update_coordinators.append(
await _create_update_coordinator(
hass,
inverter,
slave_id,
meter_entity_descriptions,
slave_device_info["power_meter"],
"power_meter",
METER_UPDATE_INTERVAL,
)
)
if slave_device_info["connected_energy_storage"]:
update_coordinators.append(
await _create_update_coordinator(
hass,
inverter,
slave_id,
BATTERY_ENTITY_DESCRIPTIONS,
slave_device_info["connected_energy_storage"],
"battery",
BATTERY_UPDATE_INTERVAL,
)
)
return update_coordinators
async def _create_update_coordinator(
hass,
inverter: AsyncHuaweiSolar,
slave_id,
entity_descriptions,
device_info,
coordinator_name,
update_interval,
):
entity_registers = [descr.key for descr in entity_descriptions]
async def async_update_data():
try:
async with async_timeout.timeout(10):
return dict(
zip(
entity_registers,
await inverter.get_multiple(entity_registers, slave_id),
)
)
except HuaweiSolarException as err:
raise UpdateFailed(
f"Could not update {coordinator_name} values: {err}"
) from err
coordinator = HuaweiSolarRegisterUpdateCoordinator(
hass,
_LOGGER,
entity_descriptions,
device_info,
slave_id,
name=f"{coordinator_name}_sensors{f'/{slave_id}' if slave_id else ''}",
update_method=async_update_data,
update_interval=update_interval,
)
await coordinator.async_config_entry_first_refresh()
return coordinator
def get_device_info_unique_id(device_info: DeviceInfo):
"""Retrieve the value used as the identifier.
Assumes there is only one identifier!
"""
_, value = next(iter(device_info["identifiers"]))
return value