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

Make triggers and condition for monetary sensor consistent #131184

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from

Conversation

NoRi2909
Copy link
Contributor

Since March 2023 the sensor type 'monetary' has the friendly name "Balance" (in the sense of an account balance):

"monetary": {
"name": "Balance"

The corresponding trigger and condition strings, however, were not matched and called "money" instead.
This is not only inconsistent, it also does not make any sense to say

When {entity_name} money changes

or

Current {entity_name} money

Both make sense with "balance" only.

Proposed change

Replace "money" in both strings with "balance".

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:

Since March 2023 the sensor type 'monetary' has the friendly name "Balance" (in the sense of an account balance).

The corresponding trigger and condition strings, however, were not matched and called "money" instead. This is not only inconsistent, it also does not make any sense to say

    When {entity_name} money changes

or

    Current {entity_name} money

Both make sense with "balance" only.
@home-assistant
Copy link

Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (sensor) you are listed as a code owner for? Thanks!

Code owner commands

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

@@ -23,7 +23,7 @@
"is_illuminance": "Current {entity_name} illuminance",
"is_irradiance": "Current {entity_name} irradiance",
"is_moisture": "Current {entity_name} moisture",
"is_monetary": "Current {entity_name} money",
"is_monetary": "Current {entity_name} balance",
Copy link
Member

Choose a reason for hiding this comment

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

This device class doesn't represent a total, thus cannot be a balance.

Copy link
Contributor Author

@NoRi2909 NoRi2909 Nov 21, 2024

Choose a reason for hiding this comment

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

Well, I mentioned it at the very top of my PR, the 'monetary' entity class is named "Balance":

"monetary": {
"name": "Balance"

That is also how it is listed as device class when creating a Random helper:

Screenshot 2024-11-22 11 47 53

So this is the current balance on some (virtual) account.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Now if that is called "Balance", a trigger "when xyz money changes" and a condition "if xyz money is above / below …" does not make sense.

But a trigger "when xyz balance changes" and a condition "if xyz balance is above / below …" sound like the logical way to work with such a device class.

@home-assistant home-assistant bot marked this pull request as draft November 21, 2024 20:37
@home-assistant
Copy link

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.

@NoRi2909 NoRi2909 requested a review from frenck November 21, 2024 21:25
@NoRi2909 NoRi2909 marked this pull request as ready for review November 22, 2024 10:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Inconsistent naming of MONETARY sensor strings
2 participants