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

Improve the readability of status messages in NUT #141335

Merged
merged 1 commit into from
Mar 30, 2025

Conversation

bonanitech
Copy link
Contributor

@bonanitech bonanitech commented Mar 25, 2025

Breaking change

The status sensor has changed, providing the state from the UPS Display. Previously, multiple states would be concatenated using a space, which made them harder to read and process. As of this release, multiple statuses are separated using a comma instead.

Proposed change

Improve the readability of status messages by separating them by commas.

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

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
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format 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, 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.

To help with the load of incoming pull requests:

@home-assistant
Copy link

Hey there @bdraco, @ollo69, @pestevez, @tdfountain, mind taking a look at this pull request as it has been labeled with an integration (nut) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of nut can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign nut Removes the current integration label and assignees on the pull request, 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 pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@tdfountain
Copy link
Contributor

This is a breaking change since the return values of the status sensor will change. The breaking change section and explanation should be provided.

Copy link
Contributor

@tdfountain tdfountain left a comment

Choose a reason for hiding this comment

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

Please add Breaking Change as noted.

@tdfountain
Copy link
Contributor

@home-assistant rename Improve the readability of status messages in NUT

@home-assistant home-assistant bot changed the title Improve the readability of status messages Improve the readability of status messages in NUT Mar 25, 2025
@bonanitech
Copy link
Contributor Author

Please add Breaking Change as noted.

I had no idea it would be a breaking change. What should I add there?

@bonanitech
Copy link
Contributor Author

I changed it to Breaking Change, but I don't know what to add as an explanation there.

@frenck
Copy link
Member

frenck commented Mar 30, 2025

I changed it to Breaking Change, but I don't know what to add as an explanation there.

Added an note to the first chapter.

Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Thanks, @bonanitech 👍

../Frenck

@frenck frenck dismissed tdfountain’s stale review March 30, 2025 14:26

Comment addressed

@frenck frenck merged commit ec20e41 into home-assistant:dev Mar 30, 2025
34 checks passed
@bonanitech bonanitech deleted the nut-readability branch March 30, 2025 15:30
@github-actions github-actions bot locked and limited conversation to collaborators Mar 31, 2025
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.

Network UPS Tools (NUT) integration status messages
4 participants