Fix persisting with_solar, and use it on startup.

Author: jmattsson

custom_components/powersensor/__init__.py

@@ -10,11 +10,26 @@
 
 from .PowersensorDiscoveryService import PowersensorDiscoveryService
 from .PowersensorMessageDispatcher import PowersensorMessageDispatcher
+from .config_flow import PowersensorConfigFlow
 from .const import DOMAIN
 _LOGGER = logging.getLogger(__name__)
 
 PLATFORMS: list[Platform] = [Platform.SENSOR]
 
+#
+# config entry.data structure (version 2.1):
+#   {
+#     devices = {
+#       mac = {
+#         name =,
+#         display_name =,
+#         mac =,
+#         host =,
+#         port =,
+#     }
+#     with_solar =,
+#   }
+#
 
 async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     """Set up integration from a config entry."""
@@ -30,14 +45,14 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     await zeroconf_service.start()
 
     # Establish our virtual household
-    vhh = VirtualHousehold(False)
+    vhh = VirtualHousehold(entry.data['with_solar'])
 
-
-    # TODO: can we move the dispatcher into the entry.runtime_data dict?
+    # Set up message dispatcher
     dispatcher = PowersensorMessageDispatcher(hass, vhh)
-    for mac, network_info in entry.data.items():
+    for mac, network_info in entry.data['devices'].items():
         await dispatcher.enqueue_plug_for_adding(network_info)
 
+
     entry.runtime_data = { "vhh": vhh , "dispatcher" : dispatcher, "zeroconf" : zeroconf_service}
     await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
     return True
@@ -52,5 +67,24 @@ async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
         if "zeroconf" in entry.runtime_data .keys():
             await entry.runtime_data["zeroconf"].stop()
 
+    hass.data[DOMAIN].pop(entry.entry_id)
+
     return unload_ok
 
+
+async def async_migrate_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
+    """Migrate old config entry."""
+    _LOGGER.debug("Upgrading config from %s.%s", entry.version, entry.minor_version)
+    if entry.version > PowersensorConfigFlow.VERSION:
+        # Downgrade from future version
+        return False
+
+    if entry.version == 1:
+        # Move device info into subkey, add with_solar key
+        devices = { **entry.data }
+        new_data = { 'devices': devices, 'with_solar': False }
+        hass.config_entries.async_update_entry(entry, data=new_data, version=2, minor_version=1)
+
+    _LOGGER.debug("Upgrading config to %s.%s", entry.version, entry.minor_version)
+    return True
+

custom_components/powersensor/config_flow.py

@@ -50,7 +50,7 @@ def _extract_device_name(discovery_info) -> str:
 class PowersensorConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
     """Handle a config flow."""
 
-    VERSION = 1
+    VERSION = 2
 
     def __init__(self):
         """Initialize the config flow."""
@@ -142,6 +142,9 @@ async def async_step_discovery_confirm(
             _LOGGER.debug(self.hass.data[DOMAIN]["discovered_plugs"])
             return self.async_create_entry(
                 title="Powersensor",
-                data=self.hass.data[DOMAIN]["discovered_plugs"]
+                data={
+                    'devices': self.hass.data[DOMAIN]["discovered_plugs"],
+                    'with_solar': False,
+                }
             )
-        return self.async_show_form(step_id="discovery_confirm")
+        return self.async_show_form(step_id="discovery_confirm")

custom_components/powersensor/sensor.py

@@ -56,7 +56,9 @@ async def handle_discovered_plug(plug_mac_address: str, host: str, port: int, na
 
     async def handle_discovered_sensor(sensor_mac: str, sensor_role: str):
         if sensor_role == 'solar':
-            entry.runtime_data["with_solar"] = True  # Remember for next time we start
+            new_data = { **entry.data }
+            new_data['with_solar'] = True  # Remember for next time we start
+            hass.config_entries.async_update_entry(entry, data=new_data)
 
         new_sensors = [
             PowersensorSensorEntity(hass, sensor_mac, SensorMeasurements.Battery),