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鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add comments to zwave_js node metadata WS API #67210
Conversation
Hey there @home-assistant/z-wave, mind taking a look at this pull request as it has been labeled with an integration ( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems reasonable as far as it goes. Is there a corresponding PR in the frontend?
Yeah, we should have a plan for the frontend before we merge here. |
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 |
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? |
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. |
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. |
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. |
Can be merged when frontend PR is approved. |
This feature needs to be added to the release because the frontend changes were included in the release while this was not |
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
Additional information
Checklist
black --fast homeassistant tests
)If user exposed functionality or configuration variables are added/changed:
If the code communicates with devices, web services, or third-party tools:
Updated and included derived files by running:
python3 -m script.hassfest
.requirements_all.txt
.Updated by running
python3 -m script.gen_requirements_all
..coveragerc
.The integration reached or maintains the following Integration Quality Scale:
To help with the load of incoming pull requests: