Merge pull request #319 from sgryphon/bugfix/318-update-unit-id-label

Bugfix 318: Update unit id label

Author: CJNE

.devcontainer/devcontainer.json

@@ -1,28 +1,38 @@
 // See https://aka.ms/vscode-remote/devcontainer.json for format details.
 {
-  "image": "ludeeus/container:integration-debian",
+  "image": "mcr.microsoft.com/devcontainers/python:3.13",
   "name": "SunSpec integration development",
-  "context": "..",
-  "appPort": ["9123:8123"],
-  "postCreateCommand": "container install",
-  "extensions": [
-    "ms-python.python",
-    "github.vscode-pull-request-github",
-    "ryanluker.vscode-coverage-gutters",
-    "ms-python.vscode-pylance"
-  ],
-  "settings": {
-    "files.eol": "\n",
-    "editor.tabSize": 4,
-    "terminal.integrated.shell.linux": "/bin/bash",
-    "python.pythonPath": "/usr/bin/python3",
-    "python.analysis.autoSearchPaths": false,
-    "python.linting.pylintEnabled": true,
-    "python.linting.enabled": true,
-    "python.formatting.provider": "black",
-    "editor.formatOnPaste": false,
-    "editor.formatOnSave": true,
-    "editor.formatOnType": true,
-    "files.trimTrailingWhitespace": true
+  "postCreateCommand": "scripts/setup",
+  "forwardPorts": [8123],
+  "portsAttributes": {
+    "8123": {
+      "label": "Home Assistant",
+      "onAutoForward": "notify"
+    }
+  },
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "charliermarsh.ruff",
+        "github.vscode-pull-request-github",
+        "ms-python.python",
+        "ms-python.vscode-pylance",
+        "ryanluker.vscode-coverage-gutters"
+      ],
+      "settings": {
+        "files.eol": "\n",
+        "editor.tabSize": 4,
+        "editor.formatOnPaste": true,
+        "editor.formatOnSave": true,
+        "editor.formatOnType": false,
+        "files.trimTrailingWhitespace": true,
+        "python.analysis.typeCheckingMode": "basic",
+        "python.analysis.autoImportCompletions": true,
+        "python.defaultInterpreterPath": "/usr/local/bin/python",
+        "[python]": {
+          "editor.defaultFormatter": "charliermarsh.ruff"
+        }
+      }
+    }
   }
 }

.gitignore

@@ -5,3 +5,4 @@ pythonenv*
 venv
 .venv
 .direnv
+*.code-workspace

.vscode/settings.json

@@ -4,5 +4,8 @@
   "python.pythonPath": "venv/bin/python",
   "files.associations": {
     "*.yaml": "home-assistant"
-  }
+  },
+  "python.testing.pytestArgs": [],
+  "python.testing.unittestEnabled": false,
+  "python.testing.pytestEnabled": true
 }

custom_components/sunspec/__init__.py

@@ -20,7 +20,7 @@
 from .const import CONF_HOST
 from .const import CONF_PORT
 from .const import CONF_SCAN_INTERVAL
-from .const import CONF_SLAVE_ID
+from .const import CONF_UNIT_ID
 from .const import DEFAULT_MODELS
 from .const import DOMAIN
 from .const import PLATFORMS
@@ -44,9 +44,9 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry):
 
     host = entry.data.get(CONF_HOST)
     port = entry.data.get(CONF_PORT)
-    slave_id = entry.data.get(CONF_SLAVE_ID, 1)
+    unit_id = entry.data.get(CONF_UNIT_ID, 1)
 
-    client = SunSpecApiClient(host, port, slave_id, hass)
+    client = SunSpecApiClient(host, port, unit_id, hass)
 
     _LOGGER.debug("Setup conifg entry for SunSpec")
     coordinator = SunSpecDataUpdateCoordinator(hass, client=client, entry=entry)
@@ -117,7 +117,7 @@ def __init__(self, hass: HomeAssistant, client: SunSpecApiClient, entry) -> None
             scan_interval,
             entry.data.get(CONF_HOST),
             entry.data.get(CONF_PORT),
-            entry.data.get(CONF_SLAVE_ID),
+            entry.data.get(CONF_UNIT_ID),
         )
         super().__init__(hass, _LOGGER, name=DOMAIN, update_interval=scan_interval)
 

custom_components/sunspec/api.py

@@ -97,17 +97,15 @@ def progress(msg):
 class SunSpecApiClient:
     CLIENT_CACHE = {}
 
-    def __init__(
-        self, host: str, port: int, slave_id: int, hass: HomeAssistant
-    ) -> None:
+    def __init__(self, host: str, port: int, unit_id: int, hass: HomeAssistant) -> None:
         """Sunspec modbus client."""
 
         _LOGGER.debug("New SunspecApi Client")
         self._host = host
         self._port = port
         self._hass = hass
-        self._slave_id = slave_id
-        self._client_key = f"{host}:{port}:{slave_id}"
+        self._unit_id = unit_id
+        self._client_key = f"{host}:{port}:{unit_id}"
         self._lock = threading.Lock()
         self._reconnect = False
 
@@ -183,14 +181,14 @@ def modbus_connect(self, config=None):
         use_config = SimpleNamespace(
             **(
                 config
-                or {"host": self._host, "port": self._port, "slave_id": self._slave_id}
+                or {"host": self._host, "port": self._port, "unit_id": self._unit_id}
             )
         )
         _LOGGER.debug(
-            f"Client connect to IP {use_config.host} port {use_config.port} slave id {use_config.slave_id} using timeout {TIMEOUT}"
+            f"Client connect to IP {use_config.host} port {use_config.port} unit id {use_config.unit_id} using timeout {TIMEOUT}"
         )
         client = modbus_client.SunSpecModbusClientDeviceTCP(
-            slave_id=use_config.slave_id,
+            slave_id=use_config.unit_id,
             ipaddr=use_config.host,
             ipport=use_config.port,
             timeout=TIMEOUT,
@@ -202,7 +200,7 @@ def modbus_connect(self, config=None):
                     client.connect()
                 if not client.is_connected():
                     raise ConnectionError(
-                        f"Failed to connect to {self._host}:{self._port} slave id {self._slave_id}"
+                        f"Failed to connect to {self._host}:{self._port} unit id {self._unit_id}"
                     )
                 _LOGGER.debug("Client connected, perform initial scan")
                 client.scan(
@@ -211,7 +209,7 @@ def modbus_connect(self, config=None):
                 return client
             except ModbusClientError:
                 raise ConnectionError(
-                    f"Failed to connect to {use_config.host}:{use_config.port} slave id {use_config.slave_id}"
+                    f"Failed to connect to {use_config.host}:{use_config.port} unit id {use_config.unit_id}"
                 )
         else:
             _LOGGER.debug("Inverter not ready for Modbus TCP connection")

custom_components/sunspec/config_flow.py

@@ -14,7 +14,7 @@
 from .const import CONF_PORT
 from .const import CONF_PREFIX
 from .const import CONF_SCAN_INTERVAL
-from .const import CONF_SLAVE_ID
+from .const import CONF_UNIT_ID
 from .const import DEFAULT_MODELS
 from .const import DOMAIN
 
@@ -37,15 +37,15 @@ async def async_step_user(self, user_input=None):
         if user_input is not None:
             host = user_input[CONF_HOST]
             port = user_input[CONF_PORT]
-            slave_id = user_input[CONF_SLAVE_ID]
-            valid = await self._test_connection(host, port, slave_id)
+            unit_id = user_input[CONF_UNIT_ID]
+            valid = await self._test_connection(host, port, unit_id)
             if valid:
                 uid = self._device_info.getValue("SN")
                 _LOGGER.debug(f"Sunspec device unique id: {uid}")
                 await self.async_set_unique_id(uid)
 
                 self._abort_if_unique_id_configured(
-                    updates={CONF_HOST: host, CONF_PORT: port, CONF_SLAVE_ID: slave_id}
+                    updates={CONF_HOST: host, CONF_PORT: port, CONF_UNIT_ID: unit_id}
                 )
                 self.init_info = user_input
                 return await self.async_step_settings()
@@ -66,10 +66,10 @@ async def async_step_settings(self, user_input=None):
             self.init_info[CONF_SCAN_INTERVAL] = user_input[CONF_SCAN_INTERVAL]
             host = self.init_info[CONF_HOST]
             port = self.init_info[CONF_PORT]
-            slave_id = self.init_info[CONF_SLAVE_ID]
+            unit_id = self.init_info[CONF_UNIT_ID]
             _LOGGER.debug("Creating entry with data %s", self.init_info)
             return self.async_create_entry(
-                title=f"{host}:{port}:{slave_id}", data=self.init_info
+                title=f"{host}:{port}:{unit_id}", data=self.init_info
             )
 
         return await self._show_settings_form(user_input)
@@ -81,14 +81,14 @@ def async_get_options_flow(config_entry):
 
     async def _show_config_form(self, user_input):  # pylint: disable=unused-argument
         """Show the configuration form to edit connection data."""
-        defaults = user_input or {CONF_HOST: "", CONF_PORT: 502, CONF_SLAVE_ID: 1}
+        defaults = user_input or {CONF_HOST: "", CONF_PORT: 502, CONF_UNIT_ID: 1}
         return self.async_show_form(
             step_id="user",
             data_schema=vol.Schema(
                 {
                     vol.Required(CONF_HOST, default=defaults[CONF_HOST]): str,
                     vol.Required(CONF_PORT, default=defaults[CONF_PORT]): int,
-                    vol.Required(CONF_SLAVE_ID, default=defaults[CONF_SLAVE_ID]): int,
+                    vol.Required(CONF_UNIT_ID, default=defaults[CONF_UNIT_ID]): int,
                 }
             ),
             errors=self._errors,
@@ -116,17 +116,17 @@ async def _show_settings_form(self, user_input):  # pylint: disable=unused-argum
             errors=self._errors,
         )
 
-    async def _test_connection(self, host, port, slave_id):
+    async def _test_connection(self, host, port, unit_id):
         """Return true if credentials is valid."""
-        _LOGGER.debug(f"Test connection to {host}:{port} slave id {slave_id}")
+        _LOGGER.debug(f"Test connection to {host}:{port} unit id {unit_id}")
         try:
-            self.client = SunSpecApiClient(host, port, slave_id, self.hass)
+            self.client = SunSpecApiClient(host, port, unit_id, self.hass)
             self._device_info = await self.client.async_get_device_info()
             _LOGGER.info(self._device_info)
             return True
         except Exception as e:  # pylint: disable=broad-except
             _LOGGER.error(
-                "Failed to connect to host %s:%s slave %s - %s", host, port, slave_id, e
+                "Failed to connect to host %s:%s unit %s - %s", host, port, unit_id, e
             )
             pass
         return False
@@ -162,15 +162,15 @@ async def show_settings_form(self, data=None, errors=None):
         settings = data or self.config_entry.data
         host = settings.get(CONF_HOST)
         port = settings.get(CONF_PORT)
-        slave_id = settings.get(CONF_SLAVE_ID)
+        unit_id = settings.get(CONF_UNIT_ID)
 
         return self.async_show_form(
             step_id="host_options",
             data_schema=vol.Schema(
                 {
                     vol.Required(CONF_HOST, default=host): str,
                     vol.Required(CONF_PORT, default=port): int,
-                    vol.Required(CONF_SLAVE_ID, default=slave_id): int,
+                    vol.Required(CONF_UNIT_ID, default=unit_id): int,
                 }
             ),
             errors=errors,
@@ -213,10 +213,10 @@ async def async_step_model_options(self, user_input=None):
             )
         except Exception as e:  # pylint: disable=broad-except
             _LOGGER.error(
-                "Failed to connect to host %s:%s slave %s - %s",
+                "Failed to connect to host %s:%s unit %s - %s",
                 self.settings[CONF_HOST],
                 self.settings[CONF_PORT],
-                self.settings[CONF_SLAVE_ID],
+                self.settings[CONF_UNIT_ID],
                 e,
             )
             return await self.show_settings_form(
@@ -227,7 +227,7 @@ async def _update_options(self):
         """Update config entry options."""
         # self.settings[CONF_PORT] = 503
         # self.settings[CONF_ENABLED_MODELS] = [160, 103]
-        title = f"{self.settings[CONF_HOST]}:{self.settings[CONF_PORT]}:{self.settings[CONF_SLAVE_ID]}"
+        title = f"{self.settings[CONF_HOST]}:{self.settings[CONF_PORT]}:{self.settings[CONF_UNIT_ID]}"
         _LOGGER.debug(
             "Saving config entry with title %s, data: %s options %s",
             title,

custom_components/sunspec/const.py

@@ -24,7 +24,7 @@
 CONF_ENABLED = "enabled"
 CONF_HOST = "host"
 CONF_PORT = "port"
-CONF_SLAVE_ID = "slave_id"
+CONF_UNIT_ID = "unit_id"
 CONF_PREFIX = "prefix"
 CONF_SCAN_INTERVAL = "scan_interval"
 CONF_ENABLED_MODELS = "models_enabled"

custom_components/sunspec/translations/en.json

@@ -7,7 +7,7 @@
         "data": {
           "host": "Hostname/IP",
           "port": "Port",
-          "slave_id": "Slave ID"
+          "unit_id": "Unit ID"
         }
       },
       "settings": {
@@ -35,7 +35,7 @@
         "data": {
           "host": "Hostname/IP",
           "port": "Port",
-          "slave_id": "Slave ID"
+          "unit_id": "Unit ID"
         }
       },
       "model_options": {
@@ -44,7 +44,7 @@
         "data": {
           "host": "Hostname/IP",
           "port": "Port",
-          "slave_id": "Slave ID",
+          "unit_id": "Unit ID",
           "models_enabled": "Read models",
           "scan_interval": "Scan interval (seconds)"
         }

custom_components/sunspec/translations/pl.json

@@ -7,7 +7,7 @@
         "data": {
           "host": "Nazwa hosta/Adres IP",
           "port": "Port",
-          "slave_id": "Identyfikator urządzenia"
+          "unit_id": "Identyfikator urządzenia"
         }
       },
       "settings": {

custom_components/sunspec/translations/sk.json

@@ -7,7 +7,7 @@
         "data": {
           "host": "Meno hosťa/IP",
           "port": "Port",
-          "slave_id": "Slave ID"
+          "unit_id": "Unit ID"
         }
       },
       "settings": {
@@ -35,7 +35,7 @@
         "data": {
           "host": "Meno hosťa/IP",
           "port": "Port",
-          "slave_id": "Slave ID"
+          "unit_id": "Unit ID"
         }
       },
       "model_options": {
@@ -44,7 +44,7 @@
         "data": {
           "host": "Meno hosťa/IP",
           "port": "Port",
-          "slave_id": "Slave ID",
+          "unit_id": "Unit ID",
           "models_enabled": "Čítať modely",
           "scan_interval": "Interval skenovania (sekundy)"
         }