valve.py

Go to the documentation of this file.

"""Support for ESPHome valves."""
 
from __future__ import annotations
 
from functools import partial
from typing import Any
 
from aioesphomeapi import EntityInfo, ValveInfo, ValveOperation, ValveState
 
from homeassistant.components.valve import (
    ValveDeviceClass,
    ValveEntity,
    ValveEntityFeature,
)
from homeassistant.core import callback
from homeassistant.util.enum import try_parse_enum
 
from .entity import (
    EsphomeEntity,
    convert_api_error_ha_error,
    esphome_state_property,
    platform_async_setup_entry,
)
 
 
class EsphomeValve(EsphomeEntity[ValveInfo, ValveState], ValveEntity):
    """A valve implementation for ESPHome."""
 
    @callback
    def _on_static_info_update(self, static_info: EntityInfo) -> None:
        """Set attrs from static info."""
        super()._on_static_info_update(static_info)
        static_info = self._static_info_static_info
        flags = ValveEntityFeature.OPEN | ValveEntityFeature.CLOSE
        if static_info.supports_stop:
            flags |= ValveEntityFeature.STOP
        if static_info.supports_position:
            flags |= ValveEntityFeature.SET_POSITION
        self._attr_supported_features_attr_supported_features = flags
        self._attr_device_class_attr_device_class = try_parse_enum(
            ValveDeviceClass, static_info.device_class
        )
        self._attr_assumed_state_attr_assumed_state = static_info.assumed_state
        self._attr_reports_position_attr_reports_position = static_info.supports_position
 
    @property
    @esphome_state_property
    def is_closed(self) -> bool:
        """Return if the valve is closed or not."""
        return self._state_state.position == 0.0
 
    @property
    @esphome_state_property
    def is_opening(self) -> bool:
        """Return if the valve is opening or not."""
        return self._state_state.current_operation is ValveOperation.IS_OPENING
 
    @property
    @esphome_state_property
    def is_closing(self) -> bool:
        """Return if the valve is closing or not."""
        return self._state_state.current_operation is ValveOperation.IS_CLOSING
 
    @property
    @esphome_state_property
    def current_valve_position(self) -> int | None:
        """Return current position of valve. 0 is closed, 100 is open."""
        return round(self._state_state.position * 100.0)
 
    @convert_api_error_ha_error
    async def async_open_valve(self, **kwargs: Any) -> None:
        """Open the valve."""
        self._client_client.valve_command(key=self._key_key, position=1.0)
 
    @convert_api_error_ha_error
    async def async_close_valve(self, **kwargs: Any) -> None:
        """Close valve."""
        self._client_client.valve_command(key=self._key_key, position=0.0)
 
    @convert_api_error_ha_error
    async def async_stop_valve(self, **kwargs: Any) -> None:
        """Stop the valve."""
        self._client_client.valve_command(key=self._key_key, stop=True)
 
    @convert_api_error_ha_error
    async def async_set_valve_position(self, position: float) -> None:
        """Move the valve to a specific position."""
        self._client_client.valve_command(key=self._key_key, position=position / 100)
 
 
async_setup_entry = partial(
    platform_async_setup_entry,
    info_type=ValveInfo,
    entity_type=EsphomeValve,
    state_type=ValveState,
)