Chore/refactor (#17)

* Remove unnecessary title field

As per hassfest warning.

* Refactor & simplify dynamic household entity handling

Also avoid getting with_solar/with_mains out of sync by changing to
pulling that knowledge from the known device roles instead. This also
addresses the issue of not being able to go back to a mains-only
install as there was no way of clearing with_solar. There is no
support for removing already created household entities yet however.

Switched more strings over to const.py imports to ensure consistency and
reduce risk of typos.

---------

Co-authored-by: Jade Mattsson <github@frozenlogic.org>

Author: bookman-dius

custom_components/powersensor/PowersensorMessageDispatcher.py

@@ -10,6 +10,10 @@
 
 from custom_components.powersensor.AsyncSet import AsyncSet
 from custom_components.powersensor.const import (
+    # Used config entry fields
+    CFG_ROLES,
+
+    # Used signals
     CREATE_PLUG_SIGNAL,
     CREATE_SENSOR_SIGNAL,
     DATA_UPDATE_SIGNAL_FMT_MAC_EVENT,
@@ -173,7 +177,7 @@ async def handle_relaying_for(self, event: str, message: dict):
             _LOGGER.warning(f"Ignoring relayed device with MAC \"{mac}\" and type {device_type}")
             return
 
-        persisted_role = self._entry.data.get('roles', {}).get(mac, None)
+        persisted_role = self._entry.data.get(CFG_ROLES, {}).get(mac, None)
         role = message.get('role', None)
         _LOGGER.debug(f"Relayed sensor {mac} with role {role} found")
 
@@ -187,7 +191,7 @@ async def handle_relaying_for(self, event: str, message: dict):
 
     async def handle_message(self, event: str, message: dict):
         mac = message['mac']
-        persisted_role = self._entry.data.get('roles', {}).get(mac, None)
+        persisted_role = self._entry.data.get(CFG_ROLES, {}).get(mac, None)
         role = message.get('role', persisted_role)
         message['role'] = role
 

custom_components/powersensor/__init__.py

@@ -11,13 +11,22 @@
 from .PowersensorDiscoveryService import PowersensorDiscoveryService
 from .PowersensorMessageDispatcher import PowersensorMessageDispatcher
 from .config_flow import PowersensorConfigFlow
-from .const import DOMAIN
+from .const import (
+    CFG_DEVICES,
+    CFG_ROLES,
+    DOMAIN,
+    ROLE_SOLAR,
+    RT_VHH,
+    RT_DISPATCHER,
+    RT_ZEROCONF,
+)
+
 _LOGGER = logging.getLogger(__name__)
 
 PLATFORMS: list[Platform] = [Platform.SENSOR]
 
 #
-# config entry.data structure (version 2.1):
+# config entry.data structure (version 2.2):
 #   {
 #     devices = {
 #       mac = {
@@ -27,7 +36,6 @@
 #         host =,
 #         port =,
 #     }
-#     with_solar =,
 #     roles = {
 #       mac = role,
 #     }
@@ -41,22 +49,26 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     hass.data[DOMAIN][entry.entry_id] = {}
 
     integration = await async_get_integration(hass, DOMAIN)
-    manifest  = integration.manifest
+    manifest = integration.manifest
 
     # Establish create the zeroconf discovery service
-    zeroconf_service= PowersensorDiscoveryService(hass, manifest["zeroconf"][0])
+    zeroconf_service = PowersensorDiscoveryService(hass, manifest["zeroconf"][0])
     await zeroconf_service.start()
 
     # Establish our virtual household
-    vhh = VirtualHousehold(entry.data['with_solar'])
+    with_solar = ROLE_SOLAR in entry.data.get(CFG_ROLES, {}).values()
+    vhh = VirtualHousehold(with_solar)
 
     # Set up message dispatcher
     dispatcher = PowersensorMessageDispatcher(hass, entry, vhh)
-    for mac, network_info in entry.data['devices'].items():
+    for mac, network_info in entry.data.get(CFG_DEVICES, {}).items():
         await dispatcher.enqueue_plug_for_adding(network_info)
 
-
-    entry.runtime_data = { "vhh": vhh , "dispatcher" : dispatcher, "zeroconf" : zeroconf_service}
+    entry.runtime_data = {
+        RT_VHH: vhh,
+        RT_DISPATCHER: dispatcher,
+        RT_ZEROCONF: zeroconf_service
+    }
     await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
     return True
 
@@ -65,10 +77,10 @@ async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     """Unload a config entry."""
     _LOGGER.debug("Started unloading for %s", entry.entry_id)
     if unload_ok := await hass.config_entries.async_unload_platforms(entry, PLATFORMS):
-        if "dispatcher" in entry.runtime_data .keys():
-            await entry.runtime_data["dispatcher"].disconnect()
-        if "zeroconf" in entry.runtime_data .keys():
-            await entry.runtime_data["zeroconf"].stop()
+        if RT_DISPATCHER in entry.runtime_data.keys():
+            await entry.runtime_data[RT_DISPATCHER].disconnect()
+        if RT_ZEROCONF in entry.runtime_data.keys():
+            await entry.runtime_data[RT_ZEROCONF].stop()
 
     hass.data[DOMAIN].pop(entry.entry_id)
 
@@ -83,10 +95,10 @@ async def async_migrate_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
         return False
 
     if entry.version == 1:
-        # Move device info into subkey, add with_solar key
+        # Move device info into subkey
         devices = { **entry.data }
-        new_data = { 'devices': devices, 'with_solar': False, 'with_mains': False, 'roles': {} }
-        hass.config_entries.async_update_entry(entry, data=new_data, version=2, minor_version=1)
+        new_data = { CFG_DEVICES: devices, CFG_ROLES: {} }
+        hass.config_entries.async_update_entry(entry, data=new_data, version=2, minor_version=2)
 
     _LOGGER.debug("Upgrading config to %s.%s", entry.version, entry.minor_version)
     return True

custom_components/powersensor/config_flow.py

@@ -9,7 +9,24 @@
 from homeassistant.helpers.service_info import zeroconf
 from homeassistant.helpers.selector import selector
 
-from .const import DEFAULT_PORT, DOMAIN, ROLE_UPDATE_SIGNAL, SENSOR_NAME_FORMAT
+from .const import (
+    CFG_DEVICES,
+    CFG_ROLES,
+
+    DEFAULT_PORT,
+    DOMAIN,
+
+    ROLE_APPLIANCE,
+    ROLE_HOUSENET,
+    ROLE_SOLAR,
+    ROLE_WATER,
+
+    ROLE_UPDATE_SIGNAL,
+
+    RT_DISPATCHER,
+
+    SENSOR_NAME_FORMAT,
+)
 
 def _extract_device_name(discovery_info) -> str:
     """Extract a user-friendly device name from zeroconf info."""
@@ -53,7 +70,7 @@ def __init__(self):
 
     async def async_step_reconfigure(self, user_input: dict | None = None)->FlowResult:
         entry = self.hass.config_entries.async_get_entry(self.context["entry_id"])
-        dispatcher = entry.runtime_data["dispatcher"]
+        dispatcher = entry.runtime_data[RT_DISPATCHER]
 
         mac2name = { mac: SENSOR_NAME_FORMAT % mac for mac in dispatcher.sensors }
 
@@ -70,12 +87,13 @@ async def async_step_reconfigure(self, user_input: dict | None = None)->FlowResu
 
         sensor_roles = {}
         for sensor_mac in dispatcher.sensors:
-            role = entry.data.get('roles', {}).get(sensor_mac, unknown)
+            role = entry.data.get(CFG_ROLES, {}).get(sensor_mac, unknown)
             sel = selector({
                 "select": {
                     "options": [
                         # Note: these strings are NOT subject to translation
-                        "house-net", "solar", "water", "appliance", unknown
+                        ROLE_HOUSENET, ROLE_SOLAR, ROLE_WATER, ROLE_APPLIANCE,
+                        unknown
                     ],
                     "mode": "dropdown",
                 }
@@ -154,9 +172,8 @@ async def async_step_confirm(self, step_id :str, user_input: dict[str, Any] | No
             return self.async_create_entry(
                 title="Powersensor",
                 data={
-                    'devices': self.hass.data[DOMAIN]["discovered_plugs"],
-                    'with_solar': False,
-                    'roles': {},
+                    CFG_DEVICES: self.hass.data[DOMAIN]["discovered_plugs"],
+                    CFG_ROLES: {},
                 }
             )
         return self.async_show_form(step_id=step_id)
@@ -171,4 +188,4 @@ async def async_step_manual_confirm(
         self, user_input: dict[str, Any] | None = None
     ) -> ConfigFlowResult:
 
-        return await self.async_step_confirm(step_id="manual_confirm", user_input=user_input)
+        return await self.async_step_confirm(step_id="manual_confirm", user_input=user_input)

custom_components/powersensor/const.py

@@ -5,17 +5,35 @@
 DEFAULT_PORT = 49476
 DEFAULT_SCAN_INTERVAL = 30
 
+# Internal signals
 CREATE_PLUG_SIGNAL = f"{DOMAIN}_create_plug"
 CREATE_SENSOR_SIGNAL = f"{DOMAIN}_create_sensor"
 DATA_UPDATE_SIGNAL_FMT_MAC_EVENT = f"{DOMAIN}_data_update_%s_%s"
-HAVE_SOLAR_SENSOR_SIGNAL = f"{DOMAIN}_have_solar_sensor"
-HAVE_MAINS_SENSOR_SIGNAL = f"{DOMAIN}_have_mains_sensor"
 ROLE_UPDATE_SIGNAL = f"{DOMAIN}_update_role"
 PLUG_ADDED_TO_HA_SIGNAL = f"{DOMAIN}_plug_added_to_homeassistant"
 SENSOR_ADDED_TO_HA_SIGNAL = f"{DOMAIN}_sensor_added_to_homeassistant"
+UPDATE_VHH_SIGNAL = f"{DOMAIN}_update_vhh"
 ZEROCONF_ADD_PLUG_SIGNAL = f"{DOMAIN}_zeroconf_add_plug"
 ZEROCONF_REMOVE_PLUG_SIGNAL = f"{DOMAIN}_zeroconf_remove_plug"
 ZEROCONF_UPDATE_PLUG_SIGNAL = f"{DOMAIN}_zeroconf_update_plug"
 
-
+# Formatting, would've liked to have been able to have this translatable
 SENSOR_NAME_FORMAT = "Powersensor Sensor (ID: %s) ⚡"
+
+# Config entry keys
+CFG_DEVICES = "devices"
+CFG_ROLES = "roles"
+
+# Role names (fixed, as-received from plug API)
+ROLE_APPLIANCE = "appliance"
+ROLE_HOUSENET = "house-net"
+ROLE_SOLAR = "solar"
+ROLE_WATER = "water"
+
+# runtime_data keys
+RT_DISPATCHER = "dispatcher"
+RT_VHH = "vhh"
+RT_VHH_LOCK = "vhh_update_lock"
+RT_VHH_MAINS_ADDED = "vhh_main_added"
+RT_VHH_SOLAR_ADDED = "vhh_solar_added"
+RT_ZEROCONF = "zeroconf"