0.9.1 Release

Author: Adminiuga

README.md

@@ -9,6 +9,28 @@ The goal of this project to add native support for the Dresden-Elektronik deCONZ
 
 This library uses the deCONZ serial protocol for communicating with [ConBee](https://www.dresden-elektronik.de/conbee/), [ConBee II (ConBee 2)](https://shop.dresden-elektronik.de/conbee-2.html), and [RaspBee](https://www.dresden-elektronik.de/raspbee/) adapters from [Dresden-Elektronik](https://github.com/dresden-elektronik/).
 
+# Testing new releases
+
+Testing a new release of the zigpy-deconz library before it is released in Home Assistant.
+
+If you are using Supervised Home Assistant (formerly known as the Hassio/Hass.io distro):
+- Add https://github.com/home-assistant/hassio-addons-development as "add-on" repository
+- Install "Custom deps deployment" addon
+- Update config like: 
+  ```
+  pypi:
+    - zigpy-deconz==0.9.0
+  apk: []
+  ```
+  where 0.5.1 is the new version
+- Start the addon
+
+If you are instead using some custom python installation of Home Assistant then do this:
+- Activate your python virtual env
+- Update package with ``pip``
+  ```
+  pip install zigpy-deconz==0.9.0
+
 # Releases via PyPI
 Tagged versions are also released via PyPI
 

tests/test_api.py

@@ -14,7 +14,7 @@
 
 
 @pytest.fixture
-def api():
+def api(event_loop):
     controller = mock.MagicMock(
         spec_set=zigpy_deconz.zigbee.application.ControllerApplication
     )
@@ -82,6 +82,26 @@ async def mock_fut():
         api._uart.send.reset_mock()
 
 
+@pytest.mark.asyncio
+async def test_command_queue(api, monkeypatch):
+    def mock_api_frame(name, *args):
+        return mock.sentinel.api_frame_data, api._seq
+
+    api._api_frame = mock.MagicMock(side_effect=mock_api_frame)
+    api._uart.send = mock.MagicMock()
+
+    monkeypatch.setattr(deconz_api, "COMMAND_TIMEOUT", 0.1)
+
+    for cmd, cmd_opts in deconz_api.TX_COMMANDS.items():
+        async with api._command_lock:
+            with pytest.raises(asyncio.TimeoutError):
+                await asyncio.wait_for(api._command(cmd, mock.sentinel.cmd_data), 0.1)
+        assert api._api_frame.call_count == 0
+        assert api._uart.send.call_count == 0
+        api._api_frame.reset_mock()
+        api._uart.send.reset_mock()
+
+
 @pytest.mark.asyncio
 async def test_command_timeout(api, monkeypatch):
     def mock_api_frame(name, *args):

tests/test_application.py

@@ -15,10 +15,15 @@
 
 
 @pytest.fixture
-def app(database_file=None):
+def device_path():
+    return "/dev/null"
+
+
+@pytest.fixture
+def app(device_path, database_file=None):
     config = application.ControllerApplication.SCHEMA(
         {
-            zigpy.config.CONF_DEVICE: {zigpy.config.CONF_DEVICE_PATH: "/dev/null"},
+            zigpy.config.CONF_DEVICE: {zigpy.config.CONF_DEVICE_PATH: device_path},
             zigpy.config.CONF_DATABASE: database_file,
         }
     )
@@ -215,7 +220,7 @@ async def _version():
     api.version = mock.MagicMock(side_effect=_version)
     api.write_parameter = CoroutineMock()
 
-    monkeypatch.setattr(application.ConBeeDevice, "new", CoroutineMock())
+    monkeypatch.setattr(application.DeconzDevice, "new", CoroutineMock())
     with mock.patch.object(application, "Deconz", return_value=api):
         await app.startup(auto_form=False)
         assert app.form_network.call_count == 0
@@ -393,19 +398,19 @@ def test_rx_device_annce(app, addr_ieee, addr_nwk):
 
 
 @pytest.mark.asyncio
-async def test_conbee_dev_add_to_group(app, nwk):
+async def test_deconz_dev_add_to_group(app, nwk, device_path):
     group = mock.MagicMock()
     app._groups = mock.MagicMock()
     app._groups.add_group.return_value = group
 
-    conbee = application.ConBeeDevice(app, mock.sentinel.ieee, nwk)
-    conbee.endpoints = {
+    deconz = application.DeconzDevice(0, device_path, app, mock.sentinel.ieee, nwk)
+    deconz.endpoints = {
         0: mock.sentinel.zdo,
         1: mock.sentinel.ep1,
         2: mock.sentinel.ep2,
     }
 
-    await conbee.add_to_group(mock.sentinel.grp_id, mock.sentinel.grp_name)
+    await deconz.add_to_group(mock.sentinel.grp_id, mock.sentinel.grp_name)
     assert group.add_member.call_count == 2
 
     assert app.groups.add_group.call_count == 1
@@ -414,33 +419,53 @@ async def test_conbee_dev_add_to_group(app, nwk):
 
 
 @pytest.mark.asyncio
-async def test_conbee_dev_remove_from_group(app, nwk):
+async def test_deconz_dev_remove_from_group(app, nwk, device_path):
     group = mock.MagicMock()
     app.groups[mock.sentinel.grp_id] = group
-    conbee = application.ConBeeDevice(app, mock.sentinel.ieee, nwk)
-    conbee.endpoints = {
+    deconz = application.DeconzDevice(0, device_path, app, mock.sentinel.ieee, nwk)
+    deconz.endpoints = {
         0: mock.sentinel.zdo,
         1: mock.sentinel.ep1,
         2: mock.sentinel.ep2,
     }
 
-    await conbee.remove_from_group(mock.sentinel.grp_id)
+    await deconz.remove_from_group(mock.sentinel.grp_id)
     assert group.remove_member.call_count == 2
 
 
-def test_conbee_props(nwk):
-    conbee = application.ConBeeDevice(app, mock.sentinel.ieee, nwk)
-    assert conbee.manufacturer is not None
-    assert conbee.model is not None
+def test_deconz_props(nwk, device_path):
+    deconz = application.DeconzDevice(0, device_path, app, mock.sentinel.ieee, nwk)
+    assert deconz.manufacturer is not None
+    assert deconz.model is not None
+
+
+@pytest.mark.parametrize(
+    "name, firmware_version, device_path",
+    [
+        ("ConBee", 0x00000500, "/dev/ttyUSB0"),
+        ("ConBee II", 0x00000700, "/dev/ttyUSB0"),
+        ("RaspBee", 0x00000500, "/dev/ttyS0"),
+        ("RaspBee II", 0x00000700, "/dev/ttyS0"),
+        ("RaspBee", 0x00000500, "/dev/ttyAMA0"),
+        ("RaspBee II", 0x00000700, "/dev/ttyAMA0"),
+    ],
+)
+def test_deconz_name(nwk, name, firmware_version, device_path):
+    deconz = application.DeconzDevice(
+        firmware_version, device_path, app, mock.sentinel.ieee, nwk
+    )
+    assert deconz.model == name
 
 
 @pytest.mark.asyncio
-async def test_conbee_new(app, nwk, monkeypatch):
+async def test_deconz_new(app, nwk, device_path, monkeypatch):
     mock_init = mock.MagicMock(side_effect=asyncio.coroutine(mock.MagicMock()))
     monkeypatch.setattr(zigpy.device.Device, "_initialize", mock_init)
 
-    conbee = await application.ConBeeDevice.new(app, mock.sentinel.ieee, nwk)
-    assert isinstance(conbee, application.ConBeeDevice)
+    deconz = await application.DeconzDevice.new(
+        app, mock.sentinel.ieee, nwk, 0, device_path
+    )
+    assert isinstance(deconz, application.DeconzDevice)
     assert mock_init.call_count == 1
     mock_init.reset_mock()
 
@@ -451,8 +476,10 @@ async def test_conbee_new(app, nwk, monkeypatch):
         22: mock.MagicMock(),
     }
     app.devices[mock.sentinel.ieee] = mock_dev
-    conbee = await application.ConBeeDevice.new(app, mock.sentinel.ieee, nwk)
-    assert isinstance(conbee, application.ConBeeDevice)
+    deconz = await application.DeconzDevice.new(
+        app, mock.sentinel.ieee, nwk, 0, device_path
+    )
+    assert isinstance(deconz, application.DeconzDevice)
     assert mock_init.call_count == 0
 
 

zigpy_deconz/__init__.py

@@ -1,6 +1,6 @@
 # coding: utf-8
 MAJOR_VERSION = 0
 MINOR_VERSION = 9
-PATCH_VERSION = "0"
+PATCH_VERSION = "1"
 __short_version__ = "{}.{}".format(MAJOR_VERSION, MINOR_VERSION)
 __version__ = "{}.{}".format(__short_version__, PATCH_VERSION)

zigpy_deconz/api.py

@@ -14,8 +14,8 @@
 
 LOGGER = logging.getLogger(__name__)
 
-COMMAND_TIMEOUT = 2
-PROBE_TIMEOUT = 3
+COMMAND_TIMEOUT = 1
+PROBE_TIMEOUT = 2
 MIN_PROTO_VERSION = 0x010B
 
 
@@ -204,6 +204,7 @@ def __init__(self, app: Callable, device_config: Dict[str, Any]):
         self._app = app
         self._aps_data_ind_flags: int = 0x01
         self._awaiting = {}
+        self._command_lock = asyncio.Lock()
         self._config = device_config
         self._conn_lost_task: Optional[asyncio.Task] = None
         self._data_indication: bool = False
@@ -275,20 +276,23 @@ def close(self):
             self._uart = None
 
     async def _command(self, cmd, *args):
-        LOGGER.debug("Command %s %s", cmd, args)
         if self._uart is None:
             # connection was lost
             raise CommandError(Status.ERROR, "API is not running")
-        data, seq = self._api_frame(cmd, *args)
-        self._uart.send(data)
-        fut = asyncio.Future()
-        self._awaiting[seq] = fut
-        try:
-            return await asyncio.wait_for(fut, timeout=COMMAND_TIMEOUT)
-        except asyncio.TimeoutError:
-            LOGGER.warning("No response to '%s' command", cmd)
-            self._awaiting.pop(seq)
-            raise
+        async with self._command_lock:
+            LOGGER.debug("Command %s %s", cmd, args)
+            data, seq = self._api_frame(cmd, *args)
+            self._uart.send(data)
+            fut = asyncio.Future()
+            self._awaiting[seq] = fut
+            try:
+                return await asyncio.wait_for(fut, timeout=COMMAND_TIMEOUT)
+            except asyncio.TimeoutError:
+                LOGGER.warning(
+                    "No response to '%s' command with seq id '0x%02x'", cmd, seq
+                )
+                self._awaiting.pop(seq)
+                raise
 
     def _api_frame(self, cmd, *args):
         schema = TX_COMMANDS[cmd]

zigpy_deconz/config.py

@@ -3,6 +3,7 @@
     CONF_DEVICE,
     CONF_DEVICE_PATH,
     CONFIG_SCHEMA,
+    SCHEMA_DEVICE,
 )
 
 CONF_WATCHDOG_TTL = "watchdog_ttl"

zigpy_deconz/zigbee/application.py

@@ -1,6 +1,7 @@
 import asyncio
 import binascii
 import logging
+import re
 from typing import Any, Dict
 
 import zigpy.application
@@ -13,7 +14,7 @@
 
 from zigpy_deconz import types as t
 from zigpy_deconz.api import Deconz, NetworkParameter, NetworkState, Status
-from zigpy_deconz.config import CONF_WATCHDOG_TTL, CONFIG_SCHEMA
+from zigpy_deconz.config import CONF_WATCHDOG_TTL, CONFIG_SCHEMA, SCHEMA_DEVICE
 import zigpy_deconz.exception
 
 LOGGER = logging.getLogger(__name__)
@@ -26,6 +27,9 @@
 
 class ControllerApplication(zigpy.application.ControllerApplication):
     SCHEMA = CONFIG_SCHEMA
+    SCHEMA_DEVICE = SCHEMA_DEVICE
+
+    probe = Deconz.probe
 
     def __init__(self, config: Dict[str, Any]):
         super().__init__(config=zigpy.config.ZIGPY_SCHEMA(config))
@@ -73,7 +77,13 @@ async def startup(self, auto_form=False):
 
         if auto_form:
             await self.form_network()
-        self.devices[self.ieee] = await ConBeeDevice.new(self, self.ieee, self.nwk)
+        self.devices[self.ieee] = await DeconzDevice.new(
+            self,
+            self.ieee,
+            self.nwk,
+            self.version,
+            self._config[zigpy.config.CONF_DEVICE][zigpy.config.CONF_DEVICE_PATH],
+        )
 
     async def force_remove(self, dev):
         """Forcibly remove device from NCP."""
@@ -281,9 +291,15 @@ def handle_tx_confirm(self, req_id, status):
             )
 
 
-class ConBeeDevice(zigpy.device.Device):
+class DeconzDevice(zigpy.device.Device):
     """Zigpy Device representing Coordinator."""
 
+    def __init__(self, version: int, device_path: str, *args):
+        super().__init__(*args)
+        is_gpio_device = re.match(r"/dev/tty(S|AMA)\d+", device_path)
+        self._model = "RaspBee" if is_gpio_device else "ConBee"
+        self._model += " II" if ((version & 0x0000FF00) == 0x00000700) else ""
+
     async def add_to_group(self, grp_id: int, name: str = None) -> None:
         group = self.application.groups.add_group(grp_id, name)
 
@@ -306,12 +322,12 @@ def manufacturer(self):
 
     @property
     def model(self):
-        return "ConBee"
+        return self._model
 
     @classmethod
-    async def new(cls, application, ieee, nwk):
+    async def new(cls, application, ieee, nwk, version: int, device_path: str):
         """Create or replace zigpy device."""
-        dev = cls(application, ieee, nwk)
+        dev = cls(version, device_path, application, ieee, nwk)
 
         if ieee in application.devices:
             from_dev = application.get_device(ieee=ieee)