-
Notifications
You must be signed in to change notification settings - Fork 18
/
climate.py
367 lines (324 loc) · 13.7 KB
/
climate.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
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
"""Support for HeishaMon controlled heatpumps through MQTT."""
from __future__ import annotations
import logging
from dataclasses import dataclass
from enum import Enum, Flag, auto
from homeassistant.components import mqtt
from homeassistant.components.mqtt.client import async_publish
from homeassistant.components.climate import ClimateEntity
from homeassistant.components.climate.const import ClimateEntityFeature, HVACMode
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.util import slugify
from homeassistant.components.climate import ClimateEntityDescription
from .definitions import OperatingMode
from . import build_device_info
from .const import DeviceType
_LOGGER = logging.getLogger(__name__)
class ZoneState(Flag):
ZONE1 = auto()
ZONE2 = auto()
@staticmethod
def from_id(id: int) -> ZoneState:
if id == 1:
return ZoneState.ZONE1
elif id == 2:
return ZoneState.ZONE2
else:
raise Exception(f"No zone with id {id}")
def to_mqtt(self) -> str:
return str(
{
ZoneState.ZONE1: 0,
ZoneState.ZONE2: 1,
(ZoneState.ZONE1 | ZoneState.ZONE2): 2,
}[self]
)
@staticmethod
def from_mqtt(value: str) -> ZoneState:
return {
0: ZoneState.ZONE1,
1: ZoneState.ZONE2,
2: (ZoneState.ZONE1 | ZoneState.ZONE2),
}[int(value)]
async def async_setup_entry(
hass: HomeAssistant,
config_entry: ConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
discovery_prefix = config_entry.data[
"discovery_prefix"
] # TODO: handle migration of entities
_LOGGER.debug(
f"Starting bootstrap of climate entities with prefix '{discovery_prefix}'"
)
"""Set up HeishaMon climates from config entry."""
description_zone1 = ZoneClimateEntityDescription(
key=f"{discovery_prefix}main/Z1_Temp",
name="Aquarea Zone 1 climate",
zone_id=1,
)
zone1_climate = HeishaMonZoneClimate(hass, description_zone1, config_entry)
description_zone2 = ZoneClimateEntityDescription(
name="Aquarea Zone 2 climate",
key=f"{discovery_prefix}main/Z2_Temp",
zone_id=2,
)
zone2_climate = HeishaMonZoneClimate(hass, description_zone2, config_entry)
async_add_entities([zone1_climate, zone2_climate])
@dataclass
class ZoneClimateEntityDescription(ClimateEntityDescription):
zone_id: int = 1
# preparing ZoneSensorMode to handle sensor setting per zone (TOP111 and TOP112)
# currently not used as ZoneSensorMode change will result directly in ZoneClimateMode change
class ZoneSensorMode(Enum):
WATER = 0
EXTERNAL = 1
INTERNAL = 2
THERMISTOR = 3
class ZoneClimateMode(Enum):
COMPENSATION = 1
DIRECT = 2
# ZoneTemperatureMode is outcome of ZoneSensorMode and ZoneClimateMode
class ZoneTemperatureMode(Enum):
COMPENSATION = 1 # driving the temp of water by comp curve (-5:5 deg C)
DIRECT = 2 # driving the temp of water directly (20:55 deg C)
ROOM = 3 # ROOM temperature is the driver, you set it directly from 10:30 deg C
NAN = 4 # if external thermostat is choosen you cannot drive the temperature at all
class HeishaMonZoneClimate(ClimateEntity):
"""Representation of a HeishaMon climate entity that is updated via MQTT."""
def __init__(
self,
hass: HomeAssistant,
description: ZoneClimateEntityDescription,
config_entry: ConfigEntry,
) -> None:
"""Initialize the climate entity."""
self.config_entry_entry_id = config_entry.entry_id
self.entity_description = description
self.hass = hass
self.discovery_prefix = config_entry.data[
"discovery_prefix"
] # TODO: handle migration of entities
self.zone_id = description.zone_id
slug = slugify(self.entity_description.key.replace("/", "_"))
self.entity_id = f"climate.{slug}"
self._attr_unique_id = f"{config_entry.entry_id}-{self.zone_id}"
self._attr_temperature_unit = "°C"
self._enable_turn_on_off_backwards_compatibility = False
self._attr_supported_features = ClimateEntityFeature.TARGET_TEMPERATURE | ClimateEntityFeature.TURN_OFF | ClimateEntityFeature.TURN_ON
self._attr_hvac_modes = [HVACMode.HEAT, HVACMode.OFF]
self._attr_hvac_mode = HVACMode.OFF
self._zone_state = ZoneState(0) # i.e None
self._operating_mode = OperatingMode(0) # i.e None
self._sensor_mode = ZoneSensorMode.WATER
self._climate_mode = ZoneClimateMode.DIRECT
self._mode = ZoneTemperatureMode.DIRECT
self.change_mode(ZoneTemperatureMode.DIRECT, initialization=True)
async def async_turn_off(self) -> None:
await self.async_set_hvac_mode(HVACMode.OFF)
async def async_turn_on(self) -> None:
await self.async_set_hvac_mode(HVACMode.HEATING)
def evaluate_temperature_mode(self):
mode = self._mode
if self._sensor_mode == ZoneSensorMode.INTERNAL:
mode = ZoneTemperatureMode.ROOM
elif self._sensor_mode == ZoneSensorMode.THERMISTOR:
mode = ZoneTemperatureMode.ROOM
elif self._sensor_mode == ZoneSensorMode.EXTERNAL:
mode = ZoneTemperatureMode.NAN
elif self._sensor_mode == ZoneSensorMode.WATER:
if self._climate_mode == ZoneClimateMode.DIRECT:
mode = ZoneTemperatureMode.DIRECT
elif self._climate_mode == ZoneClimateMode.COMPENSATION:
mode = ZoneTemperatureMode.COMPENSATION
else:
assert False, f"Unknown combination of Sensor Mode and Climate Mode"
else:
assert False, f"Unknown Sensor Mode"
if mode != self._mode:
self.change_mode(mode)
def change_mode(self, mode: ZoneTemperatureMode, initialization: bool = False):
if self._mode == mode:
_LOGGER.debug(f"Enforcing mode to {mode} for zone {self.zone_id}")
else:
_LOGGER.info(f"Changing mode to {mode} for zone {self.zone_id}")
self._mode = mode
if mode == ZoneTemperatureMode.COMPENSATION:
self._attr_min_temp = -5
self._attr_max_temp = 5
self._attr_target_temperature_step = 1
elif mode == ZoneTemperatureMode.DIRECT:
self._attr_min_temp = 20
self._attr_max_temp = 55
self._attr_target_temperature_step = 1
elif mode == ZoneTemperatureMode.ROOM:
self._attr_min_temp = 10
self._attr_max_temp = 30
self._attr_target_temperature_step = 1
# else: # mode == ZoneTemperatureMode.NAN
# TODO: disable widget as external thermostat is driving
if not initialization:
# during initialization we cannot write HA state because entities are not registered yet.
# Otherwise it triggers https://github.com/kamaradclimber/heishamon-homeassistant/issues/47
self.async_write_ha_state()
async def async_set_temperature(self, **kwargs) -> None:
temperature = kwargs.get("temperature")
if self._mode == ZoneTemperatureMode.COMPENSATION:
_LOGGER.info(
f"Changing {self.name} temperature offset to {temperature} for zone {self.zone_id}"
)
elif self._mode == ZoneTemperatureMode.DIRECT:
_LOGGER.info(
f"Changing {self.name} target temperature to {temperature} for zone {self.zone_id}"
)
elif self._mode == ZoneTemperatureMode.ROOM:
_LOGGER.info(
f"Changing {self.name} target room temperature to {temperature} for zone {self.zone_id}"
)
else:
raise Exception(f"Unknown climate mode: {self._mode}")
payload = str(temperature)
_LOGGER.debug(
f"sending {payload} as temperature command for zone {self.zone_id}"
)
await async_publish(
self.hass,
f"{self.discovery_prefix}commands/SetZ{self.zone_id}HeatRequestTemperature",
payload,
0,
False,
"utf-8",
)
async def async_added_to_hass(self) -> None:
"""Subscribe to MQTT events."""
async def async_added_to_hass(self) -> None:
"""Subscribe to MQTT events."""
# per zone handle of sensory type to drive mode of operation
@callback
def sensor_mode_received(message):
mode = self._mode
try:
sensor_mode = ZoneSensorMode(int(message.payload))
except ValueError:
_LOGGER.error(f"Sensor mode value {message.payload} is not a valid value")
assert False
if sensor_mode != self._sensor_mode: # if sensor mode was changed
self._sensor_mode = sensor_mode # updated it
self.evaluate_temperature_mode() # and trigger temp eval
await mqtt.async_subscribe(
self.hass,
f"{self.discovery_prefix}main/Z{self.zone_id}_Sensor_Settings",
sensor_mode_received,
1,
)
@callback
def mode_received(message):
if message.payload == "0":
climate_mode = ZoneClimateMode.COMPENSATION
elif message.payload == "1":
climate_mode = ZoneClimateMode.DIRECT
else:
assert False, f"Climate Mode received is not a known value"
if climate_mode != self._climate_mode: # if climate mode was changed
self._climate_mode = climate_mode # updated it
self.evaluate_temperature_mode() # and trigger temp eval
await mqtt.async_subscribe(
self.hass,
f"{self.discovery_prefix}main/Heating_Mode",
mode_received,
1,
)
@callback
def current_temperature_message_received(message):
self._attr_current_temperature = float(message.payload)
self.async_write_ha_state()
await mqtt.async_subscribe(
self.hass,
f"{self.discovery_prefix}main/Z{self.zone_id}_Temp",
current_temperature_message_received,
1,
)
@callback
def target_temperature_message_received(message):
self._attr_target_temperature = float(message.payload)
_LOGGER.debug(
f"Received target temperature for {self.zone_id}: {self._attr_target_temperature}"
)
self.async_write_ha_state()
await mqtt.async_subscribe(
self.hass,
f"{self.discovery_prefix}main/Z{self.zone_id}_Heat_Request_Temp",
target_temperature_message_received,
1,
)
def guess_hvac_mode() -> HVACMode:
global_heating = OperatingMode.HEAT in self._operating_mode
zone_heating = ZoneState.from_id(self.zone_id) in self._zone_state
if global_heating and zone_heating:
return HVACMode.HEAT
else:
return HVACMode.OFF
@callback
def heating_conf_message_received(message):
if message.topic == f"{self.discovery_prefix}main/Zones_State":
self._zone_state = ZoneState.from_mqtt(message.payload)
elif message.topic == f"{self.discovery_prefix}main/Operating_Mode_State":
self._operating_mode = OperatingMode.from_mqtt(message.payload)
self._attr_hvac_mode = guess_hvac_mode()
self.async_write_ha_state()
await mqtt.async_subscribe(
self.hass,
f"{self.discovery_prefix}main/Zones_State",
heating_conf_message_received,
1,
)
await mqtt.async_subscribe(
self.hass,
f"{self.discovery_prefix}main/Operating_Mode_State",
heating_conf_message_received,
1,
)
async def async_set_hvac_mode(self, hvac_mode: HVACMode) -> None:
if hvac_mode == HVACMode.HEAT:
new_zone_state = self._zone_state | ZoneState.from_id(self.zone_id)
new_operating_mode = self._operating_mode | OperatingMode.HEAT
elif hvac_mode == HVACMode.OFF:
new_zone_state = self._zone_state & ~ZoneState.from_id(self.zone_id)
new_operating_mode = self._operating_mode
if new_zone_state == ZoneState(0):
new_operating_mode = self._operating_mode & ~OperatingMode.HEAT
else:
raise NotImplemented(
f"Mode {hvac_mode} has not been implemented by this entity"
)
if new_operating_mode != self._operating_mode:
_LOGGER.debug(
f"Setting operation mode {new_operating_mode} for zone {self.zone_id}"
)
await async_publish(
self.hass,
f"{self.discovery_prefix}commands/SetOperationMode",
new_operating_mode.to_mqtt(),
0,
False,
"utf-8",
)
if new_zone_state not in [self._zone_state, ZoneState(0)]:
_LOGGER.debug(
f"Setting operation mode {new_zone_state} for zone {self.zone_id}"
)
await async_publish(
self.hass,
f"{self.discovery_prefix}commands/SetZones",
new_zone_state.to_mqtt(),
0,
False,
"utf-8",
)
self._attr_hvac_mode = hvac_mode # let's be optimistic
self.async_write_ha_state()
@property
def device_info(self):
return build_device_info(DeviceType.HEATPUMP, self.discovery_prefix)