compit-inext-api-beta 0.4.0b13__py3-none-any.whl

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/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/connector.py

@@ -0,0 +1,130 @@
+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
+                
+        param = PARAMS.get(parameter, None)
+        if param is None:
+            return None
+        
+        val = device.state.get_parameter_value(parameter.value)
+        if val is None:
+            return None
+        
+        for key, value in param.items():
+            if value == val.value:
+                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
+
+        

compit_inext_api/consts.py

@@ -0,0 +1,94 @@
+from enum import Enum
+
+
+class CompitHVACMode(Enum):
+    """Enum for available HVAC modes."""
+
+    HEAT = 0
+    OFF = 1
+    COOL = 2
+
+class CompitParameter(Enum):
+    """Enum for Compit device parameters."""
+
+    ADDITIONAL_VENTILATION_ZONE = "__trybaero2"
+    AEROKONFBYPASS = "__aerokonfbypass"
+    AIRING_PROGRAM_ZONE_3 = "__a3programwietrzenia"
+    AIRING_PROGRAM_ZONE_4 = "__a4programwietrzenia"
+    AIRING_PROGRAM_ZONE_5 = "__a5prwietrz"
+    BIOMAX_CIRCULATION_MODE = "__trybcyrkulacji"
+    BIOMAX_DHW_CIRCULATION_MODE = "__cwucyrkpraca"
+    BIOMAX_DHW_MODE = "__cwupraca"
+    BIOMAX_HEATING_SOURCE_OF_CORRECTION = "__pracakotla"
+    BIOMAX_MIXER_MODE_ZONE_1 = "__m1praca"
+    BIOMAX_MIXER_MODE_ZONE_2 = "__m2praca"
+    BUFFER_MODE = "__trprbufora"
+    CIRCUIT_MODE_HEATING_ZONE_1 = "__typ_obwo_co1"
+    CIRCUIT_MODE_HEATING_ZONE_2 = "__typ_obwo_co2"
+    CIRCUIT_MODE_HEATING_ZONE_3 = "__typ_obwo_co3"
+    CIRCUIT_MODE_HEATING_ZONE_4 = "__typ_obwo_co4"
+    CURRENT_TEMPERATURE = "__tpokojowa"
+    DHW_CIRCULATION_MODE = "__dhwcircmode"
+    DHW_MODE = "__dhwmode"
+    DHW_OPERATING_MODE = "__trybprcwu"
+    DHWC_CIRCULATION = "__cyrk_cwu"
+    FAN_MODE = "__trybaero"
+    HEATING_MODE_ZONE_1 = "__tr_pr_co1"
+    HEATING_MODE_ZONE_2 = "__tr_pr_co2"
+    HEATING_MODE_ZONE_3 = "__tr_pr_co3"
+    HEATING_MODE_ZONE_4 = "__tr_pr_co4"
+    HEATING_OPERATING_MODE_ZONE_1 = "__trprco1"
+    HEATING_OPERATING_MODE_ZONE_2 = "__trprco2"
+    HEATING_OPERATING_MODE_ZONE_3 = "__trprco3"
+    HEATING_OPERATING_MODE_ZONE_4 = "__trprco4"
+    HEATING_SOURCE_OF_CORRECTION = "__comode"
+    HEATING_SOURCE_OF_CORRECTION_ZONE_1 = "__co1zrodlokorekty"
+    HEATING_SOURCE_OF_CORRECTION_ZONE_2 = "_co2zrodlokorekty"
+    HEATING_SOURCE_OF_CORRECTION_ZONE_3 = "__co3zrodlokorekty"
+    HEATING_SOURCE_OF_CORRECTION_ZONE_4 = "__co4zrkorekty"
+    HVAC_MODE = "__trybpracyinstalacji"
+    LANGUAGE = "_jezyk"
+    MIXER_MODE = "__pracamieszacza"
+    MIXERMODE_ZONE_1 = "__mixer1mode"
+    NANO_MODE = "__nano_mode"
+    OPERATING_MODE = "__tr_pracy_pc"
+    PRE_HEATER_ZONE_3 = "__a3konfignagwst"
+    PRE_HEATER_ZONE_5 = "__a5trybnagrzwst"
+    PRESET_MODE = "__trybpracytermostatu"
+    R350_HEATING_SOURCE_OF_CORRECTION = "__tr_pr"
+    R470_OPERATING_MODE = "__mode"
+    R480_BUFFER_MODE = "__tr_buf"
+    R480_DHW_CIRCULATION = "__cwu_cyrkulacja"
+    R480_DHW_MODE = "__tryb_cwu"
+    R480_OPERATING_MODE = "__praca_pc"
+    R490_OPERATING_MODE = "__sezprinst"
+    R770_DHW_CIRCULATION_MODE = "__trybpracycyrkcwu"
+    R770_DHW_OPERATING_MODE = "__trybpracycwu"
+    R770_MIXER_MODE_ZONE_1 = "__trybmieszacza"
+    R770_MIXER_MODE_ZONE_2 = "__trybmie2"
+    SECONDARY_HEATER_ZONE_3 = "__a3konfignagwt"
+    SECONDARY_HEATER_ZONE_5 = "__a5trnagrzgl"
+    SET_TARGET_TEMPERATURE = "__tempzadpracareczna"
+    SOLAR_COMP_OPERATING_MODE = "__trybpracy"
+    TARGET_TEMPERATURE = "__tpokzadana"    
+    VENTILATION_COMFORT_ZONE = "__wentkomfort"
+    VENTILATION_ECO_ZONE = "__wenteko"
+    VENTILATION_HOLIDAY_MODE = "__wenturlop"
+
+class CompitFanMode(Enum):
+    """Enum for available fan modes."""
+
+    OFF = 0
+    LOW = 1
+    MEDIUM = 2
+    HIGH = 3
+    HOLIDAY = 4
+    AUTO = 5
+
+class CompitPresetMode(Enum):
+    """Enum for available preset modes."""
+    
+    AUTO = 0
+    HOLIDAY = 1
+    MANUAL = 2
+    AWAY = 3

compit_inext_api/definitions/__init__.py

@@ -0,0 +1 @@
+# Device definitions package