Add documentation for Olarm integration #39772
Conversation
home-assistant
bot
added
in-progress
|
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. |
home-assistant
bot
removed
the
needs-rebase
|
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
| 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 (
|
![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/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.
| ### Binary sensors | ||
|
|
||
| The integration creates various binary sensors depending on your alarm system configuration: | ||
|
|
||
| #### Zone sensors | ||
| - `binary_sensor.zone_XXX_<zone_name>`: Individual zone status for each configured zone | ||
| - Device class automatically set based on zone type (door, window, motion) | ||
| - Extra attribute: `bypassed` indicates if the zone is currently bypassed | ||
|
|
||
| #### Zone bypass sensors (optional) | ||
| - `binary_sensor.zone_XXX_bypass_<zone_name>`: Shows bypass status for each zone (only if bypass {% term entities %} are enabled during setup) | ||
|
|
||
| #### System sensors | ||
| - `binary_sensor.ac_power`: Indicates if AC power is available to the alarm panel | ||
|
|
||
| #### LINK module sensors (if LINK modules are connected) | ||
| - `binary_sensor.<link_name>_link_input_XX_<input_name>`: LINK input status | ||
| - `binary_sensor.<link_name>_link_output_XX_<output_name>`: LINK output status (for outputs in latch mode) | ||
| - `binary_sensor.<link_name>_link_relay_XX_<relay_name>`: LINK relay status (for relays in latch mode) | ||
|
|
||
| #### MAX module sensors (if have an Olarm MAX) | ||
| - `binary_sensor.max_input_XX_<input_name>`: MAX input status | ||
| - `binary_sensor.max_output_XX_<output_name>`: MAX output status (for outputs in latch mode) | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Multiple heading / list spacing violations (MD022 & MD032)
Sections ### Binary sensors, #### Zone sensors, #### Zone bypass sensors, #### System sensors, #### LINK module sensors, and #### MAX module sensors all miss the required blank line before/after the heading and before list blocks.
Please insert a blank line in each spot or run markdownlint --fix to auto-correct.
🧰 Tools
🪛 LanguageTool
[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)
🪛 markdownlint-cli2 (0.17.2)
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)
🤖 Prompt for AI Agents
In source/_integrations/olarm.markdown between lines 53 and 76, the headings and
lists lack the required blank lines before and after headings and before list
blocks, violating markdownlint rules MD022 and MD032. To fix this, insert a
blank line before each heading and after each heading before the list starts, as
well as ensure there is a blank line before each list block. Alternatively, run
markdownlint with the --fix option to automatically correct these spacing
issues.
| --- | ||
| title: Olarm | ||
| description: Instructions on how to integrate Olarm devices into Home Assistant. | ||
| ha_release: 2025.1 | ||
| 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 | ||
| --- |
There was a problem hiding this comment.
Front-matter schema deviates from Home Assistant standards
The ha_* prefixed keys aren’t recognised by the docs builder.
Use the canonical names (iot_class, config_flow, domain, integration_type, platforms, etc.) to avoid the page being silently dropped during the build.
---
-title: Olarm
-description: Instructions on how to integrate Olarm devices into Home Assistant.
-ha_release: 2025.1
-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
+title: Olarm
+description: Integrate Olarm smart alarm communicators with Home Assistant.
+ha_release: 2025.1
+iot_class: cloud_push
+integration_type: hub
+config_flow: true
+domain: olarm
+codeowners:
+ - '@olarmtech'
+platforms:
+ - binary_sensor
---Committable suggestion skipped: line range outside the PR's diff.
🤖 Prompt for AI Agents
In source/_integrations/olarm.markdown lines 1 to 15, the front-matter keys
prefixed with "ha_" do not conform to Home Assistant documentation standards and
cause the docs builder to ignore the page. Rename all keys by removing the "ha_"
prefix and use the canonical names such as "iot_class", "config_flow", "domain",
"integration_type", and "platforms" to ensure the integration page is properly
recognized and included during the build.
Proposed change
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit