Add documentation for Olarm integration #39772
Conversation
|
It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the |
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Hi I closed previous PR which was targeting incorrect branch (current instead of next) as advised and have created a new one. Also fixed an issue with the documentation advised by CodeRabbit Thanks for your help, much appreciated. |
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for the new Olarm integration in Home Assistant, covering setup steps, supported devices, entities, automation examples, troubleshooting, and known limitations.
- Adds a new
olarm.markdownfile with integration metadata and setup instructions - Documents available entities, automation example, and removal procedure
- Details troubleshooting tips, known limitations, and use cases
Comments suppressed due to low confidence (2)
source/_integrations/olarm.markdown:44
- [nitpick] The punctuation and style in the numbered list under 'Before Configuration' are inconsistent; ensure each list item either ends with a period or remove terminal punctuation uniformly for clarity.
1. In the Olarm App: Go to **Profile** > **Device List** > **[Select Device]** > **Developer Settings**, then enable **API Access**
source/_integrations/olarm.markdown:117
- [nitpick] Consider rephrasing to 'A maximum of 5 Olarm devices per integration instance are supported' for clearer pluralization and readability.
- A maximum of 5 Olarm {% term device %}s per {% term integration %} instance are currently supported
source/_integrations/olarm.markdown
Outdated
| condition: | ||
| - condition: template | ||
| value_template: "{% raw %}{{ is_state('binary_sensor.zone_001_front_door', 'on') }}{% endraw %}" |
There was a problem hiding this comment.
The template condition duplicates the state trigger in this automation example; consider removing the redundant condition or replacing it with a direct state condition to simplify the example.
| condition: | |
| - condition: template | |
| value_template: "{% raw %}{{ is_state('binary_sensor.zone_001_front_door', 'on') }}{% endraw %}" |
Copilot uses AI. Check for mistakes.
📝 WalkthroughWalkthroughA new documentation file for the Olarm smart alarm system integration has been added. The file provides setup instructions, entity descriptions, automation examples, troubleshooting tips, limitations, and use cases for integrating Olarm devices with Home Assistant. Changes
Sequence Diagram(s)sequenceDiagram
User->>Home Assistant: Enable Olarm integration
Home Assistant->>Olarm Cloud: Authenticate with Olarm account
Olarm Cloud-->>Home Assistant: Return device and sensor data
Home Assistant-->>User: Expose Olarm entities (zones, sensors, etc.)
User->>Home Assistant: Configure automations using Olarm entities
Home Assistant->>User: Trigger automations/notifications based on Olarm state changes
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: 2
🧹 Nitpick comments (3)
source/_integrations/olarm.markdown (3)
73-75: Minor grammar – missing pronoun
(if have an Olarm MAX)→(if you have an Olarm MAX)-#### MAX module sensors (if have an Olarm MAX) +#### MAX module sensors (if you have an Olarm MAX)
90-92: Template unnecessarily re-checks the same entityInside the same trigger you re-evaluate the identical entity state in a condition:
value_template: "{{ is_state('binary_sensor.zone_001_front_door', 'on') }}"The condition is redundant because the trigger already guarantees the state transition to
on.
Consider removing it for clarity (and a tiny performance gain).
100-104: Comma splice in troubleshooting sentenceInsert a comma to join two independent clauses:
Ensure the device is online, and the subscription is active
-Ensure the {% term device %} is online and the subscription is active +Ensure the {% term device %} is online, and the subscription is active
📜 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/olarm.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/olarm.markdown
[grammar] ~29-~29: This phrase is duplicated. You should probably use “Olarm PRO” only once.
Context: ...N1 – Paradox - Olarm GEN1 – Universal - Olarm PRO - Olarm PRO 4G - Olarm MAX ## Prerequisites - A...
(PHRASE_REPETITION)
[grammar] ~37-~37: This phrase is duplicated. You should probably use “the device” only once.
Context: ...larm panel - An active subscription for the device - The device has public API access enabled ## Befor...
(PHRASE_REPETITION)
[grammar] ~73-~73: It seems that a pronoun is missing.
Context: ...n latch mode) #### MAX module sensors (if have an Olarm MAX) - `binary_sensor.max...
(IF_VB)
[uncategorized] ~102-~102: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...: Ensure the {% term device %} is online and the subscription is active - **Missing ...
(COMMA_COMPOUND_SENTENCE_2)
[uncategorized] ~109-~109: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...in the Olarm system ### Removal {% my integrations badge %} 1. Go to **{% my integrations...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/olarm.markdown
57-57: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
58-58: Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
62-62: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
63-63: Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
65-65: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
66-66: Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
68-68: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
69-69: Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
73-73: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
74-74: Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
🔇 Additional comments (1)
source/_integrations/olarm.markdown (1)
23-32: Add blank lines around lists to satisfy markdownlint (MD032)Headings and lists should be separated by a blank line; otherwise the Markdown renderer occasionally mangles the block and CI fails.
## Supported devices - -The following devices are known to be supported by the {% term integration %}: - -- Olarm GEN1 – Paradox -- Olarm GEN1 – Universal -- Olarm PRO -- Olarm PRO 4G -- Olarm MAX + + +The following devices are known to be supported by the {% term integration %}: + +* Olarm GEN1 – Paradox +* Olarm GEN1 – Universal +* Olarm PRO +* Olarm PRO 4G +* Olarm MAXLikely an incorrect or invalid review comment.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
source/_integrations/olarm.markdown (3)
27-31: Minor wording duplication
Olarm PROappears twice in succession – trim to a single entry.- - Olarm PRO - - Olarm PRO 4G + - Olarm PRO 4G
37-38: Redundant phrase
“The device has public API access enabled” — drop the second “device”.- - The device has public API access enabled + - Public API access is enabled
77-78: Missing pronoun in heading
Change “(if have an Olarm MAX)” → “(if you have an Olarm MAX)” for clarity.-#### MAX module sensors (if have an Olarm MAX) +#### MAX module sensors (if you have an Olarm MAX)
📜 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/olarm.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/olarm.markdown
[grammar] ~29-~29: This phrase is duplicated. You should probably use “Olarm PRO” only once.
Context: ...N1 – Paradox - Olarm GEN1 – Universal - Olarm PRO - Olarm PRO 4G - Olarm MAX ## Prerequisites - A...
(PHRASE_REPETITION)
[grammar] ~37-~37: This phrase is duplicated. You should probably use “the device” only once.
Context: ...larm panel - An active subscription for the device - The device has public API access enabled ## Befor...
(PHRASE_REPETITION)
[uncategorized] ~59-~59: Loose punctuation mark.
Context: ... - binary_sensor.zone_XXX_<zone_name>: Individual zone status for each configu...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~65-~65: Loose punctuation mark.
Context: ...nary_sensor.zone_XXX_bypass_<zone_name>`: Shows bypass status for each zone (only...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~69-~69: Loose punctuation mark.
Context: ...stem sensors - binary_sensor.ac_power: Indicates if AC power is available to t...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~73-~73: Loose punctuation mark.
Context: ....<link_name>link_input_XX<input_name>: LINK input status - binary_sensor.<lin...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~77-~77: It seems that a pronoun is missing.
Context: ...n latch mode) #### MAX module sensors (if have an Olarm MAX) - `binary_sensor.ma...
(IF_VB)
[uncategorized] ~79-~79: Loose punctuation mark.
Context: ...binary_sensor.max_input_XX_<input_name>: MAX input status - binary_sensor.max_o...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~104-~104: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...: Ensure the {% term device %} is online and the subscription is active - **Missing ...
(COMMA_COMPOUND_SENTENCE_2)
⏰ 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
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
source/_integrations/olarm.markdown (1)
1-15: Replace deprecatedha_*front-matter keys with canonical namesThe docs builder still ignores pages that use the old
ha_*keys (except forha_release).
Rename the keys to their canonical counterparts or this page will be silently dropped.-ha_iot_class: Cloud Push -ha_category: - - Binary sensor -ha_codeowners: - - '@olarmtech' -ha_config_flow: true -ha_domain: olarm -ha_integration_type: integration -ha_platforms: - - binary_sensor +iot_class: cloud_push +categories: + - binary_sensor +codeowners: + - '@olarmtech' +config_flow: true +domain: olarm +integration_type: hub # or “integration” if more accurate +platforms: + - binary_sensor
🧹 Nitpick comments (1)
source/_integrations/olarm.markdown (1)
77-79: Add missing pronoun in headingMinor grammar fix for clarity.
-#### MAX module sensors (if have an Olarm MAX) +#### MAX module sensors (if you have an Olarm MAX)
📜 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/olarm.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/olarm.markdown
[grammar] ~29-~29: This phrase is duplicated. You should probably use “Olarm PRO” only once.
Context: ...N1 – Paradox - Olarm GEN1 – Universal - Olarm PRO - Olarm PRO 4G - Olarm MAX ## Prerequisites - A...
(PHRASE_REPETITION)
[grammar] ~37-~37: This phrase is duplicated. You should probably use “the device” only once.
Context: ...larm panel - An active subscription for the device - The device has public API access enabled ## Befor...
(PHRASE_REPETITION)
[uncategorized] ~59-~59: Loose punctuation mark.
Context: ... - binary_sensor.zone_XXX_<zone_name>: Individual zone status for each configu...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~65-~65: Loose punctuation mark.
Context: ...nary_sensor.zone_XXX_bypass_<zone_name>`: Shows bypass status for each zone (only...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~69-~69: Loose punctuation mark.
Context: ...stem sensors - binary_sensor.ac_power: Indicates if AC power is available to t...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~73-~73: Loose punctuation mark.
Context: ....<link_name>link_input_XX<input_name>: LINK input status - binary_sensor.<lin...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~77-~77: It seems that a pronoun is missing.
Context: ...n latch mode) #### MAX module sensors (if have an Olarm MAX) - `binary_sensor.ma...
(IF_VB)
[uncategorized] ~79-~79: Loose punctuation mark.
Context: ...binary_sensor.max_input_XX_<input_name>: MAX input status - binary_sensor.max_o...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~104-~104: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...: Ensure the {% term device %} is online and the subscription is active - **Missing ...
(COMMA_COMPOUND_SENTENCE_2)
[uncategorized] ~111-~111: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...in the Olarm system ### Removal {% my integrations badge %} 1. Go to **{% my integrations...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
source/_integrations/olarm.markdown (1)
75-75: Minor grammar – add missing pronoun-#### MAX module sensors (if have an Olarm MAX) +#### MAX module sensors (if you have an Olarm MAX)
📜 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/olarm.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/olarm.markdown
[grammar] ~27-~27: This phrase is duplicated. You should probably use “Olarm PRO” only once.
Context: ...N1 – Paradox - Olarm GEN1 – Universal - Olarm PRO - Olarm PRO 4G - Olarm MAX ## Prerequisites - A...
(PHRASE_REPETITION)
[grammar] ~35-~35: This phrase is duplicated. You should probably use “the device” only once.
Context: ...larm panel - An active subscription for the device - The device has public API access enabled ## Befor...
(PHRASE_REPETITION)
[uncategorized] ~57-~57: Loose punctuation mark.
Context: ... - binary_sensor.zone_XXX_<zone_name>: Individual zone status for each configu...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~63-~63: Loose punctuation mark.
Context: ...nary_sensor.zone_XXX_bypass_<zone_name>`: Shows bypass status for each zone (only...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~67-~67: Loose punctuation mark.
Context: ...stem sensors - binary_sensor.ac_power: Indicates if AC power is available to t...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~71-~71: Loose punctuation mark.
Context: ....<link_name>link_input_XX<input_name>: LINK input status - binary_sensor.<lin...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~75-~75: It seems that a pronoun is missing.
Context: ...n latch mode) #### MAX module sensors (if have an Olarm MAX) - `binary_sensor.ma...
(IF_VB)
[uncategorized] ~77-~77: Loose punctuation mark.
Context: ...binary_sensor.max_input_XX_<input_name>: MAX input status - binary_sensor.max_o...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~102-~102: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...: Ensure the {% term device %} is online and the subscription is active - **Missing ...
(COMMA_COMPOUND_SENTENCE_2)
[uncategorized] ~109-~109: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...in the Olarm system ### Removal {% my integrations badge %} 1. Go to **{% my integrations...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
- GitHub Check: Lint Markdown
- GitHub Check: Lint Text
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
source/_integrations/olarm.markdown (3)
75-76: Add missing pronoun in heading
(if have an Olarm MAX)→(if you have an Olarm MAX)
Small clarity/grammar improvement.
25-29: Remove repeated “Olarm PRO” entry
Lines 27 & 28 list “Olarm PRO” twice (the second time with “4G”). Combine or clarify to avoid duplication.- - Olarm PRO - - Olarm PRO 4G + - Olarm PRO / PRO 4G
34-37: Tighten wording and remove duplicate “device”- - An active subscription for the device - - The device has public API access enabled + - An active subscription for the device + - Public API access enabled
📜 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/olarm.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/olarm.markdown
[grammar] ~27-~27: This phrase is duplicated. You should probably use “Olarm PRO” only once.
Context: ...N1 – Paradox - Olarm GEN1 – Universal - Olarm PRO - Olarm PRO 4G - Olarm MAX ## Prerequisites - A...
(PHRASE_REPETITION)
[grammar] ~35-~35: This phrase is duplicated. You should probably use “the device” only once.
Context: ...larm panel - An active subscription for the device - The device has public API access enabled ## Befor...
(PHRASE_REPETITION)
[uncategorized] ~57-~57: Loose punctuation mark.
Context: ... - binary_sensor.zone_XXX_<zone_name>: Individual zone status for each configu...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~63-~63: Loose punctuation mark.
Context: ...nary_sensor.zone_XXX_bypass_<zone_name>`: Shows bypass status for each zone (only...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~67-~67: Loose punctuation mark.
Context: ...stem sensors - binary_sensor.ac_power: Indicates if AC power is available to t...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~71-~71: Loose punctuation mark.
Context: ....<link_name>link_input_XX<input_name>: LINK input status - binary_sensor.<lin...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~75-~75: It seems that a pronoun is missing.
Context: ...n latch mode) #### MAX module sensors (if have an Olarm MAX) - `binary_sensor.ma...
(IF_VB)
[uncategorized] ~77-~77: Loose punctuation mark.
Context: ...binary_sensor.max_input_XX_<input_name>: MAX input status - binary_sensor.max_o...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~102-~102: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...: Ensure the {% term device %} is online and the subscription is active - **Missing ...
(COMMA_COMPOUND_SENTENCE_2)
[uncategorized] ~109-~109: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...in the Olarm system ### Removal {% my integrations badge %} 1. Go to **{% my integrations...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
| ## Use cases | ||
|
|
||
| - Get real-time alerts for alarm events and zone activity | ||
| - Monitor alarm system health | ||
| - Integrate LINK modules for expanded I/O capabilities |
There was a problem hiding this comment.
| ## Use cases | |
| - Get real-time alerts for alarm events and zone activity | |
| - Monitor alarm system health | |
| - Integrate LINK modules for expanded I/O capabilities |
There was a problem hiding this comment.
I would move this section to the intro section, so people can learn if this is useful to them.
| The **Olarm** {% term integration %} connects Home Assistant with Olarm's range of smart alarm communicators. It allows you to monitor, control, and automate your alarm system directly from Home Assistant—enhancing security through smart home automation. | ||
|
|
||
| Olarm upgrades traditional alarm panels with remote access, real-time notifications, and seamless smart home integration. | ||
|
|
There was a problem hiding this comment.
| ## Use cases | |
| - Get real-time alerts for alarm events and zone activity | |
| - Monitor alarm system health | |
| - Integrate LINK modules for expanded I/O capabilities | |
|
If you enable the Allow edits by maintainers option, maintainers can add tweaks themselves. |
Proposed change
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit