Add SwitchBot WWHA for Bluetooth #39731
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull Request Overview
This pull request adds metadata and documentation to highlight SwitchBot devices certified for Bluetooth in Home Assistant.
- Introduces a new
works_withmetadata field for Bluetooth compatibility. - Adds a Works with Home Assistant section listing Bluetooth-certified SwitchBot devices.
- Updates cross-link to the Matter-certified devices page.
Comments suppressed due to low confidence (3)
source/_integrations/switchbot.markdown:23
- The
works_withmetadata field is not in our documented schema for integration pages. Please verify if this key is supported or use an existing field (e.g.,ha_device_support) to indicate Bluetooth compatibility.
works_with:
source/_integrations/switchbot.markdown:170
- [nitpick] The section title "Works with Home Assistant" may confuse readers, as it suggests Home Assistant compatibility rather than listing SwitchBot devices. Consider renaming to "## Certified Bluetooth devices" or similar.
## Works with Home Assistant
source/_integrations/switchbot.markdown:189
- The markdown link to
switchbot_matter.markdownmay not resolve correctly in the site. Update it to the proper URL path (e.g.,[/integrations/switchbot_matter](/integrations/switchbot_matter)or include the.htmlextension) to ensure navigation works.
To see the list of SwitchBot Matter certified devices, visit the [SwitchBot Matter](switchbot_matter.markdown) page.
📝 WalkthroughWalkthroughThe documentation for the SwitchBot integration was updated to include a new Changes
Sequence Diagram(s)No sequence diagram generated as the changes are limited to documentation updates and metadata additions. 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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
source/_integrations/switchbot.markdown (1)
185-186: Possible broken URL for the Contact SensorThe slug is missing the
switchbot-prefix used by the rest of SwitchBot product URLs and by the earlier link in Supported devices.-- [SwitchBot Contact Sensor](https://www.switch-bot.com/products/contact-sensor) +- [SwitchBot Contact Sensor](https://www.switch-bot.com/products/switchbot-contact-sensor)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/switchbot.markdown(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`source/_integrations/*`: Integration documentation must use the provided template structure and section order.
source/_integrations/*: Integration documentation must use the provided template structure and section order.
📄 Source: CodeRabbit Inference Engine (.github/copilot-instructions.md)
List of files the instruction was applied to:
source/_integrations/switchbot.markdown
🪛 LanguageTool
source/_integrations/switchbot.markdown
[grammar] ~180-~180: This phrase is duplicated. You should probably use “SwitchBot Meter” only once.
Context: ...ducts/switchbot-water-leak-detector) - SwitchBot Meter - [SwitchBot Meter Pro](https://www.switch-bot.com/product...
(PHRASE_REPETITION)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/switchbot.markdown
176-176: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (1)
source/_integrations/switchbot.markdown (1)
23-24: ```shell
#!/usr/bin/env bashLocate the integration markdown template to inspect allowed front-matter keys
TEMPLATE=$(rg -l '_template' -R source/_integrations)
echo "Template file: $TEMPLATE"
sed -n '1,200p' "$TEMPLATE"</details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
| ## Works with Home Assistant | ||
|
|
||
| SwitchBot is committed to making sure their products are up-to-date and ready to use in Home Assistant. | ||
| Devices are certified for both Bluetooth and Matter. | ||
|
|
||
| The following devices are certified for Bluetooth: | ||
| - [SwitchBot Lock Ultra](https://www.switch-bot.com/products/switchbot-lock-ultra) | ||
| - [SwitchBot Air Purifier](https://www.switch-bot.com/products/switchbot-air-purifier) | ||
| - [SwitchBot Air Purifier Table](https://www.switch-bot.com/products/switchbot-air-purifier-table) | ||
| - [SwitchBot Leak Detector](https://www.switch-bot.com/products/switchbot-water-leak-detector) | ||
| - [SwitchBot Meter](https://www.switch-bot.com/products/switchbot-meter) | ||
| - [SwitchBot Meter Pro](https://www.switch-bot.com/products/switchbot-meter-pro) | ||
| - [SwitchBot Meter Pro CO2](https://www.switch-bot.com/products/switchbot-meter-pro-co2-monitor) | ||
| - [SwitchBot Indoor/Outdoor Thermo-Hygrometer](https://www.switch-bot.com/products/switchbot-indoor-outdoor-thermo-hygrometer) | ||
| - [SwitchBot Curtain 3](https://www.switch-bot.com/products/switchbot-curtain-3) | ||
| - [SwitchBot Contact Sensor](https://www.switch-bot.com/products/contact-sensor) | ||
| - [SwitchBot Roller Shade](https://www.switch-bot.com/products/switchbot-roller-shade) | ||
| - [SwitchBot Lock Pro](https://www.switch-bot.com/products/switchbot-lock-pro) | ||
|
|
||
| To see the list of SwitchBot Matter certified devices, visit the [SwitchBot Matter](switchbot_matter.markdown) page. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
List needs blank-line padding – fails markdownlint (MD032)
The bullet list is missing the mandatory blank line before and after the list, triggering MD032.
Devices are certified for both Bluetooth and Matter.
+
+The following devices are certified for Bluetooth:
+
+- [SwitchBot Lock Ultra](https://www.switch-bot.com/products/switchbot-lock-ultra)
...
-- [SwitchBot Lock Pro](https://www.switch-bot.com/products/switchbot-lock-pro)
-
-To see the list of SwitchBot Matter certified devices, visit the [SwitchBot Matter](switchbot_matter.markdown) page.
+- [SwitchBot Lock Pro](https://www.switch-bot.com/products/switchbot-lock-pro)
+
+To see the list of SwitchBot Matter certified devices, visit the [SwitchBot Matter](switchbot_matter.markdown) page.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## Works with Home Assistant | |
| SwitchBot is committed to making sure their products are up-to-date and ready to use in Home Assistant. | |
| Devices are certified for both Bluetooth and Matter. | |
| The following devices are certified for Bluetooth: | |
| - [SwitchBot Lock Ultra](https://www.switch-bot.com/products/switchbot-lock-ultra) | |
| - [SwitchBot Air Purifier](https://www.switch-bot.com/products/switchbot-air-purifier) | |
| - [SwitchBot Air Purifier Table](https://www.switch-bot.com/products/switchbot-air-purifier-table) | |
| - [SwitchBot Leak Detector](https://www.switch-bot.com/products/switchbot-water-leak-detector) | |
| - [SwitchBot Meter](https://www.switch-bot.com/products/switchbot-meter) | |
| - [SwitchBot Meter Pro](https://www.switch-bot.com/products/switchbot-meter-pro) | |
| - [SwitchBot Meter Pro CO2](https://www.switch-bot.com/products/switchbot-meter-pro-co2-monitor) | |
| - [SwitchBot Indoor/Outdoor Thermo-Hygrometer](https://www.switch-bot.com/products/switchbot-indoor-outdoor-thermo-hygrometer) | |
| - [SwitchBot Curtain 3](https://www.switch-bot.com/products/switchbot-curtain-3) | |
| - [SwitchBot Contact Sensor](https://www.switch-bot.com/products/contact-sensor) | |
| - [SwitchBot Roller Shade](https://www.switch-bot.com/products/switchbot-roller-shade) | |
| - [SwitchBot Lock Pro](https://www.switch-bot.com/products/switchbot-lock-pro) | |
| To see the list of SwitchBot Matter certified devices, visit the [SwitchBot Matter](switchbot_matter.markdown) page. | |
| ## Works with Home Assistant | |
| SwitchBot is committed to making sure their products are up-to-date and ready to use in Home Assistant. | |
| Devices are certified for both Bluetooth and Matter. | |
| The following devices are certified for Bluetooth: | |
| - [SwitchBot Lock Ultra](https://www.switch-bot.com/products/switchbot-lock-ultra) | |
| - [SwitchBot Air Purifier](https://www.switch-bot.com/products/switchbot-air-purifier) | |
| - [SwitchBot Air Purifier Table](https://www.switch-bot.com/products/switchbot-air-purifier-table) | |
| - [SwitchBot Leak Detector](https://www.switch-bot.com/products/switchbot-water-leak-detector) | |
| - [SwitchBot Meter](https://www.switch-bot.com/products/switchbot-meter) | |
| - [SwitchBot Meter Pro](https://www.switch-bot.com/products/switchbot-meter-pro) | |
| - [SwitchBot Meter Pro CO2](https://www.switch-bot.com/products/switchbot-meter-pro-co2-monitor) | |
| - [SwitchBot Indoor/Outdoor Thermo-Hygrometer](https://www.switch-bot.com/products/switchbot-indoor-outdoor-thermo-hygrometer) | |
| - [SwitchBot Curtain 3](https://www.switch-bot.com/products/switchbot-curtain-3) | |
| - [SwitchBot Contact Sensor](https://www.switch-bot.com/products/contact-sensor) | |
| - [SwitchBot Roller Shade](https://www.switch-bot.com/products/switchbot-roller-shade) | |
| - [SwitchBot Lock Pro](https://www.switch-bot.com/products/switchbot-lock-pro) | |
| To see the list of SwitchBot Matter certified devices, visit the [SwitchBot Matter](switchbot_matter.markdown) page. |
🧰 Tools
🪛 LanguageTool
[grammar] ~180-~180: This phrase is duplicated. You should probably use “SwitchBot Meter” only once.
Context: ...ducts/switchbot-water-leak-detector) - SwitchBot Meter - [SwitchBot Meter Pro](https://www.switch-bot.com/product...
(PHRASE_REPETITION)
🪛 markdownlint-cli2 (0.17.2)
176-176: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
🤖 Prompt for AI Agents
In source/_integrations/switchbot.markdown around lines 170 to 189, the bullet
list of Bluetooth certified devices lacks a blank line before and after it,
causing markdownlint error MD032. Add a blank line immediately before the first
bullet point and another blank line immediately after the last bullet point to
properly separate the list from surrounding text.
Proposed change
Add SwitchBot WWHA for Bluetooth
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit