cover.py

Go to the documentation of this file.

"""Support for SUPLA covers - curtains, rollershutters, entry gate etc."""
 
from __future__ import annotations
 
import logging
from pprint import pformat
from typing import Any
 
from homeassistant.components.cover import ATTR_POSITION, CoverDeviceClass, CoverEntity
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
 
from . import DOMAIN, SUPLA_COORDINATORS, SUPLA_SERVERS
from .entity import SuplaEntity
 
_LOGGER = logging.getLogger(__name__)
 
SUPLA_SHUTTER = "CONTROLLINGTHEROLLERSHUTTER"
SUPLA_GATE = "CONTROLLINGTHEGATE"
SUPLA_GARAGE_DOOR = "CONTROLLINGTHEGARAGEDOOR"
 
 
async def async_setup_platform(
    hass: HomeAssistant,
    config: ConfigType,
    async_add_entities: AddEntitiesCallback,
    discovery_info: DiscoveryInfoType | None = None,
) -> None:
    """Set up the SUPLA covers."""
    if discovery_info is None:
        return
 
    _LOGGER.debug("Discovery: %s", pformat(discovery_info))
 
    entities: list[CoverEntity] = []
    for device in discovery_info.values():
        device_name = device["function_name"]
        server_name = device["server_name"]
 
        if device_name == SUPLA_SHUTTER:
            entities.append(
                SuplaCoverEntity(
                    device,
                    hass.data[DOMAIN][SUPLA_SERVERS][server_name],
                    hass.data[DOMAIN][SUPLA_COORDINATORS][server_name],
                )
            )
 
        elif device_name in {SUPLA_GATE, SUPLA_GARAGE_DOOR}:
            entities.append(
                SuplaDoorEntity(
                    device,
                    hass.data[DOMAIN][SUPLA_SERVERS][server_name],
                    hass.data[DOMAIN][SUPLA_COORDINATORS][server_name],
                )
            )
 
    async_add_entities(entities)
 
 
class SuplaCoverEntity(SuplaEntity, CoverEntity):
    """Representation of a SUPLA Cover."""
 
    @property
    def current_cover_position(self) -> int | None:
        """Return current position of cover. 0 is closed, 100 is open."""
        if state := self.channel_datachannel_data.get("state"):
            return 100 - state["shut"]
        return None
 
    async def async_set_cover_position(self, **kwargs: Any) -> None:
        """Move the cover to a specific position."""
        await self.async_actionasync_action(
            "REVEAL_PARTIALLY", percentage=kwargs.get(ATTR_POSITION)
        )
 
    @property
    def is_closed(self) -> bool | None:
        """Return if the cover is closed."""
        if self.current_cover_positioncurrent_cover_positioncurrent_cover_positioncurrent_cover_positioncurrent_cover_position is None:
            return None
        return self.current_cover_positioncurrent_cover_positioncurrent_cover_positioncurrent_cover_positioncurrent_cover_position == 0
 
    async def async_open_cover(self, **kwargs: Any) -> None:
        """Open the cover."""
        await self.async_actionasync_action("REVEAL")
 
    async def async_close_cover(self, **kwargs: Any) -> None:
        """Close the cover."""
        await self.async_actionasync_action("SHUT")
 
    async def async_stop_cover(self, **kwargs: Any) -> None:
        """Stop the cover."""
        await self.async_actionasync_action("STOP")
 
 
class SuplaDoorEntity(SuplaEntity, CoverEntity):
    """Representation of a SUPLA door."""
 
    _attr_device_class = CoverDeviceClass.GARAGE
 
    @property
    def is_closed(self) -> bool | None:
        """Return if the door is closed or not."""
        state = self.channel_datachannel_data.get("state")
        if state and "hi" in state:
            return state.get("hi")
        return None
 
    async def async_open_cover(self, **kwargs: Any) -> None:
        """Open the door."""
        if self.is_closedis_closedis_closed:
            await self.async_actionasync_action("OPEN_CLOSE")
 
    async def async_close_cover(self, **kwargs: Any) -> None:
        """Close the door."""
        if not self.is_closedis_closedis_closed:
            await self.async_actionasync_action("OPEN_CLOSE")
 
    async def async_stop_cover(self, **kwargs: Any) -> None:
        """Stop the door."""
        await self.async_actionasync_action("OPEN_CLOSE")
 
    async def async_toggle(self, **kwargs: Any) -> None:
        """Toggle the door."""
        await self.async_actionasync_action("OPEN_CLOSE")