Skip to content

docs: Add manual alarm bad code attempt event#39426

Merged
c0ffeeca7 merged 5 commits into
home-assistant:nextfrom
giuseppeg88:next
Nov 7, 2025
Merged

docs: Add manual alarm bad code attempt event#39426
c0ffeeca7 merged 5 commits into
home-assistant:nextfrom
giuseppeg88:next

Conversation

@giuseppeg88
Copy link
Copy Markdown
Contributor

@giuseppeg88 giuseppeg88 commented Jun 8, 2025

Proposed change

This Pull Request adds new documentation for the manual_alarm_bad_code_attempt event, which is fired by the manual alarm 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 manual integration aimed at enhancing security and monitoring capabilities.

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

  • Documentation
    • Added information about a new event triggered by invalid code attempts on the manual alarm control panel.
    • Provided an example automation for notifying users when an invalid code is entered.

@home-assistant home-assistant Bot added has-parent This PR has a parent PR in another repo next This PR goes into the next branch labels Jun 8, 2025
@netlify
Copy link
Copy Markdown

netlify Bot commented Jun 8, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 3f3e758
🔍 Latest deploy log https://app.netlify.com/projects/home-assistant-docs/deploys/684595eb21771600085072b4
😎 Deploy Preview https://deploy-preview-39426--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 project configuration.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 8, 2025

📝 Walkthrough

Walkthrough

Documentation for the manual alarm control panel integration has been updated to include a new event, manual_alarm_bad_code_attempt. This event occurs when a user fails to change the alarm state due to entering an invalid code. Details about the event data and an example automation trigger are provided.

Changes

File(s) Change Summary
source/_integrations/manual.markdown Added documentation for the manual_alarm_bad_code_attempt event, its data, and a usage example.

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)
Loading

📜 Recent 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

📥 Commits

Reviewing files that changed from the base of the PR and between d1c916b and 3f3e758.

📒 Files selected for processing (1)
  • source/_integrations/manual.markdown (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • source/_integrations/manual.markdown
⏰ 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

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.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need 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)

  • @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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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
Copy Markdown
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: 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

📥 Commits

Reviewing files that changed from the base of the PR and between 9419017 and 73554b7.

📒 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 new manual_alarm_bad_code_attempt heading and its descriptive text are clear and follow the existing pattern.


108-115: Event Data table is well-formatted and accurate.
The table correctly lists entity_id, action, and user_id with appropriate types and descriptions.

Comment thread source/_integrations/manual.markdown
@netlify
Copy link
Copy Markdown

netlify Bot commented Nov 4, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 8de47a9
🔍 Latest deploy log https://app.netlify.com/projects/home-assistant-docs/deploys/690d762d850d4900089f1a24
😎 Deploy Preview https://deploy-preview-39426--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 project configuration.

@home-assistant home-assistant Bot added the parent-merged The parent PR has been merged already label Nov 5, 2025
Comment thread source/_integrations/manual.markdown Outdated
Comment thread source/_integrations/manual.markdown Outdated
Comment thread source/_integrations/manual.markdown Outdated
Comment thread source/_integrations/manual.markdown Outdated
Copy link
Copy Markdown
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, @giuseppeg88 👍

@c0ffeeca7 c0ffeeca7 enabled auto-merge (squash) November 7, 2025 04:33
@c0ffeeca7 c0ffeeca7 merged commit e55457c into home-assistant:next Nov 7, 2025
7 checks passed
@home-assistant home-assistant Bot removed the parent-merged The parent PR has been merged already label Nov 7, 2025
@giuseppeg88
Copy link
Copy Markdown
Contributor Author

@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

@github-actions github-actions Bot locked and limited conversation to collaborators Nov 8, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

has-parent This PR has a parent PR in another repo next This PR goes into the next branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants