docs: Add manual alarm bad code attempt event#39426
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughDocumentation for the manual alarm control panel integration has been updated to include a new event, Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant AlarmPanel
participant EventSystem
participant Automation
User->>AlarmPanel: Attempt to change alarm state (with code)
AlarmPanel-->>User: Validate code (failure)
AlarmPanel->>EventSystem: Fire manual_alarm_bad_code_attempt event (with entity_id, action, user_id)
EventSystem->>Automation: Trigger automation (e.g., notify user)
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (3)
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: 1
📜 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/manual.markdown(1 hunks)
⏰ 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 (2)
source/_integrations/manual.markdown (2)
104-107: Event heading and description look solid.
The newmanual_alarm_bad_code_attemptheading and its descriptive text are clear and follow the existing pattern.
108-115: Event Data table is well-formatted and accurate.
The table correctly listsentity_id,action, anduser_idwith appropriate types and descriptions.
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
c0ffeeca7
left a comment
There was a problem hiding this comment.
Thank you, @giuseppeg88 👍
|
@c0ffeeca7 I just realized I hadn't updated the documentation after the recent changes I made to the code pull request. You can find the fixes here: #41661 |
Proposed change
This Pull Request adds new documentation for the
manual_alarm_bad_code_attemptevent, which is fired by themanualalarm control panel integration.This event allows users to create automations to react to or monitor instances where an invalid code is provided during an attempt to change the alarm's state (e.g., arm or disarm). The documentation includes details about when the event is fired, the data it contains (
entity_id,target_state,user_id), and an example automation to demonstrate its usage.This new event is part of a feature improvement in the
manualintegration aimed at enhancing security and monitoring capabilities.Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
nextbranch.Summary by CodeRabbit