Expose Rider 18 export status

Author: javaDevJT

custom_components/dte_rates/config_flow.py

@@ -6,6 +6,7 @@
 
 from .const import CONF_NET_METERING, CONF_SELECTED_RATE, DOMAIN
 from .coordinator import DteRateCoordinator
+from .models import ParsedRateCard
 
 
 class DteRatesConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
@@ -35,4 +36,22 @@ async def async_step_user(self, user_input: dict | None = None) -> FlowResult:
                 vol.Optional(CONF_NET_METERING, default=False): bool,
             }
         )
-        return self.async_show_form(step_id="user", data_schema=schema)
+        return self.async_show_form(
+            step_id="user",
+            data_schema=schema,
+            description_placeholders={
+                "rider18_status": _rider18_status(coordinator.data),
+            },
+        )
+
+
+def _rider18_status(rate_card: ParsedRateCard) -> str:
+    count = len(rate_card.rider18_export_rates)
+    if count:
+        suffix = "rate plan" if count == 1 else "rate plans"
+        return f"Rider 18 export credits loaded for {count} {suffix}."
+
+    if rate_card.rider18_source_url:
+        return "Rider 18 calculator loaded, but no export credits matched the parsed rate plans."
+
+    return "Rider 18 export credits are not loaded; non-net-metering exports will fall back to PDF generation-only pricing."

custom_components/dte_rates/const.py

@@ -24,6 +24,9 @@
 ATTR_MONTHLY_COMPONENTS = "monthly_components"
 ATTR_SOURCE_URL = "source_url"
 ATTR_RIDER18_SOURCE_URL = "rider18_source_url"
+ATTR_RIDER18_EXPORT_AVAILABLE = "rider18_export_available"
+ATTR_EXPORT_RATE_SOURCE = "export_rate_source"
+ATTR_EXPORT_RATE_WARNING = "export_rate_warning"
 ATTR_CARD_EFFECTIVE_DATE = "card_effective_date"
 ATTR_SELECTED_RATE_AVAILABLE = "selected_rate_available"
 ATTR_WARNING = "warning"

custom_components/dte_rates/sensor.py

@@ -20,11 +20,14 @@
     ATTR_MONTHLY_COMPONENTS,
     ATTR_PERIOD,
     ATTR_CURRENT_RATE_NAME,
+    ATTR_EXPORT_RATE_SOURCE,
+    ATTR_EXPORT_RATE_WARNING,
     ATTR_NEXT_RATE_CHANGE,
     ATTR_NEXT_RATE_NAME,
     ATTR_NEXT_RATE_VALUE,
     ATTR_RATE_CODE,
     ATTR_RATE_NAME,
+    ATTR_RIDER18_EXPORT_AVAILABLE,
     ATTR_RIDER18_SOURCE_URL,
     ATTR_SCHEDULE_BY_SEASON,
     ATTR_SCHEDULE_TEXT,
@@ -123,6 +126,25 @@ def _export_rate_cents(self, period: SeasonalPeriodRate):
             self._rider18_export_rate_cents(period),
         )
 
+    def _export_rate_source(self, period: SeasonalPeriodRate) -> str:
+        if self._entry.data.get(CONF_NET_METERING, False):
+            return "net_metering"
+        if self._rider18_export_rate_cents(period) is not None:
+            return "rider18"
+        return "pdf_generation_components"
+
+    def _export_rate_warning(self, period: SeasonalPeriodRate) -> str | None:
+        if self._entry.data.get(CONF_NET_METERING, False):
+            return None
+        if self._rider18_export_rate_cents(period) is not None:
+            return None
+        if not self.coordinator.data.rider18_source_url:
+            return "Rider 18 export credits are not loaded; using PDF generation-only export pricing."
+        return (
+            "No Rider 18 export credit matched the selected rate's active season and period; "
+            "using PDF generation-only export pricing."
+        )
+
     def _warning(self) -> str | None:
         selected = self._entry.data[CONF_SELECTED_RATE]
         if selected not in self.coordinator.data.rates:
@@ -282,6 +304,13 @@ def native_value(self) -> float | None:
     def extra_state_attributes(self) -> dict:
         attrs = self._base_attributes()
         attrs[CONF_NET_METERING] = self._entry.data.get(CONF_NET_METERING, False)
+        period = self._active_period()
+        if period is not None:
+            attrs[ATTR_EXPORT_RATE_SOURCE] = self._export_rate_source(period)
+            attrs[ATTR_RIDER18_EXPORT_AVAILABLE] = self._rider18_export_rate_cents(period) is not None
+            warning = self._export_rate_warning(period)
+            if warning is not None:
+                attrs[ATTR_EXPORT_RATE_WARNING] = warning
         return attrs
 
     def _period_value_usd(self, period: SeasonalPeriodRate | None) -> float | None:

custom_components/dte_rates/strings.json

@@ -3,7 +3,7 @@
     "step": {
       "user": {
         "title": "DTE Residential Rates",
-        "description": "Choose your DTE residential electric pricing plan.",
+        "description": "Choose your DTE residential electric pricing plan.\n\n{rider18_status}",
         "data": {
           "selected_rate": "Rate plan",
           "net_metering": "Net metering enabled"

custom_components/dte_rates/translations/en.json

@@ -3,7 +3,7 @@
     "step": {
       "user": {
         "title": "DTE Residential Rates",
-        "description": "Choose your DTE residential electric pricing plan.",
+        "description": "Choose your DTE residential electric pricing plan.\n\n{rider18_status}",
         "data": {
           "selected_rate": "Rate plan",
           "net_metering": "Net metering enabled"

tests/conftest.py

@@ -32,7 +32,7 @@ def __init__(self):
             self.hass = None
 
         def async_show_form(self, *, step_id, data_schema=None, errors=None, **kwargs):
-            return FlowResult(type="form", step_id=step_id, data_schema=data_schema, errors=errors or {})
+            return FlowResult(type="form", step_id=step_id, data_schema=data_schema, errors=errors or {}, **kwargs)
 
         def async_create_entry(self, *, title, data):
             return FlowResult(type="create_entry", title=title, data=data)

tests/test_config_flow.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+from decimal import Decimal
 from unittest.mock import MagicMock
 
 import pytest
@@ -41,3 +42,34 @@ async def _refresh(self):
     assert result["title"] == "Overnight (D1.13)"
     assert result["data"][CONF_SELECTED_RATE] == "D1.13"
     assert result["data"][CONF_NET_METERING] is True
+
+
+@pytest.mark.asyncio
+async def test_config_flow_describes_rider18_loaded_status(monkeypatch):
+    flow = DteRatesConfigFlow()
+    flow.hass = MagicMock()
+
+    async def _refresh(self):
+        self.data = ParsedRateCard(
+            source_url="https://example.test/card.pdf",
+            effective_date="February 6, 2025",
+            rates={
+                "D1.11": RatePlan(code="D1.11", name="Standard Base", periods=[]),
+                "D1.13": RatePlan(code="D1.13", name="Overnight", periods=[]),
+            },
+            raw_text_hash="abc",
+            rider18_source_url="https://example.test/Rider18Calculator.xlsx",
+            rider18_export_rates={
+                "D1.11": {("october_through_may", "off_peak"): Decimal("10.586")},
+            },
+        )
+
+    monkeypatch.setattr(
+        "custom_components.dte_rates.coordinator.DteRateCoordinator.async_refresh",
+        _refresh,
+    )
+
+    result = await flow.async_step_user()
+
+    assert result["type"] == "form"
+    assert result["description_placeholders"]["rider18_status"] == "Rider 18 export credits loaded for 1 rate plan."

tests/test_sensor.py

@@ -84,6 +84,8 @@ def test_export_sensor_prefers_rider18_credit_without_net_metering(monkeypatch):
     sensor = DteExportRateSensor(coordinator, entry)
     assert sensor.native_value == 0.10586
     assert sensor.extra_state_attributes["rider18_source_url"] == "https://example.test/Rider18Calculator.xlsx"
+    assert sensor.extra_state_attributes["export_rate_source"] == "rider18"
+    assert sensor.extra_state_attributes["rider18_export_available"] is True
 
 
 def test_export_sensor_ignores_rider18_credit_with_net_metering(monkeypatch):
@@ -94,6 +96,22 @@ def test_export_sensor_ignores_rider18_credit_with_net_metering(monkeypatch):
 
     sensor = DteExportRateSensor(coordinator, entry)
     assert sensor.native_value == 0.06
+    assert sensor.extra_state_attributes["export_rate_source"] == "net_metering"
+
+
+def test_export_sensor_reports_generation_fallback_when_rider18_missing(monkeypatch):
+    monkeypatch.setattr("custom_components.dte_rates.sensor.dt_util.now", lambda: datetime(2026, 3, 1, 12, 0))
+
+    coordinator = _coordinator_with_rate({("june_through_september", "peak"): Decimal("16.284")})
+    entry = SimpleNamespace(entry_id="entry_16", data={CONF_SELECTED_RATE: "D1.11", CONF_NET_METERING: False})
+
+    sensor = DteExportRateSensor(coordinator, entry)
+    attrs = sensor.extra_state_attributes
+
+    assert sensor.native_value == 0.03
+    assert attrs["export_rate_source"] == "pdf_generation_components"
+    assert attrs["rider18_export_available"] is False
+    assert "No Rider 18 export credit" in attrs["export_rate_warning"]
 
 
 def test_sensor_warns_when_selected_rate_disappears(monkeypatch):