Put accumulative energy usage sensor behind an option

Author: dan-r

README.md

@@ -60,8 +60,8 @@ This integration exposes the following entities:
     * Next Charge Slot End - The next time your car will stop charging according to the Ohme-generated charge plan
 * Sensors (Other)
     * CT Reading (Amps) - Reading from attached CT clamp
-    * Accumulative Energy Usage (kWh) - Total energy used by the charger
     * Session Energy Usage (kWh) - Energy used in the current session
+    * Accumulative Energy Usage (kWh) - Total energy used by the charger (If enabled in options)
     * Battery State of Charge (%) - If your car is API connected this is read from the car, if not it is how much charge Ohme thinks it has added
 * Switches (Settings) - **Only options available to your charger model will show**
     * Lock Buttons - Locks buttons on charger
@@ -84,6 +84,7 @@ This integration exposes the following entities:
 ## Options
 Some options can be set from the 'Configure' menu in Home Assistant:
 * Never update an ongoing session - Override the default behaviour of the target time, percentage and preconditioning inputs and only ever update the schedule, not the current session. This was added as changing the current session can cause issues for customers on Intelligent Octopus Go.
+* Enable accumulative energy usage sensor - Enable the sensor showing an all-time incrementing energy usage counter. This causes issues with some accounts. 
 
 
 ## Coordinators

custom_components/ohme/__init__.py

@@ -1,6 +1,7 @@
 import logging
 from homeassistant import core
 from .const import *
+from .utils import get_option
 from .api_client import OhmeApiClient
 from .coordinator import OhmeChargeSessionsCoordinator, OhmeStatisticsCoordinator, OhmeAccountInfoCoordinator, OhmeAdvancedSettingsCoordinator, OhmeChargeSchedulesCoordinator
 from homeassistant.exceptions import ConfigEntryNotReady
@@ -25,12 +26,9 @@ async def async_setup_dependencies(hass, entry):
 
 async def async_update_listener(hass, entry):
     """Handle options flow credentials update."""
-    # Re-instantiate the API client
-    await async_setup_dependencies(hass, entry)
-
-    # Refresh all coordinators for good measure
-    for coordinator in hass.data[DOMAIN][DATA_COORDINATORS]:
-        await coordinator.async_refresh()
+    
+    # Reload this instance
+    await hass.config_entries.async_reload(entry.entry_id)
 
 
 async def async_setup_entry(hass, entry):
@@ -53,7 +51,24 @@ async def async_setup_entry(hass, entry):
         OhmeAdvancedSettingsCoordinator
     ]
 
+    coordinators_skipped = []
+
+    # Skip statistics coordinator if we don't need it
+    if not get_option(hass, "enable_accumulative_energy"):
+        coordinators_skipped.append(OhmeStatisticsCoordinator)
+
     for coordinator in coordinators:
+        # If we should skip this coordinator
+        skip = False
+        for skipped in coordinators_skipped:
+            if isinstance(coordinator, skipped):
+                skip = True
+                break
+        
+        if skip:
+            _LOGGER.debug(f"Skipping initial load of {coordinator.__class__.__name__}")
+            continue
+
         # Catch failures if this is an 'optional' coordinator
         try:
             await coordinator.async_config_entry_first_refresh()

custom_components/ohme/config_flow.py

@@ -86,6 +86,9 @@ async def async_step_init(self, options):
                         ): str,
                         vol.Required(
                             "never_session_specific", default=self._config_entry.options.get("never_session_specific", False)
+                        ) : bool,
+                        vol.Required(
+                            "enable_accumulative_energy", default=self._config_entry.options.get("enable_accumulative_energy", False)
                         ) : bool
                     }), errors=errors
         )

custom_components/ohme/sensor.py

@@ -17,7 +17,7 @@
 from homeassistant.util.dt import (utcnow)
 from .const import DOMAIN, DATA_CLIENT, DATA_COORDINATORS, DATA_SLOTS, COORDINATOR_CHARGESESSIONS, COORDINATOR_STATISTICS, COORDINATOR_ADVANCED
 from .coordinator import OhmeChargeSessionsCoordinator, OhmeStatisticsCoordinator, OhmeAdvancedSettingsCoordinator
-from .utils import charge_graph_next_slot, charge_graph_slot_list
+from .utils import charge_graph_next_slot, charge_graph_slot_list, get_option
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -39,11 +39,13 @@ async def async_setup_entry(
                VoltageSensor(coordinator, hass, client),
                CTSensor(adv_coordinator, hass, client),
                EnergyUsageSensor(coordinator, hass, client),
-               AccumulativeEnergyUsageSensor(stats_coordinator, hass, client),
                NextSlotEndSensor(coordinator, hass, client),
                NextSlotStartSensor(coordinator, hass, client),
                SlotListSensor(coordinator, hass, client),
                BatterySOCSensor(coordinator, hass, client)]
+    
+    if get_option(hass, "enable_accumulative_energy"):
+        sensors.append(AccumulativeEnergyUsageSensor(stats_coordinator, hass, client))
 
     async_add_entities(sensors, update_before_add=True)
 

custom_components/ohme/translations/en.json

@@ -22,7 +22,8 @@
         "data": {
           "email": "Email address",
           "password": "Password",
-          "never_session_specific": "Never update an ongoing session"
+          "never_session_specific": "Never update an ongoing session",
+          "enable_accumulative_energy": "Enable accumulative energy sensor"
         },
         "data_description": {
           "password": "If you are not changing your credentials, leave the password field empty.",

custom_components/ohme/utils.py

@@ -199,6 +199,6 @@ def session_in_progress(hass, data):
     return True
 
 
-def get_option(hass, option):
-    """Return option value, default to False."""
-    return hass.data[DOMAIN][DATA_OPTIONS].get(option, None)
+def get_option(hass, option, default=False):
+    """Return option value, with settable default."""
+    return hass.data[DOMAIN][DATA_OPTIONS].get(option, default)