Switch velbus from python-velbus to velbusaio

[cereal2nd]

Breaking change

• The configuration.yaml config option is deprecated
• The velbus services call will now need an interface parameter, to allow support for multiple velbus connections.

Proposed change

Switch the velbus component from python-velbus to velbusaio lib. Both modules are compatible and support the same features. velbusaio is just an asyncio implementation for python-velbus.
https://github.com/Cereal2nd/velbus-aio

The velbusaio lib has has the following advantages

• asyncio
• uses a json protocol description generated from the velbus protocol desciption. This will result in more supported modules and les maintenance
• add caching, the velbus scan can take up to 10 minuts, this is verry long and until its finished HASS does not know the velbus entities. The velbusaio has a caching mechanisme, so the startup only takes about 20 seconds.
• fix the power sensors so they are useable in the energy dashboard
• Deprecate the platform setup via the config file
• Fix some errors in the velbus packet parsing (made the component break in some cases)

Additional information

• Link to documentation pull request: Update the velbus documentation for the velbusaio module home-assistant.io#19309

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

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][dev-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][docs-repository]

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

• The [manifest file][manifest-docs] 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][quality-scale]:

• No score or internal
• 🥈 Silver
• 🥇 Gold
• 🏆 Platinum

To help with the load of incoming pull requests:

• I have reviewed two other open pull requests in this repository.

[probot-home-assistant]

Hey there @brefra, mind taking a look at this pull request as it has been labeled with an integration (velbus) you are listed as a code owner for? Thanks!
_{^{(message by CodeOwnersMention)}}

[brefra]

That's Looks great!
I'll give it a try asap and let you know the result.

[cereal2nd]

That's Looks great!
I'll give it a try asap and let you know the result.

i'm sure there will be items that ar not correctly working yet, thats why its a WIP pull request :)

[cereal2nd]

THIS PR is now ready, can someone have a look at give some suggestions on how to improve it?

[MartinHjelmare]

Please add a link to the new library on github in the PR description.

[cereal2nd]

Link added, the only thing that needs to be done is the service change.
i reallyw ant this to be in this PR

[cereal2nd]

@MartinHjelmare any idea why the python 3.9 runs fail and the other runs pass?

[ludeeus]

Both 3.8 and 3.9 tails on tests/components/velbus/test_config_flow.py::test_user_fail

[cereal2nd]

Both 3.8 and 3.9 tails on tests/components/velbus/test_config_flow.py::test_user_fail

Thanks, looked at the results wrongly. Fixed in the meantime ....

[cereal2nd]

Converting to draft because @brefra fond some potential problems with the new lib and we want to investigate before merging

[cereal2nd]

@MartinHjelmare one point that i'm not sure about:

• During the intial loading of the component (when finishing the config flow) the async_setup_entry will take a long time, how should we handle this correctly?

[MartinHjelmare]

• During the intial loading of the component (when finishing the config flow) the async_setup_entry will take a long time, how should we handle this correctly?

What is taking a long time, do you know?

[cereal2nd]

• During the intial loading of the component (when finishing the config flow) the async_setup_entry will take a long time, how should we handle this correctly?

What is taking a long time, do you know?

The actually reading of the bus. To read all the module data we need to scan the bus and send a lot of messages to the bus. Depending on the number of modules this can take a long time. For example in my install this takes 5 minute.

[MartinHjelmare]

We could create a non tracked asyncio task that finishes the connect and discovery and have a callback that forwards the entry to the platforms on demand and adds the discovered devices as entities. We could wrap the controller connect method inside a coroutine function that triggers the callback when the connect and discovery is done.

Something like zwave_js does:

core/homeassistant/components/zwave_js/__init__.py

Lines 163 to 173 in 6218cd6

	if platform not in platform_setup_tasks:
	platform_setup_tasks[platform] = hass.async_create_task(
	hass.config_entries.async_forward_entry_setup(entry, platform)
	)
	await platform_setup_tasks[platform]
	LOGGER.debug("Discovered entity: %s", disc_info)
	async_dispatcher_send(
	hass, f"{DOMAIN}_{entry.entry_id}_add_{platform}", disc_info
	)

The last part with the dispatch helper signal is only needed if we need to add entities dynamically, ie more than once.

[MartinHjelmare]

Are we ready for a final review? The PR is still draft.

[cereal2nd]

Are we ready for a final review? The PR is still draft.

I'm waiting for @brefra to releas one new version of the lib, and then i need to bump the version here.

But thats it nothing else will change

[cereal2nd]

@MartinHjelmare by when does this need to be merged to be included in the 2021.10 release?

[MartinHjelmare]

The beta cut is September 29. You can see the dev calendar here:
https://developers.home-assistant.io/

[brefra]

No issues discovered while running this PR locally on my system.

[cereal2nd]

@MartinHjelmare everything is ready
would love to have this merged before the beta cut, as we have some people waiting for it

[MartinHjelmare]

Please add a sentence about the deprecation of configuration.yaml section, in the PR description breaking change paragraph.

[MartinHjelmare]

Thanks!

[MartinHjelmare]

Please add a link to a docs PR where we document the change to the services.

[cereal2nd]

Please add a link to a docs PR where we document the change to the services.

Done