cover.py

Go to the documentation of this file.

"""Support for Velux covers."""
 
from __future__ import annotations
 
from typing import Any, cast
 
from pyvlx import OpeningDevice, Position
from pyvlx.opening_device import Awning, Blind, GarageDoor, Gate, RollerShutter, Window
 
from homeassistant.components.cover import (
    ATTR_POSITION,
    ATTR_TILT_POSITION,
    CoverDeviceClass,
    CoverEntity,
    CoverEntityFeature,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
from .const import DOMAIN
from .entity import VeluxEntity
 
PARALLEL_UPDATES = 1
 
 
async def async_setup_entry(
    hass: HomeAssistant, config: ConfigEntry, async_add_entities: AddEntitiesCallback
) -> None:
    """Set up cover(s) for Velux platform."""
    module = hass.data[DOMAIN][config.entry_id]
    async_add_entities(
        VeluxCover(node, config.entry_id)
        for node in module.pyvlx.nodes
        if isinstance(node, OpeningDevice)
    )
 
 
class VeluxCover(VeluxEntity, CoverEntity):
    """Representation of a Velux cover."""
 
    _is_blind = False
    node: OpeningDevice
 
    def __init__(self, node: OpeningDevice, config_entry_id: str) -> None:
        """Initialize VeluxCover."""
        super().__init__(node, config_entry_id)
        self._attr_device_class_attr_device_class = CoverDeviceClass.WINDOW
        if isinstance(node, Awning):
            self._attr_device_class_attr_device_class = CoverDeviceClass.AWNING
        if isinstance(node, Blind):
            self._attr_device_class_attr_device_class = CoverDeviceClass.BLIND
            self._is_blind_is_blind_is_blind = True
        if isinstance(node, GarageDoor):
            self._attr_device_class_attr_device_class = CoverDeviceClass.GARAGE
        if isinstance(node, Gate):
            self._attr_device_class_attr_device_class = CoverDeviceClass.GATE
        if isinstance(node, RollerShutter):
            self._attr_device_class_attr_device_class = CoverDeviceClass.SHUTTER
        if isinstance(node, Window):
            self._attr_device_class_attr_device_class = CoverDeviceClass.WINDOW
 
    @property
    def supported_features(self) -> CoverEntityFeature:
        """Flag supported features."""
        supported_features = (
            CoverEntityFeature.OPEN
            | CoverEntityFeature.CLOSE
            | CoverEntityFeature.SET_POSITION
            | CoverEntityFeature.STOP
        )
        if self.current_cover_tilt_positioncurrent_cover_tilt_positioncurrent_cover_tilt_positioncurrent_cover_tilt_position is not None:
            supported_features |= (
                CoverEntityFeature.OPEN_TILT
                | CoverEntityFeature.CLOSE_TILT
                | CoverEntityFeature.SET_TILT_POSITION
                | CoverEntityFeature.STOP_TILT
            )
        return supported_features
 
    @property
    def current_cover_position(self) -> int:
        """Return the current position of the cover."""
        return 100 - self.nodenode.position.position_percent
 
    @property
    def current_cover_tilt_position(self) -> int | None:
        """Return the current position of the cover."""
        if self._is_blind_is_blind_is_blind:
            return 100 - cast(Blind, self.nodenode).orientation.position_percent
        return None
 
    @property
    def is_closed(self) -> bool:
        """Return if the cover is closed."""
        return self.nodenode.position.closed
 
    @property
    def is_opening(self) -> bool:
        """Return if the cover is opening or not."""
        return self.nodenode.is_opening
 
    @property
    def is_closing(self) -> bool:
        """Return if the cover is closing or not."""
        return self.nodenode.is_closing
 
    async def async_close_cover(self, **kwargs: Any) -> None:
        """Close the cover."""
        await self.nodenode.close(wait_for_completion=False)
 
    async def async_open_cover(self, **kwargs: Any) -> None:
        """Open the cover."""
        await self.nodenode.open(wait_for_completion=False)
 
    async def async_set_cover_position(self, **kwargs: Any) -> None:
        """Move the cover to a specific position."""
        position_percent = 100 - kwargs[ATTR_POSITION]
 
        await self.nodenode.set_position(
            Position(position_percent=position_percent), wait_for_completion=False
        )
 
    async def async_stop_cover(self, **kwargs: Any) -> None:
        """Stop the cover."""
        await self.nodenode.stop(wait_for_completion=False)
 
    async def async_close_cover_tilt(self, **kwargs: Any) -> None:
        """Close cover tilt."""
        await cast(Blind, self.nodenode).close_orientation(wait_for_completion=False)
 
    async def async_open_cover_tilt(self, **kwargs: Any) -> None:
        """Open cover tilt."""
        await cast(Blind, self.nodenode).open_orientation(wait_for_completion=False)
 
    async def async_stop_cover_tilt(self, **kwargs: Any) -> None:
        """Stop cover tilt."""
        await cast(Blind, self.nodenode).stop_orientation(wait_for_completion=False)
 
    async def async_set_cover_tilt_position(self, **kwargs: Any) -> None:
        """Move cover tilt to a specific position."""
        position_percent = 100 - kwargs[ATTR_TILT_POSITION]
        orientation = Position(position_percent=position_percent)
        await cast(Blind, self.nodenode).set_orientation(
            orientation=orientation, wait_for_completion=False
        )