zcc-helper 3.8.dev3__tar.gz → 3.8.1.dev1__tar.gz

{zcc_helper-3.8.dev3/zcc_helper.egg-info → zcc_helper-3.8.1.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: zcc_helper
-Version: 3.8.dev3
+Version: 3.8.1.dev1
 Summary: ZIMI ZCC helper module
 Author: Mark Hannon
 Author-email: mark.hannon@gmail.com

{zcc_helper-3.8.dev3 → zcc_helper-3.8.1.dev1}/zcc/constants.py

@@ -9,4 +9,4 @@ APP_ID = "ZvWqWJQB"
 APP_TOKEN = "3422ecbb-cf6a-404c-b3dc-2023dd213535"
 
 NAME = "zcc_helper"
-VERSION = "3.8dev3"
+VERSION = "3.8.1dev1"

{zcc_helper-3.8.dev3 → zcc_helper-3.8.1.dev1}/zcc/controller.py

@@ -5,12 +5,18 @@
 from __future__ import annotations
 
 import asyncio
-import datetime
 import logging
 import socket
 import time
 import uuid
 from pprint import pformat
+
+# Set to True to ignore missing device states during initial fetch
+IGNORE_MISSING_STATES = True
+
+# Set to True to ignore missing manufacture_info during initial fetch (e.g. for older firmware versions)
+IGNORE_MISSING_MANUFACTURE_INFO = True
+
 from typing import Dict, List
 
 from zcc.constants import LEVEL_BY_VERBOSITY, NAME, VERSION
@@ -139,6 +145,11 @@ class ControlPoint:
             filter(lambda device: device.type == "garagedoor", self.devices.values())
         )
 
+    @property
+    def warnings(self) -> List[ControlPointDevice]:
+        """Return a list of devices with empty or missing states (incomplete data)."""
+        return [device for device in self.devices.values() if not device.states]
+
     async def connect(self, fast: bool = False) -> bool:
         """Connect to ZCC, build device table and subscribe to updates"""
         self.logger.info("Connecting to ZCC %s:%d", self.host, self.port)
@@ -264,7 +275,7 @@ class ControlPoint:
         self.disconnect()
 
     def describe(self) -> str:
-        """Return a string representation of ZCC including devices"""
+        """Return a string representation of ZCC including devices and warnings."""
         header = "+" + "-" * 130 + "+"
         if self.host:
             description = header + "\n"
@@ -301,6 +312,12 @@ class ControlPoint:
                 )
             )
             description += header + "\n"
+
+            # Add warnings section if there are devices with incomplete data
+            if self.warnings:
+                description += "| WARNING: One or more devices have incomplete data.   Check for WARNINGS and upgrade firmware with Zimi app                         |\n"
+                description += "+" + "-" * 130 + "+\n"
+
             description_details = []
             for key in self.manufacture_infos:
                 description_details.append(self.manufacture_infos[key].describe())
@@ -340,12 +357,18 @@ class ControlPoint:
         try:
             await asyncio.wait_for(
                 self.manufacture_info_ready,
-                timeout=ControlPointProtocol.DEVICE_GET_TIMEOUT,
+                timeout=ControlPointProtocol.DEVICE_INFO_TIMEOUT,
             )
         except asyncio.exceptions.TimeoutError as error:
-            raise ControlPointError(
-                "ZCC connection failed - didn't receive manufacture_info."
-            ) from error
+            if IGNORE_MISSING_MANUFACTURE_INFO:
+                self.logger.warning(
+                    "ZCC connection warning - timeout waiting for manufacture_info."
+                )
+            else:
+                raise ControlPointError(
+                    "ZCC connection failed - didn't receive manufacture_info."
+                ) from error
+            # ) from error
 
         await asyncio.sleep(ControlPointProtocol.STEP_TIMEOUT)
 
@@ -386,17 +409,19 @@ class ControlPoint:
             ControlPointProtocol.get("states"), response_expected=False
         )
 
-        self.logger.debug("Over-riding states_ready future")
-        self.states_ready.set_result(True)
-
         try:
             await asyncio.wait_for(
                 self.states_ready, timeout=ControlPointProtocol.DEVICE_GET_TIMEOUT
             )
         except asyncio.exceptions.TimeoutError as error:
-            raise ControlPointError(
-                "ZCC connection failed - didn't receive any states."
-            ) from error
+            if IGNORE_MISSING_STATES:
+                self.logger.info(
+                    "ZCC connection warning - timeout waiting for device states."
+                )
+            else:
+                raise ControlPointError(
+                    "ZCC connection failed - didn't receive any states."
+                ) from error
 
         await asyncio.sleep(ControlPointProtocol.STEP_TIMEOUT)
 
@@ -443,11 +468,7 @@ class ControlPoint:
                 await self.re_connect()
             return
 
-        self.logger.debug(
-            "notify() received at %s:\n%s",
-            datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S"),
-            response,
-        )
+        self.logger.debug("notify() received:\n%s", response)
 
         if response.get(ControlPointProtocol.AUTH_APP_FAILED, None):
             self.logger.error("Authorisation failed\n%s", pformat(response))

{zcc_helper-3.8.dev3 → zcc_helper-3.8.1.dev1}/zcc/device.py

@@ -64,6 +64,8 @@ class ControlPointDevice:
     @property
     def __states(self) -> str:
         """Gets a descriptive string of the device state"""
+        if self.type == "behaviourlink":
+            return ""
         description = ""
         try:
             key = list(self.states["controlState"].keys())[0]
@@ -76,9 +78,9 @@ class ControlPointDevice:
             if fan_speed:
                 description += "/" + str(fan_speed)
         except IndexError:
-            pass
+            description = "WARNING"
         except KeyError:
-            pass
+            description = "WARNING"
         return description
 
     @property

{zcc_helper-3.8.dev3 → zcc_helper-3.8.1.dev1}/zcc/protocol.py

@@ -16,7 +16,8 @@ class ControlPointProtocol:
     START_SESSION_FAILED = "start_session_failed"
     START_SESSION_SUCCESS = "start_session_success"
     START_SESSION_TIMEOUT = 30
-    DEVICE_GET_TIMEOUT = 10
+    DEVICE_GET_TIMEOUT = 30
+    DEVICE_INFO_TIMEOUT = 120
     CONTROLPOINT_PROPERTIES = "controlpoint_properties"
     CONTROLPOINT_STATES = "controlpoint_states"
     CONTROLPOINT_ACTIONS = "controlpoint_actions"

{zcc_helper-3.8.dev3 → zcc_helper-3.8.1.dev1}/zcc/watchdog.py

@@ -1,44 +1,45 @@
-"""ZCC Watchdog Timer Class"""
+'''ZCC Watchdog Timer Class'''
 
 import asyncio
 import logging
 
 
 class ControlPointWatchdog:
-    """A class to create a timer with callback."""
+    '''A class to create a timer with callback.'''
 
     def __init__(self, timeout: int, callback):
-        self.logger = logging.getLogger("ControlPointWatchdog")
+
+        self.logger = logging.getLogger('ControlPointWatchdog')
 
         self._busy = False
         self._timeout = timeout
         self._callback = callback
         self._task = None
-        self.logger.debug("Created watchdog timer for %d seconds", self._timeout)
+        self.logger.debug(
+            "Created watchdog timer for %d seconds", self._timeout)
 
     async def _job(self):
         await asyncio.sleep(self._timeout)
-        self.logger.debug("Watchdog timer expired after %d seconds", self._timeout)
         self._busy = True
         await self._callback()
         self._busy = False
 
     def cancel(self):
-        """Cancel the timer."""
+        '''Cancel the timer.'''
         if not self._busy:
             self._task.cancel()
 
     def pause(self):
-        """Pause the timer"""
+        '''Pause the timer'''
         if self._task:
             self.cancel()
 
     def reset(self):
-        """Reset the timer."""
+        '''Reset the timer.'''
         if self._task:
             self.cancel()
         self.start()
 
     def start(self):
-        """Start the timer."""
+        '''Start the timer.'''
         self._task = asyncio.ensure_future(self._job())

{zcc_helper-3.8.dev3 → zcc_helper-3.8.1.dev1/zcc_helper.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: zcc_helper
-Version: 3.8.dev3
+Version: 3.8.1.dev1
 Summary: ZIMI ZCC helper module
 Author: Mark Hannon
 Author-email: mark.hannon@gmail.com