128 lines
3.9 KiB
Python
128 lines
3.9 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 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 . import PECOCoordinatorData
|
|
from .const import ATTR_CONTENT, CONF_COUNTY, DOMAIN
|
|
|
|
|
|
@dataclass
|
|
class PECOSensorEntityDescriptionMixin:
|
|
"""Mixin for required keys."""
|
|
|
|
value_fn: Callable[[PECOCoordinatorData], int | str]
|
|
attribute_fn: Callable[[PECOCoordinatorData], dict[str, str]]
|
|
|
|
|
|
@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.outages.customers_out),
|
|
attribute_fn=lambda data: {},
|
|
icon="mdi:power-plug-off",
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
PECOSensorEntityDescription(
|
|
key="percent_customers_out",
|
|
name="Percent Customers Out",
|
|
native_unit_of_measurement=PERCENTAGE,
|
|
value_fn=lambda data: int(data.outages.percent_customers_out),
|
|
attribute_fn=lambda data: {},
|
|
icon="mdi:power-plug-off",
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
PECOSensorEntityDescription(
|
|
key="outage_count",
|
|
name="Outage Count",
|
|
value_fn=lambda data: int(data.outages.outage_count),
|
|
attribute_fn=lambda data: {},
|
|
icon="mdi:power-plug-off",
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
PECOSensorEntityDescription(
|
|
key="customers_served",
|
|
name="Customers Served",
|
|
value_fn=lambda data: int(data.outages.customers_served),
|
|
attribute_fn=lambda data: {},
|
|
icon="mdi:power-plug-off",
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
PECOSensorEntityDescription(
|
|
key="map_alert",
|
|
name="Map Alert",
|
|
value_fn=lambda data: str(data.alerts.alert_title),
|
|
attribute_fn=lambda data: {ATTR_CONTENT: data.alerts.alert_content},
|
|
icon="mdi:alert",
|
|
),
|
|
)
|
|
|
|
|
|
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
|
|
)
|
|
|
|
|
|
class PecoSensor(
|
|
CoordinatorEntity[DataUpdateCoordinator[PECOCoordinatorData]], SensorEntity
|
|
):
|
|
"""PECO outage counter sensor."""
|
|
|
|
entity_description: PECOSensorEntityDescription
|
|
|
|
def __init__(
|
|
self,
|
|
description: PECOSensorEntityDescription,
|
|
county: str,
|
|
coordinator: DataUpdateCoordinator[PECOCoordinatorData],
|
|
) -> 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 | str:
|
|
"""Return the value of the sensor."""
|
|
return self.entity_description.value_fn(self.coordinator.data)
|
|
|
|
@property
|
|
def extra_state_attributes(self) -> dict[str, str]:
|
|
"""Return state attributes for the sensor."""
|
|
return self.entity_description.attribute_fn(self.coordinator.data)
|