text.py

Go to the documentation of this file.

"""Support for esphome texts."""
 
from __future__ import annotations
 
from functools import partial
 
from aioesphomeapi import EntityInfo, TextInfo, TextMode as EsphomeTextMode, TextState
 
from homeassistant.components.text import TextEntity, TextMode
from homeassistant.core import callback
 
from .entity import (
    EsphomeEntity,
    convert_api_error_ha_error,
    esphome_state_property,
    platform_async_setup_entry,
)
from .enum_mapper import EsphomeEnumMapper
 
TEXT_MODES: EsphomeEnumMapper[EsphomeTextMode, TextMode] = EsphomeEnumMapper(
    {
        EsphomeTextMode.TEXT: TextMode.TEXT,
        EsphomeTextMode.PASSWORD: TextMode.PASSWORD,
    }
)
 
 
class EsphomeText(EsphomeEntity[TextInfo, TextState], TextEntity):
    """A text 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
        self._attr_native_min_attr_native_min = static_info.min_length
        self._attr_native_max_attr_native_max = static_info.max_length
        self._attr_pattern_attr_pattern = static_info.pattern
        self._attr_mode_attr_mode = TEXT_MODES.from_esphome(static_info.mode) or TextMode.TEXT
 
    @property
    @esphome_state_property
    def native_value(self) -> str | None:
        """Return the state of the entity."""
        state = self._state_state
        return None if state.missing_state else state.state
 
    @convert_api_error_ha_error
    async def async_set_value(self, value: str) -> None:
        """Update the current value."""
        self._client_client.text_command(self._key_key, value)
 
 
async_setup_entry = partial(
    platform_async_setup_entry,
    info_type=TextInfo,
    entity_type=EsphomeText,
    state_type=TextState,
)