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 sensors to Motionblinds BLE integration #114226

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

Conversation

LennP
Copy link
Contributor

@LennP LennP commented Mar 26, 2024

Proposed change

Add sensors to Motionblinds BLE integration (battery percentage, connection status, calibration status, signal strength).

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

Code owner commands

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

@LennP LennP changed the title Add sensors Add sensors to Motionblinds BLE integration Mar 26, 2024
homeassistant/components/motionblinds_ble/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/motionblinds_ble/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/motionblinds_ble/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/motionblinds_ble/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/motionblinds_ble/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/motionblinds_ble/sensor.py Outdated Show resolved Hide resolved
Comment on lines 42 to 58
"connection": {
"name": "Connected",
"state": {
"connected": "Yes",
"disconnected": "No",
"connecting": "Connecting...",
"disconnecting": "Disconnecting..."
}
},
"calibration": {
"name": "Calibrated",
"state": {
"calibrated": "Yes",
"uncalibrated": "No",
"calibrating": "Calibrating..."
}
},
Copy link
Member

Choose a reason for hiding this comment

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

I think these entities could be more descriptive in their value.

Name: connectivity
connected
disconnected
connecting
disconnecting

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Personally I think "Connectivity: Connected" is a bit too verbose. The majority of times, currently it will say "Connected: Yes" or "Connected: No" which I think is nicer. "Connecting" and "Disconnecting" are kind of transitioning states to provide the user with a bit more information on what is happening

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's why I opted for "Yes"/"No", I think it's easier to read

Copy link
Member

Choose a reason for hiding this comment

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

It might look good on a dashboard, but it's horrible for automating and templating

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Don't you use the key for automation and not the translation? For the majority of users I personally think this is the best option. "Connected: Yes" in my opinion is much easier to process (and not to mention translate to other languages) than something like "Connectivity: Connected"

        "state": {
          "connected": "Yes",
          "disconnected": "No",
          "connecting": "Connecting...",
          "disconnecting": "Disconnecting..."
        }

Copy link
Member

Choose a reason for hiding this comment

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

For this one I'm looking to the connectivity device class, which is used in the binary sensors and looks like connectivity - connected - disconnected. Even tho this provides own translations I still think they should be in line with the translations other integrations use

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What about:

      "connection": {
        "name": "Connection",
        "state": {
          "connected": "Connected",
          "disconnected": "Disconnected",
          "connecting": "Connecting",
          "disconnecting": "Disconnecting"
        }
      },

But as you know this may result in longer translations in other languages, where in Dutch you would probably get "Verbinding: Verbonden", as opposed to "Verbonden: Ja". I still prefer the latter but if you want the former I will change it

Copy link
Member

Choose a reason for hiding this comment

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

You could do Connection status

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed it, please check

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I hope "Connection status: Disconnecting..." fits in the sensor entity?

requirements_all.txt Outdated Show resolved Hide resolved
homeassistant/components/motionblinds_ble/sensor.py Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft March 26, 2024 10:04
@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.

@LennP LennP requested a review from joostlek March 26, 2024 10:59
@LennP LennP marked this pull request as ready for review March 26, 2024 10:59
@LennP LennP force-pushed the motionblinds_ble_sensor_pr branch from 82bac04 to 5984401 Compare March 26, 2024 12:31
@LennP LennP force-pushed the motionblinds_ble_sensor_pr branch from 5984401 to 4d54c56 Compare March 27, 2024 10:32
@home-assistant home-assistant bot marked this pull request as draft March 27, 2024 16:41
@LennP LennP force-pushed the motionblinds_ble_sensor_pr branch from 24e30e7 to 5d070c7 Compare March 27, 2024 17:01
@LennP LennP requested a review from edenhaus March 27, 2024 17:10
@LennP LennP marked this pull request as ready for review March 27, 2024 17:10
@LennP LennP force-pushed the motionblinds_ble_sensor_pr branch 3 times, most recently from 8635ec5 to 2f8f3a3 Compare April 12, 2024 09:56
@LennP LennP force-pushed the motionblinds_ble_sensor_pr branch from 2f8f3a3 to bd0e763 Compare April 12, 2024 11:45
homeassistant/components/motionblinds_ble/strings.json Outdated Show resolved Hide resolved
homeassistant/components/motionblinds_ble/strings.json Outdated Show resolved Hide resolved
homeassistant/components/motionblinds_ble/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/motionblinds_ble/strings.json Outdated Show resolved Hide resolved
Copy link
Member

@joostlek joostlek left a comment

Choose a reason for hiding this comment

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

wrong button

@home-assistant home-assistant bot marked this pull request as draft June 5, 2024 10:40
LennP and others added 4 commits June 6, 2024 10:40
Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>
Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>
Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>
Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>
@LennP LennP requested a review from joostlek June 6, 2024 08:41
@LennP LennP marked this pull request as ready for review June 6, 2024 08:41
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.

None yet

3 participants