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

compit_inext_api/device_definitions.py

@@ -0,0 +1,44 @@
+from importlib import resources
+import json
+import logging
+import aiofiles
+
+from .types.DeviceDefinitions import DeviceDefinitions, Device
+
+_LOGGER: logging.Logger = logging.getLogger(__package__)
+
+class DeviceDefinitionsLoader:
+    """Class to load the device definitions from file."""
+    
+    cache: dict[str, DeviceDefinitions] = {}
+
+    @staticmethod
+    async def get_device_definitions(lang: str) -> DeviceDefinitions:
+        """Get the device definitions from file."""
+        file_name = f"devices_{lang}.json"
+
+        if lang in DeviceDefinitionsLoader.cache:
+            return DeviceDefinitionsLoader.cache[lang]
+
+        config_path = resources.files('compit_inext_api.definitions').joinpath(file_name)
+        try:        
+            async with aiofiles.open(config_path, encoding="utf-8", mode='r') as file:
+                content = await file.read()
+                definitions = DeviceDefinitions.from_json(json.loads(content))
+                DeviceDefinitionsLoader.cache[lang] = definitions
+                return definitions
+        except FileNotFoundError:
+            _LOGGER.warning("File %s not found", file_name)
+            if lang != "en":
+                _LOGGER.debug("Trying to load English definitions")
+                return await DeviceDefinitionsLoader.get_device_definitions("en")
+            raise ValueError("No definitions found") from None
+        
+    @staticmethod
+    async def get_device_definition(code: int, lang: str = "en") -> Device:
+        """Get the device definition for a specific device type."""
+        definitions = await DeviceDefinitionsLoader.get_device_definitions(lang)
+        for device in definitions.devices:
+            if device.code == code:
+                return device            
+        raise ValueError(f"No definition found for device with code {code}")

compit_inext_api/params_dictionary.py

@@ -0,0 +1,369 @@
+from .consts import CompitParameter
+
+PARAMS = {
+    CompitParameter.AEROKONFBYPASS: {
+        "off": 0,
+        "auto": 1,
+        "on": 2,
+    },
+    CompitParameter.ADDITIONAL_VENTILATION_ZONE: {
+        "gear_0": 0,
+        "gear_1": 1,
+        "gear_2": 2,
+        "gear_3": 3,
+        "gear_4": 4,
+    },
+    CompitParameter.LANGUAGE: {
+        "polish": 0,
+        "english": 1,
+    },
+    CompitParameter.NANO_MODE: {
+        "manual_3": 0,
+        "manual_2": 1,
+        "manual_1": 2,
+        "manual_0": 3,
+        "schedule": 4,
+        "christmas": 5,
+        "out_of_home": 6,
+    },
+    CompitParameter.VENTILATION_COMFORT_ZONE: {
+        "gear_0": 0,
+        "gear_1": 1,
+        "gear_2": 2,
+        "gear_3": 3,
+    },
+    CompitParameter.VENTILATION_ECO_ZONE: {
+        "gear_0": 0,
+        "gear_1": 1,
+        "gear_2": 2,
+        "gear_3": 3,
+    },
+    CompitParameter.VENTILATION_HOLIDAY_MODE: {
+        "gear_0": 0,
+        "gear_1": 1,
+        "gear_2": 2,
+        "gear_3": 3,
+    },
+    CompitParameter.AIRING_PROGRAM_ZONE_3: {
+        "no_exclusions": 0,
+        "30m_work30m_stop": 1,
+        "20m_work40m_stop": 2,
+        "20m_work100m_stop": 3,
+    },
+    CompitParameter.PRE_HEATER_ZONE_3: {
+        "disabled": 0,
+        "onoff": 1,
+        "pwm": 2,
+    },
+    CompitParameter.SECONDARY_HEATER_ZONE_3: {
+        "disabled": 0,
+        "onoff_room_temp": 1,
+        "onoff_outside_temp": 2,
+        "onoff": 3,
+        "pwm_room_temp": 4,
+        "pwm_outside_temp": 5,
+    },
+    CompitParameter.AIRING_PROGRAM_ZONE_4: {
+        "no_exclusions": 0,
+        "30m_work30m_stop": 1,
+        "20m_work40m_stop": 2,
+        "20m_work100m_stop": 3,
+    },
+    CompitParameter.AIRING_PROGRAM_ZONE_5: {
+        "no_exclusions": 0,
+        "30m_work30m_stop": 1,
+        "20m_work40m_stop": 2,
+        "20m_work100m_stop": 3,
+    },
+    CompitParameter.PRE_HEATER_ZONE_5: {
+        "disabled": 0,
+        "onoff": 1,
+        "pwm": 2,
+    },
+    CompitParameter.SECONDARY_HEATER_ZONE_5: {
+        "disabled": 0,
+        "pwm": 1,
+    },
+    CompitParameter.CIRCUIT_MODE_HEATING_ZONE_1: {
+        "pump": 0,
+        "mixer": 1,
+    },
+    CompitParameter.CIRCUIT_MODE_HEATING_ZONE_2: {
+        "pump": 0,
+        "mixer": 1,
+    },
+    CompitParameter.CIRCUIT_MODE_HEATING_ZONE_3: {
+        "pump": 0,
+        "mixer": 1,
+    },
+    CompitParameter.CIRCUIT_MODE_HEATING_ZONE_4: {
+        "pump": 0,
+        "mixer": 1,
+    },
+    CompitParameter.DHWC_CIRCULATION: {
+        "disabled": 0,
+        "schedule": 1,
+        "constant": 2,
+    },
+    CompitParameter.OPERATING_MODE: {
+        "disabled": 0,
+        "eco": 1,
+        "hybrid": 2,
+    },
+    CompitParameter.HEATING_MODE_ZONE_1: {
+        "disabled": 0,
+        "schedule": 1,
+        "manual": 2,
+    },
+    CompitParameter.HEATING_MODE_ZONE_2: {
+        "disabled": 0,
+        "schedule": 1,
+        "manual": 2,
+    },
+    CompitParameter.HEATING_MODE_ZONE_3: {
+        "disabled": 0,
+        "schedule": 1,
+        "manual": 2,
+    },
+    CompitParameter.HEATING_MODE_ZONE_4: {
+        "disabled": 0,
+        "schedule": 1,
+        "manual": 2,
+    },
+    CompitParameter.MIXER_MODE: {
+        "disabled": 0,
+        "no_corrections": 1,
+        "with_a_schedule": 2,
+        "with_thermostat": 3,
+        "nano_nr_1": 4,
+        "nano_nr_2": 5,
+        "nano_nr_3": 6,
+        "nano_nr_4": 7,
+        "nano_nr_5": 8,
+    },
+    CompitParameter.SOLAR_COMP_OPERATING_MODE: {
+        "auto": 1,
+        "de_icing": 2,
+        "holiday": 3,
+        "disabled": 4,
+    },
+    CompitParameter.HEATING_SOURCE_OF_CORRECTION_ZONE_1: {
+        "no_corrections": 0,
+        "schedule": 1,
+        "thermostat": 2,
+        "nano_nr_1": 3,
+        "nano_nr_2": 4,
+        "nano_nr_3": 5,
+        "nano_nr_4": 6,
+        "nano_nr_5": 7,
+    },
+    CompitParameter.HEATING_SOURCE_OF_CORRECTION_ZONE_2: {
+        "no_corrections": 0,
+        "schedule": 1,
+        "thermostat": 2,
+        "nano_nr_1": 3,
+        "nano_nr_2": 4,
+        "nano_nr_3": 5,
+        "nano_nr_4": 6,
+        "nano_nr_5": 7,
+    },
+    CompitParameter.HEATING_SOURCE_OF_CORRECTION_ZONE_3: {
+        "no_corrections": 0,
+        "schedule": 1,
+        "thermostat": 2,
+        "nano_nr_1": 3,
+        "nano_nr_2": 4,
+        "nano_nr_3": 5,
+        "nano_nr_4": 6,
+        "nano_nr_5": 7,
+    },
+    CompitParameter.HEATING_SOURCE_OF_CORRECTION_ZONE_4: {
+        "no_corrections": 0,
+        "schedule": 1,
+        "thermostat": 2,
+        "nano_nr_1": 3,
+        "nano_nr_2": 4,
+        "nano_nr_3": 5,
+        "nano_nr_4": 6,
+        "nano_nr_5": 7,
+    },
+    CompitParameter.R490_OPERATING_MODE: {
+        "disabled": 0,
+        "eco": 1,
+        "hybrid": 2,
+    },
+    CompitParameter.DHW_OPERATING_MODE: {
+        "schedule": 1,
+        "manual": 2,
+    },
+    CompitParameter.HEATING_OPERATING_MODE_ZONE_1: {
+        "disabled": 0,
+        "schedule": 1,
+        "manual": 2,
+    },
+    CompitParameter.HEATING_OPERATING_MODE_ZONE_2: {
+        "disabled": 0,
+        "schedule": 1,
+        "manual": 2,
+    },
+    CompitParameter.HEATING_OPERATING_MODE_ZONE_3: {
+        "disabled": 0,
+        "schedule": 1,
+        "manual": 2,
+    },
+    CompitParameter.HEATING_OPERATING_MODE_ZONE_4: {
+        "disabled": 0,
+        "schedule": 1,
+        "manual": 2,
+    },
+    CompitParameter.BUFFER_MODE: {
+        "disabled": 0,
+        "schedule": 1,
+        "manual": 2,
+    },
+    CompitParameter.R470_OPERATING_MODE: {
+        "disabled": 1,
+        "auto": 2,
+        "eco": 3,
+    },
+    CompitParameter.HEATING_SOURCE_OF_CORRECTION: {
+        "no_corrections": 1,
+        "schedule": 2,
+        "thermostat": 3,
+        "nano_nr_1": 4,
+        "nano_nr_2": 5,
+        "nano_nr_3": 6,
+        "nano_nr_4": 7,
+        "nano_nr_5": 8,
+    },
+    CompitParameter.MIXERMODE_ZONE_1: {
+        "no_corrections": 1,
+        "clock": 2,
+        "thermostat": 3,
+        "nano_nr_1": 4,
+        "nano_nr_2": 5,
+        "nano_nr_3": 6,
+        "nano_nr_4": 7,
+        "nano_nr_5": 8,
+    },
+    CompitParameter.DHW_MODE: {
+        "disabled": 0,
+        "constant": 1,
+        "schedule": 2,
+    },
+    CompitParameter.DHW_CIRCULATION_MODE: {
+        "disabled": 0,
+        "constant": 1,
+        "schedule": 2,
+    },
+    CompitParameter.R770_MIXER_MODE_ZONE_1: {
+        "disabled": 0,
+        "schedule": 1,
+        "thermostat": 2,
+        "nano_nr_1": 3,
+        "nano_nr_2": 4,
+        "nano_nr_3": 5,
+        "nano_nr_4": 6,
+        "nano_nr_5": 7,
+    },
+    CompitParameter.R770_MIXER_MODE_ZONE_2: {
+        "disabled": 0,
+        "schedule": 1,
+        "thermostat": 2,
+        "nano_nr_1": 3,
+        "nano_nr_2": 4,
+        "nano_nr_3": 5,
+        "nano_nr_4": 6,
+        "nano_nr_5": 7,
+    },
+    CompitParameter.R770_DHW_OPERATING_MODE: {
+        "disabled": 0,
+        "constant": 1,
+        "schedule": 2,
+    },
+    CompitParameter.R770_DHW_CIRCULATION_MODE: {
+        "disabled": 0,
+        "constant": 1,
+        "schedule": 2,
+    },
+    CompitParameter.BIOMAX_HEATING_SOURCE_OF_CORRECTION: {
+        "disabled": 0,
+        "no_corrections": 1,
+        "schedule": 2,
+        "thermostat": 3,
+        "nano_nr_1": 4,
+        "nano_nr_2": 5,
+        "nano_nr_3": 6,
+        "nano_nr_4": 7,
+        "nano_nr_5": 8,
+    },
+    CompitParameter.BIOMAX_MIXER_MODE_ZONE_1: {
+        "disabled": 0,
+        "without_thermostat": 1,
+        "no_corrections": 1,
+        "schedule": 2,
+        "thermostat": 3,
+        "nano_nr_1": 4,
+        "nano_nr_2": 5,
+        "nano_nr_3": 6,
+        "nano_nr_4": 7,
+        "nano_nr_5": 8,
+    },
+    CompitParameter.BIOMAX_MIXER_MODE_ZONE_2: {
+        "disabled": 0,
+        "without_thermostat": 1,
+        "no_corrections": 1,
+        "schedule": 2,
+        "thermostat": 3,
+        "nano_nr_1": 4,
+        "nano_nr_2": 5,
+        "nano_nr_3": 6,
+        "nano_nr_4": 7,
+        "nano_nr_5": 8,
+    },
+    CompitParameter.BIOMAX_DHW_MODE: {
+        "disabled": 0,
+        "constant": 1,
+        "schedule": 2,
+    },
+    CompitParameter.BIOMAX_DHW_CIRCULATION_MODE: {
+        "disabled": 0,
+        "constant": 1,
+        "schedule": 2,
+    },
+    CompitParameter.BIOMAX_DHW_CIRCULATION_MODE: {
+        "disabled": 0,
+        "constant": 1,
+        "schedule": 2,
+    },
+    CompitParameter.R350_HEATING_SOURCE_OF_CORRECTION: {
+        "no_corrections": 1,
+        "schedule": 2,
+        "thermostat": 3,
+        "nano_nr_1": 4,
+        "nano_nr_2": 5,
+        "nano_nr_3": 6,
+        "nano_nr_4": 7,
+        "nano_nr_5": 8,
+    },
+    CompitParameter.R480_DHW_CIRCULATION: {
+        "disabled": 0,
+        "schedule": 1,
+        "constant": 2,
+    },
+    CompitParameter.R480_OPERATING_MODE: {
+        "disabled": 0,
+        "eco": 1,
+        "hybrid": 2,
+    },
+    CompitParameter.R480_DHW_MODE: {
+        "disabled": 0,
+        "schedule": 1,
+        "manual": 2,
+    },
+    CompitParameter.R480_BUFFER_MODE: {
+        "disabled": 0,
+        "schedule": 1,
+        "manual": 2,
+    },
+}

compit_inext_api/types/DeviceDefinitions.py

@@ -0,0 +1,126 @@
+"""Module containing device definitions for compit which are deserialized from json."""  # noqa: INP001
+
+from typing import Any
+
+
+class ParameterDetails:
+    """Class representing the details of a parameter."""
+
+    def __init__(self, State: int, Description: str, Param: str) -> None:
+        """Initialize the ParameterDetails class.
+
+        Args:
+            State (int): The state of the parameter.
+            Description (str): The description of the parameter.
+            Param (str): The parameter value.
+
+        """
+        self.state = State
+        self.description = Description
+        self.param = Param
+
+
+class Parameter:
+    """Class representing a parameter."""
+
+    def __init__(
+        self,
+        ParameterCode: str,
+        Label: str,
+        ReadWrite: str = "R",
+        Details: list[dict[str, Any]] | None = None,
+        MinValue: float | None = None,
+        MaxValue: float | None = None,
+        Unit: str | None = None,
+        Type: str | None = None,
+    ) -> None:
+        """Initialize the DeviceDefinitions class."""
+
+        self.parameter_code = ParameterCode
+        self.label = Label
+        self.ReadOnly = ReadWrite == "R"
+        self.details = (
+            [ParameterDetails(**detail) if Details else None for detail in Details]
+            if Details
+            else None
+        )
+        self.min_value = MinValue
+        self.max_value = MaxValue
+        self.unit = Unit
+        self.type = Type
+
+
+class Device:
+    """Class representing a device."""
+
+    def __init__(
+        self,
+        name: str,
+        parameters: list[Parameter],
+        code: int,
+        device_class: int,
+        id: int | None,
+    ) -> None:
+        """Initialize the Device class.
+
+        Args:
+            name (str): The name of the device.
+            parameters (list[Parameter]): The list of parameters for the device.
+            code (int): The code of the device.
+            device_class (int): The class of the device.
+            id (int | None): The ID of the device.
+
+        """
+        self.name = name
+        self.parameters = parameters
+        self.code = code
+        self.device_class = device_class
+        self.id = id
+        self.type = type
+
+    @classmethod
+    def from_json(cls, data: dict[str, Any]):
+        """Create a DeviceDefinitions instance from JSON data.
+
+        Args:
+            data (dict[str, Any]): The JSON data representing the device definitions.
+
+        Returns:
+            DeviceDefinitions: The created DeviceDefinitions instance.
+
+        """
+        parameters = [Parameter(**param) for param in data.get("Parameters", [])]
+        return cls(
+            name=data["Name"],
+            parameters=parameters,
+            code=data["Code"],
+            device_class=data["Class"],
+            id=data.get("ID"),
+        )
+
+
+class DeviceDefinitions:
+    """Class representing device definitions."""
+
+    def __init__(self, devices: list[Device]) -> None:
+        """Initialize the DeviceDefinitions class.
+
+        Args:
+            devices (list[Device]): The list of devices.
+
+        """
+        self.devices = devices
+
+    @classmethod
+    def from_json(cls, data: Any):
+        """Create a DeviceDefinitions instance from JSON data.
+
+        Args:
+            data (Any): The JSON data representing the device definitions.
+
+        Returns:
+            DeviceDefinitions: The created DeviceDefinitions instance.
+
+        """
+        devices = [Device.from_json(device_data) for device_data in data]
+        return cls(devices=devices)

compit_inext_api/types/DeviceState.py

@@ -0,0 +1,137 @@
+"""Module containing params definitions."""  # noqa: INP001
+
+from typing import Any
+
+from .DeviceDefinitions import Device, Parameter
+
+
+class Param:
+    """Class representing a parameter."""
+
+    def __init__(
+        self,
+        code: str,
+        hidden: bool,
+        max: float | None,
+        min: float | None,
+        value: Any,
+        value_code: str | None,
+        value_label: str | None,
+        write: bool,
+        ext_info: dict | None = None,
+    ) -> None:
+        """Initialize the Param object."""
+        self.code = code
+        self.hidden = hidden
+        self.max = max
+        self.min = min
+        self.value = value
+        self.value_code = value_code
+        self.value_label = value_label
+        self.write = write
+        self.ext_info = ext_info
+
+
+class DeviceState:
+    """Class representing the state of a device."""
+
+    def __init__(
+        self, errors: list[Any], last_connected_at: str, params: list[Param]
+    ) -> None:
+        """Initialize the DeviceState object."""
+        self.errors = errors
+        self.last_connected_at = last_connected_at
+        self.params = params
+
+    def get_parameter_value(self, param: str | Parameter) -> Param | None:
+        """Get the value of a parameter by its code or parameter object.
+
+        Args:
+            param (str | Parameter): The code or parameter object.
+
+        Returns:
+            Param: The parameter object.
+
+        """
+
+        if isinstance(param, str):
+            return next(
+                (item for item in self.params if item and item.code == param), None
+            )
+        return next(
+            (
+                item
+                for item in self.params
+                if item and item.code == param.parameter_code
+            ),
+            None,
+        )
+
+    def set_parameter_value(self, param: str | Parameter, value: Any) -> bool:
+        """Set the value of a parameter by its code or parameter object.
+
+        Args:
+            param (str | Parameter): The code or parameter object.
+            value (Any): The new value of the parameter.
+        """
+        if isinstance(param, str):
+            parameter = next(
+                (item for item in self.params if item and item.code == param), None
+            )
+            if parameter:
+                parameter.value = value
+            return parameter is not None
+        else:
+            parameter = next(
+                (
+                    item
+                    for item in self.params
+                    if item and item.code == param.parameter_code
+                ),
+                None,
+            )
+            if parameter:
+                parameter.value = value
+            return parameter is not None
+
+    @classmethod
+    def from_json(cls, data: dict):
+        """Create a DeviceState object from JSON data."""
+        params = [
+            Param(
+                code=p["code"],
+                hidden=p["hidden"],
+                max=p.get("max"),
+                min=p.get("min"),
+                value=p["value"],
+                value_code=p.get("value_code"),
+                value_label=p.get("value_label"),
+                write=p["write"],
+                ext_info=p.get("ext_info"),
+            )
+            for p in data["params"]
+        ]
+        return cls(
+            errors=data["errors"],
+            last_connected_at=data["last_connected_at"],
+            params=params,
+        )
+
+
+class DeviceInstance:
+    """Class representing a device instance."""
+
+    def __init__(self, label: str, definition: Device | None) -> None:
+        """Initialize the DeviceInstance object."""
+        self.label = label
+        self.definition = definition
+        self.state: DeviceState
+
+class GateInstance:
+    """Class representing a gate instance."""
+
+    def __init__(self, id: int, label: str) -> None:
+        """Initialize the GateInstance object."""
+        self.id = id
+        self.label = label
+        self.devices: dict[int, DeviceInstance] = {}