home-assistant.io
home-assistant.io copied to clipboard
Add docs for proposed new intergration: Hue BLE
Proposed change
This adds documentation for the proposed new integration HueBLE. https://github.com/home-assistant/core/pull/118635
Type of change
- [ ] Spelling, grammar or other readability improvements (
currentbranch). - [ ] Adjusted missing or incorrect information in the current documentation (
currentbranch). - [X] Added documentation for a new integration I'm adding to Home Assistant (
nextbranch).- [X] I've opened up a PR to add logos and icons in Brands repository.
- [ ] Added documentation for a new feature I'm adding to Home Assistant (
nextbranch). - [ ] Removed stale or deprecated documentation.
Additional information
- Link to parent pull request in the codebase: https://github.com/home-assistant/core/pull/118635
- Link to parent pull request in the Brands repository: https://github.com/home-assistant/brands/pull/5534
- This PR fixes or closes issue: fixes #
Checklist
- [X] This PR uses the correct branch, based on one of the following:
- I made a change to the existing documentation and used the
currentbranch. - I made a change that is related to an upcoming version of Home Assistant and used the
nextbranch.
- I made a change to the existing documentation and used the
- [X] The documentation follows the Home Assistant documentation standards.
Deploy Preview for home-assistant-docs ready!
| Name | Link |
|---|---|
| Latest commit | 8b5210553532b1b6988404a11c9d875e98370eb6 |
| Latest deploy log | https://app.netlify.com/projects/home-assistant-docs/deploys/68c950c295999e00084ae9f0 |
| Deploy Preview | https://deploy-preview-33042--home-assistant-docs.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify project configuration.
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks :+1:
@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 https://github.com/home-assistant/brands/pull/5534
📝 Walkthrough
Walkthrough
The 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
| File | Change Summary |
|---|---|
source/_integrations/hue_ble.markdown |
Added new integration documentation for Hue BLE lights, including setup instructions, supported models, and metadata details such as title, description, and release version. |
Sequence Diagram
sequenceDiagram
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?
🪧 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
@coderabbitaiin 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
@coderabbitaiin 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.
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 pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai generate docstringsto generate docstrings for this PR. (Beta)@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaior@coderabbitai titleanywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.