Add docs for proposed new intergration: Hue BLE #33042
Conversation
home-assistant
bot
added
has-parent
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
c0ffeeca7
added
the
new-integration
|
@flip-dots, please link the related brands PR. |
|
I updated the request with the brands PR but ill put it here for convinience as well |
📝 WalkthroughWalkthroughThe pull request introduces a new integration for controlling Philips Hue Bluetooth lights within Home Assistant, named "Hue BLE." It includes comprehensive documentation detailing setup instructions, the necessity of pairing mode via the Hue app, and supported models like the Hue White and Color 1100 (LCA006). The integration supports local push communication and Bluetooth connectivity, with a configuration flow available through the Home Assistant interface. Changes
Sequence DiagramsequenceDiagram
participant User
participant HueApp
participant HomeAssistant
participant HueBLELight
User->>HueApp: Put light in pairing mode
HueApp->>HueBLELight: Enable Bluetooth discovery
User->>HomeAssistant: Start integration setup
HomeAssistant->>HueBLELight: Discover and connect via Bluetooth
HueBLELight-->>HomeAssistant: Establish connection
HomeAssistant->>User: Integration setup complete
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (6)
source/_integrations/hue_ble.markdown (6)
3-3: Improve the description field.The description contains a typo in "Phillips" (should be "Philips") and could be more descriptive about the integration's capabilities.
-description: Instructions on how to setup Phillips Hue Bluetooth lights within Home Assistant. +description: Instructions on how to integrate and control Philips Hue Bluetooth lights locally within Home Assistant.
18-18: Fix the brand name spelling.The brand name "Phillips" should be "Philips".
-The **Hue BLE** {% term integration %} allows you to control your Phillips Hue Bluetooth lights with Home Assistant. +The **Hue BLE** {% term integration %} allows you to control your Philips Hue Bluetooth lights with Home Assistant.🧰 Tools
🪛 LanguageTool
[uncategorized] ~18-~18: Did you mean “Philips Hue”?
Context: ...tegration %} allows you to control your Phillips Hue Bluetooth lights with Home Assistant. ...(EN_SIMPLE_REPLACE_PHILLIPS_HUE)
19-20: Remove extra blank line.There are multiple consecutive blank lines. Keep only one blank line for consistency.
- - +🧰 Tools
🪛 Markdownlint (0.37.0)
20-20: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
25-25: Improve sentence structure with proper punctuation.Add a comma after "Home Assistant" for better readability.
-Before trying to connect your light(s) to Home Assistant you must put the light(s) into pairing mode in the Hue app ([Android](https://play.google.com/store/apps/details?id=com.philips.lighting.hue2), [iOS](https://apps.apple.com/us/app/philips-hue/id1055281310)). +Before trying to connect your light(s) to Home Assistant, you must put the light(s) into pairing mode in the Hue app ([Android](https://play.google.com/store/apps/details?id=com.philips.lighting.hue2), [iOS](https://apps.apple.com/us/app/philips-hue/id1055281310)).🧰 Tools
🪛 LanguageTool
[uncategorized] ~25-~25: Possible missing comma found.
Context: ...trying to connect your light(s) to Home Assistant you must put the light(s) into pairing ...(AI_HYDRA_LEO_MISSING_COMMA)
38-39: Add instructions for reporting compatibility.Provide clear instructions on how users can report working models.
-This {% term integration %} is tested to work with the following models but has been designed to work with other models. If you have a different model and it is working, please let us know. +This {% term integration %} is tested to work with the following models but has been designed to work with other models. If you have a different model that works, please report it in the [Home Assistant Community Forum](https://community.home-assistant.io/) or create a pull request to update this documentation.
18-18: Add references to related PRs.For better traceability, add links to the related PRs in the core and brands repositories.
The **Hue BLE** {% term integration %} allows you to control your Philips Hue Bluetooth lights with Home Assistant. + +This integration is part of the following pull requests: +- [Core integration PR #118635](https://github.com/home-assistant/core/pull/118635) +- [Brands PR #5534](https://github.com/home-assistant/brands/pull/5534)🧰 Tools
🪛 LanguageTool
[uncategorized] ~18-~18: Did you mean “Philips Hue”?
Context: ...tegration %} allows you to control your Phillips Hue Bluetooth lights with Home Assistant. ...(EN_SIMPLE_REPLACE_PHILLIPS_HUE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/hue_ble.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/hue_ble.markdown
[uncategorized] ~18-~18: Did you mean “Philips Hue”?
Context: ...tegration %} allows you to control your Phillips Hue Bluetooth lights with Home Assistant. ...
(EN_SIMPLE_REPLACE_PHILLIPS_HUE)
[uncategorized] ~25-~25: Possible missing comma found.
Context: ...trying to connect your light(s) to Home Assistant you must put the light(s) into pairing ...
(AI_HYDRA_LEO_MISSING_COMMA)
🪛 Markdownlint (0.37.0)
source/_integrations/hue_ble.markdown
20-20: Expected: 1; Actual: 2
Multiple consecutive blank lines
(MD012, no-multiple-blanks)
⏰ 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/hue_ble.markdown (1)
45-49: LGTM!The removal instructions are clear and follow the standard documentation format.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
source/_integrations/hue_ble.markdown (3)
28-28: Add missing comma for better readability.Add a comma after "pairing mode" to improve sentence structure.
-When the light is in pairing mode you may proceed to connect to it with Home Assistant. +When the light is in pairing mode, you may proceed to connect to it with Home Assistant.🧰 Tools
🪛 LanguageTool
[uncategorized] ~28-~28: Possible missing comma found.
Context: ...erable**. When the light is in pairing mode you may proceed to connect to it with H...(AI_HYDRA_LEO_MISSING_COMMA)
37-38: Add link for reporting compatible models.Consider adding a link to guide users on where to report compatible models (e.g., GitHub issues or discussions).
-This {% term integration %} is tested to work with the following models but has been designed to work with other models. If you have a different model and it is working, please let us know. +This {% term integration %} is tested to work with the following models but has been designed to work with other models. If you have a different model and it is working, please [open an issue](https://github.com/home-assistant/core/issues/new?labels=integration%3A+hue_ble) to let us know.
18-18: Add reference to the brands repository PR.Consider adding a note about the integration's icons and logos being available through the brands repository.
The **Hue BLE** {% term integration %} allows you to control your Philips Hue Bluetooth lights with Home Assistant. +<div class='note'> +Icons and logos for this integration are available through the [brands repository](https://github.com/home-assistant/brands/pull/5534). +</div> +
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/hue_ble.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/hue_ble.markdown
[uncategorized] ~28-~28: Possible missing comma found.
Context: ...erable**. When the light is in pairing mode you may proceed to connect to it with H...
(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
🔇 Additional comments (4)
source/_integrations/hue_ble.markdown (4)
1-16: LGTM! Metadata is well-structured and complete.The YAML frontmatter contains all the necessary fields and follows Home Assistant's documentation standards.
18-18: LGTM! Introduction is clear and consistent.The introduction effectively describes the integration's purpose, and the naming convention "Hue BLE" is consistently used.
32-32: LGTM! Config flow section is properly placed.The configuration flow template is correctly included and appropriately positioned after the initial setup instructions.
44-48: LGTM! Removal instructions are clear and complete.The removal section correctly includes both custom instructions and the standard template.
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
Proposed change
This adds documentation for the proposed new integration HueBLE.
home-assistant/core#118635
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
New Features
Documentation