Skip to content

Add is_controller_node flag to WS node status#66404

Merged
MartinHjelmare merged 1 commit intohome-assistant:devfrom
kpine:is-controller-node
Feb 12, 2022
Merged

Add is_controller_node flag to WS node status#66404
MartinHjelmare merged 1 commit intohome-assistant:devfrom
kpine:is-controller-node

Conversation

@kpine
Copy link
Copy Markdown
Contributor

@kpine kpine commented Feb 12, 2022

Proposed change

Add the node's is_controller_node flag to the WS node status message, which is used by the frontend to display device information. The is_controller_node flag is True when a node is the "connected" z-wave controller. The meaning of "connected controller" refers to the controller that is being controlled by the driver via the serial API. Other controllers in the network (e.g. secondary) that interact by z-wave commands are not "connected" and this flag would be false for those.

The frontend can use this flag to tailor information and actions based on whether the selected device is the connected controller or not (I have a change for that in progress). Many properties and actions for nodes are not valid for connected controllers and causes confusion with users. Common support questions are along the lines of "why doesn't my controller support z-wave plus or security?". These are examples of two properties that aren't available via the serial API and so displaying them incorrectly is misleading. With this flag the frontend is able to omit those properties.

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

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:

If the code communicates with devices, devicesweb 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:

@probot-home-assistant
Copy link
Copy Markdown

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)

Copy link
Copy Markdown
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@MartinHjelmare MartinHjelmare merged commit a7e5f38 into home-assistant:dev Feb 12, 2022
@kpine kpine deleted the is-controller-node branch February 13, 2022 01:57
@github-actions github-actions bot locked and limited conversation to collaborators Feb 14, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants