Add batch reading functionality

Author: mkuthan

custom_components/solis_cloud_control/api.py

@@ -12,6 +12,7 @@
     API_BASE_URL,
     API_CONCURRENT_REQUESTS,
     API_CONTROL_ENDPOINT,
+    API_READ_BATCH_ENDPOINT,
     API_READ_ENDPOINT,
     API_RETRY_COUNT,
     API_RETRY_DELAY_SECONDS,
@@ -121,6 +122,43 @@ async def read(self, cid: int) -> str:
 
         return data["msg"]
 
+    @backoff.on_exception(
+        backoff.constant,
+        SolisCloudControlApiError,
+        max_tries=API_RETRY_COUNT,
+        interval=API_RETRY_DELAY_SECONDS,
+        logger=_LOGGER,
+    )
+    async def at_read_batch(self, cids: list[int]) -> dict[int, str]:
+        date = current_date()
+        payload = {"inverterSn": self._inverter_sn, "cids": ",".join(map(str, cids))}
+
+        data = await self._request(date, API_READ_BATCH_ENDPOINT, payload)
+
+        if data is None:
+            raise SolisCloudControlApiError("ReadBatch failed: 'data' field is missing in response")
+
+        if not isinstance(data, list):
+            raise SolisCloudControlApiError("ReadBatch failed: response data is not an array")
+
+        result = {}
+        for outer_item in data:
+            if not isinstance(outer_item, list):
+                continue
+
+            for item in outer_item:
+                if not isinstance(item, dict):
+                    continue
+
+                if "msg" not in item:
+                    raise SolisCloudControlApiError("ReadBatch failed: 'msg' field is missing in response item")
+                if "cid" not in item:
+                    raise SolisCloudControlApiError("ReadBatch failed: 'cid' field is missing in response item")
+
+                result[int(item["cid"])] = item["msg"]
+
+        return result
+
     @backoff.on_exception(
         backoff.constant,
         SolisCloudControlApiError,

custom_components/solis_cloud_control/config_flow.py

@@ -44,7 +44,7 @@ async def async_step_user(self, user_input: dict[str, any] | None = None) -> Con
                 _LOGGER.exception(error)
                 errors["base"] = "unknown_error"
             else:
-                await self.async_set_unique_id(unique_id=user_input[CONF_INVERTER_SN])
+                await self.async_set_unique_id(unique_id=user_input[CONF_API_KEY])
                 self._abort_if_unique_id_configured()
                 return self.async_create_entry(
                     title=user_input[CONF_API_KEY],

custom_components/solis_cloud_control/const.py

@@ -4,6 +4,7 @@
 
 API_BASE_URL = "https://www.soliscloud.com:13333"
 API_READ_ENDPOINT = "/v2/api/atRead"
+API_READ_BATCH_ENDPOINT = "/v2/api/atReadBatch"
 API_CONTROL_ENDPOINT = "/v2/api/control"
 API_TIMEOUT_SECONDS = 10
 API_RETRY_COUNT = 3  # initial attempt + 2 retries

custom_components/solis_cloud_control/coordinator.py

@@ -4,7 +4,7 @@
 
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.core import HomeAssistant
-from homeassistant.helpers.update_coordinator import DataUpdateCoordinator
+from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
 
 from custom_components.solis_cloud_control.api import SolisCloudControlApiClient, SolisCloudControlApiError
 from custom_components.solis_cloud_control.const import (
@@ -53,20 +53,10 @@ def __init__(
         self.api_client = api_client
 
     async def _async_update_data(self) -> SolisCloudControlData:
-        data = SolisCloudControlData()
-
-        async def fetch_cid_value(cid: int) -> tuple[int, str | None]:
-            try:
-                value = await self.api_client.read(cid)
-                return cid, value
-            except SolisCloudControlApiError as error:
-                _LOGGER.error("Failed to read CID %s: %s", cid, error)
-                return cid, None
-
-        tasks = [fetch_cid_value(cid) for cid in _ALL_CIDS]
-        results = await asyncio.gather(*tasks)
-
-        for cid, value in results:
-            data[cid] = value
-
-        return data
+        try:
+            result = await self.api_client.at_read_batch(_ALL_CIDS)
+            data = SolisCloudControlData({cid: result.get(cid) for cid in _ALL_CIDS})
+            _LOGGER.debug("Data read from API: %s", data)
+            return data
+        except SolisCloudControlApiError as error:
+            raise UpdateFailed(error) from error

custom_components/solis_cloud_control/translations/en.json

@@ -6,18 +6,18 @@
                 "data": {
                     "api_key": "API key",
                     "token": "API token",
-                    "inverter_sn": "Inverter serial number",
+                    "inverter_sn": "Inverter serial number"
                 }
             }
         },
         "error": {
             "invalid_auth": "Invalid API key or token",
             "invalid_inverter_sn": "Invalid inverter serial number",
             "connection_error": "Connection error",
-            "unknown_error": "Unknown error",
+            "unknown_error": "Unknown error"
         },
         "abort": {
-            "already_configured": "[%key:common::config_flow::abort::already_configured_device%]"
+            "already_configured": "This entry is already configured."
         }
     }
 }