ZHA developer tools - ZHA: Permit should accept Hue QR Install Codes

JohnConnett · March 18, 2024, 2:57pm

It is possible to join a Hue device using the separate Source IEEE and Install code fields. However, the QR Code is rejected with Failed to call service zha.permit. couldn’t convert qr code: […].

According to Zigbee Home Automation this is expected behaviour. Only Aqara, Bosch, Consciot and Embrighten QR Install Codes are supported.

Hue QR Install Codes have this format:

1. 'HUE:'                           // Hue header
2. 'Z:'                             // Z tag
3. 36 uppercase hexadecimal digits  // 128-bit install code + 16-bit CRC
4. ' '                              // single space
5. 'M:'                             // M tag
6. 16 uppercase hexadecimal digits  // IEEE Address
7. ' '                              // single space
8. 'D:'                             // D tag
9. digits or uppercase letters      // 3 or 5 of them?
10. ' '                             // single space
11. 'A:'                            // A tag
12. 4 digits                        // always 4 of them?

This style of QR Install Code has been confirmed for five Hue devices: a floodlight, three different models of bulb and a dimmer switch.

Hedda · August 16, 2024, 10:54am

@JohnConnett I believe that the request for Hue QR install code for ZHA might instead belong as issue for the developers working on zigpy or zha libraries that the ZHA integration depends on (same devs):

By the way, noticed that in related news you got Philips Hue Secure Floodlight Camera EU (929003608801) working working with Zigbee2MQTT via QR code and install code and there is lots more information in the discussion for it there, and that you submitted a device support request to ZHA Device Handlers as well:

github.com/zigpy/zha-device-handlers

[Device Support Request] Philips Hue Secure Floodlight Camera EU (929003608801)

opened 03:18PM - 02 Mar 24 UTC

JohnConnett

### Problem description This is a slightly unusual device. It is essentially tw…o devices: a Zigbee Colour Floodlight and a Secure Camera sharing a common base and power supply. Although the packaging describes it as a [Zigbee Certified Product](https://zigbeealliance.org/wp-content/uploads/2021/04/07-4842-13-Zigbee-certification-policy.pdf) the camera part is unable to pair with ZHA. Nor does it support pairing using Zigbee Direct using Bluetooth LE (BLE). It can be commissioned into a Zigbee network with a [Philips Hue Bridge](https://www.philips-hue.com/en-gb/p/hue-bridge/8719514342583) as coordinator using the proprietary [Philips Hue App](https://www.philips-hue.com/en-gb/explore-hue/apps/bridge) using WiFi and BLE. The BLE advertisements emitted during setup do not conform to the _BLE Connectable Advertisement example_ in Appendix A of **Zigbee Direct Specification, Version 1.0**. In particular, instead of the 16-bit UUID of the Zigbee Direct Commissioning Service (0xFFF7) it has the 16-bit UUID of Signify Netherlands B.V. (formerly Philips Lighting B.V.) (0xFE0F). It may not be feasible to support this device with ZHA. I have set up a GitHub repository [Hue-Secure-Camera](https://github.com/JohnConnett/Hue-Secure-Camera) to collate information about this device. ### Solution description I would like to be able to pair this **Zigbee Certified Product** with ZHA (or other Zigbee networks of my choice). ### Screenshots/Video <details><summary>Screenshots/Video</summary> [Paste/upload your media here] </details> ### Device signature <details><summary>Device signature</summary> ```json [Paste the device signature here] ``` </details> ### Diagnostic information <details><summary>Diagnostic information</summary> ```json [Paste the diagnostic information here] ``` </details> ### Logs <details><summary>Logs</summary> ```python [Paste the logs here] ``` </details> ### Custom quirk <details><summary>Custom quirk</summary> ```python [Paste your custom quirk here] ``` </details> ### Additional information _No response_

github.com/Koenkk/zigbee2mqtt

[New device support]: Philips Hue Secure Floodlight Camera EU (929003608801)

opened 02:58PM - 02 Mar 24 UTC

JohnConnett

new device support

### Link https://www.philips-hue.com/en-gb/p/hue-philips-hue-secure-flood-lig…ht-camera-eu/8720169177703 ### Database entry Floodlight Part: {"id":16,"type":"Router","ieeeAddr":"0x001788010e115407","nwkAddr":48753,"manufId":4107,"manufName":"Signify Netherlands B.V.","powerSource":"Mains (single phase)","modelId":"442296118491","epList":[11,242],"endpoints":{"11":{"profId":260,"epId":11,"devId":269,"inClusterList":[0,3,4,5,6,8,4096,64515,768,64513,64516],"outClusterList":[25],"clusters":{"genBasic":{"attributes":{"modelId":"442296118491","manufacturerName":"Signify Netherlands B.V.","powerSource":1,"zclVersion":8,"appVersion":2,"stackVersion":1,"hwVersion":0,"dateCode":"20230403","swBuildId":"1.104.2"}},"lightingColorCtrl":{"attributes":{"colorCapabilities":31,"colorTempPhysicalMin":153,"colorTempPhysicalMax":500}}},"binds":[],"configuredReportings":[],"meta":{}},"242":{"profId":41440,"epId":242,"devId":97,"inClusterList":[],"outClusterList":[33],"clusters":{},"binds":[],"configuredReportings":[],"meta":{}}},"appVersion":2,"stackVersion":1,"hwVersion":0,"dateCode":"20230403","swBuildId":"1.104.2","zclVersion":8,"interviewCompleted":true,"meta":{"configured":1324213189},"lastSeen":1711293848840} ### Comments This is a slightly unusual device. It is essentially two devices: a Zigbee Colour Floodlight and a Secure Camera sharing a common base and power supply. Although the packaging describes it as a [Zigbee Certified Product](https://zigbeealliance.org/wp-content/uploads/2021/04/07-4842-13-Zigbee-certification-policy.pdf) the camera part is unable to pair with Zigbee2MQTT. Nor does it support pairing using **Zigbee Direct** using Bluetooth LE (BLE). Although _Zigbee2MQTT can pair with any Zigbee device_ this appears to be an exception ... It can be commissioned into a Zigbee network with a [Philips Hue Bridge](https://www.philips-hue.com/en-gb/p/hue-bridge/8719514342583) as coordinator using the proprietary [Philips Hue App](https://www.philips-hue.com/en-gb/explore-hue/apps/bridge) using WiFi and BLE. The BLE advertisements emitted during setup do not conform to the _BLE Connectable Advertisement example_ in Appendix A of **Zigbee Direct Specification, Version 1.0**. In particular, instead of the 16-bit UUID of the Zigbee Direct Commissioning Service (0xFFF7) it has the 16-bit UUID of Signify Netherlands B.V. (formerly Philips Lighting B.V.) (0xFE0F). It may not be feasible to support this device with Zigbee2MQTT. I have set up a GitHub repository [Hue-Secure-Camera](https://github.com/JohnConnett/Hue-Secure-Camera) to collate information about this device. ### External definition ```shell const {} = require('zigbee-herdsman-converters/lib/modernExtend'); // Add the lines below const fz = require('zigbee-herdsman-converters/converters/fromZigbee'); const tz = require('zigbee-herdsman-converters/converters/toZigbee'); const exposes = require('zigbee-herdsman-converters/lib/exposes'); const reporting = require('zigbee-herdsman-converters/lib/reporting'); const extend = require('zigbee-herdsman-converters/lib/extend'); const ota = require('zigbee-herdsman-converters/lib/ota'); const tuya = require('zigbee-herdsman-converters/lib/tuya'); const {} = require('zigbee-herdsman-converters/lib/tuya'); const utils = require('zigbee-herdsman-converters/lib/utils'); const globalStore = require('zigbee-herdsman-converters/lib/store'); const e = exposes.presets; const ea = exposes.access; const definition = { zigbeeModel: ['unknown'], model: 'UNKNOWN', // Update this with the real model of the device (written on the device itself or product page) vendor: 'Signify Netherlands B.V.', // Update this with the real vendor of the device (written on the device itself or product page) description: 'Philips Hue Secure Floodlight Camera EU', // Description of the device, copy from vendor site. (only used for documentation and startup logging) extend: [], fromZigbee: [], // We will add this later toZigbee: [], // Should be empty, unless device can be controlled (e.g. lights, switches). exposes: [e.battery(), e.temperature(), e.humidity()], // Defines what this device exposes, used for e.g. Home Assistant discovery and in the frontend }; module.exports = definition; ```

PS: Off-topic, also check out this feature request related to QR install code provisioning in ZHA:

Zigbee device provisioning by scanning QR Code = QR camera scanner in ZHA's UI config and companion apps to include new Zigbee 3.0 devices to Home Assistant's ZHA integration?