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 myuplink binary_sensor platform #110388

Merged

Conversation

astrandb
Copy link
Contributor

@astrandb astrandb commented Feb 12, 2024

Breaking change

Proposed change

Some device_points should be added as binary sensors instead of as ordinary sensors.
This PR will analyze the meta-data from API and if a device_point can have exactly two values (0 or 1) a binary sensor will be created.

Side-effect: The new binary sensors will be accompanied by stale sensors with same name after first run of this version. The user can delete these stale sensors manually from the UI but a better solution would be to delete them automatically.

This is no problem for the platforms that are included in HA 2024.3. After that, there can be stale entities when new platforms are merged or the filtering criteria are changed.

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

To help with the load of incoming pull requests:

@home-assistant
Copy link

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

Code owner commands

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

@pajzo
Copy link
Contributor

pajzo commented Feb 12, 2024

@astrandb just a side note, I'm planning adding system notifications as binary sensor also, but will await this PR to be merged.

@astrandb
Copy link
Contributor Author

@astrandb just a side note, I'm planning adding system notifications as binary sensor also, but will await this PR to be merged.

Excellent!
The notifications appear on the systemId level and not on the device_id level. Same for hasAlarm and perhaps some more.
Perhaps we should create a System device with the current "Device-devices" linked in the HA device hierarcy. You add a via_device keyword on the "Device-device" device_info attribute.

@MartinHjelmare
Copy link
Member

MartinHjelmare commented Feb 12, 2024

Side-effect: The new binary sensors will be accompanied by stale sensors with same name after first run of this version. The user can delete these stale sensors manually from the UI but a better solution would be to delete them automatically.

We haven't released any entities under the wrong platform yet, as far as I know, so we won't generate any stale entities if we release this approach with matching platforms in the March release.

@astrandb
Copy link
Contributor Author

astrandb commented Feb 12, 2024

That's correct. It is only super-early adopters that are running the dev branch that will see some garbage. But they can cleanup themselves.
I hope that we manage to add binary_sensors and switches and perhaps numbers before March. Climate and select will come later when we have more diagnostic data from other systems.

@astrandb astrandb marked this pull request as ready for review February 12, 2024 19:46
Copy link
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.

Please add tests or exclude the new modules from coverage calculation via entries in .coveragerc.

homeassistant/components/myuplink/binary_sensor.py Outdated Show resolved Hide resolved
homeassistant/components/myuplink/binary_sensor.py Outdated Show resolved Hide resolved
@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.

@home-assistant home-assistant bot marked this pull request as draft February 13, 2024 13:56
@astrandb
Copy link
Contributor Author

I prefer to wait with the tests until the structure is sorted out according to your comments. Then it will be a breeze to add them.

@astrandb astrandb marked this pull request as ready for review February 13, 2024 14:21
Copy link
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 MartinHjelmare merged commit e2ff5bc into home-assistant:dev Feb 13, 2024
23 checks passed
astrandb added a commit to astrandb/core-akefork that referenced this pull request Feb 13, 2024
* Add binary_sensor platform

* Address review comments

* Add one file more to .coveragerc
@github-actions github-actions bot locked and limited conversation to collaborators Feb 14, 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.

None yet

3 participants