Add documentation for new bosch alarm integration #37458
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThis pull request introduces a new documentation file for the Bosch Alarm integration. The document outlines the integration’s configuration details, including its title, description, supported Bosch alarm panel models, and the Alarm Control Panel entity. It details the authentication process via the Mode 2 API, security considerations, and standard removal procedures. Changes
🪧 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: 2
🧹 Nitpick comments (3)
source/_integrations/bosch_alarm.markdown (3)
25-25: Simplify wording for better readability.Consider simplifying "in order to" to just "to" for better readability.
-The **Bosch Alarm Panel** {% term integration %} allows you to connect your [Bosch Alarm Panel](https://www.boschsecurity.com) to Home Assistant in order to control and monitor your Bosch Alarm Panel. +The **Bosch Alarm Panel** {% term integration %} allows you to connect your [Bosch Alarm Panel](https://www.boschsecurity.com) to Home Assistant to control and monitor your Bosch Alarm Panel.🧰 Tools
🪛 LanguageTool
[style] ~25-~25: Consider a shorter alternative to avoid wordiness.
Context: ...ww.boschsecurity.com) to Home Assistant in order to control and monitor your Bosch Alarm Pa...(IN_ORDER_TO_PREMIUM)
52-52: Add missing period after "etc".In American English, the abbreviation "etc" should include a period.
-This entity reports state (_disarmed_, _armed_away_, etc), and contains custom attributes _ready_to_arm_ (_no_|_home_|_away_), and a _faulted_points_ counter. +This entity reports state (_disarmed_, _armed_away_, etc.), and contains custom attributes _ready_to_arm_ (_no_|_home_|_away_), and a _faulted_points_ counter.🧰 Tools
🪛 LanguageTool
[style] ~52-~52: In American English, abbreviations like “etc.” require a period.
Context: ...eports state (disarmed, armed_away, etc), and contains custom attributes _ready...(ETC_PERIOD)
95-95: Remove unnecessary hyphen.Since "regularly" is an adverb ending in 'ly', the hyphen in "regularly-configured" is unnecessary.
-⚠️ Since the _Mode 2_ automation user has "superuser" privileges, it bypasses the regularly-configured alarm pin: you will _not_ be prompted for a _User_ code when arming/disaming through the integration. +⚠️ Since the _Mode 2_ automation user has "superuser" privileges, it bypasses the regularly configured alarm pin: you will _not_ be prompted for a _User_ code when arming/disaming through the integration.🧰 Tools
🪛 LanguageTool
[uncategorized] ~95-~95: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ..."superuser" privileges, it bypasses the regularly-configured alarm pin: you will not be prompted f...(HYPHENATED_LY_ADVERB_ADJECTIVE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/bosch_alarm.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/bosch_alarm.markdown
[style] ~25-~25: Consider a shorter alternative to avoid wordiness.
Context: ...ww.boschsecurity.com) to Home Assistant in order to control and monitor your Bosch Alarm Pa...
(IN_ORDER_TO_PREMIUM)
[style] ~52-~52: In American English, abbreviations like “etc.” require a period.
Context: ...eports state (disarmed, armed_away, etc), and contains custom attributes _ready...
(ETC_PERIOD)
[uncategorized] ~95-~95: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ..."superuser" privileges, it bypasses the regularly-configured alarm pin: you will not be prompted f...
(HYPHENATED_LY_ADVERB_ADJECTIVE)
🪛 GitHub Actions: home-assistant.io Test
source/_integrations/bosch_alarm.markdown
[warning] 31-31: Unexpected unordered list marker *, expected -
[warning] 32-32: Unexpected unordered list marker *, expected -
[warning] 33-33: Unexpected unordered list marker *, expected -
[warning] 34-34: Unexpected unordered list marker *, expected -
[warning] 35-35: Unexpected unordered list marker *, expected -
[warning] 43-43: Unexpected unordered list marker *, expected -
[warning] 44-44: Unexpected unordered list marker *, expected -
[warning] 45-45: Unexpected unordered list marker *, expected -
[warning] 46-46: Unexpected unordered list marker *, expected -
[warning] 47-47: Unexpected unordered list marker *, expected -
⏰ 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 (1)
source/_integrations/bosch_alarm.markdown (1)
9-9: Verify the release version.The release version
2025.2.3seems to be set far in the future. Please verify if this is the intended version number or if it should be adjusted to match the actual planned release version.
bae712c to
7ff0690
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
source/_integrations/bosch_alarm.markdown (3)
25-25: Improve sentence conciseness.The introduction can be more concise.
-The **Bosch Alarm Panel** {% term integration %} allows you to connect your [Bosch Alarm Panel](https://www.boschsecurity.com) to Home Assistant in order to control and monitor your Bosch Alarm Panel. +The **Bosch Alarm Panel** {% term integration %} allows you to connect your [Bosch Alarm Panel](https://www.boschsecurity.com) to Home Assistant to control and monitor your Bosch Alarm Panel.🧰 Tools
🪛 LanguageTool
[style] ~25-~25: Consider a shorter alternative to avoid wordiness.
Context: ...ww.boschsecurity.com) to Home Assistant in order to control and monitor your Bosch Alarm Pa...(IN_ORDER_TO_PREMIUM)
52-52: Add missing period after "etc".In American English, abbreviations like "etc." require a period.
-This entity reports state (_disarmed_, _armed_away_, etc), and contains custom attributes _ready_to_arm_ (_no_|_home_|_away_), and a _faulted_points_ counter. +This entity reports state (_disarmed_, _armed_away_, etc.), and contains custom attributes _ready_to_arm_ (_no_|_home_|_away_), and a _faulted_points_ counter.🧰 Tools
🪛 LanguageTool
[style] ~52-~52: In American English, abbreviations like “etc.” require a period.
Context: ...eports state (disarmed, armed_away, etc), and contains custom attributes _ready...(ETC_PERIOD)
95-95: Remove unnecessary hyphen.Remove the hyphen after the adverb ending in 'ly'.
-Since the _Mode 2_ automation user has "superuser" privileges, it bypasses the regularly-configured alarm pin: you will _not_ be prompted for a _User_ code when arming/disaming through the integration. +Since the _Mode 2_ automation user has "superuser" privileges, it bypasses the regularly configured alarm pin: you will _not_ be prompted for a _User_ code when arming/disaming through the integration.🧰 Tools
🪛 LanguageTool
[uncategorized] ~95-~95: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ..."superuser" privileges, it bypasses the regularly-configured alarm pin: you will not be prompted f...(HYPHENATED_LY_ADVERB_ADJECTIVE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/bosch_alarm.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/bosch_alarm.markdown
[style] ~25-~25: Consider a shorter alternative to avoid wordiness.
Context: ...ww.boschsecurity.com) to Home Assistant in order to control and monitor your Bosch Alarm Pa...
(IN_ORDER_TO_PREMIUM)
[style] ~52-~52: In American English, abbreviations like “etc.” require a period.
Context: ...eports state (disarmed, armed_away, etc), and contains custom attributes _ready...
(ETC_PERIOD)
[uncategorized] ~95-~95: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ..."superuser" privileges, it bypasses the regularly-configured alarm pin: you will not be prompted f...
(HYPHENATED_LY_ADVERB_ADJECTIVE)
⏰ 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
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
Co-authored-by: c0ffeeca7 <[email protected]>
Co-authored-by: c0ffeeca7 <[email protected]>
Co-authored-by: c0ffeeca7 <[email protected]>
Co-authored-by: c0ffeeca7 <[email protected]>
Co-authored-by: Joost Lekkerkerker <[email protected]>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
source/_integrations/bosch_alarm.markdown (1)
18-21: Introduction Clarity and Link VerificationThe introduction clearly describes the Bosch Alarm integration and includes a working link to Bosch Security. Consider rephrasing to avoid repetition of "Bosch Alarm Panel" (e.g. "The Bosch Alarm integration connects your Bosch Alarm Panel to Home Assistant..."). Overall, the segment meets documentation standards.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/bosch_alarm.markdown(1 hunks)
🔇 Additional comments (8)
source/_integrations/bosch_alarm.markdown (8)
1-16: YAML Front Matter VerificationThe metadata block is well-structured and clearly defines integration details including
title,ha_category,ha_release, and others. Please verify that the release version (ha_release: 2025.4) is intended, as it appears to be a future version. If this aligns with your release planning, then it is acceptable.
22-31: Supported Devices Section AccuracyThe "Supported devices" section uses hyphenated list markers as required by documentation standards. The device models and the linked firmware note ([^1]) are clearly listed. Ensure that the listed models and firmware details remain accurate with any future changes.
32-37: Provided Entities DocumentationThe "Provided entities" section is concise and formatted correctly. Currently, it lists only the Alarm Control Panel, which appears to align with the integration’s features. If additional entities are supported in the future, remember to update this section.
38-42: Alarm Control Panel Section ClarityThe "Alarm Control Panel" subsection provides a clear description of the entity’s capabilities, including arming/disarming commands and state reporting. This information is well-aligned with standard Home Assistant documentation.
43-47: Authentication Section DetailingThe "Authentication" section explains the Mode 2 API authentication requirements in a clear manner. The differentiation between the Automation passcode and the shorter User code is helpful. Overall, this section effectively minimizes potential configuration confusion.
48-55: Markdown Table Formatting in AuthenticationThe markdown table detailing the panel types and associated authentication codes is correctly formatted. The footnote [^2] is appropriately referenced. Ensure that this table is updated if the authentication methods or supported panel types expand.
57-59: Emphasis on Security ExceptionThe use of the
{% important %}block to highlight that the Mode 2 automation user bypasses the User code is effective. This clear security note draws necessary attention to critical configuration behavior.
61-66: Integration Removal InstructionsThe "Removing the integration" section concisely states that no extra steps are required and includes the standard removal snippet. This adheres to Home Assistant’s integration removal procedures.
requested chanages have been implemented
Proposed change
Add documentation for a new bosch alarm integration
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
Summary by CodeRabbit