Clean up gateway logic from Plugwise (#91769)
This commit is contained in:
parent
33a8eb1716
commit
5e243da470
3 changed files with 73 additions and 97 deletions
|
@ -1,23 +1,84 @@
|
||||||
"""Plugwise platform for Home Assistant Core."""
|
"""Plugwise platform for Home Assistant Core."""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
from homeassistant.config_entries import ConfigEntry
|
from homeassistant.config_entries import ConfigEntry
|
||||||
from homeassistant.const import CONF_HOST
|
from homeassistant.const import Platform
|
||||||
from homeassistant.core import HomeAssistant
|
from homeassistant.core import HomeAssistant, callback
|
||||||
|
from homeassistant.helpers import device_registry as dr, entity_registry as er
|
||||||
|
|
||||||
from .gateway import async_setup_entry_gw, async_unload_entry_gw
|
from .const import DOMAIN, LOGGER, PLATFORMS
|
||||||
|
from .coordinator import PlugwiseDataUpdateCoordinator
|
||||||
|
|
||||||
|
|
||||||
async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
|
async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
|
||||||
"""Set up Plugwise components from a config entry."""
|
"""Set up Plugwise components from a config entry."""
|
||||||
if entry.data.get(CONF_HOST):
|
await er.async_migrate_entries(hass, entry.entry_id, async_migrate_entity_entry)
|
||||||
return await async_setup_entry_gw(hass, entry)
|
|
||||||
# PLACEHOLDER USB entry setup
|
coordinator = PlugwiseDataUpdateCoordinator(hass, entry)
|
||||||
return False
|
await coordinator.async_config_entry_first_refresh()
|
||||||
|
migrate_sensor_entities(hass, coordinator)
|
||||||
|
|
||||||
|
hass.data.setdefault(DOMAIN, {})[entry.entry_id] = coordinator
|
||||||
|
|
||||||
|
device_registry = dr.async_get(hass)
|
||||||
|
device_registry.async_get_or_create(
|
||||||
|
config_entry_id=entry.entry_id,
|
||||||
|
identifiers={(DOMAIN, str(coordinator.api.gateway_id))},
|
||||||
|
manufacturer="Plugwise",
|
||||||
|
model=coordinator.api.smile_model,
|
||||||
|
name=coordinator.api.smile_name,
|
||||||
|
sw_version=coordinator.api.smile_version[0],
|
||||||
|
)
|
||||||
|
|
||||||
|
await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
|
||||||
|
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
|
async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
|
||||||
"""Unload the Plugwise components."""
|
"""Unload the Plugwise components."""
|
||||||
if entry.data.get(CONF_HOST):
|
if unload_ok := await hass.config_entries.async_unload_platforms(entry, PLATFORMS):
|
||||||
return await async_unload_entry_gw(hass, entry)
|
hass.data[DOMAIN].pop(entry.entry_id)
|
||||||
# PLACEHOLDER USB entry setup
|
return unload_ok
|
||||||
return False
|
|
||||||
|
|
||||||
|
@callback
|
||||||
|
def async_migrate_entity_entry(entry: er.RegistryEntry) -> dict[str, Any] | None:
|
||||||
|
"""Migrate Plugwise entity entries.
|
||||||
|
|
||||||
|
- Migrates unique ID from old relay switches to the new unique ID
|
||||||
|
"""
|
||||||
|
if entry.domain == Platform.SWITCH and entry.unique_id.endswith("-plug"):
|
||||||
|
return {"new_unique_id": entry.unique_id.replace("-plug", "-relay")}
|
||||||
|
|
||||||
|
# No migration needed
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def migrate_sensor_entities(
|
||||||
|
hass: HomeAssistant,
|
||||||
|
coordinator: PlugwiseDataUpdateCoordinator,
|
||||||
|
) -> None:
|
||||||
|
"""Migrate Sensors if needed."""
|
||||||
|
ent_reg = er.async_get(hass)
|
||||||
|
|
||||||
|
# Migrating opentherm_outdoor_temperature
|
||||||
|
# to opentherm_outdoor_air_temperature sensor
|
||||||
|
for device_id, device in coordinator.data.devices.items():
|
||||||
|
if device.get("dev_class") != "heater_central":
|
||||||
|
continue
|
||||||
|
|
||||||
|
old_unique_id = f"{device_id}-outdoor_temperature"
|
||||||
|
if entity_id := ent_reg.async_get_entity_id(
|
||||||
|
Platform.SENSOR, DOMAIN, old_unique_id
|
||||||
|
):
|
||||||
|
new_unique_id = f"{device_id}-outdoor_air_temperature"
|
||||||
|
LOGGER.debug(
|
||||||
|
"Migrating entity %s from old unique ID '%s' to new unique ID '%s'",
|
||||||
|
entity_id,
|
||||||
|
old_unique_id,
|
||||||
|
new_unique_id,
|
||||||
|
)
|
||||||
|
ent_reg.async_update_entity(entity_id, new_unique_id=new_unique_id)
|
||||||
|
|
|
@ -21,7 +21,7 @@ SMILE: Final = "smile"
|
||||||
STRETCH: Final = "stretch"
|
STRETCH: Final = "stretch"
|
||||||
STRETCH_USERNAME: Final = "stretch"
|
STRETCH_USERNAME: Final = "stretch"
|
||||||
|
|
||||||
PLATFORMS_GATEWAY: Final[list[str]] = [
|
PLATFORMS: Final[list[str]] = [
|
||||||
Platform.BINARY_SENSOR,
|
Platform.BINARY_SENSOR,
|
||||||
Platform.CLIMATE,
|
Platform.CLIMATE,
|
||||||
Platform.NUMBER,
|
Platform.NUMBER,
|
||||||
|
|
|
@ -1,85 +0,0 @@
|
||||||
"""Plugwise platform for Home Assistant Core."""
|
|
||||||
from __future__ import annotations
|
|
||||||
|
|
||||||
from typing import Any
|
|
||||||
|
|
||||||
from homeassistant.config_entries import ConfigEntry
|
|
||||||
from homeassistant.core import HomeAssistant, callback
|
|
||||||
from homeassistant.helpers import device_registry as dr, entity_registry as er
|
|
||||||
|
|
||||||
from .const import DOMAIN, LOGGER, PLATFORMS_GATEWAY, Platform
|
|
||||||
from .coordinator import PlugwiseDataUpdateCoordinator
|
|
||||||
|
|
||||||
|
|
||||||
async def async_setup_entry_gw(hass: HomeAssistant, entry: ConfigEntry) -> bool:
|
|
||||||
"""Set up Plugwise Smiles from a config entry."""
|
|
||||||
await er.async_migrate_entries(hass, entry.entry_id, async_migrate_entity_entry)
|
|
||||||
|
|
||||||
coordinator = PlugwiseDataUpdateCoordinator(hass, entry)
|
|
||||||
await coordinator.async_config_entry_first_refresh()
|
|
||||||
migrate_sensor_entities(hass, coordinator)
|
|
||||||
|
|
||||||
hass.data.setdefault(DOMAIN, {})[entry.entry_id] = coordinator
|
|
||||||
|
|
||||||
device_registry = dr.async_get(hass)
|
|
||||||
device_registry.async_get_or_create(
|
|
||||||
config_entry_id=entry.entry_id,
|
|
||||||
identifiers={(DOMAIN, str(coordinator.api.gateway_id))},
|
|
||||||
manufacturer="Plugwise",
|
|
||||||
model=coordinator.api.smile_model,
|
|
||||||
name=coordinator.api.smile_name,
|
|
||||||
sw_version=coordinator.api.smile_version[0],
|
|
||||||
)
|
|
||||||
|
|
||||||
await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS_GATEWAY)
|
|
||||||
|
|
||||||
return True
|
|
||||||
|
|
||||||
|
|
||||||
async def async_unload_entry_gw(hass: HomeAssistant, entry: ConfigEntry) -> bool:
|
|
||||||
"""Unload a config entry."""
|
|
||||||
if unload_ok := await hass.config_entries.async_unload_platforms(
|
|
||||||
entry, PLATFORMS_GATEWAY
|
|
||||||
):
|
|
||||||
hass.data[DOMAIN].pop(entry.entry_id)
|
|
||||||
return unload_ok
|
|
||||||
|
|
||||||
|
|
||||||
@callback
|
|
||||||
def async_migrate_entity_entry(entry: er.RegistryEntry) -> dict[str, Any] | None:
|
|
||||||
"""Migrate Plugwise entity entries.
|
|
||||||
|
|
||||||
- Migrates unique ID from old relay switches to the new unique ID
|
|
||||||
"""
|
|
||||||
if entry.domain == Platform.SWITCH and entry.unique_id.endswith("-plug"):
|
|
||||||
return {"new_unique_id": entry.unique_id.replace("-plug", "-relay")}
|
|
||||||
|
|
||||||
# No migration needed
|
|
||||||
return None
|
|
||||||
|
|
||||||
|
|
||||||
def migrate_sensor_entities(
|
|
||||||
hass: HomeAssistant,
|
|
||||||
coordinator: PlugwiseDataUpdateCoordinator,
|
|
||||||
) -> None:
|
|
||||||
"""Migrate Sensors if needed."""
|
|
||||||
ent_reg = er.async_get(hass)
|
|
||||||
|
|
||||||
# Migrating opentherm_outdoor_temperature
|
|
||||||
# to opentherm_outdoor_air_temperature sensor
|
|
||||||
for device_id, device in coordinator.data.devices.items():
|
|
||||||
if device.get("dev_class") != "heater_central":
|
|
||||||
continue
|
|
||||||
|
|
||||||
old_unique_id = f"{device_id}-outdoor_temperature"
|
|
||||||
if entity_id := ent_reg.async_get_entity_id(
|
|
||||||
Platform.SENSOR, DOMAIN, old_unique_id
|
|
||||||
):
|
|
||||||
new_unique_id = f"{device_id}-outdoor_air_temperature"
|
|
||||||
LOGGER.debug(
|
|
||||||
"Migrating entity %s from old unique ID '%s' to new unique ID '%s'",
|
|
||||||
entity_id,
|
|
||||||
old_unique_id,
|
|
||||||
new_unique_id,
|
|
||||||
)
|
|
||||||
ent_reg.async_update_entity(entity_id, new_unique_id=new_unique_id)
|
|
Loading…
Add table
Add a link
Reference in a new issue