compit-inext-api-beta 0.4.0b10__tar.gz

compit_inext_api_beta-0.4.0b10/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

compit_inext_api_beta-0.4.0b10/PKG-INFO

@@ -0,0 +1,33 @@
+Metadata-Version: 2.4
+Name: compit-inext-api-beta
+Version: 0.4.0b10
+Summary: Compit Inext API - Python client
+Author: Przemyslaw Grzywa
+License: Apache-2.0
+Project-URL: homepage, https://github.com/Przemko92/compit-inext-api
+Project-URL: repository, https://github.com/Przemko92/compit-inext-api
+Project-URL: issues, https://github.com/Przemko92/compit-inext-api/issues
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiofiles
+Requires-Dist: aiohttp
+Dynamic: license-file
+
+# Compit inext api
+
+This lib allows you to interact with the Compit inext api https://inext.compit.pl/mobile/v2/compit.
+Use the credentials from https://inext.compit.pl/.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [License](#license)
+
+## Installation
+
+`pip install compit-inext-api`
+
+## License
+
+This project is licensed under the Apache License, Version 2.0. See the [LICENSE](LICENSE) file for details.

compit_inext_api_beta-0.4.0b10/README.md

@@ -0,0 +1,17 @@
+# Compit inext api
+
+This lib allows you to interact with the Compit inext api https://inext.compit.pl/mobile/v2/compit.
+Use the credentials from https://inext.compit.pl/.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [License](#license)
+
+## Installation
+
+`pip install compit-inext-api`
+
+## License
+
+This project is licensed under the Apache License, Version 2.0. See the [LICENSE](LICENSE) file for details.

compit_inext_api_beta-0.4.0b10/compit_inext_api/__init__.py

@@ -0,0 +1,30 @@
+"""Module HTTP communication with the Inext Compit api."""
+
+from .device_definitions import DeviceDefinitionsLoader
+from .api import CompitAPI, CannotConnect, InvalidAuth
+from .types.DeviceState import DeviceState, Param, DeviceInstance
+from .types.DeviceDefinitions import DeviceDefinitions, Parameter, ParameterDetails
+from .types.SystemInfo import SystemInfo, Gate, Device
+from .consts import CompitHVACMode, CompitParameter, CompitFanMode, CompitPresetMode
+from .connector import CompitApiConnector
+
+__all__ = [
+    "DeviceDefinitionsLoader", 
+    "CompitAPI", 
+    "DeviceState", 
+    "Param", 
+    "DeviceInstance", 
+    "DeviceDefinitions", 
+    "Parameter", 
+    "ParameterDetails", 
+    "SystemInfo", 
+    "Gate", 
+    "Device",
+    "InvalidAuth",
+    "CannotConnect",
+    "CompitHVACMode",
+    "CompitParameter", 
+    "CompitFanMode",
+    "CompitPresetMode",
+    "CompitApiConnector"
+]

compit_inext_api_beta-0.4.0b10/compit_inext_api/api.py

@@ -0,0 +1,240 @@
+"""The Compit api connector."""
+
+import asyncio
+import logging
+from typing import Any
+
+import aiohttp
+
+from compit_inext_api.consts import CompitParameter
+
+from .types.DeviceState import DeviceState
+from .types.SystemInfo import SystemInfo
+
+TIMEOUT = 10
+_LOGGER: logging.Logger = logging.getLogger(__package__)
+HEADERS = {"Content-type": "application/json; charset=UTF-8"}
+API_URL = "https://inext.compit.pl/mobile/v2/compit"
+
+class CompitAPI:
+    """API client for Compit."""
+
+    def __init__(self, email, password, session: aiohttp.ClientSession) -> None:
+        """Initialize the CompitAPI class."""
+        self.email = email
+        self.password = password
+        self.token = None
+        self._api_wrapper = ApiWrapper(session)
+
+    async def authenticate(self) -> SystemInfo | None:
+        """Authenticate the user."""
+        try:
+            response = await self._api_wrapper.post(
+                f"{API_URL}/authorize",
+                {
+                    "email": self.email,
+                    "password": self.password,
+                    "uid": "HomeAssistant",
+                    "label": "HomeAssistant",
+                },
+            )
+
+            if response.status == 401:
+                raise InvalidAuth()
+
+            if response.status == 422:
+                result = await self.get_result(response, ignore_response_code=True)
+                self.token = result["token"]
+                response = await self._api_wrapper.post(
+                    f"{API_URL}/clients",
+                    {
+                        "fcm_token": None,
+                        "uid": "HomeAssistant",
+                        "label": "HomeAssistant",
+                    },
+                    auth=self.token,
+                )
+
+                result = await self.get_result(response)
+                return await self.authenticate()
+            elif response.status >= 400:
+                return None
+
+            result = await self.get_result(response)
+            self.token = result["token"]
+            return SystemInfo.from_json(result)
+        except aiohttp.ClientError as e:
+            _LOGGER.error(e)
+            raise CannotConnect()
+
+    async def get_gates(self) -> SystemInfo | None:
+        """Get the gates from the Compit API."""
+        try:
+            response = await self._api_wrapper.get(f"{API_URL}/gates", {}, self.token)
+
+            return SystemInfo.from_json(await self.get_result(response))
+        except aiohttp.ClientError as e:
+            _LOGGER.error(e)
+            return None
+
+    async def get_state(self, device_id: int) -> DeviceState | None:
+        """Get the state of a device."""
+        try:
+            response = await self._api_wrapper.get(
+                f"{API_URL}/devices/{device_id}/state", {}, self.token
+            )
+
+            return DeviceState.from_json(await self.get_result(response))
+
+        except aiohttp.ClientError as e:
+            _LOGGER.error(e)
+            return None
+
+    async def update_device_parameter(
+        self, device_id: int, parameter: CompitParameter | str, value: str | float
+    ) -> Any:
+        """Update the parameter of a device.
+
+        Args:
+            device_id (int): The ID of the device.
+            parameter (CompitParameter): The parameter to update.
+            value (str | float): The new value of the parameter.
+
+        Returns:
+            Any: The result of the update operation.
+
+        """
+        try:
+            _LOGGER.info("Set %s to %s for device %s", parameter, value, device_id)
+
+            data = {"values": [{"code": parameter.value if isinstance(parameter, CompitParameter) else parameter, "value": value}]}
+
+            response = await self._api_wrapper.put(
+                f"{API_URL}/devices/{device_id}/params", data=data, auth=self.token
+            )
+            return await self.get_result(response)
+
+        except aiohttp.ClientError as e:
+            _LOGGER.error(e)
+            return None
+
+    async def get_result(
+        self,
+        response: aiohttp.ClientResponse | None,
+        ignore_response_code: bool = False,
+    ) -> Any:
+        """Get the result from the response.
+
+        Args:
+            response (aiohttp.ClientResponse): The response object.
+            ignore_response_code (bool, optional): Whether to ignore the response code. Defaults to False.
+
+        Returns:
+            Any: The result from the response.
+
+        Raises:
+            Exception: If the server returns an error response.
+
+        """
+        if response is None:
+            raise ValueError("Server empty response")
+        if response.ok or ignore_response_code:
+            return await response.json()
+
+        raise ValueError(f"Server returned: {response.status}, {response.reason}")
+
+
+class ApiWrapper:
+    """Helper wrapper class."""
+
+    def __init__(self, session: aiohttp.ClientSession) -> None:
+        """Initialize the Helper class.
+
+        Args:
+            session (aiohttp.ClientSession): The aiohttp client session.
+
+        """
+        self._session = session
+
+    async def get(
+        self, url: str, headers: dict | None = None, auth: Any = None
+    ) -> aiohttp.ClientResponse:
+        """Run http GET method."""
+        if headers is None:
+            headers = {}
+
+        if auth:
+            headers["Authorization"] = auth
+
+        return await self.api_wrapper("get", url, headers=headers, auth=None)
+
+    async def post(
+        self,
+        url: str,
+        data: dict | None = None,
+        headers: dict | None = None,
+        auth: Any = None,
+    ) -> aiohttp.ClientResponse:
+        """Run http POST method."""
+        if headers is None:
+            headers = {}
+
+        if auth:
+            headers["Authorization"] = auth
+
+        return await self.api_wrapper(
+            "post", url, data=data, headers=headers, auth=None
+        )
+
+    async def put(
+        self,
+        url: str,
+        data: dict | None = None,
+        headers: dict | None = None,
+        auth: Any = None,
+    ) -> aiohttp.ClientResponse:
+        """Run http PUT method."""
+        if headers is None:
+            headers = {}
+
+        if auth:
+            headers["Authorization"] = auth
+
+        return await self.api_wrapper("put", url, data=data, headers=headers, auth=None)
+
+    async def api_wrapper(
+        self,
+        method: str,
+        url: str,
+        data: dict | None = None,
+        headers: dict | None = None,
+        auth: Any = None,
+    ) -> Any:
+        """Get information from the API."""
+        try:
+            async with asyncio.timeout(TIMEOUT):
+                if method == "get":
+                    return await self._session.get(url, headers=headers, auth=auth)
+
+                if method == "post":
+                    return await self._session.post(
+                        url, headers=headers, data=data, auth=auth
+                    )
+                if method == "put":
+                    return await self._session.put(
+                        url, headers=headers, json=data, auth=auth
+                    )
+
+        except TimeoutError as exception:
+            _LOGGER.error(
+                "Timeout error fetching information from %s - %s",
+                url,
+                exception,
+            )
+
+class CannotConnect(Exception):
+    """Error to indicate we cannot connect."""
+
+
+class InvalidAuth(Exception):
+    """Error to indicate there is invalid auth."""

compit_inext_api_beta-0.4.0b10/compit_inext_api/connector.py

@@ -0,0 +1,124 @@
+import aiohttp
+import logging
+
+from compit_inext_api.api import CompitAPI
+from compit_inext_api.consts import CompitParameter
+from compit_inext_api.params_dictionary import PARAMS
+from compit_inext_api.device_definitions import DeviceDefinitionsLoader
+from compit_inext_api.types.DeviceState import DeviceInstance, DeviceState, GateInstance, Param
+
+
+_LOGGER: logging.Logger = logging.getLogger(__package__)
+
+
+class CompitApiConnector:
+    """Connector class for Compit API."""
+
+    gates: dict[int, GateInstance] = {}
+
+    @property
+    def all_devices(self) -> dict[int, DeviceInstance]:
+        devices = {}
+        for gate in self.gates.values():
+            devices.update(gate.devices)
+        return devices
+
+    def __init__(self, session: aiohttp.ClientSession) -> None:
+        self.session = session
+
+    def get_device(self, device_id: int) -> DeviceInstance | None:
+        for gate in self.gates.values():
+            if device_id in gate.devices:
+                return gate.devices[device_id]
+        return None
+
+    async def init(self, email: str, password: str, lang: str = "en") -> bool:
+        self.api = CompitAPI(email, password, self.session)
+        self.systemInfo = await self.api.authenticate()
+        if self.systemInfo is None:
+            _LOGGER.error("Failed to authenticate with Compit API")
+            return False
+        
+        for gates in self.systemInfo.gates:
+            self.gates[gates.id] = GateInstance(gates.id, gates.label)
+            for device in gates.devices:
+                try:
+                    self.gates[gates.id].devices[device.id] = DeviceInstance(device.label, await DeviceDefinitionsLoader.get_device_definition(device.type, lang))
+                    state = await self.api.get_state(device.id)
+                    if state:
+                        self.gates[gates.id].devices[device.id].state = state
+                    else:
+                        _LOGGER.error("Failed to get state for device %s", device.id)
+                except ValueError:
+                    _LOGGER.warning("No definition found for device with code %d", device.type)
+        return True
+
+    async def update_state(self, device_id: int | None) -> None:
+        if device_id is None:
+            for gate in self.gates.values():
+                for device in gate.devices.keys():
+                    await self.update_state(device)
+            return
+
+        device = self.get_device(device_id)
+        if device is None:
+            _LOGGER.warning("No device found with ID %d", device_id)
+            return
+
+        state = await self.api.get_state(device_id)
+        if state:
+            device.state = state
+        else:
+            _LOGGER.error("Failed to get state for device %s", device_id)
+
+    def get_current_option(self, device_id: int, parameter: str | CompitParameter) -> str | None:
+        if isinstance(parameter, str):
+            parameter = CompitParameter(parameter)
+        device = self.get_device(device_id)
+        if not device:
+            return None
+        val = device.state.get_parameter_value(parameter.value)
+        param = PARAMS.get(parameter, None)
+        if param is None:
+            return None
+        for key, value in param.items():
+            if value == val:
+                return key
+        return None        
+
+    def get_device_parameter(self, device_id: int, parameter: str | CompitParameter) -> Param | str | None:
+        device = self.get_device(device_id)
+        if not device:
+            return None
+        return device.state.get_parameter_value(parameter if isinstance(parameter, str) else parameter.value)
+
+    async def select_device_option(self, device_id: int, parameter: str | CompitParameter, value: str) -> bool:
+        if isinstance(parameter, str):
+            parameter = CompitParameter(parameter)
+
+        param = PARAMS.get(parameter, None)
+        if param is None:
+                return False
+        val = param.get(value, None)
+        if val is None:
+                return False
+        result = await self.api.update_device_parameter(device_id, parameter, val)
+        if result is None:
+                return False
+            
+        device = self.get_device(device_id)
+        if device is None:
+                return False
+            
+        device.state.set_parameter_value(parameter if isinstance(parameter, str) else parameter.value, val)
+        return result
+
+    async def set_device_parameter(self, device_id: int, parameter: str | CompitParameter, value: str | float) -> bool:
+        result = await self.api.update_device_parameter(device_id, parameter, value)
+        if result:
+            device = self.get_device(device_id)
+            if device:
+                device.state.set_parameter_value(parameter if isinstance(parameter, str) else parameter.value, value)
+        return result
+
+