"""Support for TPLink Omada binary sensors.""" from __future__ import annotations from collections.abc import Callable from dataclasses import dataclass from tplink_omada_client.definitions import DeviceStatus, DeviceStatusCategory from tplink_omada_client.devices import OmadaListDevice from homeassistant.components.sensor import ( SensorDeviceClass, SensorEntity, SensorEntityDescription, SensorStateClass, ) from homeassistant.const import PERCENTAGE, EntityCategory from homeassistant.core import HomeAssistant from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback from homeassistant.helpers.typing import StateType from . import OmadaConfigEntry from .const import OmadaDeviceStatus from .coordinator import OmadaDevicesCoordinator from .entity import OmadaDeviceEntity # Useful low level status categories, mapped to a more descriptive status. DEVICE_STATUS_MAP = { DeviceStatus.PROVISIONING: OmadaDeviceStatus.PENDING, DeviceStatus.CONFIGURING: OmadaDeviceStatus.PENDING, DeviceStatus.UPGRADING: OmadaDeviceStatus.PENDING, DeviceStatus.REBOOTING: OmadaDeviceStatus.PENDING, DeviceStatus.ADOPT_FAILED: OmadaDeviceStatus.ADOPT_FAILED, DeviceStatus.ADOPT_FAILED_WIRELESS: OmadaDeviceStatus.ADOPT_FAILED, DeviceStatus.MANAGED_EXTERNALLY: OmadaDeviceStatus.MANAGED_EXTERNALLY, DeviceStatus.MANAGED_EXTERNALLY_WIRELESS: OmadaDeviceStatus.MANAGED_EXTERNALLY, } # High level status categories, suitable for most device statuses. DEVICE_STATUS_CATEGORY_MAP = { DeviceStatusCategory.DISCONNECTED: OmadaDeviceStatus.DISCONNECTED, DeviceStatusCategory.CONNECTED: OmadaDeviceStatus.CONNECTED, DeviceStatusCategory.PENDING: OmadaDeviceStatus.PENDING, DeviceStatusCategory.HEARTBEAT_MISSED: OmadaDeviceStatus.HEARTBEAT_MISSED, DeviceStatusCategory.ISOLATED: OmadaDeviceStatus.ISOLATED, } def _map_device_status(device: OmadaListDevice) -> str | None: """Map the API device status to the best available descriptive device status.""" display_status = DEVICE_STATUS_MAP.get( device.status ) or DEVICE_STATUS_CATEGORY_MAP.get(device.status_category) return display_status.value if display_status else None async def async_setup_entry( hass: HomeAssistant, config_entry: OmadaConfigEntry, async_add_entities: AddConfigEntryEntitiesCallback, ) -> None: """Set up sensors.""" controller = config_entry.runtime_data devices_coordinator = controller.devices_coordinator async_add_entities( OmadaDeviceSensor(devices_coordinator, device, desc) for device in devices_coordinator.data.values() for desc in OMADA_DEVICE_SENSORS if desc.exists_func(device) ) @dataclass(frozen=True, kw_only=True) class OmadaDeviceSensorEntityDescription(SensorEntityDescription): """Entity description for a status derived from an Omada device in the device list.""" exists_func: Callable[[OmadaListDevice], bool] = lambda _: True update_func: Callable[[OmadaListDevice], StateType] OMADA_DEVICE_SENSORS: list[OmadaDeviceSensorEntityDescription] = [ OmadaDeviceSensorEntityDescription( key="device_status", translation_key="device_status", device_class=SensorDeviceClass.ENUM, entity_category=EntityCategory.DIAGNOSTIC, update_func=_map_device_status, options=[v.value for v in OmadaDeviceStatus], ), OmadaDeviceSensorEntityDescription( key="cpu_usage", translation_key="cpu_usage", entity_category=EntityCategory.DIAGNOSTIC, state_class=SensorStateClass.MEASUREMENT, native_unit_of_measurement=PERCENTAGE, update_func=lambda device: device.cpu_usage, ), OmadaDeviceSensorEntityDescription( key="mem_usage", translation_key="mem_usage", entity_category=EntityCategory.DIAGNOSTIC, state_class=SensorStateClass.MEASUREMENT, native_unit_of_measurement=PERCENTAGE, update_func=lambda device: device.mem_usage, ), ] class OmadaDeviceSensor(OmadaDeviceEntity[OmadaDevicesCoordinator], SensorEntity): """Sensor for property of a generic Omada device.""" entity_description: OmadaDeviceSensorEntityDescription def __init__( self, coordinator: OmadaDevicesCoordinator, device: OmadaListDevice, entity_description: OmadaDeviceSensorEntityDescription, ) -> None: """Initialize the device sensor.""" super().__init__(coordinator, device) self.entity_description = entity_description self._attr_unique_id = f"{device.mac}_{entity_description.key}" @property def native_value(self) -> StateType: """Return the state of the sensor.""" return self.entity_description.update_func( self.coordinator.data[self.device.mac] )