SIA Alarm Systems
The SIA Alarm Systems integration provides integration with several alarm systems that implement the SIA Protocol, including Ajax Systems. This protocol is listen-only, so does not allow you to turn on/off your alarm system, it just updates the state to reflect your alarm and allows you to act on that state, for instance turning on all lights and opening the curtains when the alarm triggers. The underlying package has support for different variants of SIA, including DC-09, DC-04 and a limited set of ADM-CID. If your alarm system uses the ADM-CID standard and it isn’t working, please log an issue here.
To use this platform, you need to setup your alarm system to communicate using the SIA Protocol and setup several things on the alarm. This integration basically works by Home Assistant listening on a port for messages from the alarm systems and handling and responding to that message and finally updating one or more entities in Home Assistant.
Alarm Setup (Ajax Systems Hub example)
- In the settings of your hub, go to the monitoring stations page.
- Select “SIA Protocol”.
- Enable “Connect on demand”.
- Place Account Id - 3-16 ASCII hex characters. For example AAA.
- Insert Home Assistant IP address. The hub must be able to reach this IP address. There is no cloud connection necessary.
- Insert Home Assistant listening port. This port must not be used by anything else on the machine Home Assistant is running on, see the notes on port usage below.
- Select Preferred Network. Ethernet is preferred if hub and HA in same network. Multiple networks are not tested.
- Enable Periodic Reports. The interval with which the alarm systems reports to the monitoring station, default is 1 minute. This component adds 30 seconds before setting the alarm unavailable to deal with slights latencies between ajax and HA and the async nature of HA.
- Encryption is preferred but optional. Password is 16, 24 or 32 ASCII characters.
Adding SIA Alarm Systems to your Home Assistant instance can be done via the user interface, by using this My button:
If the above My button doesn’t work, you can also perform the following steps manually:
Browse to your Home Assistant instance.
In the sidebar, select Settings.
From the configuration menu, select Devices & Services.
In the bottom right, select the Add Integration button.
From the list, search and select SIA Alarm Systems.
Follow the instructions on screen to complete the setup.
Port that your alarm will communicate with, must be set in the alarm system as explained above.
Hub account to communicate with. 3-16 ASCII hex characters. Must be set in the alarm system as explained above.
Ping interval in minutes that the alarm system uses to send “Automatic communication test report” messages, the component adds 30 seconds before marking all entities for that account (alarm and binary sensors) unavailable. Must be between 1 and 1440 minutes.
ASCII characters are 0-9 and ABCDEF, so an account is something like
346EB and the encryption key has the same characters but needs to be 16, 24 or 32 characters in length.
Note on monitoring multiple alarm systems
If you have multiple accounts (alarm systems) that you want to monitor you can choose to have all communicating with the same port, in that case, use the additional accounts checkbox in the dialog to setup the next account and keep doing that until you have them all. You can also choose to have both running on a different port, in that case setup the component twice with the different ports.
The port used with this component must be a port no other processes use on the machine your HA instance is running. If you have a complex network setup or want to monitor alarm systems at other locations you will most likely have to open firewalls and/or create network routes for that purpose, the integration will just listen for messages coming into that port, and will not proactively send, only responding with an acknowledgement to the alarm system.
In the initial version, after setup you will see one alarm_control_panel per account and zone combination. This entity will have 5 attributes that reflect all messages that came in for that account and zone, it includes fields for
last_timestamp. The alarm_control_panel state itself is changed based on a subset of values, including but not limited to codes:
NL, for the full list check the code on GitHub. If you expected the state to change then please log which code it was and create an issue on GitHub as well.
Each event that comes into your systems through SIA is also forwarded to the internal HA event bus, which can then be used to trigger automations directly on the codes that came in there. The events are created with event_type set to
sia_event_<port>_<account>. The event_data holds many fields, see details below.
- ri (also known as
- extended_data (list)