Alarmo

This is an alarm system integration for Home Assistant. It provides a user interface for setting up your own alarm system completely from the browser.

Alarmo

Introduction

This is an integration for the alarm_control_panel domain in HA. It allows to combine existing sensors for creating a security system for your house. The integration is comparable with the Manual Alarm in HA, but also has some additional features that makes it easier to use.

Alarmo consists of 3 parts:

Alarmo component: a custom component for HA that controls the states of the alarm panel entities in HA.
Alarmo panel: a GUI for configuring the settings of your alarm (sensors, delays, actions etc.)
Alarmo card: a custom card for arming / disarming the alarm.

Features

Fully compatible with Home Assistant and the Alarm Panel Card.
Has an integrated panel for complete management via UI (no YAML required).
No restarts required when making changes.
Can set up to 4 arm modes (armed_away, armed_home, armed_night, armed_custom_bypass), each with configurable delays and security perimeter.
Supports configuring your existing HA entities as security sensors. These sensors will be watched automatically.
Allows setting up multiple users with individual pincode and permission levels.
Will restore its previous state after restart of HA.
Built-in actions: receive push notifications when anything changes in the alarm, activate a siren when the alarm is triggered, etc.
Supports splitting up your house security system into multiple areas which can be armed independently.

Preview

Installation

<details> <summary>Click to show installation instructions</summary> <ol> <li>Install files:</li> <ul> <li>Using HACS: In the HACS panel, go to integrations and click the big orange '+' button. Search for 'Alarmo' and click 'Install this repository in HACS'.</li> <li>Manually: Download the <a href="https://github.com/nielsfaber/alarmo/releases">latest release</a> as a zip file and extract it into the `custom_components` folder in your HA installation.</li> </ul> <li>Restart HA to load the integration into HA.</li> <li>Go to Configuration -> Integrations and click the big orange '+' button. Look for Alarmo and click to add it.</li> <li>The Alarmo integration is ready for use. You can find the configuration panel in the menu on the left.</li> </ol> </details>

Updating

<details> <summary>Click to show updating instructions</summary> <ol> <li>Update the files: <ul> <li>Using HACS: In the HACS panel, there should be an notification when a new version is available. Follow the instructions within HACS to update the installation files. </li> <li>Manually: Download the <a href="https://github.com/nielsfaber/alarmo/releases">latest release</a> as a zip file and extract it into the <code>custom_components</code> folder in your HA installation, overwriting the previous installation. </li> </ul> <li>Restart HA to load the changes.</li> <li>(Optional) Verify the version number. <ul> <li>Verify version of the backend: In HA, go to Configuration -> Integrations. In the Alarmo card, you should see a link with '1 device', click it. In the table click the 'Alarmo' device, and you should see the Device info. The 'firmware version' represents the installed version number. </li> <li>Verify version of the frontend: In the Alarmo configuration panel, the version number is displayed in the top right. If the version does not match with the backend version, your browser has an outdated version stored in the cache. To clear the cache, you should do a <a href="https://refreshyourcache.com/en/cache/">force refresh</a> of your browser. </li> </ul> </li> </ol> </details>

Uninstalling

<details> <summary>Click to show uninstall instructions</summary> <ol> <li>Remove Alarmo from HA: In HA go to Configuration -> Integrations. In the Alarmo card, click the button with the 3 dots, and click 'Delete'. </li> <li>Remove the files: <ul> <li> When installed with HACS: In the HACS panel go to integrations and look for Alarmo. Click the button with the 3 dots and click 'Uninstall'. </li> <li> When installed manually: In the <code>custom_components</code> directory, remove the 'alarmo' folder. </li> </ul> </li> <li>Restart HA to make all traces of the component dissapear. </li> </ol> </details>

Usage

Alarm functionality

The following diagram describes the operational states of the alarm and provides a simplified overview of the functionality.

Arm modes

The alarm can be activated (armed) in a certain mode. This mode defines a certain set of sensors and represents the security zone (or perimeter).

The following modes are supported:

Armed away
Armed night
Armed home
Armed vacation
Armed custom bypass (let's just call it armed custom from now on)

In the tab general you can find the settings for each mode. There are flip switches to enable/disable modes.

Alarmo entity

After installing Alarmo the entity alarm_control_panel.alarmo shall be added to HA. You can use this entity together with the Alarm panel card, or in conjuction with automations to automatically arm/disarm the alarm.

States

The Alarmo entity follows the state definitions as defined by HA:

State	Description
`disarmed`	The alarm is disabled/off.
`arming`	The alarm is arming.<br>After the leave delay has expired, the alarm will be armed.
`armed_away`	The alarm is armed in away mode.
`armed_home`	The alarm is armed in home mode.
`armed_night`	The alarm is armed in night mode.
`armed_vacation`	The alarm is armed in vacation mode.
`armed_custom_bypass`	The alarm is armed in custom mode.
`pending`	The alarm is pending.<br>After the entry delay has expired, the alarm will be triggered.
`triggered`	The alarm is triggered.
`unavailable`<br>`unknown`	Something is wrong.<br>Check the logs for more information.

Attributes

The Alarmo entity defines the following attributes:

Attribute	Default value	Example value when set	Description
`arm_mode`	`null`	`armed_away`	The current active arm mode.<br> Defined in all states except `disarmed`.
`next_state`	(same as current state)	`armed_away`	When alarm is in state `arming`: `next_state` is equal to the `arm_mode`.<br>When alarm is in state `pending`: `next_state` is `triggered`. <br>When alarm is in state `triggered`: `next_state` is `triggered` (if no trigger time is configured), `disarmed` (if 'disarm after triggering' setting is enabled) or equal to the `arm_mode` (otherwise).<br>In other cases, the `next_state` will be equal to the current state.
`changed_by`	`null`	`Niels`	User who last armed or disarmed the alarm.<br> Detected from the entered code.<br> Cleared when alarm is armed or disarmed without a code.
`open_sensors`	`null`	`{binary_sensor.backdoor: on}`	Dictionary of sensors with their entity-ID + state, that caused the alarm to change state.<br>Set when arming attempt failed (due to one or more sensors).<br>Set when alarm is triggered (only first sensor that caused the triggering is stored).
`bypassed_sensors`	`null`	`[binary_sensor.backdoor]`	List of sensors that are temporarily excluded from the alarm, due to arming in force.
`delay`	`null`	30	Duration of the exit or entry delay. Only set in the `arming` and `pending` states, `null` otherwise.

Commands

The Alarmo entities support the following commands:

Command	Description	Conditions
`ARM_AWAY`	Arm the alarm in mode `armed_away`.	- The entity has the mode `away` enabled.<br>- The current alarm state is `disarmed`, `armed_home`, `armed_night`, `armed_vacation` or `armed_custom_bypass`.
`ARM_HOME`	Arm the alarm in mode `armed_home`.	- The entity has the mode `home` enabled.<br>- The current alarm state is `disarmed`, `armed_away`, `armed_night`, `armed_vacation` or `armed_custom_bypass`.
`ARM_NIGHT`	Arm the alarm in mode `armed_night`.	- The entity has the mode `night` enabled.<br>- The current alarm state is `disarmed`, `armed_away`, `armed_home`, `armed_vacation` or `armed_custom_bypass`.
`ARM_VACATION`	Arm the alarm in mode `armed_vacation`.	- The entity has the mode `vacation` enabled.<br>- The current alarm state is `disarmed`, `armed_away`, `armed_home`, `armed_night` or `armed_custom_bypass`.
`ARM_CUSTOM_BYPASS`	Arm the alarm in mode `armed_custom_bypass`.	- The entity has the mode `custom` enabled.<br>- The current alarm state is `disarmed`, `armed_away`, `armed_home`, `armed_vacation` or `armed_night`.
`DISARM`	Disarm the alarm.	- The current alarm state is not `disarmed`

Areas

An area is a physical compartment of your house, such as a garage, 1st floor of the house, garden, etc. Alarmo will create an alarm_control_panel entity for each area which can be armed and disarmed independently. An area has its own set of sensors and can have dedicated configuration for arm modes, exit/entry times and automations.

In the general tab of the Alarmo configuration UI, there is a card showing the areas in your setup. You can add additional areas, as well as rename or remove existing areas. Alarmo requires at least 1 area to be set up to be functional.

The name of an area defines the entity ID as well. The entity will be instantly renamed after saving.

Warning: renaming an area changes the entity ID, which might break your Lovelace cards and automations outside of Alarmo, so treat it with care.

Alarm Master

Alarmo has the option for enabling an alarm master. The option appears in the general tab in general settings if you have multiple areas defined.

The alarm master is meant for operating your areas synchronously. An extra alarm_control_panel entity is created for the master, which watches the state of the areas for and mirrors its own state with that.

States

The Alarm Master will watch the states of the area entities and updates its own state accordingly.

The following table shows the rules which are implemented to determine the the master alarm state (in order of priority):

Condition	Master Alarm state
One or more areas have state `triggered`	`triggered`
One or more areas have state `pending`	`pending`
One or more areas have state `arming`, others have state `armed_away`, `armed_home`, `armed_night`, `armed_vacation` or `armed_custom_bypass`	`arming`
All areas have state `armed_away`	`armed_away`
All areas have state `armed_home`	`armed_home`
All areas have state `armed_night`	`armed_night`
All areas have state `armed_vacation`	`armed_vacation`
All areas have state `armed_custom_bypass`	`armed_custom_bypass`
All areas have state `disarmed`	`disarmed`
Otherwise	(previous state is kept)

Notes:

The Alarm Master cannot determine its state if some are disarmed while others are armed. If the Alarm Master is used for arming/disarming the alarm, this condition should not occur.
If the areas are independently operated, the user is reponsible to maintain synchronism between the areas. If independent operation is desired, usage of the Master Alarm is not recommended.

Commands

Arming / disarming the master will cause the action to be propagated to all areas.

If the arming of an area fails (due to blocking sensors), the arming procedure will be aborted and all areas are disarmed.

The available arm modes for the Master Alarm are determined from the areas. Only arm modes which are in common for all areas are available for the Master Alarm.

Sensor configuration

Currently Alarmo supports sensors of type binary_sensor. Alarmo will check the device class of each sensor, and only supports sensors that are related to security.

Available sensors should show up automatically in the sensors tab in the Add sensors card. Simply check the sensors that you wish to include in the alarm, and click 'add to alarm'. Review the configuration for each sensor in the sensors card.

Sensor types

The sensor configuration in the Alarmo panel allows defining a type for each sensor entity.

Setting a type for a sensor has the benefit that the appropriate configuration is automatically set. HA defines device classes for binary sensors. When assigning sensors to Alarmo, the type of the sensor is automatically determined based on this property (if it is defined).

Note that assigning a sensor type is not mandatory, and all configuration settings can also be set manually. It is also possible to deviate from the predefined configuration after setting a type.

The following table defines the sensor types and the predefined configuration: