mirror of
https://github.com/home-assistant/core.git
synced 2025-11-08 18:39:30 +00:00
136 lines
4.5 KiB
Python
136 lines
4.5 KiB
Python
"""Cover Entity for Genie Garage Door."""
|
|
|
|
from datetime import timedelta
|
|
from typing import Any
|
|
|
|
from genie_partner_sdk.client import AladdinConnectClient
|
|
|
|
from homeassistant.components.cover import (
|
|
CoverDeviceClass,
|
|
CoverEntity,
|
|
CoverEntityFeature,
|
|
)
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.exceptions import PlatformNotReady
|
|
import homeassistant.helpers.device_registry as dr
|
|
from homeassistant.helpers.device_registry import DeviceInfo
|
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
|
|
|
from . import api
|
|
from .const import DOMAIN
|
|
from .model import GarageDoor
|
|
|
|
SCAN_INTERVAL = timedelta(seconds=15)
|
|
|
|
|
|
async def async_setup_entry(
|
|
hass: HomeAssistant,
|
|
config_entry: ConfigEntry,
|
|
async_add_entities: AddEntitiesCallback,
|
|
) -> None:
|
|
"""Set up the Aladdin Connect platform."""
|
|
session: api.AsyncConfigEntryAuth = config_entry.runtime_data
|
|
acc = AladdinConnectClient(session)
|
|
doors = await acc.get_doors()
|
|
if doors is None:
|
|
raise PlatformNotReady("Error from Aladdin Connect getting doors")
|
|
device_registry = dr.async_get(hass)
|
|
doors_to_add = []
|
|
for door in doors:
|
|
existing = device_registry.async_get(door.unique_id)
|
|
if existing is None:
|
|
doors_to_add.append(door)
|
|
|
|
async_add_entities(
|
|
(AladdinDevice(acc, door, config_entry) for door in doors_to_add),
|
|
)
|
|
remove_stale_devices(hass, config_entry, doors)
|
|
|
|
|
|
def remove_stale_devices(
|
|
hass: HomeAssistant, config_entry: ConfigEntry, devices: list[GarageDoor]
|
|
) -> None:
|
|
"""Remove stale devices from device registry."""
|
|
device_registry = dr.async_get(hass)
|
|
device_entries = dr.async_entries_for_config_entry(
|
|
device_registry, config_entry.entry_id
|
|
)
|
|
all_device_ids = {door.unique_id for door in devices}
|
|
|
|
for device_entry in device_entries:
|
|
device_id: str | None = None
|
|
|
|
for identifier in device_entry.identifiers:
|
|
if identifier[0] == DOMAIN:
|
|
device_id = identifier[1]
|
|
break
|
|
|
|
if device_id is None or device_id not in all_device_ids:
|
|
# If device_id is None an invalid device entry was found for this config entry.
|
|
# If the device_id is not in existing device ids it's a stale device entry.
|
|
# Remove config entry from this device entry in either case.
|
|
device_registry.async_update_device(
|
|
device_entry.id, remove_config_entry_id=config_entry.entry_id
|
|
)
|
|
|
|
|
|
class AladdinDevice(CoverEntity):
|
|
"""Representation of Aladdin Connect cover."""
|
|
|
|
_attr_device_class = CoverDeviceClass.GARAGE
|
|
_attr_supported_features = CoverEntityFeature.OPEN | CoverEntityFeature.CLOSE
|
|
_attr_has_entity_name = True
|
|
_attr_name = None
|
|
|
|
def __init__(
|
|
self, acc: AladdinConnectClient, device: GarageDoor, entry: ConfigEntry
|
|
) -> None:
|
|
"""Initialize the Aladdin Connect cover."""
|
|
self._acc = acc
|
|
self._device_id = device.device_id
|
|
self._number = device.door_number
|
|
|
|
self._attr_device_info = DeviceInfo(
|
|
identifiers={(DOMAIN, device.unique_id)},
|
|
name=device.name,
|
|
manufacturer="Overhead Door",
|
|
)
|
|
self._attr_unique_id = device.unique_id
|
|
|
|
async def async_open_cover(self, **kwargs: Any) -> None:
|
|
"""Issue open command to cover."""
|
|
await self._acc.open_door(self._device_id, self._number)
|
|
|
|
async def async_close_cover(self, **kwargs: Any) -> None:
|
|
"""Issue close command to cover."""
|
|
await self._acc.close_door(self._device_id, self._number)
|
|
|
|
async def async_update(self) -> None:
|
|
"""Update status of cover."""
|
|
await self._acc.update_door(self._device_id, self._number)
|
|
|
|
@property
|
|
def is_closed(self) -> bool | None:
|
|
"""Update is closed attribute."""
|
|
value = self._acc.get_door_status(self._device_id, self._number)
|
|
if value is None:
|
|
return None
|
|
return bool(value == "closed")
|
|
|
|
@property
|
|
def is_closing(self) -> bool | None:
|
|
"""Update is closing attribute."""
|
|
value = self._acc.get_door_status(self._device_id, self._number)
|
|
if value is None:
|
|
return None
|
|
return bool(value == "closing")
|
|
|
|
@property
|
|
def is_opening(self) -> bool | None:
|
|
"""Update is opening attribute."""
|
|
value = self._acc.get_door_status(self._device_id, self._number)
|
|
if value is None:
|
|
return None
|
|
return bool(value == "opening")
|