PyPlumIO 0.5.42__py3-none-any.whl → 0.5.43__py3-none-any.whl

pyplumio/parameters/mixer.py

@@ -0,0 +1,245 @@
+"""Contains mixer parameter descriptors."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from functools import cache
+from typing import TYPE_CHECKING
+
+from dataslots import dataslots
+
+from pyplumio.const import (
+    ATTR_DEVICE_INDEX,
+    ATTR_INDEX,
+    ATTR_VALUE,
+    FrameType,
+    ProductType,
+    UnitOfMeasurement,
+)
+from pyplumio.frames import Request
+from pyplumio.parameters import (
+    OffsetNumber,
+    OffsetNumberDescription,
+    Parameter,
+    ParameterDescription,
+    Switch,
+    SwitchDescription,
+)
+from pyplumio.structures.product_info import ProductInfo
+
+if TYPE_CHECKING:
+    from pyplumio.devices.mixer import Mixer
+
+
+@dataclass
+class MixerParameterDescription(ParameterDescription):
+    """Represents a mixer parameter description."""
+
+    __slots__ = ()
+
+
+class MixerParameter(Parameter):
+    """Represent a mixer parameter."""
+
+    __slots__ = ()
+
+    device: Mixer
+    description: MixerParameterDescription
+
+    async def create_request(self) -> Request:
+        """Create a request to change the parameter."""
+        return await Request.create(
+            FrameType.REQUEST_SET_MIXER_PARAMETER,
+            recipient=self.device.parent.address,
+            data={
+                ATTR_INDEX: self._index,
+                ATTR_VALUE: self.values.value,
+                ATTR_DEVICE_INDEX: self.device.index,
+            },
+        )
+
+
+@dataclass
+class MixerNumberDescription(MixerParameterDescription, OffsetNumberDescription):
+    """Represent a mixer number description."""
+
+    __slots__ = ()
+
+
+class MixerNumber(MixerParameter, OffsetNumber):
+    """Represents a mixer number."""
+
+    __slots__ = ()
+
+    description: MixerNumberDescription
+
+
+@dataslots
+@dataclass
+class MixerSwitchDescription(MixerParameterDescription, SwitchDescription):
+    """Represents a mixer switch description."""
+
+
+class MixerSwitch(MixerParameter, Switch):
+    """Represents a mixer switch."""
+
+    __slots__ = ()
+
+    description: MixerSwitchDescription
+
+
+PARAMETER_TYPES: dict[ProductType, list[MixerParameterDescription]] = {
+    ProductType.ECOMAX_P: [
+        MixerNumberDescription(
+            name="mixer_target_temp",
+            unit_of_measurement=UnitOfMeasurement.CELSIUS,
+        ),
+        MixerNumberDescription(
+            name="min_target_temp",
+            unit_of_measurement=UnitOfMeasurement.CELSIUS,
+        ),
+        MixerNumberDescription(
+            name="max_target_temp",
+            unit_of_measurement=UnitOfMeasurement.CELSIUS,
+        ),
+        MixerNumberDescription(
+            name="thermostat_decrease_target_temp",
+            unit_of_measurement=UnitOfMeasurement.CELSIUS,
+        ),
+        MixerSwitchDescription(
+            name="weather_control",
+        ),
+        MixerNumberDescription(
+            name="heating_curve",
+            step=0.1,
+        ),
+        MixerNumberDescription(
+            name="heating_curve_shift",
+            offset=20,
+            unit_of_measurement=UnitOfMeasurement.CELSIUS,
+        ),
+        MixerNumberDescription(
+            name="weather_factor",
+        ),
+        MixerNumberDescription(
+            name="work_mode",
+        ),
+        MixerNumberDescription(
+            name="mixer_input_dead_zone",
+            step=0.1,
+            unit_of_measurement=UnitOfMeasurement.CELSIUS,
+        ),
+        MixerSwitchDescription(
+            name="thermostat_operation",
+        ),
+        MixerNumberDescription(
+            name="thermostat_mode",
+        ),
+        MixerSwitchDescription(
+            name="disable_pump_on_thermostat",
+        ),
+        MixerSwitchDescription(
+            name="summer_work",
+        ),
+    ],
+    ProductType.ECOMAX_I: [
+        MixerNumberDescription(
+            name="work_mode",
+        ),
+        MixerNumberDescription(
+            name="circuit_target_temp",
+            unit_of_measurement=UnitOfMeasurement.CELSIUS,
+        ),
+        MixerNumberDescription(
+            name="day_target_temp",
+            unit_of_measurement=UnitOfMeasurement.CELSIUS,
+        ),
+        MixerNumberDescription(
+            name="night_target_temp",
+            unit_of_measurement=UnitOfMeasurement.CELSIUS,
+        ),
+        MixerNumberDescription(
+            name="min_target_temp",
+            unit_of_measurement=UnitOfMeasurement.CELSIUS,
+        ),
+        MixerNumberDescription(
+            name="max_target_temp",
+            unit_of_measurement=UnitOfMeasurement.CELSIUS,
+        ),
+        MixerSwitchDescription(
+            name="summer_work",
+        ),
+        MixerSwitchDescription(
+            name="weather_control",
+        ),
+        MixerNumberDescription(
+            name="enable_circuit",
+        ),
+        MixerNumberDescription(
+            name="constant_water_preset_temp",
+            unit_of_measurement=UnitOfMeasurement.CELSIUS,
+        ),
+        MixerNumberDescription(
+            name="thermostat_decrease_temp",
+            unit_of_measurement=UnitOfMeasurement.CELSIUS,
+        ),
+        MixerNumberDescription(
+            name="thermostat_correction",
+            unit_of_measurement=UnitOfMeasurement.CELSIUS,
+        ),
+        MixerSwitchDescription(
+            name="thermostat_pump_lock",
+        ),
+        MixerNumberDescription(
+            name="valve_opening_time",
+            unit_of_measurement=UnitOfMeasurement.SECONDS,
+        ),
+        MixerNumberDescription(
+            name="mixer_input_dead_zone",
+            step=0.1,
+            unit_of_measurement=UnitOfMeasurement.CELSIUS,
+        ),
+        MixerNumberDescription(
+            name="proportional_range",
+        ),
+        MixerNumberDescription(
+            name="integration_time_constant",
+        ),
+        MixerNumberDescription(
+            name="heating_curve",
+            step=0.1,
+        ),
+        MixerNumberDescription(
+            name="heating_curve_shift",
+            offset=20,
+            unit_of_measurement=UnitOfMeasurement.CELSIUS,
+        ),
+        MixerNumberDescription(
+            name="thermostat_mode",
+        ),
+        MixerNumberDescription(
+            name="decreasing_constant_water_temp",
+            unit_of_measurement=UnitOfMeasurement.CELSIUS,
+        ),
+    ],
+}
+
+
+@cache
+def get_mixer_parameter_types(
+    product_info: ProductInfo,
+) -> list[MixerParameterDescription]:
+    """Return cached mixer parameter types for specific product."""
+    return PARAMETER_TYPES[product_info.type]
+
+
+__all__ = [
+    "get_mixer_parameter_types",
+    "MixerNumber",
+    "MixerNumberDescription",
+    "MixerParameter",
+    "MixerParameterDescription",
+    "MixerSwitch",
+    "MixerSwitchDescription",
+    "PARAMETER_TYPES",
+]

pyplumio/parameters/thermostat.py

@@ -0,0 +1,197 @@
+"""Contains thermostat parameter descriptors."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from functools import cache
+from typing import TYPE_CHECKING
+
+from dataslots import dataslots
+
+from pyplumio.const import (
+    ATTR_INDEX,
+    ATTR_OFFSET,
+    ATTR_SIZE,
+    ATTR_VALUE,
+    FrameType,
+    UnitOfMeasurement,
+)
+from pyplumio.frames import Request
+from pyplumio.parameters import (
+    Number,
+    NumberDescription,
+    Parameter,
+    ParameterDescription,
+    ParameterValues,
+    Switch,
+    SwitchDescription,
+)
+
+if TYPE_CHECKING:
+    from pyplumio.devices.thermostat import Thermostat
+
+
+@dataclass
+class ThermostatParameterDescription(ParameterDescription):
+    """Represents a thermostat parameter description."""
+
+    __slots__ = ()
+
+    size: int = 1
+
+
+class ThermostatParameter(Parameter):
+    """Represents a thermostat parameter."""
+
+    __slots__ = ("offset",)
+
+    device: Thermostat
+    description: ThermostatParameterDescription
+    offset: int
+
+    def __init__(
+        self,
+        device: Thermostat,
+        description: ThermostatParameterDescription,
+        values: ParameterValues | None = None,
+        index: int = 0,
+        offset: int = 0,
+    ) -> None:
+        """Initialize a new thermostat parameter."""
+        self.offset = offset
+        super().__init__(device, description, values, index)
+
+    async def create_request(self) -> Request:
+        """Create a request to change the parameter."""
+        return await Request.create(
+            FrameType.REQUEST_SET_THERMOSTAT_PARAMETER,
+            recipient=self.device.parent.address,
+            data={
+                # Increase the index by one to account for thermostat
+                # profile, which is being set at ecoMAX device level.
+                ATTR_INDEX: self._index + 1,
+                ATTR_VALUE: self.values.value,
+                ATTR_OFFSET: self.offset,
+                ATTR_SIZE: self.description.size,
+            },
+        )
+
+
+@dataslots
+@dataclass
+class ThermostatNumberDescription(ThermostatParameterDescription, NumberDescription):
+    """Represent a thermostat number description."""
+
+
+class ThermostatNumber(ThermostatParameter, Number):
+    """Represents a thermostat number."""
+
+    __slots__ = ()
+
+    description: ThermostatNumberDescription
+
+
+@dataslots
+@dataclass
+class ThermostatSwitchDescription(ThermostatParameterDescription, SwitchDescription):
+    """Represents a thermostat switch description."""
+
+
+class ThermostatSwitch(ThermostatParameter, Switch):
+    """Represents a thermostat switch."""
+
+    __slots__ = ()
+
+    description: ThermostatSwitchDescription
+
+
+PARAMETER_TYPES: list[ThermostatParameterDescription] = [
+    ThermostatNumberDescription(
+        name="mode",
+    ),
+    ThermostatNumberDescription(
+        name="party_target_temp",
+        size=2,
+        step=0.1,
+        unit_of_measurement=UnitOfMeasurement.CELSIUS,
+    ),
+    ThermostatNumberDescription(
+        name="holidays_target_temp",
+        size=2,
+        step=0.1,
+        unit_of_measurement=UnitOfMeasurement.CELSIUS,
+    ),
+    ThermostatNumberDescription(
+        name="correction",
+        unit_of_measurement=UnitOfMeasurement.CELSIUS,
+    ),
+    ThermostatNumberDescription(
+        name="away_timer",
+        unit_of_measurement=UnitOfMeasurement.DAYS,
+    ),
+    ThermostatNumberDescription(
+        name="airing_timer",
+        unit_of_measurement=UnitOfMeasurement.DAYS,
+    ),
+    ThermostatNumberDescription(
+        name="party_timer",
+        unit_of_measurement=UnitOfMeasurement.DAYS,
+    ),
+    ThermostatNumberDescription(
+        name="holidays_timer",
+        unit_of_measurement=UnitOfMeasurement.DAYS,
+    ),
+    ThermostatNumberDescription(
+        name="hysteresis",
+        step=0.1,
+        unit_of_measurement=UnitOfMeasurement.CELSIUS,
+    ),
+    ThermostatNumberDescription(
+        name="day_target_temp",
+        size=2,
+        step=0.1,
+        unit_of_measurement=UnitOfMeasurement.CELSIUS,
+    ),
+    ThermostatNumberDescription(
+        name="night_target_temp",
+        size=2,
+        step=0.1,
+        unit_of_measurement=UnitOfMeasurement.CELSIUS,
+    ),
+    ThermostatNumberDescription(
+        name="antifreeze_target_temp",
+        size=2,
+        step=0.1,
+        unit_of_measurement=UnitOfMeasurement.CELSIUS,
+    ),
+    ThermostatNumberDescription(
+        name="heating_target_temp",
+        size=2,
+        step=0.1,
+        unit_of_measurement=UnitOfMeasurement.CELSIUS,
+    ),
+    ThermostatNumberDescription(
+        name="heating_timer",
+    ),
+    ThermostatNumberDescription(
+        name="off_timer",
+    ),
+]
+
+
+@cache
+def get_thermostat_parameter_types() -> list[ThermostatParameterDescription]:
+    """Return cached thermostat parameter types for specific product."""
+    return PARAMETER_TYPES
+
+
+__all__ = [
+    "get_thermostat_parameter_types",
+    "PARAMETER_TYPES",
+    "ThermostatNumber",
+    "ThermostatNumberDescription",
+    "ThermostatParameter",
+    "ThermostatParameterDescription",
+    "ThermostatSwitch",
+    "ThermostatSwitchDescription",
+]

pyplumio/protocol.py

@@ -25,7 +25,7 @@ from pyplumio.structures.network_info import (
 
 _LOGGER = logging.getLogger(__name__)
 
-_Callback: TypeAlias = Callable[[], Awaitable[None]]
+Callback: TypeAlias = Callable[[], Awaitable[None]]
 
 
 class Protocol(ABC):
@@ -34,7 +34,7 @@ class Protocol(ABC):
     connected: asyncio.Event
     reader: FrameReader | None
     writer: FrameWriter | None
-    _on_connection_lost: set[_Callback]
+    _on_connection_lost: set[Callback]
 
     def __init__(self) -> None:
         """Initialize a new protocol."""
@@ -51,7 +51,7 @@ class Protocol(ABC):
             self.writer = None
 
     @property
-    def on_connection_lost(self) -> set[_Callback]:
+    def on_connection_lost(self) -> set[Callback]:
         """Return the callbacks that'll be called on connection lost."""
         return self._on_connection_lost
 
@@ -236,3 +236,6 @@ class AsyncProtocol(Protocol, EventManager[PhysicalDevice]):
             await self.dispatch(name, device)
 
         return self.data[name]
+
+
+__all__ = ["Protocol", "DummyProtocol", "AsyncProtocol"]

pyplumio/stream.py

@@ -153,3 +153,6 @@ class FrameReader:
         _LOGGER.debug("Received frame: %s, bytes: %s", frame, buffer.hex())
 
         return frame
+
+
+__all__ = ["FrameReader", "FrameWriter"]

pyplumio/structures/__init__.py

@@ -51,3 +51,6 @@ class StructureDecoder(Structure, ABC):
         self, message: bytearray, offset: int = 0, data: dict[str, Any] | None = None
     ) -> tuple[dict[str, Any], int]:
         """Decode bytes and return message data and offset."""
+
+
+__all__ = ["Structure", "StructureDecoder"]

pyplumio/structures/alerts.py

@@ -39,21 +39,21 @@ DATETIME_INTERVALS: tuple[DateTimeInterval, ...] = (
 
 
 @lru_cache(maxsize=10)
-def _seconds_to_datetime(timestamp: int) -> datetime:
+def seconds_to_datetime(timestamp: int) -> datetime:
     """Convert timestamp to a datetime object.
 
     The ecoMAX controller stores alert time as a special timestamp value
     in seconds counted from Jan 1st, 2000.
     """
 
-    def _datetime_kwargs(timestamp: int) -> Generator[Any, None, None]:
+    def datetime_kwargs(timestamp: int) -> Generator[Any, None, None]:
         """Yield a tuple, that represents a single datetime kwarg."""
         for name, seconds, offset in DATETIME_INTERVALS:
             value = timestamp // seconds
             timestamp -= value * seconds
             yield name, (value + offset)
 
-    return datetime(**dict(_datetime_kwargs(timestamp)))
+    return datetime(**dict(datetime_kwargs(timestamp)))
 
 
 @dataclass
@@ -83,11 +83,11 @@ class AlertsStructure(StructureDecoder):
         offset += from_seconds.size
         to_seconds = UnsignedInt.from_bytes(message, offset)
         offset += to_seconds.size
-        from_dt = _seconds_to_datetime(from_seconds.value)
+        from_dt = seconds_to_datetime(from_seconds.value)
         to_dt = (
             None
             if to_seconds.value == MAX_UINT32
-            else _seconds_to_datetime(to_seconds.value)
+            else seconds_to_datetime(to_seconds.value)
         )
         with suppress(ValueError):
             code = AlertType(code)
@@ -119,3 +119,6 @@ class AlertsStructure(StructureDecoder):
             ),
             self._offset,
         )
+
+
+__all__ = ["AlertsStructure", "Alert"]

pyplumio/structures/boiler_load.py

@@ -27,3 +27,6 @@ class BoilerLoadStructure(StructureDecoder):
             return ensure_dict(data), offset
 
         return (ensure_dict(data, {ATTR_BOILER_LOAD: boiler_load}), offset)
+
+
+__all__ = ["ATTR_BOILER_LOAD", "BoilerLoadStructure"]

pyplumio/structures/boiler_power.py

@@ -28,3 +28,6 @@ class BoilerPowerStructure(StructureDecoder):
             return ensure_dict(data), offset
 
         return ensure_dict(data, {ATTR_BOILER_POWER: boiler_power.value}), offset
+
+
+__all__ = ["ATTR_BOILER_POWER", "BoilerPowerStructure"]