"""Support for voltage, power & energy sensors for VeSync outlets.""" from __future__ import annotations from collections.abc import Callable from dataclasses import dataclass import logging from pyvesync.base_devices.vesyncbasedevice import VeSyncBaseDevice from homeassistant.components.sensor import ( SensorDeviceClass, SensorEntity, SensorEntityDescription, SensorStateClass, ) from homeassistant.config_entries import ConfigEntry from homeassistant.const import ( CONCENTRATION_MICROGRAMS_PER_CUBIC_METER, PERCENTAGE, EntityCategory, UnitOfElectricPotential, UnitOfEnergy, UnitOfPower, ) from homeassistant.core import HomeAssistant, callback from homeassistant.helpers.dispatcher import async_dispatcher_connect from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback from homeassistant.helpers.typing import StateType from .common import is_humidifier, is_outlet, rgetattr from .const import DOMAIN, VS_COORDINATOR, VS_DEVICES, VS_DISCOVERY, VS_MANAGER from .coordinator import VeSyncDataCoordinator from .entity import VeSyncBaseEntity _LOGGER = logging.getLogger(__name__) @dataclass(frozen=True, kw_only=True) class VeSyncSensorEntityDescription(SensorEntityDescription): """Describe VeSync sensor entity.""" value_fn: Callable[[VeSyncBaseDevice], StateType] exists_fn: Callable[[VeSyncBaseDevice], bool] SENSORS: tuple[VeSyncSensorEntityDescription, ...] = ( VeSyncSensorEntityDescription( key="filter-life", translation_key="filter_life", native_unit_of_measurement=PERCENTAGE, state_class=SensorStateClass.MEASUREMENT, entity_category=EntityCategory.DIAGNOSTIC, value_fn=lambda device: device.state.filter_life, exists_fn=lambda device: rgetattr(device, "state.filter_life") is not None, ), VeSyncSensorEntityDescription( key="air-quality", translation_key="air_quality", value_fn=lambda device: device.state.air_quality_string, exists_fn=( lambda device: rgetattr(device, "state.air_quality_string") is not None ), ), VeSyncSensorEntityDescription( key="pm25", device_class=SensorDeviceClass.PM25, native_unit_of_measurement=CONCENTRATION_MICROGRAMS_PER_CUBIC_METER, state_class=SensorStateClass.MEASUREMENT, value_fn=lambda device: device.state.pm25, exists_fn=lambda device: rgetattr(device, "state.pm25") is not None, ), VeSyncSensorEntityDescription( key="power", translation_key="current_power", device_class=SensorDeviceClass.POWER, native_unit_of_measurement=UnitOfPower.WATT, state_class=SensorStateClass.MEASUREMENT, value_fn=lambda device: device.state.power, exists_fn=is_outlet, ), VeSyncSensorEntityDescription( key="energy", translation_key="energy_today", device_class=SensorDeviceClass.ENERGY, native_unit_of_measurement=UnitOfEnergy.KILO_WATT_HOUR, state_class=SensorStateClass.TOTAL_INCREASING, value_fn=lambda device: device.state.energy, exists_fn=is_outlet, ), VeSyncSensorEntityDescription( key="energy-weekly", translation_key="energy_week", device_class=SensorDeviceClass.ENERGY, native_unit_of_measurement=UnitOfEnergy.KILO_WATT_HOUR, state_class=SensorStateClass.TOTAL_INCREASING, value_fn=lambda device: getattr( device.state.weekly_history, "totalEnergy", None ), exists_fn=is_outlet, ), VeSyncSensorEntityDescription( key="energy-monthly", translation_key="energy_month", device_class=SensorDeviceClass.ENERGY, native_unit_of_measurement=UnitOfEnergy.KILO_WATT_HOUR, state_class=SensorStateClass.TOTAL_INCREASING, value_fn=lambda device: getattr( device.state.monthly_history, "totalEnergy", None ), exists_fn=is_outlet, ), VeSyncSensorEntityDescription( key="energy-yearly", translation_key="energy_year", device_class=SensorDeviceClass.ENERGY, native_unit_of_measurement=UnitOfEnergy.KILO_WATT_HOUR, state_class=SensorStateClass.TOTAL_INCREASING, value_fn=lambda device: getattr( device.state.yearly_history, "totalEnergy", None ), exists_fn=is_outlet, ), VeSyncSensorEntityDescription( key="voltage", translation_key="current_voltage", device_class=SensorDeviceClass.VOLTAGE, native_unit_of_measurement=UnitOfElectricPotential.VOLT, state_class=SensorStateClass.MEASUREMENT, value_fn=lambda device: device.state.voltage, exists_fn=is_outlet, ), VeSyncSensorEntityDescription( key="humidity", device_class=SensorDeviceClass.HUMIDITY, native_unit_of_measurement=PERCENTAGE, state_class=SensorStateClass.MEASUREMENT, value_fn=lambda device: device.state.humidity, exists_fn=is_humidifier, ), ) async def async_setup_entry( hass: HomeAssistant, config_entry: ConfigEntry, async_add_entities: AddConfigEntryEntitiesCallback, ) -> None: """Set up switches.""" coordinator = hass.data[DOMAIN][VS_COORDINATOR] @callback def discover(devices): """Add new devices to platform.""" _setup_entities(devices, async_add_entities, coordinator) config_entry.async_on_unload( async_dispatcher_connect(hass, VS_DISCOVERY.format(VS_DEVICES), discover) ) _setup_entities( hass.data[DOMAIN][VS_MANAGER].devices, async_add_entities, coordinator ) @callback def _setup_entities( devices: list[VeSyncBaseDevice], async_add_entities: AddConfigEntryEntitiesCallback, coordinator: VeSyncDataCoordinator, ): """Check if device is online and add entity.""" async_add_entities( ( VeSyncSensorEntity(dev, description, coordinator) for dev in devices for description in SENSORS if description.exists_fn(dev) ), update_before_add=True, ) class VeSyncSensorEntity(VeSyncBaseEntity, SensorEntity): """Representation of a sensor describing a VeSync device.""" entity_description: VeSyncSensorEntityDescription def __init__( self, device: VeSyncBaseDevice, description: VeSyncSensorEntityDescription, coordinator: VeSyncDataCoordinator, ) -> None: """Initialize the VeSync outlet device.""" super().__init__(device, coordinator) self.entity_description = description self._attr_unique_id = f"{super().unique_id}-{description.key}" @property def native_value(self) -> StateType: """Return the state of the sensor.""" return self.entity_description.value_fn(self.device)