compit-inext-api-beta 0.4.0b10__tar.gz → 0.4.3b2__tar.gz

{compit_inext_api_beta-0.4.0b10 → compit_inext_api_beta-0.4.3b2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: compit-inext-api-beta
-Version: 0.4.0b10
+Version: 0.4.3b2
 Summary: Compit Inext API - Python client
 Author: Przemyslaw Grzywa
 License: Apache-2.0

{compit_inext_api_beta-0.4.0b10 → compit_inext_api_beta-0.4.3b2}/compit_inext_api/__init__.py

@@ -5,7 +5,7 @@ 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 .consts import CompitHVACMode, CompitParameter, CompitFanMode, CompitPresetMode, CompitDevice
 from .connector import CompitApiConnector
 
 __all__ = [
@@ -22,6 +22,7 @@ __all__ = [
     "Device",
     "InvalidAuth",
     "CannotConnect",
+    "CompitDevice",
     "CompitHVACMode",
     "CompitParameter", 
     "CompitFanMode",

{compit_inext_api_beta-0.4.0b10 → compit_inext_api_beta-0.4.3b2}/compit_inext_api/api.py

@@ -19,7 +19,7 @@ API_URL = "https://inext.compit.pl/mobile/v2/compit"
 class CompitAPI:
     """API client for Compit."""
 
-    def __init__(self, email, password, session: aiohttp.ClientSession) -> None:
+    def __init__(self, email: str, password: str, session: aiohttp.ClientSession) -> None:
         """Initialize the CompitAPI class."""
         self.email = email
         self.password = password
@@ -107,7 +107,7 @@ class CompitAPI:
         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}]}
+            data: dict[str, Any] = {"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
@@ -157,7 +157,7 @@ class ApiWrapper:
         self._session = session
 
     async def get(
-        self, url: str, headers: dict | None = None, auth: Any = None
+        self, url: str, headers: dict[str, Any] | None = None, auth: Any = None
     ) -> aiohttp.ClientResponse:
         """Run http GET method."""
         if headers is None:
@@ -171,8 +171,8 @@ class ApiWrapper:
     async def post(
         self,
         url: str,
-        data: dict | None = None,
-        headers: dict | None = None,
+        data: dict[str, Any] | None = None,
+        headers: dict[str, Any] | None = None,
         auth: Any = None,
     ) -> aiohttp.ClientResponse:
         """Run http POST method."""
@@ -189,8 +189,8 @@ class ApiWrapper:
     async def put(
         self,
         url: str,
-        data: dict | None = None,
-        headers: dict | None = None,
+        data: dict[str, Any] | None = None,
+        headers: dict[str, Any] | None = None,
         auth: Any = None,
     ) -> aiohttp.ClientResponse:
         """Run http PUT method."""
@@ -206,8 +206,8 @@ class ApiWrapper:
         self,
         method: str,
         url: str,
-        data: dict | None = None,
-        headers: dict | None = None,
+        data: dict[str, Any] | None = None,
+        headers: dict[str, Any] | None = None,
         auth: Any = None,
     ) -> Any:
         """Get information from the API."""

{compit_inext_api_beta-0.4.0b10 → compit_inext_api_beta-0.4.3b2}/compit_inext_api/connector.py

@@ -5,7 +5,8 @@ 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
+from compit_inext_api.params_dictionary import PARAMS
+from compit_inext_api.types.DeviceState import DeviceInstance, GateInstance, Param
 
 
 _LOGGER: logging.Logger = logging.getLogger(__package__)
@@ -18,7 +19,7 @@ class CompitApiConnector:
 
     @property
     def all_devices(self) -> dict[int, DeviceInstance]:
-        devices = {}
+        devices: dict[int, DeviceInstance] = {}
         for gate in self.gates.values():
             devices.update(gate.devices)
         return devices
@@ -32,7 +33,7 @@ class CompitApiConnector:
                 return gate.devices[device_id]
         return None
 
-    async def init(self, email: str, password: str, lang: str = "en") -> bool:
+    async def init(self, email: str, password: str, lang: str | None = None) -> bool:
         self.api = CompitAPI(email, password, self.session)
         self.systemInfo = await self.api.authenticate()
         if self.systemInfo is None:
@@ -43,7 +44,13 @@ class CompitApiConnector:
             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))
+                    self.gates[gates.id].devices[device.id] = DeviceInstance(
+                        device.label,
+                        await DeviceDefinitionsLoader.get_device_definition(
+                            device.type,
+                            lang=lang,
+                        ),
+                    )
                     state = await self.api.get_state(device.id)
                     if state:
                         self.gates[gates.id].devices[device.id].state = state
@@ -77,13 +84,19 @@ class CompitApiConnector:
         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
+        
+        val = device.state.get_parameter_value(parameter.value)
+        if val is None:
+            return None
+        
         for key, value in param.items():
-            if value == val:
+            if value == val.value:
                 return key
+            
         return None        
 
     def get_device_parameter(self, device_id: int, parameter: str | CompitParameter) -> Param | str | None:

{compit_inext_api_beta-0.4.0b10 → compit_inext_api_beta-0.4.3b2}/compit_inext_api/consts.py

@@ -91,4 +91,55 @@ class CompitPresetMode(Enum):
     AUTO = 0
     HOLIDAY = 1
     MANUAL = 2
-    AWAY = 3
+    AWAY = 3
+
+class CompitDevice(Enum):
+    """Enum for Compit devices.
+
+    The enum value is the device `Code`, so you can look up a device by code:
+    `CompitDevice(223) -> CompitDevice.NANO_COLOR_2`.
+
+    Each member also exposes:
+    - `label`: original device name
+    - `device_class`: device class id
+    """
+
+    label: str
+    device_class: int
+
+    def __new__(cls, label: str, code: int, device_class: int):
+        obj = object.__new__(cls)
+        obj._value_ = code
+        obj.label = label
+        obj.device_class = device_class
+        return obj
+
+    AF_1 = ("AF-1", 226, 48)
+    BIOMAX742_2 = ("BioMax742", 36, 15)
+    BIOMAX742 = ("BioMax742", 212, 15)
+    BIOMAX772 = ("BioMax772", 75, 15)
+    BIOMAX775 = ("BioMax775", 201, 15)
+    BWC310 = ("BWC310", 14, 69)
+    COMBO = ("COMBO", 227, 49)
+    COMBO_PRO = ("COMBO PRO", 229, 37)
+    EL750 = ("EL750", 210, 29)
+    L2 = ("L2", 17, 12)
+    NANO_COLOR = ("Nano Color", 12, 10)
+    NANO_COLOR_2 = ("Nano Color 2", 223, 10)
+    NANO_ONE = ("Nano One", 7, 10)
+    R_900 = ("R 900", 224, 47)
+    R350CWU = ("R350.CWU", 53, 36)
+    R350M = ("R350.M", 221, 14)
+    R350_T3 = ("R350 T3", 5, 14)
+    R470 = ("r470", 34, 16)
+    R480 = ("R480", 215, 43)
+    R490 = ("r490", 92, 33)
+    R770RS_R771RS = ("R770RS / R771RS", 91, 25)
+    R810 = ("R810", 3, 14)
+    R810_1 = ("R810", 222, 34)
+    CO2_SHC = ("SHC", 27, 15)
+    SOLARCOMP_951 = ("SolarComp 951", 44, 18)
+    SOLARCOMP971 = ("SolarComp971", 45, 18)
+    SPM_NANO_COLOR = ("SPM - Nano Color", 225, 27)
+    SPM_NANO_COLOR2 = ("SPM - Nano Color2", 0, 46)
+    SPM_NANO_COLOR2_1 = ("SPM - Nano Color2", 78, 46)

{compit_inext_api_beta-0.4.0b10 → compit_inext_api_beta-0.4.3b2}/compit_inext_api/definitions/devices_en.json

@@ -1,6 +1,6 @@
 [
     {
-      "Name": "Nano Color 3",
+      "Name": "Nano Color 2",
       "Parameters": [
         {
           "ParameterCode": "__tpokojowa",
@@ -22104,6 +22104,173 @@
       "Class": 46,
       "ID": ""
     },
+    {
+      "Name": "SPM - Nano Color2",
+      "Parameters": [
+        {
+          "ParameterCode": "__rr_co2",
+          "Label": "Co2",
+          "ReadWrite": "R",
+          "Details": null,
+          "MinValue": null,
+          "MaxValue": null,
+          "Unit": "ppm"
+        },
+        {
+          "ParameterCode": "__hig",
+          "Label": "Humidity",
+          "ReadWrite": "R",
+          "Details": null,
+          "MinValue": null,
+          "MaxValue": null,
+          "Unit": "%"
+        },
+        {
+          "ParameterCode": "__vocindex",
+          "Label": "Voc index (volatile compounds)",
+          "ReadWrite": "R",
+          "Details": null,
+          "MinValue": null,
+          "MaxValue": null,
+          "Unit": null
+        },
+        {
+          "ParameterCode": "__rr_pm1",
+          "Label": "Pm1",
+          "ReadWrite": "R",
+          "Details": null,
+          "MinValue": null,
+          "MaxValue": null,
+          "Unit": "ug/m3"
+        },
+        {
+          "ParameterCode": "__rr_pm2_5",
+          "Label": "Pm2.5",
+          "ReadWrite": "R",
+          "Details": null,
+          "MinValue": null,
+          "MaxValue": null,
+          "Unit": "ug/m3"
+        },
+        {
+          "ParameterCode": "__rr_pm4",
+          "Label": "Pm4",
+          "ReadWrite": "R",
+          "Details": null,
+          "MinValue": null,
+          "MaxValue": null,
+          "Unit": "ug/m3"
+        },
+        {
+          "ParameterCode": "__temp",
+          "Label": "Temperature",
+          "ReadWrite": "R",
+          "Details": null,
+          "MinValue": null,
+          "MaxValue": null,
+          "Unit": "C"
+        },
+        {
+          "ParameterCode": "__flaga_pyly",
+          "Label": "Dust",
+          "ReadWrite": "R",
+          "Details": [
+            {
+              "State": 1,
+              "Description": "Normal",
+              "Param": "__nie"
+            },
+            {
+              "State": 0,
+              "Description": "Exceeded",
+              "Param": "__tak"
+            }
+          ],
+          "MinValue": null,
+          "MaxValue": null,
+          "Unit": null
+        },
+        {
+          "ParameterCode": "__osuszanie",
+          "Label": "Drying",
+          "ReadWrite": "R",
+          "Details": [
+            {
+              "State": 1,
+              "Description": "Yes",
+              "Param": "__tak"
+            },
+            {
+              "State": 0,
+              "Description": "No",
+              "Param": "__nie"
+            }
+          ],
+          "MinValue": null,
+          "MaxValue": null,
+          "Unit": null
+        },
+        {
+          "ParameterCode": "__flaga_co2",
+          "Label": "Co2",
+          "ReadWrite": "R",
+          "Details": null,
+          "MinValue": null,
+          "MaxValue": null,
+          "Unit": null
+        },
+        {
+          "ParameterCode": "__rr_pm10",
+          "Label": "Pm10",
+          "ReadWrite": "R",
+          "Details": null,
+          "MinValue": null,
+          "MaxValue": null,
+          "Unit": "ug/m3"
+        },
+        {
+          "ParameterCode": "__rr_fl_temp",
+          "Label": "Temperature (flaga)",
+          "ReadWrite": "R",
+          "Details": [
+            {
+              "State": 0,
+              "Description": "Ok",
+              "Param": "__ok"
+            },
+            {
+              "State": 1,
+              "Description": "Not ok",
+              "Param": "__nie_ok"
+            }
+          ],
+          "MinValue": null,
+          "MaxValue": null,
+          "Unit": null
+        },
+        {
+          "ParameterCode": "__rt_odczyt_co2",
+          "Label": "Rt - co2 reading",
+          "ReadWrite": "R",
+          "Details": null,
+          "MinValue": null,
+          "MaxValue": null,
+          "Unit": "ppm"
+        },
+        {
+          "ParameterCode": "__rt_proc_co2",
+          "Label": "Rt - procent co2",
+          "ReadWrite": "R",
+          "Details": null,
+          "MinValue": null,
+          "MaxValue": null,
+          "Unit": "%"
+        }
+      ],
+      "Code": 0,
+      "Class": 46,
+      "ID": ""
+    },
     {
       "Name": "SPM - Nano Color",
       "Parameters": [

{compit_inext_api_beta-0.4.0b10 → compit_inext_api_beta-0.4.3b2}/compit_inext_api/device_definitions.py

@@ -1,7 +1,9 @@
 from importlib import resources
 import json
 import logging
-import aiofiles
+import aiofiles  # type: ignore
+
+from compit_inext_api.consts import CompitDevice
 
 from .types.DeviceDefinitions import DeviceDefinitions, Device
 
@@ -22,7 +24,7 @@ class DeviceDefinitionsLoader:
 
         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:
+            async with aiofiles.open(str(config_path), encoding="utf-8", mode='r') as file:
                 content = await file.read()
                 definitions = DeviceDefinitions.from_json(json.loads(content))
                 DeviceDefinitionsLoader.cache[lang] = definitions
@@ -35,8 +37,19 @@ class DeviceDefinitionsLoader:
             raise ValueError("No definitions found") from None
         
     @staticmethod
-    async def get_device_definition(code: int, lang: str = "en") -> Device:
+    async def get_device_definition(code: int, lang: str | None = None) -> Device:
         """Get the device definition for a specific device type."""
+        if not lang:
+            device = CompitDevice(code)
+            return Device(
+                name=device.label,
+                parameters=[],
+                code=int(device.value),
+                device_class=device.device_class,
+                id=None,
+            )
+
+
         definitions = await DeviceDefinitionsLoader.get_device_definitions(lang)
         for device in definitions.devices:
             if device.code == code:

{compit_inext_api_beta-0.4.0b10 → compit_inext_api_beta-0.4.3b2}/compit_inext_api/params_dictionary.py

@@ -226,7 +226,7 @@ PARAMS = {
         "auto": 2,
         "eco": 3,
     },
-    CompitParameter.HEATING_SOURCE_OF_CORRECTION_ZONE: {
+    CompitParameter.HEATING_SOURCE_OF_CORRECTION: {
         "no_corrections": 1,
         "schedule": 2,
         "thermostat": 3,
@@ -286,7 +286,7 @@ PARAMS = {
         "constant": 1,
         "schedule": 2,
     },
-    CompitParameter.BIOMAX775_HEATING_SOURCE_OF_CORRECTION_ZONE: {
+    CompitParameter.BIOMAX_HEATING_SOURCE_OF_CORRECTION: {
         "disabled": 0,
         "no_corrections": 1,
         "schedule": 2,
@@ -297,7 +297,7 @@ PARAMS = {
         "nano_nr_4": 7,
         "nano_nr_5": 8,
     },
-    CompitParameter.BIOMAX775_MIXER_MODE_ZONE_1: {
+    CompitParameter.BIOMAX_MIXER_MODE_ZONE_1: {
         "disabled": 0,
         "without_thermostat": 1,
         "no_corrections": 1,
@@ -309,7 +309,7 @@ PARAMS = {
         "nano_nr_4": 7,
         "nano_nr_5": 8,
     },
-    CompitParameter.BIOMAX775_MIXER_MODE_ZONE_2: {
+    CompitParameter.BIOMAX_MIXER_MODE_ZONE_2: {
         "disabled": 0,
         "without_thermostat": 1,
         "no_corrections": 1,
@@ -321,22 +321,22 @@ PARAMS = {
         "nano_nr_4": 7,
         "nano_nr_5": 8,
     },
-    CompitParameter.BIOMAX775_DHW_MODE: {
+    CompitParameter.BIOMAX_DHW_MODE: {
         "disabled": 0,
         "constant": 1,
         "schedule": 2,
     },
-    CompitParameter.BIOMAX775_DHW_CIRCULATION_MODE: {
+    CompitParameter.BIOMAX_DHW_CIRCULATION_MODE: {
         "disabled": 0,
         "constant": 1,
         "schedule": 2,
     },
-    CompitParameter.BIOMAX775_CIRCULATION_MODE: {
+    CompitParameter.BIOMAX_DHW_CIRCULATION_MODE: {
         "disabled": 0,
         "constant": 1,
         "schedule": 2,
     },
-    CompitParameter.R350_HEATING_SOURCE_OF_CORRECTION_ZONE: {
+    CompitParameter.R350_HEATING_SOURCE_OF_CORRECTION: {
         "no_corrections": 1,
         "schedule": 2,
         "thermostat": 3,

{compit_inext_api_beta-0.4.0b10 → compit_inext_api_beta-0.4.3b2}/compit_inext_api/types/DeviceState.py

@@ -18,7 +18,7 @@ class Param:
         value_code: str | None,
         value_label: str | None,
         write: bool,
-        ext_info: dict | None = None,
+        ext_info: dict[str, Any] | None = None,
     ) -> None:
         """Initialize the Param object."""
         self.code = code
@@ -95,7 +95,7 @@ class DeviceState:
             return parameter is not None
 
     @classmethod
-    def from_json(cls, data: dict):
+    def from_json(cls, data: dict[str, Any]):
         """Create a DeviceState object from JSON data."""
         params = [
             Param(
@@ -121,7 +121,7 @@ class DeviceState:
 class DeviceInstance:
     """Class representing a device instance."""
 
-    def __init__(self, label: str, definition: Device) -> None:
+    def __init__(self, label: str, definition: Device | None) -> None:
         """Initialize the DeviceInstance object."""
         self.label = label
         self.definition = definition

{compit_inext_api_beta-0.4.0b10 → compit_inext_api_beta-0.4.3b2}/compit_inext_api/types/SystemInfo.py

@@ -1,5 +1,8 @@
 """Module contains classes for system information."""  # noqa: INP001
 
+from typing import Any
+
+
 class Device:
     """Class representing a device in the system."""
 
@@ -30,7 +33,7 @@ class SystemInfo:
         self.gates = gates
 
     @classmethod
-    def from_json(cls, data: dict):
+    def from_json(cls, data: dict[str, Any]):
         """Create a SystemInfo instance from JSON data."""
         gates = [
             Gate(

{compit_inext_api_beta-0.4.0b10 → compit_inext_api_beta-0.4.3b2}/compit_inext_api_beta.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: compit-inext-api-beta
-Version: 0.4.0b10
+Version: 0.4.3b2
 Summary: Compit Inext API - Python client
 Author: Przemyslaw Grzywa
 License: Apache-2.0

{compit_inext_api_beta-0.4.0b10 → compit_inext_api_beta-0.4.3b2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "compit-inext-api-beta"
-version = "0.4.0b10"
+version = "0.4.3b2"
 description = "Compit Inext API - Python client"
 readme = "README.md"
 requires-python = ">=3.12"