Skip to content

Switchbot_cloud: Binary Sensor for Lock's door state and calibration #38829

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 2 commits into
base: next
Choose a base branch
from
Open

Switchbot_cloud: Binary Sensor for Lock's door state and calibration #38829

wants to merge 2 commits into from

Conversation

mrueg
Copy link
Contributor

@mrueg mrueg commented Apr 30, 2025 •
edited by coderabbitai bot
Loading

Proposed change

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • Documentation
    • Updated SwitchBot Cloud integration documentation to include "binary_sensor" platform details.
    • Expanded prerequisites section with an additional reference link for more detailed setup guidance.

@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo next This PR goes into the next branch labels Apr 30, 2025
@mrueg mrueg mentioned this pull request Apr 30, 2025
Open
19 tasks
@netlify Netlify
Copy link

netlify bot commented Apr 30, 2025 •
edited
Loading

✅ Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 7abd496
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/681284ce22cb4f000899deba
😎 Deploy Preview https://deploy-preview-38829--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 30, 2025 •
edited
Loading

📝 Walkthrough

Walkthrough

The documentation for the SwitchBot Cloud integration was updated to reflect the addition of the "binary_sensor" platform in its metadata. The prerequisites section now includes a new reference link to a SwitchBot blog post for more detailed setup instructions. No changes were made to the integration's code or its public entities.

Changes

File Change Summary
source/_integrations/switchbot_cloud.markdown Added "binary_sensor" to ha_category and ha_platforms metadata; updated prerequisites with a new reference link.

Sequence Diagram(s)

No sequence diagram generated as the changes are limited to documentation updates.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot]
coderabbitai bot reviewed Apr 30, 2025
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
source/_integrations/switchbot_cloud.markdown (2)

5-5: Validate category naming for consistency
Ensure that the new entry “Binary sensor” follows the same naming conventions as other categories (e.g., “Sensor”, “Switch”). You may want to confirm whether it should be “Binary sensor” or “Binary Sensor” per the documentation style guide.

37-37: Simplify wording for clarity
The current phrasing is a bit verbose. Consider tightening the language and removing “in succession” for readability. For example:

-In order to use this integration, you will need at least a SwitchBot Hub and a SwitchBot account to get a token and secret key from the SwitchBot mobile app in **Profiles** > **Preferences** > **Developer Options**. If **Developer Options** is not present in preferences, tap the App Version (e.g. 6.24) several times (5~15 times) in succession to open the **Developer Options**. See also [SwitchBot's blog](https://blog.switch-bot.com/switchbot-x-home-assistant-the-official-setup-tips-guide-you-asked-for-3/#cloud-integration) for more information specific to the app.
+To use this integration, you need a SwitchBot Hub and a SwitchBot account to obtain a token and secret key via the mobile app (**Profiles** > **Preferences** > **Developer Options**). If **Developer Options** isn’t visible, tap the App Version (e.g., 6.24) 5–15 times to enable it. See [SwitchBot's blog](https://blog.switch-bot.com/switchbot-x-home-assistant-the-official-setup-tips-guide-you-asked-for-3/#cloud-integration) for more details.
🧰 Tools
🪛 LanguageTool

[style] ~37-37: ‘in succession’ might be wordy. Consider a shorter alternative.
Context: ... (e.g. 6.24) several times (515 times) in succession to open the Developer Options. See ...

(EN_WORDINESS_PREMIUM_IN_SUCCESSION)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 43f8e43 and 71e01f1.

📒 Files selected for processing (1)
  • source/_integrations/switchbot_cloud.markdown (3 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/switchbot_cloud.markdown

[style] ~37-37: ‘in succession’ might be wordy. Consider a shorter alternative.
Context: ... (e.g. 6.24) several times (515 times) in succession to open the Developer Options. See ...

(EN_WORDINESS_PREMIUM_IN_SUCCESSION)

🔇 Additional comments (1)
source/_integrations/switchbot_cloud.markdown (1)

22-22: Include binary_sensor platform
This correctly adds the binary_sensor platform to the integration metadata, reflecting the core PR’s new entities.

@mrueg mrueg force-pushed the switchbot-binary branch from 71e01f1 to 7abd496 Compare April 30, 2025 20:15
coderabbitai[bot]
coderabbitai bot reviewed Apr 30, 2025
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
source/_integrations/switchbot_cloud.markdown (1)

37-37: Refine wording in Prerequisites for clarity
The phrase “several times (5~15 times) in succession” is a bit verbose. Consider streamlining it for readability.

Proposed diff:

-In order to use this integration, you will need at least a SwitchBot Hub and a SwitchBot account to get a token and secret key from the SwitchBot mobile app in **Profiles** > **Preferences** > **Developer Options**. If **Developer Options** is not present in preferences, tap the App Version (e.g. 6.24) several times (5~15 times) in succession to open the **Developer Options**. See also [SwitchBot's blog](https://blog.switch-bot.com/switchbot-x-home-assistant-the-official-setup-tips-guide-you-asked-for-3/#cloud-integration) for more information specific to the app.
+In order to use this integration, you need at least a SwitchBot Hub and a SwitchBot account to get a token and secret key from the SwitchBot mobile app in **Profiles** > **Preferences** > **Developer Options**. If **Developer Options** isn’t visible, tap the App Version (e.g. 6.24) 5–15 times to open **Developer Options**. See also [SwitchBot's blog](https://blog.switch-bot.com/switchbot-x-home-assistant-the-official-setup-tips-guide-you-asked-for-3/#cloud-integration) for more information specific to the app.
🧰 Tools
🪛 LanguageTool

[style] ~37-37: ‘in succession’ might be wordy. Consider a shorter alternative.
Context: ... (e.g. 6.24) several times (515 times) in succession to open the Developer Options. See ...

(EN_WORDINESS_PREMIUM_IN_SUCCESSION)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 71e01f1 and 7abd496.

📒 Files selected for processing (1)
  • source/_integrations/switchbot_cloud.markdown (3 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/switchbot_cloud.markdown

[style] ~37-37: ‘in succession’ might be wordy. Consider a shorter alternative.
Context: ... (e.g. 6.24) several times (515 times) in succession to open the Developer Options. See ...

(EN_WORDINESS_PREMIUM_IN_SUCCESSION)

🔇 Additional comments (2)
source/_integrations/switchbot_cloud.markdown (2)

5-5: Approve addition of Binary Sensor category
Adding “Binary Sensor” to ha_category aligns the documentation with the new binary sensor platform introduced in core.

22-22: Approve addition of binary_sensor platform metadata
Including binary_sensor in ha_platforms correctly surfaces the new platform in Home Assistant’s UI.

c0ffeeca7
c0ffeeca7 approved these changes May 5, 2025
View reviewed changes
Copy link
Contributor

@c0ffeeca7 c0ffeeca7 left a comment

Choose a reason for hiding this comment

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

Thank you, @mrueg 👍

@c0ffeeca7 c0ffeeca7 added the awaits-parent Awaits the merge of an parent PR label May 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@c0ffeeca7 c0ffeeca7 c0ffeeca7 approved these changes

Assignees
No one assigned
Labels
awaits-parent Awaits the merge of an parent PR has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mrueg @c0ffeeca7