Add comments to zwave_js node metadata WS API

[raman325]

Proposed change

comments are a metadata field that the zwave-js project uses to note certain things about a device. A good example is to let users know that a given device is known to provide invalid meter values. It would be useful to display this information on the device panel somehow.

Here's what it looks like in the device DB:

Frontend PR: home-assistant/frontend#12173

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:

• 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.

[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)}}

[jkeljo]

Seems reasonable as far as it goes. Is there a corresponding PR in the frontend?

[MartinHjelmare]

Yeah, we should have a plan for the frontend before we merge here.

[raman325]

Seems reasonable as far as it goes. Is there a corresponding PR in the frontend?

Not yet as we haven't determined how we will display all of this metadata. I was going to mess with this to see if I could get a good frontend PR going for it but it shouldn't block this PR since it's an update to an existing API command

[raman325]

Yeah, we should have a plan for the frontend before we merge here.

OK, I can look into it. But given that we are already making other metadata available to the frontend with this command, does it not seem like this should be OK to merge for now?

[MartinHjelmare]

As I understand it, adding data to the commands isn't insignificant when it comes to processing time in the frontend. I think we should know that we'll use the data and how we'll use it before adding it.

[raman325]

I was not aware of that. We can discuss this in more detail on Discord if need be but perhaps this is better as a separate API command then. The rest of the metadata doesn't need to be displayed on the device panel every time, I think we can put it in a modal or on a separate page. This seems like something that's worth display on the device panel.

[github-actions]

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
Thank you for your contributions.

[MartinHjelmare]

Can be merged when frontend PR is approved.

[raman325]

This feature needs to be added to the release because the frontend changes were included in the release while this was not