cover.py

Go to the documentation of this file.

"""Support for HomematicIP Cloud cover devices."""
 
from __future__ import annotations
 
from typing import Any
 
from homematicip.aio.device import (
    AsyncBlindModule,
    AsyncDinRailBlind4,
    AsyncFullFlushBlind,
    AsyncFullFlushShutter,
    AsyncGarageDoorModuleTormatic,
    AsyncHoermannDrivesModule,
)
from homematicip.aio.group import AsyncExtendedLinkedShutterGroup
from homematicip.base.enums import DoorCommand, DoorState
 
from homeassistant.components.cover import (
    ATTR_POSITION,
    ATTR_TILT_POSITION,
    CoverDeviceClass,
    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 HomematicipGenericEntity
from .hap import HomematicipHAP
 
HMIP_COVER_OPEN = 0
HMIP_COVER_CLOSED = 1
HMIP_SLATS_OPEN = 0
HMIP_SLATS_CLOSED = 1
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    config_entry: ConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up the HomematicIP cover from a config entry."""
    hap = hass.data[DOMAIN][config_entry.unique_id]
    entities: list[HomematicipGenericEntity] = [
        HomematicipCoverShutterGroup(hap, group)
        for group in hap.home.groups
        if isinstance(group, AsyncExtendedLinkedShutterGroup)
    ]
    for device in hap.home.devices:
        if isinstance(device, AsyncBlindModule):
            entities.append(HomematicipBlindModule(hap, device))
        elif isinstance(device, AsyncDinRailBlind4):
            entities.extend(
                HomematicipMultiCoverSlats(hap, device, channel=channel)
                for channel in range(1, 5)
            )
        elif isinstance(device, AsyncFullFlushBlind):
            entities.append(HomematicipCoverSlats(hap, device))
        elif isinstance(device, AsyncFullFlushShutter):
            entities.append(HomematicipCoverShutter(hap, device))
        elif isinstance(
            device, (AsyncHoermannDrivesModule, AsyncGarageDoorModuleTormatic)
        ):
            entities.append(HomematicipGarageDoorModule(hap, device))
 
    async_add_entities(entities)
 
 
class HomematicipBlindModule(HomematicipGenericEntity, CoverEntity):
    """Representation of the HomematicIP blind module."""
 
    _attr_device_class = CoverDeviceClass.BLIND
 
    @property
    def current_cover_position(self) -> int | None:
        """Return current position of cover."""
        if self._device_device.primaryShadingLevel is not None:
            return int((1 - self._device_device.primaryShadingLevel) * 100)
        return None
 
    @property
    def current_cover_tilt_position(self) -> int | None:
        """Return current tilt position of cover."""
        if self._device_device.secondaryShadingLevel is not None:
            return int((1 - self._device_device.secondaryShadingLevel) * 100)
        return None
 
    async def async_set_cover_position(self, **kwargs: Any) -> None:
        """Move the cover to a specific position."""
        position = kwargs[ATTR_POSITION]
        # HmIP cover is closed:1 -> open:0
        level = 1 - position / 100.0
        await self._device_device.set_primary_shading_level(primaryShadingLevel=level)
 
    async def async_set_cover_tilt_position(self, **kwargs: Any) -> None:
        """Move the cover to a specific tilt position."""
        position = kwargs[ATTR_TILT_POSITION]
        # HmIP slats is closed:1 -> open:0
        level = 1 - position / 100.0
        await self._device_device.set_secondary_shading_level(
            primaryShadingLevel=self._device_device.primaryShadingLevel,
            secondaryShadingLevel=level,
        )
 
    @property
    def is_closed(self) -> bool | None:
        """Return if the cover is closed."""
        if self._device_device.primaryShadingLevel is not None:
            return self._device_device.primaryShadingLevel == HMIP_COVER_CLOSED
        return None
 
    async def async_open_cover(self, **kwargs: Any) -> None:
        """Open the cover."""
        await self._device_device.set_primary_shading_level(
            primaryShadingLevel=HMIP_COVER_OPEN
        )
 
    async def async_close_cover(self, **kwargs: Any) -> None:
        """Close the cover."""
        await self._device_device.set_primary_shading_level(
            primaryShadingLevel=HMIP_COVER_CLOSED
        )
 
    async def async_stop_cover(self, **kwargs: Any) -> None:
        """Stop the device if in motion."""
        await self._device_device.stop()
 
    async def async_open_cover_tilt(self, **kwargs: Any) -> None:
        """Open the slats."""
        await self._device_device.set_secondary_shading_level(
            primaryShadingLevel=self._device_device.primaryShadingLevel,
            secondaryShadingLevel=HMIP_SLATS_OPEN,
        )
 
    async def async_close_cover_tilt(self, **kwargs: Any) -> None:
        """Close the slats."""
        await self._device_device.set_secondary_shading_level(
            primaryShadingLevel=self._device_device.primaryShadingLevel,
            secondaryShadingLevel=HMIP_SLATS_CLOSED,
        )
 
    async def async_stop_cover_tilt(self, **kwargs: Any) -> None:
        """Stop the device if in motion."""
        await self._device_device.stop()
 
 
class HomematicipMultiCoverShutter(HomematicipGenericEntity, CoverEntity):
    """Representation of the HomematicIP cover shutter."""
 
    _attr_device_class = CoverDeviceClass.SHUTTER
 
    def __init__(
        self,
        hap: HomematicipHAP,
        device,
        channel=1,
        is_multi_channel=True,
    ) -> None:
        """Initialize the multi cover entity."""
        super().__init__(
            hap, device, channel=channel, is_multi_channel=is_multi_channel
        )
 
    @property
    def current_cover_position(self) -> int | None:
        """Return current position of cover."""
        if self._device_device.functionalChannels[self._channel_channel].shutterLevel is not None:
            return int(
                (1 - self._device_device.functionalChannels[self._channel_channel].shutterLevel) * 100
            )
        return None
 
    async def async_set_cover_position(self, **kwargs: Any) -> None:
        """Move the cover to a specific position."""
        position = kwargs[ATTR_POSITION]
        # HmIP cover is closed:1 -> open:0
        level = 1 - position / 100.0
        await self._device_device.set_shutter_level(level, self._channel_channel)
 
    @property
    def is_closed(self) -> bool | None:
        """Return if the cover is closed."""
        if self._device_device.functionalChannels[self._channel_channel].shutterLevel is not None:
            return (
                self._device_device.functionalChannels[self._channel_channel].shutterLevel
                == HMIP_COVER_CLOSED
            )
        return None
 
    async def async_open_cover(self, **kwargs: Any) -> None:
        """Open the cover."""
        await self._device_device.set_shutter_level(HMIP_COVER_OPEN, self._channel_channel)
 
    async def async_close_cover(self, **kwargs: Any) -> None:
        """Close the cover."""
        await self._device_device.set_shutter_level(HMIP_COVER_CLOSED, self._channel_channel)
 
    async def async_stop_cover(self, **kwargs: Any) -> None:
        """Stop the device if in motion."""
        await self._device_device.set_shutter_stop(self._channel_channel)
 
 
class HomematicipCoverShutter(HomematicipMultiCoverShutter, CoverEntity):
    """Representation of the HomematicIP cover shutter."""
 
    def __init__(self, hap: HomematicipHAP, device) -> None:
        """Initialize the multi cover entity."""
        super().__init__(hap, device, is_multi_channel=False)
 
 
class HomematicipMultiCoverSlats(HomematicipMultiCoverShutter, CoverEntity):
    """Representation of the HomematicIP multi cover slats."""
 
    def __init__(
        self,
        hap: HomematicipHAP,
        device,
        channel=1,
        is_multi_channel=True,
    ) -> None:
        """Initialize the multi slats entity."""
        super().__init__(
            hap, device, channel=channel, is_multi_channel=is_multi_channel
        )
 
    @property
    def current_cover_tilt_position(self) -> int | None:
        """Return current tilt position of cover."""
        if self._device_device.functionalChannels[self._channel_channel].slatsLevel is not None:
            return int(
                (1 - self._device_device.functionalChannels[self._channel_channel].slatsLevel) * 100
            )
        return None
 
    async def async_set_cover_tilt_position(self, **kwargs: Any) -> None:
        """Move the cover to a specific tilt position."""
        position = kwargs[ATTR_TILT_POSITION]
        # HmIP slats is closed:1 -> open:0
        level = 1 - position / 100.0
        await self._device_device.set_slats_level(slatsLevel=level, channelIndex=self._channel_channel)
 
    async def async_open_cover_tilt(self, **kwargs: Any) -> None:
        """Open the slats."""
        await self._device_device.set_slats_level(
            slatsLevel=HMIP_SLATS_OPEN, channelIndex=self._channel_channel
        )
 
    async def async_close_cover_tilt(self, **kwargs: Any) -> None:
        """Close the slats."""
        await self._device_device.set_slats_level(
            slatsLevel=HMIP_SLATS_CLOSED, channelIndex=self._channel_channel
        )
 
    async def async_stop_cover_tilt(self, **kwargs: Any) -> None:
        """Stop the device if in motion."""
        await self._device_device.set_shutter_stop(self._channel_channel)
 
 
class HomematicipCoverSlats(HomematicipMultiCoverSlats, CoverEntity):
    """Representation of the HomematicIP cover slats."""
 
    def __init__(self, hap: HomematicipHAP, device) -> None:
        """Initialize the multi slats entity."""
        super().__init__(hap, device, is_multi_channel=False)
 
 
class HomematicipGarageDoorModule(HomematicipGenericEntity, CoverEntity):
    """Representation of the HomematicIP Garage Door Module."""
 
    _attr_device_class = CoverDeviceClass.GARAGE
 
    @property
    def current_cover_position(self) -> int | None:
        """Return current position of cover."""
        door_state_to_position = {
            DoorState.CLOSED: 0,
            DoorState.OPEN: 100,
            DoorState.VENTILATION_POSITION: 10,
            DoorState.POSITION_UNKNOWN: None,
        }
        return door_state_to_position.get(self._device_device.doorState)
 
    @property
    def is_closed(self) -> bool | None:
        """Return if the cover is closed."""
        return self._device_device.doorState == DoorState.CLOSED
 
    async def async_open_cover(self, **kwargs: Any) -> None:
        """Open the cover."""
        await self._device_device.send_door_command(DoorCommand.OPEN)
 
    async def async_close_cover(self, **kwargs: Any) -> None:
        """Close the cover."""
        await self._device_device.send_door_command(DoorCommand.CLOSE)
 
    async def async_stop_cover(self, **kwargs: Any) -> None:
        """Stop the cover."""
        await self._device_device.send_door_command(DoorCommand.STOP)
 
 
class HomematicipCoverShutterGroup(HomematicipGenericEntity, CoverEntity):
    """Representation of the HomematicIP cover shutter group."""
 
    _attr_device_class = CoverDeviceClass.SHUTTER
 
    def __init__(self, hap: HomematicipHAP, device, post: str = "ShutterGroup") -> None:
        """Initialize switching group."""
        device.modelType = f"HmIP-{post}"
        super().__init__(hap, device, post, is_multi_channel=False)
 
    @property
    def current_cover_position(self) -> int | None:
        """Return current position of cover."""
        if self._device_device.shutterLevel is not None:
            return int((1 - self._device_device.shutterLevel) * 100)
        return None
 
    @property
    def current_cover_tilt_position(self) -> int | None:
        """Return current tilt position of cover."""
        if self._device_device.slatsLevel is not None:
            return int((1 - self._device_device.slatsLevel) * 100)
        return None
 
    @property
    def is_closed(self) -> bool | None:
        """Return if the cover is closed."""
        if self._device_device.shutterLevel is not None:
            return self._device_device.shutterLevel == HMIP_COVER_CLOSED
        return None
 
    async def async_set_cover_position(self, **kwargs: Any) -> None:
        """Move the cover to a specific position."""
        position = kwargs[ATTR_POSITION]
        # HmIP cover is closed:1 -> open:0
        level = 1 - position / 100.0
        await self._device_device.set_shutter_level(level)
 
    async def async_set_cover_tilt_position(self, **kwargs: Any) -> None:
        """Move the cover to a specific tilt position."""
        position = kwargs[ATTR_TILT_POSITION]
        # HmIP slats is closed:1 -> open:0
        level = 1 - position / 100.0
        await self._device_device.set_slats_level(level)
 
    async def async_open_cover(self, **kwargs: Any) -> None:
        """Open the cover."""
        await self._device_device.set_shutter_level(HMIP_COVER_OPEN)
 
    async def async_close_cover(self, **kwargs: Any) -> None:
        """Close the cover."""
        await self._device_device.set_shutter_level(HMIP_COVER_CLOSED)
 
    async def async_stop_cover(self, **kwargs: Any) -> None:
        """Stop the group if in motion."""
        await self._device_device.set_shutter_stop()
 
    async def async_open_cover_tilt(self, **kwargs: Any) -> None:
        """Open the slats."""
        await self._device_device.set_slats_level(HMIP_SLATS_OPEN)
 
    async def async_close_cover_tilt(self, **kwargs: Any) -> None:
        """Close the slats."""
        await self._device_device.set_slats_level(HMIP_SLATS_CLOSED)
 
    async def async_stop_cover_tilt(self, **kwargs: Any) -> None:
        """Stop the group if in motion."""
        await self._device_device.set_shutter_stop()