cover.py

Go to the documentation of this file.

"""Support for AVM FRITZ!SmartHome cover devices."""
 
from __future__ import annotations
 
from typing import Any
 
from homeassistant.components.cover import (
    ATTR_POSITION,
    CoverDeviceClass,
    CoverEntity,
    CoverEntityFeature,
)
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
from .coordinator import FritzboxConfigEntry
from .entity import FritzBoxDeviceEntity
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    entry: FritzboxConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up the FRITZ!SmartHome cover from ConfigEntry."""
    coordinator = entry.runtime_data
 
    @callback
    def _add_entities(devices: set[str] | None = None) -> None:
        """Add devices."""
        if devices is None:
            devices = coordinator.new_devices
        if not devices:
            return
        async_add_entities(
            FritzboxCover(coordinator, ain)
            for ain in devices
            if coordinator.data.devices[ain].has_blind
        )
 
    entry.async_on_unload(coordinator.async_add_listener(_add_entities))
 
    _add_entities(set(coordinator.data.devices))
 
 
class FritzboxCover(FritzBoxDeviceEntity, CoverEntity):
    """The cover class for FRITZ!SmartHome covers."""
 
    _attr_device_class = CoverDeviceClass.BLIND
    _attr_supported_features = (
        CoverEntityFeature.OPEN
        | CoverEntityFeature.SET_POSITION
        | CoverEntityFeature.CLOSE
        | CoverEntityFeature.STOP
    )
 
    @property
    def current_cover_position(self) -> int | None:
        """Return the current position."""
        position = None
        if self.datadatadatadatadata.levelpercentage is not None:
            position = 100 - self.datadatadatadatadata.levelpercentage
        return position
 
    @property
    def is_closed(self) -> bool | None:
        """Return if the cover is closed."""
        if self.datadatadatadatadata.levelpercentage is None:
            return None
        return self.datadatadatadatadata.levelpercentage == 100  # type: ignore [no-any-return]
 
    async def async_open_cover(self, **kwargs: Any) -> None:
        """Open the cover."""
        await self.hasshasshass.async_add_executor_job(self.datadatadatadatadata.set_blind_open)
        await self.coordinator.async_refresh()
 
    async def async_close_cover(self, **kwargs: Any) -> None:
        """Close the cover."""
        await self.hasshasshass.async_add_executor_job(self.datadatadatadatadata.set_blind_close)
        await self.coordinator.async_refresh()
 
    async def async_set_cover_position(self, **kwargs: Any) -> None:
        """Move the cover to a specific position."""
        await self.hasshasshass.async_add_executor_job(
            self.datadatadatadatadata.set_level_percentage, 100 - kwargs[ATTR_POSITION]
        )
 
    async def async_stop_cover(self, **kwargs: Any) -> None:
        """Stop the cover."""
        await self.hasshasshass.async_add_executor_job(self.datadatadatadatadata.set_blind_stop)
        await self.coordinator.async_refresh()