python-omnilogic-local 0.23.0__tar.gz → 0.25.0__tar.gz

{python_omnilogic_local-0.23.0 → python_omnilogic_local-0.25.0}/PKG-INFO

@@ -1,15 +1,15 @@
 Metadata-Version: 2.4
 Name: python-omnilogic-local
-Version: 0.23.0
+Version: 0.25.0
 Summary: A library for local control of Hayward OmniHub/OmniLogic pool controllers using their local API
 Author: Chris Jowett, djtimca, garionphx
 Author-email: Chris Jowett <421501+cryptk@users.noreply.github.com>
 License-File: LICENSE
 Requires-Dist: pydantic>=2.0.0,<3.0.0
-Requires-Dist: click>=8.0.0,<9.0.0
 Requires-Dist: xmltodict>=1.0.1,<2.0.0
 Requires-Dist: uv~=0.11.6 ; extra == 'build'
 Requires-Dist: scapy>=2.6.1,<3.0.0 ; extra == 'cli'
+Requires-Dist: click>=8.0.0,<9.0.0 ; extra == 'cli'
 Requires-Python: >=3.14.2
 Provides-Extra: build
 Provides-Extra: cli

{python_omnilogic_local-0.23.0 → python_omnilogic_local-0.25.0}/pyomnilogic_local/api/api.py

@@ -168,8 +168,12 @@ class OmniLogicAPI:
 
         req_body = ET.tostring(body_element, xml_declaration=True, encoding=XML_ENCODING)
 
+        _LOGGER.debug("Sending RequestConfiguration with body: %s", req_body)
+
         resp = await self.async_send_message(MessageType.REQUEST_CONFIGURATION, req_body, True)
 
+        _LOGGER.debug("Received response for RequestConfiguration: %s", resp)
+
         if raw:
             return resp
         return MSPConfig.load_xml(resp)
@@ -206,8 +210,12 @@ class OmniLogicAPI:
 
         req_body = ET.tostring(body_element, xml_declaration=True, encoding=XML_ENCODING)
 
+        _LOGGER.debug("Sending GetUIFilterDiagnosticInfo with body: %s", req_body)
+
         resp = await self.async_send_message(MessageType.GET_FILTER_DIAGNOSTIC_INFO, req_body, True)
 
+        _LOGGER.debug("Received response for GetUIFilterDiagnosticInfo: %s", resp)
+
         if raw:
             return resp
         return FilterDiagnostics.load_xml(resp)
@@ -231,8 +239,12 @@ class OmniLogicAPI:
 
         req_body = ET.tostring(body_element, xml_declaration=True, encoding=XML_ENCODING)
 
+        _LOGGER.debug("Sending RequestTelemetryData with body: %s", req_body)
+
         resp = await self.async_send_message(MessageType.GET_TELEMETRY, req_body, True)
 
+        _LOGGER.debug("Received response for RequestTelemetryData: %s", resp)
+
         if raw:
             return resp
         return Telemetry.load_xml(resp)
@@ -268,6 +280,8 @@ class OmniLogicAPI:
 
         req_body = ET.tostring(body_element, xml_declaration=True, encoding=XML_ENCODING)
 
+        _LOGGER.debug("Sending SetUIHeaterCmd with body: %s", req_body)
+
         return await self.async_send_message(MessageType.SET_HEATER_COMMAND, req_body, False)
 
     async def async_set_solar_heater(
@@ -301,6 +315,8 @@ class OmniLogicAPI:
 
         req_body = ET.tostring(body_element, xml_declaration=True, encoding=XML_ENCODING)
 
+        _LOGGER.debug("Sending SetUISolarSetPointCmd with body: %s", req_body)
+
         return await self.async_send_message(MessageType.SET_SOLAR_SET_POINT_COMMAND, req_body, False)
 
     async def async_set_heater_mode(
@@ -334,6 +350,8 @@ class OmniLogicAPI:
 
         req_body = ET.tostring(body_element, xml_declaration=True, encoding=XML_ENCODING)
 
+        _LOGGER.debug("Sending SetUIHeaterModeCmd with body: %s", req_body)
+
         return await self.async_send_message(MessageType.SET_HEATER_MODE_COMMAND, req_body, False)
 
     async def async_set_heater_enable(
@@ -367,6 +385,8 @@ class OmniLogicAPI:
 
         req_body = ET.tostring(body_element, xml_declaration=True, encoding=XML_ENCODING)
 
+        _LOGGER.debug("Sending SetHeaterEnable with body: %s", req_body)
+
         return await self.async_send_message(MessageType.SET_HEATER_ENABLED, req_body, False)
 
     async def async_set_equipment(
@@ -427,6 +447,8 @@ class OmniLogicAPI:
 
         req_body = ET.tostring(body_element, xml_declaration=True, encoding=XML_ENCODING)
 
+        _LOGGER.debug("Sending SetUIEquipmentCmd with body: %s", req_body)
+
         return await self.async_send_message(MessageType.SET_EQUIPMENT, req_body, False)
 
     async def async_set_filter_speed(self, pool_id: int, equipment_id: int, speed: int) -> None:
@@ -453,6 +475,8 @@ class OmniLogicAPI:
 
         req_body = ET.tostring(body_element, xml_declaration=True, encoding=XML_ENCODING)
 
+        _LOGGER.debug("Sending SetUIFilterSpeedCmd with body: %s", req_body)
+
         return await self.async_send_message(MessageType.SET_FILTER_SPEED, req_body, False)
 
     async def async_set_light_show(
@@ -522,6 +546,9 @@ class OmniLogicAPI:
         parameter.text = str(int(recurring))
 
         req_body = ET.tostring(body_element, xml_declaration=True, encoding=XML_ENCODING)
+
+        _LOGGER.debug("Sending SetStandAloneLightShow with body: %s", req_body)
+
         return await self.async_send_message(MessageType.SET_STANDALONE_LIGHT_SHOW, req_body, False)
 
     async def async_set_chlorinator_enable(self, pool_id: int, enabled: int | bool) -> None:
@@ -538,6 +565,8 @@ class OmniLogicAPI:
 
         req_body = ET.tostring(body_element, xml_declaration=True, encoding=XML_ENCODING)
 
+        _LOGGER.debug("Sending SetCHLOREnable with body: %s", req_body)
+
         return await self.async_send_message(MessageType.SET_CHLOR_ENABLED, req_body, False)
 
     # This is used to set the ORP target value on a CSAD
@@ -562,6 +591,8 @@ class OmniLogicAPI:
 
         req_body = ET.tostring(body_element, xml_declaration=True, encoding=XML_ENCODING)
 
+        _LOGGER.debug("Sending SetUICSADORPTargetLevel with body: %s", req_body)
+
         return await self.async_send_message(MessageType.SET_CSAD_ORP_TARGET, req_body, False)
 
     # This is used to set the pH target value on a CSAD
@@ -586,6 +617,8 @@ class OmniLogicAPI:
 
         req_body = ET.tostring(body_element, xml_declaration=True, encoding=XML_ENCODING)
 
+        _LOGGER.debug("Sending UISetCSADTargetValue with body: %s", req_body)
+
         return await self.async_send_message(MessageType.SET_CSAD_TARGET_VALUE, req_body, False)
 
     async def async_set_chlorinator_params(
@@ -627,6 +660,8 @@ class OmniLogicAPI:
 
         req_body = ET.tostring(body_element, xml_declaration=True, encoding=XML_ENCODING)
 
+        _LOGGER.debug("Sending SetCHLORParams with body: %s", req_body)
+
         return await self.async_send_message(MessageType.SET_CHLOR_PARAMS, req_body, False)
 
     async def async_set_chlorinator_superchlorinate(
@@ -650,6 +685,8 @@ class OmniLogicAPI:
 
         req_body = ET.tostring(body_element, xml_declaration=True, encoding=XML_ENCODING)
 
+        _LOGGER.debug("Sending SetUISuperCHLORCmd with body: %s", req_body)
+
         return await self.async_send_message(MessageType.SET_SUPERCHLORINATE, req_body, False)
 
     async def async_restore_idle_state(self) -> None:
@@ -662,6 +699,8 @@ class OmniLogicAPI:
 
         req_body = ET.tostring(body_element, xml_declaration=True, encoding=XML_ENCODING)
 
+        _LOGGER.debug("Sending RestoreIdleState with body: %s", req_body)
+
         return await self.async_send_message(MessageType.RESTORE_IDLE_STATE, req_body, False)
 
     async def async_set_spillover(
@@ -703,6 +742,8 @@ class OmniLogicAPI:
 
         req_body = ET.tostring(body_element, xml_declaration=True, encoding=XML_ENCODING)
 
+        _LOGGER.debug("Sending SetUISpilloverCmd with body: %s", req_body)
+
         return await self.async_send_message(MessageType.SET_SPILLOVER, req_body, False)
 
     async def async_set_group_enable(
@@ -744,6 +785,8 @@ class OmniLogicAPI:
 
         req_body = ET.tostring(body_element, xml_declaration=True, encoding=XML_ENCODING)
 
+        _LOGGER.debug("Sending RunGroupCmd with body: %s", req_body)
+
         return await self.async_send_message(MessageType.RUN_GROUP_CMD, req_body, False)
 
     async def async_edit_schedule(
@@ -815,4 +858,6 @@ class OmniLogicAPI:
 
         req_body = ET.tostring(body_element, xml_declaration=True, encoding=XML_ENCODING)
 
+        _LOGGER.debug("Sending EditUIScheduleCmd with body: %s", req_body)
+
         return await self.async_send_message(MessageType.EDIT_SCHEDULE, req_body, False)

{python_omnilogic_local-0.23.0 → python_omnilogic_local-0.25.0}/pyomnilogic_local/bow.py

@@ -170,7 +170,7 @@ class Bow(OmniEquipment[MSPBoW, TelemetryBoW]):
         return f"Bow({', '.join(parts)})"
 
     @property
-    def equip_type(self) -> BodyOfWaterType | str:
+    def equip_type(self) -> BodyOfWaterType:
         """The equipment type of the bow (POOL or SPA)."""
         return self.mspconfig.equip_type
 

{python_omnilogic_local-0.23.0 → python_omnilogic_local-0.25.0}/pyomnilogic_local/cli/get/backyard.py

@@ -54,7 +54,7 @@ def _print_backyard_info(backyardconfig: MSPBackyard, telemetry: TelemetryType |
             continue
 
         if attr_name == "state":
-            value = BackyardState(value).pretty()
+            value = str(BackyardState(value))
         elif isinstance(value, list):
             # Format lists nicely
             value = ", ".join(str(v) for v in value) if value else "None"

{python_omnilogic_local-0.23.0 → python_omnilogic_local-0.25.0}/pyomnilogic_local/cli/get/bows.py

@@ -58,7 +58,7 @@ def _print_bow_info(bow: MSPBoW, telemetry: TelemetryType | None) -> None:
             continue
 
         if attr_name == "type":
-            value = BodyOfWaterType(value).pretty()
+            value = str(BodyOfWaterType(value))
         elif isinstance(value, list):
             # Format lists nicely
             value = ", ".join(str(v) for v in value) if value else "None"

{python_omnilogic_local-0.23.0 → python_omnilogic_local-0.25.0}/pyomnilogic_local/cli/get/csads.py

@@ -50,9 +50,9 @@ def _print_csad_info(csad: MSPCSAD, telemetry: TelemetryCSAD | None) -> None:
     csad_data: dict[Any, Any] = {**dict(csad), **dict(telemetry)} if telemetry else dict(csad)
     for attr_name, value in csad_data.items():
         if attr_name == "equip_type":
-            value = CSADType(value).pretty()
+            value = str(CSADType(value))
         elif attr_name == "mode":
-            value = CSADMode(value).pretty()
+            value = str(CSADMode(value))
         elif isinstance(value, list):
             # Format lists nicely
             value = ", ".join(str(v) for v in value) if value else "None"

{python_omnilogic_local-0.23.0 → python_omnilogic_local-0.25.0}/pyomnilogic_local/cli/get/filters.py

@@ -50,13 +50,13 @@ def _print_filter_info(filt: MSPFilter, telemetry: TelemetryType | None) -> None
     filter_data: dict[Any, Any] = {**dict(filt), **dict(telemetry)} if telemetry else dict(filt)
     for attr_name, value in filter_data.items():
         if attr_name == "state":
-            value = FilterState(value).pretty()
+            value = str(FilterState(value))
         elif attr_name == "type":
-            value = FilterType(value).pretty()
+            value = str(FilterType(value))
         elif attr_name == "valve_position":
-            value = FilterValvePosition(value).pretty()
+            value = str(FilterValvePosition(value))
         elif attr_name == "why_on":
-            value = FilterWhyOn(value).pretty()
+            value = str(FilterWhyOn(value))
         elif isinstance(value, list):
             # Format lists nicely
             value = ", ".join(str(v) for v in value) if value else "None"

{python_omnilogic_local-0.23.0 → python_omnilogic_local-0.25.0}/pyomnilogic_local/cli/get/groups.py

@@ -53,7 +53,7 @@ def _print_group_info(group: MSPGroup, telemetry: TelemetryGroup | None) -> None
             # Skip bow_id as it's not relevant for groups
             continue
         if attr_name == "state":
-            value = GroupState(value).pretty()
+            value = str(GroupState(value))
         elif isinstance(value, list):
             # Format lists nicely
             value = ", ".join(str(v) for v in value) if value else "None"

{python_omnilogic_local-0.23.0 → python_omnilogic_local-0.25.0}/pyomnilogic_local/cli/get/heaters.py

@@ -67,9 +67,9 @@ def _print_virtual_heater_info(virt_heater: MSPVirtualHeater, telemetry: Telemet
 
     for attr_name, value in display_data.items():
         if attr_name == "state":
-            value = HeaterState(value).pretty()
+            value = str(HeaterState(value))
         elif attr_name == "mode":
-            value = HeaterMode(value).pretty()
+            value = str(HeaterMode(value))
         elif isinstance(value, list):
             # Format lists nicely
             value = ", ".join(str(v) for v in value) if value else "None"
@@ -105,9 +105,9 @@ def _print_heater_equipment_info(equip: MSPHeaterEquip, telemetry: Telemetry) ->
 
     for attr_name, value in equip_data.items():
         if attr_name == "heater_type":
-            value = HeaterType(value).pretty()
+            value = str(HeaterType(value))
         elif attr_name == "state":
-            value = HeaterState(value).pretty()
+            value = str(HeaterState(value))
         elif isinstance(value, list):
             value = ", ".join(str(v) for v in value) if value else "None"
 

{python_omnilogic_local-0.23.0 → python_omnilogic_local-0.25.0}/pyomnilogic_local/cli/get/lights.py

@@ -51,16 +51,16 @@ def _print_light_info(light: MSPColorLogicLight, telemetry: TelemetryColorLogicL
 
     for attr_name, value in light_data.items():
         if attr_name == "brightness":
-            value = ColorLogicBrightness(value).pretty()
+            value = str(ColorLogicBrightness(value))
         elif attr_name == "effects" and isinstance(value, list):
-            show_names = [show.pretty() if hasattr(show, "pretty") else str(show) for show in value]
+            show_names = [str(show) for show in value]
             value = ", ".join(show_names) if show_names else "None"
         elif attr_name == "show" and value is not None:
             value = telemetry.show_name(light.equip_type, light.v2_active) if telemetry else str(value)
         elif attr_name == "speed":
-            value = ColorLogicSpeed(value).pretty()
+            value = str(ColorLogicSpeed(value))
         elif attr_name == "state":
-            value = ColorLogicPowerState(value).pretty()
+            value = str(ColorLogicPowerState(value))
         elif isinstance(value, list):
             # Format other lists nicely
             value = ", ".join(str(v) for v in value) if value else "None"

{python_omnilogic_local-0.23.0 → python_omnilogic_local-0.25.0}/pyomnilogic_local/cli/get/pumps.py

@@ -50,11 +50,11 @@ def _print_pump_info(pump: MSPPump, telemetry: TelemetryType | None) -> None:
     pump_data: dict[Any, Any] = {**dict(pump), **dict(telemetry)} if telemetry else dict(pump)
     for attr_name, value in pump_data.items():
         if attr_name == "state":
-            value = PumpState(value).pretty()
+            value = str(PumpState(value))
         elif attr_name == "equip_type":
-            value = PumpType(value).pretty()
+            value = str(PumpType(value))
         elif attr_name == "function":
-            value = PumpFunction(value).pretty()
+            value = str(PumpFunction(value))
         elif isinstance(value, list):
             # Format lists nicely
             value = ", ".join(str(v) for v in value) if value else "None"

{python_omnilogic_local-0.23.0 → python_omnilogic_local-0.25.0}/pyomnilogic_local/cli/get/relays.py

@@ -50,13 +50,13 @@ def _print_relay_info(relay: MSPRelay, telemetry: TelemetryType | None) -> None:
     relay_data: dict[Any, Any] = {**dict(relay), **dict(telemetry)} if telemetry else dict(relay)
     for attr_name, value in relay_data.items():
         if attr_name == "state":
-            value = RelayState(value).pretty()
+            value = str(RelayState(value))
         elif attr_name == "type":
-            value = RelayType(value).pretty()
+            value = str(RelayType(value))
         elif attr_name == "function":
-            value = RelayFunction(value).pretty()
+            value = str(RelayFunction(value))
         elif attr_name == "why_on":
-            value = RelayWhyOn(value).pretty()
+            value = str(RelayWhyOn(value))
         elif isinstance(value, list):
             # Format lists nicely
             value = ", ".join(str(v) for v in value) if value else "None"

{python_omnilogic_local-0.23.0 → python_omnilogic_local-0.25.0}/pyomnilogic_local/cli/get/sensors.py

@@ -48,9 +48,9 @@ def _print_sensor_info(sensor: MSPSensor) -> None:
     sensor_data: dict[Any, Any] = dict(sensor)
     for attr_name, value in sensor_data.items():
         if attr_name == "equip_type":
-            value = SensorType(value).pretty()
+            value = str(SensorType(value))
         elif attr_name == "units":
-            value = SensorUnits(value).pretty()
+            value = str(SensorUnits(value))
         elif isinstance(value, list):
             # Format lists nicely
             value = ", ".join(str(v) for v in value) if value else "None"

{python_omnilogic_local-0.23.0 → python_omnilogic_local-0.25.0}/pyomnilogic_local/cli/get/valves.py

@@ -60,13 +60,13 @@ def _print_valve_info(relay: MSPRelay, telemetry: Telemetry) -> None:
 
     for attr_name, value in valve_data.items():
         if attr_name == "type":
-            value = RelayType(value).pretty()
+            value = str(RelayType(value))
         elif attr_name == "function":
-            value = RelayFunction(value).pretty()
+            value = str(RelayFunction(value))
         elif attr_name == "state":
-            value = ValveActuatorState(value).pretty()
+            value = str(ValveActuatorState(value))
         elif attr_name == "why_on":
-            value = RelayWhyOn(value).pretty()
+            value = str(RelayWhyOn(value))
         elif isinstance(value, list):
             # Format lists nicely
             value = ", ".join(str(v) for v in value) if value else "None"

{python_omnilogic_local-0.23.0 → python_omnilogic_local-0.25.0}/pyomnilogic_local/csad.py

@@ -69,7 +69,7 @@ class CSAD(OmniEquipment[MSPCSAD, TelemetryCSAD]):
         return self.mspconfig.enabled
 
     @property
-    def equip_type(self) -> CSADType | str:
+    def equip_type(self) -> CSADType:
         """Type of CSAD system (ACID or CO2)."""
         return self.mspconfig.equip_type
 
@@ -160,7 +160,7 @@ class CSAD(OmniEquipment[MSPCSAD, TelemetryCSAD]):
         return self.telemetry.orp
 
     @property
-    def mode(self) -> CSADMode | int:
+    def mode(self) -> CSADMode:
         """Current operating mode of the CSAD.
 
         Returns:

{python_omnilogic_local-0.23.0 → python_omnilogic_local-0.25.0}/pyomnilogic_local/filter.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from typing import TYPE_CHECKING
+
 from pyomnilogic_local._base import OmniEquipment
 from pyomnilogic_local.decorators import control_method
 from pyomnilogic_local.models.mspconfig import MSPFilter
@@ -7,6 +9,9 @@ from pyomnilogic_local.models.telemetry import TelemetryFilter
 from pyomnilogic_local.omnitypes import FilterSpeedPresets, FilterState
 from pyomnilogic_local.util import OmniEquipmentNotInitializedError
 
+if TYPE_CHECKING:
+    from pyomnilogic_local.omnitypes import FilterType, FilterValvePosition, FilterWhyOn
+
 
 class Filter(OmniEquipment[MSPFilter, TelemetryFilter]):
     """Represents a pool/spa filtration pump in the OmniLogic system.
@@ -81,7 +86,7 @@ class Filter(OmniEquipment[MSPFilter, TelemetryFilter]):
 
     # Expose MSPConfig attributes
     @property
-    def equip_type(self) -> str:
+    def equip_type(self) -> FilterType:
         """The filter type (e.g., FMT_VARIABLE_SPEED_PUMP)."""
         return self.mspconfig.equip_type
 
@@ -127,7 +132,7 @@ class Filter(OmniEquipment[MSPFilter, TelemetryFilter]):
 
     # Expose Telemetry attributes
     @property
-    def state(self) -> FilterState | int:
+    def state(self) -> FilterState:
         """Current filter state."""
         return self.telemetry.state
 
@@ -137,12 +142,12 @@ class Filter(OmniEquipment[MSPFilter, TelemetryFilter]):
         return self.telemetry.speed
 
     @property
-    def valve_position(self) -> int:
+    def valve_position(self) -> FilterValvePosition:
         """Current valve position."""
         return self.telemetry.valve_position
 
     @property
-    def why_on(self) -> int:
+    def why_on(self) -> FilterWhyOn:
         """Reason why the filter is on."""
         return self.telemetry.why_on
 

{python_omnilogic_local-0.23.0 → python_omnilogic_local-0.25.0}/pyomnilogic_local/heater.py

@@ -140,7 +140,7 @@ class Heater(OmniEquipment[MSPVirtualHeater, TelemetryVirtualHeater]):
         return self.mspconfig.min_temp
 
     @property
-    def mode(self) -> HeaterMode | int:
+    def mode(self) -> HeaterMode:
         """Returns the current heater mode from telemetry."""
         return self.telemetry.mode
 
@@ -174,7 +174,10 @@ class Heater(OmniEquipment[MSPVirtualHeater, TelemetryVirtualHeater]):
 
     @property
     def why_on(self) -> int:
-        """Returns the reason why the heater is on from telemetry."""
+        """Returns the reason why the heater is on from telemetry.
+
+        We don't have a good understanding of what these values mean yet
+        """
         return self.telemetry.why_on
 
     @property

{python_omnilogic_local-0.23.0 → python_omnilogic_local-0.25.0}/pyomnilogic_local/heater_equip.py

@@ -110,7 +110,7 @@ class HeaterEquipment(OmniEquipment[MSPHeaterEquip, TelemetryHeater]):
         return self.mspconfig.supports_cooling
 
     @property
-    def state(self) -> HeaterState | int:
+    def state(self) -> HeaterState:
         """Returns the current state of the heater equipment (OFF, ON, or PAUSE)."""
         return self.telemetry.state
 

{python_omnilogic_local-0.23.0 → python_omnilogic_local-0.25.0}/pyomnilogic_local/models/mspconfig.py

@@ -59,9 +59,7 @@ class OmniBase(BaseModel):
 
     def without_subdevices(self) -> Self:
         data = self.model_dump(exclude=self._sub_devices, round_trip=True, by_alias=True)
-        copied = self.model_validate(data)
-        _LOGGER.debug("without_subdevices: original=%s, copied=%s", self, copied)
-        return copied
+        return self.model_validate(data)
 
     def propagate_bow_id(self, bow_id: int) -> None:
         # First we set our own bow_id

{python_omnilogic_local-0.23.0 → python_omnilogic_local-0.25.0}/pyomnilogic_local/omnitypes.py

@@ -6,7 +6,7 @@ from .util import PrettyEnum
 
 
 # OmniAPI Enums
-class MessageType(IntEnum, PrettyEnum):
+class MessageType(PrettyEnum, IntEnum):
     XML_ACK = 0000
     REQUEST_CONFIGURATION = 1
     SET_FILTER_SPEED = 9
@@ -39,7 +39,7 @@ class MessageType(IntEnum, PrettyEnum):
     MSP_BLOCKMESSAGE = 1999
 
 
-class ClientType(IntEnum, PrettyEnum):
+class ClientType(PrettyEnum, IntEnum):
     XML = 0
     SIMPLE = 1
     OMNI = 3
@@ -71,7 +71,7 @@ class OmniType(StrEnum):
 
 
 # Backyard/BoW
-class BackyardState(IntEnum, PrettyEnum):
+class BackyardState(PrettyEnum, IntEnum):
     OFF = 0
     ON = 1
     SERVICE_MODE = 2
@@ -79,12 +79,12 @@ class BackyardState(IntEnum, PrettyEnum):
     TIMED_SERVICE_MODE = 4
 
 
-class BodyOfWaterState(IntEnum, PrettyEnum):
+class BodyOfWaterState(PrettyEnum, IntEnum):
     NO_FLOW = 0
     FLOW = 1
 
 
-class BodyOfWaterType(StrEnum, PrettyEnum):
+class BodyOfWaterType(PrettyEnum, StrEnum):
     POOL = "BOW_POOL"
     SPA = "BOW_SPA"
 
@@ -150,26 +150,26 @@ class ChlorinatorError(Flag):
     AQUARITE_PCB_ERROR = 1 << 14
 
 
-class ChlorinatorOperatingMode(IntEnum, PrettyEnum):
+class ChlorinatorOperatingMode(PrettyEnum, IntEnum):
     DISABLED = 0
     TIMED = 1
     ORP_AUTO = 2
     ORP_TIMED_RW = 3  # Chlorinator in ORP mode experienced CSAD condition that prevents ORP operation
 
 
-class ChlorinatorType(StrEnum, PrettyEnum):
+class ChlorinatorType(PrettyEnum, StrEnum):
     MAIN_PANEL = "CHLOR_TYPE_MAIN_PANEL"
     DISPENSER = "CHLOR_TYPE_DISPENSER"
     AQUA_RITE = "CHLOR_TYPE_AQUA_RITE"
 
 
-class ChlorinatorDispenserType(StrEnum, PrettyEnum):
+class ChlorinatorDispenserType(PrettyEnum, StrEnum):
     SALT = "SALT_DISPENSING"
     LIQUID = "LIQUID_DISPENSING"
     TABLET = "TABLET_DISPENSING"
 
 
-class ChlorinatorCellType(IntEnum, PrettyEnum):
+class ChlorinatorCellType(PrettyEnum, IntEnum):
     CELL_TYPE_UNKNOWN = 0
     CELL_TYPE_T3 = 1
     CELL_TYPE_T5 = 2
@@ -184,7 +184,7 @@ class ChlorinatorCellType(IntEnum, PrettyEnum):
 
 
 # Lights
-class ColorLogicSpeed(IntEnum, PrettyEnum):
+class ColorLogicSpeed(PrettyEnum, IntEnum):
     ONE_SIXTEENTH = 0
     ONE_EIGHTH = 1
     ONE_QUARTER = 2
@@ -196,7 +196,7 @@ class ColorLogicSpeed(IntEnum, PrettyEnum):
     SIXTEEN_TIMES = 8
 
 
-class ColorLogicBrightness(IntEnum, PrettyEnum):
+class ColorLogicBrightness(PrettyEnum, IntEnum):
     TWENTY_PERCENT = 0
     FOURTY_PERCENT = 1
     SIXTY_PERCENT = 2
@@ -207,7 +207,7 @@ class ColorLogicBrightness(IntEnum, PrettyEnum):
 type LightShows = ColorLogicShow25 | ColorLogicShow40 | ColorLogicShowUCL | ColorLogicShowUCLV2 | PentairShow | ZodiacShow
 
 
-class ColorLogicShow25(IntEnum, PrettyEnum):
+class ColorLogicShow25(PrettyEnum, IntEnum):
     VOODOO_LOUNGE = 0
     DEEP_BLUE_SEA = 1
     AFTERNOON_SKY = 2
@@ -222,7 +222,7 @@ class ColorLogicShow25(IntEnum, PrettyEnum):
     COOL_CABARET = 11
 
 
-class ColorLogicShow40(IntEnum, PrettyEnum):
+class ColorLogicShow40(PrettyEnum, IntEnum):
     VOODOO_LOUNGE = 0
     DEEP_BLUE_SEA = 1
     AFTERNOON_SKY = 2
@@ -237,7 +237,7 @@ class ColorLogicShow40(IntEnum, PrettyEnum):
     COOL_CABARET = 11
 
 
-class ColorLogicShowUCL(IntEnum, PrettyEnum):
+class ColorLogicShowUCL(PrettyEnum, IntEnum):
     VOODOO_LOUNGE = 0
     DEEP_BLUE_SEA = 1
     ROYAL_BLUE = 2
@@ -257,7 +257,7 @@ class ColorLogicShowUCL(IntEnum, PrettyEnum):
     COOL_CABARET = 16
 
 
-class ColorLogicShowUCLV2(IntEnum, PrettyEnum):
+class ColorLogicShowUCLV2(PrettyEnum, IntEnum):
     VOODOO_LOUNGE = 0
     DEEP_BLUE_SEA = 1
     ROYAL_BLUE = 2
@@ -288,7 +288,7 @@ class ColorLogicShowUCLV2(IntEnum, PrettyEnum):
     BRIGHT_YELLOW = 26
 
 
-class PentairShow(IntEnum, PrettyEnum):
+class PentairShow(PrettyEnum, IntEnum):
     SAM = 0
     PARTY = 1
     ROMANCE = 2
@@ -303,7 +303,7 @@ class PentairShow(IntEnum, PrettyEnum):
     MAGENTA = 11
 
 
-class ZodiacShow(IntEnum, PrettyEnum):
+class ZodiacShow(PrettyEnum, IntEnum):
     ALPINE_WHITE = 0
     SKY_BLUE = 1
     COBALT_BLUE = 2
@@ -320,7 +320,7 @@ class ZodiacShow(IntEnum, PrettyEnum):
     DISCO_TECH = 13
 
 
-class ColorLogicPowerState(IntEnum, PrettyEnum):
+class ColorLogicPowerState(PrettyEnum, IntEnum):
     OFF = 0
     POWERING_OFF = 1
     CHANGING_SHOW = 3
@@ -329,7 +329,7 @@ class ColorLogicPowerState(IntEnum, PrettyEnum):
     COOLDOWN = 7
 
 
-class ColorLogicLightType(StrEnum, PrettyEnum):
+class ColorLogicLightType(PrettyEnum, StrEnum):
     UCL = "COLOR_LOGIC_UCL"
     FOUR_ZERO = "COLOR_LOGIC_4_0"
     TWO_FIVE = "COLOR_LOGIC_2_5"
@@ -342,22 +342,22 @@ class ColorLogicLightType(StrEnum, PrettyEnum):
         return ColorLogicLightType[self.name].value
 
 
-class CSADType(StrEnum, PrettyEnum):
+class CSADType(PrettyEnum, StrEnum):
     ACID = "ACID"
     CO2 = "CO2"
 
 
-class CSADEquipmentType(StrEnum, PrettyEnum):
+class CSADEquipmentType(PrettyEnum, StrEnum):
     AQL_CHEM = "AQL-CHEM"
 
 
 # Chemistry Sense and Dispense
-class CSADStatus(IntEnum, PrettyEnum):
+class CSADStatus(PrettyEnum, IntEnum):
     NOT_DISPENSING = 0
     DISPENSING = 1
 
 
-class CSADMode(IntEnum, PrettyEnum):
+class CSADMode(PrettyEnum, IntEnum):
     OFF = 0
     AUTO = 1
     FORCE_ON = 2
@@ -366,7 +366,7 @@ class CSADMode(IntEnum, PrettyEnum):
 
 
 # Filters
-class FilterState(IntEnum, PrettyEnum):
+class FilterState(PrettyEnum, IntEnum):
     OFF = 0
     ON = 1
     PRIMING = 2
@@ -381,13 +381,13 @@ class FilterState(IntEnum, PrettyEnum):
     FILTER_WAITING_TURN_OFF = 11
 
 
-class FilterType(StrEnum, PrettyEnum):
+class FilterType(PrettyEnum, StrEnum):
     VARIABLE_SPEED = "FMT_VARIABLE_SPEED_PUMP"
     DUAL_SPEED = "FMT_DUAL_SPEED"
     SINGLE_SPEED = "FMT_SINGLE_SPEED"
 
 
-class FilterValvePosition(IntEnum, PrettyEnum):
+class FilterValvePosition(PrettyEnum, IntEnum):
     POOL_ONLY = 1
     SPA_ONLY = 2
     SPILLOVER = 3
@@ -395,7 +395,7 @@ class FilterValvePosition(IntEnum, PrettyEnum):
     HIGH_PRIO_HEAT = 5
 
 
-class FilterWhyOn(IntEnum, PrettyEnum):
+class FilterWhyOn(PrettyEnum, IntEnum):
     OFF = 0
     NO_WATER_FLOW = 1
     COOLDOWN = 2
@@ -417,28 +417,30 @@ class FilterWhyOn(IntEnum, PrettyEnum):
     GROUP_COMMAND = 18
     SPILLOVER_INTERLOCK = 19
     MAX_VALUE = 20
+    UNKNOWN_1 = 21
+    UNKNOWN_2 = 22
 
 
-class FilterSpeedPresets(StrEnum, PrettyEnum):
+class FilterSpeedPresets(PrettyEnum, StrEnum):
     LOW = auto()
     MEDIUM = auto()
     HIGH = auto()
 
 
 # Groups
-class GroupState(IntEnum, PrettyEnum):
+class GroupState(PrettyEnum, IntEnum):
     OFF = 0
     ON = 1
 
 
 # Heaters
-class HeaterState(IntEnum, PrettyEnum):
+class HeaterState(PrettyEnum, IntEnum):
     OFF = 0
     ON = 1
     PAUSE = 2
 
 
-class HeaterType(StrEnum, PrettyEnum):
+class HeaterType(PrettyEnum, StrEnum):
     GAS = "HTR_GAS"
     HEAT_PUMP = "HTR_HEAT_PUMP"
     SOLAR = "HTR_SOLAR"
@@ -449,26 +451,26 @@ class HeaterType(StrEnum, PrettyEnum):
     SMART_HEAT_PUMP = "HTR_SMART_HEAT_PUMP"
 
 
-class HeaterMode(IntEnum, PrettyEnum):
+class HeaterMode(PrettyEnum, IntEnum):
     HEAT = 0
     COOL = 1
     AUTO = 2
 
 
 # Pumps
-class PumpState(IntEnum, PrettyEnum):
+class PumpState(PrettyEnum, IntEnum):
     OFF = 0
     ON = 1
     FREEZE_PROTECT = 2  # This is an assumption that 2 means freeze protect, ref: https://github.com/cryptk/haomnilogic-local/issues/147
 
 
-class PumpType(StrEnum, PrettyEnum):
+class PumpType(PrettyEnum, StrEnum):
     SINGLE_SPEED = "PMP_SINGLE_SPEED"
     DUAL_SPEED = "PMP_DUAL_SPEED"
     VARIABLE_SPEED = "PMP_VARIABLE_SPEED_PUMP"
 
 
-class PumpFunction(StrEnum, PrettyEnum):
+class PumpFunction(PrettyEnum, StrEnum):
     PUMP = "PMP_PUMP"
     WATER_FEATURE = "PMP_WATER_FEATURE"
     CLEANER = "PMP_CLEANER"
@@ -485,14 +487,14 @@ class PumpFunction(StrEnum, PrettyEnum):
     CLEANER_IN_FLOOR = "PMP_CLEANER_IN_FLOOR"
 
 
-class PumpSpeedPresets(StrEnum, PrettyEnum):
+class PumpSpeedPresets(PrettyEnum, StrEnum):
     LOW = auto()
     MEDIUM = auto()
     HIGH = auto()
 
 
 # Relays
-class RelayFunction(StrEnum, PrettyEnum):
+class RelayFunction(PrettyEnum, StrEnum):
     WATER_FEATURE = "RLY_WATER_FEATURE"
     LIGHT = "RLY_LIGHT"
     BACKYARD_LIGHT = "RLY_BACKYARD_LIGHT"
@@ -512,18 +514,18 @@ class RelayFunction(StrEnum, PrettyEnum):
     CLEANER_IN_FLOOR = "RLY_CLEANER_IN_FLOOR"
 
 
-class RelayState(IntEnum, PrettyEnum):
+class RelayState(PrettyEnum, IntEnum):
     OFF = 0
     ON = 1
 
 
-class RelayType(StrEnum, PrettyEnum):
+class RelayType(PrettyEnum, StrEnum):
     VALVE_ACTUATOR = "RLY_VALVE_ACTUATOR"
     HIGH_VOLTAGE = "RLY_HIGH_VOLTAGE_RELAY"
     LOW_VOLTAGE = "RLY_LOW_VOLTAGE_RELAY"
 
 
-class RelayWhyOn(IntEnum, PrettyEnum):
+class RelayWhyOn(PrettyEnum, IntEnum):
     NO_MESSAGE = 0
     MANUAL_OFF = 1
     COUNTDOWN_DONE = 2
@@ -539,7 +541,7 @@ class RelayWhyOn(IntEnum, PrettyEnum):
 
 
 # Sensors
-class SensorType(StrEnum, PrettyEnum):
+class SensorType(PrettyEnum, StrEnum):
     AIR_TEMP = "SENSOR_AIR_TEMP"
     SOLAR_TEMP = "SENSOR_SOLAR_TEMP"
     WATER_TEMP = "SENSOR_WATER_TEMP"
@@ -548,7 +550,7 @@ class SensorType(StrEnum, PrettyEnum):
     EXT_INPUT = "SENSOR_EXT_INPUT"
 
 
-class SensorUnits(StrEnum, PrettyEnum):
+class SensorUnits(PrettyEnum, StrEnum):
     FAHRENHEIT = "UNITS_FAHRENHEIT"
     CELSIUS = "UNITS_CELSIUS"
     PPM = "UNITS_PPM"
@@ -559,13 +561,13 @@ class SensorUnits(StrEnum, PrettyEnum):
 
 
 # Valve Actuators
-class ValveActuatorState(IntEnum, PrettyEnum):
+class ValveActuatorState(PrettyEnum, IntEnum):
     OFF = 0
     ON = 1
 
 
 # Schedules
-class ScheduleDaysActive(Flag, PrettyEnum):
+class ScheduleDaysActive(PrettyEnum, Flag):
     MONDAY = 1 << 0
     TUESDAY = 1 << 1
     WEDNESDAY = 1 << 2

{python_omnilogic_local-0.23.0 → python_omnilogic_local-0.25.0}/pyomnilogic_local/pump.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from typing import TYPE_CHECKING
+
 from pyomnilogic_local._base import OmniEquipment
 from pyomnilogic_local.decorators import control_method
 from pyomnilogic_local.models.mspconfig import MSPPump
@@ -7,6 +9,9 @@ from pyomnilogic_local.models.telemetry import TelemetryPump
 from pyomnilogic_local.omnitypes import PumpSpeedPresets, PumpState
 from pyomnilogic_local.util import OmniEquipmentNotInitializedError
 
+if TYPE_CHECKING:
+    from pyomnilogic_local.omnitypes import PumpFunction, PumpType
+
 
 class Pump(OmniEquipment[MSPPump, TelemetryPump]):
     """Represents a pump in the OmniLogic system.
@@ -80,12 +85,12 @@ class Pump(OmniEquipment[MSPPump, TelemetryPump]):
 
     # Expose MSPConfig attributes
     @property
-    def equip_type(self) -> str:
+    def equip_type(self) -> PumpType:
         """The pump type (e.g., PMP_VARIABLE_SPEED_PUMP)."""
         return self.mspconfig.equip_type
 
     @property
-    def function(self) -> str:
+    def function(self) -> PumpFunction:
         """The pump function (e.g., PMP_PUMP, PMP_WATER_FEATURE)."""
         return self.mspconfig.function
 
@@ -131,7 +136,7 @@ class Pump(OmniEquipment[MSPPump, TelemetryPump]):
 
     # Expose Telemetry attributes
     @property
-    def state(self) -> PumpState | int:
+    def state(self) -> PumpState:
         """Current pump state."""
         return self.telemetry.state
 
@@ -147,7 +152,10 @@ class Pump(OmniEquipment[MSPPump, TelemetryPump]):
 
     @property
     def why_on(self) -> int:
-        """Reason why the pump is on."""
+        """Reason why the pump is on.
+
+        We don't have a confirmation that these are the same as the FilterWhyOn states yet.
+        """
         return self.telemetry.why_on
 
     # Computed properties

{python_omnilogic_local-0.23.0 → python_omnilogic_local-0.25.0}/pyomnilogic_local/sensor.py

@@ -86,7 +86,7 @@ class Sensor(OmniEquipment[MSPSensor, None]):
         super().__init__(omni, mspconfig, telemetry)
 
     @property
-    def equip_type(self) -> SensorType | str:
+    def equip_type(self) -> SensorType:
         """Returns the type of sensor.
 
         Can be AIR_TEMP, SOLAR_TEMP, WATER_TEMP, FLOW, ORP, or EXT_INPUT.
@@ -94,7 +94,7 @@ class Sensor(OmniEquipment[MSPSensor, None]):
         return self.mspconfig.equip_type
 
     @property
-    def units(self) -> SensorUnits | str:
+    def units(self) -> SensorUnits:
         """Returns the units used by the sensor.
 
         Can be FAHRENHEIT, CELSIUS, PPM, GRAMS_PER_LITER, MILLIVOLTS,

{python_omnilogic_local-0.23.0 → python_omnilogic_local-0.25.0}/pyomnilogic_local/system.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Literal
 
 if TYPE_CHECKING:
     from pyomnilogic_local.models.mspconfig import MSPSystem
@@ -15,12 +15,12 @@ class System:
         self.update_config(mspconfig)
 
     @property
-    def vsp_speed_format(self) -> str | None:
+    def vsp_speed_format(self) -> Literal["RPM", "Percent"]:
         """The VSP speed format of the system."""
         return self.mspconfig.vsp_speed_format
 
     @property
-    def units(self) -> str | None:
+    def units(self) -> Literal["Standard", "Metric"]:
         """The units of the system."""
         return self.mspconfig.units
 

{python_omnilogic_local-0.23.0 → python_omnilogic_local-0.25.0}/pyomnilogic_local/util.py

@@ -40,9 +40,15 @@ class OmniConnectionError(OmniLogicLocalError):
 
 
 class PrettyEnum(Enum):
-    def pretty(self) -> str:
+    def __str__(self) -> str:
+        """Return a human-friendly string representation of the enum member."""
         return self.name.replace("_", " ").title()
 
     @classmethod
-    def from_pretty(cls, name: str) -> Self:
-        return cls[name.upper().replace(" ", "_")]
+    def from_str(cls, name: str) -> Self:
+        lookup_key = name.upper().replace(" ", "_")
+        try:
+            return cls[lookup_key]
+        except KeyError as err:
+            msg = f"'{name}' is not a valid {cls.__name__}"
+            raise ValueError(msg) from err

{python_omnilogic_local-0.23.0 → python_omnilogic_local-0.25.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-omnilogic-local"
-version = "0.23.0"
+version = "0.25.0"
 description = "A library for local control of Hayward OmniHub/OmniLogic pool controllers using their local API"
 readme = "README.md"
 requires-python = ">=3.14.2"
@@ -12,7 +12,6 @@ authors = [
 license-files = ["LICENSE"]
 dependencies = [
     "pydantic >=2.0.0,<3.0.0",
-    "click >=8.0.0,<9.0.0",
     "xmltodict >=1.0.1,<2.0.0",
 ]
 
@@ -22,6 +21,7 @@ omnilogic = "pyomnilogic_local.cli.cli:entrypoint"
 [project.optional-dependencies]
 cli = [
     "scapy>=2.6.1,<3.0.0",
+    "click >=8.0.0,<9.0.0",
 ]
 build = [
     "uv ~= 0.11.6"