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
    • Features
    • Preview
  • Installation
  • Updating
  • Uninstalling
  • Usage
    • Alarm functionality
    • Arm modes
    • Alarmo entity
      • States
      • Attributes
      • Commands
    • Areas
    • Alarm Master
      • States
      • Commands
    • Sensor configuration
      • Sensor types
      • Immediate
      • Always on
      • Allow open while arming
      • Arm after closing
      • Trigger when unavailable
    • Codes and users
      • Codes
      • Administrator
    • MQTT
      • State topic
      • Event topic
      • Command topic
      • Multiple area usage
    • Actions
      • Push notifications
        • Actionable notifications
      • Device actions
  • Alarmo-card
    • Demonstration
    • Configuration
  • Say thank you

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.

• 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.

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

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 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.

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.

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

The Alarmo entity defines the following attributes:

The Alarmo entities support the following commands:

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.

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.

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):

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.

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.

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.

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:

When the alarm is armed with an immediate sensor, this sensor will trigger the alarm directly instead of waiting for the (optional) entry delay.

An immediate sensor must be closed before you can enable the alarm. It is not allowed to be open while you are leaving the house. In other words, the exit delay is not applicable to immediate sensors.

Example of use cases: in mode armed away you would normally leave and enter the house via a door. If a window is opened when the alarm is armed, this means bad news. The siren should be enabled ASAP.

When marking a sensor as always on, it will always be able to trigger the alarm, even when the alarm is disarmed. The triggering occurs as soon as the sensor is activated and entry delays will be ignored.

This functionality is intended for safety sensors, such as fire detectors.

The allow open while arming property allows a sensor to be in the active state, while (and after) the alarm is armed. Setting this property is not the same as bypassing a sensor, since as soon as the sensor returns to the inactive state, it is capable of triggering the alarm. The property only ignores the initial state of the sensor.

This property is intended for motion sensors, which have a relatively long period before they return to inactive state, after the zone is clear. By setting this property, it is possible to set a leave delay that is lower than the reset period of this sensor.

The alarm on close feature is intended for entrances only. When setting this property to a door/contact sensor, Alarmo will watch this sensor while the alarm is in state arming, and determine if the user left the house.

Once the sensor state changes from open to closed, this is interpreted as the user closing the (front) door. Alarmo will skip the remaining of the exit delay, and proceed directly to the armed state. If any sensor (without the allow open while arming setting) is still open, the alarm will return to disarmed state.

Note: Alarmo uses a built-in 5 seconds delay to allow for contact bounce (the chattering of a door when pulling it shut).

HA defines the unavailable state for sensors for which the state is undeterminate (can be either open or closed). The unavailable state usually occurs when a battery-powered sensor loses connection to the gateway. This might be a harmless scenario (such as an empty battery) but it could also be the result of tampering of the sensor.

Since Alarmo cannot guarantee the security of your house when this occurs, it might be desirable to have the alarm trigger if this occurs. Setting the trigger when unavailable setting has the effect that the unavailable state is treated the same as the sensor being open.

By default, the alarm has no code and can be locked and unlocked by anyone who has access to HA. It is recommended to set a code for disarming the alarm as minumum security level.

To do so, go to the codes tab, and enable the setting 'use disarm code'.

Next, set up a user and give it a name and code. It is recommended to use the same name as your HA account, but this is not required.

A code can be a sequence of digits (4 or more) or contain a mix of letters, characters etc. Make sure to use a code that matches with the code format setting in the codes tab. This setting is detected by the alarm panel card, and will automatically show either a number pad or a text field.

Your code is stored completely secure. It is encrypted in the same way as your login credentials, and stored in the HA storage registry. When you enter a code, this will be encrypted too, and the encrypted values will be compared for a match. So it is impossible to recover your pin code. This also means that if you lose your pincode, you cannot unlock the alarm (there is no backup code!)

The administrator setting grants access to the Alarmo configuration panel.

For using this feature, the user names in Alarmo should be matched to the account names in HA.

When a user is trying to access the Alarmo configuration panel, access is only allowed if any of the following requirements are met:

1. The user is administrator in HA (i.e. this user can access the HA configuration)
2. The user is not a HA administrator, but a matching user exists in Alarmo, which has the administator setting activated.

Alarmo supports MQTT for external control of the alarm. This function is intended for third-party alarm panels (such as a touch screen in the hallway).

The MQTT support needs to be enabled before it can be used. This setting is available in tab "General".

The state topic is used to publish state changes of the alarm_control_panel entities.

The state topic is an output topic, i.e. the data is sent by Alarmo and should be received by another application (such as a wall panel display).

Default state topic (can be configured):

alarmo/state

Alarmo will send the current state of the Alarmo entity as payload (string). See here for the complete list of payloads. The payload which is sent per state can be configured if desired.

The data published on the state topic shall be sent with a retain flag. This means that the last sent payload shall be stored in the broker, and as soon as an application subscribed to the topic, the most recent data shall be available for it.

The event topic is used for publishing additional status updates of the alarm_control_panel entities.

The event topic is an output topic, i.e. the data is sent by Alarmo and should be received by another application (such as a wall panel display).

Default event topic (can be configured):

alarmo/event

The published payloads on this topic are formatted as JSON struct, which contains the event name, and optionally some extra parameters.

The following table shows the events which are published on the event topic, together with the parameters which are sent for a certain event):

Example payload on the event topic (Consider the scenario where the alarm is armed in state armed_away and the front door is opened):

{
  "event": "TRIGGER",
  "sensors": [ # list of sensor(s) that causes the triggering
    {
      "entity_id": "binary_sensor.frontdoor",
      "name": "Front Door"
    }
  ],
  "delay": 60 # entry delay
}

The command topic can be used for external control of Alarmo through MQTT.

The command topic is an input topic, i.e. the topic is watched by Alarmo and data should be sent by another application (such as a wall panel). The data should never be sent with retain flag, as this might give undesired behaviour when HA is restarted.

Default command topic (can be configured):

alarmo/command

If Alarmo is configured to require a pincode or password for the (arm/disarm) command, the payload must be formatted as JSON according to the following format:

{
  "command": "<my command>",
  "code": "<my pin or password>"
}

If Alarmo does not require any code for the command, the command can be sent directly as text/string value.

The supported commands can be found in commands.

If the provided payload does not have the correct format, lacks a code when it is required or contains a wrong code, the command shall be ignored. In other cases, you should see a change in the state topic.

Notes:

• The pin or password value should always be sent as a text/string value. A numeric value is not supported. This is due to the fact that a pincode could contain leading zeros (e.g. 0012), which would be lost if sent as a number.
• Alarmo provides the option to accept MQTT commands without requiring a code. By disabling the "Require code" setting in the MQTT configuration, the internal code check is skipped. This setting should be used with care as it may compromise the security of the alarm.
• The command is treated as case-insensitive.

The MQTT functionality can be used in combination with a multiple area configuration.

Alarmo shall publish the state updates for the Master Alarm and the areas in dedicated state topics:

• Master Alarm: alarmo/state
• Area: alarmo/<area_name>/state

For targeting an arm/disarm command to a specific area, the JSON payload can be extended with the area property:

{
  "command": "<my command>",
  "code": "<my pin or password>",
  "area": "<area_name>"
}

Notes:

• The MQTT configuration allows defining the topics for the Master Alarm only. The input topics (state/event topics) for the areas are automatically derived by inserting the area name. Example: setting state topic to my/custom/topic gives my/custom/<area_name>/topic as state topic for an area.
• <area_name> is a slug of the name that is given to an area. This means that the name shall be in lowercase and all non-alphanumerical characters are replaced by underscores (similar to the entity_IDs in HA).
• If no area is provided, the command is addressed to the Master Alarm. If the Master Alarm is disabled, the command is ignored.

Alarmo features a built-in panel for managing push notifications. It can be found in the actions tab.

This feature has the same effect as defining an automation in HA that is triggered by a state change of the alarm_control_panel.alarmo entity. It is only intended to provide a more integrated means of setting up your alarm.

This function adds buttons to a push message, that can be clicked to interact with Alarmo.

Alarmo has built-in support for actionable push notification with the 'failed to arm' condition.

Example:

The 'Retry Arm' option will repeat the command that failed before. You could use it if you solved the issue in the mean time.

The 'Force Arm' option will repeat the command that failed before. The sensor/sensors that failed, shall be ignored while the alarm is armed.

For iOS devices

Step 1: Add this to the configuration.yaml file:

ios:
  push:
    categories:
      - name: Alarm Arm Failure
        identifier: alarmo_arm_failure
        actions:
          - identifier: ALARMO_RETRY_ARM
            title: Retry Arm # feel free to change this text
            destructive: true
          - identifier: ALARMO_FORCE_ARM
            title: Force Arm # feel free to change this text
            destructive: true

Step 2: Restart HA to make the configuration effective.

Step 3: In the Alarmo notifications editor, create a notification for the 'Failed to arm' event. Choose your iOS device as target.

Step 4: Go to YAML mode. Look for the part that has service_data, and extend it as follows:

    service_data:
      ... # your message and title should be here already
      data:
        push:
          category: alarmo_arm_failure

For Android devices Step 1: In the Alarmo notifications editor, create a notification for the 'Failed to arm' event. Choose your Android device as target.

Step 2: Go to YAML mode. Look for the part that has service_data, and extend it as follows:

    service_data:
      ... # your message and title should be here already
      data:
        actions:
          - action: ALARMO_RETRY_ARM
            title: Retry Arm # feel free to change this text
          - action: ALARMO_FORCE_ARM
            title: Force Arm # feel free to change this text
        ttl: 0
        priority: high

Alarmo features a built-in panel for managing device actions. It can be found in the actions tab.

This feature has the same effect as defining an automation in HA that is triggered by a state change of the alarm_control_panel.alarmo entity. It is only intended to provide a more integrated means of setting up your alarm.

The actions are currently limited to turning on or turning off a HA entity. For more advanced actions, you can use the built-in YAML editor to define your own HA service call.

The installation of Alarmo automatically adds the alarmo-card to Lovelace. This card allows you to control your alarm through the HA web interface.

The alarmo-card is similar to the Lovelace alarm panel card, but brings some extra functions:

• A countdown timer is displayed when the alarm is in arming or pending state. It shows you how much time you have left for leaving the house / disarming the alarm.
• A message is displayed when the arming of the alarm failed or the alarm has triggered, with an overview of the sensor(s) involved.
• The card gives you feedback when a wrong code was entered.

See the alarmo-card in action:

For setting up the card, you need to assign the correct entity to the card. All settings regarding delay times, arming modes, code settings are automatically detected.

Example YAML configuration:

type: 'custom:alarmo-card'
entity: alarm_control_panel.alarmo

Configuration using UI mode:

1. Go to the Lovelace page where you want to add the card
2. Click "Edit Dashboard" on the right (under the button with the 3 dots)

• Click the "Add card" button on the bottom
• Choose "Custom: Alarmo Card" and pick the correct entity.

If you want to make donation as appreciation of my work, you can buy me a coffee. Thank you!