feat: add some nicer repr functions to equipment classes

Author: cryptk

pyomnilogic_local/_base.py

@@ -149,3 +149,19 @@ def update_telemetry(self, telemetry: Telemetry) -> None:
             self.telemetry = cast(TelemetryT, specific_telemetry)
         else:
             self.telemetry = cast(TelemetryT, None)
+
+    def __repr__(self) -> str:
+        """Return a string representation of the equipment for debugging.
+
+        Returns:
+            A string showing the class name, system_id, name, and state (if available).
+        """
+        class_name = self.__class__.__name__
+        parts = [f"system_id={self.system_id!r}", f"name={self.name!r}"]
+
+        # Include state if the equipment has telemetry with a state attribute
+        if hasattr(self, "telemetry") and self.telemetry is not None:
+            if (state := getattr(self.telemetry, "state", None)) is not None:
+                parts.append(f"state={state!r}")
+
+        return f"{class_name}({', '.join(parts)})"

pyomnilogic_local/bow.py

@@ -138,6 +138,31 @@ class Bow(OmniEquipment[MSPBoW, TelemetryBoW]):
     def __init__(self, omni: "OmniLogic", mspconfig: MSPBoW, telemetry: Telemetry) -> None:
         super().__init__(omni, mspconfig, telemetry)
 
+    def __repr__(self) -> str:
+        """Return a string representation of the Bow for debugging.
+
+        Returns:
+            A string showing the class name, system_id, name, type, and equipment counts.
+        """
+        parts = [f"system_id={self.system_id!r}", f"name={self.name!r}", f"type={self.equip_type!r}"]
+
+        # Add equipment counts
+        parts.append(f"filters={len(self.filters)}")
+        parts.append(f"pumps={len(self.pumps)}")
+        parts.append(f"lights={len(self.lights)}")
+        parts.append(f"relays={len(self.relays)}")
+        parts.append(f"sensors={len(self.sensors)}")
+
+        # Add heater and chlorinator status (present or not)
+        if self.heater is not None:
+            parts.append("heater=True")
+        if self.chlorinator is not None:
+            parts.append("chlorinator=True")
+        if len(self.csads) > 0:
+            parts.append(f"csads={len(self.csads)}")
+
+        return f"Bow({', '.join(parts)})"
+
     @property
     def equip_type(self) -> BodyOfWaterType | str:
         """The equipment type of the bow (POOL or SPA)."""

pyomnilogic_local/omnilogic.py

@@ -42,6 +42,27 @@ def __init__(self, host: str, port: int = 10444) -> None:
         self._api = OmniLogicAPI(host, port)
         self._refresh_lock = asyncio.Lock()
 
+    def __repr__(self) -> str:
+        """Return a string representation of the OmniLogic instance for debugging.
+
+        Returns:
+            A string showing host, port, and counts of various equipment types.
+        """
+        # Only show equipment counts if backyard has been initialized
+        if hasattr(self, "backyard"):
+            bow_count = len(self.backyard.bow)
+            light_count = len(self.all_lights)
+            relay_count = len(self.all_relays)
+            pump_count = len(self.all_pumps)
+            filter_count = len(self.all_filters)
+
+            return (
+                f"OmniLogic(host={self.host!r}, port={self.port}, "
+                f"bows={bow_count}, lights={light_count}, relays={relay_count}, "
+                f"pumps={pump_count}, filters={filter_count})"
+            )
+        return f"OmniLogic(host={self.host!r}, port={self.port}, not_initialized=True)"
+
     async def refresh(
         self,
         *,