Add documentation for new bosch alarm integration #37458
Conversation
home-assistant
bot
added
has-parent
✅ 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
📜 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)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
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.
sanjay900
force-pushed
the
bosch-alarm
branch
from
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
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