Fix Z-Wave JS cover stop support

[Yukon]

Proposed change

This change fixes issues stopping covers (blinds) I was having with my home setup. The Z-Wave JS integration would blindly set the Up/Down property twice, causing the blinds to move again. The integration will now only stop one direction which will stop the cover regardless of actual direction of travel.

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)
• Deprecation (breaking change to happen in the future)
• Breaking change (fix/feature causing existing functionality to break)
• Code quality improvements to existing code or addition of tests

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

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.
• For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
• Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration 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.

[homeassistant]

Hi @Yukon,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

[probot-home-assistant]

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

[MartinHjelmare]

Please make sure the CI checks pass.

[kpine]

I don't think this is the right solution. I am fairly certain the root of this problem is it looks like the original implementation was copied from the OZW integration code, which sent multiple open/close commands to workaround a bug in OZW (legacy zwave used a different API so it doesn't have this same code).

The desired Z-Wave command to stop an ongoing multilevel-switch transition is the Multilevel Switch CC Stop Level Command. Any one of the open/up/close/down values set to a False value will result in the stop level command. If there's an Up value, then there's always a Down, Open and Close, etc, so you just need to find one them, e.g. On, Up, Open, etc.

All possible switch types are listed here. Each X/Y entry generates separate "X" and "Y" value IDs.

Another approach to finding a value would be to search all values and find the first that has metadata cc_specific.switch_type (or however the Python lib represents it), and use that one. Or, one could just use the CC API instead (see invoke_cc_api used elsewhere) and manually call the stopLevelChange instead, but you'd also need to check for support.

In summary, the solution should probably be to just remove the duplicate set_value. Your change effectively does this because it returns on the first check.

If you're unsure of how these properties are supposed to work (and don't take my word for it), I would confirm with the node-zwave-js project.

[Yukon]

Hopefully I can get some feedback from others that have worked with covers about the readable state. It seems to be the case from the additional details @kpine provided that it really does not matter as setting the Open or Close state performs the same action in Wave-JS. I will jump on making that change, hopefully I will be able to figure out what is tripping up the flake8 CI check.

[Yukon]

Changes are up! Much simpler approach calling stopLevelChange.

[MartinHjelmare]

@kpine are you happy with this change?

[kpine]

@kpine are you happy with this change?

Technically, looks fine to me. The "stopLevelChange" command is mandatory for all devices that support the multilevel switch CC, which all the (non-barrier) covers are, so there's no issue using it. The only thing is that by using the CC API it deviates from the convention (value ID API) used elsewhere in the integration, so not sure if that is a problem for you.

I think the same solution would be achieved by just deleting the usage of the close_value value ID in the original code.

[MartinHjelmare]

@Yukon I'd suggest we follow the suggestion by @kpine and just remove the close_value call and adjust the tests accordingly. This will make the change smaller and should mostly be a deletion of code compared to the dev branch.

[Yukon]

@MartinHjelmare The changes have been simplified to just remove the problematic extra stop.

[MartinHjelmare]

Thanks! Please solve the lint errors.

[frenck]

Pushed a fix for the linter warnings

[MartinHjelmare]

Thanks!