133 lines
4.6 KiB
Python
133 lines
4.6 KiB
Python
"""Support for ESPHome covers."""
|
|
from __future__ import annotations
|
|
|
|
from typing import Any
|
|
|
|
from aioesphomeapi import CoverInfo, CoverOperation, CoverState
|
|
|
|
from homeassistant.components.cover import (
|
|
ATTR_POSITION,
|
|
ATTR_TILT_POSITION,
|
|
DEVICE_CLASSES,
|
|
SUPPORT_CLOSE,
|
|
SUPPORT_CLOSE_TILT,
|
|
SUPPORT_OPEN,
|
|
SUPPORT_OPEN_TILT,
|
|
SUPPORT_SET_POSITION,
|
|
SUPPORT_SET_TILT_POSITION,
|
|
SUPPORT_STOP,
|
|
CoverEntity,
|
|
)
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
|
|
|
from . import EsphomeEntity, esphome_state_property, platform_async_setup_entry
|
|
|
|
|
|
async def async_setup_entry(
|
|
hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
|
|
) -> None:
|
|
"""Set up ESPHome covers based on a config entry."""
|
|
await platform_async_setup_entry(
|
|
hass,
|
|
entry,
|
|
async_add_entities,
|
|
component_key="cover",
|
|
info_type=CoverInfo,
|
|
entity_type=EsphomeCover,
|
|
state_type=CoverState,
|
|
)
|
|
|
|
|
|
# https://github.com/PyCQA/pylint/issues/3150 for all @esphome_state_property
|
|
# pylint: disable=invalid-overridden-method
|
|
|
|
|
|
class EsphomeCover(EsphomeEntity[CoverInfo, CoverState], CoverEntity):
|
|
"""A cover implementation for ESPHome."""
|
|
|
|
@property
|
|
def supported_features(self) -> int:
|
|
"""Flag supported features."""
|
|
flags = SUPPORT_OPEN | SUPPORT_CLOSE | SUPPORT_STOP
|
|
if self._static_info.supports_position:
|
|
flags |= SUPPORT_SET_POSITION
|
|
if self._static_info.supports_tilt:
|
|
flags |= SUPPORT_OPEN_TILT | SUPPORT_CLOSE_TILT | SUPPORT_SET_TILT_POSITION
|
|
return flags
|
|
|
|
@property
|
|
def device_class(self) -> str | None:
|
|
"""Return the class of this device, from component DEVICE_CLASSES."""
|
|
if self._static_info.device_class not in DEVICE_CLASSES:
|
|
return None
|
|
return self._static_info.device_class
|
|
|
|
@property
|
|
def assumed_state(self) -> bool:
|
|
"""Return true if we do optimistic updates."""
|
|
return self._static_info.assumed_state
|
|
|
|
@esphome_state_property
|
|
def is_closed(self) -> bool | None:
|
|
"""Return if the cover is closed or not."""
|
|
# Check closed state with api version due to a protocol change
|
|
return self._state.is_closed(self._api_version)
|
|
|
|
@esphome_state_property
|
|
def is_opening(self) -> bool:
|
|
"""Return if the cover is opening or not."""
|
|
return self._state.current_operation == CoverOperation.IS_OPENING
|
|
|
|
@esphome_state_property
|
|
def is_closing(self) -> bool:
|
|
"""Return if the cover is closing or not."""
|
|
return self._state.current_operation == CoverOperation.IS_CLOSING
|
|
|
|
@esphome_state_property
|
|
def current_cover_position(self) -> int | None:
|
|
"""Return current position of cover. 0 is closed, 100 is open."""
|
|
if not self._static_info.supports_position:
|
|
return None
|
|
return round(self._state.position * 100.0)
|
|
|
|
@esphome_state_property
|
|
def current_cover_tilt_position(self) -> int | None:
|
|
"""Return current position of cover tilt. 0 is closed, 100 is open."""
|
|
if not self._static_info.supports_tilt:
|
|
return None
|
|
return round(self._state.tilt * 100.0)
|
|
|
|
async def async_open_cover(self, **kwargs: Any) -> None:
|
|
"""Open the cover."""
|
|
await self._client.cover_command(key=self._static_info.key, position=1.0)
|
|
|
|
async def async_close_cover(self, **kwargs: Any) -> None:
|
|
"""Close cover."""
|
|
await self._client.cover_command(key=self._static_info.key, position=0.0)
|
|
|
|
async def async_stop_cover(self, **kwargs: Any) -> None:
|
|
"""Stop the cover."""
|
|
await self._client.cover_command(key=self._static_info.key, stop=True)
|
|
|
|
async def async_set_cover_position(self, **kwargs: int) -> None:
|
|
"""Move the cover to a specific position."""
|
|
await self._client.cover_command(
|
|
key=self._static_info.key, position=kwargs[ATTR_POSITION] / 100
|
|
)
|
|
|
|
async def async_open_cover_tilt(self, **kwargs: Any) -> None:
|
|
"""Open the cover tilt."""
|
|
await self._client.cover_command(key=self._static_info.key, tilt=1.0)
|
|
|
|
async def async_close_cover_tilt(self, **kwargs: Any) -> None:
|
|
"""Close the cover tilt."""
|
|
await self._client.cover_command(key=self._static_info.key, tilt=0.0)
|
|
|
|
async def async_set_cover_tilt_position(self, **kwargs: int) -> None:
|
|
"""Move the cover tilt to a specific position."""
|
|
await self._client.cover_command(
|
|
key=self._static_info.key, tilt=kwargs[ATTR_TILT_POSITION] / 100
|
|
)
|