156 lines
5.0 KiB
Python
156 lines
5.0 KiB
Python
"""Platform for the Aladdin Connect cover component."""
|
|
from __future__ import annotations
|
|
|
|
from datetime import timedelta
|
|
import logging
|
|
from typing import Any, Final
|
|
|
|
from AIOAladdinConnect import AladdinConnectClient
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.cover import (
|
|
PLATFORM_SCHEMA as BASE_PLATFORM_SCHEMA,
|
|
CoverDeviceClass,
|
|
CoverEntity,
|
|
)
|
|
from homeassistant.config_entries import SOURCE_IMPORT, ConfigEntry
|
|
from homeassistant.const import (
|
|
CONF_PASSWORD,
|
|
CONF_USERNAME,
|
|
STATE_CLOSED,
|
|
STATE_CLOSING,
|
|
STATE_OPENING,
|
|
)
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.exceptions import PlatformNotReady
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.helpers.entity import DeviceInfo
|
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
|
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
|
|
|
|
from .const import DOMAIN, STATES_MAP, SUPPORTED_FEATURES
|
|
from .model import DoorDevice
|
|
|
|
_LOGGER: Final = logging.getLogger(__name__)
|
|
|
|
PLATFORM_SCHEMA: Final = BASE_PLATFORM_SCHEMA.extend(
|
|
{vol.Required(CONF_USERNAME): cv.string, vol.Required(CONF_PASSWORD): cv.string}
|
|
)
|
|
SCAN_INTERVAL = timedelta(seconds=300)
|
|
|
|
|
|
async def async_setup_platform(
|
|
hass: HomeAssistant,
|
|
config: ConfigType,
|
|
async_add_entities: AddEntitiesCallback,
|
|
discovery_info: DiscoveryInfoType | None = None,
|
|
) -> None:
|
|
"""Set up Aladdin Connect devices yaml depreciated."""
|
|
_LOGGER.warning(
|
|
"Configuring Aladdin Connect through yaml is deprecated"
|
|
"Please remove it from your configuration as it has already been imported to a config entry"
|
|
)
|
|
await hass.async_create_task(
|
|
hass.config_entries.flow.async_init(
|
|
DOMAIN,
|
|
context={"source": SOURCE_IMPORT},
|
|
data=config,
|
|
)
|
|
)
|
|
|
|
|
|
async def async_setup_entry(
|
|
hass: HomeAssistant,
|
|
config_entry: ConfigEntry,
|
|
async_add_entities: AddEntitiesCallback,
|
|
) -> None:
|
|
"""Set up the Aladdin Connect platform."""
|
|
acc: AladdinConnectClient = hass.data[DOMAIN][config_entry.entry_id]
|
|
doors = await acc.get_doors()
|
|
if doors is None:
|
|
raise PlatformNotReady("Error from Aladdin Connect getting doors")
|
|
async_add_entities(
|
|
(AladdinDevice(acc, door, config_entry) for door in doors),
|
|
)
|
|
|
|
|
|
class AladdinDevice(CoverEntity):
|
|
"""Representation of Aladdin Connect cover."""
|
|
|
|
_attr_device_class = CoverDeviceClass.GARAGE
|
|
_attr_supported_features = SUPPORTED_FEATURES
|
|
|
|
def __init__(
|
|
self, acc: AladdinConnectClient, device: DoorDevice, entry: ConfigEntry
|
|
) -> None:
|
|
"""Initialize the Aladdin Connect cover."""
|
|
self._acc = acc
|
|
|
|
self._device_id = device["device_id"]
|
|
self._number = device["door_number"]
|
|
self._name = device["name"]
|
|
self._serial = device["serial"]
|
|
self._model = device["model"]
|
|
self._attr_unique_id = f"{self._device_id}-{self._number}"
|
|
self._attr_has_entity_name = True
|
|
|
|
@property
|
|
def device_info(self) -> DeviceInfo | None:
|
|
"""Device information for Aladdin Connect cover."""
|
|
return DeviceInfo(
|
|
identifiers={(DOMAIN, f"{self._device_id}-{self._number}")},
|
|
name=self._name,
|
|
manufacturer="Overhead Door",
|
|
model=self._model,
|
|
)
|
|
|
|
async def async_added_to_hass(self) -> None:
|
|
"""Connect Aladdin Connect to the cloud."""
|
|
|
|
async def update_callback() -> None:
|
|
"""Schedule a state update."""
|
|
self.async_write_ha_state()
|
|
|
|
self._acc.register_callback(update_callback, self._serial, self._number)
|
|
await self._acc.get_doors(self._serial)
|
|
|
|
async def async_will_remove_from_hass(self) -> None:
|
|
"""Close Aladdin Connect before removing."""
|
|
await self._acc.close()
|
|
|
|
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_open_cover(self, **kwargs: Any) -> None:
|
|
"""Issue open command to cover."""
|
|
await self._acc.open_door(self._device_id, self._number)
|
|
|
|
async def async_update(self) -> None:
|
|
"""Update status of cover."""
|
|
await self._acc.get_doors(self._serial)
|
|
|
|
@property
|
|
def is_closed(self) -> bool | None:
|
|
"""Update is closed attribute."""
|
|
value = STATES_MAP.get(self._acc.get_door_status(self._device_id, self._number))
|
|
if value is None:
|
|
return None
|
|
return value == STATE_CLOSED
|
|
|
|
@property
|
|
def is_closing(self) -> bool:
|
|
"""Update is closing attribute."""
|
|
return (
|
|
STATES_MAP.get(self._acc.get_door_status(self._device_id, self._number))
|
|
== STATE_CLOSING
|
|
)
|
|
|
|
@property
|
|
def is_opening(self) -> bool:
|
|
"""Update is opening attribute."""
|
|
return (
|
|
STATES_MAP.get(self._acc.get_door_status(self._device_id, self._number))
|
|
== STATE_OPENING
|
|
)
|