Continue shaping setup device wizard for Zigbee devices

[mkerstner]

Problem statement

Building upon #31 we aim to further shape and streamline the setup devices flow focusing on Zigbee devices.

This opportunity continues to lay the foundation for

• Unify setup experience across all supported protocols #5

Community signals

wip

Scope & Boundaries

In scope

• Revisit setup of Zigbee devices in alignment with concepts introduced in First device setup wizard focusing on Matter devices #31

Not in scope

• Other protocols

Foreseen solution

No response

Risks & open questions

Open questions

• Are we able to retrieve all device information the same way

Appetite

• Medium - 3-4 weeks

Execution issues

No response

Decision log

Date	Decision	Outcome

[Hedda]

This maybe belong in #5 but for reference, already mentioned here are also other related ideas raised about Zigbee device setup:

• Further shape Zigbee support by implementing missing features in ZHA while retaining choice #93

Like also considering looking into if "Zigbee 3.0 device secure provisioning via QR code scanning for ZHA integration UI in Home Assistant's frontend" could maybe also be added, (because QR code commissioning is already supported by Z-Wave and Matter):

• [frontend] Zigbee 3.0 device secure provisioning via QR code scanning for ZHA integration UI in Home Assistant's frontend? zigpy/backlog#3

Adding that to ZHA would add QR-code provisioning feature-parity with the Matter and Z-Wave JS integrations in Home Assistant:

• https://community.home-assistant.io/t/zigbee-device-secure-provisioning-by-scanning-qr-code-on-product-using-native-qr-scanner-via-camera-from-zhas-ui-config-and-home-assistant-companion-app-s-to-include-new-zigbee-3-0-devices-to-the-zha-integration/231185

As such implementing that on the frontend side in Home Assistant will further unify setup experience across supported protocols:

• Unify setup experience across all supported protocols #5

If and when a Zigbee device have a such QR code for secure provisioning then it should be more user-friendly if could use that.

While the QR-code for this is not printed on all Zigbee 3.0 products (as it is not a requirement), this way of secure provisioning of devices will also applies to future Zigbee 4.0 products too and might become more popular then, and I think that it would lower barrier to entry ifor end users f the Open Home Foundation could help try convincing all WWHA partners that they should begin printing print QR-code for Zigbee device secure provisioning on all their Zigbee 3.0 and Zigbee 4.0 compatible products in the future.

Regardless, not only would this make the QR-code scanning support for device provisioning make ZHA be consistent and have feature-parity with the Matter and Z-Wave integrations. I also believe that this could make adding Zigbee devices more approachable for end-users as users will be able to just scan the QR-code on new Zigbee products with the Home Assistant Companion app (using an Android or iOS mobile phone) to provision the device and it will be automatically joined/paired to your Zigbee network and commissioned/interviewed by the ZHA integration (Home Assistant's built-in Zigbee gateway).

FYI, for reference, Zigbee 4.0 also adds support for "Batch Commissioning" which is kind of a related concept as it will be great for professional installers and integrators who will be able to provision larger groups of devices simultaneously, which is also indirectly related to Zigbee device secure provisioning via QR code scanning for ZHA integration UI in Home Assiatant's frontend and the Home Assistant Companion apps:

• [ZHA/zigpy] Zigbee 4.0 compliance in zigpy, zha, and bellows, including support for Zigbee Smart Energy Profile (ZSE/SEP) devices zigpy/backlog#75

  "Batch Commissioning: Add and configure large groups of devices simultaneously - ideal for commercial lighting or smart building projects. Enables efficient, simultaneous setup of multiple devices, simplifying residential and commercial deployments Which will be great for professional installers and integrators."

PS: List of ZHA limitations is not exhaustive but it specifically mentions some current limitations with “QR Code” commissioning:

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

  "Home Assistant’s user interface does not currently support scanning a QR code for Zigbee 3.0 secure provisioning for device pre-commissioning in ZHA’s UI (instead, you currently need to use the zha.permit action with the qr_code parameter)."