zcc-helper 3.3.1.dev2__tar.gz → 3.4__tar.gz

{zcc_helper-3.3.1.dev2 → zcc_helper-3.4}/PKG-INFO

@@ -1,16 +1,23 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: zcc_helper
-Version: 3.3.1.dev2
+Version: 3.4
 Summary: ZIMI ZCC helper module
-Home-page: UNKNOWN
 Author: Mark Hannon
 Author-email: mark.hannon@gmail.com
 License: MIT
 Project-URL: Source, https://bitbucket.org/mark_hannon/zcc
-Platform: UNKNOWN
-Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: summary
 
 # ZCC-HELPER
 
@@ -274,5 +281,3 @@ python -m zcc --execute --device 'bddf0500-4d15-4457-b063-c12ed208a0b0_3' --acti
 ```
 
 This version of the command is relatively slow as it first of all discovers the ZCC on the local LAN, builds a device inventory and then executes the action.
-
-

{zcc_helper-3.3.1.dev2 → zcc_helper-3.4}/setup.py

@@ -19,7 +19,7 @@ setup(
     author_email="mark.hannon@gmail.com",
     license="MIT",
     classifiers=[
-        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.12",
     ],
     packages=find_packages(exclude=["contrib", "docs", "tests"]),
     project_urls={"Source": "https://bitbucket.org/mark_hannon/zcc"},

zcc_helper-3.4/tests/test_controller.py

@@ -0,0 +1,59 @@
+'''Test Basic Controller functionality.'''
+import pytest
+
+from zcc.controller import ControlPoint, ControlPointError
+from zcc.device import ControlPointDevice
+
+from tests.test_server import test_server
+
+
+def test_controller_discover(test_server):
+    '''Test for connection to a Controller connected to the Test Server'''
+
+    controller = ControlPoint(timeout=1)
+
+    assert controller.ready is True
+    assert controller.host is not None
+    assert controller.port == 5003
+    assert controller.brand == 'zimi'
+    assert len(controller.devices) == 31
+    assert len(controller.doors) == 0
+    assert len(controller.fans) == 0
+    assert len(controller.lights) == 20
+    assert len(controller.outlets) == 0
+
+
+def test_controller_discover_timeout():
+    '''Test if a UDP discovery times out - goes out over wire'''
+
+    try:
+        ControlPoint(timeout=1)
+        assert False
+    except ControlPointError as error:
+        assert error.args[0] == '__init() failed - unable to discover and connect to ZCC'
+
+
+def test_controller_device(test_server):
+    '''Test turn_on works for valid devices'''
+
+    controller = ControlPoint(timeout=1)
+
+    light = controller.lights[0]
+
+    assert light.is_off() is not True
+    assert light.is_on() is True
+
+    assert light.is_opening is not True
+    assert light.is_open is not True
+    assert light.location == "lounge LED strip/Lounge"
+    assert light.name == "lounge LED strip"
+
+    with pytest.raises(ControlPointDeviceError):
+        light.open_door()
+
+    with pytest.raises(ControlPointDeviceError):
+        light.close_door()
+
+    light.turn_on()
+
+    light.turn_off()

zcc_helper-3.4/tests/test_device.py

@@ -0,0 +1,42 @@
+import unittest
+
+from zcc.device import ControlPointDevice
+
+
+class DeviceTest(unittest.TestCase):
+
+    identifier = 'test_device_id'
+
+    def test_init(self):
+        device = ControlPointDevice(None, DeviceTest.identifier)
+        self.assertEqual(device.controller, None)
+        self.assertEqual(device.identifier, DeviceTest.identifier)
+        self.assertEqual(device.actions, {})
+        self.assertEqual(device.properties, {})
+        self.assertEqual(device.states, {})
+
+    def test_add_action(self):
+        device = ControlPointDevice(None, DeviceTest.identifier)
+        device.actions = {'TurnOn': {'actionParams': {}},
+                          'TurnOff': {'actionParams': {}}}
+        print(device)
+        self.assertEqual(device.controller, None)
+        self.assertEqual(device.identifier, DeviceTest.identifier)
+
+    def test_add_properties(self):
+        device = ControlPointDevice(None, DeviceTest.identifier)
+        device.properties = {'name': 'Entry Pendant',
+                             'controlPointType': 'switch', 'roomId': 2, 'roomName': 'Front Door '}
+        self.assertEqual(device.controller, None)
+        self.assertEqual(device.identifier, DeviceTest.identifier)
+
+    def test_add_states(self):
+        device = ControlPointDevice(None, DeviceTest.identifier)
+        device.states = {'controlState': {
+            'switch': {...}}, 'isConnected': True}
+        self.assertEqual(device.controller, None)
+        self.assertEqual(device.identifier, DeviceTest.identifier)
+
+
+if __name__ == '__main__':
+    unittest.main()

zcc_helper-3.4/tests/test_server.py

@@ -0,0 +1,11 @@
+'''Setup Test Server.'''
+import pytest
+
+from zcc.controller import ControlPoint, ControlPointError
+from tests.server import TestServer
+
+
+@pytest.fixture
+def test_server():
+    '''Create (and delete) a Test Server'''
+    return TestServer()

zcc_helper-3.4/tests/test_socket.py

@@ -0,0 +1,52 @@
+import socket
+import pytest
+from unittest.mock import Mock
+from mockito import when, unstub
+
+from zcc.socket import ControlPointSocket
+
+TEST_HOST = '10.0.0.1'
+TEST_PORT = 4567
+TEST_TIMEOUT = 5
+
+
+@pytest.fixture
+def mock_tcp_socket():
+    mock_socket = Mock(spec=socket.socket)
+    return mock_socket
+
+
+def test_socket_create(mock_tcp_socket, when):
+
+    when(socket).socket(socket.AF_INET,
+                        socket.SOCK_STREAM)\
+        .thenReturn(mock_tcp_socket)
+
+    controller_socket = ControlPointSocket(TEST_HOST, TEST_PORT)
+
+    assert controller_socket.host == TEST_HOST
+    assert controller_socket.port == TEST_PORT
+    assert controller_socket.sock == mock_tcp_socket
+
+    controller_socket.close()
+    assert controller_socket.sock == None
+
+
+def test_socket_create_timeout(mock_tcp_socket, when):
+
+    when(socket).socket(socket.AF_INET,
+                        socket.SOCK_STREAM)\
+        .thenReturn(mock_tcp_socket)
+
+    controller_socket = ControlPointSocket(
+        TEST_HOST, TEST_PORT, timeout=TEST_TIMEOUT)
+
+    assert controller_socket.host == TEST_HOST
+    assert controller_socket.port == TEST_PORT
+    assert controller_socket.sock == mock_tcp_socket
+
+    assert mock_tcp_socket.settimeout.call_count == 1
+    assert mock_tcp_socket.settimeout.call_args.args == (TEST_TIMEOUT,)
+
+    controller_socket.close()
+    assert controller_socket.sock == None

{zcc_helper-3.3.1.dev2 → zcc_helper-3.4}/zcc/__init__.py

@@ -5,6 +5,10 @@ import sys
 from .controller import ControlPoint
 from .description import ControlPointDescription
 from .discovery import ControlPointDiscoveryService
-from .errors import ControlPointError
+from .errors import ( ControlPointError,
+                     ControlPointConnectionRefusedError,
+                     ControlPointCannotConnectError,
+                     ControlPointInvalidHostError,
+                     ControlPointTimeoutError)
 
 logging.basicConfig(stream=sys.stderr)

{zcc_helper-3.3.1.dev2 → zcc_helper-3.4}/zcc/__main__.py

@@ -52,6 +52,9 @@ def __options(args):
     cxg.add_argument(
         "--execute", action="store_true", help="execute an action on a device"
     )
+    cxg.add_argument(
+        "--test-connection", action="store_true", help="test the connection to a device"
+    )
 
     host_group = parser.add_argument_group("host")
     host_group.add_argument("--host", action="store", help="zcc host name|address")
@@ -96,6 +99,13 @@ async def main(args):
         await ControlPointDiscoveryService(verbosity=options.verbosity).discover()
         return
 
+    if options.test_connection and options.host and options.port:
+        result = await ControlPointDiscoveryService(
+            verbosity=options.verbosity
+        ).validate_connection(host=options.host, port=options.port)
+        print(result)
+        return
+
     if options.host and options.port:
         description = ControlPointDescription(host=options.host, port=options.port)
     else:

{zcc_helper-3.3.1.dev2 → zcc_helper-3.4}/zcc/constants.py

@@ -9,4 +9,4 @@ APP_ID = "ZvWqWJQB"
 APP_TOKEN = "3422ecbb-cf6a-404c-b3dc-2023dd213535"
 
 NAME = "zcc_helper"
-VERSION = "3.3.1-dev2"
+VERSION = "3.4"

{zcc_helper-3.3.1.dev2 → zcc_helper-3.4}/zcc/controller.py

@@ -313,9 +313,13 @@ class ControlPoint:
         """Get initial control point data from controller."""
 
         self.manufacture_info_ready = self.loop.create_future()
+        self.manufacture_info_received = 0
         self.properties_ready = self.loop.create_future()
+        self.properties_received = 0
         self.actions_ready = self.loop.create_future()
+        self.actions_received = 0
         self.states_ready = self.loop.create_future()
+        self.states_received = 0
 
         self.logger.debug("Getting manufacture_info")
         await self.socket.sendall(
@@ -332,7 +336,7 @@ class ControlPoint:
                 "ZCC connection failed - didn't receive manufacture_info."
             ) from error
 
-        await asyncio.sleep(ControlPointProtocol.DEVICE_GET_TIMEOUT)
+        await asyncio.sleep(ControlPointProtocol.STEP_TIMEOUT)
 
         self.logger.debug("Getting initial device properties")
         await self.socket.sendall(
@@ -348,7 +352,7 @@ class ControlPoint:
                 "ZCC connection failed - didn't receive any properties."
             ) from error
 
-        await asyncio.sleep(ControlPointProtocol.DEVICE_GET_TIMEOUT)
+        await asyncio.sleep(ControlPointProtocol.STEP_TIMEOUT)
 
         self.logger.debug("Getting initial device actions")
         await self.socket.sendall(
@@ -364,7 +368,7 @@ class ControlPoint:
                 "ZCC connection failed - didn't receive any actions."
             ) from error
 
-        await asyncio.sleep(ControlPointProtocol.DEVICE_GET_TIMEOUT)
+        await asyncio.sleep(ControlPointProtocol.STEP_TIMEOUT)
 
         self.logger.debug("Getting initial device states")
         await self.socket.sendall(
@@ -380,7 +384,7 @@ class ControlPoint:
                 "ZCC connection failed - didn't receive any states."
             ) from error
 
-        await asyncio.sleep(ControlPointProtocol.DEVICE_GET_TIMEOUT)
+        await asyncio.sleep(ControlPointProtocol.STEP_TIMEOUT)
 
         for key in self.devices.keys():
             identifier_msb = self.devices[key].identifier.split("_")[0]

{zcc_helper-3.3.1.dev2 → zcc_helper-3.4}/zcc/discovery.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 import asyncio
+from enum import StrEnum
 import json
 from json.decoder import JSONDecodeError
 import logging
@@ -10,11 +11,15 @@ import socket
 from typing import Tuple
 
 from zcc.constants import LEVEL_BY_VERBOSITY
+from zcc.controller import ControlPoint
 from zcc.description import ControlPointDescription
-from zcc.errors import ControlPointError
+from zcc.errors import ( ControlPointError,
+                     ControlPointConnectionRefusedError,
+                     ControlPointCannotConnectError,
+                     ControlPointInvalidHostError,
+                     ControlPointTimeoutError)
 from zcc.protocol import ControlPointProtocol
 
-
 class ControlPointDiscoveryProtocol(asyncio.DatagramProtocol):
     """Listens for ZCC announcements on the defined UDP port."""
 
@@ -76,6 +81,7 @@ class ControlPointDiscoveryService:
         self.discovery_complete = self.loop.create_future()
         self.discovery_result: list[ControlPointDescription] = []
         self.never_completes = self.loop.create_future()
+        self.validation_result: ControlPointDescription
 
     async def discover(
         self, wait_for_all: bool = False
@@ -135,3 +141,51 @@ class ControlPointDiscoveryService:
     async def discovers(self) -> list[ControlPointDescription]:
         """Discover all local zimi controllers."""
         return await self.discover(wait_for_all=True)
+
+    async def validate_connection(
+        self, host: str, port: int
+    ) -> ControlPointDescription:
+        """Validate ability to connect and close a connection.
+
+        Returns ControlPointDescription if OK.
+        """
+
+        try:
+            socket.gethostbyname(host)
+            s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+            s.settimeout(10)
+            try:
+                s.connect((host, port))
+                s.close()
+            except ConnectionRefusedError as e:
+                raise ControlPointConnectionRefusedError() from e
+            except TimeoutError as e:
+                raise ControlPointTimeoutError() from e
+            except socket.gaierror as e:
+                raise ControlPointCannotConnectError() from e
+        except socket.gaierror as e:
+            raise ControlPointInvalidHostError() from e
+
+        api = ControlPoint(ControlPointDescription(host=host, port=port))
+
+        try:
+            await api.connect(fast=True)
+        except ControlPointError as e:
+            raise ControlPointCannotConnectError() from e
+
+        self.validation_result = ControlPointDescription(
+            brand=api.brand,
+            product=api.product,
+            host=host,
+            port=port,
+            mac=api.mac,
+            available_tcps=api.available_tcps,
+            api_version=api.api_version,
+            firmware_version=api.firmware_version
+        )
+
+        api.disconnect()
+        
+        self.logger.info(self.validation_result)
+
+        return self.validation_result

zcc_helper-3.4/zcc/errors.py

@@ -0,0 +1,16 @@
+'''ControlPoint error class'''
+
+
+class ControlPointError(Exception):
+    '''Represents a ZCC controller error.'''
+
+class ControlPointCannotConnectError(ControlPointError):
+    '''Represents a connect connect error when connecting to zcc.'''
+    
+class ControlPointInvalidHostError(ControlPointError):
+    '''Represents an invalid host error when connecting to zcc.'''
+class ControlPointConnectionRefusedError(ControlPointError):
+    '''Represents a connection refused when connecting to zcc.'''
+
+class ControlPointTimeoutError(ControlPointError):
+    '''Represents a connection timeout when connecting to zcc.'''

{zcc_helper-3.3.1.dev2 → zcc_helper-3.4}/zcc/protocol.py

@@ -23,9 +23,11 @@ class ControlPointProtocol:
     CONTROLPOINT_STATES_EVENTS = "controlpoint_states_events"
     ZCC_STATUS = "zcc_status"
 
-    SUBSCRIBE_TIMEOUT = 5
+    SUBSCRIBE_TIMEOUT = 2
     GATEWAY_PROPERTIES = "gateway_properties"
-    GATEWAY_PROPERTIES_TIMOUT = 10
+    GATEWAY_PROPERTIES_TIMEOUT = 10
+
+    STEP_TIMEOUT = 0
 
     RETRY_TIMEOUT = 90
 

{zcc_helper-3.3.1.dev2 → zcc_helper-3.4}/zcc_helper.egg-info/PKG-INFO

@@ -1,16 +1,23 @@
-Metadata-Version: 2.1
-Name: zcc-helper
-Version: 3.3.1.dev2
+Metadata-Version: 2.4
+Name: zcc_helper
+Version: 3.4
 Summary: ZIMI ZCC helper module
-Home-page: UNKNOWN
 Author: Mark Hannon
 Author-email: mark.hannon@gmail.com
 License: MIT
 Project-URL: Source, https://bitbucket.org/mark_hannon/zcc
-Platform: UNKNOWN
-Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: summary
 
 # ZCC-HELPER
 
@@ -274,5 +281,3 @@ python -m zcc --execute --device 'bddf0500-4d15-4457-b063-c12ed208a0b0_3' --acti
 ```
 
 This version of the command is relatively slow as it first of all discovers the ZCC on the local LAN, builds a device inventory and then executes the action.
-
-

{zcc_helper-3.3.1.dev2 → zcc_helper-3.4}/zcc_helper.egg-info/SOURCES.txt

@@ -2,6 +2,10 @@ LICENSE.txt
 README.md
 setup.py
 zcc.py
+tests/test_controller.py
+tests/test_device.py
+tests/test_server.py
+tests/test_socket.py
 zcc/__init__.py
 zcc/__main__.py
 zcc/constants.py

zcc_helper-3.3.1.dev2/zcc/errors.py

@@ -1,5 +0,0 @@
-'''ControlPoint error class'''
-
-
-class ControlPointError(Exception):
-    '''Represents a ZCC controller error.'''