ha-core/homeassistant/components/overkiz/cover_entities/awning.py

103 lines
3.4 KiB
Python

"""Support for Overkiz awnings."""
from __future__ import annotations
from typing import Any, cast
from pyoverkiz.enums import OverkizCommand, OverkizState
from homeassistant.components.cover import (
ATTR_POSITION,
CoverDeviceClass,
CoverEntityFeature,
)
from .generic_cover import (
COMMANDS_CLOSE,
COMMANDS_OPEN,
COMMANDS_STOP,
OverkizGenericCover,
)
class Awning(OverkizGenericCover):
"""Representation of an Overkiz awning."""
_attr_device_class = CoverDeviceClass.AWNING
@property
def supported_features(self) -> CoverEntityFeature:
"""Flag supported features."""
supported_features = super().supported_features
if self.executor.has_command(OverkizCommand.SET_DEPLOYMENT):
supported_features |= CoverEntityFeature.SET_POSITION
if self.executor.has_command(OverkizCommand.DEPLOY):
supported_features |= CoverEntityFeature.OPEN
if self.executor.has_command(*COMMANDS_STOP):
supported_features |= CoverEntityFeature.STOP
if self.executor.has_command(OverkizCommand.UNDEPLOY):
supported_features |= CoverEntityFeature.CLOSE
return supported_features
@property
def current_cover_position(self) -> int | None:
"""Return current position of cover.
None is unknown, 0 is closed, 100 is fully open.
"""
current_position = self.executor.select_state(OverkizState.CORE_DEPLOYMENT)
if current_position is not None:
return cast(int, current_position)
return None
async def async_set_cover_position(self, **kwargs: Any) -> None:
"""Move the cover to a specific position."""
await self.executor.async_execute_command(
OverkizCommand.SET_DEPLOYMENT, kwargs[ATTR_POSITION]
)
async def async_open_cover(self, **kwargs: Any) -> None:
"""Open the cover."""
await self.executor.async_execute_command(OverkizCommand.DEPLOY)
async def async_close_cover(self, **kwargs: Any) -> None:
"""Close the cover."""
await self.executor.async_execute_command(OverkizCommand.UNDEPLOY)
@property
def is_opening(self) -> bool | None:
"""Return if the cover is opening or not."""
if self.is_running(COMMANDS_OPEN):
return True
# Check if cover is moving based on current state
is_moving = self.device.states.get(OverkizState.CORE_MOVING)
current_closure = self.device.states.get(OverkizState.CORE_DEPLOYMENT)
target_closure = self.device.states.get(OverkizState.CORE_TARGET_CLOSURE)
if not is_moving or not current_closure or not target_closure:
return None
return cast(int, current_closure.value) < cast(int, target_closure.value)
@property
def is_closing(self) -> bool | None:
"""Return if the cover is closing or not."""
if self.is_running(COMMANDS_CLOSE):
return True
# Check if cover is moving based on current state
is_moving = self.device.states.get(OverkizState.CORE_MOVING)
current_closure = self.device.states.get(OverkizState.CORE_DEPLOYMENT)
target_closure = self.device.states.get(OverkizState.CORE_TARGET_CLOSURE)
if not is_moving or not current_closure or not target_closure:
return None
return cast(int, current_closure.value) > cast(int, target_closure.value)