@@ -1,52 +1,29 @@
|
|
1 |
"""Plugwise platform for Home Assistant Core."""
|
|
|
2 |
from __future__ import annotations
|
3 |
|
4 |
from typing import Any
|
5 |
|
6 |
-
from plugwise.exceptions import PlugwiseError
|
7 |
-
import voluptuous as vol
|
8 |
-
|
9 |
from homeassistant.config_entries import ConfigEntry
|
10 |
from homeassistant.const import Platform
|
11 |
-
from homeassistant.core import HomeAssistant,
|
12 |
from homeassistant.helpers import device_registry as dr, entity_registry as er
|
13 |
|
14 |
-
from .const import
|
15 |
-
CONF_REFRESH_INTERVAL, # pw-beta options
|
16 |
-
COORDINATOR,
|
17 |
-
DOMAIN,
|
18 |
-
LOGGER,
|
19 |
-
PLATFORMS,
|
20 |
-
SERVICE_DELETE,
|
21 |
-
UNDO_UPDATE_LISTENER,
|
22 |
-
)
|
23 |
from .coordinator import PlugwiseDataUpdateCoordinator
|
24 |
|
|
|
|
|
25 |
|
26 |
-
async def async_setup_entry(hass: HomeAssistant, entry:
|
27 |
-
"""Set up
|
28 |
await er.async_migrate_entries(hass, entry.entry_id, async_migrate_entity_entry)
|
29 |
|
30 |
-
|
31 |
-
if (
|
32 |
-
custom_refresh := entry.options.get(CONF_REFRESH_INTERVAL)
|
33 |
-
) is not None: # pragma: no cover
|
34 |
-
cooldown = custom_refresh
|
35 |
-
LOGGER.debug("DUC cooldown interval: %s", cooldown)
|
36 |
-
|
37 |
-
coordinator = PlugwiseDataUpdateCoordinator(
|
38 |
-
hass, entry, cooldown
|
39 |
-
) # pw-beta - cooldown, update_interval as extra
|
40 |
await coordinator.async_config_entry_first_refresh()
|
41 |
-
# Migrate a changed sensor unique_id
|
42 |
migrate_sensor_entities(hass, coordinator)
|
43 |
|
44 |
-
|
45 |
-
|
46 |
-
hass.data.setdefault(DOMAIN, {})[entry.entry_id] = {
|
47 |
-
COORDINATOR: coordinator, # pw-beta
|
48 |
-
UNDO_UPDATE_LISTENER: undo_listener, # pw-beta
|
49 |
-
}
|
50 |
|
51 |
device_registry = dr.async_get(hass)
|
52 |
device_registry.async_get_or_create(
|
@@ -54,66 +31,43 @@
|
|
54 |
identifiers={(DOMAIN, str(coordinator.api.gateway_id))},
|
55 |
manufacturer="Plugwise",
|
56 |
model=coordinator.api.smile_model,
|
|
|
57 |
name=coordinator.api.smile_name,
|
58 |
-
sw_version=coordinator.api.smile_version
|
59 |
-
)
|
60 |
-
|
61 |
-
async def delete_notification(
|
62 |
-
call: ServiceCall,
|
63 |
-
) -> None: # pragma: no cover # pw-beta: HA service - delete_notification
|
64 |
-
"""Service: delete the Plugwise Notification."""
|
65 |
-
LOGGER.debug(
|
66 |
-
"Service delete PW Notification called for %s",
|
67 |
-
coordinator.api.smile_name,
|
68 |
-
)
|
69 |
-
try:
|
70 |
-
await coordinator.api.delete_notification()
|
71 |
-
LOGGER.debug("PW Notification deleted")
|
72 |
-
except PlugwiseError:
|
73 |
-
LOGGER.debug(
|
74 |
-
"Failed to delete the Plugwise Notification for %s",
|
75 |
-
coordinator.api.smile_name,
|
76 |
-
)
|
77 |
|
78 |
await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
|
79 |
|
80 |
-
for component in PLATFORMS: # pw-beta
|
81 |
-
if component == Platform.BINARY_SENSOR:
|
82 |
-
hass.services.async_register(
|
83 |
-
DOMAIN, SERVICE_DELETE, delete_notification, schema=vol.Schema({})
|
84 |
-
)
|
85 |
-
|
86 |
return True
|
87 |
|
88 |
|
89 |
-
async def
|
90 |
-
|
91 |
-
|
92 |
-
"""Handle options update."""
|
93 |
-
await hass.config_entries.async_reload(entry.entry_id)
|
94 |
-
|
95 |
-
|
96 |
-
async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
|
97 |
-
"""Unload a config entry."""
|
98 |
-
if unload_ok := await hass.config_entries.async_unload_platforms(entry, PLATFORMS):
|
99 |
-
hass.data[DOMAIN].pop(entry.entry_id)
|
100 |
-
return unload_ok
|
101 |
|
102 |
|
103 |
@callback
|
104 |
def async_migrate_entity_entry(entry: er.RegistryEntry) -> dict[str, Any] | None:
|
105 |
"""Migrate Plugwise entity entries.
|
106 |
|
107 |
-
- Migrates unique ID from old
|
108 |
"""
|
109 |
-
if entry.domain == Platform.
|
110 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
111 |
if entry.domain == Platform.SENSOR and entry.unique_id.endswith(
|
112 |
"-relative_humidity"
|
113 |
):
|
114 |
return {
|
115 |
"new_unique_id": entry.unique_id.replace("-relative_humidity", "-humidity")
|
116 |
}
|
|
|
|
|
117 |
|
118 |
# No migration needed
|
119 |
return None
|
@@ -126,10 +80,10 @@
|
|
126 |
"""Migrate Sensors if needed."""
|
127 |
ent_reg = er.async_get(hass)
|
128 |
|
129 |
-
#
|
130 |
# to opentherm_outdoor_air_temperature sensor
|
131 |
for device_id, device in coordinator.data.devices.items():
|
132 |
-
if device["dev_class"] != "heater_central":
|
133 |
continue
|
134 |
|
135 |
old_unique_id = f"{device_id}-outdoor_temperature"
|
@@ -137,4 +91,10 @@
|
|
137 |
Platform.SENSOR, DOMAIN, old_unique_id
|
138 |
):
|
139 |
new_unique_id = f"{device_id}-outdoor_air_temperature"
|
|
|
|
|
|
|
|
|
|
|
|
|
140 |
ent_reg.async_update_entity(entity_id, new_unique_id=new_unique_id)
|
|
|
1 |
"""Plugwise platform for Home Assistant Core."""
|
2 |
+
|
3 |
from __future__ import annotations
|
4 |
|
5 |
from typing import Any
|
6 |
|
|
|
|
|
|
|
7 |
from homeassistant.config_entries import ConfigEntry
|
8 |
from homeassistant.const import Platform
|
9 |
+
from homeassistant.core import HomeAssistant, callback
|
10 |
from homeassistant.helpers import device_registry as dr, entity_registry as er
|
11 |
|
12 |
+
from .const import DOMAIN, LOGGER, PLATFORMS
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
13 |
from .coordinator import PlugwiseDataUpdateCoordinator
|
14 |
|
15 |
+
type PlugwiseConfigEntry = ConfigEntry[PlugwiseDataUpdateCoordinator]
|
16 |
+
|
17 |
|
18 |
+
async def async_setup_entry(hass: HomeAssistant, entry: PlugwiseConfigEntry) -> bool:
|
19 |
+
"""Set up Plugwise components from a config entry."""
|
20 |
await er.async_migrate_entries(hass, entry.entry_id, async_migrate_entity_entry)
|
21 |
|
22 |
+
coordinator = PlugwiseDataUpdateCoordinator(hass)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
23 |
await coordinator.async_config_entry_first_refresh()
|
|
|
24 |
migrate_sensor_entities(hass, coordinator)
|
25 |
|
26 |
+
entry.runtime_data = coordinator
|
|
|
|
|
|
|
|
|
|
|
27 |
|
28 |
device_registry = dr.async_get(hass)
|
29 |
device_registry.async_get_or_create(
|
|
|
31 |
identifiers={(DOMAIN, str(coordinator.api.gateway_id))},
|
32 |
manufacturer="Plugwise",
|
33 |
model=coordinator.api.smile_model,
|
34 |
+
model_id=coordinator.api.smile_model_id,
|
35 |
name=coordinator.api.smile_name,
|
36 |
+
sw_version=str(coordinator.api.smile_version),
|
37 |
+
) # required for adding the entity-less P1 Gateway
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
38 |
|
39 |
await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
|
40 |
|
|
|
|
|
|
|
|
|
|
|
|
|
41 |
return True
|
42 |
|
43 |
|
44 |
+
async def async_unload_entry(hass: HomeAssistant, entry: PlugwiseConfigEntry) -> bool:
|
45 |
+
"""Unload the Plugwise components."""
|
46 |
+
return await hass.config_entries.async_unload_platforms(entry, PLATFORMS)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
47 |
|
48 |
|
49 |
@callback
|
50 |
def async_migrate_entity_entry(entry: er.RegistryEntry) -> dict[str, Any] | None:
|
51 |
"""Migrate Plugwise entity entries.
|
52 |
|
53 |
+
- Migrates old unique ID's from old binary_sensors and switches to the new unique ID's
|
54 |
"""
|
55 |
+
if entry.domain == Platform.BINARY_SENSOR and entry.unique_id.endswith(
|
56 |
+
"-slave_boiler_state"
|
57 |
+
):
|
58 |
+
return {
|
59 |
+
"new_unique_id": entry.unique_id.replace(
|
60 |
+
"-slave_boiler_state", "-secondary_boiler_state"
|
61 |
+
)
|
62 |
+
}
|
63 |
if entry.domain == Platform.SENSOR and entry.unique_id.endswith(
|
64 |
"-relative_humidity"
|
65 |
):
|
66 |
return {
|
67 |
"new_unique_id": entry.unique_id.replace("-relative_humidity", "-humidity")
|
68 |
}
|
69 |
+
if entry.domain == Platform.SWITCH and entry.unique_id.endswith("-plug"):
|
70 |
+
return {"new_unique_id": entry.unique_id.replace("-plug", "-relay")}
|
71 |
|
72 |
# No migration needed
|
73 |
return None
|
|
|
80 |
"""Migrate Sensors if needed."""
|
81 |
ent_reg = er.async_get(hass)
|
82 |
|
83 |
+
# Migrating opentherm_outdoor_temperature
|
84 |
# to opentherm_outdoor_air_temperature sensor
|
85 |
for device_id, device in coordinator.data.devices.items():
|
86 |
+
if device["dev_class"] != "heater_central":
|
87 |
continue
|
88 |
|
89 |
old_unique_id = f"{device_id}-outdoor_temperature"
|
|
|
91 |
Platform.SENSOR, DOMAIN, old_unique_id
|
92 |
):
|
93 |
new_unique_id = f"{device_id}-outdoor_air_temperature"
|
94 |
+
LOGGER.debug(
|
95 |
+
"Migrating entity %s from old unique ID '%s' to new unique ID '%s'",
|
96 |
+
entity_id,
|
97 |
+
old_unique_id,
|
98 |
+
new_unique_id,
|
99 |
+
)
|
100 |
ent_reg.async_update_entity(entity_id, new_unique_id=new_unique_id)
|
@@ -1,4 +1,5 @@
|
|
1 |
"""Plugwise Binary Sensor component for Home Assistant."""
|
|
|
2 |
from __future__ import annotations
|
3 |
|
4 |
from collections.abc import Mapping
|
@@ -8,88 +9,75 @@
|
|
8 |
from plugwise.constants import BinarySensorType
|
9 |
|
10 |
from homeassistant.components.binary_sensor import (
|
|
|
11 |
BinarySensorEntity,
|
12 |
BinarySensorEntityDescription,
|
13 |
)
|
14 |
-
from homeassistant.config_entries import ConfigEntry
|
15 |
from homeassistant.const import EntityCategory
|
16 |
-
from homeassistant.core import HomeAssistant
|
17 |
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
18 |
|
19 |
-
from .
|
20 |
-
COORDINATOR, # pw-beta
|
21 |
-
DOMAIN,
|
22 |
-
LOGGER,
|
23 |
-
SEVERITIES,
|
24 |
-
)
|
25 |
from .coordinator import PlugwiseDataUpdateCoordinator
|
26 |
from .entity import PlugwiseEntity
|
27 |
|
|
|
|
|
|
|
28 |
PARALLEL_UPDATES = 0
|
29 |
|
30 |
|
31 |
-
@dataclass
|
32 |
class PlugwiseBinarySensorEntityDescription(BinarySensorEntityDescription):
|
33 |
"""Describes a Plugwise binary sensor entity."""
|
34 |
|
35 |
key: BinarySensorType
|
36 |
-
icon_off: str | None = None
|
37 |
|
38 |
|
39 |
BINARY_SENSORS: tuple[PlugwiseBinarySensorEntityDescription, ...] = (
|
40 |
PlugwiseBinarySensorEntityDescription(
|
|
|
|
|
|
|
|
|
|
|
41 |
key="compressor_state",
|
42 |
translation_key="compressor_state",
|
43 |
-
icon="mdi:hvac",
|
44 |
-
icon_off="mdi:hvac-off",
|
45 |
entity_category=EntityCategory.DIAGNOSTIC,
|
46 |
),
|
47 |
PlugwiseBinarySensorEntityDescription(
|
48 |
key="cooling_enabled",
|
49 |
translation_key="cooling_enabled",
|
50 |
-
icon="mdi:snowflake-thermometer",
|
51 |
entity_category=EntityCategory.DIAGNOSTIC,
|
52 |
),
|
53 |
PlugwiseBinarySensorEntityDescription(
|
54 |
key="dhw_state",
|
55 |
translation_key="dhw_state",
|
56 |
-
icon="mdi:water-pump",
|
57 |
-
icon_off="mdi:water-pump-off",
|
58 |
entity_category=EntityCategory.DIAGNOSTIC,
|
59 |
),
|
60 |
PlugwiseBinarySensorEntityDescription(
|
61 |
key="flame_state",
|
62 |
translation_key="flame_state",
|
63 |
-
icon="mdi:fire",
|
64 |
-
icon_off="mdi:fire-off",
|
65 |
entity_category=EntityCategory.DIAGNOSTIC,
|
66 |
),
|
67 |
PlugwiseBinarySensorEntityDescription(
|
68 |
key="heating_state",
|
69 |
translation_key="heating_state",
|
70 |
-
icon="mdi:radiator",
|
71 |
-
icon_off="mdi:radiator-off",
|
72 |
entity_category=EntityCategory.DIAGNOSTIC,
|
73 |
),
|
74 |
PlugwiseBinarySensorEntityDescription(
|
75 |
key="cooling_state",
|
76 |
translation_key="cooling_state",
|
77 |
-
icon="mdi:snowflake",
|
78 |
-
icon_off="mdi:snowflake-off",
|
79 |
entity_category=EntityCategory.DIAGNOSTIC,
|
80 |
),
|
81 |
PlugwiseBinarySensorEntityDescription(
|
82 |
-
key="
|
83 |
-
translation_key="
|
84 |
-
icon="mdi:fire",
|
85 |
-
icon_off="mdi:circle-off-outline",
|
86 |
entity_category=EntityCategory.DIAGNOSTIC,
|
87 |
),
|
88 |
PlugwiseBinarySensorEntityDescription(
|
89 |
key="plugwise_notification",
|
90 |
translation_key="plugwise_notification",
|
91 |
-
icon="mdi:mailbox-up-outline",
|
92 |
-
icon_off="mdi:mailbox-outline",
|
93 |
entity_category=EntityCategory.DIAGNOSTIC,
|
94 |
),
|
95 |
)
|
@@ -97,33 +85,32 @@
|
|
97 |
|
98 |
async def async_setup_entry(
|
99 |
hass: HomeAssistant,
|
100 |
-
|
101 |
async_add_entities: AddEntitiesCallback,
|
102 |
) -> None:
|
103 |
-
"""Set up the
|
104 |
-
coordinator
|
105 |
-
|
106 |
-
|
107 |
-
|
108 |
-
|
109 |
-
|
110 |
-
|
111 |
-
|
112 |
-
|
113 |
-
|
114 |
-
|
115 |
-
|
116 |
-
|
117 |
-
|
118 |
-
device_id,
|
119 |
-
description,
|
120 |
)
|
121 |
)
|
122 |
-
|
123 |
-
|
124 |
-
|
125 |
|
126 |
-
|
|
|
127 |
|
128 |
|
129 |
class PlugwiseBinarySensorEntity(PlugwiseEntity, BinarySensorEntity):
|
@@ -141,53 +128,25 @@
|
|
141 |
super().__init__(coordinator, device_id)
|
142 |
self.entity_description = description
|
143 |
self._attr_unique_id = f"{device_id}-{description.key}"
|
144 |
-
self._notification: dict[str, str] = {} # pw-beta
|
145 |
|
146 |
@property
|
147 |
def is_on(self) -> bool:
|
148 |
"""Return true if the binary sensor is on."""
|
149 |
-
# pw-beta: show Plugwise notifications as HA persistent notifications
|
150 |
-
if self._notification:
|
151 |
-
for notify_id, message in self._notification.items():
|
152 |
-
self.hass.components.persistent_notification.async_create(
|
153 |
-
message, "Plugwise Notification:", f"{DOMAIN}.{notify_id}"
|
154 |
-
)
|
155 |
-
|
156 |
-
# return self.device["binary_sensors"][self.entity_description.key] # type: ignore [literal-required]
|
157 |
return self.device["binary_sensors"][self.entity_description.key]
|
158 |
|
159 |
@property
|
160 |
-
def icon(self) -> str | None:
|
161 |
-
"""Return the icon to use in the frontend, if any."""
|
162 |
-
if (icon_off := self.entity_description.icon_off) and self.is_on is False:
|
163 |
-
return icon_off
|
164 |
-
return self.entity_description.icon
|
165 |
-
|
166 |
-
@property
|
167 |
def extra_state_attributes(self) -> Mapping[str, Any] | None:
|
168 |
"""Return entity specific state attributes."""
|
169 |
if self.entity_description.key != "plugwise_notification":
|
170 |
return None
|
171 |
|
172 |
-
|
173 |
-
# not all severities including those without content as empty lists
|
174 |
-
attrs: dict[str, list[str]] = {} # pw-beta Re-evaluate against Core
|
175 |
-
self._notification = {} # pw-beta
|
176 |
if notify := self.coordinator.data.gateway["notifications"]:
|
177 |
-
for
|
178 |
for msg_type, msg in details.items():
|
179 |
msg_type = msg_type.lower()
|
180 |
if msg_type not in SEVERITIES:
|
181 |
-
msg_type = "other"
|
182 |
-
|
183 |
-
if (
|
184 |
-
f"{msg_type}_msg" not in attrs
|
185 |
-
): # pw-beta Re-evaluate against Core
|
186 |
-
attrs[f"{msg_type}_msg"] = []
|
187 |
attrs[f"{msg_type}_msg"].append(msg)
|
188 |
|
189 |
-
self._notification[
|
190 |
-
notify_id
|
191 |
-
] = f"{msg_type.title()}: {msg}" # pw-beta
|
192 |
-
|
193 |
return attrs
|
|
|
1 |
"""Plugwise Binary Sensor component for Home Assistant."""
|
2 |
+
|
3 |
from __future__ import annotations
|
4 |
|
5 |
from collections.abc import Mapping
|
|
|
9 |
from plugwise.constants import BinarySensorType
|
10 |
|
11 |
from homeassistant.components.binary_sensor import (
|
12 |
+
BinarySensorDeviceClass,
|
13 |
BinarySensorEntity,
|
14 |
BinarySensorEntityDescription,
|
15 |
)
|
|
|
16 |
from homeassistant.const import EntityCategory
|
17 |
+
from homeassistant.core import HomeAssistant, callback
|
18 |
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
19 |
|
20 |
+
from . import PlugwiseConfigEntry
|
|
|
|
|
|
|
|
|
|
|
21 |
from .coordinator import PlugwiseDataUpdateCoordinator
|
22 |
from .entity import PlugwiseEntity
|
23 |
|
24 |
+
SEVERITIES = ["other", "info", "warning", "error"]
|
25 |
+
|
26 |
+
# Coordinator is used to centralize the data updates
|
27 |
PARALLEL_UPDATES = 0
|
28 |
|
29 |
|
30 |
+
@dataclass(frozen=True)
|
31 |
class PlugwiseBinarySensorEntityDescription(BinarySensorEntityDescription):
|
32 |
"""Describes a Plugwise binary sensor entity."""
|
33 |
|
34 |
key: BinarySensorType
|
|
|
35 |
|
36 |
|
37 |
BINARY_SENSORS: tuple[PlugwiseBinarySensorEntityDescription, ...] = (
|
38 |
PlugwiseBinarySensorEntityDescription(
|
39 |
+
key="low_battery",
|
40 |
+
device_class=BinarySensorDeviceClass.BATTERY,
|
41 |
+
entity_category=EntityCategory.DIAGNOSTIC,
|
42 |
+
),
|
43 |
+
PlugwiseBinarySensorEntityDescription(
|
44 |
key="compressor_state",
|
45 |
translation_key="compressor_state",
|
|
|
|
|
46 |
entity_category=EntityCategory.DIAGNOSTIC,
|
47 |
),
|
48 |
PlugwiseBinarySensorEntityDescription(
|
49 |
key="cooling_enabled",
|
50 |
translation_key="cooling_enabled",
|
|
|
51 |
entity_category=EntityCategory.DIAGNOSTIC,
|
52 |
),
|
53 |
PlugwiseBinarySensorEntityDescription(
|
54 |
key="dhw_state",
|
55 |
translation_key="dhw_state",
|
|
|
|
|
56 |
entity_category=EntityCategory.DIAGNOSTIC,
|
57 |
),
|
58 |
PlugwiseBinarySensorEntityDescription(
|
59 |
key="flame_state",
|
60 |
translation_key="flame_state",
|
|
|
|
|
61 |
entity_category=EntityCategory.DIAGNOSTIC,
|
62 |
),
|
63 |
PlugwiseBinarySensorEntityDescription(
|
64 |
key="heating_state",
|
65 |
translation_key="heating_state",
|
|
|
|
|
66 |
entity_category=EntityCategory.DIAGNOSTIC,
|
67 |
),
|
68 |
PlugwiseBinarySensorEntityDescription(
|
69 |
key="cooling_state",
|
70 |
translation_key="cooling_state",
|
|
|
|
|
71 |
entity_category=EntityCategory.DIAGNOSTIC,
|
72 |
),
|
73 |
PlugwiseBinarySensorEntityDescription(
|
74 |
+
key="secondary_boiler_state",
|
75 |
+
translation_key="secondary_boiler_state",
|
|
|
|
|
76 |
entity_category=EntityCategory.DIAGNOSTIC,
|
77 |
),
|
78 |
PlugwiseBinarySensorEntityDescription(
|
79 |
key="plugwise_notification",
|
80 |
translation_key="plugwise_notification",
|
|
|
|
|
81 |
entity_category=EntityCategory.DIAGNOSTIC,
|
82 |
),
|
83 |
)
|
|
|
85 |
|
86 |
async def async_setup_entry(
|
87 |
hass: HomeAssistant,
|
88 |
+
entry: PlugwiseConfigEntry,
|
89 |
async_add_entities: AddEntitiesCallback,
|
90 |
) -> None:
|
91 |
+
"""Set up the Smile binary_sensors from a config entry."""
|
92 |
+
coordinator = entry.runtime_data
|
93 |
+
|
94 |
+
@callback
|
95 |
+
def _add_entities() -> None:
|
96 |
+
"""Add Entities."""
|
97 |
+
if not coordinator.new_devices:
|
98 |
+
return
|
99 |
+
|
100 |
+
async_add_entities(
|
101 |
+
PlugwiseBinarySensorEntity(coordinator, device_id, description)
|
102 |
+
for device_id in coordinator.new_devices
|
103 |
+
if (
|
104 |
+
binary_sensors := coordinator.data.devices[device_id].get(
|
105 |
+
"binary_sensors"
|
|
|
|
|
106 |
)
|
107 |
)
|
108 |
+
for description in BINARY_SENSORS
|
109 |
+
if description.key in binary_sensors
|
110 |
+
)
|
111 |
|
112 |
+
_add_entities()
|
113 |
+
entry.async_on_unload(coordinator.async_add_listener(_add_entities))
|
114 |
|
115 |
|
116 |
class PlugwiseBinarySensorEntity(PlugwiseEntity, BinarySensorEntity):
|
|
|
128 |
super().__init__(coordinator, device_id)
|
129 |
self.entity_description = description
|
130 |
self._attr_unique_id = f"{device_id}-{description.key}"
|
|
|
131 |
|
132 |
@property
|
133 |
def is_on(self) -> bool:
|
134 |
"""Return true if the binary sensor is on."""
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
135 |
return self.device["binary_sensors"][self.entity_description.key]
|
136 |
|
137 |
@property
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
138 |
def extra_state_attributes(self) -> Mapping[str, Any] | None:
|
139 |
"""Return entity specific state attributes."""
|
140 |
if self.entity_description.key != "plugwise_notification":
|
141 |
return None
|
142 |
|
143 |
+
attrs: dict[str, list[str]] = {f"{severity}_msg": [] for severity in SEVERITIES}
|
|
|
|
|
|
|
144 |
if notify := self.coordinator.data.gateway["notifications"]:
|
145 |
+
for details in notify.values():
|
146 |
for msg_type, msg in details.items():
|
147 |
msg_type = msg_type.lower()
|
148 |
if msg_type not in SEVERITIES:
|
149 |
+
msg_type = "other"
|
|
|
|
|
|
|
|
|
|
|
150 |
attrs[f"{msg_type}_msg"].append(msg)
|
151 |
|
|
|
|
|
|
|
|
|
152 |
return attrs
|
@@ -1,4 +1,5 @@
|
|
1 |
"""Plugwise Climate component for Home Assistant."""
|
|
|
2 |
from __future__ import annotations
|
3 |
|
4 |
from typing import Any
|
@@ -12,97 +13,99 @@
|
|
12 |
HVACAction,
|
13 |
HVACMode,
|
14 |
)
|
15 |
-
from homeassistant.components.climate.const import (
|
16 |
-
PRESET_AWAY, # pw-beta homekit emulation
|
17 |
-
PRESET_HOME, # pw-beta homekit emulation
|
18 |
-
)
|
19 |
-
from homeassistant.config_entries import ConfigEntry
|
20 |
from homeassistant.const import ATTR_TEMPERATURE, UnitOfTemperature
|
21 |
-
from homeassistant.core import HomeAssistant
|
22 |
-
from homeassistant.exceptions import
|
23 |
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
24 |
|
25 |
-
from .
|
26 |
-
|
27 |
-
COORDINATOR, # pw-beta
|
28 |
-
DOMAIN,
|
29 |
-
MASTER_THERMOSTATS,
|
30 |
-
)
|
31 |
from .coordinator import PlugwiseDataUpdateCoordinator
|
32 |
from .entity import PlugwiseEntity
|
33 |
from .util import plugwise_command
|
34 |
|
|
|
|
|
35 |
|
36 |
async def async_setup_entry(
|
37 |
hass: HomeAssistant,
|
38 |
-
|
39 |
async_add_entities: AddEntitiesCallback,
|
40 |
) -> None:
|
41 |
"""Set up the Smile Thermostats from a config entry."""
|
42 |
-
coordinator
|
43 |
-
|
44 |
-
|
45 |
-
|
46 |
-
|
47 |
-
|
48 |
-
|
49 |
-
|
50 |
-
|
51 |
-
|
52 |
-
|
53 |
-
|
54 |
-
|
55 |
-
|
56 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
57 |
|
58 |
|
59 |
class PlugwiseClimateEntity(PlugwiseEntity, ClimateEntity):
|
60 |
"""Representation of a Plugwise thermostat."""
|
61 |
|
62 |
-
_attr_has_entity_name = True
|
63 |
_attr_name = None
|
64 |
_attr_temperature_unit = UnitOfTemperature.CELSIUS
|
65 |
_attr_translation_key = DOMAIN
|
66 |
|
67 |
-
_homekit_mode: str | None = None # pw-beta homekit emulation
|
68 |
_previous_mode: str = "heating"
|
69 |
|
70 |
def __init__(
|
71 |
self,
|
72 |
coordinator: PlugwiseDataUpdateCoordinator,
|
73 |
device_id: str,
|
74 |
-
homekit_enabled: bool, # pw-beta homekit emulation
|
75 |
) -> None:
|
76 |
"""Set up the Plugwise API."""
|
77 |
super().__init__(coordinator, device_id)
|
78 |
-
|
79 |
-
self._attr_max_temp = self.device["thermostat"]["upper_bound"]
|
80 |
-
self._attr_min_temp = self.device["thermostat"]["lower_bound"]
|
81 |
-
# Ensure we don't drop below 0.1
|
82 |
-
self._attr_target_temperature_step = max(
|
83 |
-
self.device["thermostat"]["resolution"], 0.1
|
84 |
-
)
|
85 |
self._attr_unique_id = f"{device_id}-climate"
|
86 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
87 |
# Determine supported features
|
88 |
-
self.cdr_gateway = coordinator.data.gateway
|
89 |
self._attr_supported_features = ClimateEntityFeature.TARGET_TEMPERATURE
|
90 |
-
if
|
91 |
-
self.cdr_gateway["cooling_present"]
|
92 |
-
and self.cdr_gateway["smile_name"] != "Adam"
|
93 |
-
):
|
94 |
self._attr_supported_features = (
|
95 |
ClimateEntityFeature.TARGET_TEMPERATURE_RANGE
|
96 |
)
|
|
|
|
|
|
|
|
|
97 |
if presets := self.device.get("preset_modes"):
|
98 |
self._attr_supported_features |= ClimateEntityFeature.PRESET_MODE
|
99 |
self._attr_preset_modes = presets
|
100 |
|
101 |
-
|
102 |
-
self.
|
103 |
-
|
104 |
-
self.
|
105 |
-
|
|
|
106 |
|
107 |
def _previous_action_mode(self, coordinator: PlugwiseDataUpdateCoordinator) -> None:
|
108 |
"""Return the previous action-mode when the regulation-mode is not heating or cooling.
|
@@ -111,10 +114,10 @@
|
|
111 |
"""
|
112 |
# When no cooling available, _previous_mode is always heating
|
113 |
if (
|
114 |
-
"regulation_modes" in self.
|
115 |
-
and "cooling" in self.
|
116 |
):
|
117 |
-
mode = self.
|
118 |
if mode in ("cooling", "heating"):
|
119 |
self._previous_mode = mode
|
120 |
|
@@ -152,33 +155,26 @@
|
|
152 |
def hvac_mode(self) -> HVACMode:
|
153 |
"""Return HVAC operation ie. auto, cool, heat, heat_cool, or off mode."""
|
154 |
if (
|
155 |
-
mode := self.device
|
156 |
-
) is None or mode not in self.hvac_modes:
|
157 |
-
return HVACMode.HEAT
|
158 |
-
# pw-beta homekit emulation
|
159 |
-
if self._homekit_enabled and self._homekit_mode == HVACMode.OFF:
|
160 |
-
mode = HVACMode.OFF # pragma: no cover
|
161 |
-
|
162 |
return HVACMode(mode)
|
163 |
|
164 |
@property
|
165 |
def hvac_modes(self) -> list[HVACMode]:
|
166 |
"""Return a list of available HVACModes."""
|
167 |
hvac_modes: list[HVACMode] = []
|
168 |
-
if
|
169 |
-
self._homekit_enabled # pw-beta homekit emulation
|
170 |
-
or "regulation_modes" in self.gateway_data
|
171 |
-
):
|
172 |
hvac_modes.append(HVACMode.OFF)
|
173 |
|
174 |
-
if
|
175 |
hvac_modes.append(HVACMode.AUTO)
|
176 |
|
177 |
-
if self.
|
178 |
-
if "regulation_modes" in self.
|
179 |
-
if self.
|
180 |
hvac_modes.append(HVACMode.COOL)
|
181 |
-
if self.
|
182 |
hvac_modes.append(HVACMode.HEAT)
|
183 |
else:
|
184 |
hvac_modes.append(HVACMode.HEAT_COOL)
|
@@ -188,35 +184,19 @@
|
|
188 |
return hvac_modes
|
189 |
|
190 |
@property
|
191 |
-
def hvac_action(self) -> HVACAction:
|
192 |
"""Return the current running hvac operation if supported."""
|
193 |
# Keep track of the previous action-mode
|
194 |
self._previous_action_mode(self.coordinator)
|
195 |
-
|
196 |
-
|
197 |
-
if (control_state := self.device.get("control_state")) == "cooling":
|
198 |
-
return HVACAction.COOLING
|
199 |
-
if control_state == "heating":
|
200 |
-
return HVACAction.HEATING
|
201 |
-
if control_state == "preheating":
|
202 |
-
return HVACAction.PREHEATING
|
203 |
-
if control_state == "off":
|
204 |
-
return HVACAction.IDLE
|
205 |
-
|
206 |
-
# Anna
|
207 |
-
heater: str = self.coordinator.data.gateway["heater_id"]
|
208 |
-
heater_data = self.coordinator.data.devices[heater]
|
209 |
-
if heater_data["binary_sensors"]["heating_state"]:
|
210 |
-
return HVACAction.HEATING
|
211 |
-
if heater_data["binary_sensors"].get("cooling_state", False):
|
212 |
-
return HVACAction.COOLING
|
213 |
|
214 |
return HVACAction.IDLE
|
215 |
|
216 |
@property
|
217 |
def preset_mode(self) -> str | None:
|
218 |
"""Return the current preset mode."""
|
219 |
-
return self.device
|
220 |
|
221 |
@plugwise_command
|
222 |
async def async_set_temperature(self, **kwargs: Any) -> None:
|
@@ -229,50 +209,39 @@
|
|
229 |
if ATTR_TARGET_TEMP_LOW in kwargs:
|
230 |
data["setpoint_low"] = kwargs.get(ATTR_TARGET_TEMP_LOW)
|
231 |
|
232 |
-
for temperature in data.values():
|
233 |
-
if temperature is None or not (
|
234 |
-
self._attr_min_temp <= temperature <= self._attr_max_temp
|
235 |
-
):
|
236 |
-
raise ValueError("Invalid temperature change requested")
|
237 |
-
|
238 |
if mode := kwargs.get(ATTR_HVAC_MODE):
|
239 |
await self.async_set_hvac_mode(mode)
|
240 |
|
241 |
-
await self.coordinator.api.set_temperature(self.
|
242 |
|
243 |
@plugwise_command
|
244 |
-
async def async_set_hvac_mode(self, hvac_mode:
|
245 |
"""Set the hvac mode."""
|
246 |
if hvac_mode not in self.hvac_modes:
|
247 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
248 |
|
249 |
if hvac_mode == self.hvac_mode:
|
250 |
return
|
251 |
|
252 |
-
if hvac_mode
|
|
|
|
|
253 |
await self.coordinator.api.set_schedule_state(
|
254 |
-
self.
|
255 |
"on" if hvac_mode == HVACMode.AUTO else "off",
|
256 |
)
|
257 |
-
|
258 |
-
if (
|
259 |
-
not self._homekit_enabled
|
260 |
-
): # pw-beta: feature request - mimic HomeKit behavior
|
261 |
-
if hvac_mode == HVACMode.OFF:
|
262 |
-
await self.coordinator.api.set_regulation_mode(hvac_mode)
|
263 |
-
elif self.hvac_mode == HVACMode.OFF:
|
264 |
await self.coordinator.api.set_regulation_mode(self._previous_mode)
|
265 |
-
else:
|
266 |
-
self._homekit_mode = hvac_mode # pragma: no cover
|
267 |
-
if self._homekit_mode == HVACMode.OFF: # pragma: no cover
|
268 |
-
await self.async_set_preset_mode(PRESET_AWAY) # pragma: no cover
|
269 |
-
if (
|
270 |
-
self._homekit_mode in [HVACMode.HEAT, HVACMode.HEAT_COOL]
|
271 |
-
and self.device["active_preset"] == PRESET_AWAY
|
272 |
-
): # pragma: no cover
|
273 |
-
await self.async_set_preset_mode(PRESET_HOME) # pragma: no cover
|
274 |
|
275 |
@plugwise_command
|
276 |
async def async_set_preset_mode(self, preset_mode: str) -> None:
|
277 |
"""Set the preset mode."""
|
278 |
-
await self.coordinator.api.set_preset(self.
|
|
|
1 |
"""Plugwise Climate component for Home Assistant."""
|
2 |
+
|
3 |
from __future__ import annotations
|
4 |
|
5 |
from typing import Any
|
|
|
13 |
HVACAction,
|
14 |
HVACMode,
|
15 |
)
|
|
|
|
|
|
|
|
|
|
|
16 |
from homeassistant.const import ATTR_TEMPERATURE, UnitOfTemperature
|
17 |
+
from homeassistant.core import HomeAssistant, callback
|
18 |
+
from homeassistant.exceptions import ServiceValidationError
|
19 |
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
20 |
|
21 |
+
from . import PlugwiseConfigEntry
|
22 |
+
from .const import DOMAIN, MASTER_THERMOSTATS
|
|
|
|
|
|
|
|
|
23 |
from .coordinator import PlugwiseDataUpdateCoordinator
|
24 |
from .entity import PlugwiseEntity
|
25 |
from .util import plugwise_command
|
26 |
|
27 |
+
PARALLEL_UPDATES = 0
|
28 |
+
|
29 |
|
30 |
async def async_setup_entry(
|
31 |
hass: HomeAssistant,
|
32 |
+
entry: PlugwiseConfigEntry,
|
33 |
async_add_entities: AddEntitiesCallback,
|
34 |
) -> None:
|
35 |
"""Set up the Smile Thermostats from a config entry."""
|
36 |
+
coordinator = entry.runtime_data
|
37 |
+
|
38 |
+
@callback
|
39 |
+
def _add_entities() -> None:
|
40 |
+
"""Add Entities."""
|
41 |
+
if not coordinator.new_devices:
|
42 |
+
return
|
43 |
+
|
44 |
+
if coordinator.data.gateway["smile_name"] == "Adam":
|
45 |
+
async_add_entities(
|
46 |
+
PlugwiseClimateEntity(coordinator, device_id)
|
47 |
+
for device_id in coordinator.new_devices
|
48 |
+
if coordinator.data.devices[device_id]["dev_class"] == "climate"
|
49 |
+
)
|
50 |
+
else:
|
51 |
+
async_add_entities(
|
52 |
+
PlugwiseClimateEntity(coordinator, device_id)
|
53 |
+
for device_id in coordinator.new_devices
|
54 |
+
if coordinator.data.devices[device_id]["dev_class"]
|
55 |
+
in MASTER_THERMOSTATS
|
56 |
+
)
|
57 |
+
|
58 |
+
_add_entities()
|
59 |
+
entry.async_on_unload(coordinator.async_add_listener(_add_entities))
|
60 |
|
61 |
|
62 |
class PlugwiseClimateEntity(PlugwiseEntity, ClimateEntity):
|
63 |
"""Representation of a Plugwise thermostat."""
|
64 |
|
|
|
65 |
_attr_name = None
|
66 |
_attr_temperature_unit = UnitOfTemperature.CELSIUS
|
67 |
_attr_translation_key = DOMAIN
|
68 |
|
|
|
69 |
_previous_mode: str = "heating"
|
70 |
|
71 |
def __init__(
|
72 |
self,
|
73 |
coordinator: PlugwiseDataUpdateCoordinator,
|
74 |
device_id: str,
|
|
|
75 |
) -> None:
|
76 |
"""Set up the Plugwise API."""
|
77 |
super().__init__(coordinator, device_id)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
78 |
self._attr_unique_id = f"{device_id}-climate"
|
79 |
|
80 |
+
self._devices = coordinator.data.devices
|
81 |
+
self._gateway = coordinator.data.gateway
|
82 |
+
gateway_id: str = self._gateway["gateway_id"]
|
83 |
+
self._gateway_data = self._devices[gateway_id]
|
84 |
+
|
85 |
+
self._location = device_id
|
86 |
+
if (location := self.device.get("location")) is not None:
|
87 |
+
self._location = location
|
88 |
+
|
89 |
# Determine supported features
|
|
|
90 |
self._attr_supported_features = ClimateEntityFeature.TARGET_TEMPERATURE
|
91 |
+
if self._gateway["cooling_present"] and self._gateway["smile_name"] != "Adam":
|
|
|
|
|
|
|
92 |
self._attr_supported_features = (
|
93 |
ClimateEntityFeature.TARGET_TEMPERATURE_RANGE
|
94 |
)
|
95 |
+
if HVACMode.OFF in self.hvac_modes:
|
96 |
+
self._attr_supported_features |= (
|
97 |
+
ClimateEntityFeature.TURN_OFF | ClimateEntityFeature.TURN_ON
|
98 |
+
)
|
99 |
if presets := self.device.get("preset_modes"):
|
100 |
self._attr_supported_features |= ClimateEntityFeature.PRESET_MODE
|
101 |
self._attr_preset_modes = presets
|
102 |
|
103 |
+
self._attr_min_temp = self.device["thermostat"]["lower_bound"]
|
104 |
+
self._attr_max_temp = min(self.device["thermostat"]["upper_bound"], 35.0)
|
105 |
+
# Ensure we don't drop below 0.1
|
106 |
+
self._attr_target_temperature_step = max(
|
107 |
+
self.device["thermostat"]["resolution"], 0.1
|
108 |
+
)
|
109 |
|
110 |
def _previous_action_mode(self, coordinator: PlugwiseDataUpdateCoordinator) -> None:
|
111 |
"""Return the previous action-mode when the regulation-mode is not heating or cooling.
|
|
|
114 |
"""
|
115 |
# When no cooling available, _previous_mode is always heating
|
116 |
if (
|
117 |
+
"regulation_modes" in self._gateway_data
|
118 |
+
and "cooling" in self._gateway_data["regulation_modes"]
|
119 |
):
|
120 |
+
mode = self._gateway_data["select_regulation_mode"]
|
121 |
if mode in ("cooling", "heating"):
|
122 |
self._previous_mode = mode
|
123 |
|
|
|
155 |
def hvac_mode(self) -> HVACMode:
|
156 |
"""Return HVAC operation ie. auto, cool, heat, heat_cool, or off mode."""
|
157 |
if (
|
158 |
+
mode := self.device.get("climate_mode")
|
159 |
+
) is None or mode not in self.hvac_modes:
|
160 |
+
return HVACMode.HEAT
|
|
|
|
|
|
|
|
|
161 |
return HVACMode(mode)
|
162 |
|
163 |
@property
|
164 |
def hvac_modes(self) -> list[HVACMode]:
|
165 |
"""Return a list of available HVACModes."""
|
166 |
hvac_modes: list[HVACMode] = []
|
167 |
+
if "regulation_modes" in self._gateway_data:
|
|
|
|
|
|
|
168 |
hvac_modes.append(HVACMode.OFF)
|
169 |
|
170 |
+
if "available_schedules" in self.device:
|
171 |
hvac_modes.append(HVACMode.AUTO)
|
172 |
|
173 |
+
if self._gateway["cooling_present"]:
|
174 |
+
if "regulation_modes" in self._gateway_data:
|
175 |
+
if self._gateway_data["select_regulation_mode"] == "cooling":
|
176 |
hvac_modes.append(HVACMode.COOL)
|
177 |
+
if self._gateway_data["select_regulation_mode"] == "heating":
|
178 |
hvac_modes.append(HVACMode.HEAT)
|
179 |
else:
|
180 |
hvac_modes.append(HVACMode.HEAT_COOL)
|
|
|
184 |
return hvac_modes
|
185 |
|
186 |
@property
|
187 |
+
def hvac_action(self) -> HVACAction:
|
188 |
"""Return the current running hvac operation if supported."""
|
189 |
# Keep track of the previous action-mode
|
190 |
self._previous_action_mode(self.coordinator)
|
191 |
+
if (action := self.device.get("control_state")) is not None:
|
192 |
+
return HVACAction(action)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
193 |
|
194 |
return HVACAction.IDLE
|
195 |
|
196 |
@property
|
197 |
def preset_mode(self) -> str | None:
|
198 |
"""Return the current preset mode."""
|
199 |
+
return self.device.get("active_preset")
|
200 |
|
201 |
@plugwise_command
|
202 |
async def async_set_temperature(self, **kwargs: Any) -> None:
|
|
|
209 |
if ATTR_TARGET_TEMP_LOW in kwargs:
|
210 |
data["setpoint_low"] = kwargs.get(ATTR_TARGET_TEMP_LOW)
|
211 |
|
|
|
|
|
|
|
|
|
|
|
|
|
212 |
if mode := kwargs.get(ATTR_HVAC_MODE):
|
213 |
await self.async_set_hvac_mode(mode)
|
214 |
|
215 |
+
await self.coordinator.api.set_temperature(self._location, data)
|
216 |
|
217 |
@plugwise_command
|
218 |
+
async def async_set_hvac_mode(self, hvac_mode: HVACMode) -> None:
|
219 |
"""Set the hvac mode."""
|
220 |
if hvac_mode not in self.hvac_modes:
|
221 |
+
hvac_modes = ", ".join(self.hvac_modes)
|
222 |
+
raise ServiceValidationError(
|
223 |
+
translation_domain=DOMAIN,
|
224 |
+
translation_key="unsupported_hvac_mode_requested",
|
225 |
+
translation_placeholders={
|
226 |
+
"hvac_mode": hvac_mode,
|
227 |
+
"hvac_modes": hvac_modes,
|
228 |
+
},
|
229 |
+
)
|
230 |
|
231 |
if hvac_mode == self.hvac_mode:
|
232 |
return
|
233 |
|
234 |
+
if hvac_mode == HVACMode.OFF:
|
235 |
+
await self.coordinator.api.set_regulation_mode(hvac_mode)
|
236 |
+
else:
|
237 |
await self.coordinator.api.set_schedule_state(
|
238 |
+
self._location,
|
239 |
"on" if hvac_mode == HVACMode.AUTO else "off",
|
240 |
)
|
241 |
+
if self.hvac_mode == HVACMode.OFF:
|
|
|
|
|
|
|
|
|
|
|
|
|
242 |
await self.coordinator.api.set_regulation_mode(self._previous_mode)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
243 |
|
244 |
@plugwise_command
|
245 |
async def async_set_preset_mode(self, preset_mode: str) -> None:
|
246 |
"""Set the preset mode."""
|
247 |
+
await self.coordinator.api.set_preset(self._location, preset_mode)
|
@@ -1,8 +1,9 @@
|
|
1 |
"""Config flow for Plugwise integration."""
|
|
|
2 |
from __future__ import annotations
|
3 |
|
4 |
-
import
|
5 |
-
from typing import Any
|
6 |
|
7 |
from plugwise import Smile
|
8 |
from plugwise.exceptions import (
|
@@ -15,29 +16,22 @@
|
|
15 |
)
|
16 |
import voluptuous as vol
|
17 |
|
18 |
-
from homeassistant import
|
19 |
-
from homeassistant.components.zeroconf import ZeroconfServiceInfo
|
20 |
-
from homeassistant.config_entries import ConfigEntry, ConfigFlow
|
21 |
from homeassistant.const import (
|
|
|
22 |
CONF_BASE,
|
23 |
CONF_HOST,
|
24 |
CONF_NAME,
|
25 |
CONF_PASSWORD,
|
26 |
CONF_PORT,
|
27 |
-
CONF_SCAN_INTERVAL,
|
28 |
CONF_USERNAME,
|
29 |
)
|
30 |
-
from homeassistant.core import HomeAssistant
|
31 |
-
from homeassistant.data_entry_flow import FlowResult
|
32 |
-
from homeassistant.helpers import config_validation as cv
|
33 |
from homeassistant.helpers.aiohttp_client import async_get_clientsession
|
|
|
34 |
|
35 |
from .const import (
|
36 |
-
CONF_HOMEKIT_EMULATION, # pw-beta option
|
37 |
-
CONF_REFRESH_INTERVAL, # pw-beta option
|
38 |
-
COORDINATOR,
|
39 |
DEFAULT_PORT,
|
40 |
-
DEFAULT_SCAN_INTERVAL, # pw-beta option
|
41 |
DEFAULT_USERNAME,
|
42 |
DOMAIN,
|
43 |
FLOW_SMILE,
|
@@ -48,42 +42,38 @@
|
|
48 |
ZEROCONF_MAP,
|
49 |
)
|
50 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
51 |
|
52 |
-
def
|
53 |
-
discovery_info: ZeroconfServiceInfo | None,
|
54 |
-
user_input: dict[str, Any] | None,
|
55 |
-
) -> vol.Schema:
|
56 |
"""Generate base schema for gateways."""
|
|
|
|
|
57 |
if not discovery_info:
|
58 |
-
|
59 |
-
return vol.Schema(
|
60 |
-
{
|
61 |
-
vol.Required(CONF_PASSWORD): str,
|
62 |
-
vol.Required(CONF_HOST): str,
|
63 |
-
vol.Optional(CONF_PORT, default=DEFAULT_PORT): int,
|
64 |
-
vol.Required(CONF_USERNAME, default=SMILE): vol.In(
|
65 |
-
{SMILE: FLOW_SMILE, STRETCH: FLOW_STRETCH}
|
66 |
-
),
|
67 |
-
}
|
68 |
-
)
|
69 |
-
return vol.Schema(
|
70 |
{
|
71 |
-
vol.Required(
|
72 |
-
|
73 |
-
vol.Optional(CONF_PORT, default=
|
74 |
-
vol.Required(CONF_USERNAME, default=
|
75 |
{SMILE: FLOW_SMILE, STRETCH: FLOW_STRETCH}
|
76 |
),
|
77 |
}
|
78 |
)
|
79 |
|
80 |
-
return
|
81 |
|
82 |
|
83 |
async def validate_input(hass: HomeAssistant, data: dict[str, Any]) -> Smile:
|
84 |
"""Validate whether the user input allows us to connect to the gateway.
|
85 |
|
86 |
-
Data has the keys from
|
87 |
"""
|
88 |
websession = async_get_clientsession(hass, verify_ssl=False)
|
89 |
api = Smile(
|
@@ -91,24 +81,50 @@
|
|
91 |
password=data[CONF_PASSWORD],
|
92 |
port=data[CONF_PORT],
|
93 |
username=data[CONF_USERNAME],
|
94 |
-
timeout=30,
|
95 |
websession=websession,
|
96 |
)
|
97 |
await api.connect()
|
98 |
return api
|
99 |
|
100 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
101 |
class PlugwiseConfigFlow(ConfigFlow, domain=DOMAIN):
|
102 |
"""Handle a config flow for Plugwise Smile."""
|
103 |
|
104 |
VERSION = 1
|
105 |
|
106 |
discovery_info: ZeroconfServiceInfo | None = None
|
|
|
107 |
_username: str = DEFAULT_USERNAME
|
108 |
|
109 |
async def async_step_zeroconf(
|
110 |
self, discovery_info: ZeroconfServiceInfo
|
111 |
-
) ->
|
112 |
"""Prepare configuration for a discovered Plugwise Smile."""
|
113 |
self.discovery_info = discovery_info
|
114 |
_properties = discovery_info.properties
|
@@ -125,7 +141,7 @@
|
|
125 |
CONF_PASSWORD: config_entry.data[CONF_PASSWORD],
|
126 |
},
|
127 |
)
|
128 |
-
except Exception: #
|
129 |
self._abort_if_unique_id_configured()
|
130 |
else:
|
131 |
self._abort_if_unique_id_configured(
|
@@ -137,7 +153,7 @@
|
|
137 |
|
138 |
if DEFAULT_USERNAME not in unique_id:
|
139 |
self._username = STRETCH_USERNAME
|
140 |
-
_product = _properties.get("product",
|
141 |
_version = _properties.get("version", "n/a")
|
142 |
_name = f"{ZEROCONF_MAP.get(_product, _product)} v{_version}"
|
143 |
|
@@ -149,155 +165,93 @@
|
|
149 |
# If we have discovered an Adam or Anna, both might be on the network.
|
150 |
# In that case, we need to cancel the Anna flow, as the Adam should
|
151 |
# be added.
|
152 |
-
|
153 |
-
|
154 |
-
if (
|
155 |
-
_product == "smile_thermo"
|
156 |
-
and "context" in flow
|
157 |
-
and flow["context"].get("product") == "smile_open_therm"
|
158 |
-
):
|
159 |
-
return self.async_abort(reason="anna_with_adam")
|
160 |
-
|
161 |
-
# This is an Adam, and there is already an Anna flow in progress
|
162 |
-
if (
|
163 |
-
_product == "smile_open_therm"
|
164 |
-
and "context" in flow
|
165 |
-
and flow["context"].get("product") == "smile_thermo"
|
166 |
-
and "flow_id" in flow
|
167 |
-
):
|
168 |
-
self.hass.config_entries.flow.async_abort(flow["flow_id"])
|
169 |
|
170 |
self.context.update(
|
171 |
{
|
172 |
-
"title_placeholders": {
|
173 |
-
|
174 |
-
CONF_NAME: _name,
|
175 |
-
CONF_PORT: discovery_info.port,
|
176 |
-
CONF_USERNAME: self._username,
|
177 |
-
},
|
178 |
-
"configuration_url": (
|
179 |
f"http://{discovery_info.host}:{discovery_info.port}"
|
180 |
),
|
181 |
-
"product": _product,
|
182 |
}
|
183 |
)
|
184 |
return await self.async_step_user()
|
185 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
186 |
async def async_step_user(
|
187 |
self, user_input: dict[str, Any] | None = None
|
188 |
-
) ->
|
189 |
"""Handle the initial step when using network/gateway setups."""
|
190 |
errors: dict[str, str] = {}
|
191 |
|
192 |
-
if not user_input:
|
193 |
-
return self.async_show_form(
|
194 |
-
step_id="user",
|
195 |
-
data_schema=_base_schema(self.discovery_info, None),
|
196 |
-
errors=errors,
|
197 |
-
)
|
198 |
-
|
199 |
-
if self.discovery_info:
|
200 |
-
user_input[CONF_HOST] = self.discovery_info.host
|
201 |
-
user_input[CONF_PORT] = self.discovery_info.port
|
202 |
-
user_input[CONF_USERNAME] = self._username
|
203 |
-
try:
|
204 |
-
api = await validate_input(self.hass, user_input)
|
205 |
-
except ConnectionFailedError:
|
206 |
-
errors[CONF_BASE] = "cannot_connect"
|
207 |
-
except InvalidAuthentication:
|
208 |
-
errors[CONF_BASE] = "invalid_auth"
|
209 |
-
except InvalidSetupError:
|
210 |
-
errors[CONF_BASE] = "invalid_setup"
|
211 |
-
except (InvalidXMLError, ResponseError):
|
212 |
-
errors[CONF_BASE] = "response_error"
|
213 |
-
except UnsupportedDeviceError:
|
214 |
-
errors[CONF_BASE] = "unsupported"
|
215 |
-
except Exception: # pylint: disable=broad-except
|
216 |
-
errors[CONF_BASE] = "unknown"
|
217 |
-
|
218 |
-
if errors:
|
219 |
-
return self.async_show_form(
|
220 |
-
step_id="user",
|
221 |
-
data_schema=_base_schema(None, user_input),
|
222 |
-
errors=errors,
|
223 |
-
)
|
224 |
-
|
225 |
-
await self.async_set_unique_id(
|
226 |
-
api.smile_hostname or api.gateway_id, raise_on_progress=False
|
227 |
-
)
|
228 |
-
self._abort_if_unique_id_configured()
|
229 |
-
|
230 |
-
return self.async_create_entry(title=api.smile_name, data=user_input)
|
231 |
-
|
232 |
-
@staticmethod
|
233 |
-
@callback
|
234 |
-
def async_get_options_flow(
|
235 |
-
config_entry: ConfigEntry,
|
236 |
-
) -> config_entries.OptionsFlow: # pw-beta options
|
237 |
-
"""Get the options flow for this handler."""
|
238 |
-
return PlugwiseOptionsFlowHandler(config_entry)
|
239 |
-
|
240 |
-
|
241 |
-
# pw-beta - change the scan-interval via CONFIGURE
|
242 |
-
# pw-beta - add homekit emulation via CONFIGURE
|
243 |
-
# pw-beta - change the frontend refresh interval via CONFIGURE
|
244 |
-
class PlugwiseOptionsFlowHandler(config_entries.OptionsFlow): # pw-beta options
|
245 |
-
"""Plugwise option flow."""
|
246 |
-
|
247 |
-
def __init__(self, config_entry: ConfigEntry) -> None: # pragma: no cover
|
248 |
-
"""Initialize options flow."""
|
249 |
-
self.config_entry = config_entry
|
250 |
-
|
251 |
-
async def async_step_none(
|
252 |
-
self, user_input: dict[str, Any] | None = None
|
253 |
-
) -> FlowResult: # pragma: no cover
|
254 |
-
"""No options available."""
|
255 |
if user_input is not None:
|
256 |
-
|
257 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
258 |
|
259 |
-
return self.async_show_form(
|
|
|
|
|
|
|
|
|
260 |
|
261 |
-
async def
|
262 |
self, user_input: dict[str, Any] | None = None
|
263 |
-
) ->
|
264 |
-
"""
|
265 |
-
|
266 |
-
return await self.async_step_none(user_input)
|
267 |
-
|
268 |
-
if user_input is not None:
|
269 |
-
return self.async_create_entry(title="", data=user_input)
|
270 |
-
|
271 |
-
coordinator = self.hass.data[DOMAIN][self.config_entry.entry_id][COORDINATOR]
|
272 |
-
interval: dt.timedelta = DEFAULT_SCAN_INTERVAL[
|
273 |
-
coordinator.api.smile_type
|
274 |
-
] # pw-beta options
|
275 |
-
|
276 |
-
data = {
|
277 |
-
vol.Optional(
|
278 |
-
CONF_SCAN_INTERVAL,
|
279 |
-
default=self.config_entry.options.get(
|
280 |
-
CONF_SCAN_INTERVAL, interval.seconds
|
281 |
-
),
|
282 |
-
): vol.All(cv.positive_int, vol.Clamp(min=10)),
|
283 |
-
} # pw-beta
|
284 |
|
285 |
-
|
286 |
-
return self.async_show_form(step_id="init", data_schema=vol.Schema(data))
|
287 |
|
288 |
-
|
289 |
-
|
290 |
-
|
291 |
-
|
292 |
-
|
293 |
-
|
294 |
-
|
295 |
-
): cv.boolean,
|
296 |
-
vol.Optional(
|
297 |
-
CONF_REFRESH_INTERVAL,
|
298 |
-
default=self.config_entry.options.get(CONF_REFRESH_INTERVAL, 1.5),
|
299 |
-
): vol.All(vol.Coerce(float), vol.Range(min=1.5, max=10.0)),
|
300 |
}
|
301 |
-
) # pw-beta
|
302 |
|
303 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
"""Config flow for Plugwise integration."""
|
2 |
+
|
3 |
from __future__ import annotations
|
4 |
|
5 |
+
import logging
|
6 |
+
from typing import Any, Self
|
7 |
|
8 |
from plugwise import Smile
|
9 |
from plugwise.exceptions import (
|
|
|
16 |
)
|
17 |
import voluptuous as vol
|
18 |
|
19 |
+
from homeassistant.config_entries import SOURCE_USER, ConfigFlow, ConfigFlowResult
|
|
|
|
|
20 |
from homeassistant.const import (
|
21 |
+
ATTR_CONFIGURATION_URL,
|
22 |
CONF_BASE,
|
23 |
CONF_HOST,
|
24 |
CONF_NAME,
|
25 |
CONF_PASSWORD,
|
26 |
CONF_PORT,
|
|
|
27 |
CONF_USERNAME,
|
28 |
)
|
29 |
+
from homeassistant.core import HomeAssistant
|
|
|
|
|
30 |
from homeassistant.helpers.aiohttp_client import async_get_clientsession
|
31 |
+
from homeassistant.helpers.service_info.zeroconf import ZeroconfServiceInfo
|
32 |
|
33 |
from .const import (
|
|
|
|
|
|
|
34 |
DEFAULT_PORT,
|
|
|
35 |
DEFAULT_USERNAME,
|
36 |
DOMAIN,
|
37 |
FLOW_SMILE,
|
|
|
42 |
ZEROCONF_MAP,
|
43 |
)
|
44 |
|
45 |
+
_LOGGER = logging.getLogger(__name__)
|
46 |
+
|
47 |
+
SMILE_RECONF_SCHEMA = vol.Schema(
|
48 |
+
{
|
49 |
+
vol.Required(CONF_HOST): str,
|
50 |
+
}
|
51 |
+
)
|
52 |
+
|
53 |
|
54 |
+
def smile_user_schema(discovery_info: ZeroconfServiceInfo | None) -> vol.Schema:
|
|
|
|
|
|
|
55 |
"""Generate base schema for gateways."""
|
56 |
+
schema = vol.Schema({vol.Required(CONF_PASSWORD): str})
|
57 |
+
|
58 |
if not discovery_info:
|
59 |
+
schema = schema.extend(
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
60 |
{
|
61 |
+
vol.Required(CONF_HOST): str,
|
62 |
+
# Port under investigation for removal (hence not added in #132878)
|
63 |
+
vol.Optional(CONF_PORT, default=DEFAULT_PORT): int,
|
64 |
+
vol.Required(CONF_USERNAME, default=SMILE): vol.In(
|
65 |
{SMILE: FLOW_SMILE, STRETCH: FLOW_STRETCH}
|
66 |
),
|
67 |
}
|
68 |
)
|
69 |
|
70 |
+
return schema
|
71 |
|
72 |
|
73 |
async def validate_input(hass: HomeAssistant, data: dict[str, Any]) -> Smile:
|
74 |
"""Validate whether the user input allows us to connect to the gateway.
|
75 |
|
76 |
+
Data has the keys from the schema with values provided by the user.
|
77 |
"""
|
78 |
websession = async_get_clientsession(hass, verify_ssl=False)
|
79 |
api = Smile(
|
|
|
81 |
password=data[CONF_PASSWORD],
|
82 |
port=data[CONF_PORT],
|
83 |
username=data[CONF_USERNAME],
|
|
|
84 |
websession=websession,
|
85 |
)
|
86 |
await api.connect()
|
87 |
return api
|
88 |
|
89 |
|
90 |
+
async def verify_connection(
|
91 |
+
hass: HomeAssistant, user_input: dict[str, Any]
|
92 |
+
) -> tuple[Smile | None, dict[str, str]]:
|
93 |
+
"""Verify and return the gateway connection or an error."""
|
94 |
+
errors: dict[str, str] = {}
|
95 |
+
|
96 |
+
try:
|
97 |
+
return (await validate_input(hass, user_input), errors)
|
98 |
+
except ConnectionFailedError:
|
99 |
+
errors[CONF_BASE] = "cannot_connect"
|
100 |
+
except InvalidAuthentication:
|
101 |
+
errors[CONF_BASE] = "invalid_auth"
|
102 |
+
except InvalidSetupError:
|
103 |
+
errors[CONF_BASE] = "invalid_setup"
|
104 |
+
except (InvalidXMLError, ResponseError):
|
105 |
+
errors[CONF_BASE] = "response_error"
|
106 |
+
except UnsupportedDeviceError:
|
107 |
+
errors[CONF_BASE] = "unsupported"
|
108 |
+
except Exception:
|
109 |
+
_LOGGER.exception(
|
110 |
+
"Unknown exception while verifying connection with your Plugwise Smile"
|
111 |
+
)
|
112 |
+
errors[CONF_BASE] = "unknown"
|
113 |
+
return (None, errors)
|
114 |
+
|
115 |
+
|
116 |
class PlugwiseConfigFlow(ConfigFlow, domain=DOMAIN):
|
117 |
"""Handle a config flow for Plugwise Smile."""
|
118 |
|
119 |
VERSION = 1
|
120 |
|
121 |
discovery_info: ZeroconfServiceInfo | None = None
|
122 |
+
product: str = "Unknown Smile"
|
123 |
_username: str = DEFAULT_USERNAME
|
124 |
|
125 |
async def async_step_zeroconf(
|
126 |
self, discovery_info: ZeroconfServiceInfo
|
127 |
+
) -> ConfigFlowResult:
|
128 |
"""Prepare configuration for a discovered Plugwise Smile."""
|
129 |
self.discovery_info = discovery_info
|
130 |
_properties = discovery_info.properties
|
|
|
141 |
CONF_PASSWORD: config_entry.data[CONF_PASSWORD],
|
142 |
},
|
143 |
)
|
144 |
+
except Exception: # noqa: BLE001
|
145 |
self._abort_if_unique_id_configured()
|
146 |
else:
|
147 |
self._abort_if_unique_id_configured(
|
|
|
153 |
|
154 |
if DEFAULT_USERNAME not in unique_id:
|
155 |
self._username = STRETCH_USERNAME
|
156 |
+
self.product = _product = _properties.get("product", "Unknown Smile")
|
157 |
_version = _properties.get("version", "n/a")
|
158 |
_name = f"{ZEROCONF_MAP.get(_product, _product)} v{_version}"
|
159 |
|
|
|
165 |
# If we have discovered an Adam or Anna, both might be on the network.
|
166 |
# In that case, we need to cancel the Anna flow, as the Adam should
|
167 |
# be added.
|
168 |
+
if self.hass.config_entries.flow.async_has_matching_flow(self):
|
169 |
+
return self.async_abort(reason="anna_with_adam")
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
170 |
|
171 |
self.context.update(
|
172 |
{
|
173 |
+
"title_placeholders": {CONF_NAME: _name},
|
174 |
+
ATTR_CONFIGURATION_URL: (
|
|
|
|
|
|
|
|
|
|
|
175 |
f"http://{discovery_info.host}:{discovery_info.port}"
|
176 |
),
|
|
|
177 |
}
|
178 |
)
|
179 |
return await self.async_step_user()
|
180 |
|
181 |
+
def is_matching(self, other_flow: Self) -> bool:
|
182 |
+
"""Return True if other_flow is matching this flow."""
|
183 |
+
# This is an Anna, and there is already an Adam flow in progress
|
184 |
+
if self.product == "smile_thermo" and other_flow.product == "smile_open_therm":
|
185 |
+
return True
|
186 |
+
|
187 |
+
# This is an Adam, and there is already an Anna flow in progress
|
188 |
+
if self.product == "smile_open_therm" and other_flow.product == "smile_thermo":
|
189 |
+
self.hass.config_entries.flow.async_abort(other_flow.flow_id)
|
190 |
+
|
191 |
+
return False
|
192 |
+
|
193 |
async def async_step_user(
|
194 |
self, user_input: dict[str, Any] | None = None
|
195 |
+
) -> ConfigFlowResult:
|
196 |
"""Handle the initial step when using network/gateway setups."""
|
197 |
errors: dict[str, str] = {}
|
198 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
199 |
if user_input is not None:
|
200 |
+
if self.discovery_info:
|
201 |
+
user_input[CONF_HOST] = self.discovery_info.host
|
202 |
+
user_input[CONF_PORT] = self.discovery_info.port
|
203 |
+
user_input[CONF_USERNAME] = self._username
|
204 |
+
|
205 |
+
api, errors = await verify_connection(self.hass, user_input)
|
206 |
+
if api:
|
207 |
+
await self.async_set_unique_id(
|
208 |
+
api.smile_hostname or api.gateway_id,
|
209 |
+
raise_on_progress=False,
|
210 |
+
)
|
211 |
+
self._abort_if_unique_id_configured()
|
212 |
+
return self.async_create_entry(title=api.smile_name, data=user_input)
|
213 |
|
214 |
+
return self.async_show_form(
|
215 |
+
step_id=SOURCE_USER,
|
216 |
+
data_schema=smile_user_schema(self.discovery_info),
|
217 |
+
errors=errors,
|
218 |
+
)
|
219 |
|
220 |
+
async def async_step_reconfigure(
|
221 |
self, user_input: dict[str, Any] | None = None
|
222 |
+
) -> ConfigFlowResult:
|
223 |
+
"""Handle reconfiguration of the integration."""
|
224 |
+
errors: dict[str, str] = {}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
225 |
|
226 |
+
reconfigure_entry = self._get_reconfigure_entry()
|
|
|
227 |
|
228 |
+
if user_input:
|
229 |
+
# Keep current username and password
|
230 |
+
full_input = {
|
231 |
+
CONF_HOST: user_input.get(CONF_HOST),
|
232 |
+
CONF_PORT: reconfigure_entry.data.get(CONF_PORT),
|
233 |
+
CONF_USERNAME: reconfigure_entry.data.get(CONF_USERNAME),
|
234 |
+
CONF_PASSWORD: reconfigure_entry.data.get(CONF_PASSWORD),
|
|
|
|
|
|
|
|
|
|
|
235 |
}
|
|
|
236 |
|
237 |
+
api, errors = await verify_connection(self.hass, full_input)
|
238 |
+
if api:
|
239 |
+
await self.async_set_unique_id(
|
240 |
+
api.smile_hostname or api.gateway_id,
|
241 |
+
raise_on_progress=False,
|
242 |
+
)
|
243 |
+
self._abort_if_unique_id_mismatch(reason="not_the_same_smile")
|
244 |
+
return self.async_update_reload_and_abort(
|
245 |
+
reconfigure_entry,
|
246 |
+
data_updates=full_input,
|
247 |
+
)
|
248 |
+
|
249 |
+
return self.async_show_form(
|
250 |
+
step_id="reconfigure",
|
251 |
+
data_schema=self.add_suggested_values_to_schema(
|
252 |
+
data_schema=SMILE_RECONF_SCHEMA,
|
253 |
+
suggested_values=reconfigure_entry.data,
|
254 |
+
),
|
255 |
+
description_placeholders={"title": reconfigure_entry.title},
|
256 |
+
errors=errors,
|
257 |
+
)
|
@@ -1,4 +1,7 @@
|
|
1 |
"""Constants for Plugwise component."""
|
|
|
|
|
|
|
2 |
from datetime import timedelta
|
3 |
import logging
|
4 |
from typing import Final, Literal
|
@@ -10,53 +13,27 @@
|
|
10 |
LOGGER = logging.getLogger(__package__)
|
11 |
|
12 |
API: Final = "api"
|
13 |
-
|
14 |
-
|
15 |
-
|
16 |
-
|
|
|
|
|
|
|
|
|
17 |
SMILE: Final = "smile"
|
18 |
STRETCH: Final = "stretch"
|
19 |
STRETCH_USERNAME: Final = "stretch"
|
20 |
-
UNIQUE_IDS: Final = "unique_ids"
|
21 |
-
|
22 |
-
FLOW_NET: Final = "Network: Smile/Stretch"
|
23 |
-
FLOW_SMILE: Final = "Smile (Adam/Anna/P1)"
|
24 |
-
FLOW_STRETCH: Final = "Stretch (Stretch)"
|
25 |
-
FLOW_TYPE: Final = "flow_type"
|
26 |
-
|
27 |
-
UNDO_UPDATE_LISTENER: Final = "undo_update_listener"
|
28 |
|
29 |
-
# Default directives
|
30 |
-
DEFAULT_PORT: Final = 80
|
31 |
-
DEFAULT_SCAN_INTERVAL: Final[dict[str, timedelta]] = {
|
32 |
-
"power": timedelta(seconds=10),
|
33 |
-
"stretch": timedelta(seconds=60),
|
34 |
-
"thermostat": timedelta(seconds=60),
|
35 |
-
}
|
36 |
-
DEFAULT_TIMEOUT: Final = 10
|
37 |
-
DEFAULT_USERNAME: Final = "smile"
|
38 |
-
|
39 |
-
# --- Const for Plugwise Smile and Stretch
|
40 |
PLATFORMS: Final[list[str]] = [
|
41 |
Platform.BINARY_SENSOR,
|
|
|
42 |
Platform.CLIMATE,
|
43 |
Platform.NUMBER,
|
44 |
Platform.SELECT,
|
45 |
Platform.SENSOR,
|
46 |
Platform.SWITCH,
|
47 |
]
|
48 |
-
SERVICE_DELETE: Final = "delete_notification"
|
49 |
-
SEVERITIES: Final[list[str]] = ["other", "info", "message", "warning", "error"]
|
50 |
-
|
51 |
-
# Climate const:
|
52 |
-
MASTER_THERMOSTATS: Final[list[str]] = [
|
53 |
-
"thermostat",
|
54 |
-
"zone_thermometer",
|
55 |
-
"zone_thermostat",
|
56 |
-
"thermostatic_radiator_valve",
|
57 |
-
]
|
58 |
-
|
59 |
-
# Config_flow const:
|
60 |
ZEROCONF_MAP: Final[dict[str, str]] = {
|
61 |
"smile": "Smile P1",
|
62 |
"smile_thermo": "Smile Anna",
|
@@ -64,15 +41,39 @@
|
|
64 |
"stretch": "Stretch",
|
65 |
}
|
66 |
|
67 |
-
|
68 |
-
"
|
|
|
|
|
|
|
|
|
|
|
69 |
"select_dhw_mode",
|
|
|
70 |
"select_regulation_mode",
|
71 |
"select_schedule",
|
72 |
]
|
73 |
-
SelectOptionsType = Literal[
|
74 |
"dhw_modes",
|
75 |
-
"
|
76 |
"regulation_modes",
|
77 |
"available_schedules",
|
78 |
]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
"""Constants for Plugwise component."""
|
2 |
+
|
3 |
+
from __future__ import annotations
|
4 |
+
|
5 |
from datetime import timedelta
|
6 |
import logging
|
7 |
from typing import Final, Literal
|
|
|
13 |
LOGGER = logging.getLogger(__package__)
|
14 |
|
15 |
API: Final = "api"
|
16 |
+
FLOW_SMILE: Final = "smile (Adam/Anna/P1)"
|
17 |
+
FLOW_STRETCH: Final = "stretch (Stretch)"
|
18 |
+
FLOW_TYPE: Final = "flow_type"
|
19 |
+
GATEWAY: Final = "gateway"
|
20 |
+
GATEWAY_ID: Final = "gateway_id"
|
21 |
+
LOCATION: Final = "location"
|
22 |
+
PW_TYPE: Final = "plugwise_type"
|
23 |
+
REBOOT: Final = "reboot"
|
24 |
SMILE: Final = "smile"
|
25 |
STRETCH: Final = "stretch"
|
26 |
STRETCH_USERNAME: Final = "stretch"
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
27 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
28 |
PLATFORMS: Final[list[str]] = [
|
29 |
Platform.BINARY_SENSOR,
|
30 |
+
Platform.BUTTON,
|
31 |
Platform.CLIMATE,
|
32 |
Platform.NUMBER,
|
33 |
Platform.SELECT,
|
34 |
Platform.SENSOR,
|
35 |
Platform.SWITCH,
|
36 |
]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
37 |
ZEROCONF_MAP: Final[dict[str, str]] = {
|
38 |
"smile": "Smile P1",
|
39 |
"smile_thermo": "Smile Anna",
|
|
|
41 |
"stretch": "Stretch",
|
42 |
}
|
43 |
|
44 |
+
type NumberType = Literal[
|
45 |
+
"maximum_boiler_temperature",
|
46 |
+
"max_dhw_temperature",
|
47 |
+
"temperature_offset",
|
48 |
+
]
|
49 |
+
|
50 |
+
type SelectType = Literal[
|
51 |
"select_dhw_mode",
|
52 |
+
"select_gateway_mode",
|
53 |
"select_regulation_mode",
|
54 |
"select_schedule",
|
55 |
]
|
56 |
+
type SelectOptionsType = Literal[
|
57 |
"dhw_modes",
|
58 |
+
"gateway_modes",
|
59 |
"regulation_modes",
|
60 |
"available_schedules",
|
61 |
]
|
62 |
+
|
63 |
+
# Default directives
|
64 |
+
DEFAULT_MAX_TEMP: Final = 30
|
65 |
+
DEFAULT_MIN_TEMP: Final = 4
|
66 |
+
DEFAULT_PORT: Final = 80
|
67 |
+
DEFAULT_SCAN_INTERVAL: Final[dict[str, timedelta]] = {
|
68 |
+
"power": timedelta(seconds=10),
|
69 |
+
"stretch": timedelta(seconds=60),
|
70 |
+
"thermostat": timedelta(seconds=60),
|
71 |
+
}
|
72 |
+
DEFAULT_USERNAME: Final = "smile"
|
73 |
+
|
74 |
+
MASTER_THERMOSTATS: Final[list[str]] = [
|
75 |
+
"thermostat",
|
76 |
+
"thermostatic_radiator_valve",
|
77 |
+
"zone_thermometer",
|
78 |
+
"zone_thermostat",
|
79 |
+
]
|
@@ -1,23 +1,20 @@
|
|
1 |
"""DataUpdateCoordinator for Plugwise."""
|
|
|
2 |
from datetime import timedelta
|
3 |
|
|
|
4 |
from plugwise import PlugwiseData, Smile
|
5 |
from plugwise.exceptions import (
|
6 |
ConnectionFailedError,
|
7 |
InvalidAuthentication,
|
8 |
InvalidXMLError,
|
|
|
9 |
ResponseError,
|
10 |
UnsupportedDeviceError,
|
11 |
)
|
12 |
|
13 |
from homeassistant.config_entries import ConfigEntry
|
14 |
-
from homeassistant.const import
|
15 |
-
CONF_HOST,
|
16 |
-
CONF_PASSWORD,
|
17 |
-
CONF_PORT,
|
18 |
-
CONF_SCAN_INTERVAL, # pw-beta options
|
19 |
-
CONF_USERNAME,
|
20 |
-
)
|
21 |
from homeassistant.core import HomeAssistant
|
22 |
from homeassistant.exceptions import ConfigEntryError
|
23 |
from homeassistant.helpers import device_registry as dr
|
@@ -25,48 +22,7 @@
|
|
25 |
from homeassistant.helpers.debounce import Debouncer
|
26 |
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
|
27 |
|
28 |
-
from .const import DEFAULT_PORT,
|
29 |
-
|
30 |
-
|
31 |
-
def remove_stale_devices(
|
32 |
-
api: Smile,
|
33 |
-
device_registry: dr.DeviceRegistry,
|
34 |
-
via_id: str,
|
35 |
-
) -> None:
|
36 |
-
"""Process the Plugwise devices present in the device_registry connected to a specific Gateway."""
|
37 |
-
for dev_id, device_entry in list(device_registry.devices.items()):
|
38 |
-
if device_entry.via_device_id == via_id:
|
39 |
-
for item in device_entry.identifiers:
|
40 |
-
if item[0] == DOMAIN and item[1] in api.device_list:
|
41 |
-
continue
|
42 |
-
|
43 |
-
device_registry.async_remove_device(dev_id)
|
44 |
-
LOGGER.debug(
|
45 |
-
"Removed device %s %s %s from device_registry",
|
46 |
-
DOMAIN,
|
47 |
-
device_entry.model,
|
48 |
-
dev_id,
|
49 |
-
)
|
50 |
-
|
51 |
-
|
52 |
-
def cleanup_device_registry(
|
53 |
-
hass: HomeAssistant,
|
54 |
-
api: Smile,
|
55 |
-
) -> None:
|
56 |
-
"""Remove deleted devices from device-registry."""
|
57 |
-
device_registry = dr.async_get(hass)
|
58 |
-
via_id_list: list[list[str]] = []
|
59 |
-
# Collect the required data of the Plugwise Gateway's
|
60 |
-
for device_entry in list(device_registry.devices.values()):
|
61 |
-
if device_entry.manufacturer == "Plugwise" and device_entry.model == "Gateway":
|
62 |
-
for item in device_entry.identifiers:
|
63 |
-
via_id_list.append([item[1], device_entry.id])
|
64 |
-
|
65 |
-
for via_id in via_id_list:
|
66 |
-
if via_id[0] != api.gateway_id:
|
67 |
-
continue # pragma: no cover
|
68 |
-
|
69 |
-
remove_stale_devices(api, device_registry, via_id[1])
|
70 |
|
71 |
|
72 |
class PlugwiseDataUpdateCoordinator(DataUpdateCoordinator[PlugwiseData]):
|
@@ -74,90 +30,114 @@
|
|
74 |
|
75 |
_connected: bool = False
|
76 |
|
77 |
-
|
78 |
-
|
79 |
-
|
80 |
-
entry: ConfigEntry,
|
81 |
-
cooldown: float,
|
82 |
-
update_interval: timedelta = timedelta(seconds=60),
|
83 |
-
) -> None: # pw-beta cooldown
|
84 |
"""Initialize the coordinator."""
|
85 |
super().__init__(
|
86 |
hass,
|
87 |
LOGGER,
|
88 |
name=DOMAIN,
|
89 |
-
|
90 |
-
update_interval=update_interval,
|
91 |
# Don't refresh immediately, give the device time to process
|
92 |
# the change in state before we query it.
|
93 |
request_refresh_debouncer=Debouncer(
|
94 |
hass,
|
95 |
LOGGER,
|
96 |
-
cooldown=
|
97 |
immediate=False,
|
98 |
),
|
99 |
)
|
100 |
|
101 |
self.api = Smile(
|
102 |
-
host=
|
103 |
-
username=
|
104 |
-
password=
|
105 |
-
port=
|
106 |
-
timeout=30,
|
107 |
websession=async_get_clientsession(hass, verify_ssl=False),
|
108 |
)
|
109 |
-
self.
|
110 |
-
self.
|
111 |
-
self._unavailable_logged = False
|
112 |
-
self.current_unique_ids: set[tuple[str, str]] = {("dummy", "dummy_id")}
|
113 |
-
self.update_interval = update_interval
|
114 |
|
115 |
async def _connect(self) -> None:
|
116 |
"""Connect to the Plugwise Smile."""
|
117 |
-
|
118 |
-
self.
|
119 |
-
|
120 |
-
|
121 |
-
self.api.smile_type, timedelta(seconds=60)
|
122 |
-
) # pw-beta options scan-interval
|
123 |
-
if (custom_time := self._entry.options.get(CONF_SCAN_INTERVAL)) is not None:
|
124 |
-
self.update_interval = timedelta(
|
125 |
-
seconds=int(custom_time)
|
126 |
-
) # pragma: no cover # pw-beta options
|
127 |
-
|
128 |
-
LOGGER.debug("DUC update interval: %s", self.update_interval) # pw-beta options
|
129 |
|
130 |
async def _async_update_data(self) -> PlugwiseData:
|
131 |
"""Fetch data from Plugwise."""
|
132 |
-
data = PlugwiseData(gateway={}, devices={})
|
133 |
-
|
134 |
try:
|
135 |
if not self._connected:
|
136 |
await self._connect()
|
137 |
data = await self.api.async_update()
|
138 |
-
|
139 |
-
|
140 |
-
|
|
|
|
|
141 |
except InvalidAuthentication as err:
|
142 |
-
|
143 |
-
|
144 |
-
|
|
|
145 |
except (InvalidXMLError, ResponseError) as err:
|
146 |
-
|
147 |
-
|
148 |
-
|
149 |
-
|
150 |
-
|
|
|
|
|
|
|
|
|
151 |
except UnsupportedDeviceError as err:
|
152 |
-
|
153 |
-
|
154 |
-
|
155 |
-
|
156 |
-
if not self._unavailable_logged: # pw-beta add to Core
|
157 |
-
self._unavailable_logged = True
|
158 |
-
raise UpdateFailed("Failed to connect") from err
|
159 |
-
|
160 |
-
# Clean-up removed devices
|
161 |
-
cleanup_device_registry(self.hass, self.api)
|
162 |
|
|
|
163 |
return data
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
"""DataUpdateCoordinator for Plugwise."""
|
2 |
+
|
3 |
from datetime import timedelta
|
4 |
|
5 |
+
from packaging.version import Version
|
6 |
from plugwise import PlugwiseData, Smile
|
7 |
from plugwise.exceptions import (
|
8 |
ConnectionFailedError,
|
9 |
InvalidAuthentication,
|
10 |
InvalidXMLError,
|
11 |
+
PlugwiseError,
|
12 |
ResponseError,
|
13 |
UnsupportedDeviceError,
|
14 |
)
|
15 |
|
16 |
from homeassistant.config_entries import ConfigEntry
|
17 |
+
from homeassistant.const import CONF_HOST, CONF_PASSWORD, CONF_PORT, CONF_USERNAME
|
|
|
|
|
|
|
|
|
|
|
|
|
18 |
from homeassistant.core import HomeAssistant
|
19 |
from homeassistant.exceptions import ConfigEntryError
|
20 |
from homeassistant.helpers import device_registry as dr
|
|
|
22 |
from homeassistant.helpers.debounce import Debouncer
|
23 |
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
|
24 |
|
25 |
+
from .const import DEFAULT_PORT, DEFAULT_USERNAME, DOMAIN, GATEWAY_ID, LOGGER
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
26 |
|
27 |
|
28 |
class PlugwiseDataUpdateCoordinator(DataUpdateCoordinator[PlugwiseData]):
|
|
|
30 |
|
31 |
_connected: bool = False
|
32 |
|
33 |
+
config_entry: ConfigEntry
|
34 |
+
|
35 |
+
def __init__(self, hass: HomeAssistant) -> None:
|
|
|
|
|
|
|
|
|
36 |
"""Initialize the coordinator."""
|
37 |
super().__init__(
|
38 |
hass,
|
39 |
LOGGER,
|
40 |
name=DOMAIN,
|
41 |
+
update_interval=timedelta(seconds=60),
|
|
|
42 |
# Don't refresh immediately, give the device time to process
|
43 |
# the change in state before we query it.
|
44 |
request_refresh_debouncer=Debouncer(
|
45 |
hass,
|
46 |
LOGGER,
|
47 |
+
cooldown=1.5,
|
48 |
immediate=False,
|
49 |
),
|
50 |
)
|
51 |
|
52 |
self.api = Smile(
|
53 |
+
host=self.config_entry.data[CONF_HOST],
|
54 |
+
username=self.config_entry.data.get(CONF_USERNAME, DEFAULT_USERNAME),
|
55 |
+
password=self.config_entry.data[CONF_PASSWORD],
|
56 |
+
port=self.config_entry.data.get(CONF_PORT, DEFAULT_PORT),
|
|
|
57 |
websession=async_get_clientsession(hass, verify_ssl=False),
|
58 |
)
|
59 |
+
self._current_devices: set[str] = set()
|
60 |
+
self.new_devices: set[str] = set()
|
|
|
|
|
|
|
61 |
|
62 |
async def _connect(self) -> None:
|
63 |
"""Connect to the Plugwise Smile."""
|
64 |
+
version = await self.api.connect()
|
65 |
+
self._connected = isinstance(version, Version)
|
66 |
+
if self._connected:
|
67 |
+
self.api.get_all_gateway_entities()
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
68 |
|
69 |
async def _async_update_data(self) -> PlugwiseData:
|
70 |
"""Fetch data from Plugwise."""
|
|
|
|
|
71 |
try:
|
72 |
if not self._connected:
|
73 |
await self._connect()
|
74 |
data = await self.api.async_update()
|
75 |
+
except ConnectionFailedError as err:
|
76 |
+
raise UpdateFailed(
|
77 |
+
translation_domain=DOMAIN,
|
78 |
+
translation_key="failed_to_connect",
|
79 |
+
) from err
|
80 |
except InvalidAuthentication as err:
|
81 |
+
raise ConfigEntryError(
|
82 |
+
translation_domain=DOMAIN,
|
83 |
+
translation_key="authentication_failed",
|
84 |
+
) from err
|
85 |
except (InvalidXMLError, ResponseError) as err:
|
86 |
+
raise UpdateFailed(
|
87 |
+
translation_domain=DOMAIN,
|
88 |
+
translation_key="invalid_xml_data",
|
89 |
+
) from err
|
90 |
+
except PlugwiseError as err:
|
91 |
+
raise UpdateFailed(
|
92 |
+
translation_domain=DOMAIN,
|
93 |
+
translation_key="data_incomplete_or_missing",
|
94 |
+
) from err
|
95 |
except UnsupportedDeviceError as err:
|
96 |
+
raise ConfigEntryError(
|
97 |
+
translation_domain=DOMAIN,
|
98 |
+
translation_key="unsupported_firmware",
|
99 |
+
) from err
|
|
|
|
|
|
|
|
|
|
|
|
|
100 |
|
101 |
+
self._async_add_remove_devices(data, self.config_entry)
|
102 |
return data
|
103 |
+
|
104 |
+
def _async_add_remove_devices(self, data: PlugwiseData, entry: ConfigEntry) -> None:
|
105 |
+
"""Add new Plugwise devices, remove non-existing devices."""
|
106 |
+
# Check for new or removed devices
|
107 |
+
self.new_devices = set(data.devices) - self._current_devices
|
108 |
+
removed_devices = self._current_devices - set(data.devices)
|
109 |
+
self._current_devices = set(data.devices)
|
110 |
+
|
111 |
+
if removed_devices:
|
112 |
+
self._async_remove_devices(data, entry)
|
113 |
+
|
114 |
+
def _async_remove_devices(self, data: PlugwiseData, entry: ConfigEntry) -> None:
|
115 |
+
"""Clean registries when removed devices found."""
|
116 |
+
device_reg = dr.async_get(self.hass)
|
117 |
+
device_list = dr.async_entries_for_config_entry(
|
118 |
+
device_reg, self.config_entry.entry_id
|
119 |
+
)
|
120 |
+
# First find the Plugwise via_device
|
121 |
+
gateway_device = device_reg.async_get_device(
|
122 |
+
{(DOMAIN, data.gateway[GATEWAY_ID])}
|
123 |
+
)
|
124 |
+
assert gateway_device is not None
|
125 |
+
via_device_id = gateway_device.id
|
126 |
+
|
127 |
+
# Then remove the connected orphaned device(s)
|
128 |
+
for device_entry in device_list:
|
129 |
+
for identifier in device_entry.identifiers:
|
130 |
+
if identifier[0] == DOMAIN:
|
131 |
+
if (
|
132 |
+
device_entry.via_device_id == via_device_id
|
133 |
+
and identifier[1] not in data.devices
|
134 |
+
):
|
135 |
+
device_reg.async_update_device(
|
136 |
+
device_entry.id, remove_config_entry_id=entry.entry_id
|
137 |
+
)
|
138 |
+
LOGGER.debug(
|
139 |
+
"Removed %s device %s %s from device_registry",
|
140 |
+
DOMAIN,
|
141 |
+
device_entry.model,
|
142 |
+
identifier[1],
|
143 |
+
)
|
@@ -1,26 +1,20 @@
|
|
1 |
"""Diagnostics support for Plugwise."""
|
|
|
2 |
from __future__ import annotations
|
3 |
|
4 |
from typing import Any
|
5 |
|
6 |
-
from homeassistant.config_entries import ConfigEntry
|
7 |
from homeassistant.core import HomeAssistant
|
8 |
|
9 |
-
from .
|
10 |
-
COORDINATOR, # pw-beta
|
11 |
-
DOMAIN,
|
12 |
-
)
|
13 |
-
from .coordinator import PlugwiseDataUpdateCoordinator
|
14 |
|
15 |
|
16 |
async def async_get_config_entry_diagnostics(
|
17 |
-
hass: HomeAssistant, entry:
|
18 |
) -> dict[str, Any]:
|
19 |
"""Return diagnostics for a config entry."""
|
20 |
-
coordinator
|
21 |
-
COORDINATOR
|
22 |
-
]
|
23 |
return {
|
24 |
-
"gateway": coordinator.data.gateway,
|
25 |
"devices": coordinator.data.devices,
|
|
|
26 |
}
|
|
|
1 |
"""Diagnostics support for Plugwise."""
|
2 |
+
|
3 |
from __future__ import annotations
|
4 |
|
5 |
from typing import Any
|
6 |
|
|
|
7 |
from homeassistant.core import HomeAssistant
|
8 |
|
9 |
+
from . import PlugwiseConfigEntry
|
|
|
|
|
|
|
|
|
10 |
|
11 |
|
12 |
async def async_get_config_entry_diagnostics(
|
13 |
+
hass: HomeAssistant, entry: PlugwiseConfigEntry
|
14 |
) -> dict[str, Any]:
|
15 |
"""Return diagnostics for a config entry."""
|
16 |
+
coordinator = entry.runtime_data
|
|
|
|
|
17 |
return {
|
|
|
18 |
"devices": coordinator.data.devices,
|
19 |
+
"gateway": coordinator.data.gateway,
|
20 |
}
|
@@ -1,7 +1,8 @@
|
|
1 |
"""Generic Plugwise Entity Class."""
|
|
|
2 |
from __future__ import annotations
|
3 |
|
4 |
-
from plugwise.constants import
|
5 |
|
6 |
from homeassistant.const import ATTR_NAME, ATTR_VIA_DEVICE, CONF_HOST
|
7 |
from homeassistant.helpers.device_registry import (
|
@@ -46,6 +47,7 @@
|
|
46 |
connections=connections,
|
47 |
manufacturer=data.get("vendor"),
|
48 |
model=data.get("model"),
|
|
|
49 |
name=coordinator.data.gateway["smile_name"],
|
50 |
sw_version=data.get("firmware"),
|
51 |
hw_version=data.get("hardware"),
|
@@ -67,18 +69,11 @@
|
|
67 |
"""Return if entity is available."""
|
68 |
return (
|
69 |
self._dev_id in self.coordinator.data.devices
|
70 |
-
# Do not change the below line: some Plugwise devices
|
71 |
-
# do not provide their availability-status!
|
72 |
and ("available" not in self.device or self.device["available"] is True)
|
73 |
and super().available
|
74 |
)
|
75 |
|
76 |
@property
|
77 |
-
def device(self) ->
|
78 |
"""Return data for this device."""
|
79 |
return self.coordinator.data.devices[self._dev_id]
|
80 |
-
|
81 |
-
async def async_added_to_hass(self) -> None:
|
82 |
-
"""Subscribe to updates."""
|
83 |
-
self._handle_coordinator_update()
|
84 |
-
await super().async_added_to_hass()
|
|
|
1 |
"""Generic Plugwise Entity Class."""
|
2 |
+
|
3 |
from __future__ import annotations
|
4 |
|
5 |
+
from plugwise.constants import GwEntityData
|
6 |
|
7 |
from homeassistant.const import ATTR_NAME, ATTR_VIA_DEVICE, CONF_HOST
|
8 |
from homeassistant.helpers.device_registry import (
|
|
|
47 |
connections=connections,
|
48 |
manufacturer=data.get("vendor"),
|
49 |
model=data.get("model"),
|
50 |
+
model_id=data.get("model_id"),
|
51 |
name=coordinator.data.gateway["smile_name"],
|
52 |
sw_version=data.get("firmware"),
|
53 |
hw_version=data.get("hardware"),
|
|
|
69 |
"""Return if entity is available."""
|
70 |
return (
|
71 |
self._dev_id in self.coordinator.data.devices
|
|
|
|
|
72 |
and ("available" not in self.device or self.device["available"] is True)
|
73 |
and super().available
|
74 |
)
|
75 |
|
76 |
@property
|
77 |
+
def device(self) -> GwEntityData:
|
78 |
"""Return data for this device."""
|
79 |
return self.coordinator.data.devices[self._dev_id]
|
|
|
|
|
|
|
|
|
|
@@ -1,13 +1,12 @@
|
|
1 |
{
|
2 |
"domain": "plugwise",
|
3 |
-
"name": "Plugwise
|
4 |
-
"after_dependencies": ["zeroconf"],
|
5 |
"codeowners": ["@CoMPaTech", "@bouwew"],
|
6 |
"config_flow": true,
|
7 |
-
"documentation": "https://
|
8 |
"integration_type": "hub",
|
9 |
"iot_class": "local_polling",
|
10 |
"loggers": ["plugwise"],
|
11 |
-
"requirements": ["plugwise==
|
12 |
-
"
|
13 |
}
|
|
|
1 |
{
|
2 |
"domain": "plugwise",
|
3 |
+
"name": "Plugwise",
|
|
|
4 |
"codeowners": ["@CoMPaTech", "@bouwew"],
|
5 |
"config_flow": true,
|
6 |
+
"documentation": "https://www.home-assistant.io/integrations/plugwise",
|
7 |
"integration_type": "hub",
|
8 |
"iot_class": "local_polling",
|
9 |
"loggers": ["plugwise"],
|
10 |
+
"requirements": ["plugwise==1.6.4"],
|
11 |
+
"zeroconf": ["_plugwise._tcp.local."]
|
12 |
}
|
@@ -1,43 +1,30 @@
|
|
1 |
"""Number platform for Plugwise integration."""
|
|
|
2 |
from __future__ import annotations
|
3 |
|
4 |
-
from collections.abc import Awaitable, Callable
|
5 |
from dataclasses import dataclass
|
6 |
|
7 |
-
from plugwise import Smile
|
8 |
-
from plugwise.constants import NumberType
|
9 |
-
|
10 |
from homeassistant.components.number import (
|
11 |
NumberDeviceClass,
|
12 |
NumberEntity,
|
13 |
NumberEntityDescription,
|
14 |
NumberMode,
|
15 |
)
|
16 |
-
from homeassistant.config_entries import ConfigEntry
|
17 |
from homeassistant.const import EntityCategory, UnitOfTemperature
|
18 |
-
from homeassistant.core import HomeAssistant
|
19 |
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
20 |
|
21 |
-
from .
|
22 |
-
|
23 |
-
DOMAIN,
|
24 |
-
LOGGER,
|
25 |
-
)
|
26 |
from .coordinator import PlugwiseDataUpdateCoordinator
|
27 |
from .entity import PlugwiseEntity
|
|
|
28 |
|
|
|
29 |
|
30 |
-
@dataclass
|
31 |
-
class PlugwiseEntityDescriptionMixin:
|
32 |
-
"""Mixin values for Plugwise entities."""
|
33 |
-
|
34 |
-
command: Callable[[Smile, str, str, float], Awaitable[None]]
|
35 |
|
36 |
-
|
37 |
-
|
38 |
-
class PlugwiseNumberEntityDescription(
|
39 |
-
NumberEntityDescription, PlugwiseEntityDescriptionMixin
|
40 |
-
):
|
41 |
"""Class describing Plugwise Number entities."""
|
42 |
|
43 |
key: NumberType
|
@@ -47,9 +34,6 @@
|
|
47 |
PlugwiseNumberEntityDescription(
|
48 |
key="maximum_boiler_temperature",
|
49 |
translation_key="maximum_boiler_temperature",
|
50 |
-
command=lambda api, number, dev_id, value: api.set_number_setpoint(
|
51 |
-
number, dev_id, value
|
52 |
-
),
|
53 |
device_class=NumberDeviceClass.TEMPERATURE,
|
54 |
entity_category=EntityCategory.CONFIG,
|
55 |
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
@@ -57,9 +41,6 @@
|
|
57 |
PlugwiseNumberEntityDescription(
|
58 |
key="max_dhw_temperature",
|
59 |
translation_key="max_dhw_temperature",
|
60 |
-
command=lambda api, number, dev_id, value: api.set_number_setpoint(
|
61 |
-
number, dev_id, value
|
62 |
-
),
|
63 |
device_class=NumberDeviceClass.TEMPERATURE,
|
64 |
entity_category=EntityCategory.CONFIG,
|
65 |
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
@@ -67,9 +48,6 @@
|
|
67 |
PlugwiseNumberEntityDescription(
|
68 |
key="temperature_offset",
|
69 |
translation_key="temperature_offset",
|
70 |
-
command=lambda api, number, dev_id, value: api.set_temperature_offset(
|
71 |
-
number, dev_id, value
|
72 |
-
),
|
73 |
device_class=NumberDeviceClass.TEMPERATURE,
|
74 |
entity_category=EntityCategory.CONFIG,
|
75 |
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
@@ -79,27 +57,27 @@
|
|
79 |
|
80 |
async def async_setup_entry(
|
81 |
hass: HomeAssistant,
|
82 |
-
|
83 |
async_add_entities: AddEntitiesCallback,
|
84 |
) -> None:
|
85 |
"""Set up Plugwise number platform."""
|
|
|
86 |
|
87 |
-
|
88 |
-
|
89 |
-
|
90 |
-
|
91 |
-
|
92 |
-
|
93 |
-
|
94 |
-
|
95 |
-
|
96 |
-
|
97 |
-
|
98 |
-
|
99 |
-
"Add %s %s number", device["name"], description.translation_key
|
100 |
-
)
|
101 |
|
102 |
-
|
|
|
103 |
|
104 |
|
105 |
class PlugwiseNumberEntity(PlugwiseEntity, NumberEntity):
|
@@ -115,13 +93,12 @@
|
|
115 |
) -> None:
|
116 |
"""Initiate Plugwise Number."""
|
117 |
super().__init__(coordinator, device_id)
|
118 |
-
self.actuator = self.device[description.key]
|
119 |
-
self.device_id = device_id
|
120 |
-
self.entity_description = description
|
121 |
-
self._attr_unique_id = f"{device_id}-{description.key}"
|
122 |
self._attr_mode = NumberMode.BOX
|
123 |
self._attr_native_max_value = self.device[description.key]["upper_bound"]
|
124 |
self._attr_native_min_value = self.device[description.key]["lower_bound"]
|
|
|
|
|
|
|
125 |
|
126 |
native_step = self.device[description.key]["resolution"]
|
127 |
if description.key != "temperature_offset":
|
@@ -133,12 +110,9 @@
|
|
133 |
"""Return the present setpoint value."""
|
134 |
return self.device[self.entity_description.key]["setpoint"]
|
135 |
|
|
|
136 |
async def async_set_native_value(self, value: float) -> None:
|
137 |
"""Change to the new setpoint value."""
|
138 |
-
await self.
|
139 |
-
self.
|
140 |
-
)
|
141 |
-
LOGGER.debug(
|
142 |
-
"Setting %s to %s was successful", self.entity_description.name, value
|
143 |
)
|
144 |
-
await self.coordinator.async_request_refresh()
|
|
|
1 |
"""Number platform for Plugwise integration."""
|
2 |
+
|
3 |
from __future__ import annotations
|
4 |
|
|
|
5 |
from dataclasses import dataclass
|
6 |
|
|
|
|
|
|
|
7 |
from homeassistant.components.number import (
|
8 |
NumberDeviceClass,
|
9 |
NumberEntity,
|
10 |
NumberEntityDescription,
|
11 |
NumberMode,
|
12 |
)
|
|
|
13 |
from homeassistant.const import EntityCategory, UnitOfTemperature
|
14 |
+
from homeassistant.core import HomeAssistant, callback
|
15 |
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
16 |
|
17 |
+
from . import PlugwiseConfigEntry
|
18 |
+
from .const import NumberType
|
|
|
|
|
|
|
19 |
from .coordinator import PlugwiseDataUpdateCoordinator
|
20 |
from .entity import PlugwiseEntity
|
21 |
+
from .util import plugwise_command
|
22 |
|
23 |
+
PARALLEL_UPDATES = 0
|
24 |
|
|
|
|
|
|
|
|
|
|
|
25 |
|
26 |
+
@dataclass(frozen=True, kw_only=True)
|
27 |
+
class PlugwiseNumberEntityDescription(NumberEntityDescription):
|
|
|
|
|
|
|
28 |
"""Class describing Plugwise Number entities."""
|
29 |
|
30 |
key: NumberType
|
|
|
34 |
PlugwiseNumberEntityDescription(
|
35 |
key="maximum_boiler_temperature",
|
36 |
translation_key="maximum_boiler_temperature",
|
|
|
|
|
|
|
37 |
device_class=NumberDeviceClass.TEMPERATURE,
|
38 |
entity_category=EntityCategory.CONFIG,
|
39 |
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
|
|
41 |
PlugwiseNumberEntityDescription(
|
42 |
key="max_dhw_temperature",
|
43 |
translation_key="max_dhw_temperature",
|
|
|
|
|
|
|
44 |
device_class=NumberDeviceClass.TEMPERATURE,
|
45 |
entity_category=EntityCategory.CONFIG,
|
46 |
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
|
|
48 |
PlugwiseNumberEntityDescription(
|
49 |
key="temperature_offset",
|
50 |
translation_key="temperature_offset",
|
|
|
|
|
|
|
51 |
device_class=NumberDeviceClass.TEMPERATURE,
|
52 |
entity_category=EntityCategory.CONFIG,
|
53 |
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
|
|
57 |
|
58 |
async def async_setup_entry(
|
59 |
hass: HomeAssistant,
|
60 |
+
entry: PlugwiseConfigEntry,
|
61 |
async_add_entities: AddEntitiesCallback,
|
62 |
) -> None:
|
63 |
"""Set up Plugwise number platform."""
|
64 |
+
coordinator = entry.runtime_data
|
65 |
|
66 |
+
@callback
|
67 |
+
def _add_entities() -> None:
|
68 |
+
"""Add Entities."""
|
69 |
+
if not coordinator.new_devices:
|
70 |
+
return
|
71 |
+
|
72 |
+
async_add_entities(
|
73 |
+
PlugwiseNumberEntity(coordinator, device_id, description)
|
74 |
+
for device_id in coordinator.new_devices
|
75 |
+
for description in NUMBER_TYPES
|
76 |
+
if description.key in coordinator.data.devices[device_id]
|
77 |
+
)
|
|
|
|
|
78 |
|
79 |
+
_add_entities()
|
80 |
+
entry.async_on_unload(coordinator.async_add_listener(_add_entities))
|
81 |
|
82 |
|
83 |
class PlugwiseNumberEntity(PlugwiseEntity, NumberEntity):
|
|
|
93 |
) -> None:
|
94 |
"""Initiate Plugwise Number."""
|
95 |
super().__init__(coordinator, device_id)
|
|
|
|
|
|
|
|
|
96 |
self._attr_mode = NumberMode.BOX
|
97 |
self._attr_native_max_value = self.device[description.key]["upper_bound"]
|
98 |
self._attr_native_min_value = self.device[description.key]["lower_bound"]
|
99 |
+
self._attr_unique_id = f"{device_id}-{description.key}"
|
100 |
+
self.device_id = device_id
|
101 |
+
self.entity_description = description
|
102 |
|
103 |
native_step = self.device[description.key]["resolution"]
|
104 |
if description.key != "temperature_offset":
|
|
|
110 |
"""Return the present setpoint value."""
|
111 |
return self.device[self.entity_description.key]["setpoint"]
|
112 |
|
113 |
+
@plugwise_command
|
114 |
async def async_set_native_value(self, value: float) -> None:
|
115 |
"""Change to the new setpoint value."""
|
116 |
+
await self.coordinator.api.set_number(
|
117 |
+
self.device_id, self.entity_description.key, value
|
|
|
|
|
|
|
118 |
)
|
|
@@ -1,105 +1,81 @@
|
|
1 |
"""Plugwise Select component for Home Assistant."""
|
|
|
2 |
from __future__ import annotations
|
3 |
|
4 |
-
from collections.abc import Awaitable, Callable
|
5 |
from dataclasses import dataclass
|
6 |
|
7 |
-
from plugwise import Smile
|
8 |
-
|
9 |
from homeassistant.components.select import SelectEntity, SelectEntityDescription
|
10 |
-
from homeassistant.config_entries import ConfigEntry
|
11 |
from homeassistant.const import STATE_ON, EntityCategory
|
12 |
-
from homeassistant.core import HomeAssistant
|
13 |
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
14 |
|
15 |
-
from .
|
16 |
-
|
17 |
-
DOMAIN,
|
18 |
-
LOGGER,
|
19 |
-
SelectOptionsType,
|
20 |
-
SelectType,
|
21 |
-
)
|
22 |
from .coordinator import PlugwiseDataUpdateCoordinator
|
23 |
from .entity import PlugwiseEntity
|
|
|
24 |
|
25 |
PARALLEL_UPDATES = 0
|
26 |
|
27 |
|
28 |
-
@dataclass
|
29 |
-
class
|
30 |
-
"""Mixin values for Plugwise Select entities."""
|
31 |
-
|
32 |
-
command: Callable[[Smile, str, str], Awaitable[None]]
|
33 |
-
options_key: SelectOptionsType
|
34 |
-
|
35 |
-
|
36 |
-
@dataclass
|
37 |
-
class PlugwiseSelectEntityDescription(
|
38 |
-
SelectEntityDescription, PlugwiseSelectDescriptionMixin
|
39 |
-
):
|
40 |
"""Class describing Plugwise Select entities."""
|
41 |
|
42 |
key: SelectType
|
|
|
43 |
|
44 |
|
45 |
SELECT_TYPES = (
|
46 |
PlugwiseSelectEntityDescription(
|
47 |
key="select_schedule",
|
48 |
-
translation_key="
|
49 |
-
icon="mdi:calendar-clock",
|
50 |
-
command=lambda api, loc, opt: api.set_schedule_state(loc, STATE_ON, opt),
|
51 |
options_key="available_schedules",
|
52 |
),
|
53 |
PlugwiseSelectEntityDescription(
|
54 |
-
key="active_preset",
|
55 |
-
translation_key="thermostat_preset",
|
56 |
-
icon="mdi:room_preferences",
|
57 |
-
command=lambda api, loc, opt: api.set_preset(loc, opt),
|
58 |
-
options_key="preset_modes",
|
59 |
-
),
|
60 |
-
PlugwiseSelectEntityDescription(
|
61 |
key="select_regulation_mode",
|
62 |
translation_key="regulation_mode",
|
63 |
-
icon="mdi:hvac",
|
64 |
entity_category=EntityCategory.CONFIG,
|
65 |
-
command=lambda api, loc, opt: api.set_regulation_mode(opt),
|
66 |
options_key="regulation_modes",
|
67 |
),
|
68 |
PlugwiseSelectEntityDescription(
|
69 |
key="select_dhw_mode",
|
70 |
translation_key="dhw_mode",
|
71 |
-
icon="mdi:shower",
|
72 |
entity_category=EntityCategory.CONFIG,
|
73 |
-
command=lambda api, loc, opt: api.set_dhw_mode(opt),
|
74 |
options_key="dhw_modes",
|
75 |
),
|
|
|
|
|
|
|
|
|
|
|
|
|
76 |
)
|
77 |
|
78 |
|
79 |
async def async_setup_entry(
|
80 |
hass: HomeAssistant,
|
81 |
-
|
82 |
async_add_entities: AddEntitiesCallback,
|
83 |
) -> None:
|
84 |
"""Set up the Smile selector from a config entry."""
|
85 |
-
coordinator
|
86 |
-
|
87 |
-
|
88 |
-
|
89 |
-
|
90 |
-
|
91 |
-
|
92 |
-
|
93 |
-
|
94 |
-
|
95 |
-
|
96 |
-
|
97 |
-
|
98 |
-
|
99 |
-
"Add %s %s selector", device["name"], description.translation_key
|
100 |
-
)
|
101 |
|
102 |
-
|
|
|
103 |
|
104 |
|
105 |
class PlugwiseSelectEntity(PlugwiseEntity, SelectEntity):
|
@@ -115,25 +91,29 @@
|
|
115 |
) -> None:
|
116 |
"""Initialise the selector."""
|
117 |
super().__init__(coordinator, device_id)
|
118 |
-
self.entity_description = entity_description
|
119 |
self._attr_unique_id = f"{device_id}-{entity_description.key}"
|
120 |
-
self.
|
121 |
-
|
122 |
-
|
|
|
|
|
123 |
|
124 |
@property
|
125 |
-
def current_option(self) -> str
|
126 |
"""Return the selected entity option to represent the entity state."""
|
127 |
return self.device[self.entity_description.key]
|
128 |
|
|
|
|
|
|
|
|
|
|
|
|
|
129 |
async def async_select_option(self, option: str) -> None:
|
130 |
-
"""Change to the selected entity option.
|
131 |
-
|
132 |
-
|
133 |
-
|
134 |
-
|
135 |
-
|
136 |
-
self.entity_description.name,
|
137 |
-
option,
|
138 |
)
|
139 |
-
await self.coordinator.async_request_refresh()
|
|
|
1 |
"""Plugwise Select component for Home Assistant."""
|
2 |
+
|
3 |
from __future__ import annotations
|
4 |
|
|
|
5 |
from dataclasses import dataclass
|
6 |
|
|
|
|
|
7 |
from homeassistant.components.select import SelectEntity, SelectEntityDescription
|
|
|
8 |
from homeassistant.const import STATE_ON, EntityCategory
|
9 |
+
from homeassistant.core import HomeAssistant, callback
|
10 |
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
11 |
|
12 |
+
from . import PlugwiseConfigEntry
|
13 |
+
from .const import SelectOptionsType, SelectType
|
|
|
|
|
|
|
|
|
|
|
14 |
from .coordinator import PlugwiseDataUpdateCoordinator
|
15 |
from .entity import PlugwiseEntity
|
16 |
+
from .util import plugwise_command
|
17 |
|
18 |
PARALLEL_UPDATES = 0
|
19 |
|
20 |
|
21 |
+
@dataclass(frozen=True, kw_only=True)
|
22 |
+
class PlugwiseSelectEntityDescription(SelectEntityDescription):
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
23 |
"""Class describing Plugwise Select entities."""
|
24 |
|
25 |
key: SelectType
|
26 |
+
options_key: SelectOptionsType
|
27 |
|
28 |
|
29 |
SELECT_TYPES = (
|
30 |
PlugwiseSelectEntityDescription(
|
31 |
key="select_schedule",
|
32 |
+
translation_key="select_schedule",
|
|
|
|
|
33 |
options_key="available_schedules",
|
34 |
),
|
35 |
PlugwiseSelectEntityDescription(
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
36 |
key="select_regulation_mode",
|
37 |
translation_key="regulation_mode",
|
|
|
38 |
entity_category=EntityCategory.CONFIG,
|
|
|
39 |
options_key="regulation_modes",
|
40 |
),
|
41 |
PlugwiseSelectEntityDescription(
|
42 |
key="select_dhw_mode",
|
43 |
translation_key="dhw_mode",
|
|
|
44 |
entity_category=EntityCategory.CONFIG,
|
|
|
45 |
options_key="dhw_modes",
|
46 |
),
|
47 |
+
PlugwiseSelectEntityDescription(
|
48 |
+
key="select_gateway_mode",
|
49 |
+
translation_key="gateway_mode",
|
50 |
+
entity_category=EntityCategory.CONFIG,
|
51 |
+
options_key="gateway_modes",
|
52 |
+
),
|
53 |
)
|
54 |
|
55 |
|
56 |
async def async_setup_entry(
|
57 |
hass: HomeAssistant,
|
58 |
+
entry: PlugwiseConfigEntry,
|
59 |
async_add_entities: AddEntitiesCallback,
|
60 |
) -> None:
|
61 |
"""Set up the Smile selector from a config entry."""
|
62 |
+
coordinator = entry.runtime_data
|
63 |
+
|
64 |
+
@callback
|
65 |
+
def _add_entities() -> None:
|
66 |
+
"""Add Entities."""
|
67 |
+
if not coordinator.new_devices:
|
68 |
+
return
|
69 |
+
|
70 |
+
async_add_entities(
|
71 |
+
PlugwiseSelectEntity(coordinator, device_id, description)
|
72 |
+
for device_id in coordinator.new_devices
|
73 |
+
for description in SELECT_TYPES
|
74 |
+
if description.options_key in coordinator.data.devices[device_id]
|
75 |
+
)
|
|
|
|
|
76 |
|
77 |
+
_add_entities()
|
78 |
+
entry.async_on_unload(coordinator.async_add_listener(_add_entities))
|
79 |
|
80 |
|
81 |
class PlugwiseSelectEntity(PlugwiseEntity, SelectEntity):
|
|
|
91 |
) -> None:
|
92 |
"""Initialise the selector."""
|
93 |
super().__init__(coordinator, device_id)
|
|
|
94 |
self._attr_unique_id = f"{device_id}-{entity_description.key}"
|
95 |
+
self.entity_description = entity_description
|
96 |
+
|
97 |
+
self._location = device_id
|
98 |
+
if (location := self.device.get("location")) is not None:
|
99 |
+
self._location = location
|
100 |
|
101 |
@property
|
102 |
+
def current_option(self) -> str:
|
103 |
"""Return the selected entity option to represent the entity state."""
|
104 |
return self.device[self.entity_description.key]
|
105 |
|
106 |
+
@property
|
107 |
+
def options(self) -> list[str]:
|
108 |
+
"""Return the available select-options."""
|
109 |
+
return self.device[self.entity_description.options_key]
|
110 |
+
|
111 |
+
@plugwise_command
|
112 |
async def async_select_option(self, option: str) -> None:
|
113 |
+
"""Change to the selected entity option.
|
114 |
+
|
115 |
+
self._location and STATE_ON are required for the thermostat-schedule select.
|
116 |
+
"""
|
117 |
+
await self.coordinator.api.set_select(
|
118 |
+
self.entity_description.key, self._location, option, STATE_ON
|
|
|
|
|
119 |
)
|
|
@@ -1,4 +1,5 @@
|
|
1 |
"""Plugwise Sensor component for Home Assistant."""
|
|
|
2 |
from __future__ import annotations
|
3 |
|
4 |
from dataclasses import dataclass
|
@@ -11,7 +12,6 @@
|
|
11 |
SensorEntityDescription,
|
12 |
SensorStateClass,
|
13 |
)
|
14 |
-
from homeassistant.config_entries import ConfigEntry
|
15 |
from homeassistant.const import (
|
16 |
LIGHT_LUX,
|
17 |
PERCENTAGE,
|
@@ -24,178 +24,194 @@
|
|
24 |
UnitOfVolume,
|
25 |
UnitOfVolumeFlowRate,
|
26 |
)
|
27 |
-
from homeassistant.core import HomeAssistant
|
28 |
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
29 |
|
30 |
-
from .
|
31 |
-
COORDINATOR, # pw-beta
|
32 |
-
DOMAIN,
|
33 |
-
LOGGER,
|
34 |
-
)
|
35 |
from .coordinator import PlugwiseDataUpdateCoordinator
|
36 |
from .entity import PlugwiseEntity
|
37 |
|
|
|
38 |
PARALLEL_UPDATES = 0
|
39 |
|
40 |
|
41 |
-
@dataclass
|
42 |
class PlugwiseSensorEntityDescription(SensorEntityDescription):
|
43 |
"""Describes Plugwise sensor entity."""
|
44 |
|
45 |
key: SensorType
|
46 |
-
state_class: str | None = SensorStateClass.MEASUREMENT
|
47 |
|
48 |
|
49 |
SENSORS: tuple[PlugwiseSensorEntityDescription, ...] = (
|
50 |
PlugwiseSensorEntityDescription(
|
51 |
key="setpoint",
|
52 |
translation_key="setpoint",
|
|
|
53 |
device_class=SensorDeviceClass.TEMPERATURE,
|
|
|
54 |
entity_category=EntityCategory.DIAGNOSTIC,
|
55 |
-
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
56 |
),
|
57 |
PlugwiseSensorEntityDescription(
|
58 |
key="setpoint_high",
|
59 |
translation_key="cooling_setpoint",
|
|
|
60 |
device_class=SensorDeviceClass.TEMPERATURE,
|
|
|
61 |
entity_category=EntityCategory.DIAGNOSTIC,
|
62 |
-
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
63 |
),
|
64 |
PlugwiseSensorEntityDescription(
|
65 |
key="setpoint_low",
|
66 |
translation_key="heating_setpoint",
|
|
|
67 |
device_class=SensorDeviceClass.TEMPERATURE,
|
|
|
68 |
entity_category=EntityCategory.DIAGNOSTIC,
|
69 |
-
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
70 |
),
|
71 |
PlugwiseSensorEntityDescription(
|
72 |
key="temperature",
|
|
|
73 |
device_class=SensorDeviceClass.TEMPERATURE,
|
74 |
entity_category=EntityCategory.DIAGNOSTIC,
|
75 |
-
|
76 |
),
|
77 |
PlugwiseSensorEntityDescription(
|
78 |
key="intended_boiler_temperature",
|
79 |
translation_key="intended_boiler_temperature",
|
|
|
80 |
device_class=SensorDeviceClass.TEMPERATURE,
|
81 |
entity_category=EntityCategory.DIAGNOSTIC,
|
82 |
-
|
83 |
),
|
84 |
PlugwiseSensorEntityDescription(
|
85 |
key="temperature_difference",
|
86 |
translation_key="temperature_difference",
|
87 |
-
entity_category=EntityCategory.DIAGNOSTIC,
|
88 |
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
|
|
|
|
|
|
89 |
),
|
90 |
PlugwiseSensorEntityDescription(
|
91 |
key="outdoor_temperature",
|
92 |
translation_key="outdoor_temperature",
|
93 |
-
device_class=SensorDeviceClass.TEMPERATURE,
|
94 |
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
95 |
-
|
|
|
96 |
),
|
97 |
PlugwiseSensorEntityDescription(
|
98 |
key="outdoor_air_temperature",
|
99 |
translation_key="outdoor_air_temperature",
|
|
|
100 |
device_class=SensorDeviceClass.TEMPERATURE,
|
101 |
entity_category=EntityCategory.DIAGNOSTIC,
|
102 |
-
|
103 |
-
suggested_display_precision=1,
|
104 |
),
|
105 |
PlugwiseSensorEntityDescription(
|
106 |
key="water_temperature",
|
107 |
translation_key="water_temperature",
|
|
|
108 |
device_class=SensorDeviceClass.TEMPERATURE,
|
109 |
entity_category=EntityCategory.DIAGNOSTIC,
|
110 |
-
|
111 |
),
|
112 |
PlugwiseSensorEntityDescription(
|
113 |
key="return_temperature",
|
114 |
translation_key="return_temperature",
|
|
|
115 |
device_class=SensorDeviceClass.TEMPERATURE,
|
116 |
entity_category=EntityCategory.DIAGNOSTIC,
|
117 |
-
|
118 |
),
|
119 |
PlugwiseSensorEntityDescription(
|
120 |
key="electricity_consumed",
|
121 |
translation_key="electricity_consumed",
|
122 |
-
device_class=SensorDeviceClass.POWER,
|
123 |
native_unit_of_measurement=UnitOfPower.WATT,
|
|
|
|
|
124 |
),
|
125 |
PlugwiseSensorEntityDescription(
|
126 |
key="electricity_produced",
|
127 |
translation_key="electricity_produced",
|
128 |
-
device_class=SensorDeviceClass.POWER,
|
129 |
native_unit_of_measurement=UnitOfPower.WATT,
|
|
|
|
|
130 |
entity_registry_enabled_default=False,
|
131 |
),
|
132 |
PlugwiseSensorEntityDescription(
|
133 |
key="electricity_consumed_interval",
|
134 |
translation_key="electricity_consumed_interval",
|
135 |
-
icon="mdi:lightning-bolt",
|
136 |
native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,
|
|
|
|
|
137 |
),
|
138 |
PlugwiseSensorEntityDescription(
|
139 |
key="electricity_consumed_peak_interval",
|
140 |
translation_key="electricity_consumed_peak_interval",
|
141 |
-
icon="mdi:lightning-bolt",
|
142 |
native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,
|
|
|
|
|
143 |
),
|
144 |
PlugwiseSensorEntityDescription(
|
145 |
key="electricity_consumed_off_peak_interval",
|
146 |
translation_key="electricity_consumed_off_peak_interval",
|
147 |
-
icon="mdi:lightning-bolt",
|
148 |
native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,
|
|
|
|
|
149 |
),
|
150 |
PlugwiseSensorEntityDescription(
|
151 |
key="electricity_produced_interval",
|
152 |
translation_key="electricity_produced_interval",
|
153 |
-
icon="mdi:lightning-bolt",
|
154 |
native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,
|
|
|
|
|
155 |
entity_registry_enabled_default=False,
|
156 |
),
|
157 |
PlugwiseSensorEntityDescription(
|
158 |
key="electricity_produced_peak_interval",
|
159 |
translation_key="electricity_produced_peak_interval",
|
160 |
-
icon="mdi:lightning-bolt",
|
161 |
native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,
|
|
|
|
|
162 |
),
|
163 |
PlugwiseSensorEntityDescription(
|
164 |
key="electricity_produced_off_peak_interval",
|
165 |
translation_key="electricity_produced_off_peak_interval",
|
166 |
-
icon="mdi:lightning-bolt",
|
167 |
native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,
|
|
|
|
|
168 |
),
|
169 |
PlugwiseSensorEntityDescription(
|
170 |
key="electricity_consumed_point",
|
171 |
translation_key="electricity_consumed_point",
|
172 |
device_class=SensorDeviceClass.POWER,
|
173 |
native_unit_of_measurement=UnitOfPower.WATT,
|
|
|
174 |
),
|
175 |
PlugwiseSensorEntityDescription(
|
176 |
key="electricity_consumed_off_peak_point",
|
177 |
translation_key="electricity_consumed_off_peak_point",
|
178 |
-
device_class=SensorDeviceClass.POWER,
|
179 |
native_unit_of_measurement=UnitOfPower.WATT,
|
|
|
|
|
180 |
),
|
181 |
PlugwiseSensorEntityDescription(
|
182 |
key="electricity_consumed_peak_point",
|
183 |
translation_key="electricity_consumed_peak_point",
|
184 |
-
device_class=SensorDeviceClass.POWER,
|
185 |
native_unit_of_measurement=UnitOfPower.WATT,
|
|
|
|
|
186 |
),
|
187 |
PlugwiseSensorEntityDescription(
|
188 |
key="electricity_consumed_off_peak_cumulative",
|
189 |
translation_key="electricity_consumed_off_peak_cumulative",
|
190 |
-
device_class=SensorDeviceClass.ENERGY,
|
191 |
native_unit_of_measurement=UnitOfEnergy.KILO_WATT_HOUR,
|
|
|
192 |
state_class=SensorStateClass.TOTAL_INCREASING,
|
193 |
),
|
194 |
PlugwiseSensorEntityDescription(
|
195 |
key="electricity_consumed_peak_cumulative",
|
196 |
translation_key="electricity_consumed_peak_cumulative",
|
197 |
-
device_class=SensorDeviceClass.ENERGY,
|
198 |
native_unit_of_measurement=UnitOfEnergy.KILO_WATT_HOUR,
|
|
|
199 |
state_class=SensorStateClass.TOTAL_INCREASING,
|
200 |
),
|
201 |
PlugwiseSensorEntityDescription(
|
@@ -203,24 +219,27 @@
|
|
203 |
translation_key="electricity_produced_point",
|
204 |
device_class=SensorDeviceClass.POWER,
|
205 |
native_unit_of_measurement=UnitOfPower.WATT,
|
|
|
206 |
),
|
207 |
PlugwiseSensorEntityDescription(
|
208 |
key="electricity_produced_off_peak_point",
|
209 |
translation_key="electricity_produced_off_peak_point",
|
210 |
-
device_class=SensorDeviceClass.POWER,
|
211 |
native_unit_of_measurement=UnitOfPower.WATT,
|
|
|
|
|
212 |
),
|
213 |
PlugwiseSensorEntityDescription(
|
214 |
key="electricity_produced_peak_point",
|
215 |
translation_key="electricity_produced_peak_point",
|
216 |
-
device_class=SensorDeviceClass.POWER,
|
217 |
native_unit_of_measurement=UnitOfPower.WATT,
|
|
|
|
|
218 |
),
|
219 |
PlugwiseSensorEntityDescription(
|
220 |
key="electricity_produced_off_peak_cumulative",
|
221 |
translation_key="electricity_produced_off_peak_cumulative",
|
222 |
-
device_class=SensorDeviceClass.ENERGY,
|
223 |
native_unit_of_measurement=UnitOfEnergy.KILO_WATT_HOUR,
|
|
|
224 |
state_class=SensorStateClass.TOTAL_INCREASING,
|
225 |
),
|
226 |
PlugwiseSensorEntityDescription(
|
@@ -233,45 +252,51 @@
|
|
233 |
PlugwiseSensorEntityDescription(
|
234 |
key="electricity_phase_one_consumed",
|
235 |
translation_key="electricity_phase_one_consumed",
|
236 |
-
name="Electricity phase one consumed",
|
237 |
device_class=SensorDeviceClass.POWER,
|
238 |
native_unit_of_measurement=UnitOfPower.WATT,
|
|
|
239 |
),
|
240 |
PlugwiseSensorEntityDescription(
|
241 |
key="electricity_phase_two_consumed",
|
242 |
translation_key="electricity_phase_two_consumed",
|
243 |
device_class=SensorDeviceClass.POWER,
|
244 |
native_unit_of_measurement=UnitOfPower.WATT,
|
|
|
245 |
),
|
246 |
PlugwiseSensorEntityDescription(
|
247 |
key="electricity_phase_three_consumed",
|
248 |
translation_key="electricity_phase_three_consumed",
|
249 |
device_class=SensorDeviceClass.POWER,
|
250 |
native_unit_of_measurement=UnitOfPower.WATT,
|
|
|
251 |
),
|
252 |
PlugwiseSensorEntityDescription(
|
253 |
key="electricity_phase_one_produced",
|
254 |
translation_key="electricity_phase_one_produced",
|
255 |
device_class=SensorDeviceClass.POWER,
|
256 |
native_unit_of_measurement=UnitOfPower.WATT,
|
|
|
257 |
),
|
258 |
PlugwiseSensorEntityDescription(
|
259 |
key="electricity_phase_two_produced",
|
260 |
translation_key="electricity_phase_two_produced",
|
261 |
device_class=SensorDeviceClass.POWER,
|
262 |
native_unit_of_measurement=UnitOfPower.WATT,
|
|
|
263 |
),
|
264 |
PlugwiseSensorEntityDescription(
|
265 |
key="electricity_phase_three_produced",
|
266 |
translation_key="electricity_phase_three_produced",
|
267 |
device_class=SensorDeviceClass.POWER,
|
268 |
native_unit_of_measurement=UnitOfPower.WATT,
|
|
|
269 |
),
|
270 |
PlugwiseSensorEntityDescription(
|
271 |
key="voltage_phase_one",
|
272 |
translation_key="voltage_phase_one",
|
273 |
device_class=SensorDeviceClass.VOLTAGE,
|
274 |
native_unit_of_measurement=UnitOfElectricPotential.VOLT,
|
|
|
275 |
entity_registry_enabled_default=False,
|
276 |
),
|
277 |
PlugwiseSensorEntityDescription(
|
@@ -279,6 +304,7 @@
|
|
279 |
translation_key="voltage_phase_two",
|
280 |
device_class=SensorDeviceClass.VOLTAGE,
|
281 |
native_unit_of_measurement=UnitOfElectricPotential.VOLT,
|
|
|
282 |
entity_registry_enabled_default=False,
|
283 |
),
|
284 |
PlugwiseSensorEntityDescription(
|
@@ -286,116 +312,121 @@
|
|
286 |
translation_key="voltage_phase_three",
|
287 |
device_class=SensorDeviceClass.VOLTAGE,
|
288 |
native_unit_of_measurement=UnitOfElectricPotential.VOLT,
|
|
|
289 |
entity_registry_enabled_default=False,
|
290 |
),
|
291 |
PlugwiseSensorEntityDescription(
|
292 |
key="gas_consumed_interval",
|
293 |
translation_key="gas_consumed_interval",
|
294 |
-
icon="mdi:meter-gas",
|
295 |
native_unit_of_measurement=UnitOfVolumeFlowRate.CUBIC_METERS_PER_HOUR,
|
|
|
296 |
),
|
297 |
PlugwiseSensorEntityDescription(
|
298 |
key="gas_consumed_cumulative",
|
299 |
translation_key="gas_consumed_cumulative",
|
300 |
-
device_class=SensorDeviceClass.GAS,
|
301 |
native_unit_of_measurement=UnitOfVolume.CUBIC_METERS,
|
302 |
-
|
|
|
303 |
),
|
304 |
PlugwiseSensorEntityDescription(
|
305 |
key="net_electricity_point",
|
306 |
translation_key="net_electricity_point",
|
307 |
-
device_class=SensorDeviceClass.POWER,
|
308 |
native_unit_of_measurement=UnitOfPower.WATT,
|
|
|
|
|
309 |
),
|
310 |
PlugwiseSensorEntityDescription(
|
311 |
key="net_electricity_cumulative",
|
312 |
translation_key="net_electricity_cumulative",
|
313 |
-
device_class=SensorDeviceClass.ENERGY,
|
314 |
native_unit_of_measurement=UnitOfEnergy.KILO_WATT_HOUR,
|
|
|
315 |
state_class=SensorStateClass.TOTAL,
|
316 |
),
|
317 |
PlugwiseSensorEntityDescription(
|
318 |
key="battery",
|
|
|
319 |
device_class=SensorDeviceClass.BATTERY,
|
320 |
entity_category=EntityCategory.DIAGNOSTIC,
|
321 |
-
|
322 |
),
|
323 |
PlugwiseSensorEntityDescription(
|
324 |
key="illuminance",
|
|
|
325 |
device_class=SensorDeviceClass.ILLUMINANCE,
|
|
|
326 |
entity_category=EntityCategory.DIAGNOSTIC,
|
327 |
-
native_unit_of_measurement=LIGHT_LUX,
|
328 |
),
|
329 |
PlugwiseSensorEntityDescription(
|
330 |
key="modulation_level",
|
331 |
translation_key="modulation_level",
|
332 |
-
entity_category=EntityCategory.DIAGNOSTIC,
|
333 |
native_unit_of_measurement=PERCENTAGE,
|
334 |
-
|
|
|
335 |
),
|
336 |
PlugwiseSensorEntityDescription(
|
337 |
key="valve_position",
|
338 |
translation_key="valve_position",
|
339 |
-
icon="mdi:valve",
|
340 |
entity_category=EntityCategory.DIAGNOSTIC,
|
341 |
native_unit_of_measurement=PERCENTAGE,
|
|
|
342 |
),
|
343 |
PlugwiseSensorEntityDescription(
|
344 |
key="water_pressure",
|
345 |
translation_key="water_pressure",
|
|
|
346 |
device_class=SensorDeviceClass.PRESSURE,
|
347 |
entity_category=EntityCategory.DIAGNOSTIC,
|
348 |
-
|
349 |
),
|
350 |
PlugwiseSensorEntityDescription(
|
351 |
key="humidity",
|
352 |
-
device_class=SensorDeviceClass.HUMIDITY,
|
353 |
native_unit_of_measurement=PERCENTAGE,
|
|
|
|
|
354 |
),
|
355 |
PlugwiseSensorEntityDescription(
|
356 |
key="dhw_temperature",
|
357 |
translation_key="dhw_temperature",
|
|
|
358 |
device_class=SensorDeviceClass.TEMPERATURE,
|
359 |
entity_category=EntityCategory.DIAGNOSTIC,
|
360 |
-
|
361 |
),
|
362 |
PlugwiseSensorEntityDescription(
|
363 |
key="domestic_hot_water_setpoint",
|
364 |
translation_key="domestic_hot_water_setpoint",
|
|
|
365 |
device_class=SensorDeviceClass.TEMPERATURE,
|
366 |
entity_category=EntityCategory.DIAGNOSTIC,
|
367 |
-
|
368 |
),
|
369 |
)
|
370 |
|
371 |
|
372 |
async def async_setup_entry(
|
373 |
hass: HomeAssistant,
|
374 |
-
|
375 |
async_add_entities: AddEntitiesCallback,
|
376 |
) -> None:
|
377 |
"""Set up the Smile sensors from a config entry."""
|
378 |
-
coordinator =
|
379 |
|
380 |
-
|
381 |
-
|
382 |
-
|
383 |
-
|
384 |
-
|
385 |
-
|
386 |
-
|
387 |
-
|
388 |
-
|
389 |
-
|
390 |
-
|
391 |
-
|
392 |
-
|
393 |
-
)
|
394 |
-
LOGGER.debug(
|
395 |
-
"Add %s %s sensor", device["name"], description.translation_key
|
396 |
-
)
|
397 |
|
398 |
-
|
|
|
399 |
|
400 |
|
401 |
class PlugwiseSensorEntity(PlugwiseEntity, SensorEntity):
|
@@ -411,8 +442,8 @@
|
|
411 |
) -> None:
|
412 |
"""Initialise the sensor."""
|
413 |
super().__init__(coordinator, device_id)
|
414 |
-
self.entity_description = description
|
415 |
self._attr_unique_id = f"{device_id}-{description.key}"
|
|
|
416 |
|
417 |
@property
|
418 |
def native_value(self) -> int | float:
|
|
|
1 |
"""Plugwise Sensor component for Home Assistant."""
|
2 |
+
|
3 |
from __future__ import annotations
|
4 |
|
5 |
from dataclasses import dataclass
|
|
|
12 |
SensorEntityDescription,
|
13 |
SensorStateClass,
|
14 |
)
|
|
|
15 |
from homeassistant.const import (
|
16 |
LIGHT_LUX,
|
17 |
PERCENTAGE,
|
|
|
24 |
UnitOfVolume,
|
25 |
UnitOfVolumeFlowRate,
|
26 |
)
|
27 |
+
from homeassistant.core import HomeAssistant, callback
|
28 |
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
29 |
|
30 |
+
from . import PlugwiseConfigEntry
|
|
|
|
|
|
|
|
|
31 |
from .coordinator import PlugwiseDataUpdateCoordinator
|
32 |
from .entity import PlugwiseEntity
|
33 |
|
34 |
+
# Coordinator is used to centralize the data updates
|
35 |
PARALLEL_UPDATES = 0
|
36 |
|
37 |
|
38 |
+
@dataclass(frozen=True)
|
39 |
class PlugwiseSensorEntityDescription(SensorEntityDescription):
|
40 |
"""Describes Plugwise sensor entity."""
|
41 |
|
42 |
key: SensorType
|
|
|
43 |
|
44 |
|
45 |
SENSORS: tuple[PlugwiseSensorEntityDescription, ...] = (
|
46 |
PlugwiseSensorEntityDescription(
|
47 |
key="setpoint",
|
48 |
translation_key="setpoint",
|
49 |
+
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
50 |
device_class=SensorDeviceClass.TEMPERATURE,
|
51 |
+
state_class=SensorStateClass.MEASUREMENT,
|
52 |
entity_category=EntityCategory.DIAGNOSTIC,
|
|
|
53 |
),
|
54 |
PlugwiseSensorEntityDescription(
|
55 |
key="setpoint_high",
|
56 |
translation_key="cooling_setpoint",
|
57 |
+
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
58 |
device_class=SensorDeviceClass.TEMPERATURE,
|
59 |
+
state_class=SensorStateClass.MEASUREMENT,
|
60 |
entity_category=EntityCategory.DIAGNOSTIC,
|
|
|
61 |
),
|
62 |
PlugwiseSensorEntityDescription(
|
63 |
key="setpoint_low",
|
64 |
translation_key="heating_setpoint",
|
65 |
+
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
66 |
device_class=SensorDeviceClass.TEMPERATURE,
|
67 |
+
state_class=SensorStateClass.MEASUREMENT,
|
68 |
entity_category=EntityCategory.DIAGNOSTIC,
|
|
|
69 |
),
|
70 |
PlugwiseSensorEntityDescription(
|
71 |
key="temperature",
|
72 |
+
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
73 |
device_class=SensorDeviceClass.TEMPERATURE,
|
74 |
entity_category=EntityCategory.DIAGNOSTIC,
|
75 |
+
state_class=SensorStateClass.MEASUREMENT,
|
76 |
),
|
77 |
PlugwiseSensorEntityDescription(
|
78 |
key="intended_boiler_temperature",
|
79 |
translation_key="intended_boiler_temperature",
|
80 |
+
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
81 |
device_class=SensorDeviceClass.TEMPERATURE,
|
82 |
entity_category=EntityCategory.DIAGNOSTIC,
|
83 |
+
state_class=SensorStateClass.MEASUREMENT,
|
84 |
),
|
85 |
PlugwiseSensorEntityDescription(
|
86 |
key="temperature_difference",
|
87 |
translation_key="temperature_difference",
|
|
|
88 |
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
89 |
+
device_class=SensorDeviceClass.TEMPERATURE,
|
90 |
+
entity_category=EntityCategory.DIAGNOSTIC,
|
91 |
+
state_class=SensorStateClass.MEASUREMENT,
|
92 |
),
|
93 |
PlugwiseSensorEntityDescription(
|
94 |
key="outdoor_temperature",
|
95 |
translation_key="outdoor_temperature",
|
|
|
96 |
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
97 |
+
device_class=SensorDeviceClass.TEMPERATURE,
|
98 |
+
state_class=SensorStateClass.MEASUREMENT,
|
99 |
),
|
100 |
PlugwiseSensorEntityDescription(
|
101 |
key="outdoor_air_temperature",
|
102 |
translation_key="outdoor_air_temperature",
|
103 |
+
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
104 |
device_class=SensorDeviceClass.TEMPERATURE,
|
105 |
entity_category=EntityCategory.DIAGNOSTIC,
|
106 |
+
state_class=SensorStateClass.MEASUREMENT,
|
|
|
107 |
),
|
108 |
PlugwiseSensorEntityDescription(
|
109 |
key="water_temperature",
|
110 |
translation_key="water_temperature",
|
111 |
+
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
112 |
device_class=SensorDeviceClass.TEMPERATURE,
|
113 |
entity_category=EntityCategory.DIAGNOSTIC,
|
114 |
+
state_class=SensorStateClass.MEASUREMENT,
|
115 |
),
|
116 |
PlugwiseSensorEntityDescription(
|
117 |
key="return_temperature",
|
118 |
translation_key="return_temperature",
|
119 |
+
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
120 |
device_class=SensorDeviceClass.TEMPERATURE,
|
121 |
entity_category=EntityCategory.DIAGNOSTIC,
|
122 |
+
state_class=SensorStateClass.MEASUREMENT,
|
123 |
),
|
124 |
PlugwiseSensorEntityDescription(
|
125 |
key="electricity_consumed",
|
126 |
translation_key="electricity_consumed",
|
|
|
127 |
native_unit_of_measurement=UnitOfPower.WATT,
|
128 |
+
device_class=SensorDeviceClass.POWER,
|
129 |
+
state_class=SensorStateClass.MEASUREMENT,
|
130 |
),
|
131 |
PlugwiseSensorEntityDescription(
|
132 |
key="electricity_produced",
|
133 |
translation_key="electricity_produced",
|
|
|
134 |
native_unit_of_measurement=UnitOfPower.WATT,
|
135 |
+
device_class=SensorDeviceClass.POWER,
|
136 |
+
state_class=SensorStateClass.MEASUREMENT,
|
137 |
entity_registry_enabled_default=False,
|
138 |
),
|
139 |
PlugwiseSensorEntityDescription(
|
140 |
key="electricity_consumed_interval",
|
141 |
translation_key="electricity_consumed_interval",
|
|
|
142 |
native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,
|
143 |
+
device_class=SensorDeviceClass.ENERGY,
|
144 |
+
state_class=SensorStateClass.TOTAL,
|
145 |
),
|
146 |
PlugwiseSensorEntityDescription(
|
147 |
key="electricity_consumed_peak_interval",
|
148 |
translation_key="electricity_consumed_peak_interval",
|
|
|
149 |
native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,
|
150 |
+
device_class=SensorDeviceClass.ENERGY,
|
151 |
+
state_class=SensorStateClass.TOTAL,
|
152 |
),
|
153 |
PlugwiseSensorEntityDescription(
|
154 |
key="electricity_consumed_off_peak_interval",
|
155 |
translation_key="electricity_consumed_off_peak_interval",
|
|
|
156 |
native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,
|
157 |
+
device_class=SensorDeviceClass.ENERGY,
|
158 |
+
state_class=SensorStateClass.TOTAL,
|
159 |
),
|
160 |
PlugwiseSensorEntityDescription(
|
161 |
key="electricity_produced_interval",
|
162 |
translation_key="electricity_produced_interval",
|
|
|
163 |
native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,
|
164 |
+
device_class=SensorDeviceClass.ENERGY,
|
165 |
+
state_class=SensorStateClass.TOTAL,
|
166 |
entity_registry_enabled_default=False,
|
167 |
),
|
168 |
PlugwiseSensorEntityDescription(
|
169 |
key="electricity_produced_peak_interval",
|
170 |
translation_key="electricity_produced_peak_interval",
|
|
|
171 |
native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,
|
172 |
+
device_class=SensorDeviceClass.ENERGY,
|
173 |
+
state_class=SensorStateClass.TOTAL,
|
174 |
),
|
175 |
PlugwiseSensorEntityDescription(
|
176 |
key="electricity_produced_off_peak_interval",
|
177 |
translation_key="electricity_produced_off_peak_interval",
|
|
|
178 |
native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,
|
179 |
+
device_class=SensorDeviceClass.ENERGY,
|
180 |
+
state_class=SensorStateClass.TOTAL,
|
181 |
),
|
182 |
PlugwiseSensorEntityDescription(
|
183 |
key="electricity_consumed_point",
|
184 |
translation_key="electricity_consumed_point",
|
185 |
device_class=SensorDeviceClass.POWER,
|
186 |
native_unit_of_measurement=UnitOfPower.WATT,
|
187 |
+
state_class=SensorStateClass.MEASUREMENT,
|
188 |
),
|
189 |
PlugwiseSensorEntityDescription(
|
190 |
key="electricity_consumed_off_peak_point",
|
191 |
translation_key="electricity_consumed_off_peak_point",
|
|
|
192 |
native_unit_of_measurement=UnitOfPower.WATT,
|
193 |
+
device_class=SensorDeviceClass.POWER,
|
194 |
+
state_class=SensorStateClass.MEASUREMENT,
|
195 |
),
|
196 |
PlugwiseSensorEntityDescription(
|
197 |
key="electricity_consumed_peak_point",
|
198 |
translation_key="electricity_consumed_peak_point",
|
|
|
199 |
native_unit_of_measurement=UnitOfPower.WATT,
|
200 |
+
device_class=SensorDeviceClass.POWER,
|
201 |
+
state_class=SensorStateClass.MEASUREMENT,
|
202 |
),
|
203 |
PlugwiseSensorEntityDescription(
|
204 |
key="electricity_consumed_off_peak_cumulative",
|
205 |
translation_key="electricity_consumed_off_peak_cumulative",
|
|
|
206 |
native_unit_of_measurement=UnitOfEnergy.KILO_WATT_HOUR,
|
207 |
+
device_class=SensorDeviceClass.ENERGY,
|
208 |
state_class=SensorStateClass.TOTAL_INCREASING,
|
209 |
),
|
210 |
PlugwiseSensorEntityDescription(
|
211 |
key="electricity_consumed_peak_cumulative",
|
212 |
translation_key="electricity_consumed_peak_cumulative",
|
|
|
213 |
native_unit_of_measurement=UnitOfEnergy.KILO_WATT_HOUR,
|
214 |
+
device_class=SensorDeviceClass.ENERGY,
|
215 |
state_class=SensorStateClass.TOTAL_INCREASING,
|
216 |
),
|
217 |
PlugwiseSensorEntityDescription(
|
|
|
219 |
translation_key="electricity_produced_point",
|
220 |
device_class=SensorDeviceClass.POWER,
|
221 |
native_unit_of_measurement=UnitOfPower.WATT,
|
222 |
+
state_class=SensorStateClass.MEASUREMENT,
|
223 |
),
|
224 |
PlugwiseSensorEntityDescription(
|
225 |
key="electricity_produced_off_peak_point",
|
226 |
translation_key="electricity_produced_off_peak_point",
|
|
|
227 |
native_unit_of_measurement=UnitOfPower.WATT,
|
228 |
+
device_class=SensorDeviceClass.POWER,
|
229 |
+
state_class=SensorStateClass.MEASUREMENT,
|
230 |
),
|
231 |
PlugwiseSensorEntityDescription(
|
232 |
key="electricity_produced_peak_point",
|
233 |
translation_key="electricity_produced_peak_point",
|
|
|
234 |
native_unit_of_measurement=UnitOfPower.WATT,
|
235 |
+
device_class=SensorDeviceClass.POWER,
|
236 |
+
state_class=SensorStateClass.MEASUREMENT,
|
237 |
),
|
238 |
PlugwiseSensorEntityDescription(
|
239 |
key="electricity_produced_off_peak_cumulative",
|
240 |
translation_key="electricity_produced_off_peak_cumulative",
|
|
|
241 |
native_unit_of_measurement=UnitOfEnergy.KILO_WATT_HOUR,
|
242 |
+
device_class=SensorDeviceClass.ENERGY,
|
243 |
state_class=SensorStateClass.TOTAL_INCREASING,
|
244 |
),
|
245 |
PlugwiseSensorEntityDescription(
|
|
|
252 |
PlugwiseSensorEntityDescription(
|
253 |
key="electricity_phase_one_consumed",
|
254 |
translation_key="electricity_phase_one_consumed",
|
|
|
255 |
device_class=SensorDeviceClass.POWER,
|
256 |
native_unit_of_measurement=UnitOfPower.WATT,
|
257 |
+
state_class=SensorStateClass.MEASUREMENT,
|
258 |
),
|
259 |
PlugwiseSensorEntityDescription(
|
260 |
key="electricity_phase_two_consumed",
|
261 |
translation_key="electricity_phase_two_consumed",
|
262 |
device_class=SensorDeviceClass.POWER,
|
263 |
native_unit_of_measurement=UnitOfPower.WATT,
|
264 |
+
state_class=SensorStateClass.MEASUREMENT,
|
265 |
),
|
266 |
PlugwiseSensorEntityDescription(
|
267 |
key="electricity_phase_three_consumed",
|
268 |
translation_key="electricity_phase_three_consumed",
|
269 |
device_class=SensorDeviceClass.POWER,
|
270 |
native_unit_of_measurement=UnitOfPower.WATT,
|
271 |
+
state_class=SensorStateClass.MEASUREMENT,
|
272 |
),
|
273 |
PlugwiseSensorEntityDescription(
|
274 |
key="electricity_phase_one_produced",
|
275 |
translation_key="electricity_phase_one_produced",
|
276 |
device_class=SensorDeviceClass.POWER,
|
277 |
native_unit_of_measurement=UnitOfPower.WATT,
|
278 |
+
state_class=SensorStateClass.MEASUREMENT,
|
279 |
),
|
280 |
PlugwiseSensorEntityDescription(
|
281 |
key="electricity_phase_two_produced",
|
282 |
translation_key="electricity_phase_two_produced",
|
283 |
device_class=SensorDeviceClass.POWER,
|
284 |
native_unit_of_measurement=UnitOfPower.WATT,
|
285 |
+
state_class=SensorStateClass.MEASUREMENT,
|
286 |
),
|
287 |
PlugwiseSensorEntityDescription(
|
288 |
key="electricity_phase_three_produced",
|
289 |
translation_key="electricity_phase_three_produced",
|
290 |
device_class=SensorDeviceClass.POWER,
|
291 |
native_unit_of_measurement=UnitOfPower.WATT,
|
292 |
+
state_class=SensorStateClass.MEASUREMENT,
|
293 |
),
|
294 |
PlugwiseSensorEntityDescription(
|
295 |
key="voltage_phase_one",
|
296 |
translation_key="voltage_phase_one",
|
297 |
device_class=SensorDeviceClass.VOLTAGE,
|
298 |
native_unit_of_measurement=UnitOfElectricPotential.VOLT,
|
299 |
+
state_class=SensorStateClass.MEASUREMENT,
|
300 |
entity_registry_enabled_default=False,
|
301 |
),
|
302 |
PlugwiseSensorEntityDescription(
|
|
|
304 |
translation_key="voltage_phase_two",
|
305 |
device_class=SensorDeviceClass.VOLTAGE,
|
306 |
native_unit_of_measurement=UnitOfElectricPotential.VOLT,
|
307 |
+
state_class=SensorStateClass.MEASUREMENT,
|
308 |
entity_registry_enabled_default=False,
|
309 |
),
|
310 |
PlugwiseSensorEntityDescription(
|
|
|
312 |
translation_key="voltage_phase_three",
|
313 |
device_class=SensorDeviceClass.VOLTAGE,
|
314 |
native_unit_of_measurement=UnitOfElectricPotential.VOLT,
|
315 |
+
state_class=SensorStateClass.MEASUREMENT,
|
316 |
entity_registry_enabled_default=False,
|
317 |
),
|
318 |
PlugwiseSensorEntityDescription(
|
319 |
key="gas_consumed_interval",
|
320 |
translation_key="gas_consumed_interval",
|
|
|
321 |
native_unit_of_measurement=UnitOfVolumeFlowRate.CUBIC_METERS_PER_HOUR,
|
322 |
+
state_class=SensorStateClass.MEASUREMENT,
|
323 |
),
|
324 |
PlugwiseSensorEntityDescription(
|
325 |
key="gas_consumed_cumulative",
|
326 |
translation_key="gas_consumed_cumulative",
|
|
|
327 |
native_unit_of_measurement=UnitOfVolume.CUBIC_METERS,
|
328 |
+
device_class=SensorDeviceClass.GAS,
|
329 |
+
state_class=SensorStateClass.TOTAL,
|
330 |
),
|
331 |
PlugwiseSensorEntityDescription(
|
332 |
key="net_electricity_point",
|
333 |
translation_key="net_electricity_point",
|
|
|
334 |
native_unit_of_measurement=UnitOfPower.WATT,
|
335 |
+
device_class=SensorDeviceClass.POWER,
|
336 |
+
state_class=SensorStateClass.MEASUREMENT,
|
337 |
),
|
338 |
PlugwiseSensorEntityDescription(
|
339 |
key="net_electricity_cumulative",
|
340 |
translation_key="net_electricity_cumulative",
|
|
|
341 |
native_unit_of_measurement=UnitOfEnergy.KILO_WATT_HOUR,
|
342 |
+
device_class=SensorDeviceClass.ENERGY,
|
343 |
state_class=SensorStateClass.TOTAL,
|
344 |
),
|
345 |
PlugwiseSensorEntityDescription(
|
346 |
key="battery",
|
347 |
+
native_unit_of_measurement=PERCENTAGE,
|
348 |
device_class=SensorDeviceClass.BATTERY,
|
349 |
entity_category=EntityCategory.DIAGNOSTIC,
|
350 |
+
state_class=SensorStateClass.MEASUREMENT,
|
351 |
),
|
352 |
PlugwiseSensorEntityDescription(
|
353 |
key="illuminance",
|
354 |
+
native_unit_of_measurement=LIGHT_LUX,
|
355 |
device_class=SensorDeviceClass.ILLUMINANCE,
|
356 |
+
state_class=SensorStateClass.MEASUREMENT,
|
357 |
entity_category=EntityCategory.DIAGNOSTIC,
|
|
|
358 |
),
|
359 |
PlugwiseSensorEntityDescription(
|
360 |
key="modulation_level",
|
361 |
translation_key="modulation_level",
|
|
|
362 |
native_unit_of_measurement=PERCENTAGE,
|
363 |
+
entity_category=EntityCategory.DIAGNOSTIC,
|
364 |
+
state_class=SensorStateClass.MEASUREMENT,
|
365 |
),
|
366 |
PlugwiseSensorEntityDescription(
|
367 |
key="valve_position",
|
368 |
translation_key="valve_position",
|
|
|
369 |
entity_category=EntityCategory.DIAGNOSTIC,
|
370 |
native_unit_of_measurement=PERCENTAGE,
|
371 |
+
state_class=SensorStateClass.MEASUREMENT,
|
372 |
),
|
373 |
PlugwiseSensorEntityDescription(
|
374 |
key="water_pressure",
|
375 |
translation_key="water_pressure",
|
376 |
+
native_unit_of_measurement=UnitOfPressure.BAR,
|
377 |
device_class=SensorDeviceClass.PRESSURE,
|
378 |
entity_category=EntityCategory.DIAGNOSTIC,
|
379 |
+
state_class=SensorStateClass.MEASUREMENT,
|
380 |
),
|
381 |
PlugwiseSensorEntityDescription(
|
382 |
key="humidity",
|
|
|
383 |
native_unit_of_measurement=PERCENTAGE,
|
384 |
+
device_class=SensorDeviceClass.HUMIDITY,
|
385 |
+
state_class=SensorStateClass.MEASUREMENT,
|
386 |
),
|
387 |
PlugwiseSensorEntityDescription(
|
388 |
key="dhw_temperature",
|
389 |
translation_key="dhw_temperature",
|
390 |
+
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
391 |
device_class=SensorDeviceClass.TEMPERATURE,
|
392 |
entity_category=EntityCategory.DIAGNOSTIC,
|
393 |
+
state_class=SensorStateClass.MEASUREMENT,
|
394 |
),
|
395 |
PlugwiseSensorEntityDescription(
|
396 |
key="domestic_hot_water_setpoint",
|
397 |
translation_key="domestic_hot_water_setpoint",
|
398 |
+
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
399 |
device_class=SensorDeviceClass.TEMPERATURE,
|
400 |
entity_category=EntityCategory.DIAGNOSTIC,
|
401 |
+
state_class=SensorStateClass.MEASUREMENT,
|
402 |
),
|
403 |
)
|
404 |
|
405 |
|
406 |
async def async_setup_entry(
|
407 |
hass: HomeAssistant,
|
408 |
+
entry: PlugwiseConfigEntry,
|
409 |
async_add_entities: AddEntitiesCallback,
|
410 |
) -> None:
|
411 |
"""Set up the Smile sensors from a config entry."""
|
412 |
+
coordinator = entry.runtime_data
|
413 |
|
414 |
+
@callback
|
415 |
+
def _add_entities() -> None:
|
416 |
+
"""Add Entities."""
|
417 |
+
if not coordinator.new_devices:
|
418 |
+
return
|
419 |
+
|
420 |
+
async_add_entities(
|
421 |
+
PlugwiseSensorEntity(coordinator, device_id, description)
|
422 |
+
for device_id in coordinator.new_devices
|
423 |
+
if (sensors := coordinator.data.devices[device_id].get("sensors"))
|
424 |
+
for description in SENSORS
|
425 |
+
if description.key in sensors
|
426 |
+
)
|
|
|
|
|
|
|
|
|
427 |
|
428 |
+
_add_entities()
|
429 |
+
entry.async_on_unload(coordinator.async_add_listener(_add_entities))
|
430 |
|
431 |
|
432 |
class PlugwiseSensorEntity(PlugwiseEntity, SensorEntity):
|
|
|
442 |
) -> None:
|
443 |
"""Initialise the sensor."""
|
444 |
super().__init__(coordinator, device_id)
|
|
|
445 |
self._attr_unique_id = f"{device_id}-{description.key}"
|
446 |
+
self.entity_description = description
|
447 |
|
448 |
@property
|
449 |
def native_value(self) -> int | float:
|
@@ -1,48 +1,47 @@
|
|
1 |
{
|
2 |
-
"
|
3 |
"step": {
|
4 |
-
"
|
5 |
-
"
|
6 |
-
"description": "This Integration does not provide any Options"
|
7 |
-
},
|
8 |
-
"init": {
|
9 |
-
"description": "Adjust Smile/Stretch Options",
|
10 |
"data": {
|
11 |
-
"
|
12 |
-
"
|
13 |
-
|
14 |
-
|
|
|
|
|
15 |
}
|
16 |
-
}
|
17 |
-
}
|
18 |
-
},
|
19 |
-
"config": {
|
20 |
-
"step": {
|
21 |
"user": {
|
22 |
-
"title": "Connect to the
|
23 |
-
"description": "Please enter
|
24 |
"data": {
|
25 |
-
"
|
26 |
-
"
|
27 |
-
"
|
28 |
-
"
|
|
|
|
|
|
|
|
|
|
|
|
|
29 |
}
|
30 |
}
|
31 |
},
|
32 |
"error": {
|
33 |
-
"cannot_connect": "
|
34 |
-
"invalid_auth": "
|
35 |
"invalid_setup": "Add your Adam instead of your Anna, see the documentation",
|
36 |
-
"network_down": "Plugwise Zigbee network is down",
|
37 |
-
"network_timeout": "Network communication timeout",
|
38 |
"response_error": "Invalid XML data, or error indication received",
|
39 |
-
"
|
40 |
-
"unknown": "Unknown error!",
|
41 |
"unsupported": "Device with unsupported firmware"
|
42 |
},
|
43 |
"abort": {
|
44 |
-
"already_configured": "
|
45 |
-
"anna_with_adam": "Both Anna and Adam detected. Add your Adam instead of your Anna"
|
|
|
|
|
46 |
}
|
47 |
},
|
48 |
"entity": {
|
@@ -60,29 +59,40 @@
|
|
60 |
"name": "Flame state"
|
61 |
},
|
62 |
"heating_state": {
|
63 |
-
"name": "
|
64 |
},
|
65 |
"cooling_state": {
|
66 |
-
"name": "
|
67 |
},
|
68 |
-
"
|
69 |
"name": "Secondary boiler state"
|
70 |
},
|
71 |
"plugwise_notification": {
|
72 |
"name": "Plugwise notification"
|
73 |
}
|
74 |
},
|
|
|
|
|
|
|
|
|
|
|
75 |
"climate": {
|
76 |
"plugwise": {
|
77 |
"state_attributes": {
|
|
|
|
|
|
|
78 |
"preset_mode": {
|
79 |
"state": {
|
80 |
"asleep": "Night",
|
81 |
-
"away": "
|
82 |
-
"home": "
|
83 |
"no_frost": "Anti-frost",
|
84 |
"vacation": "Vacation"
|
85 |
}
|
|
|
|
|
|
|
86 |
}
|
87 |
}
|
88 |
}
|
@@ -102,10 +112,18 @@
|
|
102 |
"dhw_mode": {
|
103 |
"name": "DHW mode",
|
104 |
"state": {
|
|
|
105 |
"auto": "Auto",
|
106 |
-
"boost": "
|
107 |
-
"comfort": "
|
108 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
109 |
}
|
110 |
},
|
111 |
"regulation_mode": {
|
@@ -113,26 +131,16 @@
|
|
113 |
"state": {
|
114 |
"bleeding_cold": "Bleeding cold",
|
115 |
"bleeding_hot": "Bleeding hot",
|
116 |
-
"cooling": "
|
117 |
-
"heating": "
|
118 |
-
"off": "
|
119 |
}
|
120 |
},
|
121 |
-
"
|
122 |
"name": "Thermostat schedule",
|
123 |
"state": {
|
124 |
"off": "Off"
|
125 |
}
|
126 |
-
},
|
127 |
-
"thermostat_preset": {
|
128 |
-
"name": "Thermostat preset",
|
129 |
-
"state": {
|
130 |
-
"asleep": "Night",
|
131 |
-
"away": "Away",
|
132 |
-
"home": "Home",
|
133 |
-
"no_frost": "Anti-frost",
|
134 |
-
"vacation": "Vacation"
|
135 |
-
}
|
136 |
}
|
137 |
},
|
138 |
"sensor": {
|
@@ -143,7 +151,7 @@
|
|
143 |
"name": "Cooling setpoint"
|
144 |
},
|
145 |
"heating_setpoint": {
|
146 |
-
"name": "
|
147 |
},
|
148 |
"intended_boiler_temperature": {
|
149 |
"name": "Intended boiler temperature"
|
@@ -169,12 +177,6 @@
|
|
169 |
"electricity_produced": {
|
170 |
"name": "Electricity produced"
|
171 |
},
|
172 |
-
"electricity_consumed_point": {
|
173 |
-
"name": "Electricity consumed point"
|
174 |
-
},
|
175 |
-
"electricity_produced_point": {
|
176 |
-
"name": "Electricity produced point"
|
177 |
-
},
|
178 |
"electricity_consumed_interval": {
|
179 |
"name": "Electricity consumed interval"
|
180 |
},
|
@@ -193,6 +195,9 @@
|
|
193 |
"electricity_produced_off_peak_interval": {
|
194 |
"name": "Electricity produced off peak interval"
|
195 |
},
|
|
|
|
|
|
|
196 |
"electricity_consumed_off_peak_point": {
|
197 |
"name": "Electricity consumed off peak point"
|
198 |
},
|
@@ -205,6 +210,9 @@
|
|
205 |
"electricity_consumed_peak_cumulative": {
|
206 |
"name": "Electricity consumed peak cumulative"
|
207 |
},
|
|
|
|
|
|
|
208 |
"electricity_produced_off_peak_point": {
|
209 |
"name": "Electricity produced off peak point"
|
210 |
},
|
@@ -272,28 +280,45 @@
|
|
272 |
"name": "DHW setpoint"
|
273 |
},
|
274 |
"maximum_boiler_temperature": {
|
275 |
-
"name": "Maximum boiler temperature
|
276 |
}
|
277 |
},
|
278 |
"switch": {
|
279 |
"cooling_ena_switch": {
|
280 |
-
"name": "
|
281 |
},
|
282 |
"dhw_cm_switch": {
|
283 |
"name": "DHW comfort mode"
|
284 |
},
|
285 |
"lock": {
|
286 |
-
"name": "
|
287 |
},
|
288 |
"relay": {
|
289 |
"name": "Relay"
|
290 |
}
|
291 |
}
|
292 |
},
|
293 |
-
"
|
294 |
-
"
|
295 |
-
"
|
296 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
297 |
}
|
298 |
}
|
299 |
}
|
|
|
1 |
{
|
2 |
+
"config": {
|
3 |
"step": {
|
4 |
+
"reconfigure": {
|
5 |
+
"description": "Update configuration for {title}.",
|
|
|
|
|
|
|
|
|
6 |
"data": {
|
7 |
+
"host": "[%key:common::config_flow::data::ip%]",
|
8 |
+
"port": "[%key:common::config_flow::data::port%]"
|
9 |
+
},
|
10 |
+
"data_description": {
|
11 |
+
"host": "[%key:component::plugwise::config::step::user::data_description::host%]",
|
12 |
+
"port": "[%key:component::plugwise::config::step::user::data_description::port%]"
|
13 |
}
|
14 |
+
},
|
|
|
|
|
|
|
|
|
15 |
"user": {
|
16 |
+
"title": "Connect to the Smile",
|
17 |
+
"description": "Please enter",
|
18 |
"data": {
|
19 |
+
"host": "[%key:common::config_flow::data::ip%]",
|
20 |
+
"password": "Smile ID",
|
21 |
+
"port": "[%key:common::config_flow::data::port%]",
|
22 |
+
"username": "Smile Username"
|
23 |
+
},
|
24 |
+
"data_description": {
|
25 |
+
"password": "The Smile ID printed on the label on the back of your Adam, Smile-T, or P1.",
|
26 |
+
"host": "The hostname or IP-address of your Smile. You can find it in your router or the Plugwise App.",
|
27 |
+
"port": "By default your Smile uses port 80, normally you should not have to change this.",
|
28 |
+
"username": "Default is `smile`, or `stretch` for the legacy Stretch."
|
29 |
}
|
30 |
}
|
31 |
},
|
32 |
"error": {
|
33 |
+
"cannot_connect": "[%key:common::config_flow::error::cannot_connect%]",
|
34 |
+
"invalid_auth": "[%key:common::config_flow::error::invalid_auth%]",
|
35 |
"invalid_setup": "Add your Adam instead of your Anna, see the documentation",
|
|
|
|
|
36 |
"response_error": "Invalid XML data, or error indication received",
|
37 |
+
"unknown": "[%key:common::config_flow::error::unknown%]",
|
|
|
38 |
"unsupported": "Device with unsupported firmware"
|
39 |
},
|
40 |
"abort": {
|
41 |
+
"already_configured": "[%key:common::config_flow::abort::already_configured_service%]",
|
42 |
+
"anna_with_adam": "Both Anna and Adam detected. Add your Adam instead of your Anna",
|
43 |
+
"not_the_same_smile": "The configured Smile ID does not match the Smile ID on the requested IP address.",
|
44 |
+
"reconfigure_successful": "[%key:common::config_flow::abort::reconfigure_successful%]"
|
45 |
}
|
46 |
},
|
47 |
"entity": {
|
|
|
59 |
"name": "Flame state"
|
60 |
},
|
61 |
"heating_state": {
|
62 |
+
"name": "[%key:component::climate::entity_component::_::state_attributes::hvac_action::state::heating%]"
|
63 |
},
|
64 |
"cooling_state": {
|
65 |
+
"name": "[%key:component::climate::entity_component::_::state_attributes::hvac_action::state::cooling%]"
|
66 |
},
|
67 |
+
"secondary_boiler_state": {
|
68 |
"name": "Secondary boiler state"
|
69 |
},
|
70 |
"plugwise_notification": {
|
71 |
"name": "Plugwise notification"
|
72 |
}
|
73 |
},
|
74 |
+
"button": {
|
75 |
+
"reboot": {
|
76 |
+
"name": "Reboot"
|
77 |
+
}
|
78 |
+
},
|
79 |
"climate": {
|
80 |
"plugwise": {
|
81 |
"state_attributes": {
|
82 |
+
"available_schemas": {
|
83 |
+
"name": "Available schemas"
|
84 |
+
},
|
85 |
"preset_mode": {
|
86 |
"state": {
|
87 |
"asleep": "Night",
|
88 |
+
"away": "[%key:component::climate::entity_component::_::state_attributes::preset_mode::state::away%]",
|
89 |
+
"home": "[%key:common::state::home%]",
|
90 |
"no_frost": "Anti-frost",
|
91 |
"vacation": "Vacation"
|
92 |
}
|
93 |
+
},
|
94 |
+
"selected_schema": {
|
95 |
+
"name": "Selected schema"
|
96 |
}
|
97 |
}
|
98 |
}
|
|
|
112 |
"dhw_mode": {
|
113 |
"name": "DHW mode",
|
114 |
"state": {
|
115 |
+
"off": "[%key:common::state::off%]",
|
116 |
"auto": "Auto",
|
117 |
+
"boost": "[%key:component::climate::entity_component::_::state_attributes::preset_mode::state::boost%]",
|
118 |
+
"comfort": "[%key:component::climate::entity_component::_::state_attributes::preset_mode::state::comfort%]"
|
119 |
+
}
|
120 |
+
},
|
121 |
+
"gateway_mode": {
|
122 |
+
"name": "Gateway mode",
|
123 |
+
"state": {
|
124 |
+
"away": "Pause",
|
125 |
+
"full": "Normal",
|
126 |
+
"vacation": "Vacation"
|
127 |
}
|
128 |
},
|
129 |
"regulation_mode": {
|
|
|
131 |
"state": {
|
132 |
"bleeding_cold": "Bleeding cold",
|
133 |
"bleeding_hot": "Bleeding hot",
|
134 |
+
"cooling": "[%key:component::climate::entity_component::_::state_attributes::hvac_action::state::cooling%]",
|
135 |
+
"heating": "[%key:component::climate::entity_component::_::state_attributes::hvac_action::state::heating%]",
|
136 |
+
"off": "[%key:common::state::off%]"
|
137 |
}
|
138 |
},
|
139 |
+
"select_schedule": {
|
140 |
"name": "Thermostat schedule",
|
141 |
"state": {
|
142 |
"off": "Off"
|
143 |
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
144 |
}
|
145 |
},
|
146 |
"sensor": {
|
|
|
151 |
"name": "Cooling setpoint"
|
152 |
},
|
153 |
"heating_setpoint": {
|
154 |
+
"name": "Heating setpoint"
|
155 |
},
|
156 |
"intended_boiler_temperature": {
|
157 |
"name": "Intended boiler temperature"
|
|
|
177 |
"electricity_produced": {
|
178 |
"name": "Electricity produced"
|
179 |
},
|
|
|
|
|
|
|
|
|
|
|
|
|
180 |
"electricity_consumed_interval": {
|
181 |
"name": "Electricity consumed interval"
|
182 |
},
|
|
|
195 |
"electricity_produced_off_peak_interval": {
|
196 |
"name": "Electricity produced off peak interval"
|
197 |
},
|
198 |
+
"electricity_consumed_point": {
|
199 |
+
"name": "Electricity consumed point"
|
200 |
+
},
|
201 |
"electricity_consumed_off_peak_point": {
|
202 |
"name": "Electricity consumed off peak point"
|
203 |
},
|
|
|
210 |
"electricity_consumed_peak_cumulative": {
|
211 |
"name": "Electricity consumed peak cumulative"
|
212 |
},
|
213 |
+
"electricity_produced_point": {
|
214 |
+
"name": "Electricity produced point"
|
215 |
+
},
|
216 |
"electricity_produced_off_peak_point": {
|
217 |
"name": "Electricity produced off peak point"
|
218 |
},
|
|
|
280 |
"name": "DHW setpoint"
|
281 |
},
|
282 |
"maximum_boiler_temperature": {
|
283 |
+
"name": "Maximum boiler temperature"
|
284 |
}
|
285 |
},
|
286 |
"switch": {
|
287 |
"cooling_ena_switch": {
|
288 |
+
"name": "[%key:component::climate::entity_component::_::state_attributes::hvac_action::state::cooling%]"
|
289 |
},
|
290 |
"dhw_cm_switch": {
|
291 |
"name": "DHW comfort mode"
|
292 |
},
|
293 |
"lock": {
|
294 |
+
"name": "[%key:component::lock::title%]"
|
295 |
},
|
296 |
"relay": {
|
297 |
"name": "Relay"
|
298 |
}
|
299 |
}
|
300 |
},
|
301 |
+
"exceptions": {
|
302 |
+
"authentication_failed": {
|
303 |
+
"message": "[%key:common::config_flow::error::invalid_auth%]"
|
304 |
+
},
|
305 |
+
"data_incomplete_or_missing": {
|
306 |
+
"message": "Data incomplete or missing."
|
307 |
+
},
|
308 |
+
"error_communicating_with_api": {
|
309 |
+
"message": "Error communicating with API: {error}."
|
310 |
+
},
|
311 |
+
"failed_to_connect": {
|
312 |
+
"message": "[%key:common::config_flow::error::cannot_connect%]"
|
313 |
+
},
|
314 |
+
"invalid_xml_data": {
|
315 |
+
"message": "[%key:component::plugwise::config::error::response_error%]"
|
316 |
+
},
|
317 |
+
"unsupported_firmware": {
|
318 |
+
"message": "[%key:component::plugwise::config::error::unsupported%]"
|
319 |
+
},
|
320 |
+
"unsupported_hvac_mode_requested": {
|
321 |
+
"message": "Unsupported mode {hvac_mode} requested, valid modes are: {hvac_modes}."
|
322 |
}
|
323 |
}
|
324 |
}
|
@@ -1,4 +1,5 @@
|
|
1 |
"""Plugwise Switch component for HomeAssistant."""
|
|
|
2 |
from __future__ import annotations
|
3 |
|
4 |
from dataclasses import dataclass
|
@@ -11,22 +12,19 @@
|
|
11 |
SwitchEntity,
|
12 |
SwitchEntityDescription,
|
13 |
)
|
14 |
-
from homeassistant.config_entries import ConfigEntry
|
15 |
from homeassistant.const import EntityCategory
|
16 |
-
from homeassistant.core import HomeAssistant
|
17 |
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
18 |
|
19 |
-
from .
|
20 |
-
COORDINATOR, # pw-beta
|
21 |
-
DOMAIN,
|
22 |
-
LOGGER,
|
23 |
-
)
|
24 |
from .coordinator import PlugwiseDataUpdateCoordinator
|
25 |
from .entity import PlugwiseEntity
|
26 |
from .util import plugwise_command
|
27 |
|
|
|
28 |
|
29 |
-
|
|
|
30 |
class PlugwiseSwitchEntityDescription(SwitchEntityDescription):
|
31 |
"""Describes Plugwise switch entity."""
|
32 |
|
@@ -37,15 +35,11 @@
|
|
37 |
PlugwiseSwitchEntityDescription(
|
38 |
key="dhw_cm_switch",
|
39 |
translation_key="dhw_cm_switch",
|
40 |
-
icon="mdi:water-plus",
|
41 |
-
device_class=SwitchDeviceClass.SWITCH,
|
42 |
entity_category=EntityCategory.CONFIG,
|
43 |
),
|
44 |
PlugwiseSwitchEntityDescription(
|
45 |
key="lock",
|
46 |
translation_key="lock",
|
47 |
-
icon="mdi:lock",
|
48 |
-
device_class=SwitchDeviceClass.SWITCH,
|
49 |
entity_category=EntityCategory.CONFIG,
|
50 |
),
|
51 |
PlugwiseSwitchEntityDescription(
|
@@ -56,8 +50,6 @@
|
|
56 |
PlugwiseSwitchEntityDescription(
|
57 |
key="cooling_ena_switch",
|
58 |
translation_key="cooling_ena_switch",
|
59 |
-
icon="mdi:snowflake-thermometer",
|
60 |
-
device_class=SwitchDeviceClass.SWITCH,
|
61 |
entity_category=EntityCategory.CONFIG,
|
62 |
),
|
63 |
)
|
@@ -65,25 +57,28 @@
|
|
65 |
|
66 |
async def async_setup_entry(
|
67 |
hass: HomeAssistant,
|
68 |
-
|
69 |
async_add_entities: AddEntitiesCallback,
|
70 |
) -> None:
|
71 |
"""Set up the Smile switches from a config entry."""
|
72 |
-
coordinator =
|
73 |
|
74 |
-
|
75 |
-
|
76 |
-
|
77 |
-
|
78 |
-
|
79 |
-
|
80 |
-
|
81 |
-
|
82 |
-
|
83 |
-
|
84 |
-
|
|
|
|
|
85 |
|
86 |
-
|
|
|
87 |
|
88 |
|
89 |
class PlugwiseSwitchEntity(PlugwiseEntity, SwitchEntity):
|
@@ -99,8 +94,8 @@
|
|
99 |
) -> None:
|
100 |
"""Set up the Plugwise API."""
|
101 |
super().__init__(coordinator, device_id)
|
102 |
-
self.entity_description = description
|
103 |
self._attr_unique_id = f"{device_id}-{description.key}"
|
|
|
104 |
|
105 |
@property
|
106 |
def is_on(self) -> bool:
|
|
|
1 |
"""Plugwise Switch component for HomeAssistant."""
|
2 |
+
|
3 |
from __future__ import annotations
|
4 |
|
5 |
from dataclasses import dataclass
|
|
|
12 |
SwitchEntity,
|
13 |
SwitchEntityDescription,
|
14 |
)
|
|
|
15 |
from homeassistant.const import EntityCategory
|
16 |
+
from homeassistant.core import HomeAssistant, callback
|
17 |
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
18 |
|
19 |
+
from . import PlugwiseConfigEntry
|
|
|
|
|
|
|
|
|
20 |
from .coordinator import PlugwiseDataUpdateCoordinator
|
21 |
from .entity import PlugwiseEntity
|
22 |
from .util import plugwise_command
|
23 |
|
24 |
+
PARALLEL_UPDATES = 0
|
25 |
|
26 |
+
|
27 |
+
@dataclass(frozen=True)
|
28 |
class PlugwiseSwitchEntityDescription(SwitchEntityDescription):
|
29 |
"""Describes Plugwise switch entity."""
|
30 |
|
|
|
35 |
PlugwiseSwitchEntityDescription(
|
36 |
key="dhw_cm_switch",
|
37 |
translation_key="dhw_cm_switch",
|
|
|
|
|
38 |
entity_category=EntityCategory.CONFIG,
|
39 |
),
|
40 |
PlugwiseSwitchEntityDescription(
|
41 |
key="lock",
|
42 |
translation_key="lock",
|
|
|
|
|
43 |
entity_category=EntityCategory.CONFIG,
|
44 |
),
|
45 |
PlugwiseSwitchEntityDescription(
|
|
|
50 |
PlugwiseSwitchEntityDescription(
|
51 |
key="cooling_ena_switch",
|
52 |
translation_key="cooling_ena_switch",
|
|
|
|
|
53 |
entity_category=EntityCategory.CONFIG,
|
54 |
),
|
55 |
)
|
|
|
57 |
|
58 |
async def async_setup_entry(
|
59 |
hass: HomeAssistant,
|
60 |
+
entry: PlugwiseConfigEntry,
|
61 |
async_add_entities: AddEntitiesCallback,
|
62 |
) -> None:
|
63 |
"""Set up the Smile switches from a config entry."""
|
64 |
+
coordinator = entry.runtime_data
|
65 |
|
66 |
+
@callback
|
67 |
+
def _add_entities() -> None:
|
68 |
+
"""Add Entities."""
|
69 |
+
if not coordinator.new_devices:
|
70 |
+
return
|
71 |
+
|
72 |
+
async_add_entities(
|
73 |
+
PlugwiseSwitchEntity(coordinator, device_id, description)
|
74 |
+
for device_id in coordinator.new_devices
|
75 |
+
if (switches := coordinator.data.devices[device_id].get("switches"))
|
76 |
+
for description in SWITCHES
|
77 |
+
if description.key in switches
|
78 |
+
)
|
79 |
|
80 |
+
_add_entities()
|
81 |
+
entry.async_on_unload(coordinator.async_add_listener(_add_entities))
|
82 |
|
83 |
|
84 |
class PlugwiseSwitchEntity(PlugwiseEntity, SwitchEntity):
|
|
|
94 |
) -> None:
|
95 |
"""Set up the Plugwise API."""
|
96 |
super().__init__(coordinator, device_id)
|
|
|
97 |
self._attr_unique_id = f"{device_id}-{description.key}"
|
98 |
+
self.entity_description = description
|
99 |
|
100 |
@property
|
101 |
def is_on(self) -> bool:
|
@@ -1,22 +1,18 @@
|
|
1 |
"""Utilities for Plugwise."""
|
2 |
-
from __future__ import annotations
|
3 |
|
4 |
from collections.abc import Awaitable, Callable, Coroutine
|
5 |
-
from typing import Any, Concatenate
|
6 |
|
7 |
from plugwise.exceptions import PlugwiseException
|
8 |
|
9 |
from homeassistant.exceptions import HomeAssistantError
|
10 |
|
|
|
11 |
from .entity import PlugwiseEntity
|
12 |
|
13 |
-
_PlugwiseEntityT = TypeVar("_PlugwiseEntityT", bound=PlugwiseEntity)
|
14 |
-
_R = TypeVar("_R")
|
15 |
-
_P = ParamSpec("_P")
|
16 |
|
17 |
-
|
18 |
-
|
19 |
-
func: Callable[Concatenate[_PlugwiseEntityT, _P], Awaitable[_R]]
|
20 |
) -> Callable[Concatenate[_PlugwiseEntityT, _P], Coroutine[Any, Any, _R]]:
|
21 |
"""Decorate Plugwise calls that send commands/make changes to the device.
|
22 |
|
@@ -29,10 +25,14 @@
|
|
29 |
) -> _R:
|
30 |
try:
|
31 |
return await func(self, *args, **kwargs)
|
32 |
-
except PlugwiseException as
|
33 |
raise HomeAssistantError(
|
34 |
-
|
35 |
-
|
|
|
|
|
|
|
|
|
36 |
finally:
|
37 |
await self.coordinator.async_request_refresh()
|
38 |
|
|
|
1 |
"""Utilities for Plugwise."""
|
|
|
2 |
|
3 |
from collections.abc import Awaitable, Callable, Coroutine
|
4 |
+
from typing import Any, Concatenate
|
5 |
|
6 |
from plugwise.exceptions import PlugwiseException
|
7 |
|
8 |
from homeassistant.exceptions import HomeAssistantError
|
9 |
|
10 |
+
from .const import DOMAIN
|
11 |
from .entity import PlugwiseEntity
|
12 |
|
|
|
|
|
|
|
13 |
|
14 |
+
def plugwise_command[_PlugwiseEntityT: PlugwiseEntity, **_P, _R](
|
15 |
+
func: Callable[Concatenate[_PlugwiseEntityT, _P], Awaitable[_R]],
|
|
|
16 |
) -> Callable[Concatenate[_PlugwiseEntityT, _P], Coroutine[Any, Any, _R]]:
|
17 |
"""Decorate Plugwise calls that send commands/make changes to the device.
|
18 |
|
|
|
25 |
) -> _R:
|
26 |
try:
|
27 |
return await func(self, *args, **kwargs)
|
28 |
+
except PlugwiseException as err:
|
29 |
raise HomeAssistantError(
|
30 |
+
translation_domain=DOMAIN,
|
31 |
+
translation_key="error_communicating_with_api",
|
32 |
+
translation_placeholders={
|
33 |
+
"error": str(err),
|
34 |
+
},
|
35 |
+
) from err
|
36 |
finally:
|
37 |
await self.coordinator.async_request_refresh()
|
38 |
|