Abode
The abode
integration will allow users to integrate their Abode Home Security systems into Home Assistant and use its alarm system and sensors to automate their homes.
Please visit the Abode website for further information about Abode Security.
There is currently support for the following device types within Home Assistant:
- Alarm Control Panel: Reports on the current alarm status and can be used to arm and disarm the system.
-
Binary Sensor: Reports on
Quick Actions
,Door Contacts
,Connectivity
sensors (remotes, keypads, and status indicators),Moisture
sensors, andMotion
orOccupancy
sensors. -
Camera: Reports on
Camera
devices and will download and show the latest captured still image. Can be turned off and on using thecamera.turn_off
andcamera.turn_on
services. -
Cover: Reports on
Secure Barriers
and can be used to open and close the cover. -
Lock: Reports on
Door Locks
and can be used to lock and unlock the door. -
Light: Reports on
Dimmer
lights and can be used to dim or turn the light on and off. -
Switch: Reports on
Power Switch
andWater Valve
devices which can be turned on and off. Also reports onAutomations
set up in the Abode system and allows you to activate or deactivate them. -
Sensor: Reports on
Temperature
,Humidity
, andLight
sensors.
Configuration
To add the Abode integration to your Home Assistant instance, use this My button:
Abode can be auto-discovered by Home Assistant. If an instance was found, it will be shown as Discovered. You can then set it up right away.
If it wasn’t discovered automatically, don’t worry! You can set up a manual integration entry:
-
Browse to your Home Assistant instance.
-
In the bottom right corner, select the Add Integration button.
-
From the list, select Abode.
-
Follow the instructions on screen to complete the setup.
Events
There are a number of events that can be triggered from Abode. They are grouped into the below events:
- abode_alarm: Fired when an alarm event is triggered from Abode. This includes Smoke, CO, Panic, and Burglar alarms.
- abode_alarm_end: Fired when an alarm end event is triggered from Abode.
- abode_automation: Fired when an Automation is triggered from Abode.
- abode_panel_fault: Fired when there is a fault with the Abode hub. This includes events like loss of power, low battery, tamper switches, polling failures, and signal interference.
- abode_panel_restore: Fired when the panel fault is restored.
- abode_disarm: Fired when the alarm is disarmed.
- abode_arm: Fired when the alarm is armed (home or away).
- abode_arm_fault: Fired when the alarm is armed (home or away) and has a fault. This includes open door/windows, low battery, backup connection. abode_arm is not fired if a fault is present.
- abode_test: Fired when a sensor is in test mode.
- abode_capture: Fired when an image is captured.
- abode_device: Fired for device changes/additions/deletions.
All events have the fields:
Field | Description |
---|---|
device_id |
The Abode device ID of the event. |
device_name |
The Abode device name of the event. |
device_type |
The Abode device type of the event. |
event_code |
The event code of the event. |
event_name |
The name of the event. |
event_type |
The type of the event. |
event_utc |
The UTC timestamp of the event. |
user_name |
The Abode user that triggered the event, if applicable. |
app_type |
The Abode app that triggered the event (e.g., web app, iOS app, etc.). |
event_by |
The keypad user that triggered the event. |
date |
The date of the event in the format MM/DD/YYYY . |
time |
The time of the event in the format HH:MM AM . |
There is a unique list of known event_codes that can be found here.
Services
Service change_setting
Change settings on your Abode system. For a full list of settings and valid values, consult the AbodePy settings section.
Service data attribute | Optional | Description |
---|---|---|
setting |
No | The setting you wish to change. |
value |
No | The value you wish to change the setting to. |
Service capture_image
Request a new still image from your Abode camera.
Service data attribute | Optional | Description |
---|---|---|
entity_id |
No | String or list of strings that point at entity_id s of Abode cameras. |
Service trigger_automation
Trigger an automation on your Abode system.
Service data attribute | Optional | Description |
---|---|---|
entity_id |
No | String or list of strings that point at entity_id s of switches that represent your Abode automations. |