Update shelly docs to make it clear that active Bluetooth connections cannot be proxied #38761
Conversation
… cannot be proxied
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe documentation for the Shelly integration's Bluetooth support was updated for clarity and completeness. The revised text specifies that Shelly Gen 2 and newer devices, excluding battery-powered ones, can serve as Bluetooth proxies for forwarding advertisement data. It also adds a tip clarifying that these devices do not support proxying active (GATT) Bluetooth connections and includes a reference link to related Bluetooth integration documentation. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant ShellyDevice
participant BluetoothIntegrationDocs
User->>ShellyDevice: Reads documentation on Bluetooth proxy support
ShellyDevice-->>User: Clarifies advertisement data forwarding capability
ShellyDevice-->>User: Shows tip about no GATT proxy support
User->>BluetoothIntegrationDocs: Follows reference link for more details
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:
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 (2)
source/_integrations/shelly.markdown (2)
95-96: Clarify scanning terminology to avoid confusionThe phrase “active listening” could be misinterpreted as active (GATT) connection proxying. Since this refers to advertisement scanning modes, consider renaming to something like:
-Shelly Gen 2 and newer devices (excluding battery-powered models) can act as Bluetooth proxies, forwarding advertisement data. You can enable either active or passive listening through the device’s options flow. +Shelly Gen 2 and newer devices (excluding battery-powered models) can act as Bluetooth proxies, forwarding advertisement data. You can enable either active or passive advertisement scanning through the device’s options flow.This will reduce ambiguity when combined with the following tip.
97-99: Enhance GATT acronym clarityThe tip is helpful, but readers may not know what “GATT” stands for. Consider expanding the acronym on first use:
-{% tip %} -Shelly devices do **not** support proxying active (GATT) connections. -{% endtip %} +{% tip %} +Shelly devices do **not** support proxying active Bluetooth connections (Generic Attribute Profile, GATT). +{% endtip %}This improves accessibility for newcomers.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/shelly.markdown(1 hunks)
🔇 Additional comments (1)
source/_integrations/shelly.markdown (1)
101-101:✅ Verification successful
Verify the documentation link anchor
Please confirm that the anchor
#remote-adapters-bluetooth-proxiesexists in the Bluetooth integration docs; a broken link will frustrate users. You can run:Expect to see a header followed by a matching ID.
🏁 Script executed:
#!/bin/bash # Verify that the anchor for remote adapters exists in the Bluetooth integration docs rg -n '^#+\s*Remote Adapters' -A2 $(fd -t f 'bluetooth.md')Length of output: 59
🏁 Script executed:
#!/bin/bash # Locate the Bluetooth integration markdown file and verify the 'Remote Adapters' header (and implied anchor) file=$(fd -t f -e markdown bluetooth) echo "Inspecting: $file" rg -nE '^#{1,6}\s*Remote Adapters' -A2 "$file"Length of output: 1529
🏁 Script executed:
#!/bin/bash # Inspect the Bluetooth integration markdown for the 'Remote Adapters (Bluetooth Proxies)' heading file="source/_integrations/bluetooth.markdown" echo "Inspecting headings in: $file" rg -n '^#{1,6}' "$file" echo echo "Context around 'Remote Adapters':" rg -n -C1 'Remote Adapters' "$file" echo echo "Context around 'Bluetooth Proxies':" rg -n -C1 'Bluetooth Proxies' "$file"Length of output: 2276
Link anchor validated in Bluetooth integration docs
The heading
## Remote adapters (Bluetooth proxies)exists at line 271 in
source/_integrations/bluetooth.markdown, which generates the anchor#remote-adapters-bluetooth-proxies. The documentation link is correct—no changes needed.
|
thanks |
Proposed change
Clarify Shelly documentation: active Bluetooth connections cannot be proxied. Shelly devices currently only support proxying Bluetooth advertisement data. This update addresses user confusion, as many users purchase multiple Shelly devices expecting them to proxy active connections and control Bluetooth devices.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit