cover.py

Go to the documentation of this file.

"""Support for IKEA Tradfri covers."""
 
from __future__ import annotations
 
from collections.abc import Callable
from typing import Any, cast
 
from pytradfri.command import Command
 
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 CONF_GATEWAY_ID, COORDINATOR, COORDINATOR_LIST, DOMAIN, KEY_API
from .coordinator import TradfriDeviceDataUpdateCoordinator
from .entity import TradfriBaseEntity
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    config_entry: ConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Load Tradfri covers based on a config entry."""
    gateway_id = config_entry.data[CONF_GATEWAY_ID]
    coordinator_data = hass.data[DOMAIN][config_entry.entry_id][COORDINATOR]
    api = coordinator_data[KEY_API]
 
    async_add_entities(
        TradfriCover(
            device_coordinator,
            api,
            gateway_id,
        )
        for device_coordinator in coordinator_data[COORDINATOR_LIST]
        if device_coordinator.device.has_blind_control
    )
 
 
class TradfriCover(TradfriBaseEntity, CoverEntity):
    """The platform class required by Home Assistant."""
 
    _attr_name = None
 
    def __init__(
        self,
        device_coordinator: TradfriDeviceDataUpdateCoordinator,
        api: Callable[[Command | list[Command]], Any],
        gateway_id: str,
    ) -> None:
        """Initialize a switch."""
        super().__init__(
            device_coordinator=device_coordinator,
            api=api,
            gateway_id=gateway_id,
        )
 
        self._device_control_device_control = self._device.blind_control
        self._device_data_device_data = self._device_control_device_control.blinds[0]
 
    def _refresh(self) -> None:
        """Refresh the device."""
        self._device_data_device_data = self.coordinator.data.blind_control.blinds[0]
 
    @property
    def extra_state_attributes(self) -> dict[str, str] | None:
        """Return the state attributes."""
        return {"model": self._device.device_info.model_number}
 
    @property
    def current_cover_position(self) -> int | None:
        """Return current position of cover.
 
        None is unknown, 0 is closed, 100 is fully open.
        """
        if not self._device_data_device_data:
            return None
        return 100 - cast(int, self._device_data_device_data.current_cover_position)
 
    async def async_set_cover_position(self, **kwargs: Any) -> None:
        """Move the cover to a specific position."""
        if not self._device_control_device_control:
            return
        await self._api_api(self._device_control_device_control.set_state(100 - kwargs[ATTR_POSITION]))
 
    async def async_open_cover(self, **kwargs: Any) -> None:
        """Open the cover."""
        if not self._device_control_device_control:
            return
        await self._api_api(self._device_control_device_control.set_state(0))
 
    async def async_close_cover(self, **kwargs: Any) -> None:
        """Close cover."""
        if not self._device_control_device_control:
            return
        await self._api_api(self._device_control_device_control.set_state(100))
 
    async def async_stop_cover(self, **kwargs: Any) -> None:
        """Close cover."""
        if not self._device_control_device_control:
            return
        await self._api_api(self._device_control_device_control.trigger_blind())
 
    @property
    def is_closed(self) -> bool:
        """Return if the cover is closed or not."""
        return self.current_cover_positioncurrent_cover_positioncurrent_cover_positioncurrent_cover_positioncurrent_cover_position == 0