Skip to content
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.

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

Document Xiaomi Cloud method is now available to get bindkeys for v4/v5 devices #35328

Merged
merged 2 commits into from
Oct 22, 2024

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Oct 22, 2024

Proposed change

Document Xiaomi Cloud method is now available to get bindkeys for v4/v5 devices

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

  • New Features

    • Added integration instructions for Xiaomi BLE devices in Home Assistant, supporting MiBeacon, MiScales, and MiFora protocols.
    • Enabled real-time tracking of sensor values to conserve battery life.
    • Included specific instructions for the MiFlora plant sensor, including firmware updates and battery level access conditions.
  • Documentation

    • Detailed encryption methods and compatibility notes for using custom firmware with Xiaomi devices, including bindkey acquisition methods.

@home-assistant home-assistant bot added Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest! has-parent This PR has a parent PR in a other repo next This PR goes into the next branch labels Oct 22, 2024
Copy link

netlify bot commented Oct 22, 2024

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 781113d
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/67176b51fe97a500081bfe5e
😎 Deploy Preview https://deploy-preview-35328--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.

@bdraco bdraco marked this pull request as ready for review October 22, 2024 03:08
@bdraco bdraco requested review from Jc2k and Ernst79 as code owners October 22, 2024 03:08
Copy link
Contributor

coderabbitai bot commented Oct 22, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes involve an update to the documentation for integrating Xiaomi BLE devices with Home Assistant. It details the supported protocols, device types, and the operation of the integration, which listens for Bluetooth broadcasts to track sensor values. The document also covers encryption methods, device-specific instructions, and compatibility issues with the Mi Home app.

Changes

File Change Summary
source/_integrations/xiaomi_ble.markdown Updated integration instructions for Xiaomi BLE devices, including supported protocols, encryption methods, and device-specific guidance for MiFlora sensors.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HomeAssistant
    participant XiaomiBLEDevice

    User->>HomeAssistant: Requests sensor data
    HomeAssistant->>XiaomiBLEDevice: Listens for Bluetooth broadcasts
    XiaomiBLEDevice-->>HomeAssistant: Sends sensor values
    HomeAssistant-->>User: Provides real-time sensor data
Loading

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 99ae592 and 781113d.

📒 Files selected for processing (1)
  • source/_integrations/xiaomi_ble.markdown (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • source/_integrations/xiaomi_ble.markdown

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?

❤️ 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.

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 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.

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

🧹 Outside diff range and nitpick comments (1)
source/_integrations/xiaomi_ble.markdown (1)

40-40: Excellent addition of new bindkey retrieval method.

The new information about obtaining bindkeys for v4 and v5 devices using Xiaomi Cloud account credentials is a valuable addition to the documentation. It provides users with an easier method to set up their devices.

Consider adding a brief note about the security implications of providing cloud credentials, and whether this process is done securely within Home Assistant. This would help users make an informed decision about using this method.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 97e61d6 and 99ae592.

📒 Files selected for processing (1)
  • source/_integrations/xiaomi_ble.markdown (1 hunks)
🧰 Additional context used
🔇 Additional comments (1)
source/_integrations/xiaomi_ble.markdown (1)

Line range hint 1-100: Overall document structure and content is excellent.

The document is well-organized, providing comprehensive information about the Xiaomi BLE integration, including supported protocols, encryption methods, and device-specific instructions. The new content about obtaining bindkeys using Xiaomi Cloud credentials fits seamlessly into the existing structure.

@Jc2k
Copy link
Member

Jc2k commented Oct 22, 2024

Should we remove mention of the cloud token extractor tool or are there cases where it would still be useful?

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, @bdraco 👍

@c0ffeeca7 c0ffeeca7 added the awaits-parent Awaits the merge of an parent PR label Oct 22, 2024
@home-assistant home-assistant bot added the parent-merged The parent PR has been merged already label Oct 22, 2024
@bdraco
Copy link
Member Author

bdraco commented Oct 22, 2024

Thanks!

@bdraco bdraco merged commit f56e0d0 into next Oct 22, 2024
9 checks passed
@bdraco bdraco deleted the xiaomi_ble_bind_key_cloud branch October 22, 2024 15:53
@home-assistant home-assistant bot removed awaits-parent Awaits the merge of an parent PR parent-merged The parent PR has been merged already labels Oct 22, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Oct 23, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest! has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants