cover.py

Go to the documentation of this file.

"""Support for WiLight Cover."""
 
from __future__ import annotations
 
from typing import Any
 
from pywilight.const import (
    COVER_V1,
    ITEM_COVER,
    WL_CLOSE,
    WL_CLOSING,
    WL_OPEN,
    WL_OPENING,
    WL_STOP,
    WL_STOPPED,
)
 
from homeassistant.components.cover import ATTR_POSITION, CoverEntity
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 WiLightDevice
from .parent_device import WiLightParent
 
 
async def async_setup_entry(
    hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
) -> None:
    """Set up WiLight covers from a config entry."""
    parent: WiLightParent = hass.data[DOMAIN][entry.entry_id]
 
    # Handle a discovered WiLight device.
    entities = []
    assert parent.api
    for item in parent.api.items:
        if item["type"] != ITEM_COVER:
            continue
        index = item["index"]
        item_name = item["name"]
        if item["sub_type"] != COVER_V1:
            continue
        entities.append(WiLightCover(parent.api, index, item_name))
 
    async_add_entities(entities)
 
 
def wilight_to_hass_position(value: int) -> int:
    """Convert wilight position 1..255 to hass format 0..100."""
    return min(100, round((value * 100) / 255))
 
 
def hass_to_wilight_position(value: int) -> int:
    """Convert hass position 0..100 to wilight 1..255 scale."""
    return min(255, round((value * 255) / 100))
 
 
class WiLightCover(WiLightDevice, CoverEntity):
    """Representation of a WiLights cover."""
 
    _attr_name = None
 
    @property
    def current_cover_position(self) -> int | None:
        """Return current position of cover.
 
        None is unknown, 0 is closed, 100 is fully open.
        """
        if "position_current" in self._status_status:
            return wilight_to_hass_position(self._status_status["position_current"])
        return None
 
    @property
    def is_opening(self) -> bool | None:
        """Return if the cover is opening or not."""
        if "motor_state" not in self._status_status:
            return None
        return self._status_status["motor_state"] == WL_OPENING
 
    @property
    def is_closing(self) -> bool | None:
        """Return if the cover is closing or not."""
        if "motor_state" not in self._status_status:
            return None
        return self._status_status["motor_state"] == WL_CLOSING
 
    @property
    def is_closed(self) -> bool | None:
        """Return if the cover is closed or not."""
        if "motor_state" not in self._status_status or "position_current" not in self._status_status:
            return None
        return (
            self._status_status["motor_state"] == WL_STOPPED
            and wilight_to_hass_position(self._status_status["position_current"]) == 0
        )
 
    async def async_open_cover(self, **kwargs: Any) -> None:
        """Open the cover."""
        await self._client_client.cover_command(self._index_index, WL_OPEN)
 
    async def async_close_cover(self, **kwargs: Any) -> None:
        """Close cover."""
        await self._client_client.cover_command(self._index_index, WL_CLOSE)
 
    async def async_set_cover_position(self, **kwargs: Any) -> None:
        """Move the cover to a specific position."""
        position = hass_to_wilight_position(kwargs[ATTR_POSITION])
        await self._client_client.set_cover_position(self._index_index, position)
 
    async def async_stop_cover(self, **kwargs: Any) -> None:
        """Stop the cover."""
        await self._client_client.cover_command(self._index_index, WL_STOP)