-
-
Notifications
You must be signed in to change notification settings - Fork 7.8k
Add documentation for Olarm integration #39772
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
pelicarno
wants to merge
5
commits into
home-assistant:next
Choose a base branch
from
OlarmTech:next
base: next
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
c58c40e
Fix Olarm integration automation YAML examples
pelicarno e5c4018
Add documentation for Olarm integration
pelicarno e10e9dc
Fix example and markdown formatting issues
pelicarno 7ba5d48
Removed deprecated ha_ keys
pelicarno a904e71
Fixed enum values error
pelicarno File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
@@ -0,0 +1,127 @@ | ||||||||||||
--- | ||||||||||||
title: Olarm | ||||||||||||
description: Instructions on how to integrate Olarm devices into Home Assistant. | ||||||||||||
ha_release: 2025.1 | ||||||||||||
iot_class: cloud_push | ||||||||||||
codeowners: | ||||||||||||
- '@olarmtech' | ||||||||||||
config_flow: true | ||||||||||||
domain: olarm | ||||||||||||
integration_type: hub | ||||||||||||
platforms: | ||||||||||||
- binary_sensor | ||||||||||||
--- | ||||||||||||
|
||||||||||||
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. | ||||||||||||
|
||||||||||||
Learn more and view supported alarm systems: [Olarm](https://www.olarm.com) | ||||||||||||
|
||||||||||||
## 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 | ||||||||||||
|
||||||||||||
## Prerequisites | ||||||||||||
|
||||||||||||
- An active Olarm account | ||||||||||||
- A compatible Olarm {% term device %} connected to a supported alarm panel | ||||||||||||
- An active subscription for the device | ||||||||||||
- The device has public API access enabled | ||||||||||||
|
||||||||||||
## Before Configuration | ||||||||||||
|
||||||||||||
Before adding the integration to Home Assistant: | ||||||||||||
|
||||||||||||
1. In the Olarm App: Go to **Profile** > **Device List** > **[Select Device]** > **Developer Settings**, then enable **API Access** | ||||||||||||
2. Ensure your Olarm device is online and has an active subscription | ||||||||||||
|
||||||||||||
{% include integrations/config_flow.md %} | ||||||||||||
|
||||||||||||
## Entities | ||||||||||||
|
||||||||||||
The **Olarm** {% term integration %} provides the following {% term entities %}. | ||||||||||||
|
||||||||||||
### 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) | ||||||||||||
|
||||||||||||
## Examples | ||||||||||||
|
||||||||||||
### Automation examples | ||||||||||||
|
||||||||||||
#### Zone monitoring | ||||||||||||
|
||||||||||||
```yaml | ||||||||||||
alias: "Front Door Opened" | ||||||||||||
trigger: | ||||||||||||
- platform: state | ||||||||||||
entity_id: binary_sensor.zone_001_front_door | ||||||||||||
to: "on" | ||||||||||||
action: | ||||||||||||
- service: notify.mobile_app | ||||||||||||
data: | ||||||||||||
message: "Front door has been opened" | ||||||||||||
``` | ||||||||||||
|
||||||||||||
## Troubleshooting | ||||||||||||
|
||||||||||||
### Common issues | ||||||||||||
|
||||||||||||
- **No updates or control issues**: Ensure the {% term device %} is online and the subscription is active | ||||||||||||
- **Missing {% term entities %}**: Reload the {% term integration %} or restart Home Assistant | ||||||||||||
- **Login issues**: Double-check your Olarm account credentials and ensure API access is enabled in the Olarm app | ||||||||||||
- **LINK entities missing**: Ensure the modules are properly connected and configured in the Olarm system | ||||||||||||
|
||||||||||||
### Removal | ||||||||||||
|
||||||||||||
{% my integrations badge %} | ||||||||||||
|
||||||||||||
1. Go to **{% my integrations icon title="Settings > Devices & Services" %}** | ||||||||||||
2. Locate the **Olarm** integration | ||||||||||||
3. Select the integration, then select **Delete** | ||||||||||||
pelicarno marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||||
|
||||||||||||
## Known limitations | ||||||||||||
|
||||||||||||
- A maximum of 5 Olarm {% term device %}s per {% term integration %} instance are currently supported | ||||||||||||
- Only one Olarm user account per Home Assistant instance - multiple Home Assistant instances require different Olarm user accounts | ||||||||||||
- Zone bypass {% term entities %} are optional and must be enabled during setup | ||||||||||||
- LINK binary sensors {% term entities %} only available if the respective modules are connected to your system | ||||||||||||
- MAX binary sensors only available if you have an Olarm MAX | ||||||||||||
|
||||||||||||
## Use cases | ||||||||||||
|
||||||||||||
- Get real-time alerts for alarm events and zone activity | ||||||||||||
- Monitor alarm system health | ||||||||||||
- Integrate LINK modules for expanded I/O capabilities | ||||||||||||
Comment on lines
+123
to
+127
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I would move this section to the intro section, so people can learn if this is useful to them. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.