"""Support for esphome sensors.""" from __future__ import annotations import math from typing import cast from aioesphomeapi import ( SensorInfo, SensorState, SensorStateClass, TextSensorInfo, TextSensorState, ) from aioesphomeapi.model import LastResetType import voluptuous as vol from homeassistant.components.sensor import ( DEVICE_CLASS_TIMESTAMP, DEVICE_CLASSES, STATE_CLASS_MEASUREMENT, STATE_CLASS_TOTAL_INCREASING, SensorEntity, ) from homeassistant.config_entries import ConfigEntry from homeassistant.core import HomeAssistant import homeassistant.helpers.config_validation as cv from homeassistant.helpers.entity_platform import AddEntitiesCallback from homeassistant.util import dt from . import ( EsphomeEntity, EsphomeEnumMapper, esphome_state_property, platform_async_setup_entry, ) ICON_SCHEMA = vol.Schema(cv.icon) async def async_setup_entry( hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback ) -> None: """Set up esphome sensors based on a config entry.""" await platform_async_setup_entry( hass, entry, async_add_entities, component_key="sensor", info_type=SensorInfo, entity_type=EsphomeSensor, state_type=SensorState, ) await platform_async_setup_entry( hass, entry, async_add_entities, component_key="text_sensor", info_type=TextSensorInfo, entity_type=EsphomeTextSensor, state_type=TextSensorState, ) # https://github.com/PyCQA/pylint/issues/3150 for all @esphome_state_property # pylint: disable=invalid-overridden-method _STATE_CLASSES: EsphomeEnumMapper[SensorStateClass, str | None] = EsphomeEnumMapper( { SensorStateClass.NONE: None, SensorStateClass.MEASUREMENT: STATE_CLASS_MEASUREMENT, SensorStateClass.TOTAL_INCREASING: STATE_CLASS_TOTAL_INCREASING, } ) class EsphomeSensor(EsphomeEntity[SensorInfo, SensorState], SensorEntity): """A sensor implementation for esphome.""" @property def icon(self) -> str | None: """Return the icon.""" if not self._static_info.icon or self._static_info.device_class: return None return cast(str, ICON_SCHEMA(self._static_info.icon)) @property def force_update(self) -> bool: """Return if this sensor should force a state update.""" return self._static_info.force_update @esphome_state_property def native_value(self) -> str | None: """Return the state of the entity.""" if math.isnan(self._state.state): return None if self._state.missing_state: return None if self.device_class == DEVICE_CLASS_TIMESTAMP: return dt.utc_from_timestamp(self._state.state).isoformat() return f"{self._state.state:.{self._static_info.accuracy_decimals}f}" @property def native_unit_of_measurement(self) -> str | None: """Return the unit the value is expressed in.""" if not self._static_info.unit_of_measurement: return None return self._static_info.unit_of_measurement @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 state_class(self) -> str | None: """Return the state class of this entity.""" if not self._static_info.state_class: return None state_class = self._static_info.state_class reset_type = self._static_info.last_reset_type if ( state_class == SensorStateClass.MEASUREMENT and reset_type == LastResetType.AUTO ): # Legacy, last_reset_type auto was the equivalent to the TOTAL_INCREASING state class return STATE_CLASS_TOTAL_INCREASING return _STATE_CLASSES.from_esphome(self._static_info.state_class) class EsphomeTextSensor(EsphomeEntity[TextSensorInfo, TextSensorState], SensorEntity): """A text sensor implementation for ESPHome.""" @property def icon(self) -> str: """Return the icon.""" return self._static_info.icon @esphome_state_property def native_value(self) -> str | None: """Return the state of the entity.""" if self._state.missing_state: return None return self._state.state