This repository is deprecated and no longer maintained. Please look here for an equivalent, even better implementation.

Ring Alarm MQTT Alarm Panel Home Assistant Integration

This package is based on Dav Glass' doorbot package, Homespun's ring-alarm fork (https://github.com/homespun/ring-alarm), various PRs from Joey Berkovitz (https://github.com/joeyberkovitz) and adapted to work with Home Assistant

This code is mostly derivative of the aforementioned repos. I just added some extras around MQTT discovery with HA since I'm too much of a novice to rewrite this as a true HA plugin.

Installation/Usage

• Clone this github
• npm install mqtt async ring-alarm socket.io-client

If not using autodiscovery, follow the next steps, otherwise skip to next section.

• npm install js-yaml
• Configure the Ring credentials in the yamlGenerator.sh

chmod a+x yamlGenerator.sh
./yamlGenerator.sh

• Press Ctrl + C to kill the script once it prints all of the yaml configurations to the console.

• Copy the content of the mqtt.yaml file that is generated into your Home Assistant configuration.

• Add your Ring credentials and MQTT broker address to mqttAlarm.sh

• Set the Discovery flag to true or false in the mqttAlarm.sh script depending on your setup

chmod a+x mqttAlarm.sh
./mqttAlarm.sh

Features:

With auto-discovery (discovery flag set to true):

• Works with MQTT discovery in Home Assistant
• Automagically adds all your contact sensors, motion sensors, and alarm units as sensors in HA
• Updates contact/motion sensor status in real-time as long as mqttAlarm.js script is running
• Alarm panel reflects current alarm mode (based on updates received from Ring API)
• Set alarm mode directly from alarm sensor
• Creates a connectivity sensor that monitors connection to Ring API. Shows unavailable if no connectivity with API in last 15 seconds
• Listens for an MQTT topic "home/alarm/check" which will resync all of the alarm device statuses

Without auto-discovery (discovery flag set to false):

• Same features as above except no autodiscovery
• yamlGenerator.js will produce a yaml configuration file that can be copied directly into your HA configuration.yaml to set up all your Ring Alarm devices

Recognition

Many thanks to davglass author of doorbot.

Many thanks (also) to joeyberkovitz who did most of the legwork on getting the Ring Alarm API connectivity to work.

Thanks also to homespun for updating doorbot with a basic, functional feature set for the Alarm API.