Add humidifer and led for switchbot integration #39722
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThe documentation for the SwitchBot integration was updated to include support for new device types and features. Additions include a new "Humidifier" category and platform, expanded lists of supported light and humidifier devices, and detailed feature descriptions for these devices. No code or control flow changes were made. Changes
Sequence Diagram(s)No sequence diagram generated as the changes are documentation-only and do not affect control flow or introduce new features requiring diagrammatic representation. 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: 0
🧹 Nitpick comments (6)
source/_integrations/switchbot.markdown (6)
4-13: Category list now out-of-orderThe template keeps
ha_categoryalphabetically sorted. After inserting “Humidifier”, the order is now
Binary sensor, Cover, Fan, Humidifier, Light, Lock... – but “Fan” should follow “Cover” alphabetically.
Re-sort to keep parity with the rest of the docs.- - Binary sensor - - Cover - - Fan - - Humidifier + - Binary sensor + - Cover + - Fan + - Humidifier - Light - Lock - Sensor - Switch - Vacuum
25-35:ha_platformslist also needs alphabetical orderingFor the same reason as above: keep the platform keys in sorted order to avoid future merge conflicts and follow the integration template.
- - fan - - humidifier - - light + - fan + - humidifier + - light(only the insertion point needs to move; other lines unchanged).
118-125: Lights sub-list no longer alphabeticalNew items “Strip Light 3” and “Floor Lamp” were appended, breaking the alphabetical sequence (and numeric suffix “3” belongs next to its family). Consider re-ordering:
- - [Light Strip (WoStrip)](...) - - [Smart Ceiling Light (WoCeiling)](...) - - [Strip Light 3](...) - - [Floor Lamp](...) + - [Floor Lamp](...) + - [Light Strip (WoStrip)](...) + - [Smart Ceiling Light (WoCeiling)](...) + - [Strip Light 3](...)
133-137: Double-space typoThere is an extra space before “Evaporative”, breaking some parsers and linters.
- Humidifier and Evaporative Humidifier. + Humidifier and Evaporative Humidifier.
429-452: Minor consistency & English fixes in new light device sections
- Bullet list for
Floor Lamplacks a blank line above, triggering MD032.- “change color temperature” bullet exists for Strip Light 3 but not for LED Strip Light earlier; ensure parity if technically supported.
-#### Floor Lamp - -This is an encrypted device. - -Features: - -- turn on or off -- change brightness -- change color temperature -- change color -- set effect +#### Floor Lamp + +This is an encrypted device. + +Features: + + - turn on or off + - change brightness + - change color temperature + - change color + - set effect(The added space before the first bullet satisfies MD032.)
577-601: Grammar & clarity improvements for the new Humidifier sectionA couple of small issues:
- “Not all modes support unless …” → “Not all modes are supported unless …”
- Lists need a blank line before/after per MD032.
-This is an encrypted device. -Note: Not all modes support unless you bind the temperature and humidity sensor. +This is an encrypted device. +Note: Not all modes are supported unless you bind a temperature and humidity sensor. -Features: - -- turn on -- turn off -- set mode -- set humidity +Features: + + - turn on + - turn off + - set mode + - set humidity
📜 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(15 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
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/switchbot.markdown
414-414: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
🪛 LanguageTool
source/_integrations/switchbot.markdown
[uncategorized] ~593-~593: Possible missing comma found.
Context: ...n encrypted device. Note: Not all modes support unless you bind the temperature and hum...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ 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
📝 WalkthroughWalkthroughThe documentation for the SwitchBot integration was updated to include support for new device types and features. Additions include new light and humidifier devices, expanded feature lists, and the introduction of the "Humidifier" platform and category. Formatting improvements were also made for clarity. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant HomeAssistant
participant SwitchBotIntegration
User->>HomeAssistant: Adds/Configures SwitchBot integration
HomeAssistant->>SwitchBotIntegration: Discovers supported devices
SwitchBotIntegration-->>HomeAssistant: Reports devices (Lights, Humidifiers, etc.)
HomeAssistant->>User: Displays new device types (Strip Light 3, Floor Lamp, Evaporative Humidifier)
User->>HomeAssistant: Controls device (on/off, brightness, mode, humidity, etc.)
HomeAssistant->>SwitchBotIntegration: Sends control command
SwitchBotIntegration-->>HomeAssistant: Updates device state
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: 0
🧹 Nitpick comments (7)
source/_integrations/switchbot.markdown (7)
25-35: Keepha_platformslist alphabetically sortedThe newly-added
humidifierentry makes the list slightly out of order (lightshould come afterhumidifier). Sorting keeps future merges conflict-free.- - fan - - humidifier - - light + - fan + - light + - humidifier
120-125: Re-order the “Lights” device list alphabetically
Floor Lampshould appear beforeLight Stripto keep the list consistent.- [Color Bulb (WoBulb)](https://switch-bot.com/pages/switchbot-color-bulb) - [Light Strip (WoStrip)](https://www.switchbot.jp/products/switchbot-strip-light) - [Smart Ceiling Light (WoCeiling)](https://www.switchbot.jp/products/switchbot-ceiling-light) - [Strip Light 3](https://www.switch-bot.com/products/switchbot-led-strip-light-3) - [Floor Lamp](https://www.switch-bot.com/products/switchbot-floor-lamp) +- [Floor Lamp](https://www.switch-bot.com/products/switchbot-floor-lamp) +- [Light Strip (WoStrip)](https://www.switchbot.jp/products/switchbot-strip-light)
133-137: Alphabetise the “Humidifiers” list
Evaporative Humidifier(E) should precedeHumidifier(H).- [Humidifier (WoHumi)](https://www.switchbot.jp/products/switchbot-smart-humidifier) - [Evaporative Humidifier](https://www.switch-bot.com/products/switchbot-evaporative-humidifier-auto-refill) + - [Evaporative Humidifier](https://www.switch-bot.com/products/switchbot-evaporative-humidifier-auto-refill) + - [Humidifier (WoHumi)](https://www.switchbot.jp/products/switchbot-smart-humidifier)
403-410: Add a trailing blank line after the list to satisfy MD032Markdown-lint warns when a list isn’t surrounded by blank lines. Insert one empty line after the last bullet.
- change color temperature +
429-440: Insert blank line after Strip Light 3 feature listSame MD032 issue as above; add a blank line after
- set effect.
441-452: Insert blank line after Floor Lamp feature listAdd an empty line after
- set effectto keep linter happy.
592-594: Fix grammar in the usage noteCurrent phrase is awkward and flagged by LanguageTool. Suggested wording:
-Note: Not all modes support unless you bind the temperature and humidity sensor. +Note: Not all modes are supported unless the humidifier is bound to a temperature and humidity 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(15 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
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/switchbot.markdown
414-414: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
🪛 LanguageTool
source/_integrations/switchbot.markdown
[uncategorized] ~593-~593: Possible missing comma found.
Context: ...n encrypted device. Note: Not all modes support unless you bind the temperature and hum...
(AI_HYDRA_LEO_MISSING_COMMA)
🔇 Additional comments (1)
source/_integrations/switchbot.markdown (1)
4-10: Verifyha_categoryentry for policy compliance
Humidifierwas added to theha_categorylist. Please double-check that this value is part of the officially-supported Home Assistant categories, including the exact casing, as the front-matter is validated by the docs build pipeline.
|
@c0ffeeca7 As i have changed the current branch for switchbot yestoday, and now i add new feature for next branch, Will this cause conflicts and affect the release of new versions? |
Proposed change
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit