Skip to content

Fix SwitchBot Blind Tilt KeyError on idle BLE advertisements#172816

Draft
frenck wants to merge 1 commit into
devfrom
frenck-2026-0655
Draft

Fix SwitchBot Blind Tilt KeyError on idle BLE advertisements#172816
frenck wants to merge 1 commit into
devfrom
frenck-2026-0655

Conversation

@frenck
Copy link
Copy Markdown
Member

@frenck frenck commented Jun 2, 2026

Proposed change

SwitchBotBlindTiltEntity._handle_coordinator_update crashes with KeyError: 'motionDirection' on every BLE advertisement when the blind tilt is idle, because idle devices don't include the motionDirection key in their parsed BLE data.

Use self._device.is_opening() / self._device.is_closing() instead of direct dict access, matching the pattern used by all other SwitchBot cover entities in the same file (SwitchBotCurtainEntity, SwitchBotRollerShadeEntity, etc.).

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

  • I understand the code I am submitting and can explain how it works.
  • 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.
  • Any generated code has been carefully reviewed for correctness and compliance with project standards.

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 diff between library versions and ideally a link to the changelog/release notes is added to the PR description.

To help with the load of incoming pull requests:

Copilot AI review requested due to automatic review settings June 2, 2026 08:16
@frenck frenck requested a review from Danielhiversen as a code owner June 2, 2026 08:16
@home-assistant home-assistant Bot added bugfix cla-signed has-tests integration: switchbot small-pr PRs with less than 30 lines. Top 200 Integration is ranked within the top 200 by usage labels Jun 2, 2026
@home-assistant
Copy link
Copy Markdown
Contributor

home-assistant Bot commented Jun 2, 2026

Hey there @Danielhiversen, @RenierM26, @murtas, @Eloston, @dsypniewski, @zerzhang, mind taking a look at this pull request as it has been labeled with an integration (switchbot) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of switchbot can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant mark-draft Mark the pull request as draft.
  • @home-assistant ready-for-review Remove the draft status from the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign switchbot Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant update-branch Update the pull request branch with the base branch.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) on the pull request.

@frenck frenck added this to the 2026.6.0 milestone Jun 2, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Fixes a KeyError: 'motionDirection' raised on every BLE advertisement for idle SwitchBot Blind Tilt devices by replacing direct dict access with the device's is_opening() / is_closing() helpers, matching the pattern already used by other cover entities in the same module.

Changes:

  • Replace self.parsed_data["motionDirection"][...] with self._device.is_opening() / is_closing() in SwitchBotBlindTiltEntity._handle_coordinator_update.
  • Add a regression test that injects an idle advertisement (no motionDirection) and asserts the entity remains available.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
homeassistant/components/switchbot/cover.py Use device helpers instead of dict access to avoid KeyError on idle advertisements.
tests/components/switchbot/test_cover.py New test verifying blind tilt entity survives BLE advertisement lacking motionDirection.

Comment on lines +417 to +420
with patch(
"homeassistant.components.switchbot.cover.switchbot.SwitchbotBlindTilt.get_basic_info",
return_value=info_idle,
):
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Please correct me if I am wrong, but isn't this the same patch as on L405? Nothing really changed to info_idle so this statement doesn't really do much

@home-assistant
Copy link
Copy Markdown
Contributor

home-assistant Bot commented Jun 2, 2026

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 June 2, 2026 11:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bugfix cla-signed has-tests integration: switchbot Quality Scale: gold small-pr PRs with less than 30 lines. Top 200 Integration is ranked within the top 200 by usage

Projects

None yet

Development

Successfully merging this pull request may close these issues.

SwitchBot Blind Tilt: KeyError motionDirection when BLE advertisement lacks motion data

4 participants