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 switch entity for Shelly scripts #108171

Draft
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

chemelli74
Copy link
Contributor

@chemelli74 chemelli74 commented Jan 16, 2024

Breaking change

Proposed change

Add switch entity to control all scripts running on a Shelly device (gen2)

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:

@home-assistant
Copy link

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

Code owner commands

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

@thecode thecode removed their request for review January 16, 2024 17:17
@bieniu
Copy link
Member

bieniu commented Jan 16, 2024

New entity seems to work properly.
obraz

But I think there is a problem with the name of the entity. For example, for the script aioshelly_ble_integration, the entity name is binary_sensor.aioshelly_ble_integration_script. If there are several devices and each of them has a script with the same name installed, we will end up with entity names with the suffixes: binary_sensor.aioshelly_ble_integration_script, binary_sensor.aioshelly_ble_integration_script_1, binary_sensor.aioshelly_ble_integration_script_2, etc.
I think the entity ID must contain the name of the device.

@thecode

This comment was marked as resolved.

@chemelli74
Copy link
Contributor Author

chemelli74 commented Jan 17, 2024

About the switch, seems a good idea.

Only concern I have is that a user can stop the script for BLE proxy and a restart of the device/HA will enable it as it's auto restarted upon connection.

Maybe we can have a binary_sensor and a button to toggle the status.

@bdraco
Copy link
Member

bdraco commented Jan 18, 2024

I think, adding disabled by default switches, makes a lot of sense here. I wouldn’t worry too much about them turning off the Bluetooth script as they can also do that on the device, and if they want to break it, that’s up to them to do.

@chemelli74
Copy link
Contributor Author

I would say, let's complete #106985 first, and then rework this to be a switch then.

@gjohansson-ST
Copy link
Member

Putting this to draft as rework is supposed to be done 👍

@gjohansson-ST gjohansson-ST marked this pull request as draft February 24, 2024 19:09

This comment was marked as outdated.

@github-actions github-actions bot added the stale label Apr 24, 2024
@chemelli74
Copy link
Contributor Author

avoid stale, waiting for rework

@github-actions github-actions bot removed the stale label Apr 24, 2024
@chemelli74 chemelli74 changed the title Add binary sensor for Shelly scripts Add switch entity for Shelly scripts May 17, 2024
@chemelli74 chemelli74 marked this pull request as ready for review May 17, 2024 13:38
"script": RpcSwitchDescription(
key="script",
sub_key="running",
entity_category=EntityCategory.DIAGNOSTIC,
Copy link
Member

Choose a reason for hiding this comment

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

Commenting so it is not accidently merged, as we discussed without changes entity_category doesn't work in this implementation.

"switch": RpcSwitchDescription(
key="switch",
sub_key="output",
entity_category=EntityCategory.CONFIG,
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
entity_category=EntityCategory.CONFIG,

This is the main device Switch output and not a config entity

@home-assistant home-assistant bot marked this pull request as draft May 23, 2024 21:33
@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.

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

6 participants