feat: add more control methods to pumps and filters

Author: cryptk

pyomnilogic_local/filter.py

@@ -187,3 +187,29 @@ async def run_preset_speed(self, speed: FilterSpeedPresets) -> None:
             equipment_id=self.system_id,
             is_on=speed_value,
         )
+
+    @dirties_state()
+    async def set_speed(self, speed: int) -> None:
+        """Set the filter to a specific speed.
+
+        Args:
+            speed: Speed value (0-100 percent). A value of 0 will turn the filter off.
+
+        Raises:
+            OmniEquipmentNotInitializedError: If bow_id or system_id is None.
+            ValueError: If speed is outside the valid range.
+        """
+        if self.bow_id is None or self.system_id is None:
+            msg = "Filter bow_id and system_id must be set"
+            raise OmniEquipmentNotInitializedError(msg)
+
+        if not 0 <= speed <= 100:
+            msg = f"Speed {speed} is outside valid range [0, 100]"
+            raise ValueError(msg)
+
+        # Note: The API validates against min_percent/max_percent internally
+        await self._api.async_set_filter_speed(
+            pool_id=self.bow_id,
+            equipment_id=self.system_id,
+            speed=speed,
+        )

pyomnilogic_local/omnitypes.py

@@ -460,6 +460,12 @@ class PumpFunction(StrEnum, PrettyEnum):
     CLEANER_IN_FLOOR = "PMP_CLEANER_IN_FLOOR"
 
 
+class PumpSpeedPresets(StrEnum, PrettyEnum):
+    LOW = auto()
+    MEDIUM = auto()
+    HIGH = auto()
+
+
 # Relays
 class RelayFunction(StrEnum, PrettyEnum):
     WATER_FEATURE = "RLY_WATER_FEATURE"

pyomnilogic_local/pump.py

@@ -2,7 +2,7 @@
 from pyomnilogic_local.decorators import dirties_state
 from pyomnilogic_local.models.mspconfig import MSPPump
 from pyomnilogic_local.models.telemetry import TelemetryPump
-from pyomnilogic_local.omnitypes import PumpState
+from pyomnilogic_local.omnitypes import PumpSpeedPresets, PumpState
 from pyomnilogic_local.util import OmniEquipmentNotInitializedError
 
 
@@ -141,3 +141,62 @@ async def turn_off(self) -> None:
             equipment_id=self.system_id,
             is_on=False,
         )
+
+    @dirties_state()
+    async def run_preset_speed(self, speed: PumpSpeedPresets) -> None:
+        """Run the pump at a preset speed.
+
+        Args:
+            speed: The preset speed to use (LOW, MEDIUM, or HIGH)
+
+        Raises:
+            OmniEquipmentNotInitializedError: If bow_id or system_id is None.
+            ValueError: If an invalid speed preset is provided.
+        """
+        if self.bow_id is None or self.system_id is None:
+            msg = "Pump bow_id and system_id must be set"
+            raise OmniEquipmentNotInitializedError(msg)
+
+        speed_value: int
+        match speed:
+            case PumpSpeedPresets.LOW:
+                speed_value = self.low_speed
+            case PumpSpeedPresets.MEDIUM:
+                speed_value = self.medium_speed
+            case PumpSpeedPresets.HIGH:
+                speed_value = self.high_speed
+            case _:
+                msg = f"Invalid speed preset: {speed}"
+                raise ValueError(msg)
+
+        await self._api.async_set_equipment(
+            pool_id=self.bow_id,
+            equipment_id=self.system_id,
+            is_on=speed_value,
+        )
+
+    @dirties_state()
+    async def set_speed(self, speed: int) -> None:
+        """Set the pump to a specific speed.
+
+        Args:
+            speed: Speed value (0-100 percent). A value of 0 will turn the pump off.
+
+        Raises:
+            OmniEquipmentNotInitializedError: If bow_id or system_id is None.
+            ValueError: If speed is outside the valid range.
+        """
+        if self.bow_id is None or self.system_id is None:
+            msg = "Pump bow_id and system_id must be set"
+            raise OmniEquipmentNotInitializedError(msg)
+
+        if not 0 <= speed <= 100:
+            msg = f"Speed {speed} is outside valid range [0, 100]"
+            raise ValueError(msg)
+
+        # Note: The API validates against min_percent/max_percent internally
+        await self._api.async_set_equipment(
+            pool_id=self.bow_id,
+            equipment_id=self.system_id,
+            is_on=speed,
+        )