PyPlumIO 0.5.21__py3-none-any.whl → 0.5.23__py3-none-any.whl

pyplumio/structures/frame_versions.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from contextlib import suppress
 from typing import Any, Final
 
 from pyplumio.const import FrameType
@@ -21,15 +22,13 @@ class FrameVersionsStructure(StructureDecoder):
 
     def _unpack_frame_versions(self, message: bytearray) -> tuple[FrameType | int, int]:
         """Unpack frame versions."""
-        try:
-            frame_type = message[self._offset]
-            frame_type = FrameType(frame_type)
-        except ValueError:
-            pass
-
+        frame_type = message[self._offset]
         self._offset += 1
         version = UnsignedShort.from_bytes(message, self._offset)
         self._offset += version.size
+        with suppress(ValueError):
+            frame_type = FrameType(frame_type)
+
         return frame_type, version.value
 
     def decode(

pyplumio/structures/lambda_sensor.py

@@ -30,22 +30,22 @@ class LambdaSensorStructure(StructureDecoder):
         if lambda_state == BYTE_UNDEFINED:
             return ensure_dict(data), offset
 
-        with suppress(ValueError):
-            lambda_state = LambdaState(lambda_state)
-
         lambda_target = message[offset]
         offset += 1
         level = UnsignedShort.from_bytes(message, offset)
         offset += level.size
+        with suppress(ValueError):
+            lambda_state = LambdaState(lambda_state)
+
         return (
             ensure_dict(
                 data,
                 {
                     ATTR_LAMBDA_STATE: lambda_state,
                     ATTR_LAMBDA_TARGET: lambda_target,
-                    ATTR_LAMBDA_LEVEL: None
-                    if math.isnan(level.value)
-                    else (level.value / 10),
+                    ATTR_LAMBDA_LEVEL: (
+                        None if math.isnan(level.value) else (level.value / 10)
+                    ),
                 },
             ),
             offset,

pyplumio/structures/mixer_parameters.py

@@ -6,6 +6,8 @@ from collections.abc import Generator
 from dataclasses import dataclass
 from typing import TYPE_CHECKING, Any, Final
 
+from dataslots import dataslots
+
 from pyplumio.const import (
     ATTR_DEVICE_INDEX,
     ATTR_INDEX,
@@ -16,14 +18,16 @@ from pyplumio.const import (
 )
 from pyplumio.frames import Request
 from pyplumio.helpers.parameter import (
-    BinaryParameter,
-    BinaryParameterDescription,
+    SET_RETRIES,
+    Number,
+    NumberDescription,
     Parameter,
     ParameterDescription,
     ParameterValues,
+    Switch,
+    SwitchDescription,
     unpack_parameter,
 )
-from pyplumio.helpers.typing import ParameterValueType
 from pyplumio.structures import StructureDecoder
 from pyplumio.utils import ensure_dict
 
@@ -35,8 +39,18 @@ ATTR_MIXER_PARAMETERS: Final = "mixer_parameters"
 MIXER_PARAMETER_SIZE: Final = 3
 
 
+@dataclass
+class MixerParameterDescription(ParameterDescription):
+    """Represents a mixer parameter description."""
+
+    __slots__ = ()
+
+    multiplier: float = 1.0
+    offset: int = 0
+
+
 class MixerParameter(Parameter):
-    """Represents a mixer parameter."""
+    """Represent a mixer parameter."""
 
     __slots__ = ()
 
@@ -55,140 +69,191 @@ class MixerParameter(Parameter):
             },
         )
 
-    async def set(self, value: ParameterValueType, retries: int = 5) -> bool:
-        """Set a parameter value."""
-        if isinstance(value, (int, float)):
-            value = int((value + self.description.offset) / self.description.multiplier)
 
+@dataslots
+@dataclass
+class MixerNumberDescription(MixerParameterDescription, NumberDescription):
+    """Represent a mixer number description."""
+
+
+class MixerNumber(MixerParameter, Number):
+    """Represents a mixer number."""
+
+    __slots__ = ()
+
+    description: MixerNumberDescription
+
+    async def set(self, value: int | float, retries: int = SET_RETRIES) -> bool:
+        """Set a parameter value."""
+        value = (value + self.description.offset) / self.description.multiplier
         return await super().set(value, retries)
 
     @property
-    def value(self) -> ParameterValueType:
+    def value(self) -> float:
         """Return the parameter value."""
         return (
             self.values.value - self.description.offset
         ) * self.description.multiplier
 
     @property
-    def min_value(self) -> ParameterValueType:
+    def min_value(self) -> float:
         """Return the minimum allowed value."""
         return (
             self.values.min_value - self.description.offset
         ) * self.description.multiplier
 
     @property
-    def max_value(self) -> ParameterValueType:
+    def max_value(self) -> float:
         """Return the maximum allowed value."""
         return (
             self.values.max_value - self.description.offset
         ) * self.description.multiplier
 
 
-class MixerBinaryParameter(BinaryParameter, MixerParameter):
-    """Represents a mixer binary parameter."""
-
-    __slots__ = ()
-
-
+@dataslots
 @dataclass
-class MixerParameterDescription(ParameterDescription):
-    """Represents a mixer parameter description."""
+class MixerSwitchDescription(MixerParameterDescription, SwitchDescription):
+    """Represents a mixer switch description."""
 
-    multiplier: float = 1
-    offset: int = 0
 
+class MixerSwitch(MixerParameter, Switch):
+    """Represents a mixer switch."""
 
-@dataclass
-class MixerBinaryParameterDescription(
-    MixerParameterDescription, BinaryParameterDescription
-):
-    """Represents a mixer binary parameter description."""
+    __slots__ = ()
+
+    description: MixerSwitchDescription
 
 
 MIXER_PARAMETERS: dict[ProductType, tuple[MixerParameterDescription, ...]] = {
     ProductType.ECOMAX_P: (
-        MixerParameterDescription(
-            name="mixer_target_temp", unit_of_measurement=UnitOfMeasurement.CELSIUS
+        MixerNumberDescription(
+            name="mixer_target_temp",
+            unit_of_measurement=UnitOfMeasurement.CELSIUS,
         ),
-        MixerParameterDescription(
-            name="min_target_temp", unit_of_measurement=UnitOfMeasurement.CELSIUS
+        MixerNumberDescription(
+            name="min_target_temp",
+            unit_of_measurement=UnitOfMeasurement.CELSIUS,
         ),
-        MixerParameterDescription(
-            name="max_target_temp", unit_of_measurement=UnitOfMeasurement.CELSIUS
+        MixerNumberDescription(
+            name="max_target_temp",
+            unit_of_measurement=UnitOfMeasurement.CELSIUS,
         ),
-        MixerParameterDescription(
+        MixerNumberDescription(
             name="thermostat_decrease_target_temp",
             unit_of_measurement=UnitOfMeasurement.CELSIUS,
         ),
-        MixerBinaryParameterDescription(name="weather_control"),
-        MixerParameterDescription(name="heating_curve", multiplier=0.1),
-        MixerParameterDescription(
+        MixerSwitchDescription(
+            name="weather_control",
+        ),
+        MixerNumberDescription(
+            name="heating_curve",
+            multiplier=0.1,
+        ),
+        MixerNumberDescription(
             name="heating_curve_shift",
             offset=20,
             unit_of_measurement=UnitOfMeasurement.CELSIUS,
         ),
-        MixerParameterDescription(name="weather_factor"),
-        MixerParameterDescription(name="work_mode"),
-        MixerParameterDescription(
+        MixerNumberDescription(
+            name="weather_factor",
+        ),
+        MixerNumberDescription(
+            name="work_mode",
+        ),
+        MixerNumberDescription(
             name="mixer_input_dead_zone",
             multiplier=0.1,
             unit_of_measurement=UnitOfMeasurement.CELSIUS,
         ),
-        MixerBinaryParameterDescription(name="thermostat_operation"),
-        MixerParameterDescription(name="thermostat_mode"),
-        MixerBinaryParameterDescription(name="disable_pump_on_thermostat"),
-        MixerBinaryParameterDescription(name="summer_work"),
+        MixerSwitchDescription(
+            name="thermostat_operation",
+        ),
+        MixerNumberDescription(
+            name="thermostat_mode",
+        ),
+        MixerSwitchDescription(
+            name="disable_pump_on_thermostat",
+        ),
+        MixerSwitchDescription(
+            name="summer_work",
+        ),
     ),
     ProductType.ECOMAX_I: (
-        MixerParameterDescription(name="work_mode"),
-        MixerParameterDescription(
-            name="circuit_target_temp", unit_of_measurement=UnitOfMeasurement.CELSIUS
+        MixerNumberDescription(
+            name="work_mode",
+        ),
+        MixerNumberDescription(
+            name="circuit_target_temp",
+            unit_of_measurement=UnitOfMeasurement.CELSIUS,
         ),
-        MixerParameterDescription(
-            name="day_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,
         ),
-        MixerParameterDescription(
-            name="night_target_temp", unit_of_measurement=UnitOfMeasurement.CELSIUS
+        MixerSwitchDescription(
+            name="summer_work",
         ),
-        MixerParameterDescription(
-            name="min_target_temp", unit_of_measurement=UnitOfMeasurement.CELSIUS
+        MixerSwitchDescription(
+            name="weather_control",
         ),
-        MixerParameterDescription(
-            name="max_target_temp", unit_of_measurement=UnitOfMeasurement.CELSIUS
+        MixerNumberDescription(
+            name="enable_circuit",
         ),
-        MixerBinaryParameterDescription(name="summer_work"),
-        MixerBinaryParameterDescription(name="weather_control"),
-        MixerParameterDescription(name="enable_circuit"),
-        MixerParameterDescription(
+        MixerNumberDescription(
             name="constant_water_preset_temp",
             unit_of_measurement=UnitOfMeasurement.CELSIUS,
         ),
-        MixerParameterDescription(
+        MixerNumberDescription(
             name="thermostat_decrease_temp",
             unit_of_measurement=UnitOfMeasurement.CELSIUS,
         ),
-        MixerParameterDescription(
-            name="thermostat_correction", unit_of_measurement=UnitOfMeasurement.CELSIUS
+        MixerNumberDescription(
+            name="thermostat_correction",
+            unit_of_measurement=UnitOfMeasurement.CELSIUS,
+        ),
+        MixerSwitchDescription(
+            name="thermostat_pump_lock",
         ),
-        MixerBinaryParameterDescription(name="thermostat_pump_lock"),
-        MixerParameterDescription(
-            name="valve_opening_time", unit_of_measurement=UnitOfMeasurement.SECONDS
+        MixerNumberDescription(
+            name="valve_opening_time",
+            unit_of_measurement=UnitOfMeasurement.SECONDS,
         ),
-        MixerParameterDescription(
+        MixerNumberDescription(
             name="mixer_input_dead_zone",
             multiplier=0.1,
             unit_of_measurement=UnitOfMeasurement.CELSIUS,
         ),
-        MixerParameterDescription(name="proportional_range"),
-        MixerParameterDescription(name="integration_time_constant"),
-        MixerParameterDescription(name="heating_curve", multiplier=0.1),
-        MixerParameterDescription(
+        MixerNumberDescription(
+            name="proportional_range",
+        ),
+        MixerNumberDescription(
+            name="integration_time_constant",
+        ),
+        MixerNumberDescription(
+            name="heating_curve",
+            multiplier=0.1,
+        ),
+        MixerNumberDescription(
             name="heating_curve_shift",
             offset=20,
             unit_of_measurement=UnitOfMeasurement.CELSIUS,
         ),
-        MixerParameterDescription(name="thermostat_mode"),
-        MixerParameterDescription(
+        MixerNumberDescription(
+            name="thermostat_mode",
+        ),
+        MixerNumberDescription(
             name="decreasing_constant_water_temp",
             unit_of_measurement=UnitOfMeasurement.CELSIUS,
         ),

pyplumio/structures/network_info.py

@@ -66,9 +66,8 @@ class NetworkInfoStructure(Structure):
 
     def encode(self, data: dict[str, Any]) -> bytearray:
         """Encode data to the bytearray message."""
-        message = bytearray()
-        message += b"\x01"
-        network_info = data[ATTR_NETWORK] if ATTR_NETWORK in data else NetworkInfo()
+        message = bytearray(b"\x01")
+        network_info: NetworkInfo = data.get(ATTR_NETWORK, NetworkInfo())
         message += IPv4(network_info.eth.ip).to_bytes()
         message += IPv4(network_info.eth.netmask).to_bytes()
         message += IPv4(network_info.eth.gateway).to_bytes()

pyplumio/structures/product_info.py

@@ -53,16 +53,12 @@ class ProductInfoStructure(StructureDecoder):
         """Decode bytes and return message data and offset."""
         product_type, product_id = struct.unpack_from("<BH", message)
         offset += 3
-
         uid = VarBytes.from_bytes(message, offset)
         offset += uid.size
-
         logo = UnsignedShort.from_bytes(message, offset)
         offset += logo.size
-
         image = UnsignedShort.from_bytes(message, offset)
         offset += image.size
-
         model_name = VarString.from_bytes(message, offset)
         offset += model_name.size
 

pyplumio/structures/program_version.py

@@ -14,7 +14,7 @@ ATTR_VERSION: Final = "version"
 
 VERSION_INFO_SIZE: Final = 15
 
-SOFTWARE_VERSION: str = ".".join(str(x) for x in __version_tuple__[0:3])
+SOFTWARE_VERSION: Final = ".".join(str(x) for x in __version_tuple__[0:3])
 
 struct_program_version = struct.Struct("<2sB2s3s3HB")
 
@@ -38,7 +38,7 @@ class ProgramVersionStructure(Structure):
     def encode(self, data: dict[str, Any]) -> bytearray:
         """Encode data to the bytearray message."""
         message = bytearray(struct_program_version.size)
-        version_info = data[ATTR_VERSION] if ATTR_VERSION in data else VersionInfo()
+        version_info: VersionInfo = data.get(ATTR_VERSION, VersionInfo())
         struct_program_version.pack_into(
             message,
             0,
@@ -55,22 +55,29 @@ class ProgramVersionStructure(Structure):
         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."""
-        version_info = VersionInfo()
-        [
-            version_info.struct_tag,
-            version_info.struct_version,
-            version_info.device_id,
-            version_info.processor_signature,
-            software_version1,
-            software_version2,
-            software_version3,
-            self.frame.recipient,
-        ] = struct_program_version.unpack_from(message)
-        version_info.software = ".".join(
-            map(str, [software_version1, software_version2, software_version3])
-        )
+        (
+            struct_tag,
+            struct_version,
+            device_id,
+            processor_signature,
+            software1,
+            software2,
+            software3,
+            _,  # recipient
+        ) = struct_program_version.unpack_from(message)
 
         return (
-            ensure_dict(data, {ATTR_VERSION: version_info}),
+            ensure_dict(
+                data,
+                {
+                    ATTR_VERSION: VersionInfo(
+                        software=".".join(map(str, [software1, software2, software3])),
+                        struct_tag=struct_tag,
+                        struct_version=struct_version,
+                        device_id=device_id,
+                        processor_signature=processor_signature,
+                    )
+                },
+            ),
             offset + VERSION_INFO_SIZE,
         )

pyplumio/structures/schedules.py

@@ -8,6 +8,8 @@ from functools import reduce
 from itertools import chain
 from typing import Any, Final
 
+from dataslots import dataslots
+
 from pyplumio.const import (
     ATTR_PARAMETER,
     ATTR_SCHEDULE,
@@ -19,11 +21,13 @@ from pyplumio.devices import AddressableDevice, Device
 from pyplumio.exceptions import FrameDataError
 from pyplumio.frames import Request
 from pyplumio.helpers.parameter import (
-    BinaryParameter,
-    BinaryParameterDescription,
+    Number,
+    NumberDescription,
     Parameter,
     ParameterDescription,
     ParameterValues,
+    Switch,
+    SwitchDescription,
     unpack_parameter,
 )
 from pyplumio.structures import Structure
@@ -80,12 +84,20 @@ SCHEDULES: tuple[str, ...] = (
 )
 
 
+@dataclass
+class ScheduleParameterDescription(ParameterDescription):
+    """Represent a schedule parameter description."""
+
+    __slots__ = ()
+
+
 class ScheduleParameter(Parameter):
     """Represents a schedule parameter."""
 
     __slots__ = ()
 
     device: AddressableDevice
+    description: ScheduleParameterDescription
 
     async def create_request(self) -> Request:
         """Create a request to change the parameter."""
@@ -97,32 +109,40 @@ class ScheduleParameter(Parameter):
         )
 
 
-class ScheduleBinaryParameter(ScheduleParameter, BinaryParameter):
-    """Represents a schedule binary parameter."""
+@dataslots
+@dataclass
+class ScheduleNumberDescription(ScheduleParameterDescription, NumberDescription):
+    """Represents a schedule number description."""
+
+
+class ScheduleNumber(ScheduleParameter, Number):
+    """Represents a schedule number."""
 
     __slots__ = ()
 
+    description: ScheduleNumberDescription
 
+
+@dataslots
 @dataclass
-class ScheduleParameterDescription(ParameterDescription):
-    """Represents a schedule parameter description."""
+class ScheduleSwitchDescription(ScheduleParameterDescription, SwitchDescription):
+    """Represents a schedule switch description."""
 
 
-@dataclass
-class ScheduleBinaryParameterDescription(
-    BinaryParameterDescription, ScheduleParameterDescription
-):
-    """Represents a schedule binary parameter description."""
+class ScheduleSwitch(ScheduleParameter, Switch):
+    """Represents a schedule switch."""
+
+    __slots__ = ()
+
+    description: ScheduleSwitchDescription
 
 
 SCHEDULE_PARAMETERS: list[ScheduleParameterDescription] = list(
     chain.from_iterable(
         [
             [
-                ScheduleBinaryParameterDescription(
-                    name=f"{name}_{ATTR_SCHEDULE_SWITCH}"
-                ),
-                ScheduleParameterDescription(name=f"{name}_{ATTR_SCHEDULE_PARAMETER}"),
+                ScheduleSwitchDescription(name=f"{name}_{ATTR_SCHEDULE_SWITCH}"),
+                ScheduleNumberDescription(name=f"{name}_{ATTR_SCHEDULE_PARAMETER}"),
             ]
             for name in SCHEDULES
         ]