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

Gold and platinum integrations should implement diagnostic #117576

Closed
8 of 17 tasks
epenet opened this issue May 16, 2024 · 37 comments
Closed
8 of 17 tasks

Gold and platinum integrations should implement diagnostic #117576

epenet opened this issue May 16, 2024 · 37 comments

Comments

@epenet
Copy link
Contributor

epenet commented May 16, 2024

The problem

As per home-assistant/developers.home-assistant#1512, gold and platinum integrations should implement diagnostic.

I discovered via #117565 that the following integrations did not implement it.

If the integration is unable to implement diagnostic, then a PR should be opened to add a comment against the integration in script/hassfest/manifest.py, explaining why it cannot be implemented.

NO_DIAGNOSTICS = [

What version of Home Assistant Core has the issue?

2024.4

What was the last working version of Home Assistant Core?

No response

What type of installation are you running?

Home Assistant OS

Integration causing the issue

No response

Link to integration documentation on our website

No response

Diagnostics information

No response

Example YAML snippet

No response

Anything in the logs that might be useful for us?

No response

Additional information

No response

@home-assistant
Copy link

Hey there @fredrike, mind taking a look at this issue as it has been labeled with an integration (point) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of point can trigger bot actions by commenting:

  • @home-assistant close Closes the issue.
  • @home-assistant rename Awesome new title Renames the issue.
  • @home-assistant reopen Reopen the issue.
  • @home-assistant unassign point Removes the current integration label and assignees on the issue, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the issue.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the issue.

(message by CodeOwnersMention)


point documentation
point source
(message by IssueLinks)

@home-assistant
Copy link

Hey there @fredrike, mind taking a look at this issue as it has been labeled with an integration (tellduslive) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of tellduslive can trigger bot actions by commenting:

  • @home-assistant close Closes the issue.
  • @home-assistant rename Awesome new title Renames the issue.
  • @home-assistant reopen Reopen the issue.
  • @home-assistant unassign tellduslive Removes the current integration label and assignees on the issue, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the issue.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the issue.

(message by CodeOwnersMention)


tellduslive documentation
tellduslive source
(message by IssueLinks)

@home-assistant
Copy link

Hey there @janiversen, mind taking a look at this issue as it has been labeled with an integration (modbus) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of modbus can trigger bot actions by commenting:

  • @home-assistant close Closes the issue.
  • @home-assistant rename Awesome new title Renames the issue.
  • @home-assistant reopen Reopen the issue.
  • @home-assistant unassign modbus Removes the current integration label and assignees on the issue, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the issue.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the issue.

(message by CodeOwnersMention)


modbus documentation
modbus source
(message by IssueLinks)

@home-assistant
Copy link

Hey there @dermotduffy, mind taking a look at this issue as it has been labeled with an integration (hyperion) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of hyperion can trigger bot actions by commenting:

  • @home-assistant close Closes the issue.
  • @home-assistant rename Awesome new title Renames the issue.
  • @home-assistant reopen Reopen the issue.
  • @home-assistant unassign hyperion Removes the current integration label and assignees on the issue, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the issue.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the issue.

(message by CodeOwnersMention)


hyperion documentation
hyperion source
(message by IssueLinks)

@home-assistant
Copy link

Hey there @mdz, mind taking a look at this issue as it has been labeled with an integration (smarttub) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of smarttub can trigger bot actions by commenting:

  • @home-assistant close Closes the issue.
  • @home-assistant rename Awesome new title Renames the issue.
  • @home-assistant reopen Reopen the issue.
  • @home-assistant unassign smarttub Removes the current integration label and assignees on the issue, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the issue.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the issue.

(message by CodeOwnersMention)


smarttub documentation
smarttub source
(message by IssueLinks)

@home-assistant
Copy link

Hey there @OnFreund, mind taking a look at this issue as it has been labeled with an integration (risco) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of risco can trigger bot actions by commenting:

  • @home-assistant close Closes the issue.
  • @home-assistant rename Awesome new title Renames the issue.
  • @home-assistant reopen Reopen the issue.
  • @home-assistant unassign risco Removes the current integration label and assignees on the issue, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the issue.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the issue.

(message by CodeOwnersMention)


risco documentation
risco source
(message by IssueLinks)

@home-assistant
Copy link

Hey there @rytilahti, @shenxn, mind taking a look at this issue as it has been labeled with an integration (songpal) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of songpal can trigger bot actions by commenting:

  • @home-assistant close Closes the issue.
  • @home-assistant rename Awesome new title Renames the issue.
  • @home-assistant reopen Reopen the issue.
  • @home-assistant unassign songpal Removes the current integration label and assignees on the issue, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the issue.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the issue.

(message by CodeOwnersMention)


songpal documentation
songpal source
(message by IssueLinks)

@home-assistant
Copy link

Hey there @exxamalte, mind taking a look at this issue as it has been labeled with an integration (gdacs) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of gdacs can trigger bot actions by commenting:

  • @home-assistant close Closes the issue.
  • @home-assistant rename Awesome new title Renames the issue.
  • @home-assistant reopen Reopen the issue.
  • @home-assistant unassign gdacs Removes the current integration label and assignees on the issue, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the issue.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the issue.

(message by CodeOwnersMention)


gdacs documentation
gdacs source
(message by IssueLinks)

@home-assistant
Copy link

Hey there @exxamalte, mind taking a look at this issue as it has been labeled with an integration (geonetnz_quakes) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of geonetnz_quakes can trigger bot actions by commenting:

  • @home-assistant close Closes the issue.
  • @home-assistant rename Awesome new title Renames the issue.
  • @home-assistant reopen Reopen the issue.
  • @home-assistant unassign geonetnz_quakes Removes the current integration label and assignees on the issue, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the issue.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the issue.

(message by CodeOwnersMention)


geonetnz_quakes documentation
geonetnz_quakes source
(message by IssueLinks)

@home-assistant
Copy link

Hey there @marciogranzotto, mind taking a look at this issue as it has been labeled with an integration (nightscout) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of nightscout can trigger bot actions by commenting:

  • @home-assistant close Closes the issue.
  • @home-assistant rename Awesome new title Renames the issue.
  • @home-assistant reopen Reopen the issue.
  • @home-assistant unassign nightscout Removes the current integration label and assignees on the issue, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the issue.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the issue.

(message by CodeOwnersMention)


nightscout documentation
nightscout source
(message by IssueLinks)

@home-assistant
Copy link

Hey there @raman325, mind taking a look at this issue as it has been labeled with an integration (vizio) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of vizio can trigger bot actions by commenting:

  • @home-assistant close Closes the issue.
  • @home-assistant rename Awesome new title Renames the issue.
  • @home-assistant reopen Reopen the issue.
  • @home-assistant unassign vizio Removes the current integration label and assignees on the issue, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the issue.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the issue.

(message by CodeOwnersMention)


vizio documentation
vizio source
(message by IssueLinks)

@farmio
Copy link
Contributor

farmio commented May 16, 2024

@janiversen in knx we use it to dump the whole yaml config. Maybe that would be an option for Modbus too.
fronius integration doesn't use Modbus btw. but a local HTTP API. Not really sure what to log here though.

@joostlek
Copy link
Member

Modbus isn't config entry based, so does diagnostics even work for them?

@tronikos
Copy link
Member

Yes Google Assistant SDK still connects to a service but my understanding of: "When communicating with a device or service" refers to https://developers.home-assistant.io/docs/architecture/devices-and-services/ which doesn't apply here. Putting just the language code in diagnostics isn't particularly useful.

@janiversen
Copy link
Member

@joostlek that is my point from earlier, the definition is "When communicating with a device or service, the integration implements the diagnostics platform which redacts sensitive information.", and not like the other demands, which have "if available", so it seems it MUST be implemented even if it does not work.

What I will be doing for modbus is to dump state of the entity...but honestly it is only to satisfy the quality demand, as it will not help in diagnosing a problem.

There is also something that I do not understand, the diagnostic platform is targeted at end-users, but it seems the dict is not being translated (I might have missed it, but at least the example tplink/diagnostic.py, does not use strings.json ??

@joostlek
Copy link
Member

I think that wording comes from one of the Adr, modbus is a protocol integration like mqtt. And it doesn't connect with a specific device.

@janiversen
Copy link
Member

The text says "device or service, modbus communicates with a specific device !! and it was added to this PR so surely someone thinks it should be done.

@MatthewFlamm
Copy link
Contributor

I cannot edit the issue description, but nws is completed in #117587. Thanks for the pointers and quick merge!

@epenet
Copy link
Contributor Author

epenet commented May 21, 2024

I have adjusted the description above.
If an integration is unable to implement diagnostic, then a PR should be opened to add a comment against the integration in script/hassfest/manifest.py, explaining why it cannot be implemented.

NO_DIAGNOSTICS = [
"dlna_dms",
"fronius",
"gdacs",
"geonetnz_quakes",
"google_assistant_sdk",
"hyperion",
# Modbus is excluded because it doesn't have to have a config flow
# according to ADR-0010, since it's a protocol integration. This
# means that it can't implement diagnostics.
"modbus",
"nightscout",
"pvpc_hourly_pricing",
"risco",
"smarttub",
"songpal",
"vizio",
"yeelight",
]

@tronikos
Copy link
Member

#118513 takes care of Google Assistant SDK

@egaryw2011
Copy link

Modbus isn't config entry based, so does diagnostics even work for them?

Hi, I am not sure who to direct my question too, I use modbus to monitor my solar system and I am in the process of cleaning up all my errors in the logs (growing a couple of gig per day).
In the error logs is the Modbus issue, how do I fix it, the following appears all the time;

Logger: homeassistant.components.modbus.validators
Source: components/modbus/validators.py:302
integration: Modbus (documentation, issues)
First occurred: October 6, 2024 at 8:06:41 AM (1 occurrences)
Last logged: October 6, 2024 at 8:06:41 AM

retries: is deprecated and will be removed in version 2024.7

Thanks in advance

@cgarwood
Copy link
Member

Gonna close this now that the new quality scale system has rolled out.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment