Improve the validation and user feedback for the charge point identity (#1886)

* Update switch to push updates - not be polled

* Update HA states after connection

Ensure Home Assistant states are updated immediately after connection.

* Change async_write_ha_state to async_schedule_update_ha_state

Refactor state update method for switch entity - for consistency.

* Formatting update

* fix test errors

* Improve supported feature coding

* add TypeError guard for None

* Fix for config flow charger name

---------

Co-authored-by: drc38 <20024196+drc38@users.noreply.github.com>

Author: filmackay

custom_components/ocpp/config_flow.py

@@ -7,6 +7,7 @@
     ConfigFlowResult,
     CONN_CLASS_LOCAL_PUSH,
 )
+from homeassistant.helpers import config_validation as cv
 import voluptuous as vol
 
 from .const import (
@@ -79,10 +80,7 @@
 
 STEP_USER_CP_DATA_SCHEMA = vol.Schema(
     {
-        vol.Required(CONF_CPID, default=DEFAULT_CPID): vol.All(
-            str,
-            vol.Match(r"^[a-z0-9_$]+$", msg="Use only lower case, digits and _"),
-        ),
+        vol.Required(CONF_CPID, default=DEFAULT_CPID): str,
         vol.Required(CONF_MAX_CURRENT, default=DEFAULT_MAX_CURRENT): int,
         vol.Required(
             CONF_MONITORED_VARIABLES_AUTOCONFIG,
@@ -168,26 +166,34 @@ async def async_step_cp_user(
         if user_input is not None:
             # Don't allow duplicate cpids to be used
             self._async_abort_entries_match({CONF_CPID: user_input[CONF_CPID]})
-
-            cp_data = {
-                **user_input,
-                CONF_NUM_CONNECTORS: self._detected_num_connectors,
-            }
-            cpids_list = self._data.get(CONF_CPIDS, []).copy()
-            cpids_list.append({self._cp_id: cp_data})
-            self._data = {**self._data, CONF_CPIDS: cpids_list}
-
-            if user_input[CONF_MONITORED_VARIABLES_AUTOCONFIG]:
-                self._data[CONF_CPIDS][-1][self._cp_id][CONF_MONITORED_VARIABLES] = (
-                    DEFAULT_MONITORED_VARIABLES
-                )
-                self.hass.config_entries.async_update_entry(
-                    self._entry, data=self._data
-                )
-                return self.async_abort(reason="Added/Updated charge point")
-
+            # Validate cpid format against entity id requirements (lowercase letters, digits and _)
+            schema = vol.Schema(
+                {vol.Required(CONF_CPID): cv.matches_regex(r"^[\da-z_]+$")}
+            )
+            try:
+                schema({CONF_CPID: user_input[CONF_CPID]})
+            except vol.Invalid:
+                errors["base"] = "invalid_cpid"
             else:
-                return await self.async_step_measurands()
+                cp_data = {
+                    **user_input,
+                    CONF_NUM_CONNECTORS: self._detected_num_connectors,
+                }
+                cpids_list = self._data.get(CONF_CPIDS, []).copy()
+                cpids_list.append({self._cp_id: cp_data})
+                self._data = {**self._data, CONF_CPIDS: cpids_list}
+
+                if user_input[CONF_MONITORED_VARIABLES_AUTOCONFIG]:
+                    self._data[CONF_CPIDS][-1][self._cp_id][
+                        CONF_MONITORED_VARIABLES
+                    ] = DEFAULT_MONITORED_VARIABLES
+                    self.hass.config_entries.async_update_entry(
+                        self._entry, data=self._data
+                    )
+                    return self.async_abort(reason="Added/Updated charge point")
+
+                else:
+                    return await self.async_step_measurands()
 
         return self.async_show_form(
             step_id="cp_user",

custom_components/ocpp/translations/en.json

@@ -61,7 +61,8 @@
         },
         "error": {
             "auth": "Username/Password is wrong.",
-            "no_measurands_selected": "No measurand selected: please select at least one"
+            "no_measurands_selected": "No measurand selected: please select at least one",
+            "invalid_cpid": "Invalid charge point identity name: use only lower case letters, digits and _"
         },
         "abort": {
             "single_instance_allowed": "Only a single instance is allowed",

custom_components/ocpp/translations/i-default.json

@@ -61,7 +61,8 @@
         },
         "error": {
             "auth": "Username/Password is wrong.",
-            "no_measurands_selected": "No measurand selected: please select at least one"
+            "no_measurands_selected": "No measurand selected: please select at least one",
+            "invalid_cpid": "Invalid charge point identity name: use only lower case letters, digits and _"
         },
         "abort": {
             "single_instance_allowed": "Only a single instance is allowed",