feat: Added repair notice when no rates are retrievable (1.5 hours dev time)

Author: BottlecapDave

_docs/repairs/tariff_rates_empty.md

@@ -0,0 +1,12 @@
+# Repairs - Tariff Rates Empty
+
+If you have received this repair notice, it means you have one or more meters associated with a tariff that no longer appears to be returning up to date rate information. 
+
+This can be confirmed by looking at the rate feed. For example if you have tariff 'G-1R-SILVER-25-09-02-M' and product 'SILVER-25-09-02', then for electricity you can find the rates at https://api.octopus.energy/v1/products/SILVER-25-09-02/electricity-tariffs/E-1R-SILVER-25-09-02-A/standard-unit-rates/ and for gas you can find the rates at https://api.octopus.energy/v1/products/SILVER-25-09-02/gas-tariffs/G-1R-SILVER-25-09-02-A/standard-unit-rates/. If the first record has an "valid_to" value that isn't "null" and in the past, then new rates are no longer being published.
+
+This can occur for a number of reasons
+
+1. Your tariff has finished but you haven't been moved to a new tariff for some reason.
+2. There is an issue with the rate feed. This might be a short term issue with the Octopus Energy servers, so waiting my rectify the issue.
+
+To rectify all of these issues, you will need to contact Octopus Energy to fix this issue.

custom_components/octopus_energy/const.py

@@ -213,6 +213,7 @@
 REPAIR_TARGET_RATE_REMOVAL_PROPOSAL = "target_rate_removal_proposal"
 REPAIR_INTELLIGENT_DEVICE_NOT_FOUND = "intelligent_device_not_found_{}"
 REPAIR_INTELLIGENT_DEVICE_CHANGED = "intelligent_device_changed_{}"
+REPAIR_TARIFF_RATES_EMPTY = "tariff_rates_empty_{}_{}"
 
 # During BST, two records are returned before the rest of the data is available
 MINIMUM_CONSUMPTION_DATA_LENGTH = 3

custom_components/octopus_energy/coordinators/__init__.py

@@ -2,12 +2,17 @@
 import logging
 from typing import Callable, Any
 
+from custom_components.octopus_energy.const import DOMAIN, REPAIR_TARIFF_RATES_EMPTY
+from custom_components.octopus_energy.utils.repairs import safe_repair_key
 from homeassistant.helpers.update_coordinator import (
   CoordinatorEntity,
 )
 from homeassistant.util.dt import (as_utc)
+from homeassistant.helpers import issue_registry as ir
+
 
 from ..utils import (
+  Tariff,
   get_active_tariff
 )
 from ..utils.rate_information import get_min_max_average_rates
@@ -128,4 +133,19 @@ def combine_rates(old_rates: list | None, new_rates: list | None, period_from: d
 
     combined_rates.sort(key=lambda x: x["start"])
 
-  return combined_rates
+  return combined_rates
+
+def raise_rates_empty(hass, account_id: str, tariff: Tariff, mprn_mpan: str, serial_number: str, is_electricity: bool):
+  ir.async_create_issue(
+    hass,
+    DOMAIN,
+    safe_repair_key(REPAIR_TARIFF_RATES_EMPTY, account_id, tariff.code),
+    is_fixable=False,
+    severity=ir.IssueSeverity.WARNING,
+    learn_more_url="https://bottlecapdave.github.io/HomeAssistant-OctopusEnergy/repairs/tariff_rates_empty",
+    translation_key="tariff_rates_empty",
+    translation_placeholders={ "account_id": account_id, "product_code": tariff.product, "tariff_code": tariff.code, "product_code": tariff.product, "mprn_mpan": mprn_mpan, "serial_number": serial_number, "meter_type": "electricity" if is_electricity else "gas" },
+  )
+
+def clear_rates_empty(hass, account_id: str, tariff: Tariff):
+  ir.async_delete_issue(hass, DOMAIN, safe_repair_key(REPAIR_TARIFF_RATES_EMPTY, account_id, tariff.code))

custom_components/octopus_energy/coordinators/electricity_rates.py

@@ -30,7 +30,7 @@
 from ..api_client import ApiException, OctopusEnergyApiClient
 from ..coordinators.intelligent_dispatches import IntelligentDispatchesCoordinatorResult
 from ..utils import Tariff, private_rates_to_public_rates
-from . import BaseCoordinatorResult, combine_rates, get_electricity_meter_tariff, raise_rate_events
+from . import BaseCoordinatorResult, clear_rates_empty, combine_rates, get_electricity_meter_tariff, raise_rate_events, raise_rates_empty
 from ..intelligent import adjust_intelligent_rates, is_intelligent_product
 from ..utils.rate_information import get_unique_rates, has_peak_rates
 from ..utils.tariff_cache import async_save_cached_tariff_total_unique_rates
@@ -67,7 +67,9 @@ async def async_refresh_electricity_rates_data(
     unique_rates_changed: Callable[[Tariff, int], Awaitable[None]] = None,
     raise_no_active_rate: Callable[[], Awaitable[None]] = None,
     remove_no_active_rate: Callable[[], Awaitable[None]] = None,
-    intelligent_rate_mode: str = CONFIG_MAIN_INTELLIGENT_RATE_MODE_PENDING_AND_STARTED_DISPATCHES
+    intelligent_rate_mode: str = CONFIG_MAIN_INTELLIGENT_RATE_MODE_PENDING_AND_STARTED_DISPATCHES,
+    raise_rates_empty: Callable[[Tariff], None] = None,
+    clear_rates_empty: Callable[[Tariff], None] = None
   ) -> ElectricityRatesCoordinatorResult: 
   if (account_info is not None):
     period_from = as_utc((current - timedelta(days=1)).replace(hour=0, minute=0, second=0, microsecond=0))
@@ -115,6 +117,11 @@ async def async_refresh_electricity_rates_data(
 
       if new_rates is not None:
         _LOGGER.debug(f'Electricity rates retrieved for {target_mpan}/{target_serial_number} ({tariff.code});')
+
+        if len(new_rates) == 0 and raise_rates_empty is not None:
+          raise_rates_empty(tariff)
+        elif clear_rates_empty is not None:
+          clear_rates_empty(tariff)
 
         original_rates = new_rates.copy()
         original_rates.sort(key=lambda rate: (rate["start"].timestamp(), rate["start"].fold))
@@ -294,7 +301,9 @@ async def async_update_electricity_rates_data():
       lambda tariff, total_unique_rates: async_update_unique_rates(hass, account_id, tariff, total_unique_rates),
       lambda: async_raise_no_active_tariff(hass, account_id, target_mpan, target_serial_number),
       lambda: async_remove_no_active_tariff(hass, target_mpan, target_serial_number),
-      intelligent_rate_mode
+      intelligent_rate_mode,
+      lambda tariff: raise_rates_empty(hass, account_id, tariff, target_mpan, target_serial_number, True),
+      lambda tariff: clear_rates_empty(hass, account_id, tariff)
     )
 
     return hass.data[DOMAIN][account_id][key]

custom_components/octopus_energy/coordinators/gas_rates.py

@@ -22,8 +22,8 @@
 )
 
 from ..api_client import ApiException, OctopusEnergyApiClient
-from ..utils import private_rates_to_public_rates
-from . import BaseCoordinatorResult, combine_rates, get_gas_meter_tariff, raise_rate_events
+from ..utils import Tariff, private_rates_to_public_rates
+from . import BaseCoordinatorResult, clear_rates_empty, combine_rates, get_gas_meter_tariff, raise_rate_events, raise_rates_empty
 from ..utils.repairs import safe_repair_key
 
 _LOGGER = logging.getLogger(__name__)
@@ -44,7 +44,9 @@ async def async_refresh_gas_rates_data(
     existing_rates_result: GasRatesCoordinatorResult,
     fire_event: Callable[[str, "dict[str, Any]"], None],
     raise_no_active_rate: Callable[[], None] = None,
-    remove_no_active_rate: Callable[[], None] = None
+    remove_no_active_rate: Callable[[], None] = None,
+    raise_rates_empty: Callable[[Tariff], None] = None,
+    clear_rates_empty: Callable[[Tariff], None] = None
   ) -> GasRatesCoordinatorResult: 
   if (account_info is not None):
     period_from = as_utc((current - timedelta(days=1)).replace(hour=0, minute=0, second=0, microsecond=0))
@@ -95,6 +97,11 @@ async def async_refresh_gas_rates_data(
       if new_rates is not None:
         _LOGGER.debug(f'Gas rates retrieved for {target_mprn}/{target_serial_number} ({tariff.code});')
 
+        if new_rates is not None and len(new_rates) == 0 and raise_rates_empty is not None:
+          raise_rates_empty(tariff)
+        elif clear_rates_empty is not None:
+          clear_rates_empty(tariff)
+
         raise_rate_events(current,
                           private_rates_to_public_rates(new_rates),
                           { "mprn": target_mprn, "serial_number": target_serial_number, "tariff_code": tariff.code },
@@ -168,7 +175,9 @@ async def async_update_gas_rates_data():
       rates,
       hass.bus.async_fire,
       lambda: async_raise_no_active_tariff(hass, account_id, target_mprn, target_serial_number),
-      lambda: async_remove_no_active_tariff(hass, target_mprn, target_serial_number)
+      lambda: async_remove_no_active_tariff(hass, target_mprn, target_serial_number),
+      lambda tariff: raise_rates_empty(hass, account_id, tariff, target_mprn, target_serial_number, False),
+      lambda tariff: clear_rates_empty(hass, account_id, tariff)
     )
 
     return hass.data[DOMAIN][account_id][key]

custom_components/octopus_energy/translations/en.json

@@ -407,6 +407,10 @@
     "meter_added": {
       "title": "{meter_type} meter added for {account_id} ({mprn_mpan}/{serial_number})",
       "description": "A new meter has been found for your account which has an active tariff. Please reload the integration to start using this meter and associated entities."
+    },
+    "tariff_rates_empty": {
+      "title": "{meter_type} {tariff_code} rates are empty for {account_id} ({mprn_mpan}/{serial_number})",
+      "description": "One of your meters ({mprn_mpan}/{serial_number}) is associated with tariff \"{tariff_code}\" for product \"{product_code}\", but no longer seems to be returning new rates. Please click \"Learn More\" with details on how to rectify this."
     }
   }
 }

mkdocs.yml

@@ -34,6 +34,7 @@ nav:
     - ./repairs/unknown_intelligent_provider.md
     - ./repairs/no_active_tariff.md
     - ./repairs/meter_removed.md
+    - ./repairs/tariff_rates_empty.md
   - Community: community.md
   - blueprints.md
   - faq.md