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 DROP Alert product support #117867

Merged
merged 7 commits into from
Aug 21, 2024
Merged

Conversation

pfrazer
Copy link
Contributor

@pfrazer pfrazer commented May 21, 2024

Proposed change

Add support for a new DROP product: DROP Alert

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

Code owner commands

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

@@ -31,6 +31,7 @@
"pending_notification": { "name": "Notification unread" },
"reserve_in_use": { "name": "Reserve capacity in use" },
"salt": { "name": "Salt low" },
"alert_sensor": { "name": "Sensor" },
Copy link
Contributor

Choose a reason for hiding this comment

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

We should use a better name for it and not "Sensor", similar to "Leak detected"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The generic naming of the sensor input on this device is intentional based on the many ways that it can be used on a DROP system. For example, it can be used with a float switch to detect rising a water level in a sump pit, notify users that pump equipment has entered a fault state, detect water intrusion, or shut off the water due to a dry contact closure on an alarm panel. Because of this, the sensor input really doesn't have a better name that wouldn't be incorrect in some cases. We spent quite a bit of time considering alternatives when the marketing plan for the device was formed and decided it was better to be vague instead of misleading.

That being said, we're open to suggestions but haven't come up with anything that is an improvement.

@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 May 29, 2024 06:55
@pfrazer pfrazer marked this pull request as ready for review May 29, 2024 17:39
@home-assistant home-assistant bot requested a review from edenhaus May 29, 2024 17:39
@frenck frenck added the smash Indicator this PR is close to finish for merging or closing label Jul 7, 2024
@@ -31,6 +31,7 @@
"pending_notification": { "name": "Notification unread" },
"reserve_in_use": { "name": "Reserve capacity in use" },
"salt": { "name": "Salt low" },
"alert_sensor": { "name": "Sensor" },
Copy link
Contributor

Choose a reason for hiding this comment

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

Please keep the keys alphabetically sorted, it's annoying to have to go through the entire map to check if something is there or not.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Addressed in 0abb8e1

),
DROPBinarySensorEntityDescription(
key=POWER,
translation_key=POWER,
Copy link
Contributor

@emontnemery emontnemery Aug 2, 2024

Choose a reason for hiding this comment

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

Did you forget to add this to strings.json, or should it be alert_sensor here instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No, the power monitoring feature is separate from the alert_sensor input. We intend for the power monitoring sensor to simply be labeled 'Power', so no entry in strings.json is necessary.

Copy link
Contributor

Choose a reason for hiding this comment

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

OK, that makes sense. However, if the entity name is not translated, you should not set the translation_key.
Maybe something like this, so it's clear from the code it's intentional to not set the name.

    DROPBinarySensorEntityDescription(
        key=POWER,
        translation_key=None,  # Use name provided by binary sensor device class
        device_class=BinarySensorDeviceClass.POWER,
        value_fn=lambda device: device.drop_api.power(),
    ),

),
DROPBinarySensorEntityDescription(
key=POWER,
translation_key=POWER,
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
translation_key=POWER,
translation_key=None, # Use name provided by binary sensor device class

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changed in 36db6c6

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, @pfrazer 👍

@emontnemery emontnemery merged commit 5f53d3f into home-assistant:dev Aug 21, 2024
26 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.
Labels
by-code-owner cla-signed has-tests integration: drop_connect new-feature Quality Scale: No score small-pr PRs with less than 30 lines. smash Indicator this PR is close to finish for merging or closing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants