Use runtime_data in freedompro (#137635)

This commit is contained in:
epenet 2025-02-07 09:52:52 +01:00 committed by GitHub
parent 734f531a56
commit b6c1c10035
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
10 changed files with 65 additions and 55 deletions

View File

@ -2,17 +2,12 @@
from __future__ import annotations
import logging
from typing import Final
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import CONF_API_KEY, Platform
from homeassistant.const import Platform
from homeassistant.core import HomeAssistant
from .const import DOMAIN
from .coordinator import FreedomproDataUpdateCoordinator
_LOGGER = logging.getLogger(__name__)
from .coordinator import FreedomproConfigEntry, FreedomproDataUpdateCoordinator
PLATFORMS: Final[list[Platform]] = [
Platform.BINARY_SENSOR,
@ -26,32 +21,27 @@ PLATFORMS: Final[list[Platform]] = [
]
async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
async def async_setup_entry(hass: HomeAssistant, entry: FreedomproConfigEntry) -> bool:
"""Set up Freedompro from a config entry."""
hass.data.setdefault(DOMAIN, {})
api_key = entry.data[CONF_API_KEY]
coordinator = FreedomproDataUpdateCoordinator(hass, api_key)
coordinator = FreedomproDataUpdateCoordinator(hass, entry)
await coordinator.async_config_entry_first_refresh()
entry.async_on_unload(entry.add_update_listener(update_listener))
hass.data[DOMAIN][entry.entry_id] = coordinator
entry.runtime_data = coordinator
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: FreedomproConfigEntry) -> bool:
"""Unload a config entry."""
unload_ok = await hass.config_entries.async_unload_platforms(entry, PLATFORMS)
if unload_ok:
hass.data[DOMAIN].pop(entry.entry_id)
return unload_ok
return await hass.config_entries.async_unload_platforms(entry, PLATFORMS)
async def update_listener(hass: HomeAssistant, config_entry: ConfigEntry) -> None:
async def update_listener(
hass: HomeAssistant, config_entry: FreedomproConfigEntry
) -> None:
"""Update listener."""
await hass.config_entries.async_reload(config_entry.entry_id)

View File

@ -6,14 +6,13 @@ from homeassistant.components.binary_sensor import (
BinarySensorDeviceClass,
BinarySensorEntity,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers.device_registry import DeviceInfo
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.update_coordinator import CoordinatorEntity
from .const import DOMAIN
from .coordinator import FreedomproDataUpdateCoordinator
from .coordinator import FreedomproConfigEntry, FreedomproDataUpdateCoordinator
DEVICE_CLASS_MAP = {
"smokeSensor": BinarySensorDeviceClass.SMOKE,
@ -33,10 +32,12 @@ SUPPORTED_SENSORS = {"smokeSensor", "occupancySensor", "motionSensor", "contactS
async def async_setup_entry(
hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
hass: HomeAssistant,
entry: FreedomproConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up Freedompro binary_sensor."""
coordinator: FreedomproDataUpdateCoordinator = hass.data[DOMAIN][entry.entry_id]
coordinator = entry.runtime_data
async_add_entities(
Device(device, coordinator)
for device in coordinator.data

View File

@ -15,7 +15,6 @@ from homeassistant.components.climate import (
ClimateEntityFeature,
HVACMode,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import ATTR_TEMPERATURE, CONF_API_KEY, UnitOfTemperature
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers import aiohttp_client
@ -24,7 +23,7 @@ from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.update_coordinator import CoordinatorEntity
from .const import DOMAIN
from .coordinator import FreedomproDataUpdateCoordinator
from .coordinator import FreedomproConfigEntry, FreedomproDataUpdateCoordinator
_LOGGER = logging.getLogger(__name__)
@ -44,11 +43,13 @@ SUPPORTED_HVAC_MODES = [
async def async_setup_entry(
hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
hass: HomeAssistant,
entry: FreedomproConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up Freedompro climate."""
api_key: str = entry.data[CONF_API_KEY]
coordinator: FreedomproDataUpdateCoordinator = hass.data[DOMAIN][entry.entry_id]
coordinator = entry.runtime_data
async_add_entities(
Device(
aiohttp_client.async_get_clientsession(hass), api_key, device, coordinator

View File

@ -8,6 +8,9 @@ from typing import Any
from pyfreedompro import get_list, get_states
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import CONF_API_KEY
from homeassistant.core import HomeAssistant
from homeassistant.helpers import aiohttp_client
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
@ -15,18 +18,27 @@ from .const import DOMAIN
_LOGGER = logging.getLogger(__name__)
type FreedomproConfigEntry = ConfigEntry[FreedomproDataUpdateCoordinator]
class FreedomproDataUpdateCoordinator(DataUpdateCoordinator[list[dict[str, Any]]]):
"""Class to manage fetching Freedompro data API."""
def __init__(self, hass, api_key):
def __init__(self, hass: HomeAssistant, entry: FreedomproConfigEntry) -> None:
"""Initialize."""
self._hass = hass
self._api_key = api_key
self._api_key = entry.data[CONF_API_KEY]
self._devices: list[dict[str, Any]] | None = None
update_interval = timedelta(minutes=1)
super().__init__(hass, _LOGGER, name=DOMAIN, update_interval=update_interval)
super().__init__(
hass,
_LOGGER,
config_entry=entry,
name=DOMAIN,
update_interval=update_interval,
)
async def _async_update_data(self):
if self._devices is None:

View File

@ -11,7 +11,6 @@ from homeassistant.components.cover import (
CoverEntity,
CoverEntityFeature,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import CONF_API_KEY
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers import aiohttp_client
@ -20,7 +19,7 @@ from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.update_coordinator import CoordinatorEntity
from .const import DOMAIN
from .coordinator import FreedomproDataUpdateCoordinator
from .coordinator import FreedomproConfigEntry, FreedomproDataUpdateCoordinator
DEVICE_CLASS_MAP = {
"windowCovering": CoverDeviceClass.BLIND,
@ -34,11 +33,13 @@ SUPPORTED_SENSORS = {"windowCovering", "gate", "garageDoor", "door", "window"}
async def async_setup_entry(
hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
hass: HomeAssistant,
entry: FreedomproConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up Freedompro cover."""
api_key: str = entry.data[CONF_API_KEY]
coordinator: FreedomproDataUpdateCoordinator = hass.data[DOMAIN][entry.entry_id]
coordinator = entry.runtime_data
async_add_entities(
Device(hass, api_key, device, coordinator)
for device in coordinator.data

View File

@ -8,7 +8,6 @@ from typing import Any
from pyfreedompro import put_state
from homeassistant.components.fan import FanEntity, FanEntityFeature
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import CONF_API_KEY
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers import aiohttp_client
@ -17,15 +16,17 @@ from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.update_coordinator import CoordinatorEntity
from .const import DOMAIN
from .coordinator import FreedomproDataUpdateCoordinator
from .coordinator import FreedomproConfigEntry, FreedomproDataUpdateCoordinator
async def async_setup_entry(
hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
hass: HomeAssistant,
entry: FreedomproConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up Freedompro fan."""
api_key: str = entry.data[CONF_API_KEY]
coordinator: FreedomproDataUpdateCoordinator = hass.data[DOMAIN][entry.entry_id]
coordinator = entry.runtime_data
async_add_entities(
FreedomproFan(hass, api_key, device, coordinator)
for device in coordinator.data

View File

@ -13,7 +13,6 @@ from homeassistant.components.light import (
ColorMode,
LightEntity,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import CONF_API_KEY
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers import aiohttp_client
@ -22,15 +21,17 @@ from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.update_coordinator import CoordinatorEntity
from .const import DOMAIN
from .coordinator import FreedomproDataUpdateCoordinator
from .coordinator import FreedomproConfigEntry, FreedomproDataUpdateCoordinator
async def async_setup_entry(
hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
hass: HomeAssistant,
entry: FreedomproConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up Freedompro light."""
api_key: str = entry.data[CONF_API_KEY]
coordinator: FreedomproDataUpdateCoordinator = hass.data[DOMAIN][entry.entry_id]
coordinator = entry.runtime_data
async_add_entities(
Device(hass, api_key, device, coordinator)
for device in coordinator.data

View File

@ -6,7 +6,6 @@ from typing import Any
from pyfreedompro import put_state
from homeassistant.components.lock import LockEntity
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import CONF_API_KEY
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers import aiohttp_client
@ -15,15 +14,17 @@ from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.update_coordinator import CoordinatorEntity
from .const import DOMAIN
from .coordinator import FreedomproDataUpdateCoordinator
from .coordinator import FreedomproConfigEntry, FreedomproDataUpdateCoordinator
async def async_setup_entry(
hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
hass: HomeAssistant,
entry: FreedomproConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up Freedompro lock."""
api_key: str = entry.data[CONF_API_KEY]
coordinator: FreedomproDataUpdateCoordinator = hass.data[DOMAIN][entry.entry_id]
coordinator = entry.runtime_data
async_add_entities(
Device(hass, api_key, device, coordinator)
for device in coordinator.data

View File

@ -7,7 +7,6 @@ from homeassistant.components.sensor import (
SensorEntity,
SensorStateClass,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import LIGHT_LUX, PERCENTAGE, UnitOfTemperature
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers.device_registry import DeviceInfo
@ -15,7 +14,7 @@ from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.update_coordinator import CoordinatorEntity
from .const import DOMAIN
from .coordinator import FreedomproDataUpdateCoordinator
from .coordinator import FreedomproConfigEntry, FreedomproDataUpdateCoordinator
DEVICE_CLASS_MAP = {
"temperatureSensor": SensorDeviceClass.TEMPERATURE,
@ -41,10 +40,12 @@ SUPPORTED_SENSORS = {"temperatureSensor", "humiditySensor", "lightSensor"}
async def async_setup_entry(
hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
hass: HomeAssistant,
entry: FreedomproConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up Freedompro sensor."""
coordinator: FreedomproDataUpdateCoordinator = hass.data[DOMAIN][entry.entry_id]
coordinator = entry.runtime_data
async_add_entities(
Device(device, coordinator)
for device in coordinator.data

View File

@ -6,7 +6,6 @@ from typing import Any
from pyfreedompro import put_state
from homeassistant.components.switch import SwitchEntity
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import CONF_API_KEY
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers import aiohttp_client
@ -15,15 +14,17 @@ from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.update_coordinator import CoordinatorEntity
from .const import DOMAIN
from .coordinator import FreedomproDataUpdateCoordinator
from .coordinator import FreedomproConfigEntry, FreedomproDataUpdateCoordinator
async def async_setup_entry(
hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
hass: HomeAssistant,
entry: FreedomproConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up Freedompro switch."""
api_key: str = entry.data[CONF_API_KEY]
coordinator: FreedomproDataUpdateCoordinator = hass.data[DOMAIN][entry.entry_id]
coordinator = entry.runtime_data
async_add_entities(
Device(hass, api_key, device, coordinator)
for device in coordinator.data