alphaess-aio 0.0.0__tar.gz

alphaess_aio-0.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 zeguramente
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

alphaess_aio-0.0.0/PKG-INFO

@@ -0,0 +1,70 @@
+Metadata-Version: 2.1
+Name: alphaess-aio
+Version: 0.0.0
+Summary: Sends get and post requests to available AlphaCloud API endpoints.
+Author-email: Markus Ziegler <frage_n@web.de>
+Maintainer-email: Markus Ziegler <frage_n@web.de>
+License: MIT License
+        
+        Copyright (c) 2024 zeguramente
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Repository, https://github.com/zeguramente/alphaess-aio
+Keywords: alphaess,api
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp==3.9.3
+Requires-Dist: pydantic==2.6.4
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-mock; extra == "test"
+Requires-Dist: pytest-asyncio; extra == "test"
+Requires-Dist: pytest-aiohttp; extra == "test"
+Provides-Extra: lint
+Requires-Dist: ruff>=0.4.2; extra == "lint"
+
+# Alphaess-aio - a Alpha Open API client
+
+## About
+
+Sends get and post requests to available AlphaCloud API endpoints and retrieves data about you AlphaESS system.
+Code generated out of API description.
+
+## Prerequisites
+
+Register account at https://open.alphaess.com/. You will recieve an AppID and AppSecret needed for authentification.
+
+## How to use
+
+```python
+import asyncio
+from alphaessaio import AlphaEssAPI, AlphaEssAuth
+
+# setup auth
+auth = AlphaEssAuth(appid="your_app_id", appsecret="your_app_secret")
+
+#init api
+alphaess_api = AlphaEssAPI(auth)
+
+ess_list = asyncio.run(alphaess_api.get_ess_list())
+```

alphaess_aio-0.0.0/README.md

@@ -0,0 +1,25 @@
+# Alphaess-aio - a Alpha Open API client
+
+## About
+
+Sends get and post requests to available AlphaCloud API endpoints and retrieves data about you AlphaESS system.
+Code generated out of API description.
+
+## Prerequisites
+
+Register account at https://open.alphaess.com/. You will recieve an AppID and AppSecret needed for authentification.
+
+## How to use
+
+```python
+import asyncio
+from alphaessaio import AlphaEssAPI, AlphaEssAuth
+
+# setup auth
+auth = AlphaEssAuth(appid="your_app_id", appsecret="your_app_secret")
+
+#init api
+alphaess_api = AlphaEssAPI(auth)
+
+ess_list = asyncio.run(alphaess_api.get_ess_list())
+```

alphaess_aio-0.0.0/alphaess_aio.egg-info/PKG-INFO

@@ -0,0 +1,70 @@
+Metadata-Version: 2.1
+Name: alphaess-aio
+Version: 0.0.0
+Summary: Sends get and post requests to available AlphaCloud API endpoints.
+Author-email: Markus Ziegler <frage_n@web.de>
+Maintainer-email: Markus Ziegler <frage_n@web.de>
+License: MIT License
+        
+        Copyright (c) 2024 zeguramente
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Repository, https://github.com/zeguramente/alphaess-aio
+Keywords: alphaess,api
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp==3.9.3
+Requires-Dist: pydantic==2.6.4
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-mock; extra == "test"
+Requires-Dist: pytest-asyncio; extra == "test"
+Requires-Dist: pytest-aiohttp; extra == "test"
+Provides-Extra: lint
+Requires-Dist: ruff>=0.4.2; extra == "lint"
+
+# Alphaess-aio - a Alpha Open API client
+
+## About
+
+Sends get and post requests to available AlphaCloud API endpoints and retrieves data about you AlphaESS system.
+Code generated out of API description.
+
+## Prerequisites
+
+Register account at https://open.alphaess.com/. You will recieve an AppID and AppSecret needed for authentification.
+
+## How to use
+
+```python
+import asyncio
+from alphaessaio import AlphaEssAPI, AlphaEssAuth
+
+# setup auth
+auth = AlphaEssAuth(appid="your_app_id", appsecret="your_app_secret")
+
+#init api
+alphaess_api = AlphaEssAPI(auth)
+
+ess_list = asyncio.run(alphaess_api.get_ess_list())
+```

alphaess_aio-0.0.0/alphaess_aio.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+README.md
+pyproject.toml
+alphaess_aio.egg-info/PKG-INFO
+alphaess_aio.egg-info/SOURCES.txt
+alphaess_aio.egg-info/dependency_links.txt
+alphaess_aio.egg-info/requires.txt
+alphaess_aio.egg-info/top_level.txt
+alphaessaio/__init__.py
+alphaessaio/client.py
+alphaessaio/response.py
+tests/test_client.py

alphaess_aio-0.0.0/alphaess_aio.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

alphaess_aio-0.0.0/alphaess_aio.egg-info/requires.txt

@@ -0,0 +1,11 @@
+aiohttp==3.9.3
+pydantic==2.6.4
+
+[lint]
+ruff>=0.4.2
+
+[test]
+pytest
+pytest-mock
+pytest-asyncio
+pytest-aiohttp

alphaess_aio-0.0.0/alphaess_aio.egg-info/top_level.txt

@@ -0,0 +1 @@
+alphaessaio

alphaess_aio-0.0.0/alphaessaio/__init__.py

@@ -0,0 +1,7 @@
+"""Import stuff"""
+
+from alphaessaio.client import AlphaEssAPI, AlphaEssAuth
+
+__all__ = [AlphaEssAPI, AlphaEssAuth]
+
+__version__ = "0.0.0"

alphaess_aio-0.0.0/alphaessaio/client.py

@@ -0,0 +1,443 @@
+"""Sending requests to AlphaESS API"""
+
+import logging
+import time
+import hashlib
+import json
+import aiohttp
+import pydantic
+from alphaessaio import response
+
+logger = logging.getLogger(__name__)
+
+
+class AlphaEssRequestError(Exception):
+    def __init__(self, response_data: dict):
+        message = f"Error: {response_data}"
+        super().__init__(message)
+
+
+class AlphaEssAuth(pydantic.BaseModel):
+    appid: str
+    appsecret: pydantic.SecretStr
+
+    def _get_signature(self, timestamp) -> str:
+        return str(
+            hashlib.sha512(
+                (f"{self.appid}{self.appsecret.get_secret_value()}{timestamp}").encode(
+                    "ascii"
+                )
+            ).hexdigest()
+        )
+
+    def create_headers(self):
+        timestamp = str(int(time.time()))
+        sign = self._get_signature(timestamp)
+        return {"appId": self.appid, "timeStamp": timestamp, "sign": sign}
+
+
+class AlphaEssAPI:
+    def __init__(self, auth: AlphaEssAuth):
+        self.auth = auth
+
+    async def _get(self, url, params) -> dict:
+        headers = self.auth.create_headers()
+        async with aiohttp.ClientSession() as session:
+            logger.debug(f"Sending get request to {url=} with {params=}")
+            async with session.get(url, headers=headers, params=params) as resp:
+                return await self._evaluate_response(resp)
+
+    async def _post(self, url, params) -> dict:
+        headers = self.auth.create_headers()
+        async with aiohttp.ClientSession() as session:
+            async with session.post(url, headers=headers, json=params) as resp:
+                return await self._evaluate_response(resp)
+
+    @staticmethod
+    async def _evaluate_response(resp: aiohttp.ClientResponse) -> dict:
+        try:
+            data = await resp.json()
+            logger.debug(f"api response: {data}")
+        except json.JSONDecodeError as json_decode_error:
+            raise AlphaEssRequestError(
+                {"msg": "returned data is not valid json", "err": json_decode_error}
+            )
+        if resp.status == 200 and data.get("code", 0) == 200:
+            logger.debug(f"Request successful. {resp.url}")
+            return data
+        logger.error(f"Request error: {data=}")
+        raise AlphaEssRequestError(data)
+
+    @pydantic.validate_call
+    async def get_ev_charger_config_list(
+        self, sys_sn: str
+    ) -> response.EvChargerConfigList:
+        """Obtain the SN of the charging pile according to the SN, and set the model
+
+        Args:
+            sys_sn (str): System S/N
+
+        Returns:
+            (response.EvChargerConfigList): response data
+        """
+
+        raw_response: dict = await self._get(
+            "https://openapi.alphaess.com/api/getEvChargerConfigList", {"sysSn": sys_sn}
+        )
+
+        return response.EvChargerConfigList(**raw_response)
+
+    @pydantic.validate_call
+    async def get_ev_charger_currents_by_sn(
+        self, sys_sn: str
+    ) -> response.EvChargerCurrentsBySn:
+        """Obtain the current setting of charging pile household according to SN
+
+        Args:
+            sys_sn (str): sys sn
+
+        Returns:
+            (response.EvChargerCurrentsBySn): response data
+        """
+
+        raw_response: dict = await self._get(
+            "https://openapi.alphaess.com/api/getEvChargerCurrentsBySn",
+            {"sysSn": sys_sn},
+        )
+
+        return response.EvChargerCurrentsBySn(**raw_response)
+
+    @pydantic.validate_call
+    async def set_ev_charger_currents_by_sn(
+        self, sys_sn: str, currentsetting: float
+    ) -> response.EvChargerCurrentsBySn:
+        """Set charging pile household current setting according to SN
+
+        Args:
+            sys_sn (str): SN
+        currentsetting (float): Household current setup
+
+        Returns:
+            (response.EvChargerCurrentsBySn): response data
+        """
+
+        raw_response: dict = await self._post(
+            "https://openapi.alphaess.com/api/setEvChargerCurrentsBySn",
+            {"sysSn": sys_sn, "currentsetting": currentsetting},
+        )
+
+        return response.EvChargerCurrentsBySn(**raw_response)
+
+    @pydantic.validate_call
+    async def get_ev_charger_status_by_sn(
+        self, sys_sn: str, evcharger_sn: str
+    ) -> response.EvChargerStatusBySn:
+        """Obtain charging pile status according to SN+charging pile SN
+
+        Args:
+            sys_sn (str): sys SN
+        evcharger_sn (str): EV-charger SN
+
+        Returns:
+            (response.EvChargerStatusBySn): response data
+        """
+
+        raw_response: dict = await self._get(
+            "https://openapi.alphaess.com/api/getEvChargerStatusBySn",
+            {"sysSn": sys_sn, "evchargerSn": evcharger_sn},
+        )
+
+        return response.EvChargerStatusBySn(**raw_response)
+
+    @pydantic.validate_call
+    async def remote_control_ev_charger(
+        self, sys_sn: str, evcharger_sn: str, control_mode: int
+    ) -> response.ControlEvCharger:
+        """According to SN+ charging pile SN remote control charging pile to start charging/stop charging
+
+        Args:
+            sys_sn (str): sys sn
+        evcharger_sn (str): EV-charger SN
+        control_mode (int): 0-Stop Charging，1-Start Charging
+
+        Returns:
+            (response.ControlEvCharger): response data
+        """
+
+        raw_response: dict = await self._post(
+            "https://openapi.alphaess.com/api/remoteControlEvCharger",
+            {"sysSn": sys_sn, "evchargerSn": evcharger_sn, "controlMode": control_mode},
+        )
+
+        return response.ControlEvCharger(**raw_response)
+
+    @pydantic.validate_call
+    async def get_sum_data_for_customer(
+        self, sys_sn: str
+    ) -> response.SumDataForCustomer:
+        """According  SN to get System Summary data
+
+        Args:
+            sys_sn (str): System S/N
+
+        Returns:
+            (response.SumDataForCustomer): response data
+        """
+
+        raw_response: dict = await self._get(
+            "https://openapi.alphaess.com/api/getSumDataForCustomer", {"sysSn": sys_sn}
+        )
+
+        return response.SumDataForCustomer(**raw_response)
+
+    @pydantic.validate_call
+    async def get_last_power_data(self, sys_sn: str) -> response.LastPowerData:
+        """Get real-time power data based on SN
+
+        Args:
+            sys_sn (str): system SN
+
+        Returns:
+            (response.LastPowerData): response data
+        """
+
+        raw_response: dict = await self._get(
+            "https://openapi.alphaess.com/api/getLastPowerData", {"sysSn": sys_sn}
+        )
+
+        return response.LastPowerData(**raw_response)
+
+    @pydantic.validate_call
+    async def get_one_day_power_by_sn(
+        self, query_date: str, sys_sn: str
+    ) -> response.OneDayPowerBySn:
+        """According  SN to get system power data
+
+        Args:
+            query_date (str): Date，Format：yyyy-MM-dd
+        sys_sn (str): System S/N
+
+        Returns:
+            (response.OneDayPowerBySn): response data
+        """
+
+        raw_response: dict = await self._get(
+            "https://openapi.alphaess.com/api/getOneDayPowerBySn",
+            {"queryDate": query_date, "sysSn": sys_sn},
+        )
+
+        return response.OneDayPowerBySn(**raw_response)
+
+    @pydantic.validate_call
+    async def get_one_date_energy_by_sn(
+        self, query_date: str, sys_sn: str
+    ) -> response.OneDateEnergyBySn:
+        """According  SN to get System Energy Data
+
+        Args:
+            query_date (str): Date，Format：yyyy-MM-dd
+        sys_sn (str): System S/N
+
+        Returns:
+            (response.OneDateEnergyBySn): response data
+        """
+
+        raw_response: dict = await self._get(
+            "https://openapi.alphaess.com/api/getOneDateEnergyBySn",
+            {"queryDate": query_date, "sysSn": sys_sn},
+        )
+
+        return response.OneDateEnergyBySn(**raw_response)
+
+    @pydantic.validate_call
+    async def get_charge_config_info(self, sys_sn: str) -> response.ChargeConfigInfo:
+        """According  SN to get charging setting information
+
+        Args:
+            sys_sn (str): System S/N
+
+        Returns:
+            (response.ChargeConfigInfo): response data
+        """
+
+        raw_response: dict = await self._get(
+            "https://openapi.alphaess.com/api/getChargeConfigInfo", {"sysSn": sys_sn}
+        )
+
+        return response.ChargeConfigInfo(**raw_response)
+
+    @pydantic.validate_call
+    async def update_charge_config_info(
+        self,
+        sys_sn: str,
+        bat_high_cap: float,
+        grid_charge: int,
+        time_chae1: str,
+        time_chae2: str,
+        time_chaf1: str,
+        time_chaf2: str,
+    ) -> response.ChargeConfigInfo:
+        """According SN to Set charging information，Setting frequency 24 hours, set once a day
+
+        Args:
+            sys_sn (str): System S/N
+        bat_high_cap (float): Charging Stops at SOC [%]
+        grid_charge (int): Enable Grid Charging Battery
+        time_chae1 (str): Charging Period 1 end time, the time format is HH:mm, such as: 00:00, the maximum is 23:45, the minimum is 00:00, and the interval is 15 minutes, such as: 00:15, 00:30, 00:45, otherwise no effect
+        time_chae2 (str): Charging Period 2 end time, the time format is HH:mm, such as: 00:00, the maximum is 23:45, the minimum is 00:00, and the interval is 15 minutes, such as: 00:15, 00:30, 00:45, otherwise no effect
+        time_chaf1 (str): Charging Period 1 start time, the time format is HH:mm, such as: 00:00, the maximum is 23:45, the minimum is 00:00, and the interval is 15 minutes, such as: 00:15, 00:30, 00:45, otherwise no effect
+        time_chaf2 (str): Charging Period 2 start time, the time format is HH:mm, such as: 00:00, the maximum is 23:45, the minimum is 00:00, and the interval is 15 minutes, such as: 00:15, 00:30, 00:45, otherwise no effect
+
+        Returns:
+            (response.ChargeConfigInfo): response data
+        """
+
+        raw_response: dict = await self._post(
+            "https://openapi.alphaess.com/api/updateChargeConfigInfo",
+            {
+                "sysSn": sys_sn,
+                "batHighCap": bat_high_cap,
+                "gridCharge": grid_charge,
+                "timeChae1": time_chae1,
+                "timeChae2": time_chae2,
+                "timeChaf1": time_chaf1,
+                "timeChaf2": time_chaf2,
+            },
+        )
+
+        return response.ChargeConfigInfo(**raw_response)
+
+    @pydantic.validate_call
+    async def get_dis_charge_config_info(
+        self, sys_sn: str
+    ) -> response.DisChargeConfigInfo:
+        """According to SN discharge setting information
+
+        Args:
+            sys_sn (str): System S/N
+
+        Returns:
+            (response.DisChargeConfigInfo): response data
+        """
+
+        raw_response: dict = await self._get(
+            "https://openapi.alphaess.com/api/getDisChargeConfigInfo", {"sysSn": sys_sn}
+        )
+
+        return response.DisChargeConfigInfo(**raw_response)
+
+    @pydantic.validate_call
+    async def update_dis_charge_config_info(
+        self,
+        bat_use_cap: float,
+        ctr_dis: int,
+        time_dise1: str,
+        time_dise2: str,
+        time_disf1: str,
+        time_disf2: str,
+        sys_sn: str,
+    ) -> response.DisChargeConfigInfo:
+        """According to SN Set discharge information，Setting frequency 24 hours, set once a day
+
+        Args:
+            bat_use_cap (float): Discharging Cutoff SOC [%]
+        ctr_dis (int): Enable Battery Discharge Time Control
+        time_dise1 (str): Discharging Period 1 End time, the time format is HH:mm, such as: 00:00, the maximum is 23:45, the minimum is 00:00, and the interval is 15 minutes, such as: 00:15, 00:30, 00:45, otherwise no effect
+        time_dise2 (str): Discharging Period 2 End time, the time format is HH:mm, such as: 00:00, the maximum is 23:45, the minimum is 00:00, and the interval is 15 minutes, such as: 00:15, 00:30, 00:45, otherwise no effect
+        time_disf1 (str): Discharging Period 1 Start time, the time format is HH:mm, such as: 00:00, the maximum is 23:45, the minimum is 00:00, and the interval is 15 minutes, such as: 00:15, 00:30, 00:45, otherwise no effect
+        time_disf2 (str): Discharging Period 2 Start time, the time format is HH:mm, such as: 00:00, the maximum is 23:45, the minimum is 00:00, and the interval is 15 minutes, such as: 00:15, 00:30, 00:45, otherwise no effect
+        sys_sn (str): System S/N
+
+        Returns:
+            (response.DisChargeConfigInfo): response data
+        """
+
+        raw_response: dict = await self._post(
+            "https://openapi.alphaess.com/api/updateDisChargeConfigInfo",
+            {
+                "batUseCap": bat_use_cap,
+                "ctrDis": ctr_dis,
+                "timeDise1": time_dise1,
+                "timeDise2": time_dise2,
+                "timeDisf1": time_disf1,
+                "timeDisf2": time_disf2,
+                "sysSn": sys_sn,
+            },
+        )
+
+        return response.DisChargeConfigInfo(**raw_response)
+
+    @pydantic.validate_call
+    async def get_verification_code(
+        self, sys_sn: str, check_code: str
+    ) -> response.VerificationCode:
+        """According to SN get the check code according to SN
+
+        Args:
+            sys_sn (str): System S/N
+        check_code (str): checkCode
+
+        Returns:
+            (response.VerificationCode): response data
+        """
+
+        raw_response: dict = await self._get(
+            "https://openapi.alphaess.com/api/getVerificationCode",
+            {"sysSn": sys_sn, "checkCode": check_code},
+        )
+
+        return response.VerificationCode(**raw_response)
+
+    @pydantic.validate_call
+    async def bind_sn(self, sys_sn: str, code: str) -> response.Sn:
+        """According to SN and check code Bind the system bind the system
+
+        Args:
+            sys_sn (str): System S/N
+        code (str): Verification Code
+
+        Returns:
+            (response.Sn): response data
+        """
+
+        raw_response: dict = await self._post(
+            "https://openapi.alphaess.com/api/bindSn", {"sysSn": sys_sn, "code": code}
+        )
+
+        return response.Sn(**raw_response)
+
+    @pydantic.validate_call
+    async def un_bind_sn(self, sys_sn: str) -> response.BindSn:
+        """According to SN and check code Unbind the system
+
+        Args:
+            sys_sn (str): System S/N
+
+        Returns:
+            (response.BindSn): response data
+        """
+
+        raw_response: dict = await self._post(
+            "https://openapi.alphaess.com/api/unBindSn", {"sysSn": sys_sn}
+        )
+
+        return response.BindSn(**raw_response)
+
+    @pydantic.validate_call
+    async def get_ess_list(
+        self,
+    ) -> response.EssList:
+        """According to SN  to get system list data
+
+        Args:
+
+
+        Returns:
+            (response.EssList): response data
+        """
+
+        raw_response: dict = await self._get(
+            "https://openapi.alphaess.com/api/getEssList", {}
+        )
+
+        return response.EssList(**raw_response)