Skip to content

Make sun solar_rising a binary_sensor#140956

Merged
MartinHjelmare merged 6 commits into
home-assistant:devfrom
karwosts:sun_binary_sensor
Jun 2, 2025
Merged

Make sun solar_rising a binary_sensor#140956
MartinHjelmare merged 6 commits into
home-assistant:devfrom
karwosts:sun_binary_sensor

Conversation

@karwosts
Copy link
Copy Markdown
Member

@karwosts karwosts commented Mar 19, 2025

Proposed change

A sun sensor for solar_rising has been previously added, but it seems like this maybe should have been a binary sensor instead.

Its only state values are "True" or "False". It is just a mirroring of a boolean attribute.

It has no hints in automation editor for what values are valid. Testing "on", "true", "On", True etc will all give the wrong result for state comparison and may be confusing to users.

This PR adds a binary_sensor that mimics the existing sensor. I'm not sure what should be done with the existing sensor, if we should announce a plan to deprecate it, or just let both coexist, or yank it out with a breaking change.

Both old and new sensor are disabled by default.

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
Copy Markdown
Contributor

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

Code owner commands

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

@github-actions
Copy link
Copy Markdown

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
If you are the author of this PR, please leave a comment if you want to keep it open. Also, please rebase your PR onto the latest dev branch to ensure that it's up to date with the latest changes.
Thank you for your contribution!

@github-actions github-actions Bot added the stale label May 19, 2025
@karwosts
Copy link
Copy Markdown
Member Author

Still valid.

@github-actions github-actions Bot removed the stale label May 19, 2025
Copy link
Copy Markdown
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

Thanks! Since we already have a calculation for this state (rising), I think it's ok to add a binary sensor. It should have been a binary sensor from the beginning instead of a sensor.

Some small comments to address.

Comment thread homeassistant/components/sun/__init__.py Outdated
Comment thread homeassistant/components/sun/__init__.py Outdated
Comment thread homeassistant/components/sun/binary_sensor.py Outdated
Comment thread homeassistant/components/sun/binary_sensor.py Outdated
Comment thread homeassistant/components/sun/binary_sensor.py Outdated
Comment thread homeassistant/components/sun/binary_sensor.py Outdated
@home-assistant home-assistant Bot marked this pull request as draft May 26, 2025 11:27
@home-assistant
Copy link
Copy Markdown
Contributor

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.

@MartinHjelmare MartinHjelmare self-assigned this May 26, 2025
@karwosts
Copy link
Copy Markdown
Member Author

Updated as requested. CI fail seems unrelated.

@karwosts karwosts marked this pull request as ready for review May 26, 2025 14:41
@karwosts karwosts requested a review from a team as a code owner May 26, 2025 14:41
@home-assistant home-assistant Bot requested a review from MartinHjelmare May 26, 2025 14:41
Comment thread homeassistant/components/sun/strings.json Outdated
Comment thread homeassistant/components/sun/const.py Outdated
Copy link
Copy Markdown
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

Thanks!

@MartinHjelmare
Copy link
Copy Markdown
Member

Please link a user docs PR that updates the supported sensors:
https://www.home-assistant.io/integrations/sun/#sensors

@karwosts
Copy link
Copy Markdown
Member Author

@karwosts karwosts marked this pull request as ready for review May 27, 2025 19:28
@home-assistant home-assistant Bot requested a review from MartinHjelmare May 27, 2025 19:28
@MartinHjelmare MartinHjelmare merged commit 33fc700 into home-assistant:dev Jun 2, 2025
48 checks passed
@karwosts karwosts deleted the sun_binary_sensor branch June 2, 2025 12:15
@github-actions github-actions Bot locked and limited conversation to collaborators Jun 3, 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.

3 participants