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 support for Bot in SwitchBot Cloud #135606

Draft
wants to merge 4 commits into
base: dev
Choose a base branch
from

Conversation

mckbrmn
Copy link

@mckbrmn mckbrmn commented Jan 14, 2025

Proposed change

Adds support for SwitchBot Bots (in SwitchBot Cloud) both as switches for Bots in switchMode and customizeMode, as well as buttons for Bots in pressMode.

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:

Copy link

@home-assistant home-assistant bot left a comment

Choose a reason for hiding this comment

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

Hi @mckbrmn

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

@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 January 14, 2025 14:58
@home-assistant
Copy link

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

Code owner commands

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

Comment on lines -138 to +147
await hass.config_entries.async_forward_entry_setups(config, PLATFORMS)
await gather(
*[coordinator.async_refresh() for coordinator in coordinators_by_id.values()]
)
await hass.config_entries.async_forward_entry_setups(config, PLATFORMS)
Copy link
Member

Choose a reason for hiding this comment

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

This change is correct, but we should do this in a separate PR

Copy link
Author

Choose a reason for hiding this comment

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

PR opened: #135625

Comment on lines +100 to +107
if "Bot" in device.device_type:
if (
coordinator.data is not None
and coordinator.data.get("deviceMode") == "pressMode"
):
# pressMode Bots are handled by the Button platform
return None
return SwitchBotCloudSwitch(api, device, coordinator)
Copy link
Member

Choose a reason for hiding this comment

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

Why is this here? The switch platform doesn't create things for the Bot right?

Copy link
Author

Choose a reason for hiding this comment

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

Bots can be configured to behaved in two different modes:

  • in switchMode, there are two actions, on (the little arm goes out and stays out) and off (the little arm goes back in and stays in)
  • in pressMode, there is only one action: the little arm comes out and immediately goes back in.

(there's a third mode customizeMode that has the same actions as switchMode but the behavior is customizable).

I've mapped the switchMode/customizeMode to the switch platform and the pressMode to the button platform.

@home-assistant home-assistant bot marked this pull request as draft January 14, 2025 16:34
@@ -111,6 +113,10 @@ def make_device_data(
devices_data.locks.append(
prepare_device(hass, api, device, coordinators_by_id)
)
if isinstance(device, Device) and device.device_type in ["Bot"]:
devices_data.buttons.append(
Copy link
Contributor

Choose a reason for hiding this comment

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

buttons is never used. the button platform is using switches instead. is this needed?

Copy link
Author

Choose a reason for hiding this comment

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

It was a mistake on my part, I've updated the button platform code to use buttons

@mckbrmn mckbrmn force-pushed the switchbot-cloud-bot branch from d67d159 to 1575c00 Compare January 14, 2025 21:59
@mckbrmn mckbrmn force-pushed the switchbot-cloud-bot branch from 1575c00 to 949d308 Compare January 14, 2025 22:55
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.

3 participants