mirror of https://github.com/home-assistant/core
138 lines
4.6 KiB
Python
138 lines
4.6 KiB
Python
"""Support for AVM FRITZ!SmartHome devices."""
|
|
from __future__ import annotations
|
|
|
|
from pyfritzhome import Fritzhome, FritzhomeDevice, LoginError
|
|
|
|
from homeassistant.components.binary_sensor import DOMAIN as BINARY_SENSOR_DOMAIN
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.const import (
|
|
CONF_HOST,
|
|
CONF_PASSWORD,
|
|
CONF_USERNAME,
|
|
EVENT_HOMEASSISTANT_STOP,
|
|
TEMP_CELSIUS,
|
|
)
|
|
from homeassistant.core import Event, HomeAssistant
|
|
from homeassistant.exceptions import ConfigEntryAuthFailed
|
|
from homeassistant.helpers.entity import DeviceInfo, EntityDescription
|
|
from homeassistant.helpers.entity_registry import RegistryEntry, async_migrate_entries
|
|
from homeassistant.helpers.update_coordinator import CoordinatorEntity
|
|
|
|
from .const import CONF_CONNECTIONS, CONF_COORDINATOR, DOMAIN, LOGGER, PLATFORMS
|
|
from .coordinator import FritzboxDataUpdateCoordinator
|
|
|
|
|
|
async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
|
|
"""Set up the AVM FRITZ!SmartHome platforms."""
|
|
fritz = Fritzhome(
|
|
host=entry.data[CONF_HOST],
|
|
user=entry.data[CONF_USERNAME],
|
|
password=entry.data[CONF_PASSWORD],
|
|
)
|
|
|
|
try:
|
|
await hass.async_add_executor_job(fritz.login)
|
|
except LoginError as err:
|
|
raise ConfigEntryAuthFailed from err
|
|
|
|
hass.data.setdefault(DOMAIN, {})
|
|
hass.data[DOMAIN][entry.entry_id] = {
|
|
CONF_CONNECTIONS: fritz,
|
|
}
|
|
|
|
coordinator = FritzboxDataUpdateCoordinator(hass, entry)
|
|
|
|
await coordinator.async_config_entry_first_refresh()
|
|
|
|
hass.data[DOMAIN][entry.entry_id][CONF_COORDINATOR] = coordinator
|
|
|
|
def _update_unique_id(entry: RegistryEntry) -> dict[str, str] | None:
|
|
"""Update unique ID of entity entry."""
|
|
if (
|
|
entry.unit_of_measurement == TEMP_CELSIUS
|
|
and "_temperature" not in entry.unique_id
|
|
):
|
|
new_unique_id = f"{entry.unique_id}_temperature"
|
|
LOGGER.info(
|
|
"Migrating unique_id [%s] to [%s]", entry.unique_id, new_unique_id
|
|
)
|
|
return {"new_unique_id": new_unique_id}
|
|
|
|
if entry.domain == BINARY_SENSOR_DOMAIN and "_" not in entry.unique_id:
|
|
new_unique_id = f"{entry.unique_id}_alarm"
|
|
LOGGER.info(
|
|
"Migrating unique_id [%s] to [%s]", entry.unique_id, new_unique_id
|
|
)
|
|
return {"new_unique_id": new_unique_id}
|
|
return None
|
|
|
|
await async_migrate_entries(hass, entry.entry_id, _update_unique_id)
|
|
|
|
hass.config_entries.async_setup_platforms(entry, PLATFORMS)
|
|
|
|
def logout_fritzbox(event: Event) -> None:
|
|
"""Close connections to this fritzbox."""
|
|
fritz.logout()
|
|
|
|
entry.async_on_unload(
|
|
hass.bus.async_listen_once(EVENT_HOMEASSISTANT_STOP, logout_fritzbox)
|
|
)
|
|
|
|
return True
|
|
|
|
|
|
async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
|
|
"""Unloading the AVM FRITZ!SmartHome platforms."""
|
|
fritz = hass.data[DOMAIN][entry.entry_id][CONF_CONNECTIONS]
|
|
await hass.async_add_executor_job(fritz.logout)
|
|
|
|
unload_ok = await hass.config_entries.async_unload_platforms(entry, PLATFORMS)
|
|
if unload_ok:
|
|
hass.data[DOMAIN].pop(entry.entry_id)
|
|
|
|
return unload_ok
|
|
|
|
|
|
class FritzBoxEntity(CoordinatorEntity[FritzboxDataUpdateCoordinator]):
|
|
"""Basis FritzBox entity."""
|
|
|
|
def __init__(
|
|
self,
|
|
coordinator: FritzboxDataUpdateCoordinator,
|
|
ain: str,
|
|
entity_description: EntityDescription | None = None,
|
|
) -> None:
|
|
"""Initialize the FritzBox entity."""
|
|
super().__init__(coordinator)
|
|
|
|
self.ain = ain
|
|
if entity_description is not None:
|
|
self.entity_description = entity_description
|
|
self._attr_name = f"{self.device.name} {entity_description.name}"
|
|
self._attr_unique_id = f"{ain}_{entity_description.key}"
|
|
else:
|
|
self._attr_name = self.device.name
|
|
self._attr_unique_id = ain
|
|
|
|
@property
|
|
def available(self) -> bool:
|
|
"""Return if entity is available."""
|
|
return super().available and self.device.present
|
|
|
|
@property
|
|
def device(self) -> FritzhomeDevice:
|
|
"""Return device object from coordinator."""
|
|
return self.coordinator.data[self.ain]
|
|
|
|
@property
|
|
def device_info(self) -> DeviceInfo:
|
|
"""Return device specific attributes."""
|
|
return DeviceInfo(
|
|
name=self.device.name,
|
|
identifiers={(DOMAIN, self.ain)},
|
|
manufacturer=self.device.manufacturer,
|
|
model=self.device.productname,
|
|
sw_version=self.device.fw_version,
|
|
configuration_url=self.coordinator.configuration_url,
|
|
)
|