aiocomfoconnect 0.3.1__tar.gz → 0.3.3__tar.gz

{aiocomfoconnect-0.3.1 → aiocomfoconnect-0.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aiocomfoconnect
-Version: 0.3.1
+Version: 0.3.3
 Summary: aiocomfoconnect is an asyncio Python 3 library for communicating with a Zehnder ComfoAir Q350/450/600 ventilation system
 License-File: LICENSE
 Author: Michaël Arnauts
@@ -84,6 +84,9 @@ $ python -m aiocomfoconnect get-property --host 192.168.1.213 1 1 8 9  # Unit 0x
 - `async set_sensor_ventmode_humidity_comfort(mode)`: Set the sensor based ventilation humidity comfort setting. (auto / on / off)
 - `async get_sensor_ventmode_humidity_protection()`: Get the sensor based ventilation humidity protection setting.
 - `async set_sensor_ventmode_humidity_protection(mode)`: Set the sensor based ventilation humidity protection setting. (auto / on / off)
+- `async get_property(prop)`: Get the value of a property, e.g. `PROPERTY_RMOT_HEATING_THRESHOLD`.
+- `async get_property_constraints(prop)`: Get the raw value of a numeric property, together with the range and step size the unit accepts.
+- `bridge_type`: The type of the bridge (`GatewayType.LANC`, `SEASON` or `PRO`). Discovery reports it, and a ComfoConnect Pro is also recognised once a session has started.
 
 ### Low-level API
 

{aiocomfoconnect-0.3.1 → aiocomfoconnect-0.3.3}/README.md

@@ -67,6 +67,9 @@ $ python -m aiocomfoconnect get-property --host 192.168.1.213 1 1 8 9  # Unit 0x
 - `async set_sensor_ventmode_humidity_comfort(mode)`: Set the sensor based ventilation humidity comfort setting. (auto / on / off)
 - `async get_sensor_ventmode_humidity_protection()`: Get the sensor based ventilation humidity protection setting.
 - `async set_sensor_ventmode_humidity_protection(mode)`: Set the sensor based ventilation humidity protection setting. (auto / on / off)
+- `async get_property(prop)`: Get the value of a property, e.g. `PROPERTY_RMOT_HEATING_THRESHOLD`.
+- `async get_property_constraints(prop)`: Get the raw value of a numeric property, together with the range and step size the unit accepts.
+- `bridge_type`: The type of the bridge (`GatewayType.LANC`, `SEASON` or `PRO`). Discovery reports it, and a ComfoConnect Pro is also recognised once a session has started.
 
 ### Low-level API
 

{aiocomfoconnect-0.3.1 → aiocomfoconnect-0.3.3}/aiocomfoconnect/bridge.py

@@ -13,7 +13,7 @@ from typing import Awaitable, Callable, Dict, Iterator, Optional, Set
 from google.protobuf.message import DecodeError
 from google.protobuf.message import Message as ProtobufMessage
 
-from .const import VENTILATION_UNIT_PRODUCT_IDS, ProductId, PdoType
+from .const import VENTILATION_UNIT_PRODUCT_IDS, GatewayType, ProductId, PdoType
 from .exceptions import (
     AioComfoConnectNotConnected,
     AioComfoConnectNotReachable,
@@ -34,7 +34,7 @@ from .protobuf import zehnder_pb2
 _LOGGER = logging.getLogger(__name__)
 
 TIMEOUT = 5
-GATEWAY_TYPE_PRO = 2
+GATEWAY_TYPE_PRO = GatewayType.PRO
 
 # How long we wait for the bridge to announce the ventilation unit before we give up.
 NODE_DISCOVERY_TIMEOUT = 5
@@ -126,6 +126,7 @@ class Bridge:
     ):
         self.host: str = host
         self.uuid: str = uuid
+        # One of GatewayType. Discovery reports it, and a ComfoConnect Pro also identifies itself when a session starts.
         self.bridge_type: int = bridge_type
         self._local_uuid: Optional[str] = None
 
@@ -490,15 +491,20 @@ class Bridge:
         except DecodeError as exc:
             _LOGGER.error("Failed to decode message: %s", exc)
 
-    def cmd_start_session(self, take_over: bool = False) -> Awaitable[Message]:
+    async def cmd_start_session(self, take_over: bool = False) -> Message:
         """Starts the session on the device by logging in and optionally disconnecting an already existing session."""
         _LOGGER.debug("StartSessionRequest")
         # pylint: disable=no-member
-        return self._send(
+        reply = await self._send(
             zehnder_pb2.StartSessionRequest,
             zehnder_pb2.GatewayOperation.StartSessionRequestType,
             {"takeover": take_over},
         )
+        # A ComfoConnect Pro sets the devicename of a successful session to "ccpro", a LAN C leaves it empty. This also
+        # tells us the type of a bridge that was connected to by IP address, without discovery.
+        if getattr(reply, "devicename", None) == "ccpro":
+            self.bridge_type = GatewayType.PRO
+        return reply
 
     def cmd_close_session(self) -> Awaitable[Message]:
         """Stops the current session."""

{aiocomfoconnect-0.3.1 → aiocomfoconnect-0.3.3}/aiocomfoconnect/comfoconnect.py

@@ -37,12 +37,22 @@ from aiocomfoconnect.exceptions import (
     ComfoConnectNotAllowed,
     VentilationUnitNotFoundException,
 )
-from aiocomfoconnect.properties import Property
+from aiocomfoconnect.properties import Property, PropertyConstraints
 from aiocomfoconnect.sensors import Sensor
 from aiocomfoconnect.util import bytearray_to_bits, bytestring, encode_pdo_value
 
 _LOGGER = logging.getLogger(__name__)
 
+# The size in bytes and the signedness of the numeric property types.
+NUMERIC_PROPERTY_TYPES = {
+    PdoType.TYPE_CN_UINT8: (1, False),
+    PdoType.TYPE_CN_UINT16: (2, False),
+    PdoType.TYPE_CN_UINT32: (4, False),
+    PdoType.TYPE_CN_INT8: (1, True),
+    PdoType.TYPE_CN_INT16: (2, True),
+    PdoType.TYPE_CN_INT64: (8, True),
+}
+
 
 class ComfoConnect(Bridge):
     """Abstraction layer over the ComfoConnect LAN C API."""
@@ -269,6 +279,21 @@ class ComfoConnect(Bridge):
 
         return result.message
 
+    async def get_property_constraints(self, prop: Property, node_id: Optional[int] = None) -> PropertyConstraints:
+        """Get the raw value of a numeric property, together with the range and step size the unit accepts, in one request."""
+        if prop.property_type not in NUMERIC_PROPERTY_TYPES:
+            raise ValueError(f"Property type {prop.property_type} has no range")
+        size, signed = NUMERIC_PROPERTY_TYPES[prop.property_type]
+
+        # Request the actual value (0x10), the range (0x20) and the step size (0x40) at once.
+        result = await self.cmd_rmi_request(bytes([0x01, prop.unit, prop.subunit, 0x70, prop.property_id]), node_id=node_id)
+
+        message = bytes(result.message)
+        if len(message) != 4 * size:
+            raise ValueError(f"Unexpected response length {len(message)} for a value with its range and step size")
+        value, minimum, maximum, step = (int.from_bytes(message[i : i + size], byteorder="little", signed=signed) for i in range(0, 4 * size, size))
+        return PropertyConstraints(value=value, minimum=minimum, maximum=maximum, step=step)
+
     async def get_multiple_properties(self, unit: int, subunit: int, property_ids: List[int], node_id: Optional[int] = None) -> Any:
         """Get multiple properties."""
         result = await self.cmd_rmi_request(bytestring([0x02, unit, subunit, 0x01, 0x10 | len(property_ids), bytes(property_ids)]), node_id=node_id)

{aiocomfoconnect-0.3.1 → aiocomfoconnect-0.3.3}/aiocomfoconnect/const.py

@@ -32,6 +32,14 @@ VENTILATION_UNIT_PRODUCT_IDS = (ProductId.COMFOAIRQ, ProductId.COMFOAIRFLEX)
 
 
 # PDO Types
+class GatewayType:
+    """Defines the type of a bridge, with the values of the GatewayType in the discovery response."""
+
+    LANC = 0  # ComfoConnect LAN C
+    SEASON = 1  # The built-in WiFi module of a ComfoAir Flex
+    PRO = 2  # ComfoConnect Pro
+
+
 class PdoType:
     """Defines a PDO type."""
 

{aiocomfoconnect-0.3.1 → aiocomfoconnect-0.3.3}/aiocomfoconnect/properties.py

@@ -24,6 +24,16 @@ class Property:
     property_type: int
 
 
+@dataclass
+class PropertyConstraints:
+    """The raw value of a numeric property, with the range and step size the unit accepts."""
+
+    value: int
+    minimum: int
+    maximum: int
+    step: int
+
+
 PROPERTY_SERIAL_NUMBER = Property(UNIT_NODE, 0x01, 0x04, PdoType.TYPE_CN_STRING)
 PROPERTY_FIRMWARE_VERSION = Property(UNIT_NODE, 0x01, 0x06, PdoType.TYPE_CN_UINT32)
 PROPERTY_MODEL = Property(UNIT_NODE, 0x01, 0x08, PdoType.TYPE_CN_STRING)
@@ -40,6 +50,12 @@ PROPERTY_SENSOR_VENTILATION_HUMIDITY_PROTECTION = Property(UNIT_TEMPHUMCONTROL,
 # Temperatures are stored in tenths of a degree.
 PROPERTY_RMOT_HEATING_THRESHOLD = Property(UNIT_TEMPHUMCONTROL, 0x01, 0x02, PdoType.TYPE_CN_INT16)
 PROPERTY_RMOT_COOLING_THRESHOLD = Property(UNIT_TEMPHUMCONTROL, 0x01, 0x03, PdoType.TYPE_CN_INT16)
+PROPERTY_PROFILE_TEMPERATURE_WARM = Property(UNIT_TEMPHUMCONTROL, 0x01, 0x0A, PdoType.TYPE_CN_INT16)
+PROPERTY_PROFILE_TEMPERATURE_NORMAL = Property(UNIT_TEMPHUMCONTROL, 0x01, 0x0B, PdoType.TYPE_CN_INT16)
+PROPERTY_PROFILE_TEMPERATURE_COOL = Property(UNIT_TEMPHUMCONTROL, 0x01, 0x0C, PdoType.TYPE_CN_INT16)
+
+# 0=adaptive (the target follows the RMOT), 1=fixed (the target is the temperature of the active profile).
+PROPERTY_TEMPERATURE_PROFILE_MODE = Property(UNIT_TEMPHUMCONTROL, 0x01, 0x08, PdoType.TYPE_CN_UINT8)
 
 # ComfoClime properties. These live on the ComfoClime node, not on the ventilation unit.
 PROPERTY_CLIME_AUTO_SEASON = Property(UNIT_CLIME_TEMPCONFIG, 0x01, 0x02, PdoType.TYPE_CN_UINT8)

{aiocomfoconnect-0.3.1 → aiocomfoconnect-0.3.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "aiocomfoconnect"
-version = "0.3.1"
+version = "0.3.3"
 description = "aiocomfoconnect is an asyncio Python 3 library for communicating with a Zehnder ComfoAir Q350/450/600 ventilation system"
 authors = ["Michaël Arnauts <michael.arnauts@gmail.com>"]
 readme = "README.md"