sensor.py

Go to the documentation of this file.

"""Platform for sensor integration."""
 
from __future__ import annotations
 
from homeassistant.components.sensor import (
    SensorDeviceClass,
    SensorEntity,
    SensorEntityDescription,
    SensorStateClass,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import (
    CONCENTRATION_PARTS_PER_MILLION,
    PERCENTAGE,
    UnitOfElectricPotential,
    UnitOfTemperature,
)
from homeassistant.core import HomeAssistant
from homeassistant.helpers.device_registry import DeviceInfo
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.typing import StateType
from homeassistant.helpers.update_coordinator import CoordinatorEntity
 
from .const import DOMAIN
from .coordinator import OndiloIcoCoordinator, OndiloIcoData
 
SENSOR_TYPES: tuple[SensorEntityDescription, ...] = (
    SensorEntityDescription(
        key="temperature",
        native_unit_of_measurement=UnitOfTemperature.CELSIUS,
        device_class=SensorDeviceClass.TEMPERATURE,
        state_class=SensorStateClass.MEASUREMENT,
    ),
    SensorEntityDescription(
        key="orp",
        translation_key="oxydo_reduction_potential",
        native_unit_of_measurement=UnitOfElectricPotential.MILLIVOLT,
        state_class=SensorStateClass.MEASUREMENT,
    ),
    SensorEntityDescription(
        key="ph",
        device_class=SensorDeviceClass.PH,
        state_class=SensorStateClass.MEASUREMENT,
    ),
    SensorEntityDescription(
        key="tds",
        translation_key="tds",
        native_unit_of_measurement=CONCENTRATION_PARTS_PER_MILLION,
        state_class=SensorStateClass.MEASUREMENT,
    ),
    SensorEntityDescription(
        key="battery",
        native_unit_of_measurement=PERCENTAGE,
        device_class=SensorDeviceClass.BATTERY,
        state_class=SensorStateClass.MEASUREMENT,
    ),
    SensorEntityDescription(
        key="rssi",
        translation_key="rssi",
        native_unit_of_measurement=PERCENTAGE,
        state_class=SensorStateClass.MEASUREMENT,
    ),
    SensorEntityDescription(
        key="salt",
        translation_key="salt",
        native_unit_of_measurement="mg/L",
        state_class=SensorStateClass.MEASUREMENT,
    ),
)
 
 
async def async_setup_entry(
    hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
) -> None:
    """Set up the Ondilo ICO sensors."""
 
    coordinator: OndiloIcoCoordinator = hass.data[DOMAIN][entry.entry_id]
 
    async_add_entities(
        OndiloICO(coordinator, pool_id, description)
        for pool_id, pool in coordinator.data.items()
        for description in SENSOR_TYPES
        if description.key in pool.sensors
    )
 
 
class OndiloICO(CoordinatorEntity[OndiloIcoCoordinator], SensorEntity):
    """Representation of a Sensor."""
 
    _attr_has_entity_name = True
 
    def __init__(
        self,
        coordinator: OndiloIcoCoordinator,
        pool_id: str,
        description: SensorEntityDescription,
    ) -> None:
        """Initialize sensor entity with data from coordinator."""
        super().__init__(coordinator)
        self.entity_descriptionentity_description = description
 
        self._pool_id_pool_id = pool_id
 
        data = self.pool_datapool_data
        self._attr_unique_id_attr_unique_id = f"{data.ico['serial_number']}-{description.key}"
        self._attr_device_info_attr_device_info = DeviceInfo(
            identifiers={(DOMAIN, data.ico["serial_number"])},
            manufacturer="Ondilo",
            model="ICO",
            name=data.pool["name"],
            sw_version=data.ico["sw_version"],
        )
 
    @property
    def pool_data(self) -> OndiloIcoData:
        """Get pool data."""
        return self.coordinator.data[self._pool_id_pool_id]
 
    @property
    def native_value(self) -> StateType:
        """Last value of the sensor."""
        return self.pool_datapool_data.sensors[self.entity_descriptionentity_description.key]