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

Fix state name for binary_sensor Power from clear/detected to on/off #116994

Merged
merged 1 commit into from
Aug 21, 2024

Conversation

JoramQ
Copy link
Contributor

@JoramQ JoramQ commented May 7, 2024

Proposed change

A binary sensor shown as "Power" was displayed as Clear/Detected

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.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

@JoramQ JoramQ requested a review from a team as a code owner May 7, 2024 13:00
Copy link

@home-assistant home-assistant bot left a comment

Choose a reason for hiding this comment

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

Hi @JoramQ

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

@home-assistant home-assistant bot marked this pull request as draft May 7, 2024 13:00
@home-assistant
Copy link

home-assistant bot commented May 7, 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.

@home-assistant
Copy link

home-assistant bot commented May 7, 2024

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

Code owner commands

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

@epenet
Copy link
Contributor

epenet commented May 7, 2024

It may have been on purpose, so I'm cc-ing @frenck / @joostlek as author/reviewer of original PR: #97084

@joostlek
Copy link
Member

joostlek commented May 7, 2024

I think there's a difference between being powered on and detecting power, the documentation points that its the latter

@JoramQ
Copy link
Contributor Author

JoramQ commented May 7, 2024

I am using Power to idicate a computer was turned on, has electricity. Therefore clear/detected sounds a bit strange to me. Its powered on/off. But i don't know other usecases of this Power so you might be right.

@MartinHjelmare MartinHjelmare changed the title Fixed state name for binary_sensor Power from clear/detected to on/off Fix state name for binary_sensor Power from clear/detected to on/off May 7, 2024
Copy link

@TiHiNi TiHiNi left a comment

Choose a reason for hiding this comment

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

Since this is a sensor, which job is to detect something, I think the existing description for on is correct and it should not be changed.

I don’t know if Clear in English is a good word for off. In German it is translated to normal, what assumed that it is not normal if power or gas is on. But that depends on the use case. In my opinion a sensor should not decide if the state is good or bad.

So, I would suggest something like undected or simple none.

@frenck : You made the old text, what do you think?

@TiHiNi
Copy link

TiHiNi commented May 17, 2024

I am using Power to idicate a computer was turned on, has electricity. Therefore clear/detected sounds a bit strange to me. Its powered on/off. But i don't know other usecases of this Power so you might be right.

Would not be running a better type for you?

@JoramQ
Copy link
Contributor Author

JoramQ commented May 20, 2024

i initially thought this needed to be fixed because the documentation is showing power (on/off)
https://www.home-assistant.io/integrations/binary_sensor/

I now do believe that a this sensor is for detecting if electricity is present, except power is watt so the name does not look perfect for me. But that might not be my problem. So for me this can stay as it is and we just need to update the documentation.

The main 'problem' that i now have that i want to show something as on/off(for whatever reason) but there is no possibility to do so if there is already a type defined. If there is already a type you can empty the selectbox but it goes back to default when you save. And the option "None" as in the documentation is not an option to choose. But this might be a new issue.

@frenck frenck marked this pull request as ready for review July 6, 2024 10:08
@frenck frenck added the smash Indicator this PR is close to finish for merging or closing label Jul 6, 2024
@frenck frenck self-assigned this Jul 6, 2024
@frenck frenck self-requested a review July 6, 2024 10:08
@emontnemery
Copy link
Contributor

I agree clear / detected is a bit strange for a sensor wher "On means power detected, Off means no power.", but On / Off also doesn't seem great.
Maybe "Powered" / "Not powered"?

@home-assistant home-assistant bot marked this pull request as draft August 9, 2024 10:14
@frenck
Copy link
Member

frenck commented Aug 9, 2024

Checked history, I made this mess. Sorry 🙏

It originally was On / Off; during moving translations from the frontend to the backend, I've messed up.

@joostlek joostlek removed the smash Indicator this PR is close to finish for merging or closing label Aug 20, 2024
@emontnemery emontnemery marked this pull request as ready for review August 21, 2024 11:37
@home-assistant home-assistant bot requested a review from joostlek August 21, 2024 11:37
Copy link
Contributor

@emontnemery emontnemery left a comment

Choose a reason for hiding this comment

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

Thanks, @JoramQ 👍

@emontnemery emontnemery merged commit fa5f471 into home-assistant:dev Aug 21, 2024
40 checks passed
raman325 added a commit to raman325/home-assistant that referenced this pull request Aug 22, 2024
* dev: (642 commits)
  Improve config flow type hints (part 4) (home-assistant#124348)
  Improve config flow type hints (part 1) (home-assistant#124343)
  Add tests for Bring integration (home-assistant#123087)
  Add DROP Alert product support (home-assistant#117867)
  update ttn_client - fix crash with SenseCAP devices (home-assistant#124370)
  Add Aranet Radon Plus support (home-assistant#124197)
  Fix Spotify Media Browsing fails for new config entries (home-assistant#124368)
  Convert Bang & Olufsen testing logging patches to caplog (home-assistant#124366)
  Remove unneeded check for Bang & Olufsen events and device update (home-assistant#124363)
  Bump async-interrupt to 1.2.0 (home-assistant#124360)
  Rename OpenThermGatewayDevice to OpenThermGatewayHub (home-assistant#124361)
  Fix Weatherflow Cloud lightning (home-assistant#124082)
  Change POWER_VOLT_AMPERE_REACTIVE to UnitOfReactivePower (home-assistant#117153)
  Disable Habitica deprecated entities by default (home-assistant#123522)
  Add test cases for ViCare entities (home-assistant#122983)
  Add tests for IronOS integration (home-assistant#123078)
  Fix state name for binary_sensor Power from clear/detected to on/off (home-assistant#116994)
  Extend blebox shutterbox tilt support (home-assistant#110547)
  blebox: use blebox_uniapi.cover.BleboxCoverState enum members instead of plain integers (home-assistant#124302)
  Add custom panel for LCN configuration (home-assistant#108664)
  ...
@github-actions github-actions bot locked and limited conversation to collaborators Aug 22, 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.

6 participants