Update yalexs_ble documentation for secure mode support #39695
Conversation
Updates the Yale Access Bluetooth integration documentation to include secure mode support. Also updates references to August cloud to include the Yale cloud integration for clarity as the August brand is not used in all markets
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThe Yale Access Bluetooth integration documentation was updated to describe new deadlock functionality, clarify device model support, and generalize references to both Yale and August cloud integrations for key provisioning and troubleshooting. Instructions and terminology were revised to reflect these broader integration options and device variants. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant HomeAssistant
participant YaleLock
participant CloudService
User->>HomeAssistant: Initiate lock integration
HomeAssistant->>CloudService: Request key provisioning (Yale or August)
CloudService-->>HomeAssistant: Provide key
HomeAssistant->>YaleLock: Communicate via Bluetooth
User->>HomeAssistant: Enable deadlock (if supported)
HomeAssistant->>YaleLock: Activate secure mode (deadlock)
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 (4)
source/_integrations/yalexs_ble.markdown (4)
39-40: Clarify Unity lock variants for easier scanning.Listing both SIL and MBK variants on the same bullet makes it harder for users to spot their exact model. Splitting them into individual lines (the pattern used for other models) improves readability and searchability.
- - YUR/SSDL/1/SIL and MBK (Yale Unity Screen Door Lock - Australia) - - YUR/DEL/1/SIL and MBK (Yale Unity Entrance Lock - Australia) + - YUR/SSDL/1/SIL (Yale Unity Screen Door Lock – Australia – SIL) + - YUR/SSDL/1/MBK (Yale Unity Screen Door Lock – Australia – MBK) + - YUR/DEL/1/SIL (Yale Unity Entrance Lock – Australia – SIL) + - YUR/DEL/1/MBK (Yale Unity Entrance Lock – Australia – MBK)
54-57: Align the heading with UI terminology.Home Assistant exposes the feature as a “Secure mode” lock entity. Renaming the section (or adding the term) keeps the docs in sync with what users see in the UI.
-## Deadlock support +## Secure mode (deadlock) supportOptionally, mention that the entity ID ends with
_secure_modeto help users locate it.
88-88: Missing comma after subordinate clause.A short comma improves readability and resolves the LanguageTool warning.
- ...under both brands and the Yale cloud should be tried for other markets. + ...under both brands, and the Yale cloud should be tried for other markets.
109-115: Trim trailing space & avoid duplicate “Troubleshooting” headings.
- Line 113 has a single trailing space that violates
MD009.- This is the second top-level “## Troubleshooting” section in the file, which breaks the template’s section order. Consider downgrading it to
### Re-authentication issuesor merging it with the earlier troubleshooting section.-...update the key.␠ +...update the key.
📜 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/yalexs_ble.markdown(4 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/_integrations/yalexs_ble.markdown
🪛 LanguageTool
source/_integrations/yalexs_ble.markdown
[uncategorized] ~88-~88: Possible missing comma found.
Context: ...hased in a market that sells under both brands and the Yale cloud should be tried for ...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~113-~113: Make sure that ‘use to’ is correct. For habitual actions in the past or to mean ‘accustomed to’, use “used to”.
Context: ...Android device that you also frequently use to operate the lock, you may find that the...
(USE_TO_VERB)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/yalexs_ble.markdown
113-113: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
⏰ 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
Updates the Yale Access Bluetooth integration documentation to include secure mode support.
Also updates references to August cloud to include the Yale cloud integration for clarity as the August brand is not used in all markets
Proposed change
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit