number.py

Go to the documentation of this file.

"""Support for esphome numbers."""
 
from __future__ import annotations
 
from functools import partial
 
from aioesphomeapi import (
    EntityInfo,
    NumberInfo,
    NumberMode as EsphomeNumberMode,
    NumberState,
)
 
from homeassistant.components.number import NumberDeviceClass, NumberEntity, NumberMode
from homeassistant.core import callback
from homeassistant.util.enum import try_parse_enum
 
from .entity import (
    EsphomeEntity,
    convert_api_error_ha_error,
    esphome_float_state_property,
    platform_async_setup_entry,
)
from .enum_mapper import EsphomeEnumMapper
 
NUMBER_MODES: EsphomeEnumMapper[EsphomeNumberMode, NumberMode] = EsphomeEnumMapper(
    {
        EsphomeNumberMode.AUTO: NumberMode.AUTO,
        EsphomeNumberMode.BOX: NumberMode.BOX,
        EsphomeNumberMode.SLIDER: NumberMode.SLIDER,
    }
)
 
 
class EsphomeNumber(EsphomeEntity[NumberInfo, NumberState], NumberEntity):
    """A number 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_device_class_attr_device_class = try_parse_enum(
            NumberDeviceClass, static_info.device_class
        )
        self._attr_native_min_value_attr_native_min_value = static_info.min_value
        self._attr_native_max_value_attr_native_max_value = static_info.max_value
        self._attr_native_step_attr_native_step = static_info.step
        # protobuf doesn't support nullable strings so we need to check
        # if the string is empty
        if unit_of_measurement := static_info.unit_of_measurement:
            self._attr_native_unit_of_measurement_attr_native_unit_of_measurement = unit_of_measurement
        if mode := static_info.mode:
            self._attr_mode_attr_mode = NUMBER_MODES.from_esphome(mode)
        else:
            self._attr_mode_attr_mode = NumberMode.AUTO
 
    @property
    @esphome_float_state_property
    def native_value(self) -> float | 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_native_value(self, value: float) -> None:
        """Update the current value."""
        self._client_client.number_command(self._key_key, value)
 
 
async_setup_entry = partial(
    platform_async_setup_entry,
    info_type=NumberInfo,
    entity_type=EsphomeNumber,
    state_type=NumberState,
)