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

Add ability to translate ENUM sensor states in Unifi integration #131921

Merged
merged 5 commits into from
Dec 18, 2024

Conversation

bieniu
Copy link
Member

@bieniu bieniu commented Nov 29, 2024

Breaking change

The states of Device State sensors have been standardized to match Home Assistant core rules and be translatable.
This affects the following Unifi sensor states:

  • Connected, which now became connected
  • Pending, which now became pending
  • Firmware Mismatch, which now became firmware_mismatch
  • Upgrading, which now became upgrading
  • Provisioning, which now became provisioning
  • Heartbeat Missed, which now became heartbeat_missed
  • Adopting, which now became adopting
  • Deleting, which now became deleting
  • Inform Error, which now became inform_error
  • Adoption Failed, which now became adoption_failed
  • Isolated, which now became isolated
  • Unknown, which now became unknown

If you used those states directly in your automations, scripts, or templates; you will need to adjust those to match these changes.

Proposed change

Adds ability to translate ENUM sensor states in Unifi integration.

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

  • 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
  • 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 @Kane610, mind taking a look at this pull request as it has been labeled with an integration (unifi) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of unifi 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 unifi 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.

Comment on lines 40 to 41
"disconnected": "Disconnected",
"connected": "Connected",
Copy link
Contributor

Choose a reason for hiding this comment

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

Couldn't some states have references to already existing translations?

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
"disconnected": "Disconnected",
"connected": "Connected",
"disconnected": "[%key:common::state::disconnected%]",
"connected": "[%key:common::state::connected%]",

Copy link
Member Author

Choose a reason for hiding this comment

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

Good point, forgot about that.

"inform_error": "Inform Error",
"adoption_failed": "Adoption Failed",
"isolated": "Isolated",
"unknown": "Unknown"
Copy link
Member

Choose a reason for hiding this comment

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

unknown should not be its own state. Rather, the entity should return None in that case (which for the end user would still resolve to unknown, but the difference is, is that unknown already is a valid state and shown in the automation editor)

Comment on lines 43 to 50
"firmware_mismatch": "Firmware Mismatch",
"upgrading": "Upgrading",
"provisioning": "Provisioning",
"heartbeat_missed": "Heartbeat Missed",
"adopting": "Adopting",
"deleting": "Deleting",
"inform_error": "Inform Error",
"adoption_failed": "Adoption Failed",
Copy link
Member

Choose a reason for hiding this comment

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

Use sentence case

Comment on lines 40 to 41
"disconnected": "Disconnected",
"connected": "Connected",
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
"disconnected": "Disconnected",
"connected": "Connected",
"disconnected": "[%key:common::state::disconnected%]",
"connected": "[%key:common::state::connected%]",

@home-assistant home-assistant bot marked this pull request as draft December 8, 2024 22:19
@home-assistant
Copy link

home-assistant bot commented Dec 8, 2024

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@bieniu bieniu marked this pull request as ready for review December 9, 2024 08:27
@home-assistant home-assistant bot requested a review from joostlek December 9, 2024 08:27
@joostlek joostlek merged commit 3132700 into home-assistant:dev Dec 18, 2024
34 checks passed
@bieniu bieniu deleted the unifi-enum-translations branch December 18, 2024 14:38
@github-actions github-actions bot locked and limited conversation to collaborators Dec 19, 2024
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.

4 participants