Add device prefix to new installs only

Author: cayossarian

custom_components/span_panel/binary_sensor.py

@@ -15,7 +15,7 @@
 from homeassistant.helpers.update_coordinator import CoordinatorEntity
 
 from .const import (COORDINATOR, DOMAIN, SYSTEM_DOOR_STATE_CLOSED,
-                    SYSTEM_DOOR_STATE_OPEN)
+                    SYSTEM_DOOR_STATE_OPEN, USE_DEVICE_PREFIX)
 from .coordinator import SpanPanelCoordinator
 from .span_panel import SpanPanel
 from .span_panel_hardware_status import SpanPanelHardwareStatus
@@ -82,11 +82,22 @@ def __init__(
         span_panel: SpanPanel = data_coordinator.data
 
         self.entity_description = description
-        self._attr_name = f"{description.name}"
+        device_info = panel_to_device_info(span_panel)
+        self._attr_device_info = device_info
+        base_name = f"{description.name}"
+        
+        if (data_coordinator.config_entry is not None and 
+            data_coordinator.config_entry.options.get(USE_DEVICE_PREFIX, False) and 
+            device_info is not None and 
+            isinstance(device_info, dict) and 
+            "name" in device_info):
+            self._attr_name = f"{device_info['name']} {base_name}"
+        else:
+            self._attr_name = base_name
+            
         self._attr_unique_id = (
             f"span_{span_panel.status.serial_number}_{description.key}"
         )
-        self._attr_device_info = panel_to_device_info(span_panel)
 
         _LOGGER.debug("CREATE BINSENSOR [%s]", self._attr_name)
 

custom_components/span_panel/config_flow.py

@@ -17,7 +17,7 @@
 from homeassistant.helpers.httpx_client import get_async_client
 from homeassistant.util.network import is_ipv4_address
 
-from .const import DEFAULT_SCAN_INTERVAL, DOMAIN
+from .const import DEFAULT_SCAN_INTERVAL, DOMAIN, USE_DEVICE_PREFIX
 from .options import (BATTERY_ENABLE, INVERTER_ENABLE, INVERTER_LEG1,
                       INVERTER_LEG2)
 from .span_panel_api import SpanPanelApi
@@ -334,7 +334,14 @@ def create_new_entry(
         Creates a new SPAN panel entry.
         """
         return self.async_create_entry(
-            title=serial_number, data={CONF_HOST: host, CONF_ACCESS_TOKEN: access_token}
+            title=serial_number, 
+            data={
+                CONF_HOST: host, 
+                CONF_ACCESS_TOKEN: access_token
+            },
+            options={
+                USE_DEVICE_PREFIX: True  # Only set for new installations
+            }
         )
 
     def update_existing_entry(
@@ -407,6 +414,10 @@ async def async_step_init(
     ) -> ConfigFlowResult:
         """Manage the options."""
         if user_input is not None:
+            # Preserve the USE_DEVICE_PREFIX setting from the original entry
+            use_prefix = self.entry.options.get(USE_DEVICE_PREFIX, False)
+            if use_prefix:
+                user_input[USE_DEVICE_PREFIX] = use_prefix
             return self.async_create_entry(title="", data=user_input)
 
         defaults = {

custom_components/span_panel/const.py

@@ -46,6 +46,7 @@
 MAIN_RELAY_STATE = "mainRelayState"
 
 PANEL_MAIN_RELAY_STATE_UNKNOWN_VALUE = "UNKNOWN"
+USE_DEVICE_PREFIX = "use_device_prefix"
 
 DEFAULT_SCAN_INTERVAL = timedelta(seconds=15)
 API_TIMEOUT = 30

custom_components/span_panel/select.py

@@ -9,7 +9,7 @@
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
 from homeassistant.helpers.update_coordinator import CoordinatorEntity
 
-from .const import COORDINATOR, DOMAIN, CircuitPriority
+from .const import COORDINATOR, DOMAIN, USE_DEVICE_PREFIX, CircuitPriority
 from .coordinator import SpanPanelCoordinator
 from .span_panel import SpanPanel
 from .util import panel_to_device_info
@@ -37,7 +37,10 @@ def __init__(self, coordinator: SpanPanelCoordinator, id: str, name: str) -> Non
     def name(self):
         """Return the switch name."""
         span_panel: SpanPanel = self.coordinator.data
-        return f"{span_panel.circuits[self.id].name} Circuit Priority"
+        base_name = f"{span_panel.circuits[self.id].name} Circuit Priority"
+        if self.coordinator.config_entry.options.get(USE_DEVICE_PREFIX, False):
+            return f"{self._attr_device_info['name']} {base_name}"
+        return base_name
 
     @cached_property
     def options(self) -> list[str]:

custom_components/span_panel/sensor.py

@@ -19,7 +19,8 @@
 from .const import (CIRCUITS_ENERGY_CONSUMED, CIRCUITS_ENERGY_PRODUCED,
                     CIRCUITS_POWER, COORDINATOR, CURRENT_RUN_CONFIG, DOMAIN,
                     DSM_GRID_STATE, DSM_STATE, MAIN_RELAY_STATE,
-                    STATUS_SOFTWARE_VER, STORAGE_BATTERY_PERCENTAGE)
+                    STATUS_SOFTWARE_VER, STORAGE_BATTERY_PERCENTAGE,
+                    USE_DEVICE_PREFIX)
 from .coordinator import SpanPanelCoordinator
 from .options import BATTERY_ENABLE, INVERTER_ENABLE
 from .span_panel import SpanPanel
@@ -258,11 +259,22 @@ def __init__(
         """Initialize Span Panel Sensor base entity."""
         super().__init__(data_coordinator, context=description)
         self.entity_description = description
-        self._attr_name = f"{description.name}"
+        device_info = panel_to_device_info(span_panel)
+        self._attr_device_info = device_info
+        base_name = f"{description.name}"
+        
+        if (data_coordinator.config_entry is not None and 
+            data_coordinator.config_entry.options.get(USE_DEVICE_PREFIX, False) and 
+            device_info is not None and 
+            isinstance(device_info, dict) and 
+            "name" in device_info):
+            self._attr_name = f"{device_info['name']} {base_name}"
+        else:
+            self._attr_name = base_name
+            
         self._attr_unique_id = (
             f"span_{span_panel.status.serial_number}_{description.key}"
         )
-        self._attr_device_info = panel_to_device_info(span_panel)
 
         _LOGGER.debug("CREATE SENSOR SPAN [%s]", self._attr_name)
 
@@ -298,9 +310,15 @@ def __init__(
         span_panel: SpanPanel,
     ) -> None:
         """Initialize Span Panel Circuit entity."""
-        super().__init__(coordinator, description, span_panel)
+        # Create a new description with modified name including circuit name
+        circuit_description = SpanPanelCircuitsSensorEntityDescription(
+            **{
+                **vars(description),
+                "name": f"{name} {description.name}"
+            }
+        )
+        super().__init__(coordinator, circuit_description, span_panel)
         self.id = circuit_id
-        self._attr_name = f"{name} {description.name}"
         self._attr_unique_id = (
             f"span_{span_panel.status.serial_number}_{circuit_id}_{description.key}"
         )

custom_components/span_panel/span_panel.py

@@ -45,7 +45,7 @@ def __init__(
         async_client: httpx.AsyncClient | None = None,
     ) -> None:
         """Initialize the Span Panel."""
-        self._options = options  # Make it protected
+        self._options = options
         self.api = SpanPanelApi(host, access_token, options, async_client)
         self._status: SpanPanelHardwareStatus | None = None
         self._panel: SpanPanelData | None = None
@@ -56,19 +56,19 @@ def _get_hardware_status(self) -> SpanPanelHardwareStatus:
         """Get hardware status with type checking."""
         if self._status is None:
             raise RuntimeError("Hardware status not available")
-        return deepcopy(self._status)  # Return copy for thread safety
+        return deepcopy(self._status)
 
     def _get_data(self) -> SpanPanelData:
         """Get data with type checking."""
         if self._panel is None:
             raise RuntimeError("Panel data not available") 
-        return deepcopy(self._panel)  # Return copy for thread safety
+        return deepcopy(self._panel)
 
     def _get_storage_battery(self) -> SpanPanelStorageBattery:
         """Get storage battery with type checking."""
         if self._storage_battery is None:
             raise RuntimeError("Storage battery not available")
-        return deepcopy(self._storage_battery)  # Return copy for thread safety
+        return deepcopy(self._storage_battery)
 
     @property
     def host(self) -> str:

custom_components/span_panel/switch.py

@@ -10,7 +10,7 @@
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
 from homeassistant.helpers.update_coordinator import CoordinatorEntity
 
-from .const import COORDINATOR, DOMAIN, CircuitRelayState
+from .const import COORDINATOR, DOMAIN, USE_DEVICE_PREFIX, CircuitRelayState
 from .coordinator import SpanPanelCoordinator
 from .span_panel import SpanPanel
 from .util import panel_to_device_info
@@ -74,7 +74,10 @@ def icon(self):
     def name(self):
         """Return the switch name."""
         span_panel: SpanPanel = self.coordinator.data
-        return f"{span_panel.circuits[self.id].name} Breaker"
+        base_name = f"{span_panel.circuits[self.id].name} Breaker"
+        if self.coordinator.config_entry.options.get(USE_DEVICE_PREFIX, False):
+            return f"{self._attr_device_info['name']} {base_name}"
+        return base_name
 
     @property
     def is_on(self) -> bool | None: