core/homeassistant/components/peco/sensor.py

106 lines
3.0 KiB
Python

"""Sensor component for PECO outage counter."""
from __future__ import annotations
from collections.abc import Callable
from dataclasses import dataclass
from typing import Final
from peco import OutageResults
from homeassistant.components.sensor import (
SensorEntity,
SensorEntityDescription,
SensorStateClass,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import PERCENTAGE
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.update_coordinator import (
CoordinatorEntity,
DataUpdateCoordinator,
)
from .const import CONF_COUNTY, DOMAIN
@dataclass
class PECOSensorEntityDescriptionMixin:
"""Mixin for required keys."""
value_fn: Callable[[OutageResults], int]
@dataclass
class PECOSensorEntityDescription(
SensorEntityDescription, PECOSensorEntityDescriptionMixin
):
"""Description for PECO sensor."""
PARALLEL_UPDATES: Final = 0
SENSOR_LIST: tuple[PECOSensorEntityDescription, ...] = (
PECOSensorEntityDescription(
key="customers_out",
name="Customers Out",
value_fn=lambda data: int(data.customers_out),
),
PECOSensorEntityDescription(
key="percent_customers_out",
name="Percent Customers Out",
native_unit_of_measurement=PERCENTAGE,
value_fn=lambda data: int(data.percent_customers_out),
),
PECOSensorEntityDescription(
key="outage_count",
name="Outage Count",
value_fn=lambda data: int(data.outage_count),
),
PECOSensorEntityDescription(
key="customers_served",
name="Customers Served",
value_fn=lambda data: int(data.customers_served),
),
)
async def async_setup_entry(
hass: HomeAssistant,
config_entry: ConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up the sensor platform."""
county: str = config_entry.data[CONF_COUNTY]
coordinator = hass.data[DOMAIN][config_entry.entry_id]
async_add_entities(
[PecoSensor(sensor, county, coordinator) for sensor in SENSOR_LIST],
True,
)
return
class PecoSensor(CoordinatorEntity[DataUpdateCoordinator[OutageResults]], SensorEntity):
"""PECO outage counter sensor."""
_attr_state_class = SensorStateClass.MEASUREMENT
_attr_icon: str = "mdi:power-plug-off"
entity_description: PECOSensorEntityDescription
def __init__(
self,
description: PECOSensorEntityDescription,
county: str,
coordinator: DataUpdateCoordinator[OutageResults],
) -> None:
"""Initialize the sensor."""
super().__init__(coordinator)
self._attr_name = f"{county.capitalize()} {description.name}"
self._attr_unique_id = f"{county}-{description.key}"
self.entity_description = description
@property
def native_value(self) -> int:
"""Return the value of the sensor."""
return self.entity_description.value_fn(self.coordinator.data)