Does deCONZ serial protocol for ConBee/RaspBee Zigbee Coordinator adapters not support joining/pairing via install code and qr code? #20

Hedda · 2023-02-12T16:40:06Z

@manup Reposting from zigpy/zigpy-deconz#214 and Koenkk/zigbee2mqtt#17492 as a public request to you dresden-elektronik's deCONZ (ConBee) developers because the developers of zigpy (used by Home Assistant's ZHA integration + Zigbee plugins for Domoticz and Jeedom) and zigbee-herdsman (Zigbee2MQTT + IoBroker) replied there that this function is not supported in zigpy-deconz or zigbee-herdsman since the function for install code (and qr code) is not a documented in the linked deCONZ serial protocol documentation:

https://github.com/dresden-elektronik/deconz-serial-protocol/blob/master/README.md

UPDATE: The exact same issue also applies to Zigbee2MQTT (Z2M) and IoBroker (which are both based on zigbee-herdsman):

Koenkk/zigbee2mqtt#17492

It started with one user of Home Assistant’s ZHA integration with an ConBee Zigbee Coordinator adapter posted that they could not join/pair a Zigbee 3.0 (ZB3) device that required an "install code", and then some other user replied to that post saying "install code" (and "qr code"?) support is not implemented in the zigpy-deconz radio library for zigpy which the ZHA integration depends on. Is that true?

https://github.com/zigpy/zigpy-deconz/blob/80041b9dbf334e0224b95081fcd49bb2da3e8c5d/zigpy_deconz/zigbee/application.py#L108

For reference that specific Zigbee 3.0 device that require install code to join was the "Bosch Thermostat 2":

https://community.home-assistant.io/t/bosch-thermostat-2/492845/

ZHA (and zigpy) can set an Install Code for Zigbee 3.0 devices if using Silicon Labs EmberZNet or Texas Instruments Z-Stack ZNP:

https://www.home-assistant.io/integrations/zha#services

https://www.silabs.com/documents/public/application-notes/an1089-using-installation-codes-with-zigbee-devices.pdf

https://wiki.st.com/stm32mcu/wiki/Connectivity:Zigbee_Install_Code

Just reposting this issue reported in the Home Assistant community forum:

https://community.home-assistant.io/t/bosch-thermostat-2/492845/10

https://community.home-assistant.io/t/bosch-thermostat-2/492845/11

The first device in question was the Bosch Thermostat II 230 V (BTH-RA / BTH-RM230Z), however, I understand that some people using deCONZ or Zigbee2MQTT have reported the same issue with a few other Bosch-branded Zigbee devices, like Bosch Smoke Alarm II (BSD-2), Bosch Door/window contact II (RBSH-SWD-ZB), and Bosch BWA-1 water sensor, all of which require adding the install code to pair/join. Another device that been mentioned to require install code is the rotary switch Aqara H1 -> Koenkk/zigbee-herdsman#420

PS: I do not have a ConBee/RaspBee Zigbee Coordinator setup myself any longer so can not replicate it to confirm or disconfirm this but think that it would be a good idea if this could be tracked as a feature request because the function is missing the deconz serial protocol documentation and for deconz firmware based Zigbee Coordinator adapters like ConBee/RaspBee but supported by other Zigbee Coordinator adapters like Silicon Labs and Texas Instruments based Zigbee Coordinator adapters via their respective radio library for zigpy.

martgras · 2023-02-13T09:43:33Z

I think that you have to set the network parameter 'Link Key' at 0x19
(page 12). However I don't have a Conbee Adapter to test it out

puddly · 2023-02-13T17:25:25Z

Unfortunately, Link Key (0x19) is the Trust Center Link Key, which is always ZigBeeAlliance09. There needs to be a specific API to add a link key for a specific IEEE address, to replace the well-known key during transport key exchange.

Hedda · 2023-02-15T11:12:33Z

@ChrisHae Can you tell if deconz adapter/driver in zigbee-herdsman (used by Zigbee2MQTT and IoBroker) supports install codes?

https://github.com/Koenkk/zigbee-herdsman

https://github.com/Koenkk/zigbee-herdsman/tree/master/src/adapter/deconz

martgras · 2023-02-15T12:10:05Z

No same problem in z2m
https://github.com/Koenkk/zigbee-herdsman/blob/master/src/adapter/deconz/adapter/deconzAdapter.ts#L187

ChrisHae · 2023-02-15T15:59:50Z

The Conbee2 fw does not support it yet. But it will come soon. And then it will also be implemented in zigbee herdsman deconz adapter.

Hedda · 2023-02-16T11:07:06Z

The Conbee2 fw does not support it yet. But it will come soon. And then it will also be implemented in zigbee herdsman deconz adapter.

Great to hear! If possible please update the documentation then also ping the zigpy developers too -> zigpy/zigpy-deconz#214

xam-ps · 2023-03-17T20:46:20Z

Any news on this? Unfortunately the Bosch Thermostat 2 only supports pairing via install code :/

pdsccode · 2023-05-07T16:20:54Z

Bumping here. Still waiting for the support of pairing via install code to get my devices up and running. Any info on the current state?

xam-ps · 2023-05-08T20:46:41Z

@pdsccode
It seems like it's included in the latest version: https://github.com/dresden-elektronik/deconz-rest-plugin/releases/tag/v2.22.0-beta
But it's still in Beta-Status. Waiting for the version to be finally released.

pdsccode · 2023-05-08T20:57:59Z

@xam-ps
Thanks for the info. Didn't see that obviously 😂

Hedda · 2023-05-09T11:12:50Z

Can anyone confirm or disconfirm if Zigbee install code support is enabled in the current or latest ConBee/RaspBee firmware?

dresden-elektronik/deconz-rest-plugin#6791

dresden-elektronik/deconz-rest-plugin@24c7ff9

https://github.com/dresden-elektronik/deconz-rest-plugin/releases/tag/v2.22.0-beta

If and when it has can you then please also update the deconz-serial-protocol documentation to include all the commands for it?

Developers of Home Assistant's ZHA integration and Zigbee2MQTT need it to implement it in zigpy-deconz and zigbee-herdsman:

zigpy/zigpy-deconz#214

Koenkk/zigbee2mqtt#17492

SwoopX · 2023-05-09T20:11:59Z

What makes you think this has anything to do with the device firmware? You can see all the necessary changes to make the install codes work from the referenced PR. To my knowledge, last changes involving the firmware were about a year ago or so and none of the change log entries reference install codes.

Generally, I cannot comment on the serial protocol, since I have no clue about it.

Hedda · 2023-05-10T18:08:29Z

So you are saying all that is missing is the documentation for the deconz serial protocol?

What makes you think this has anything to do with the device firmware?

That is what ChisHae wrote above:

Originally posted by @ChrisHae in #20 (comment)

The Conbee2 fw does not support it yet. But it will come soon. And then it will also be implemented in zigbee herdsman deconz adapter.

Again, this interface information is needed in the deconz serial protocol documentation in order zigpy and zigbee-herdsman for third parties to be able to communicate with the Zigbee devices via ConBee/RaspBee as Zigbee Coordinator adapters:

https://github.com/dresden-elektronik/deconz-serial-protocol/blob/master/README.md

zigpy is for example used by Home Assistant's ZHA integration, the Zigbee Plugin for Domoticz, and Zigbee Plugin for Jeedom.

https://github.com/zigpy/zigpy (see zigpy-deconz feature request -> zigpy/zigpy-deconz#214 )

zigbee-herdsman is for example used by Zigbee2MQTT and IoBroker:

https://github.com/Koenkk/zigbee-herdsman (see Zigbee2MQTT feature request -> Koenkk/zigbee2mqtt#17492 )

SwoopX · 2023-05-10T22:45:25Z

So you are saying all that is missing is the documentation for the deconz serial protocol?

I more or less said the exact opposite: I don't know anything about the deconz serial protocol. Please read my previous reply again.

Other than that, I also cannot comment if for other software any changes on the firmware might be necessary. For deconz itself, the PR documents the necessary changes to make it work. Nothing more, nothing less 🙂

puddly · 2023-05-11T18:27:35Z

We don't use the binary deCONZ library in ZHA or Z2M though and we instead directly interact with the coordinator over the documented serial protocol. The deCONZ object is a higher-level API so while this code is straightforward:

#if DECONZ_LIB_VERSION >= 0x010B00
            QVariantMap m;
            m["mac"] = uniqueid.toULongLong(&ok, 16);
            m["key"] = mmoHash;
            if (ok && mmoHash.size() == 32)
            {
                ok = deCONZ::ApsController::instance()->setParameter(deCONZ::ParamLinkKey, m);
            }
#endif

Writing the hashed link key and a joining device's IEEE address to this specific parameter and then permitting joins still results in the Conbee sending the network key as usual for me. So unless I'm making some simple mistake somewhere, there may be something else happening in the background within the library or a specific sequence in which this parameter write needs to be sent when permitting joins.

Various questions:

Does this command need to be sent before permitting joins? After?
How do you clear a link key? If you can't, is it cleared automatically after the join window closes? How many can you write at once?
What firmware version was this feature introduced in?

And while I could spend the time to reverse engineer deCONZ by intercepting traffic between it and the Conbee, it's a lot nicer to not have to do this.

manup · 2023-05-11T19:35:04Z

Hi, the MAC + derived Link Key is indeed what is used also on the serial protocol side.

The firmware doesn't know anything about Install Codes itself and the Link Key is derived as shown in above PR. Formerly this was done with a command line tool from the Zigbee Alliance but this was meh.

The Link Key parameter 0x19 is in the firmware since a long time, also for ConBee I, where we did our initial tests for a student diploma with various real devices. Here we also found that Install Codes sometimes are invalid/non standard, e.g. byte order of the checksum was wrong.

But I'd like to put a big warning on using the 0x19 parameter yet, while it does work it could also make the configuration in the firmware messy, e.g. after setting it classical joining of devices might not work any longer until the trust center MAC address + link key is set again. Fixing this is on the bucket list but doesn't have a high priority currently, since there are too many other pressing things on the todo list.

Hedda · 2023-09-04T12:34:09Z

Any updates on this? ...AFAIK, install code is still not supported for ConBee in Home Assistant's ZHA integration or Zigbee2MQTT?

zigpy/zigpy-deconz#214

Koenkk/zigbee2mqtt#17492

Support for commissioning Zigbee 3.0 devices via “Install Code” or “QR Code” via the ‘zha.permit’ service has so far only been implemented for ‘ezsp’ (Silicon Labs EmberZNet) or ‘znp’ (Texas Instruments Z-Stack) radio type adapters in the ZHA integration in Home Assistant (that depends on zigpy-deconz) and Zigbee2MQTT (that depends zigbee-herdsman) . Other radio types are missing support in their respective radio libraries for zigpy or manufacturer’s firmware commands/APIs.

https://www.home-assistant.io/integrations/zha#limitations

Hedda · 2023-10-13T14:29:23Z

So you are saying all that is missing is the documentation for the deconz serial protocol?

I more or less said the exact opposite: I don't know anything about the deconz serial protocol.

Mixed signals(?); as according to @ChrisHae support for using install code is not yet implemented in the deconz serial protocol:

Originally posted by @ChrisHae in Koenkk/zigbee2mqtt#17492 (comment)

It is not yet implemented in the serial protocol. When it is, it can be added to z2mqtt deconz adapter.

Again, deconz firmware for ConBee and RaspBee does not yet seem to implement Zigbee install code support in the deconz serial protocol and therefore ConBee/RaspBee does not currently offer feature-partity with with serial protocols for Texas Instruments Z-Stack and Silicon Labs EmberZNet for Zigbee Gateway host applications such as the ZHA integration in Home Assistant (which is turn depends on the zigpy and zigpy-deconz libraries) and Zigbee2MQTT (which in turn depends on zigbee-herdsman).

Any updates or news on this from dresden-elektronik's developers?

Can you assist with getting Zigbee install code support working in ZHA (zigpy-deconz) and Zigbee2MQTT(zigbee-herdsman)? See:

zigpy/zigpy-deconz#214

and

Koenkk/zigbee2mqtt#17492

pixartist · 2023-10-19T12:10:53Z

Can we get an update on this?

Pioneer42m · 2023-11-18T17:06:02Z

I would be also very happy this there was a solution for this. Thank you in advance!

lerra · 2023-12-13T07:30:55Z

Any update on this?

finkerle · 2023-12-24T10:57:58Z

Hi, any updates on this?

Hedda · 2024-03-28T10:06:13Z

Any updates of deCONZ Serial Protocol documentation to be able to support "install code" for ConBee III (ConBee 3) adapter?

https://phoscon.de/en/conbee3

As it stands, deconz "install code" and "qr code" support is not available in Home Assistant's ZHA integration of Zigbee2MQTT:

zigpy/zigpy-deconz#214

Koenkk/zigbee2mqtt#17492

PS: Still listed as a deconz serial protocol related limitation under ZHA docs and until then any ConBee cannot be recommended:

https://www.home-assistant.io/integrations/zha#limitations

"Support for commissioning Zigbee 3.0 devices via “Install Code” or “QR Code” via the ‘zha.permit’ service has so far only been implemented for ‘ezsp’ (Silicon Labs EmberZNet) or ‘znp’ (Texas Instruments) radio type in ZHA. Other radio types are missing support in their respective radio libraries for zigpy or manufacturer’s firmware commands/APIs."

hksthff · 2024-03-28T10:24:51Z

I tested yesterday with Conbee 3 and ZHA without success.

File "/usr/src/homeassistant/homeassistant/helpers/service.py", line 1006, in _async_admin_handler await result File "/usr/src/homeassistant/homeassistant/components/zha/websocket_api.py", line 1257, in permit await application_controller.permit_with_link_key( File "/usr/local/lib/python3.12/site-packages/zigpy_deconz/zigbee/application.py", line 115, in permit_with_link_key await self._api.write_parameter( File "/usr/local/lib/python3.12/site-packages/zigpy_deconz/api.py", line 849, in write_parameter await self.send_command( File "/usr/local/lib/python3.12/site-packages/zigpy_deconz/api.py", line 508, in send_command return await self._command(cmd, **kwargs) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/usr/local/lib/python3.12/site-packages/zigpy_deconz/api.py", line 589, in _command return await fut ^^^^^^^^^ zigpy_deconz.exception.CommandError: <CommandId.write_parameter: 11>, status: <Status.UNSUPPORTED: 4>

Hedda · 2024-03-28T11:22:52Z

I tested yesterday with Conbee 3 and ZHA without success.

Even if was supported in ConBee 3 firmware it would still have to be implemented in zigpy-deconz -> zigpy/zigpy-deconz#214

And that is not possible until deconz serial protocol documentation is updated to include info about "install code" + "qr code".

Hedda mentioned this issue Feb 12, 2023

zigpy-deconz (ConBee/RaspBee adapter) and ZHA support for joining/pairing via install code and qr code? zigpy/zigpy-deconz#214

Open

Hedda mentioned this issue Feb 16, 2023

deconz adapter/driver does not support backup and restore for ConBee/RaspBee by dresden elektronik? Koenkk/zigbee-herdsman#665

Open

Hedda mentioned this issue May 9, 2023

Conbee II: Add install code is not supported Koenkk/zigbee2mqtt#17492

Open

Hedda mentioned this issue Sep 4, 2023

[Device Support Request] Bosch Twinguard zigpy/zha-device-handlers#2561

Open

Hedda mentioned this issue Mar 11, 2024

Add ConBee 3 and move ConBee/RaspBee 2 to not recommended home-assistant/home-assistant.io#31839

Closed

8 tasks

hksthff mentioned this issue Mar 27, 2024

[Device Support Request] Bosch Smoke Alarm II zigpy/zha-device-handlers#1562

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Does deCONZ serial protocol for ConBee/RaspBee Zigbee Coordinator adapters not support joining/pairing via install code and qr code? #20

Does deCONZ serial protocol for ConBee/RaspBee Zigbee Coordinator adapters not support joining/pairing via install code and qr code? #20

Hedda commented Feb 12, 2023 •

edited

martgras commented Feb 13, 2023

puddly commented Feb 13, 2023

Hedda commented Feb 15, 2023 •

edited

martgras commented Feb 15, 2023

ChrisHae commented Feb 15, 2023

Hedda commented Feb 16, 2023

xam-ps commented Mar 17, 2023

pdsccode commented May 7, 2023

xam-ps commented May 8, 2023

pdsccode commented May 8, 2023

Hedda commented May 9, 2023 •

edited

SwoopX commented May 9, 2023

Hedda commented May 10, 2023 •

edited

SwoopX commented May 10, 2023

puddly commented May 11, 2023

manup commented May 11, 2023

Hedda commented Sep 4, 2023 •

edited

Hedda commented Oct 13, 2023 •

edited

pixartist commented Oct 19, 2023

Pioneer42m commented Nov 18, 2023

lerra commented Dec 13, 2023

finkerle commented Dec 24, 2023

Hedda commented Mar 28, 2024 •

edited

hksthff commented Mar 28, 2024

Hedda commented Mar 28, 2024

Does deCONZ serial protocol for ConBee/RaspBee Zigbee Coordinator adapters not support joining/pairing via install code and qr code? #20

Does deCONZ serial protocol for ConBee/RaspBee Zigbee Coordinator adapters not support joining/pairing via install code and qr code? #20

Comments

Hedda commented Feb 12, 2023 • edited

martgras commented Feb 13, 2023

puddly commented Feb 13, 2023

Hedda commented Feb 15, 2023 • edited

martgras commented Feb 15, 2023

ChrisHae commented Feb 15, 2023

Hedda commented Feb 16, 2023

xam-ps commented Mar 17, 2023

pdsccode commented May 7, 2023

xam-ps commented May 8, 2023

pdsccode commented May 8, 2023

Hedda commented May 9, 2023 • edited

SwoopX commented May 9, 2023

Hedda commented May 10, 2023 • edited

SwoopX commented May 10, 2023

puddly commented May 11, 2023

manup commented May 11, 2023

Hedda commented Sep 4, 2023 • edited

Hedda commented Oct 13, 2023 • edited

pixartist commented Oct 19, 2023

Pioneer42m commented Nov 18, 2023

lerra commented Dec 13, 2023

finkerle commented Dec 24, 2023

Hedda commented Mar 28, 2024 • edited

hksthff commented Mar 28, 2024

Hedda commented Mar 28, 2024

Hedda commented Feb 12, 2023 •

edited

Hedda commented Feb 15, 2023 •

edited

Hedda commented May 9, 2023 •

edited

Hedda commented May 10, 2023 •

edited

Hedda commented Sep 4, 2023 •

edited

Hedda commented Oct 13, 2023 •

edited

Hedda commented Mar 28, 2024 •

edited