Ring Security - Extend Heimdall with Ring Security products

Fredrik_Backman · August 24, 2022, 9:15am

unfortunately im not able to test this, i returned my v2 keypad and now im only using the v1 version (ordered it from ebay since its not for sale any more). I have proximity enabled on the v1 and it works without any problems. I have however experienced some other problems on my zwave mesh after adding the keypad, mainly with my doorlock thats mounted 1m from the keypad so its likely using the same nodes. I will try disable the proximity detection and see if that has any impact on the other nodes in my mesh.

MrBlue · August 24, 2022, 11:54am

@DaneedeKruyff Based on your experience while writing the app; do you believe it’s possible to send raw zwave commands to trigger special alarms like described here?

github.com

ImSorryButWho/HomeAssistantNotes/blob/6f05b3f90a979f7118e7c688ce2d01b878227328/RingKeypadV2.md

# Ring Keypad v2 With Home Assistant

I've been looking for a physical alarm keypad to use with Home Assistant for quite a while, and have't found any good options.  I was excited when I found out that the [Ring Alarm Keypad](https://ring.com/products/alarm-keypad-v2) is [Z-Wave based](https://support.ring.com/hc/en-us/articles/360042696611-Ring-Alarm-Keypad-2nd-gen-Z-Wave-Technical-Manual) and widely available, but I was never able to get it working with HA.  Until very recently.

It turns out that for full functionality the keypad must be paired with S2 security, the higher-security Z-Wave mode which wasn't supported by any open-source projects.  Until [August 2021](https://github.com/zwave-js/node-zwave-js/releases/tag/v8.1.0), when ZWaveJS added support for S2.  [ZWaveJS2MQTT](https://github.com/zwave-js/zwavejs2mqtt) added support for S2 soon after, which was the key to using the Ring Keypad with Home Assistant successfully.

In this document, I'll talk about how to use the Ring keypad with Home Assistant, taking full advantage of all the functionality it offers.  In my opinion, this is by far the most polished option for an alarm keypad that works with HA available currently

## Pairing

As of this writing, ZWaveJS2MQTT is the only method I can find to successfully pair the keypad with Home Assistant with full functionality.  I assume the standard ZWaveJS implementation will gain support for S2 security eventually, but currently (October 2021) the UI doesn't support it.

So, to make this work, be sure you're using ZWaveJS2MQTT.  The easiest way to do that is via the [community add-on](https://github.com/hassio-addons/addon-zwavejs2mqtt), which is part of the default add-on store.  Migrating from the standard ZWaveJS add-on to ZWaveJS2MQTT is out of the scope of this document, but should be straightforward.

If you haven't set up any devices with S2 security before, you likely don't have S2 keys defined.  In the ZWaveJS2MQTT settings page ZWave area, click the two arrows button next to the three S2 keys to generate new ones.  (Of course, don't do this if you already have keys defined, or you'll lose the ability to control whatever devices you already have paired!)

There's one issue I've had with this keypad: the security negotiation seems to time out quickly.  I found I need to have the DSK PIN (from the QR code on the back of the keypad) entered within a couple of seconds, or security negotiation fails.  I'd strongly suggest you type the PIN into a text document and copy it to your clipboard, ready to paste in as soon as ZWaveJS2MQTT asks for it.

Now you're ready to pair.  Plug the keypad into a power outlet (it will not pair on batteries).  Start inclusion by clicking "Manage Nodes" on the main ZWaveJS2MQTT page, then selecting Default mode.  Once inclusion mode starts, hold down the 1 key on the keypad until the green indicator starts flashing.

This file has been truncated. show original

Tried several options, but the keypad doesn’t seem to respond to any of them

DaneedeKruyff · August 24, 2022, 1:16pm

Yes, the keypad can be used as a siren, I wrote that functionality for the V1 keypad but disabled that part of the code when I copied it to start writing the V2 driver. I haven’t yet come around to testing it on the V2 keypad as my time is limited (and little to no demand for that functionality)

By walk-in timer I guess you mean the Alarm Delay in Heimdall, am I right? That’s implemented for both Arming and Disarming and for both Keypad versions. The functionality in the V2 keypad is however limit to 60 seconds, so when you select a Arming Delay or Alarm Delay that is longer the functionality is started an then restarted again (possibly several times) to match the ending of the delay in the device to the actual delay as set in Heimdall.

It’s possible to send raw Z-Wave commands to the keypad.The indicator class mentioned in the article you linked is also not implemented in Homey so that communication with the V2 device is done by crafting the commands into a message tot send to the device, similar as to how it’s done in Home Assistant.

MrBlue · August 24, 2022, 1:49pm

I respect that. If there’s a workaround to get this working with a flow (sending raw commands or anything), it would be great as well.

Correct. I currently set it to 30 seconds and noticed it showing the arming delay.
However, while opening the front door (triggered with delay), the panel didn’t provide any sound notification or the delay led bar (not sure about the formal definition).

Good to hear it’s still possible. However, would I be able to implement this myself (through RAW commands, Homeyscript, or another app), or is this only possible through the app developer (you).

Again, I really appreciate your support in this.

DaneedeKruyff · August 25, 2022, 11:46am

Thanks for your appreciation!

I looked at the code for the Alarm Delay and realised I only added the Arming Delay to the app in the 0.2.3 version. So, I added the Alarm Delay and submitted 0.2.4 for approval.
And while I was at it, I also finished the Siren function

(Btw, the Home Assistant article helped me figuring out how to control the duration for the Arming- & Alarm Delay so now it uses the exact delays as configured in Heimdall!)

MrBlue · August 25, 2022, 1:49pm

That’s awesome!
I’ll be out for holidays for the next weeks, but will try to test it tonight and see if it works

DaneedeKruyff · August 25, 2022, 4:14pm

It isn’t approved yet but I see it is installed on several homey’s, I hope you find some time to test and report back.

Tip: Before testing the siren function, set the volume to 1

MrBlue · August 25, 2022, 8:33pm

Holy sh*t this is so cool!
Both the Alarm delay and the sirens work beautifully! Exactly what I was looking for!
And you’re right. Siren level 10 is pretty intense

How easy/feasible would it be to trigger the different sirens from a flow?
For Heimdall I set the siren to Burglar Alarm, but for a fire alarm I would like to be able to trigger the Smoke Alarm siren. For the medical emergency button, the Medical ‘Alarm’ would be triggered.

DaneedeKruyff · August 26, 2022, 6:43am

Glad you like it!

That’s pretty easy, it will just require some time. It’s already on my todo list

guy · August 26, 2022, 3:40pm

@DaneedeKruyff It looks like the app is offline. Is that on purpose, or is there something wrong?

DaneedeKruyff · August 26, 2022, 4:11pm

That’s because I’ve submitted a new (test) version for approval, unfortunately the app is unavailable in the App Store until someone at Athom approves it.

DaneedeKruyff · August 29, 2022, 3:19pm

New version published

Version: 0.2.4 Beta

Minor changes, minor fixes and added translations
Added Alarm Delay for Ring Keypad from the 2nd Generation
Added Siren function for Ring Keypad from the 2nd Generation

In the previous version the Arming Delay was added and in this version completes it with the Alarm Delay for the Ring Keypad V2. And it is now also possible to use the Ring Keypad V2 as a siren for Heimdall. There is no need to configure flows, just make sure the Integrate with Heimdall is set to Yes and you have selected the siren type.
Tip: first test it with Siren Volume set to 1

TEST ALERT

In this version I’ve also added the Ring Contact Sensor from the 2nd Generation, but be aware: As I don’t have the device I have no idea if it works. Unfortunately I have also no documentation for this sensor so the code I wrote is all based on… guessing
I’m curious to know if it works, please let me know!
(@KjetilK)

I_am_who · August 30, 2022, 4:59pm

Great stuff. Just did two quick tests. Works like a charm, siren is active. Not so very loud (set to 10) but that’s hardware i guess. Delay is also very nice. Count down works. Red stripe visible. Thanks very much for the update much appreciated

Peter_Van_Hees · August 30, 2022, 5:25pm

Hi @DaneedeKruyff , I have installed and tested the latest version 0.2.4 beta version, the siren works fine, I set the volume to 10 and it works fine especially at night. shutdown works fine via 12345 disarmed/home without flow. my hub mini that produces the sound above stops via a flow. All LEDs work fine during arming and disarming. thanks again for the update. thank you very much, much appreciated here.

DjWhacked · August 31, 2022, 11:26am

Indeed @MrBlue
I also had the freezing upon entering a PIN+ENTER.
I guess its because you don’t need to use PIN + ENTER but rather PIN+status you want of the arming or disarming.
Currently not sure what “enter” really is being used for, but technically you don"t need it if it works with heimdall or homey.

MrBlue · August 31, 2022, 12:09pm

The only (official) use I found for the Enter key is to ignore the active sensors while arming the system.

The unofficial use is that I would like to trigger flows/actions this way (ex: open garage door with 0+Enter when system disarmed).

Another thing is that I would like to avoid the system hang itself when someone else outside the family would like to disarm and accidentally pushes Enter instead of Disarm.
Though not quite sure how we could do a root cause analysis on this…

DaneedeKruyff · August 31, 2022, 7:01pm

@DjWhacked, @MrBlue, does this only happen when entering PIN+ENTER?
I’d like to know if this also happens when you enter PIN+CANCEL or just a PIN and let it be (The keypad will eventually send the PIN when nothing else is entered.)

DjWhacked · August 31, 2022, 7:46pm

If I do PIN several times with cancel behind it, it doenst stall. I think it’s indeed not sending.
I did get the wireless wifi logo on there, as I’ve done a quick 7 times loop of pins with cancel.
But keypad didn’t freeze indeed, more like only if you do enter after PIN.
At the end it doenst matter as we ENTER button doenst do a lot for me at least in my setup.

MrBlue · September 8, 2022, 11:23am

Haven’t been able to try it myself yet as I’m still on holiday.
But interesting to read that the cancel button doesn’t freeze the keypad. Does that still send the keypress command to Homey?
If it does, the only difference I consider is the ‘invalid PIN’-command being sent back by Homey that triggers the ‘invalid PIN’-animation(?) on the panel. Could it be that those commands follow up so quickly that the keypad crashes/freezes?
Again, just thinking out loud

DaneedeKruyff · September 8, 2022, 3:11pm

I missed the earlier response by @DjWhacked, so sorry for not responding earlier.

The keypad does send the information to Homey after pressing the Cancel key and the Ring Security app relays that to Heimdall. Heimdall writes that to the log and sends a message back to the Ring Security app that no action was taken. Next the Ring Security app sends a command to the keypad to inform the user no action was taken. There is no difference in the command that is send when using the Cancel or Enter key.

I’m really lost here why these freezes happen to some of you….

Topic		Replies	Views
Ring keypad and other Ring Security System devices Devices	23	2954	May 26, 2021
Ring Doorbell and Camera support for Homey Apps app , official , security , homey-pro	312	11330	May 2, 2024
Ring Keypad - able to add it to Homey?! Apps	11	2698	March 12, 2019
Ring Security Motion Sensor v2 Devices z-wave , security , homey-pro	4	415	September 11, 2023
Add Ring Alarm Contact Sensor Ideas & Suggestions	2	520	September 1, 2022

Ring Security - Extend Heimdall with Ring Security products

Version: 0.2.4 Beta

Related Topics