New configuration flow for ZHA integration #35161

Adminiuga · 2020-05-04T01:18:16Z

Breaking change

Yes.
The following:

usb_path
baudrate
radio_type

configuration options for ZHA integration in configuration.yaml are deprecated and will be removed in 0.112.0

Proposed change

Deprecate manual ZHA configuration (Radio type and serial port settings) via yaml, while also trying to make integration configuration a bit more user friendly. In the new flow system presents a drop down of all available serial ports and user has to pick the right one:

For USB connected devices, there is going to be some extra information to narrow the choice

Once selected, the flow would try to detect the radio type automatically, which should take about 15s as it tries all radio types in sequence: EZSP, Deconz, TI_CC (ZNP), Zigate, Xbee

If successful, it's all done:

If none of the probe succeeds (e.g. Elelabs radios decided to change the default baudrate to 115200 for ezsp) then the "manual configuration" kicks in and user has to pick the radio type

And based on the radio type, user will be presented with settings specific for that radio type, as some radios don't care about "baudrate", or some radios may use a different "data flow control", Schema for this forms comes from the Radio and allows advanced radio configuration without any HA code modification. However ATM 99% should be covered by automatic radio detection, assuming user picks the right port.

Since this PR deprecates manual radio configuration via .yaml, the following options are deprecated in 0.112

usb_path
baudrate
radio_type

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New integration (thank you!)
New feature (which adds functionality to an existing integration)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Example entry for `configuration.yaml`:

n/a

Additional information

This PR fixes or closes issue: fixes #
This PR is related to issue:
Link to documentation pull request:

Checklist

The code change is tested and works locally.
Local tests pass. Your PR cannot be merged unless tests pass
There is no commented out code in this PR.
I have followed the development checklist
The code has been formatted using Black (black --fast homeassistant tests)
Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated for www.home-assistant.io Update documentation for new ZHA config entry flow home-assistant.io#13279

If the code communicates with devices, web services, or third-party tools:

The manifest file has all fields filled out correctly.
Updated and included derived files by running: python3 -m script.hassfest.
New or updated dependencies have been added to requirements_all.txt.
Updated by running python3 -m script.gen_requirements_all.
Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

No score or internal
🥈 Silver
🥇 Gold
🏆 Platinum

probot-home-assistant · 2020-05-04T01:18:27Z

Hey there @dmulcahey, @Adminiuga, mind taking a look at this pull request as its been labeled with a integration (zha) you are listed as a codeowner for? Thanks!
_{^{(message by CodeOwnersMention)}}

Hedda · 2020-05-04T09:08:55Z

I don't have one but wondering how it works with IP-based / remote networked connected adapters?

Only know of the ZiGate Pack WiFi adapter now (but assume might be similar adapters in the future).

https://zigate.fr/produit/zigate-pack-wifi-v1-3/
- https://zigate.fr/produit/module-wifi-v1-3-compatible-zigate/

@doudz do you maybe have a ZiGate Pack WiFi so you can test this with your zigpy-zigate library or?

https://github.com/zigpy/zigpy-zigate/

As I understand the ZiGate Pack WiFi adapter basically just has a serial port server forwarding service?

That is, it has a serial server software that just acts as a dumb Zigbee to WiFi bridge for zigpy-zigate or?

Hedda · 2020-05-04T09:21:12Z

@doudz @Adminiuga It would be very nice from an end-users perspective if the serial server software in the firmware of "dumb" networked Zigbee bridge hardware like the ZiGate Pack WiFi adapter had some kind of features/functions for Zero-configuration networking (zeroconf) like mDNS for automatic-discovery that would allow projects like Home Assistant's ZHA to automatically discover the ZiGate Pack WiFi on the network to make drop-down-list installation and configurations on the client-side such as these as simple as possible for a more user-friendly experience.

Off-topic, think it's just a matter of time before there's a hacked firmware like that for Sonoff ZBBridge

[REQUEST] Use zigpy & bellows with the new Sonoff ZBBridge (cheap Zigbee to WiFi Bridge/Gateway by Itead) zigpy/zigpy#385

doudz · 2020-05-04T13:57:37Z

@doudz @Adminiuga It would be very nice from an end-users perspective if the serial server software in the firmware of "dumb" networked Zigbee bridge hardware like the ZiGate Pack WiFi adapter had some kind of features/functions for Zero-configuration networking (zeroconf) like mDNS for automatic-discovery that would allow projects like Home Assistant's ZHA to automatically discover the ZiGate Pack WiFi on the network to make drop-down-list installation and configurations on the client-side such as these as simple as possible for a more user-friendly experience.

Off-topic, think it's just a matter of time before there's a hacked firmware like that for Sonoff ZBBridge

zigpy/zigpy#385

Firmware 2.0 of ZiGate WiFi adapter has mDNS
https://zigate.fr/documentation/description-du-firmware-v2-xx/

dmulcahey

LGTM!

homeassistant/components/zha/config_flow.py

tests/components/zha/test_config_flow.py

tests/components/zha/test_init.py

Hedda · 2020-05-05T07:31:11Z

Firmware 2.0 of ZiGate WiFi adapter has mDNS
https://zigate.fr/documentation/description-du-firmware-v2-xx/

@doudz That sounds great! Any chance you have time + interest to look into automatic-discovery of that adapter for mDNS adapter detection and configuration flow for ZHA integration similar to this?

UPDATE: Submitted this as a separate discussion for zigpy here instead -> https://github.com/zigpy/zigpy/issues/405

Update config entry data import. Use new zigpy startup. Fix config entry import without zha config section. Auto form Zigbee network.

Use lightweight probe() method for ZHA config entry validation when available. Failback to old behavior of setting up Zigpy app if radio lib does not provide probing.

Co-authored-by: Martin Hjelmare <[email protected]>

Use AsyncMock from tests.

tests/components/zha/conftest.py

homeassistant/components/zha/config_flow.py

MartinHjelmare · 2020-05-06T02:18:05Z

homeassistant/components/zha/__init__.py

+    _LOGGER.debug("Migrating from version %s", config_entry.version)
+
+    if config_entry.version == 1:
+        config_entry.data = {


The data attribute should be considered read only. We set it to a mapping proxy when the config entry is defined. We should use hass.config_entries.async_update_entry to update the data.

ok, i'll update it.
BTW this was copied that from axis integration, so that may need update too.

ok, it's using async_update_entry() now. For config entry migration, i still have to set the config_entry.version attribute to the new version, right?

homeassistant/components/zha/__init__.py

MartinHjelmare

Great!

MartinHjelmare · 2020-05-06T10:32:17Z

We usually add breaking change label when we deprecate things, and then another break when the deprecation expires.

Adminiuga · 2020-05-06T13:43:51Z

Updated PR description to reflect breaking change.

homeassistant added the cla-signed label May 4, 2020

probot-home-assistant bot added dependency has-tests integration: zha new-feature labels May 4, 2020

probot-home-assistant bot assigned Adminiuga and dmulcahey May 4, 2020

Adminiuga mentioned this pull request May 4, 2020

Update documentation for new ZHA config entry flow home-assistant/home-assistant.io#13279

Merged

8 tasks

dmulcahey approved these changes May 4, 2020

View reviewed changes

balloob added dependency and removed dependency old labels May 4, 2020

Adminiuga force-pushed the experimental/reb-zha-new-config-entry branch from d8d1164 to 54bc471 Compare May 4, 2020 19:21

MartinHjelmare requested changes May 5, 2020

View reviewed changes

Adminiuga requested a review from MartinHjelmare May 5, 2020 04:49

MartinHjelmare reviewed May 5, 2020

View reviewed changes

tests/components/zha/test_config_flow.py Show resolved Hide resolved

tests/components/zha/test_config_flow.py Outdated Show resolved Hide resolved

tests/components/zha/test_config_flow.py Outdated Show resolved Hide resolved

tests/components/zha/test_init.py Outdated Show resolved Hide resolved

Adminiuga requested a review from MartinHjelmare May 5, 2020 16:44

Adminiuga added 6 commits May 5, 2020 14:48

Start gateway using new zigpy init.

4f5f5c9

Update config entry data import. Use new zigpy startup. Fix config entry import without zha config section. Auto form Zigbee network.

Migrate config entry.

3a7475f

New ZHA config entry flow.

0183b26

Use lightweight probe() method for ZHA config entry validation when available. Failback to old behavior of setting up Zigpy app if radio lib does not provide probing.

Clean ZHA_GW_RADIO

43f6225

Don't import ZHA device settings.

6804291

Update config flow tests.

e7b8cad

Adminiuga and others added 9 commits May 5, 2020 14:53

Use executor pool for IO

662c074

Update tests/components/zha/test_config_flow.py

546f411

Co-authored-by: Martin Hjelmare <[email protected]>

Update tests/components/zha/test_config_flow.py

ccecfa3

Co-authored-by: Martin Hjelmare <[email protected]>

Update tests/components/zha/test_config_flow.py

fe377f0

Co-authored-by: Martin Hjelmare <[email protected]>

Address comments.

0592f83

Use AsyncMock from tests.

Use core interface to test config flow.

69fbade

Use core interface to test config_flow.

a0a733a

Address comments. Use core interface.

ac0c03f

Update ZHA dependencies.

1b425b5

Adminiuga force-pushed the experimental/reb-zha-new-config-entry branch from 5d40191 to 1b425b5 Compare May 5, 2020 18:53

Adminiuga mentioned this pull request May 5, 2020

ZHA on HA: messages received but not being parsed? zigpy/zigpy-cc#45

Closed

MartinHjelmare reviewed May 5, 2020

View reviewed changes

tests/components/zha/conftest.py Show resolved Hide resolved

MartinHjelmare reviewed May 5, 2020

View reviewed changes

homeassistant/components/zha/config_flow.py Outdated Show resolved Hide resolved

Schema guard

3101046

Adminiuga requested a review from MartinHjelmare May 6, 2020 01:18

MartinHjelmare reviewed May 6, 2020

View reviewed changes

Adminiuga added 2 commits May 5, 2020 22:34

Use async_update_entry for migration.

10d8aae

Don't allow schema extra keys.

c5a3757

Adminiuga requested a review from MartinHjelmare May 6, 2020 03:09

MartinHjelmare approved these changes May 6, 2020

View reviewed changes

MartinHjelmare merged commit c71a7b9 into home-assistant:dev May 6, 2020

MartinHjelmare added the breaking-change label May 6, 2020

Adminiuga deleted the experimental/reb-zha-new-config-entry branch May 6, 2020 13:43

Hedda mentioned this pull request May 7, 2020

[REQUEST] Zeroconf / mDNS network detection of ZiGate Pack WiFi adapter and configuration flow for ZHA integration zigpy/zigpy-zigate#36

Open

frenck mentioned this pull request May 8, 2020

ZHA no longer starts: Error setting up entry ConBee1 for zha #35377

Closed

lock bot locked and limited conversation to collaborators May 21, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New configuration flow for ZHA integration #35161

New configuration flow for ZHA integration #35161

Adminiuga commented May 4, 2020 •

edited

Loading

probot-home-assistant bot commented May 4, 2020

Hedda commented May 4, 2020 •

edited

Loading

Hedda commented May 4, 2020 •

edited

Loading

doudz commented May 4, 2020 •

edited

Loading

dmulcahey left a comment

Hedda commented May 5, 2020 •

edited

Loading

MartinHjelmare May 6, 2020

Adminiuga May 6, 2020

Adminiuga May 6, 2020

MartinHjelmare left a comment

MartinHjelmare commented May 6, 2020

Adminiuga commented May 6, 2020

New configuration flow for ZHA integration #35161

New configuration flow for ZHA integration #35161

Conversation

Adminiuga commented May 4, 2020 • edited Loading

Breaking change

Proposed change

Type of change

Example entry for configuration.yaml:

Additional information

Checklist

probot-home-assistant bot commented May 4, 2020

Hedda commented May 4, 2020 • edited Loading

Hedda commented May 4, 2020 • edited Loading

doudz commented May 4, 2020 • edited Loading

dmulcahey left a comment

Choose a reason for hiding this comment

Hedda commented May 5, 2020 • edited Loading

MartinHjelmare May 6, 2020

Choose a reason for hiding this comment

Adminiuga May 6, 2020

Choose a reason for hiding this comment

Adminiuga May 6, 2020

Choose a reason for hiding this comment

MartinHjelmare left a comment

Choose a reason for hiding this comment

MartinHjelmare commented May 6, 2020

Adminiuga commented May 6, 2020

Adminiuga commented May 4, 2020 •

edited

Loading

Example entry for `configuration.yaml`:

Hedda commented May 4, 2020 •

edited

Loading

Hedda commented May 4, 2020 •

edited

Loading

doudz commented May 4, 2020 •

edited

Loading

Hedda commented May 5, 2020 •

edited

Loading