Use tariff-specific MPSC PSCR factors

Author: javaDevJT

custom_components/dte_rates/__init__.py

@@ -122,7 +122,7 @@ async def _handle_show_schedule_service(call) -> None:
 
         lines_by_season: dict[str, list[str]] = defaultdict(list)
         net_metering = entry.data.get(CONF_NET_METERING, False) if entry else False
-        pscr_cents = getattr(coordinator.data, "pscr_cents", None)
+        pscr_cents = getattr(coordinator.data, "pscr_rates", {}).get(rate.code)
         for period in sorted(rate.periods, key=lambda p: (p.season_name, p.period_name)):
             import_usd = float(current_import_rate_cents(period) / 100)
             export_usd = float(current_export_rate_cents(period, net_metering, pscr_cents) / 100)

custom_components/dte_rates/config_flow.py

@@ -44,5 +44,9 @@ async def async_step_user(self, user_input: dict | None = None) -> FlowResult:
         )
 
 
-def _rider18_status(_rate_card) -> str:
-    return "Rider 18 export credits use parsed generation rates plus PSCR when the PSCR value is available."
+def _rider18_status(rate_card) -> str:
+    count = len(getattr(rate_card, "pscr_rates", {}))
+    if count:
+        suffix = "tariff" if count == 1 else "tariffs"
+        return f"Rider 18 export credits use parsed generation rates plus MPSC PSCR factors loaded for {count} {suffix}."
+    return "Rider 18 export credits use parsed generation rates plus MPSC PSCR when the selected tariff has a PSCR factor."

custom_components/dte_rates/const.py

@@ -24,6 +24,8 @@
 ATTR_MONTHLY_COMPONENTS = "monthly_components"
 ATTR_SOURCE_URL = "source_url"
 ATTR_PSCR_CENTS = "pscr_cents"
+ATTR_PSCR_RATE_CODE = "pscr_rate_code"
+ATTR_PSCR_RATES = "pscr_rates"
 ATTR_PSCR_SOURCE_URL = "pscr_source_url"
 ATTR_RIDER18_EXPORT_AVAILABLE = "rider18_export_available"
 ATTR_EXPORT_RATE_SOURCE = "export_rate_source"

custom_components/dte_rates/coordinator.py

@@ -10,7 +10,7 @@
 from .const import PSCR_RATE_BOOK_URL, RATE_CARD_URL, UPDATE_INTERVAL
 from .models import ParsedRateCard
 from .pdf_parser import parse_rate_card_pdf
-from .pscr_parser import parse_pscr_cents_from_pdf
+from .pscr_parser import parse_pscr_rates_from_pdf
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -65,8 +65,8 @@ async def _async_update_data(self) -> ParsedRateCard:
             return parsed
 
         try:
-            parsed.pscr_cents = await self.hass.async_add_executor_job(
-                parse_pscr_cents_from_pdf,
+            parsed.pscr_rates = await self.hass.async_add_executor_job(
+                parse_pscr_rates_from_pdf,
                 pscr_bytes,
             )
             parsed.pscr_source_url = PSCR_RATE_BOOK_URL

custom_components/dte_rates/models.py

@@ -50,5 +50,5 @@ class ParsedRateCard:
     effective_date: str | None
     rates: dict[str, RatePlan]
     raw_text_hash: str
-    pscr_cents: Decimal | None = None
+    pscr_rates: dict[str, Decimal] = field(default_factory=dict)
     pscr_source_url: str | None = None

custom_components/dte_rates/pscr_parser.py

@@ -7,20 +7,46 @@
 from pypdf import PdfReader
 
 
-_D111_PSCR_RE = re.compile(
-    r"\bD1\.11\s+Standard\s+TOU\s+(?P<pscr>\d+\.\d+)",
+_RATE_ROW_RE = re.compile(
+    r"^\s*(?P<code>[A-Z]\d+(?:\.\d+)?)\s+.+?\s+(?P<pscr>-?\d+\.\d+)\s+\d+\.\d+",
     re.IGNORECASE,
 )
 
 
-def parse_pscr_cents_from_pdf(pdf_bytes: bytes) -> Decimal:
-    """Extract the current PSCR value from the MPSC DTE electric rate book."""
+def parse_pscr_rates_from_pdf(pdf_bytes: bytes) -> dict[str, Decimal]:
+    """Extract current PSCR values by tariff code from the MPSC DTE electric rate book."""
     reader = PdfReader(io.BytesIO(pdf_bytes))
     text = "\n".join(page.extract_text() or "" for page in reader.pages)
-    normalized = re.sub(r"\s+", " ", text)
-
-    match = _D111_PSCR_RE.search(normalized)
-    if match:
-        return Decimal(match.group("pscr"))
-
-    raise ValueError("MPSC DTE rate book does not contain a D1.11 PSCR value")
+    lines = [re.sub(r"\s+", " ", line).strip() for line in text.splitlines()]
+
+    section = _power_supply_surcharge_lines(lines)
+    rates: dict[str, Decimal] = {}
+    for line in section:
+        match = _RATE_ROW_RE.match(line)
+        if match:
+            rates[match.group("code").upper()] = Decimal(match.group("pscr"))
+
+    if not rates:
+        raise ValueError("MPSC DTE rate book does not contain PSCR tariff rows")
+    return rates
+
+
+def _power_supply_surcharge_lines(lines: list[str]) -> list[str]:
+    start = None
+    for idx, line in enumerate(lines):
+        lower = line.lower()
+        if "c8.5 surcharges and credits applicable to power supply service" in lower:
+            start = idx
+            break
+
+    if start is None:
+        return lines
+
+    end = len(lines)
+    for idx in range(start + 1, len(lines)):
+        lower = lines[idx].lower()
+        if "c9 surcharges and credits applicable to delivery service" in lower:
+            end = idx
+            break
+
+    return lines[start:end]

custom_components/dte_rates/sensor.py

@@ -26,6 +26,8 @@
     ATTR_NEXT_RATE_NAME,
     ATTR_NEXT_RATE_VALUE,
     ATTR_PSCR_CENTS,
+    ATTR_PSCR_RATE_CODE,
+    ATTR_PSCR_RATES,
     ATTR_PSCR_SOURCE_URL,
     ATTR_RATE_CODE,
     ATTR_RATE_NAME,
@@ -110,27 +112,30 @@ def _active_period(self) -> SeasonalPeriodRate | None:
             return None
         return get_active_period(rate, dt_util.now())
 
-    def _pscr_cents(self) -> Decimal | None:
-        return getattr(self.coordinator.data, "pscr_cents", None)
+    def _pscr_cents_for_rate(self, rate: RatePlan | None = None) -> Decimal | None:
+        target_rate = rate or self._selected_rate()
+        if target_rate is None:
+            return None
+        return getattr(self.coordinator.data, "pscr_rates", {}).get(target_rate.code)
 
     def _export_rate_cents(self, period: SeasonalPeriodRate):
         return current_export_rate_cents(
             period,
             self._entry.data.get(CONF_NET_METERING, False),
-            self._pscr_cents(),
+            self._pscr_cents_for_rate(),
         )
 
     def _export_rate_source(self, period: SeasonalPeriodRate) -> str:
         if self._entry.data.get(CONF_NET_METERING, False):
             return "net_metering"
-        if rider18_export_formula_available(period, self._pscr_cents()):
+        if rider18_export_formula_available(period, self._pscr_cents_for_rate()):
             return "rider18_formula"
         return "rider18_formula_incomplete"
 
     def _export_rate_warning(self, period: SeasonalPeriodRate) -> str | None:
         if self._entry.data.get(CONF_NET_METERING, False):
             return None
-        if rider18_export_formula_available(period, self._pscr_cents()):
+        if rider18_export_formula_available(period, self._pscr_cents_for_rate()):
             return None
         return (
             "Rider 18 formula is missing a generation component or PSCR value "
@@ -152,8 +157,14 @@ def _base_attributes(self) -> dict:
             ATTR_SOURCE_URL: self.coordinator.data.source_url,
             ATTR_CARD_EFFECTIVE_DATE: self.coordinator.data.effective_date,
         }
-        if self.coordinator.data.pscr_cents is not None:
-            attrs[ATTR_PSCR_CENTS] = float(self.coordinator.data.pscr_cents)
+        pscr_cents = self._pscr_cents_for_rate()
+        if pscr_cents is not None:
+            attrs[ATTR_PSCR_CENTS] = float(pscr_cents)
+            rate = self._selected_rate()
+            if rate is not None:
+                attrs[ATTR_PSCR_RATE_CODE] = rate.code
+        if self.coordinator.data.pscr_rates:
+            attrs[ATTR_PSCR_RATES] = {code: float(value) for code, value in self.coordinator.data.pscr_rates.items()}
         if self.coordinator.data.pscr_source_url:
             attrs[ATTR_PSCR_SOURCE_URL] = self.coordinator.data.pscr_source_url
 
@@ -301,7 +312,7 @@ def extra_state_attributes(self) -> dict:
         period = self._active_period()
         if period is not None:
             attrs[ATTR_EXPORT_RATE_SOURCE] = self._export_rate_source(period)
-            attrs[ATTR_RIDER18_EXPORT_AVAILABLE] = rider18_export_formula_available(period, self._pscr_cents())
+            attrs[ATTR_RIDER18_EXPORT_AVAILABLE] = rider18_export_formula_available(period, self._pscr_cents_for_rate())
             warning = self._export_rate_warning(period)
             if warning is not None:
                 attrs[ATTR_EXPORT_RATE_WARNING] = warning

docs/research/rider18-export-rates.md

@@ -4,11 +4,11 @@
 
 - Enhancement request: calculate Rider 18 export credits to match DTE's Rider 18 calculator.
 - Residential rate card: source of the active generation components for each rate period.
-- MPSC DTE electric rate book: source of the current PSCR scalar.
+- MPSC DTE electric rate book: source of current PSCR factors by tariff code.
 
 ## Implementation Decision
 
-Do not use the Rider 18 calculator workbook's period-specific outflow credits as the authoritative rates. PSCR is parsed dynamically from the MPSC DTE electric rate book PDF at `https://www.michigan.gov/-/media/Project/Websites/mpsc/consumer/rate-books/electric/dte/dtee1cur.pdf`, because the residential rate card PDF does not include that scalar.
+Do not use the Rider 18 calculator workbook's period-specific outflow credits as the authoritative rates. PSCR factors are parsed dynamically by tariff code from the MPSC DTE electric rate book PDF at `https://www.michigan.gov/-/media/Project/Websites/mpsc/consumer/rate-books/electric/dte/dtee1cur.pdf`, because the residential rate card PDF does not include those factors.
 
 Formula:
 
@@ -38,7 +38,9 @@ For net metering, keep the existing behavior: export uses the full active import
 
 ## UI/Entity Status
 
-The setup flow explains that Rider 18 export credits use parsed generation plus PSCR when the PSCR value is available. Export entities expose whether the active period has enough data for the full formula:
+The setup flow reports how many MPSC tariff PSCR factors were loaded. Export entities expose the selected rate's PSCR value, the PSCR source URL, and the full parsed `pscr_rates` map.
+
+Export entities expose whether the active period has enough data for the full formula:
 
 - `export_rate_source: rider18_formula` when generation components and PSCR are present.
 - `export_rate_source: rider18_formula_incomplete` when one side of the formula is missing.

tests/test_config_flow.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+from decimal import Decimal
 from unittest.mock import MagicMock
 
 import pytest
@@ -23,7 +24,7 @@ async def _refresh(self):
                 "D1.13": RatePlan(code="D1.13", name="Overnight", periods=[]),
             },
             raw_text_hash="abc",
-            pscr_cents=None,
+            pscr_rates={},
         )
 
     monkeypatch.setattr(
@@ -58,6 +59,10 @@ async def _refresh(self):
                 "D1.13": RatePlan(code="D1.13", name="Overnight", periods=[]),
             },
             raw_text_hash="abc",
+            pscr_rates={
+                "D1.11": Decimal("1.877"),
+                "D1.13": Decimal("1.877"),
+            },
         )
 
     monkeypatch.setattr(
@@ -70,5 +75,5 @@ async def _refresh(self):
     assert result["type"] == "form"
     assert (
         result["description_placeholders"]["rider18_status"]
-        == "Rider 18 export credits use parsed generation rates plus PSCR when the PSCR value is available."
+        == "Rider 18 export credits use parsed generation rates plus MPSC PSCR factors loaded for 2 tariffs."
     )

tests/test_pscr_parser.py

@@ -2,14 +2,20 @@
 
 from decimal import Decimal
 
-from custom_components.dte_rates.pscr_parser import parse_pscr_cents_from_pdf
+from custom_components.dte_rates.pscr_parser import parse_pscr_rates_from_pdf
 
 
 SAMPLE_RATE_BOOK_TEXT = """
 C8.5 SURCHARGES AND CREDITS APPLICABLE TO POWER SUPPLY SERVICE
 Rate Schedule Description PSCR Factor Other Charges
+D1 Non Transmitting Meter 1.877 0.0222 0.2305 2.1297
+D1.8 Dynamic Peak Pricing 1.877 0.0187 0.1934 2.0891
 D1.11 Standard TOU 1.877 0.0221
-D1.13 Overnight Savers 1.877 0.0221
+D1.13 Overnight Savers 1.877 0.0221 0.2292 2.1283
+Commercial
+D3 General Service 1.877 0.0180 0.1867 2.0817
+C9 SURCHARGES AND CREDITS APPLICABLE TO DELIVERY SERVICE
+D1.11 Standard TOU 0.0890 0.4488 0.1617 0.2762
 """
 
 
@@ -23,7 +29,13 @@ def __init__(self, _bytes):
         self.pages = [_FakePage()]
 
 
-def test_parse_pscr_cents_from_mpsc_rate_book_pdf(monkeypatch):
+def test_parse_pscr_rates_from_mpsc_rate_book_pdf(monkeypatch):
     monkeypatch.setattr("custom_components.dte_rates.pscr_parser.PdfReader", _FakeReader)
 
-    assert parse_pscr_cents_from_pdf(b"fake") == Decimal("1.877")
+    assert parse_pscr_rates_from_pdf(b"fake") == {
+        "D1": Decimal("1.877"),
+        "D1.8": Decimal("1.877"),
+        "D1.11": Decimal("1.877"),
+        "D1.13": Decimal("1.877"),
+        "D3": Decimal("1.877"),
+    }