Currrently only tested on Paradox MG 5050 and MG 5050+ alarm systems
If you receive an error for your panel. Please send the response of:
https://apiv4.olarm.co/api/v4/devices/device_id?accessToken=api_key to an issue on Github.
1.) Install via HACS.
2.) Restart Home Assistant.
3.) Get your Olarm API key at : https://user.olarm.co/#/api
4.) Navigate to the Devices and Services tab under Settings.
5.) Click on Add Integration.
6.) Search for Olarm Sensors
7.) Enter these details in the fields in the popup. (Only API key is needed)
It gets all the devices assisiated with the api key automatically.
8.) Select the Scan Interval in seconds. This is the interval in seconds that Home Assistant will refresh the entity states.
Binary sensors are used for simple alarm panel zones and sensors. The folowing are examples:
1.) Motion Sensors (BinarySensorDeviceClass.MOTION)
2.) Door Sensors (BinarySensorDeviceClass.DOOR)
3.) Window Sensors (BinarySensorDeviceClass.WINDOW)
4.) Powered by AC (BinarySensorDeviceClass.PLUG)
5.) Powered by Battery (BinarySensorDeviceClass.POWER)
6.) Bypasss states of each zone on the panel. (On=bypassed, Off=active)
There is an alarm control panel for each area enabled on your alarm panel. This allows you to set the state of each area individually. If you have a nemtek electric fence. It is currently coded to enable arming and disarming of the electric fence.
There are buttons to refresh the data from the Olarm API, activate the PGM's, and activate Utility keys. The following is how it is set up:
1.) If your PGM has been set up as pulse or pulsing for the specified PGM has been enabled, it will show up as a button that can be pressed.
2.) There is a refresh button that refreshes the data from the Olarm API.
3.) There is buttons to toggle Utility Keys set up on your alarm.
There are switches that are used to activate or deactivate specified PGM's that were not set up to pulse and switches for bypassing zones. It is set up as follows:
1.) There is a switch for each zone/sensor on your alarm panel, which allows you to bypass that certain zone/sensor. (Switch on = bypassed, Switch off = active)
2.) If the specified PGM was not set up to pulse/pulsing disabled, there will be a switch that allows you to turn the PGM on and off.
Customize your own frontend or use the Home Assistant Alarm Panel Card
or the Mushroom Alarm control panel card
1.) The integration has been changed so that most of the services are built in to Home Assistant. To control your alarm panel entities please refer to the Home Assistant Alarm Panel Services for how they can be used.
2.) device_name_bypass_zone:
description: Send a request to Olarm to bypass the zone on your alarm.
fields:
zone_num:
description: "Zone Number (The zone you want to bypass) (Can be found under state attributes for the specified zone.)"
example: 1
required: true