Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove zwave.update_config service call #25959

Merged
merged 1 commit into from Aug 15, 2019

Conversation

@kpine
Copy link
Contributor

commented Aug 15, 2019

Description:

The zwave.update_config service call uses a python-openzwave API to perform the update of the config files. The implementation of the config file update is broken in the home assistant fork. It should be removed to avoid confusion.

Due to a bug in python-openzwave, the service call never actually worked properly. I submitted an issue to the project and it was fixed, but the home assistant fork never pulled in the fix. The related issue referenced below was open for months with no action, so I ended up closing it. That worked out anyways, since then OZW 1.6 has been released and the config files have changed format. To pull in the upstream fix now would be a disaster since it downloads incompatible 1.6 config files (it simply downloads from the master branch of openzwave).

The main motivation to remove the service call is that occasionally I see mentions about it in Discord or the Community forums. Either users think it works when it doesn't, or they are confused as to why it doesn't work, so better to avoid the confusion. Other reasons:

  1. OZW has stopped accepting device config updates for 1.4, therefore any recent install of ha-pyozw 1.4 (after April) has the latest config files, so there's nothing to update.
  2. OZW 1.6 introduced its own new API for updating config files, so an eventual update to python-openzwave would likely see this update mechanism change anyways.
  3. The files that actually are downloaded (to the config subdir) are the incompatible 1.6 files, so attempting to use them would not work.

Related issue (if applicable): fixes #19893

Pull request with documentation for home-assistant.io (if applicable): home-assistant/home-assistant.io#10139

Checklist:

  • The code change is tested and works locally.
  • Local tests pass with tox. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist

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

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

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

If the code does not interact with devices:

  • Tests have been added to verify that the new code works.
Remove zwave.update_config service call
The python-openzwave API which provides the implementation of the config update
does not actually work in the homeassistant fork. To avoid confusion, remove
the service call for now.

@project-bot project-bot bot added this to Needs review in Dev Aug 15, 2019

@kpine kpine referenced this pull request Aug 15, 2019
2 of 2 tasks complete

@kpine kpine marked this pull request as ready for review Aug 15, 2019

@kpine kpine requested a review from home-assistant/z-wave as a code owner Aug 15, 2019

Dev automation moved this from Needs review to Reviewer approved Aug 15, 2019

@balloob balloob merged commit 1bfe752 into home-assistant:dev Aug 15, 2019

12 checks passed

CI Build #20190815.5 succeeded
Details
CI (FullCheck Mypy) FullCheck Mypy succeeded
Details
CI (FullCheck Pylint) FullCheck Pylint succeeded
Details
CI (Overview CheckFormat) Overview CheckFormat succeeded
Details
CI (Overview Lint) Overview Lint succeeded
Details
CI (Overview Validate) Overview Validate succeeded
Details
CI (Tests PyTest Python36) Tests PyTest Python36 succeeded
Details
CI (Tests PyTest Python37) Tests PyTest Python37 succeeded
Details
cla-bot Everyone involved has signed the CLA
codecov/patch Coverage not affected when comparing b8bd97b...2994a03
Details
codecov/project 94.04% (target 90%)
Details
docs-missing Documentation ok.

Dev automation moved this from Reviewer approved to Done Aug 15, 2019

@lock lock bot locked and limited conversation to collaborators Aug 16, 2019

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
4 participants
You can’t perform that action at this time.