python-izone 1.2.9__py3-none-any.whl → 1.3.0__py3-none-any.whl

pizone/__init__.py

@@ -1,22 +1,31 @@
-"""Interface to the iZone airconditioner controller
+"""Interface to the iZone air conditioner controller.
 
-Interaction mostly through the Controller and Zone classes.
+Interaction is mostly through the :class:`~pizone.controller.Controller` and
+:class:`~pizone.zone.Zone` classes.
+
+Synchronous property reads return cached device data and do not raise
+:exc:`ConnectionError`. Async command and refresh methods perform HTTP I/O and
+raise :exc:`ConnectionError` when the device cannot be reached. They raise
+:exc:`~pizone.exceptions.ControllerCommandError` when the device responds but
+rejects the request (``{ERROR...}`` body or HTTP 4xx).
 """
 
-from .power import Power, PowerGroup, PowerDevice, PowerChannel, BatteryLevel
-from .zone import Zone
 from .controller import Controller
 from .discovery import DiscoveryService, Listener, discovery
+from .exceptions import ControllerCommandError
+from .power import BatteryLevel, Power, PowerChannel, PowerDevice, PowerGroup
+from .zone import Zone
 
-__ALL__ = [
-    Controller,
-    Zone,
-    DiscoveryService,
-    Listener,
-    discovery,
-    Power,
-    PowerGroup,
-    PowerDevice,
-    PowerChannel,
-    BatteryLevel,
+__all__ = [
+    "Controller",
+    "ControllerCommandError",
+    "Zone",
+    "DiscoveryService",
+    "Listener",
+    "discovery",
+    "Power",
+    "PowerGroup",
+    "PowerDevice",
+    "PowerChannel",
+    "BatteryLevel",
 ]