Skip to content

Commit

Permalink
Use ConfigEntry runtime_data in Tailwind (home-assistant#117404)
Browse files Browse the repository at this point in the history
  • Loading branch information
frenck committed May 14, 2024
1 parent b84829f commit f5f5790
Show file tree
Hide file tree
Showing 8 changed files with 28 additions and 36 deletions.
9 changes: 4 additions & 5 deletions homeassistant/components/tailwind/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,17 @@

from .const import DOMAIN
from .coordinator import TailwindDataUpdateCoordinator
from .typing import TailwindConfigEntry

PLATFORMS = [Platform.BINARY_SENSOR, Platform.BUTTON, Platform.COVER, Platform.NUMBER]


async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
async def async_setup_entry(hass: HomeAssistant, entry: TailwindConfigEntry) -> bool:
"""Set up Tailwind device from a config entry."""
coordinator = TailwindDataUpdateCoordinator(hass, entry)
await coordinator.async_config_entry_first_refresh()

hass.data.setdefault(DOMAIN, {})[entry.entry_id] = coordinator
entry.runtime_data = coordinator

# Register the Tailwind device, since other entities will have it as a parent.
# This prevents a child device being created before the parent ending up
Expand All @@ -40,6 +41,4 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:

async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
"""Unload Tailwind config entry."""
if unload_ok := await hass.config_entries.async_unload_platforms(entry, PLATFORMS):
del hass.data[DOMAIN][entry.entry_id]
return unload_ok
return await hass.config_entries.async_unload_platforms(entry, PLATFORMS)
11 changes: 4 additions & 7 deletions homeassistant/components/tailwind/binary_sensor.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,12 @@
BinarySensorEntity,
BinarySensorEntityDescription,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import EntityCategory
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback

from .const import DOMAIN
from .coordinator import TailwindDataUpdateCoordinator
from .entity import TailwindDoorEntity
from .typing import TailwindConfigEntry


@dataclass(kw_only=True, frozen=True)
Expand All @@ -42,15 +40,14 @@ class TailwindDoorBinarySensorEntityDescription(BinarySensorEntityDescription):

async def async_setup_entry(
hass: HomeAssistant,
entry: ConfigEntry,
entry: TailwindConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up Tailwind binary sensor based on a config entry."""
coordinator: TailwindDataUpdateCoordinator = hass.data[DOMAIN][entry.entry_id]
async_add_entities(
TailwindDoorBinarySensorEntity(coordinator, door_id, description)
TailwindDoorBinarySensorEntity(entry.runtime_data, door_id, description)
for description in DESCRIPTIONS
for door_id in coordinator.data.doors
for door_id in entry.runtime_data.data.doors
)


Expand Down
8 changes: 3 additions & 5 deletions homeassistant/components/tailwind/button.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,14 @@
ButtonEntity,
ButtonEntityDescription,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import EntityCategory
from homeassistant.core import HomeAssistant
from homeassistant.exceptions import HomeAssistantError
from homeassistant.helpers.entity_platform import AddEntitiesCallback

from .const import DOMAIN
from .coordinator import TailwindDataUpdateCoordinator
from .entity import TailwindEntity
from .typing import TailwindConfigEntry


@dataclass(frozen=True, kw_only=True)
Expand All @@ -43,14 +42,13 @@ class TailwindButtonEntityDescription(ButtonEntityDescription):

async def async_setup_entry(
hass: HomeAssistant,
entry: ConfigEntry,
entry: TailwindConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up Tailwind button based on a config entry."""
coordinator: TailwindDataUpdateCoordinator = hass.data[DOMAIN][entry.entry_id]
async_add_entities(
TailwindButtonEntity(
coordinator,
entry.runtime_data,
description,
)
for description in DESCRIPTIONS
Expand Down
2 changes: 0 additions & 2 deletions homeassistant/components/tailwind/coordinator.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,6 @@
class TailwindDataUpdateCoordinator(DataUpdateCoordinator[TailwindDeviceStatus]):
"""Class to manage fetching Tailwind data."""

config_entry: ConfigEntry

def __init__(self, hass: HomeAssistant, entry: ConfigEntry) -> None:
"""Initialize the coordinator."""
self.tailwind = Tailwind(
Expand Down
10 changes: 4 additions & 6 deletions homeassistant/components/tailwind/cover.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,26 +17,24 @@
CoverEntity,
CoverEntityFeature,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant
from homeassistant.exceptions import HomeAssistantError
from homeassistant.helpers.entity_platform import AddEntitiesCallback

from .const import DOMAIN
from .coordinator import TailwindDataUpdateCoordinator
from .entity import TailwindDoorEntity
from .typing import TailwindConfigEntry


async def async_setup_entry(
hass: HomeAssistant,
entry: ConfigEntry,
entry: TailwindConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up Tailwind cover based on a config entry."""
coordinator: TailwindDataUpdateCoordinator = hass.data[DOMAIN][entry.entry_id]
async_add_entities(
TailwindDoorCoverEntity(coordinator, door_id)
for door_id in coordinator.data.doors
TailwindDoorCoverEntity(entry.runtime_data, door_id)
for door_id in entry.runtime_data.data.doors
)


Expand Down
9 changes: 3 additions & 6 deletions homeassistant/components/tailwind/diagnostics.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,13 @@

from typing import Any

from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant

from .const import DOMAIN
from .coordinator import TailwindDataUpdateCoordinator
from .typing import TailwindConfigEntry


async def async_get_config_entry_diagnostics(
hass: HomeAssistant, entry: ConfigEntry
hass: HomeAssistant, entry: TailwindConfigEntry
) -> dict[str, Any]:
"""Return diagnostics for a config entry."""
coordinator: TailwindDataUpdateCoordinator = hass.data[DOMAIN][entry.entry_id]
return coordinator.data.to_dict()
return entry.runtime_data.data.to_dict()
8 changes: 3 additions & 5 deletions homeassistant/components/tailwind/number.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,14 @@
from gotailwind import Tailwind, TailwindDeviceStatus, TailwindError

from homeassistant.components.number import NumberEntity, NumberEntityDescription
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import PERCENTAGE, EntityCategory
from homeassistant.core import HomeAssistant
from homeassistant.exceptions import HomeAssistantError
from homeassistant.helpers.entity_platform import AddEntitiesCallback

from .const import DOMAIN
from .coordinator import TailwindDataUpdateCoordinator
from .entity import TailwindEntity
from .typing import TailwindConfigEntry


@dataclass(frozen=True, kw_only=True)
Expand Down Expand Up @@ -47,14 +46,13 @@ class TailwindNumberEntityDescription(NumberEntityDescription):

async def async_setup_entry(
hass: HomeAssistant,
entry: ConfigEntry,
entry: TailwindConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up Tailwind number based on a config entry."""
coordinator: TailwindDataUpdateCoordinator = hass.data[DOMAIN][entry.entry_id]
async_add_entities(
TailwindNumberEntity(
coordinator,
entry.runtime_data,
description,
)
for description in DESCRIPTIONS
Expand Down
7 changes: 7 additions & 0 deletions homeassistant/components/tailwind/typing.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
"""Typings for the Tailwind integration."""

from homeassistant.config_entries import ConfigEntry

from .coordinator import TailwindDataUpdateCoordinator

TailwindConfigEntry = ConfigEntry[TailwindDataUpdateCoordinator]

0 comments on commit f5f5790

Please sign in to comment.