Change entity id to include charger. Add session sensors to connectors. Clear charger-level entities after connector creation. Add num_connector changes to reload logic. Remove not used functions from chargepoint.py. Revert to original config flow due to automatic discovery of number of connectors. Add more tests.

Author: Jan Thunqvist

custom_components/ocpp/button.py

@@ -11,10 +11,17 @@
     ButtonEntity,
     ButtonEntityDescription,
 )
+from homeassistant.helpers import entity_registry as er
 from homeassistant.helpers.entity import DeviceInfo, EntityCategory
 
 from .api import CentralSystem
-from .const import CONF_CPID, CONF_CPIDS, CONF_NUM_CONNECTORS, DOMAIN
+from .const import (
+    CONF_CPID,
+    CONF_CPIDS,
+    CONF_NUM_CONNECTORS,
+    DEFAULT_NUM_CONNECTORS,
+    DOMAIN,
+)
 from .enums import HAChargerServices
 
 
@@ -50,12 +57,32 @@ async def async_setup_entry(hass, entry, async_add_devices):
     """Configure the Button platform."""
     central_system: CentralSystem = hass.data[DOMAIN][entry.entry_id]
     entities: list[ChargePointButton] = []
+    ent_reg = er.async_get(hass)
 
     for charger in entry.data[CONF_CPIDS]:
         cp_id_settings = list(charger.values())[0]
         cpid = cp_id_settings[CONF_CPID]
 
-        num_connectors = int(cp_id_settings.get(CONF_NUM_CONNECTORS, 1) or 1)
+        num_connectors = 1
+        for item in entry.data.get(CONF_CPIDS, []):
+            for _, cfg in item.items():
+                if cfg.get(CONF_CPID) == cpid:
+                    num_connectors = int(
+                        cfg.get(CONF_NUM_CONNECTORS, DEFAULT_NUM_CONNECTORS)
+                    )
+                    break
+            else:
+                continue
+            break
+
+        if num_connectors > 1:
+            for desc in BUTTONS:
+                if not desc.per_connector:
+                    continue
+                uid_flat = ".".join([BUTTON_DOMAIN, DOMAIN, cpid, desc.key])
+                stale_eid = ent_reg.async_get_entity_id(BUTTON_DOMAIN, DOMAIN, uid_flat)
+                if stale_eid:
+                    ent_reg.async_remove(stale_eid)
 
         for desc in BUTTONS:
             if desc.per_connector:
@@ -97,7 +124,7 @@ async def async_setup_entry(hass, entry, async_add_devices):
 class ChargePointButton(ButtonEntity):
     """Individual button for charge point."""
 
-    _attr_has_entity_name = True
+    _attr_has_entity_name = False
     entity_description: OcppButtonDescription
 
     def __init__(
@@ -122,14 +149,19 @@ def __init__(
         if self.connector_id:
             self._attr_device_info = DeviceInfo(
                 identifiers={(DOMAIN, f"{cpid}-conn{self.connector_id}")},
-                name=f"Connector {self.connector_id}",
+                name=f"{cpid} Connector {self.connector_id}",
                 via_device=(DOMAIN, cpid),
             )
         else:
             self._attr_device_info = DeviceInfo(
                 identifiers={(DOMAIN, cpid)},
                 name=cpid,
             )
+        if self.connector_id is not None:
+            object_id = f"{self.cpid}_connector_{self.connector_id}_{self.entity_description.key}"
+        else:
+            object_id = f"{self.cpid}_{self.entity_description.key}"
+        self.entity_id = f"{BUTTON_DOMAIN}.{object_id}"
 
     @property
     def available(self) -> bool:

custom_components/ocpp/chargepoint.py

@@ -26,7 +26,6 @@
 from ocpp.v16 import call as callv16
 from ocpp.v16 import call_result as call_resultv16
 from ocpp.v16.enums import (
-    UnitOfMeasure,
     AuthorizationStatus,
     Measurand,
     Phase,
@@ -53,10 +52,12 @@
     CONF_DEFAULT_AUTH_STATUS,
     CONF_ID_TAG,
     CONF_MONITORED_VARIABLES,
+    CONF_NUM_CONNECTORS,
     CONF_CPIDS,
     CONFIG,
     DATA_UPDATED,
     DEFAULT_ENERGY_UNIT,
+    DEFAULT_NUM_CONNECTORS,
     DEFAULT_POWER_UNIT,
     DEFAULT_MEASURAND,
     DOMAIN,
@@ -276,15 +277,22 @@ def __init__(
 
         # Init standard metrics for connector 0
         self._metrics[(0, cdet.identifier.value)].value = id
-        self._metrics[(0, csess.session_time.value)].unit = TIME_MINUTES
-        self._metrics[(0, csess.session_energy.value)].unit = UnitOfMeasure.kwh.value
-        self._metrics[(0, csess.meter_start.value)].unit = UnitOfMeasure.kwh.value
         self._metrics[(0, cstat.reconnects.value)].value = 0
 
         self._attr_supported_features = prof.NONE
         alphabet = string.ascii_uppercase + string.digits
         self._remote_id_tag = "".join(secrets.choice(alphabet) for i in range(20))
-        self.num_connectors: int = 1
+        self.num_connectors: int = DEFAULT_NUM_CONNECTORS
+
+    def _init_connector_slots(self, conn_id: int) -> None:
+        """Ensure connector-scoped metrics exist and carry the right units."""
+        _ = self._metrics[(conn_id, cstat.status_connector.value)]
+        _ = self._metrics[(conn_id, cstat.error_code_connector.value)]
+        _ = self._metrics[(conn_id, csess.transaction_id.value)]
+
+        self._metrics[(conn_id, csess.session_time.value)].unit = TIME_MINUTES
+        self._metrics[(conn_id, csess.session_energy.value)].unit = HA_ENERGY_UNIT
+        self._metrics[(conn_id, csess.meter_start.value)].unit = HA_ENERGY_UNIT
 
     async def get_number_of_connectors(self) -> int:
         """Return number of connectors on this charger."""
@@ -320,29 +328,28 @@ async def post_connect(self):
             num_connectors: int = await self.get_number_of_connectors()
             self.num_connectors = num_connectors
             for conn in range(1, self.num_connectors + 1):
-                _ = self._metrics[(conn, cstat.status_connector.value)]
-                _ = self._metrics[(conn, cstat.error_code_connector.value)]
-                _ = self._metrics[(conn, csess.session_energy.value)]
-                _ = self._metrics[(conn, csess.meter_start.value)]
-                _ = self._metrics[(conn, csess.transaction_id.value)]
-            self._metrics[(0, cdet.connectors.value)].value = num_connectors
+                self._init_connector_slots(conn)
+            self._metrics[(0, cdet.connectors.value)].value = self.num_connectors
             await self.get_heartbeat_interval()
 
             accepted_measurands: str = await self.get_supported_measurands()
             updated_entry = {**self.entry.data}
             for i in range(len(updated_entry[CONF_CPIDS])):
                 if self.id in updated_entry[CONF_CPIDS][i]:
-                    updated_entry[CONF_CPIDS][i][self.id][CONF_MONITORED_VARIABLES] = (
-                        accepted_measurands
-                    )
+                    s = updated_entry[CONF_CPIDS][i][self.id]
+                    if s.get(CONF_MONITORED_VARIABLES) != accepted_measurands or s.get(
+                        CONF_NUM_CONNECTORS
+                    ) != int(self.num_connectors):
+                        s[CONF_MONITORED_VARIABLES] = accepted_measurands
+                        s[CONF_NUM_CONNECTORS] = int(self.num_connectors)
                     break
             # if an entry differs this will unload/reload and stop/restart the central system/websocket
             self.hass.config_entries.async_update_entry(self.entry, data=updated_entry)
 
             await self.set_standard_configuration()
 
             self.post_connect_success = True
-            _LOGGER.debug(f"'{self.id}' post connection setup completed successfully")
+            _LOGGER.debug("'%s' post connection setup completed successfully", self.id)
 
             # nice to have, but not needed for integration to function
             # and can cause issues with some chargers
@@ -822,22 +829,6 @@ def supported_features(self) -> int:
         """Flag of Ocpp features that are supported."""
         return self._attr_supported_features
 
-    def get_metric(self, measurand: str, connector_id: int = 0):
-        """Return last known value for given measurand."""
-        val = self._metrics[(connector_id, measurand)].value
-        if val is not None:
-            return val
-
-        if connector_id and connector_id > 0:
-            if measurand == cstat.status_connector.value:
-                agg = self._metrics[(0, cstat.status_connector.value)]
-                return agg.extra_attr.get(connector_id, agg.value)
-            if measurand == cstat.error_code_connector.value:
-                agg = self._metrics[(0, cstat.error_code_connector.value)]
-                return agg.extra_attr.get(connector_id, agg.value)
-
-        return None
-
     def get_ha_metric(self, measurand: str, connector_id: int | None = None):
         """Return last known value in HA for given measurand, or None if not available."""
         base = self.settings.cpid.lower()
@@ -855,30 +846,6 @@ def get_ha_metric(self, measurand: str, connector_id: int | None = None):
                 return st.state
         return None
 
-    def get_extra_attr(self, measurand: str, connector_id: int = 0):
-        """Return extra attributes for given measurand (per connector)."""
-        attrs = self._metrics[(connector_id, measurand)].extra_attr
-        if attrs:
-            return attrs
-
-        if connector_id and connector_id > 0:
-            if measurand in (
-                cstat.status_connector.value,
-                cstat.error_code_connector.value,
-            ):
-                agg = self._metrics[(0, measurand)]
-                if connector_id in agg.extra_attr:
-                    return {connector_id: agg.extra_attr[connector_id]}
-        return {}
-
-    def get_unit(self, measurand: str, connector_id: int = 0):
-        """Return unit of given measurand."""
-        return self._metrics[(connector_id, measurand)].unit
-
-    def get_ha_unit(self, measurand: str, connector_id: int = 0):
-        """Return HA unit of given measurand."""
-        return self._metrics[(connector_id, measurand)].ha_unit
-
     async def notify_ha(self, msg: str, title: str = "Ocpp integration"):
         """Notify user via HA web frontend."""
         await self.hass.services.async_call(

custom_components/ocpp/config_flow.py

@@ -20,7 +20,6 @@
     CONF_METER_INTERVAL,
     CONF_MONITORED_VARIABLES,
     CONF_MONITORED_VARIABLES_AUTOCONFIG,
-    CONF_NUM_CONNECTORS,
     CONF_PORT,
     CONF_SKIP_SCHEMA_VALIDATION,
     CONF_SSL,
@@ -40,7 +39,6 @@
     DEFAULT_METER_INTERVAL,
     DEFAULT_MONITORED_VARIABLES,
     DEFAULT_MONITORED_VARIABLES_AUTOCONFIG,
-    DEFAULT_NUM_CONNECTORS,
     DEFAULT_PORT,
     DEFAULT_SKIP_SCHEMA_VALIDATION,
     DEFAULT_SSL,
@@ -93,9 +91,6 @@
         vol.Required(
             CONF_FORCE_SMART_CHARGING, default=DEFAULT_FORCE_SMART_CHARGING
         ): bool,
-        vol.Required(CONF_NUM_CONNECTORS, default=DEFAULT_NUM_CONNECTORS): vol.All(
-            vol.Coerce(int), vol.Range(min=1)
-        ),
     }
 )
 
@@ -111,7 +106,7 @@ class ConfigFlow(ConfigFlow, domain=DOMAIN):
     """Handle a config flow for OCPP."""
 
     VERSION = 2
-    MINOR_VERSION = 1
+    MINOR_VERSION = 0
     CONNECTION_CLASS = CONN_CLASS_LOCAL_PUSH
 
     def __init__(self):

custom_components/ocpp/number.py

@@ -13,6 +13,7 @@
 )
 from homeassistant.const import UnitOfElectricCurrent
 from homeassistant.core import HomeAssistant, callback
+from homeassistant.helpers import entity_registry as er
 from homeassistant.helpers.dispatcher import async_dispatcher_connect
 from homeassistant.helpers.entity import DeviceInfo
 
@@ -24,6 +25,7 @@
     CONF_NUM_CONNECTORS,
     DATA_UPDATED,
     DEFAULT_MAX_CURRENT,
+    DEFAULT_NUM_CONNECTORS,
     DOMAIN,
     ICON,
 )
@@ -57,10 +59,31 @@ async def async_setup_entry(hass, entry, async_add_devices):
     """Configure the number platform."""
     central_system = hass.data[DOMAIN][entry.entry_id]
     entities: list[ChargePointNumber] = []
+    ent_reg = er.async_get(hass)
+
     for charger in entry.data[CONF_CPIDS]:
         cp_id_settings = list(charger.values())[0]
         cpid = cp_id_settings[CONF_CPID]
-        num_connectors = int(cp_id_settings.get(CONF_NUM_CONNECTORS, 1) or 1)
+
+        num_connectors = 1
+        for item in entry.data.get(CONF_CPIDS, []):
+            for _, cfg in item.items():
+                if cfg.get(CONF_CPID) == cpid:
+                    num_connectors = int(
+                        cfg.get(CONF_NUM_CONNECTORS, DEFAULT_NUM_CONNECTORS)
+                    )
+                    break
+            else:
+                continue
+            break
+
+        if num_connectors > 1:
+            for desc in NUMBERS:
+                uid_flat = ".".join([NUMBER_DOMAIN, DOMAIN, cpid, desc.key])
+                stale_eid = ent_reg.async_get_entity_id(NUMBER_DOMAIN, DOMAIN, uid_flat)
+                if stale_eid:
+                    ent_reg.async_remove(stale_eid)
+
         for desc in NUMBERS:
             if desc.key == "maximum_current":
                 max_cur = float(
@@ -120,7 +143,7 @@ async def async_setup_entry(hass, entry, async_add_devices):
 class ChargePointNumber(RestoreNumber, NumberEntity):
     """Individual slider for setting charge rate."""
 
-    _attr_has_entity_name = True
+    _attr_has_entity_name = False
     entity_description: OcppNumberDescription
 
     def __init__(
@@ -150,14 +173,19 @@ def __init__(
         if self.connector_id:
             self._attr_device_info = DeviceInfo(
                 identifiers={(DOMAIN, f"{cpid}-conn{self.connector_id}")},
-                name=f"Connector {self.connector_id}",
+                name=f"{cpid} Connector {self.connector_id}",
                 via_device=(DOMAIN, cpid),
             )
         else:
             self._attr_device_info = DeviceInfo(
                 identifiers={(DOMAIN, cpid)},
                 name=cpid,
             )
+        if self.connector_id is not None:
+            object_id = f"{self.cpid}_connector_{self.connector_id}_{self.entity_description.key}"
+        else:
+            object_id = f"{self.cpid}_{self.entity_description.key}"
+        self.entity_id = f"{NUMBER_DOMAIN}.{object_id}"
         self._attr_native_value = self.entity_description.initial_value
         self._attr_should_poll = False