Add PECO power outage counter integration

CODEOWNERS

@@ -681,6 +681,8 @@ tests/components/panel_custom/* @home-assistant/frontend
 homeassistant/components/panel_iframe/* @home-assistant/frontend
 tests/components/panel_iframe/* @home-assistant/frontend
 homeassistant/components/pcal9535a/* @Shulyaka
+homeassistant/components/peco/* @IceBotYT
+tests/components/peco/* @IceBotYT
 homeassistant/components/persistent_notification/* @home-assistant/core
 tests/components/persistent_notification/* @home-assistant/core
 homeassistant/components/philips_js/* @elupus

homeassistant/components/peco/__init__.py

@@ -0,0 +1,43 @@
+"""The PECO Outage Counter integration."""
+from __future__ import annotations
+
+import peco
+
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.const import Platform
+from homeassistant.core import HomeAssistant
+from homeassistant.exceptions import HomeAssistantError
+from homeassistant.helpers.aiohttp_client import async_get_clientsession
+
+from .const import COUNTY_LIST, DOMAIN
+
+PLATFORMS: list[str] = [Platform.SENSOR]
+
+
+async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
+    """Set up PECO Outage Counter from a config entry."""
+
+    if entry.data["county"] not in COUNTY_LIST:
+        raise InvalidCountyError(f"{entry.data['county']} is not a valid county")
+
+    hass.data.setdefault(DOMAIN, {})
+    hass.data[DOMAIN][entry.entry_id] = {
+        "api": peco.PecoOutageApi(),
+        "websession": async_get_clientsession(hass),
+    }
+    hass.config_entries.async_setup_platforms(entry, PLATFORMS)
+
+    return True
+
+
+async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
+    """Unload a config entry."""
+    unload_ok = await hass.config_entries.async_unload_platforms(entry, PLATFORMS)
+    if unload_ok:
+        hass.data[DOMAIN].pop(entry.entry_id)
+
+    return unload_ok
+
+
+class InvalidCountyError(HomeAssistantError):
+    """Error to indicate an invalid county."""

homeassistant/components/peco/config_flow.py

@@ -0,0 +1,52 @@
+"""Config flow for PECO Outage Counter integration."""
+from __future__ import annotations
+
+from typing import Any
+
+import voluptuous as vol
+
+from homeassistant import config_entries
+from homeassistant.data_entry_flow import FlowResult
+
+from .const import COUNTY_LIST, DOMAIN
+
+STEP_USER_DATA_SCHEMA = vol.Schema(
+    {
+        vol.Required("county"): vol.In(COUNTY_LIST),
+    }
+)
+
+
+class ConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
+    """Handle a config flow for PECO Outage Counter."""
+
+    VERSION = 1
+
+    async def async_step_user(
+        self, user_input: dict[str, Any] | None = None
+    ) -> FlowResult:
+        """Handle the initial step."""
+        if user_input is None:
+            return self.async_show_form(
+                step_id="user", data_schema=STEP_USER_DATA_SCHEMA
+            )
+
+        county = user_input[
+            "county"
+        ]  # Voluptuous automatically detects if the county is invalid
+
+        await self.async_set_unique_id(county)
+        self._abort_if_unique_id_configured()  # this should abort if the county was already configured
+
+        # take the county name and make it all lowercase except for the first letter
+        # this is to make it easier to read in the UI
+        county_name = county.lower()
+        county_name = county_name[0].upper() + county_name[1:]
+
+        return self.async_create_entry(
+            title=county_name + " Outage Count", data=user_input
+        )
+
+    async def async_step_reauth(self, user_input: dict[str, Any] = None) -> FlowResult:
+        """Handle re-auth step."""
+        return await self.async_step_user(user_input)

homeassistant/components/peco/const.py

@@ -0,0 +1,29 @@
+"""Constants for the PECO Outage Counter integration."""
+import logging
+
+from homeassistant.components.sensor import SensorEntityDescription
+
+DOMAIN = "peco"
+_LOGGER = logging.getLogger(__name__)
+COUNTY_LIST = [
+    "BUCKS",
+    "CHESTER",
+    "DELAWARE",
+    "MONTGOMERY",
+    "PHILADELPHIA",
+    "YORK",
+    "TOTAL",
+]
+SCAN_INTERVAL = 5
+ATTR_CUSTOMERS_OUT = "customers_out"
+ATTR_PERCENT_CUSTOMERS_OUT = "percent_customers_out"
+ATTR_OUTAGE_COUNT = "outage_count"
+ATTR_CUSTOMERS_SERVED = "customers_served"
+SENSOR_LIST = (
+    SensorEntityDescription(key=ATTR_CUSTOMERS_OUT, name="{} Customers Out"),
+    SensorEntityDescription(
+        key=ATTR_PERCENT_CUSTOMERS_OUT, name="{} Percent Customers Out"
+    ),
+    SensorEntityDescription(key=ATTR_OUTAGE_COUNT, name="{} Outage Count"),
+    SensorEntityDescription(key=ATTR_CUSTOMERS_SERVED, name="{} Customers Served"),
+)

homeassistant/components/peco/manifest.json

@@ -0,0 +1,13 @@
+{
+  "domain": "peco",
+  "name": "PECO Outage Counter",
+  "config_flow": true,
+  "documentation": "https://www.home-assistant.io/integrations/peco",
+  "codeowners": [
+    "@IceBotYT"
+  ],
+  "iot_class": "cloud_polling",
+  "requirements": [
+    "peco==0.0.19"
+  ]
+}

homeassistant/components/peco/sensor.py

@@ -0,0 +1,109 @@
+"""Sensor component for PECO outage counter."""
+from datetime import timedelta
+from types import MappingProxyType
+from typing import Any, Final
+
+import async_timeout
+from peco import BadJSONError, HttpError
+
+from homeassistant.components.sensor import SensorEntity, SensorStateClass
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers.entity_platform import AddEntitiesCallback
+from homeassistant.helpers.update_coordinator import (
+    CoordinatorEntity,
+    DataUpdateCoordinator,
+    UpdateFailed,
+)
+
+from .const import _LOGGER, DOMAIN, SCAN_INTERVAL, SENSOR_LIST
+
+PARALLEL_UPDATES: Final = 0
+
+
+async def async_setup_entry(
+    hass: HomeAssistant,
+    config_entry: ConfigEntry,
+    async_add_entities: AddEntitiesCallback,
+) -> None:
+    """Set up the sensor platform."""
+    api = hass.data[DOMAIN][config_entry.entry_id]["api"]
+    websession = hass.data[DOMAIN][config_entry.entry_id]["websession"]
+    conf: MappingProxyType[str, Any] = config_entry.data
+
+    async def async_update_data():
+        """Fetch data from API."""
+        async with async_timeout.timeout(10):
+            if conf["county"] == "TOTAL":
+                try:
+                    data = await api.get_outage_totals(websession)
+                except HttpError as err:
+                    raise UpdateFailed(f"Error fetching data: {err}") from err
+                except BadJSONError as err:
+                    raise UpdateFailed(f"Error parsing data: {err}") from err
+                if data["percent_customers_out"] < 5:
+                    data["percent_customers_out"] = "Less than 5%"
+                return data
+            try:
+                data = await api.get_outage_count(conf["county"], websession)
+            except HttpError as err:
+                raise UpdateFailed from err
+            except BadJSONError as err:
+                raise UpdateFailed from err
+            if data["percent_customers_out"] < 5:
+                data["percent_customers_out"] = "Less than 5%"
+            return data
+
+    coordinator = DataUpdateCoordinator(
+        hass,
+        _LOGGER,
+        name="PECO Outage Count",
+        update_method=async_update_data,
+        update_interval=timedelta(minutes=SCAN_INTERVAL),
+    )
+
+    await coordinator.async_config_entry_first_refresh()
+
+    county = conf["county"]
+
+    county_name = county.lower()[0].upper() + county.lower()[1:]
+
+    sensors = []
+    for sensor in SENSOR_LIST:
+        sensor_name = getattr(sensor, "name", "This should never happen").format(
+            county_name
+        )
+        sensors.append(PecoSensor(hass, sensor_name, county, coordinator, sensor.key))
+    async_add_entities(
+        sensors,
+        True,
+    )
+    return
+
+
+class PecoSensor(CoordinatorEntity, SensorEntity):
+    """PECO outage counter sensor."""
+
+    _attr_state_class = SensorStateClass.MEASUREMENT
+    _attr_icon: str = "mdi:power-plug-off"
+
+    def __init__(
+        self,
+        hass: HomeAssistant,
+        name: str,
+        county: str,
+        coordinator: DataUpdateCoordinator,
+        key: str,
+    ) -> None:
+        """Initialize the sensor."""
+        super().__init__(coordinator)
+        self.hass = hass
+        self._county = county
+        self._attr_name = name
+        self._attr_unique_id = f"{self._county}_{key}"
+        self._key = key
+
+    @property
+    def native_value(self) -> int:
+        """Return the value of the sensor."""
+        return self.coordinator.data[self._key]

homeassistant/components/peco/strings.json

@@ -0,0 +1,16 @@
+{
+  "config": {
+    "step": {
+      "user": {
+        "title": "PECO Outage Counter",
+        "description": "Please choose your county below.",
+        "data": {
+          "county": "County"
+        }
+      }
+    },
+    "abort": {
+      "already_configured": "[%key:common::config_flow::abort::already_configured_device%]"
+    }
+  }
+}

homeassistant/components/peco/translations/en.json

@@ -0,0 +1,16 @@
+{
+    "config": {
+        "abort": {
+            "already_configured": "Device is already configured"
+        },
+        "step": {
+            "user": {
+                "data": {
+                    "county": "County"
+                },
+                "description": "Please choose your county below.",
+                "title": "PECO Outage Counter"
+            }
+        }
+    }
+}

homeassistant/generated/config_flows.py

@@ -230,6 +230,7 @@
     "ozw",
     "p1_monitor",
     "panasonic_viera",
+    "peco",
     "philips_js",
     "pi_hole",
     "picnic",

requirements_all.txt

@@ -1194,6 +1194,9 @@ pcal9535a==0.7
 # homeassistant.components.dunehd
 pdunehd==1.3.2
 
+# homeassistant.components.peco
+peco==0.0.19
+
 # homeassistant.components.pencom
 pencompy==0.0.3
 

requirements_test_all.txt

@@ -725,6 +725,9 @@ panasonic_viera==0.3.6
 # homeassistant.components.dunehd
 pdunehd==1.3.2
 
+# homeassistant.components.peco
+peco==0.0.19
+
 # homeassistant.components.aruba
 # homeassistant.components.cisco_ios
 # homeassistant.components.pandora

tests/components/peco/__init__.py

@@ -0,0 +1 @@
+"""Tests for the PECO Outage Counter integration."""