feat: implement new omnitype data

BREAKING CHANGE: Many items that previously returned a raw int value now parse a proper enum value.
Specifically Chlorinator operating_state, ColorLogic Light special_effect, Heater why_on, Pump why_on

Author: cryptk

pyomnilogic_local/chlorinator.py

@@ -8,13 +8,18 @@
 from pyomnilogic_local.decorators import control_method
 from pyomnilogic_local.models.mspconfig import MSPChlorinator
 from pyomnilogic_local.models.telemetry import TelemetryChlorinator
-from pyomnilogic_local.omnitypes import ChlorinatorMSPConfigMode, ChlorinatorStatus
+from pyomnilogic_local.omnitypes import ChlorinatorMode, ChlorinatorStatus
 from pyomnilogic_local.util import OmniEquipmentNotInitializedError
 
 if TYPE_CHECKING:
     from pyomnilogic_local.models.telemetry import Telemetry
     from pyomnilogic_local.omnilogic import OmniLogic
-    from pyomnilogic_local.omnitypes import ChlorinatorCellType, ChlorinatorDispenserType, ChlorinatorOperatingMode
+    from pyomnilogic_local.omnitypes import (
+        ChlorinatorCellType,
+        ChlorinatorDispenserType,
+        ChlorinatorOperatingMode,
+        ChlorinatorOperatingState,
+    )
 
 
 class Chlorinator(OmniEquipment[MSPChlorinator, TelemetryChlorinator]):
@@ -94,12 +99,12 @@ def cell_type(self) -> ChlorinatorCellType:
 
     # Expose Telemetry attributes
     @property
-    def operating_state(self) -> int:
+    def operating_state(self) -> ChlorinatorOperatingState:
         """Current operational state of the chlorinator (raw value)."""
         return self.telemetry.operating_state
 
     @property
-    def mode(self) -> ChlorinatorMSPConfigMode:
+    def mode(self) -> ChlorinatorMode:
         """Current operating mode from MSP Config (NOT_CONFIGURED, TIMED, ORP_AUTO).
 
         TThis data appears to have some discrepancies with the mode reported in the Telemetry.
@@ -421,7 +426,7 @@ async def set_timed_percent(self, percent: int) -> None:
         )
 
     @control_method
-    async def set_op_mode(self, op_mode: ChlorinatorMSPConfigMode) -> None:
+    async def set_op_mode(self, op_mode: ChlorinatorMode) -> None:
         """Set the operating mode for chlorine generation.
 
         Args:
@@ -453,9 +458,9 @@ async def set_op_mode(self, op_mode: ChlorinatorMSPConfigMode) -> None:
 
         new_op_mode: int
         match op_mode:
-            case ChlorinatorMSPConfigMode.TIMED:
+            case ChlorinatorMode.TIMED:
                 new_op_mode = 1
-            case ChlorinatorMSPConfigMode.ORP_AUTO:
+            case ChlorinatorMode.ORP_AUTO:
                 new_op_mode = 2
             case _:
                 msg = f"Unsupported operating mode: {op_mode}"

pyomnilogic_local/colorlogiclight.py

@@ -14,7 +14,7 @@
 if TYPE_CHECKING:
     from pyomnilogic_local.models.telemetry import Telemetry
     from pyomnilogic_local.omnilogic import OmniLogic
-    from pyomnilogic_local.omnitypes import LightShows
+    from pyomnilogic_local.omnitypes import ColorLogicSpecialEffect, LightShows
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -197,7 +197,7 @@ def brightness(self) -> ColorLogicBrightness:
         return ColorLogicBrightness.ONE_HUNDRED_PERCENT
 
     @property
-    def special_effect(self) -> int:
+    def special_effect(self) -> ColorLogicSpecialEffect:
         """Returns the current special effect."""
         return self.telemetry.special_effect
 

pyomnilogic_local/heater.py

@@ -13,7 +13,7 @@
 if TYPE_CHECKING:
     from pyomnilogic_local.models.telemetry import Telemetry
     from pyomnilogic_local.omnilogic import OmniLogic
-    from pyomnilogic_local.omnitypes import HeaterMode
+    from pyomnilogic_local.omnitypes import HeaterMode, HeaterWhyOn
 
 
 class Heater(OmniEquipment[MSPVirtualHeater, TelemetryVirtualHeater]):
@@ -173,7 +173,7 @@ def silent_mode(self) -> int:
         return self.telemetry.silent_mode
 
     @property
-    def why_on(self) -> int:
+    def why_on(self) -> HeaterWhyOn:
         """Returns the reason why the heater is on from telemetry.
 
         We don't have a good understanding of what these values mean yet

pyomnilogic_local/models/mspconfig.py

@@ -20,7 +20,7 @@
     BodyOfWaterType,
     ChlorinatorCellType,
     ChlorinatorDispenserType,
-    ChlorinatorMSPConfigMode,
+    ChlorinatorMode,
     ChlorinatorType,
     ColorLogicLightType,
     ColorLogicShow25,
@@ -218,7 +218,7 @@ class MSPChlorinator(OmniBase):
     omni_type: OmniType = OmniType.CHLORINATOR
 
     enabled: bool = Field(alias="Enabled")
-    mode: ChlorinatorMSPConfigMode = Field(alias="Mode")
+    mode: ChlorinatorMode = Field(alias="Mode")
     timed_percent: int = Field(alias="Timed-Percent")
     superchlor_timeout: int = Field(alias="SuperChlor-Timeout")
     orp_timeout: int = Field(alias="ORP-Timeout")
@@ -377,7 +377,7 @@ class MSPSchedule(OmniBase):
     bow_id: int = Field(alias="bow-system-id")  # pyright: ignore[reportGeneralTypeIssues]
     equipment_id: int = Field(alias="equipment-id")
     system_id: int = Field(alias="schedule-system-id")
-    event: MessageType = Field(alias="event")
+    event: MessageType | int = Field(alias="event")
     data: int = Field(alias="data")
     enabled: bool = Field()
     start_minute: int = Field(alias="start-minute")

pyomnilogic_local/models/telemetry.py

@@ -11,6 +11,7 @@
     ChlorinatorAlert,
     ChlorinatorError,
     ChlorinatorOperatingMode,
+    ChlorinatorOperatingState,
     ChlorinatorStatus,
     ColorLogicBrightness,
     ColorLogicLightType,
@@ -19,6 +20,7 @@
     ColorLogicShow40,
     ColorLogicShowUCL,
     ColorLogicShowUCLV2,
+    ColorLogicSpecialEffect,
     ColorLogicSpeed,
     CSADMode,
     CSADStatus,
@@ -28,10 +30,12 @@
     GroupState,
     HeaterMode,
     HeaterState,
+    HeaterWhyOn,
     LightShows,
     OmniType,
     PentairShow,
     PumpState,
+    PumpWhyOn,
     RelayState,
     RelayWhyOn,
     ValveActuatorState,
@@ -127,7 +131,7 @@ class TelemetryChlorinator(BaseModel):
     chlr_alert_raw: int = Field(alias="@chlrAlert")
     chlr_error_raw: int = Field(alias="@chlrError")
     sc_mode: int = Field(alias="@scMode")
-    operating_state: int = Field(alias="@operatingState")
+    operating_state: ChlorinatorOperatingState = Field(alias="@operatingState")
     timed_percent: int | None = Field(alias="@Timed-Percent", default=None)
     operating_mode: ChlorinatorOperatingMode = Field(alias="@operatingMode")
     enable: bool = Field(alias="@enable")
@@ -263,7 +267,7 @@ class TelemetryColorLogicLight(BaseModel):
     show: LightShows = Field(alias="@currentShow")
     speed: ColorLogicSpeed = Field(alias="@speed")
     brightness: ColorLogicBrightness = Field(alias="@brightness")
-    special_effect: int = Field(alias="@specialEffect")
+    special_effect: ColorLogicSpecialEffect = Field(alias="@specialEffect")
 
     def show_name(
         self, model: ColorLogicLightType, v2: bool
@@ -381,7 +385,7 @@ class TelemetryPump(BaseModel):
     state: PumpState = Field(alias="@pumpState")
     speed: int = Field(alias="@pumpSpeed")
     last_speed: int = Field(alias="@lastSpeed")
-    why_on: int = Field(alias="@whyOn")
+    why_on: PumpWhyOn = Field(alias="@whyOn")
 
 
 class TelemetryRelay(BaseModel):
@@ -447,7 +451,7 @@ class TelemetryVirtualHeater(BaseModel):
     solar_set_point: int = Field(alias="@SolarSetPoint")
     mode: HeaterMode = Field(alias="@Mode")
     silent_mode: int = Field(alias="@SilentMode")
-    why_on: int = Field(alias="@whyHeaterIsOn")
+    why_on: HeaterWhyOn = Field(alias="@whyHeaterIsOn")
 
 
 type TelemetryType = (

pyomnilogic_local/omnitypes.py

@@ -151,12 +151,14 @@ class ChlorinatorError(PrettyEnum, Flag):
     AQUARITE_PCB_ERROR = 1 << 14
 
 
-class ChlorinatorMSPConfigMode(PrettyEnum, StrEnum):
+# Chlorinator Mode is used in the MSPConfig to represent the desired mode
+class ChlorinatorMode(PrettyEnum, StrEnum):
     DISABLED = "CHLOR_OP_MODE_NOT_CONFIG_R"
     TIMED = "CHLOR_OP_MODE_TIMED"
     ORP_AUTO = "CHLOR_OP_MODE_ORP_AUTO"
 
 
+# Chlorinator Operating Mode is used in the Telemetry to represent the current mode
 class ChlorinatorOperatingMode(PrettyEnum, IntEnum):
     DISABLED = 0
     TIMED = 1
@@ -487,6 +489,25 @@ class HeaterMode(PrettyEnum, IntEnum):
     OFF = 3  # https://github.com/cryptk/haomnilogic-local/issues/172
 
 
+class HeaterWhyOn(PrettyEnum, IntEnum):
+    NO_MESSAGE = 0
+    STOP_HEATER = 1
+    BOOST = 2
+    MANUAL_ON = 3
+    ON_EVENT = 4
+    COOLING = 5
+    SET_CUR_SET_POINT = 6
+    PAUSE = 7
+    RESUME = 8
+    SET_HEATER_SCHEDULE = 9
+    RESTORE_HEATER_SETPOINT = 10
+    STOP_COOL_DOWN = 11
+    SET_SOLAR_SET_POINT = 12
+    SET_SOLAR_SCHEDULE = 13
+    RESTORE_SOLAR_SETPOINT = 14
+    SET_HEATER_MODE = 15
+
+
 # Pumps
 class PumpState(PrettyEnum, IntEnum):
     OFF = 0

pyomnilogic_local/pump.py

@@ -10,7 +10,7 @@
 from pyomnilogic_local.util import OmniEquipmentNotInitializedError
 
 if TYPE_CHECKING:
-    from pyomnilogic_local.omnitypes import PumpFunction
+    from pyomnilogic_local.omnitypes import PumpFunction, PumpWhyOn
 
 
 class Pump(OmniEquipment[MSPPump, TelemetryPump]):
@@ -151,7 +151,7 @@ def last_speed(self) -> int:
         return self.telemetry.last_speed
 
     @property
-    def why_on(self) -> int:
+    def why_on(self) -> PumpWhyOn:
         """Reason why the pump is on.
 
         We don't have a confirmation that these are the same as the FilterWhyOn states yet.

pyomnilogic_local/schedule.py

@@ -10,6 +10,7 @@
 if TYPE_CHECKING:
     from pyomnilogic_local.models.telemetry import Telemetry
     from pyomnilogic_local.omnilogic import OmniLogic
+    from pyomnilogic_local.omnitypes import MessageType
 
 
 class Schedule(OmniEquipment[MSPSchedule, None]):
@@ -78,9 +79,9 @@ def equipment_id(self) -> int:
         return self.mspconfig.equipment_id
 
     @property
-    def event(self) -> int:
+    def event(self) -> MessageType | int:
         """Returns the event/action ID that will be executed."""
-        return self.mspconfig.event.value
+        return self.mspconfig.event
 
     @property
     def data(self) -> int:

tests/test_filter_pump.py

@@ -13,9 +13,11 @@
     FilterSpeedPresets,
     FilterState,
     FilterType,
+    FilterWhyOn,
     PumpFunction,
     PumpState,
     PumpType,
+    PumpWhyOn,
 )
 from pyomnilogic_local.pump import Pump
 
@@ -57,7 +59,7 @@ def sample_filter_telemetry() -> TelemetryFilter:
             "@filterState": FilterState.ON,
             "@filterSpeed": 60,
             "@valvePosition": 1,
-            "@whyFilterIsOn": 14,
+            "@whyFilterIsOn": FilterWhyOn.TIMED_EVENT,
             "@reportedFilterSpeed": 60,
             "@power": 500,
             "@lastSpeed": 50,
@@ -95,7 +97,7 @@ def sample_pump_telemetry() -> TelemetryPump:
             "@pumpState": PumpState.ON,
             "@pumpSpeed": 60,
             "@lastSpeed": 50,
-            "@whyOn": 11,
+            "@whyOn": PumpWhyOn.MANUAL_ON,
         },
     )
 
@@ -142,7 +144,7 @@ def test_filter_properties_telemetry(self, mock_omni: Mock, sample_filter_config
         assert filter_obj.state == FilterState.ON
         assert filter_obj.speed == 60
         assert filter_obj.valve_position == 1
-        assert filter_obj.why_on == 14
+        assert filter_obj.why_on == FilterWhyOn.TIMED_EVENT
         assert filter_obj.reported_speed == 60
         assert filter_obj.power == 500
         assert filter_obj.last_speed == 50
@@ -291,7 +293,7 @@ def test_pump_properties_telemetry(self, mock_omni: Mock, sample_pump_config: MS
         assert pump_obj.state == PumpState.ON
         assert pump_obj.speed == 60
         assert pump_obj.last_speed == 50
-        assert pump_obj.why_on == 11
+        assert pump_obj.why_on == PumpWhyOn.MANUAL_ON
 
     def test_pump_is_on_true(self, mock_omni: Mock, sample_pump_config: MSPPump, mock_telemetry: Mock) -> None:
         """Test is_on returns True when pump is on."""