cover.py

Go to the documentation of this file.

"""Support for covers."""
 
from __future__ import annotations
 
from typing import Any
 
from aiocomelit import ComelitSerialBridgeObject
from aiocomelit.const import COVER, STATE_COVER, STATE_OFF, STATE_ON
 
from homeassistant.components.cover import CoverDeviceClass, CoverEntity, CoverState
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.restore_state import RestoreEntity
from homeassistant.helpers.update_coordinator import CoordinatorEntity
 
from .const import DOMAIN
from .coordinator import ComelitSerialBridge
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    config_entry: ConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up Comelit covers."""
 
    coordinator: ComelitSerialBridge = hass.data[DOMAIN][config_entry.entry_id]
 
    async_add_entities(
        ComelitCoverEntity(coordinator, device, config_entry.entry_id)
        for device in coordinator.data[COVER].values()
    )
 
 
class ComelitCoverEntity(
    CoordinatorEntity[ComelitSerialBridge], RestoreEntity, CoverEntity
):
    """Cover device."""
 
    _attr_device_class = CoverDeviceClass.SHUTTER
    _attr_has_entity_name = True
    _attr_name = None
 
    def __init__(
        self,
        coordinator: ComelitSerialBridge,
        device: ComelitSerialBridgeObject,
        config_entry_entry_id: str,
    ) -> None:
        """Init cover entity."""
        self._api_api = coordinator.api
        self._device_device_device = device
        super().__init__(coordinator)
        # Use config_entry.entry_id as base for unique_id
        # because no serial number or mac is available
        self._attr_unique_id_attr_unique_id = f"{config_entry_entry_id}-{device.index}"
        self._attr_device_info_attr_device_info = coordinator.platform_device_info(device, device.type)
        # Device doesn't provide a status so we assume UNKNOWN at first startup
        self._last_action_last_action: int | None = None
        self._last_state_last_state: str | None = None
 
    def _current_action(self, action: str) -> bool:
        """Return the current cover action."""
        is_moving = self.device_statusdevice_statusdevice_status == STATE_COVER.index(action)
        if is_moving:
            self._last_action_last_action = STATE_COVER.index(action)
        return is_moving
 
    @property
    def device_status(self) -> int:
        """Return current device status."""
        return self.coordinator.data[COVER][self._device_device_device.index].status
 
    @property
    def is_closed(self) -> bool | None:
        """Return if the cover is closed."""
 
        if self._last_state_last_state in [None, "unknown"]:
            return None
 
        if self.device_statusdevice_statusdevice_status != STATE_COVER.index("stopped"):
            return False
 
        if self._last_action_last_action:
            return self._last_action_last_action == STATE_COVER.index("closing")
 
        return self._last_state_last_state == CoverState.CLOSED
 
    @property
    def is_closing(self) -> bool:
        """Return if the cover is closing."""
        return self._current_action_current_action("closing")
 
    @property
    def is_opening(self) -> bool:
        """Return if the cover is opening."""
        return self._current_action_current_action("opening")
 
    async def async_close_cover(self, **kwargs: Any) -> None:
        """Close cover."""
        await self._api_api.set_device_status(COVER, self._device_device_device.index, STATE_OFF)
 
    async def async_open_cover(self, **kwargs: Any) -> None:
        """Open cover."""
        await self._api_api.set_device_status(COVER, self._device_device_device.index, STATE_ON)
 
    async def async_stop_cover(self, **_kwargs: Any) -> None:
        """Stop the cover."""
        if not self.is_closingis_closingis_closing and not self.is_openingis_openingis_opening:
            return
 
        action = STATE_ON if self.is_closingis_closingis_closing else STATE_OFF
        await self._api_api.set_device_status(COVER, self._device_device_device.index, action)
 
    @callback
    def _handle_coordinator_update(self) -> None:
        """Handle device update."""
        self._last_state_last_state = self.statestatestate
        self.async_write_ha_stateasync_write_ha_state()
 
    async def async_added_to_hass(self) -> None:
        """Handle entity which will be added."""
 
        await super().async_added_to_hass()
 
        if last_state := await self.async_get_last_stateasync_get_last_state():
            self._last_state_last_state = last_state.state