150 lines
4.0 KiB
Python
150 lines
4.0 KiB
Python
"""Support for esphome sensors."""
|
|
from __future__ import annotations
|
|
|
|
import math
|
|
|
|
from aioesphomeapi import (
|
|
SensorInfo,
|
|
SensorState,
|
|
SensorStateClass,
|
|
TextSensorInfo,
|
|
TextSensorState,
|
|
)
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.sensor import (
|
|
DEVICE_CLASS_TIMESTAMP,
|
|
DEVICE_CLASSES,
|
|
STATE_CLASS_MEASUREMENT,
|
|
SensorEntity,
|
|
)
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.core import HomeAssistant
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.util import dt
|
|
|
|
from . import (
|
|
EsphomeEntity,
|
|
esphome_map_enum,
|
|
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
|
|
) -> 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
|
|
|
|
|
|
@esphome_map_enum
|
|
def _state_classes():
|
|
return {
|
|
SensorStateClass.NONE: None,
|
|
SensorStateClass.MEASUREMENT: STATE_CLASS_MEASUREMENT,
|
|
}
|
|
|
|
|
|
class EsphomeSensor(EsphomeEntity, SensorEntity):
|
|
"""A sensor implementation for esphome."""
|
|
|
|
@property
|
|
def _static_info(self) -> SensorInfo:
|
|
return super()._static_info
|
|
|
|
@property
|
|
def _state(self) -> SensorState | None:
|
|
return super()._state
|
|
|
|
@property
|
|
def icon(self) -> str:
|
|
"""Return the icon."""
|
|
if not self._static_info.icon or self._static_info.device_class:
|
|
return None
|
|
return 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 state(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 unit_of_measurement(self) -> str:
|
|
"""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:
|
|
"""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
|
|
return _state_classes.from_esphome(self._static_info.state_class)
|
|
|
|
|
|
class EsphomeTextSensor(EsphomeEntity, SensorEntity):
|
|
"""A text sensor implementation for ESPHome."""
|
|
|
|
@property
|
|
def _static_info(self) -> TextSensorInfo:
|
|
return super()._static_info
|
|
|
|
@property
|
|
def _state(self) -> TextSensorState | None:
|
|
return super()._state
|
|
|
|
@property
|
|
def icon(self) -> str:
|
|
"""Return the icon."""
|
|
return self._static_info.icon
|
|
|
|
@esphome_state_property
|
|
def state(self) -> str | None:
|
|
"""Return the state of the entity."""
|
|
if self._state.missing_state:
|
|
return None
|
|
return self._state.state
|