PyPlumIO 0.5.2__tar.gz → 0.5.3__tar.gz

{PyPlumIO-0.5.2 → PyPlumIO-0.5.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyPlumIO
-Version: 0.5.2
+Version: 0.5.3
 Summary: PyPlumIO is a native ecoNET library for Plum ecoMAX controllers.
 Author-email: Denis Paavilainen <denpa@denpa.pro>
 License: MIT License

{PyPlumIO-0.5.2 → PyPlumIO-0.5.3}/PyPlumIO.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyPlumIO
-Version: 0.5.2
+Version: 0.5.3
 Summary: PyPlumIO is a native ecoNET library for Plum ecoMAX controllers.
 Author-email: Denis Paavilainen <denpa@denpa.pro>
 License: MIT License

{PyPlumIO-0.5.2 → PyPlumIO-0.5.3}/PyPlumIO.egg-info/SOURCES.txt

@@ -61,6 +61,8 @@ pyplumio/helpers/typing.py
 pyplumio/helpers/uid.py
 pyplumio/structures/__init__.py
 pyplumio/structures/alerts.py
+pyplumio/structures/boiler_load.py
+pyplumio/structures/boiler_power.py
 pyplumio/structures/data_schema.py
 pyplumio/structures/ecomax_parameters.py
 pyplumio/structures/fan_power.py
@@ -68,7 +70,6 @@ pyplumio/structures/frame_versions.py
 pyplumio/structures/fuel_consumption.py
 pyplumio/structures/fuel_level.py
 pyplumio/structures/lambda_sensor.py
-pyplumio/structures/load.py
 pyplumio/structures/mixer_parameters.py
 pyplumio/structures/mixer_sensors.py
 pyplumio/structures/modules.py
@@ -76,7 +77,6 @@ pyplumio/structures/network_info.py
 pyplumio/structures/output_flags.py
 pyplumio/structures/outputs.py
 pyplumio/structures/pending_alerts.py
-pyplumio/structures/power.py
 pyplumio/structures/product_info.py
 pyplumio/structures/program_version.py
 pyplumio/structures/regulator_data.py

{PyPlumIO-0.5.2 → PyPlumIO-0.5.3}/pyplumio/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.5.2'
-__version_tuple__ = version_tuple = (0, 5, 2)
+__version__ = version = '0.5.3'
+__version_tuple__ = version_tuple = (0, 5, 3)

{PyPlumIO-0.5.2 → PyPlumIO-0.5.3}/pyplumio/devices/ecomax.py

@@ -12,8 +12,6 @@ from pyplumio.const import (
     ATTR_PASSWORD,
     ATTR_SENSORS,
     ATTR_STATE,
-    STATE_OFF,
-    STATE_ON,
     DeviceState,
     DeviceType,
     FrameType,
@@ -212,14 +210,7 @@ class EcoMAX(Addressable):
             )
             await self.dispatch(
                 description.name,
-                cls(
-                    device=self,
-                    description=description,
-                    index=index,
-                    value=values.value,
-                    min_value=values.min_value,
-                    max_value=values.max_value,
-                ),
+                cls(device=self, description=description, index=index, values=values),
             )
 
         return True
@@ -322,14 +313,7 @@ class EcoMAX(Addressable):
             )
             await self.dispatch(
                 description.name,
-                cls(
-                    device=self,
-                    description=description,
-                    index=index,
-                    value=values.value,
-                    min_value=values.min_value,
-                    max_value=values.max_value,
-                ),
+                cls(device=self, description=description, index=index, values=values),
             )
 
         return True
@@ -354,9 +338,11 @@ class EcoMAX(Addressable):
             EcomaxBinaryParameter(
                 device=self,
                 description=ECOMAX_CONTROL_PARAMETER,
-                value=(mode != DeviceState.OFF),
-                min_value=STATE_OFF,
-                max_value=STATE_ON,
+                values=ParameterValues(
+                    value=int(mode != DeviceState.OFF),
+                    min_value=0,
+                    max_value=1,
+                ),
             ),
         )
 
@@ -386,11 +372,7 @@ class EcoMAX(Addressable):
         """Add thermostat profile parameter to the dataset."""
         if values is not None:
             return EcomaxParameter(
-                device=self,
-                description=THERMOSTAT_PROFILE_PARAMETER,
-                value=values.value,
-                min_value=values.min_value,
-                max_value=values.max_value,
+                device=self, description=THERMOSTAT_PROFILE_PARAMETER, values=values
             )
 
         return None

{PyPlumIO-0.5.2 → PyPlumIO-0.5.3}/pyplumio/devices/mixer.py

@@ -73,14 +73,7 @@ class Mixer(SubDevice):
             )
             await self.dispatch(
                 description.name,
-                cls(
-                    device=self,
-                    description=description,
-                    index=index,
-                    value=values.value,
-                    min_value=values.min_value,
-                    max_value=values.max_value,
-                ),
+                cls(device=self, description=description, index=index, values=values),
             )
 
         return True

{PyPlumIO-0.5.2 → PyPlumIO-0.5.3}/pyplumio/devices/thermostat.py

@@ -58,9 +58,7 @@ class Thermostat(SubDevice):
                     device=self,
                     description=description,
                     index=index,
-                    value=values.value,
-                    min_value=values.min_value,
-                    max_value=values.max_value,
+                    values=values,
                     offset=(self.index * len(parameters)),
                 ),
             )

{PyPlumIO-0.5.2 → PyPlumIO-0.5.3}/pyplumio/frames/messages.py

@@ -13,18 +13,18 @@ from pyplumio.const import (
 )
 from pyplumio.frames import Message
 from pyplumio.helpers.typing import EventDataType
+from pyplumio.structures.boiler_load import BoilerLoadStructure
+from pyplumio.structures.boiler_power import BoilerPowerStructure
 from pyplumio.structures.fan_power import FanPowerStructure
 from pyplumio.structures.frame_versions import FrameVersionsStructure
 from pyplumio.structures.fuel_consumption import FuelConsumptionStructure
 from pyplumio.structures.fuel_level import FuelLevelStructure
 from pyplumio.structures.lambda_sensor import LambdaSensorStructure
-from pyplumio.structures.load import LoadStructure
 from pyplumio.structures.mixer_sensors import MixerSensorsStructure
 from pyplumio.structures.modules import ModulesStructure
 from pyplumio.structures.output_flags import OutputFlagsStructure
 from pyplumio.structures.outputs import OutputsStructure
 from pyplumio.structures.pending_alerts import PendingAlertsStructure
-from pyplumio.structures.power import PowerStructure
 from pyplumio.structures.regulator_data import RegulatorDataStructure
 from pyplumio.structures.statuses import StatusesStructure
 from pyplumio.structures.temperatures import TemperaturesStructure
@@ -64,8 +64,8 @@ class SensorDataMessage(Message):
         sensors, offset = FuelLevelStructure(self).decode(message, offset, sensors)
         sensors[ATTR_TRANSMISSION] = message[offset]
         sensors, offset = FanPowerStructure(self).decode(message, offset + 1, sensors)
-        sensors, offset = LoadStructure(self).decode(message, offset, sensors)
-        sensors, offset = PowerStructure(self).decode(message, offset, sensors)
+        sensors, offset = BoilerLoadStructure(self).decode(message, offset, sensors)
+        sensors, offset = BoilerPowerStructure(self).decode(message, offset, sensors)
         sensors, offset = FuelConsumptionStructure(self).decode(
             message, offset, sensors
         )

{PyPlumIO-0.5.2 → PyPlumIO-0.5.3}/pyplumio/helpers/parameter.py

@@ -57,6 +57,8 @@ def _normalize_parameter_value(value: ParameterValueType) -> int:
 class ParameterValues:
     """Represents a parameter values."""
 
+    __slots__ = "value", "min_value", "max_value"
+
     value: int
     min_value: int
     max_value: int
@@ -80,18 +82,14 @@ class Parameter:
 
     device: Device
     description: ParameterDescription
-    _value: int
-    _min_value: int
-    _max_value: int
+    _values: ParameterValues
     _index: int
     _pending_update: bool = False
 
     def __init__(
         self,
         device: Device,
-        value: ParameterValueType,
-        min_value: ParameterValueType,
-        max_value: ParameterValueType,
+        values: ParameterValues,
         description: ParameterDescription,
         index: int = 0,
     ):
@@ -99,9 +97,7 @@ class Parameter:
         self.index = index
         self.device = device
         self.description = description
-        self._value = _normalize_parameter_value(value)
-        self._min_value = _normalize_parameter_value(min_value)
-        self._max_value = _normalize_parameter_value(max_value)
+        self._values = values
         self._pending_update = False
         self._index = index
 
@@ -110,22 +106,18 @@ class Parameter:
         return (
             f"{self.__class__.__name__}("
             f"device={self.device.__class__.__name__}, "
-            f"description={self.description}, value={self.value}, "
-            f"min_value={self.min_value}, max_value={self.max_value})"
+            f"values={self._values}, "
+            f"description={self.description})"
         )
 
-    def __getattr__(self, name: str):
-        """Return attributes from the parameter description."""
-        return getattr(self.description, name)
-
     def _call_relational_method(self, method_to_call, other):
         """Call a specified relational method."""
-        func = getattr(self._value, method_to_call)
+        func = getattr(self._values.value, method_to_call)
         return func(_normalize_parameter_value(other))
 
     def __int__(self) -> int:
         """Return an integer representation of parameter's value."""
-        return self._value
+        return self._values.value
 
     def __add__(self, other) -> int:
         """Return result of addition."""
@@ -167,7 +159,7 @@ class Parameter:
         """Compare if parameter value is less that other."""
         return self._call_relational_method("__lt__", other)
 
-    async def _confirm_parameter_change(self, parameter: Parameter) -> None:
+    async def _confirm_parameter_change(self, _: Parameter) -> None:
         """A callback for when parameter change is confirmed on
         the device.
         """
@@ -175,15 +167,15 @@ class Parameter:
 
     async def set(self, value: ParameterValueType, retries: int = SET_RETRIES) -> bool:
         """Set a parameter value."""
-        if (value := _normalize_parameter_value(value)) == self._value:
+        if (value := _normalize_parameter_value(value)) == self._values.value:
             return True
 
-        if value < self._min_value or value > self._max_value:
+        if value < self._values.min_value or value > self._values.max_value:
             raise ValueError(
                 f"Parameter value must be between '{self.min_value}' and '{self.max_value}'"
             )
 
-        self._value = value
+        self._values.value = value
         self._pending_update = True
         self.device.subscribe_once(
             self.description.name, self._confirm_parameter_change
@@ -217,17 +209,22 @@ class Parameter:
     @property
     def value(self) -> ParameterValueType:
         """A parameter value."""
-        return self._value
+        return self._values.value
 
     @property
     def min_value(self) -> ParameterValueType:
         """Minimum allowed value."""
-        return self._min_value
+        return self._values.min_value
 
     @property
     def max_value(self) -> ParameterValueType:
         """Maximum allowed value."""
-        return self._max_value
+        return self._values.max_value
+
+    @property
+    def unit_of_measurement(self) -> UnitOfMeasurement | Literal["%"] | None:
+        """A unit of measurement."""
+        return self.description.unit_of_measurement
 
     @property
     def request(self) -> Request:
@@ -257,7 +254,7 @@ class BinaryParameter(Parameter):
     @property
     def value(self) -> ParameterValueType:
         """A parameter value."""
-        return STATE_ON if self._value == 1 else STATE_OFF
+        return STATE_ON if self._values.value == 1 else STATE_OFF
 
     @property
     def min_value(self) -> ParameterValueType:

PyPlumIO-0.5.2/pyplumio/structures/load.py → PyPlumIO-0.5.3/pyplumio/structures/boiler_load.py

@@ -8,20 +8,20 @@ from pyplumio.helpers.typing import EventDataType
 from pyplumio.structures import StructureDecoder
 from pyplumio.utils import ensure_dict
 
-ATTR_LOAD: Final = "load"
+ATTR_BOILER_LOAD: Final = "boiler_load"
 
 
-class LoadStructure(StructureDecoder):
+class BoilerLoadStructure(StructureDecoder):
     """Represents a boiler load sensor data structure."""
 
     def decode(
         self, message: bytearray, offset: int = 0, data: EventDataType | None = None
     ) -> tuple[EventDataType, int]:
         """Decode bytes and return message data and offset."""
-        load = message[offset]
+        boiler_load = message[offset]
         offset += 1
 
-        if load == BYTE_UNDEFINED:
+        if boiler_load == BYTE_UNDEFINED:
             return ensure_dict(data), offset
 
-        return (ensure_dict(data, {ATTR_LOAD: load}), offset)
+        return (ensure_dict(data, {ATTR_BOILER_LOAD: boiler_load}), offset)

PyPlumIO-0.5.2/pyplumio/structures/power.py → PyPlumIO-0.5.3/pyplumio/structures/boiler_power.py

@@ -9,20 +9,20 @@ from pyplumio.helpers.typing import EventDataType
 from pyplumio.structures import StructureDecoder
 from pyplumio.utils import ensure_dict
 
-ATTR_POWER: Final = "power"
+ATTR_BOILER_POWER: Final = "boiler_power"
 
 
-class PowerStructure(StructureDecoder):
+class BoilerPowerStructure(StructureDecoder):
     """Represents a boiler power sensor data structure."""
 
     def decode(
         self, message: bytearray, offset: int = 0, data: EventDataType | None = None
     ) -> tuple[EventDataType, int]:
         """Decode bytes and return message data and offset."""
-        power = Float.from_bytes(message, offset)
-        offset += power.size
+        boiler_power = Float.from_bytes(message, offset)
+        offset += boiler_power.size
 
-        if math.isnan(power.value):
+        if math.isnan(boiler_power.value):
             return ensure_dict(data), offset
 
-        return ensure_dict(data, {ATTR_POWER: power.value}), offset
+        return ensure_dict(data, {ATTR_BOILER_POWER: boiler_power.value}), offset

{PyPlumIO-0.5.2 → PyPlumIO-0.5.3}/pyplumio/structures/ecomax_parameters.py

@@ -51,17 +51,23 @@ class EcomaxParameter(Parameter):
     @property
     def value(self) -> ParameterValueType:
         """A parameter value."""
-        return (self._value - self.description.offset) * self.description.multiplier
+        return (
+            self._values.value - self.description.offset
+        ) * self.description.multiplier
 
     @property
     def min_value(self) -> ParameterValueType:
         """Minimum allowed value."""
-        return (self._min_value - self.description.offset) * self.description.multiplier
+        return (
+            self._values.min_value - self.description.offset
+        ) * self.description.multiplier
 
     @property
     def max_value(self) -> ParameterValueType:
         """Maximum allowed value."""
-        return (self._max_value - self.description.offset) * self.description.multiplier
+        return (
+            self._values.max_value - self.description.offset
+        ) * self.description.multiplier
 
     @property
     def request(self) -> Request:
@@ -72,7 +78,7 @@ class EcomaxParameter(Parameter):
                 "frames.requests.EcomaxControlRequest",
                 recipient=self.device.address,
                 data={
-                    ATTR_VALUE: self._value,
+                    ATTR_VALUE: self._values.value,
                 },
             )
 
@@ -82,7 +88,7 @@ class EcomaxParameter(Parameter):
                 recipient=self.device.address,
                 data={
                     ATTR_INDEX: self._index,
-                    ATTR_VALUE: self._value,
+                    ATTR_VALUE: self._values.value,
                     ATTR_OFFSET: 0,
                     ATTR_SIZE: 1,
                 },
@@ -93,7 +99,7 @@ class EcomaxParameter(Parameter):
             recipient=self.device.address,
             data={
                 ATTR_INDEX: self._index,
-                ATTR_VALUE: self._value,
+                ATTR_VALUE: self._values.value,
             },
         )
 
@@ -421,7 +427,7 @@ ECOMAX_PARAMETERS: dict[ProductType, tuple[EcomaxParameterDescription, ...]] = {
             name="thermostat_decrease_target_temp",
             unit_of_measurement=UnitOfMeasurement.CELSIUS,
         ),
-        EcomaxBinaryParameterDescription(name="thermostat_disable_pump"),
+        EcomaxBinaryParameterDescription(name="disable_pump_on_thermostat"),
         EcomaxParameterDescription(
             name="boiler_alert_temp", unit_of_measurement=UnitOfMeasurement.CELSIUS
         ),

{PyPlumIO-0.5.2 → PyPlumIO-0.5.3}/pyplumio/structures/mixer_parameters.py

@@ -49,17 +49,23 @@ class MixerParameter(Parameter):
     @property
     def value(self) -> ParameterValueType:
         """A parameter value."""
-        return (self._value - self.description.offset) * self.description.multiplier
+        return (
+            self._values.value - self.description.offset
+        ) * self.description.multiplier
 
     @property
     def min_value(self) -> ParameterValueType:
         """Minimum allowed value."""
-        return (self._min_value - self.description.offset) * self.description.multiplier
+        return (
+            self._values.min_value - self.description.offset
+        ) * self.description.multiplier
 
     @property
     def max_value(self) -> ParameterValueType:
         """Maximum allowed value."""
-        return (self._max_value - self.description.offset) * self.description.multiplier
+        return (
+            self._values.max_value - self.description.offset
+        ) * self.description.multiplier
 
     @property
     def request(self) -> Request:
@@ -69,7 +75,7 @@ class MixerParameter(Parameter):
             recipient=self.device.parent.address,
             data={
                 ATTR_INDEX: self._index,
-                ATTR_VALUE: self._value,
+                ATTR_VALUE: self._values.value,
                 ATTR_DEVICE_INDEX: self.device.index,
             },
         )
@@ -125,7 +131,7 @@ MIXER_PARAMETERS: dict[ProductType, tuple[MixerParameterDescription, ...]] = {
         ),
         MixerBinaryParameterDescription(name="thermostat_operation"),
         MixerParameterDescription(name="thermostat_mode"),
-        MixerBinaryParameterDescription(name="thermostat_disable_pump"),
+        MixerBinaryParameterDescription(name="disable_pump_on_thermostat"),
         MixerBinaryParameterDescription(name="summer_work"),
     ),
     ProductType.ECOMAX_I: (

{PyPlumIO-0.5.2 → PyPlumIO-0.5.3}/pyplumio/structures/thermostat_parameters.py

@@ -59,17 +59,17 @@ class ThermostatParameter(Parameter):
     @property
     def value(self) -> ParameterValueType:
         """A parameter value."""
-        return self._value * self.description.multiplier
+        return self._values.value * self.description.multiplier
 
     @property
     def min_value(self) -> ParameterValueType:
         """Minimum allowed value."""
-        return self._min_value * self.description.multiplier
+        return self._values.min_value * self.description.multiplier
 
     @property
     def max_value(self) -> ParameterValueType:
         """Maximum allowed value."""
-        return self._max_value * self.description.multiplier
+        return self._values.max_value * self.description.multiplier
 
     @property
     def request(self) -> Request:
@@ -81,7 +81,7 @@ class ThermostatParameter(Parameter):
                 # 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._value,
+                ATTR_VALUE: self._values.value,
                 ATTR_OFFSET: self.offset,
                 ATTR_SIZE: self.description.size,
             },

{PyPlumIO-0.5.2 → PyPlumIO-0.5.3}/tests/helpers/test_parameter.py

@@ -37,9 +37,7 @@ def fixture_parameter(ecomax: EcoMAX) -> Parameter:
     """Return a parameter object."""
     return TestParameter(
         device=ecomax,
-        value=1,
-        min_value=0,
-        max_value=5,
+        values=ParameterValues(value=1, min_value=0, max_value=5),
         description=ParameterDescription(
             name="test_parameter", unit_of_measurement=UnitOfMeasurement.CELSIUS
         ),
@@ -51,9 +49,7 @@ def fixture_binary_parameter(ecomax: EcoMAX) -> BinaryParameter:
     """Return a binary parameter object."""
     return TestBinaryParameter(
         device=ecomax,
-        value=STATE_OFF,
-        min_value=STATE_OFF,
-        max_value=STATE_ON,
+        values=ParameterValues(value=0, min_value=0, max_value=1),
         description=ParameterDescription(name="test_binary_parameter"),
     )
 
@@ -83,9 +79,7 @@ def test_base_parameter_request(ecomax: EcoMAX) -> None:
     """Test that a base class request throws not implemented error."""
     parameter = Parameter(
         device=ecomax,
-        value=1,
-        min_value=0,
-        max_value=5,
+        values=ParameterValues(value=1, min_value=0, max_value=5),
         description=ParameterDescription(name="test_parameter"),
     )
 
@@ -156,17 +150,12 @@ def test_parameter_repr(parameter: Parameter) -> None:
     """Test a parameter representation."""
     assert repr(parameter) == (
         "TestParameter(device=EcoMAX, "
+        "values=ParameterValues(value=1, min_value=0, max_value=5), "
         "description=ParameterDescription(name='test_parameter', "
-        "unit_of_measurement=<UnitOfMeasurement.CELSIUS: '°C'>), "
-        "value=1, min_value=0, max_value=5)"
+        "unit_of_measurement=<UnitOfMeasurement.CELSIUS: '°C'>))"
     )
 
 
-def test_parameter_getattr(parameter: Parameter):
-    """Test getting attributes from the parameters description."""
-    assert parameter.unit_of_measurement == UnitOfMeasurement.CELSIUS
-
-
 @patch("asyncio.Queue.put")
 async def test_parameter_request_with_unchanged_value(
     mock_put, parameter: Parameter, bypass_asyncio_sleep, caplog

{PyPlumIO-0.5.2 → PyPlumIO-0.5.3}/tests/test_devices.py

@@ -226,10 +226,7 @@ async def test_ecomax_parameters_callbacks(ecomax: EcoMAX) -> None:
     assert heating_heat_curve_shift.value == 0.0
     assert heating_heat_curve_shift.min_value == -20.0
     assert heating_heat_curve_shift.max_value == 20.0
-    assert (
-        heating_heat_curve_shift.description.unit_of_measurement
-        == UnitOfMeasurement.CELSIUS
-    )
+    assert heating_heat_curve_shift.unit_of_measurement == UnitOfMeasurement.CELSIUS
 
     # Test setting the parameter with the offset.
     with patch(

{PyPlumIO-0.5.2 → PyPlumIO-0.5.3}/tests/testdata/messages/sensor_data.json

@@ -57,8 +57,8 @@
         "fuel_level": 32,
         "transmission": 0,
         "fan_power": 0.0,
-        "load": 16,
-        "power": 0.0,
+        "boiler_load": 16,
+        "boiler_power": 0.0,
         "fuel_consumption": 0.0,
         "thermostat": 1,
         "modules": {