omni-pca/custom_components/omni_pca/sensor.py

"""Sensor platform — analog zones, thermostat readings, panel telemetry.

We deliberately re-expose thermostat current_temperature / humidity as
diagnostic sensors (in addition to the climate entity) so users can
plot history. The climate entity remains the canonical control surface.
"""

from __future__ import annotations

from typing import TYPE_CHECKING, Any

from homeassistant.components.sensor import (
    SensorDeviceClass,
    SensorEntity,
    SensorStateClass,
)
from homeassistant.const import PERCENTAGE, UnitOfTemperature
from homeassistant.helpers.entity import EntityCategory
from homeassistant.helpers.update_coordinator import CoordinatorEntity

from .const import DOMAIN
from .coordinator import OmniDataUpdateCoordinator
from .helpers import (
    SENSOR_DEVICE_CLASS_HUMIDITY,
    SENSOR_DEVICE_CLASS_TEMPERATURE,
    analog_zone_device_class,
    is_binary_zone_type,
    prettify_name,
)

if TYPE_CHECKING:
    from homeassistant.config_entries import ConfigEntry
    from homeassistant.core import HomeAssistant
    from homeassistant.helpers.entity_platform import AddEntitiesCallback


_DEVICE_CLASS_STR_TO_ENUM: dict[str, SensorDeviceClass] = {
    SENSOR_DEVICE_CLASS_TEMPERATURE: SensorDeviceClass.TEMPERATURE,
    SENSOR_DEVICE_CLASS_HUMIDITY: SensorDeviceClass.HUMIDITY,
    "power": SensorDeviceClass.POWER,
}


async def async_setup_entry(
    hass: HomeAssistant,
    entry: ConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    coordinator: OmniDataUpdateCoordinator = hass.data[DOMAIN][entry.entry_id]
    entities: list[SensorEntity] = []

    # Analog zones (temperature / humidity / energy)
    for index in sorted(coordinator.data.zones):
        props = coordinator.data.zones[index]
        if is_binary_zone_type(props.zone_type):
            continue
        device_class_str = analog_zone_device_class(props.zone_type)
        if device_class_str is None:
            continue
        entities.append(
            OmniAnalogZoneSensor(coordinator, index, device_class_str)
        )

    # Per-thermostat diagnostic sensors
    for index in sorted(coordinator.data.thermostats):
        entities.append(OmniThermostatTempSensor(coordinator, index))
        entities.append(OmniThermostatHumiditySensor(coordinator, index))
        entities.append(OmniThermostatOutdoorTempSensor(coordinator, index))

    entities.append(OmniSystemModelSensor(coordinator))
    entities.append(OmniLastEventSensor(coordinator))

    async_add_entities(entities)


# --------------------------------------------------------------------------
# Analog zones
# --------------------------------------------------------------------------


class OmniAnalogZoneSensor(
    CoordinatorEntity[OmniDataUpdateCoordinator], SensorEntity
):
    _attr_has_entity_name = True
    _attr_state_class = SensorStateClass.MEASUREMENT

    def __init__(
        self,
        coordinator: OmniDataUpdateCoordinator,
        index: int,
        device_class_str: str,
    ) -> None:
        super().__init__(coordinator)
        self._index = index
        self._attr_unique_id = f"{coordinator.unique_id}-zone-{index}-analog"
        props = coordinator.data.zones[index]
        self._attr_name = prettify_name(props.name) or f"Zone {index}"
        self._attr_device_info = coordinator.device_info
        self._attr_device_class = _DEVICE_CLASS_STR_TO_ENUM.get(device_class_str)
        if device_class_str == SENSOR_DEVICE_CLASS_TEMPERATURE:
            self._attr_native_unit_of_measurement = UnitOfTemperature.FAHRENHEIT
        elif device_class_str == SENSOR_DEVICE_CLASS_HUMIDITY:
            self._attr_native_unit_of_measurement = PERCENTAGE

    @property
    def native_value(self) -> float | int | None:
        status = self.coordinator.data.zone_status.get(self._index)
        if status is None:
            return None
        # Reuse the linear temp formula for temperature zones; humidity
        # zones report the loop byte as the percentage directly.
        if self._attr_device_class == SensorDeviceClass.TEMPERATURE:
            return round(status.loop * 9 / 10) - 40
        return status.loop


# --------------------------------------------------------------------------
# Thermostat diagnostic sensors
# --------------------------------------------------------------------------


class _ThermostatBase(CoordinatorEntity[OmniDataUpdateCoordinator], SensorEntity):
    _attr_has_entity_name = True
    _attr_entity_category = EntityCategory.DIAGNOSTIC
    _attr_state_class = SensorStateClass.MEASUREMENT

    def __init__(
        self, coordinator: OmniDataUpdateCoordinator, index: int
    ) -> None:
        super().__init__(coordinator)
        self._index = index
        self._attr_device_info = coordinator.device_info

    @property
    def _status(self):  # type: ignore[no-untyped-def]
        return self.coordinator.data.thermostat_status.get(self._index)


class OmniThermostatTempSensor(_ThermostatBase):
    _attr_device_class = SensorDeviceClass.TEMPERATURE
    _attr_native_unit_of_measurement = UnitOfTemperature.FAHRENHEIT

    def __init__(
        self, coordinator: OmniDataUpdateCoordinator, index: int
    ) -> None:
        super().__init__(coordinator, index)
        self._attr_unique_id = f"{coordinator.unique_id}-thermostat-{index}-temp"
        props = coordinator.data.thermostats[index]
        base = prettify_name(props.name) or f"Thermostat {index}"
        self._attr_name = f"{base} Temperature"

    @property
    def native_value(self) -> float | None:
        s = self._status
        if s is None or s.temperature_raw == 0:
            return None
        return round(s.temperature_f, 1)


class OmniThermostatHumiditySensor(_ThermostatBase):
    _attr_device_class = SensorDeviceClass.HUMIDITY
    _attr_native_unit_of_measurement = PERCENTAGE

    def __init__(
        self, coordinator: OmniDataUpdateCoordinator, index: int
    ) -> None:
        super().__init__(coordinator, index)
        self._attr_unique_id = f"{coordinator.unique_id}-thermostat-{index}-humidity"
        props = coordinator.data.thermostats[index]
        base = prettify_name(props.name) or f"Thermostat {index}"
        self._attr_name = f"{base} Humidity"

    @property
    def native_value(self) -> int | None:
        s = self._status
        if s is None or s.humidity_raw == 0:
            return None
        return int(s.humidity_raw)


class OmniThermostatOutdoorTempSensor(_ThermostatBase):
    _attr_device_class = SensorDeviceClass.TEMPERATURE
    _attr_native_unit_of_measurement = UnitOfTemperature.FAHRENHEIT

    def __init__(
        self, coordinator: OmniDataUpdateCoordinator, index: int
    ) -> None:
        super().__init__(coordinator, index)
        self._attr_unique_id = f"{coordinator.unique_id}-thermostat-{index}-outdoor"
        props = coordinator.data.thermostats[index]
        base = prettify_name(props.name) or f"Thermostat {index}"
        self._attr_name = f"{base} Outdoor Temperature"

    @property
    def native_value(self) -> float | None:
        s = self._status
        if s is None or s.outdoor_temperature_raw == 0:
            return None
        return round(s.outdoor_temperature_f, 1)


# --------------------------------------------------------------------------
# Panel telemetry
# --------------------------------------------------------------------------


class OmniSystemModelSensor(
    CoordinatorEntity[OmniDataUpdateCoordinator], SensorEntity
):
    """Static text sensor: model + firmware. Helps confirm the integration
    talked to the panel without needing to dig into Devices & Services."""

    _attr_has_entity_name = True
    _attr_entity_category = EntityCategory.DIAGNOSTIC

    def __init__(self, coordinator: OmniDataUpdateCoordinator) -> None:
        super().__init__(coordinator)
        self._attr_unique_id = f"{coordinator.unique_id}-system-model"
        self._attr_name = "Panel Model"
        self._attr_device_info = coordinator.device_info

    @property
    def native_value(self) -> str | None:
        info = self.coordinator.data.system_info
        if info is None:
            return None
        return f"{info.model_name} {info.firmware_version}"


class OmniLastEventSensor(
    CoordinatorEntity[OmniDataUpdateCoordinator], SensorEntity
):
    """Diagnostic text sensor showing the most recent push event class name."""

    _attr_has_entity_name = True
    _attr_entity_category = EntityCategory.DIAGNOSTIC

    def __init__(self, coordinator: OmniDataUpdateCoordinator) -> None:
        super().__init__(coordinator)
        self._attr_unique_id = f"{coordinator.unique_id}-last-event"
        self._attr_name = "Last Panel Event"
        self._attr_device_info = coordinator.device_info

    @property
    def native_value(self) -> str | None:
        ev = self.coordinator.data.last_event
        if ev is None:
            return None
        return type(ev).__name__

    @property
    def extra_state_attributes(self) -> dict[str, Any] | None:
        ev = self.coordinator.data.last_event
        if ev is None:
            return None
        result: dict[str, Any] = {"event_class": type(ev).__name__}
        for key in (
            "zone_index", "unit_index", "area_index", "user_index",
            "new_state", "new_mode", "alarm_type",
        ):
            if hasattr(ev, key):
                result[key] = getattr(ev, key)
        return result