Bud

Apr 6, 2023

SmartThings Edge Driver and Routine Setup for the Ring Alarm Keypad 2nd Gen

Updated: Apr 7

So the question on your mind is likely whether the Ring Alarm Keypad is able to function properly within SmartThings as a fully functional security keypad capable of arming and disarming your SmartThings home? Is it also capable of producing audible and visual countdowns to accommodate delayed home entries and exits? These very questions have plagued mankind since the beginning of time… needle screech, or at least they have plagued SmartThings enthusiast since the advent of the Ring Keypad.

Is it possible that someone may have developed an Edge Driver to not only provided the keypad with the ability to arm and disarm you home, but also offer many more features, all of which can be activated with the simple press of a button? This article will attempt to answer these vexing questions while providing a product review and driver links so that you can take advantage of its awesome features.

So yes, the Generation 2 Ring Alarm Keypad will operate with the SmartThings hub. And yes, there is an available edge driver that will give you the ability to enable the features that I will cover in today’s product review. Before I provide driver and installation tips, let's review the extensive list of available feature.

The Gen 2 Ring Alarm Keypad is designed with versatility in mind. The unit can easily be mounted on the wall or it may also be used as a portable desktop keypad.

The keypad has two power options. You may plug the keypad into standard power outlet using the provided electric cord and plug or may charge it periodically to run on a rechargeable battery that keeps your Keypad active even if the power goes out.

With the installation of the SmartThings custom edge driver you will have several features to include:

  • Setting the PIN code for the “disarm” and “arm home” buttons

  • A wrong PIN signal when making a PIN entry error.

  • Motion Sensor - lights keypad when motion detected. Can also be used trigger actions in ST

  • Power source indicator light

  • Panic combination (hold simultaneously “X” and “Check” buttons)

  • Doorbell with selection of 5 sounds

  • Entry and exit delay counters.

  • Keypad configuration options in the settings menu

This keypad is compatible with any of the three SmartThings security modes: Disarmed, Armed Away and Armed Stay. The alarm system state is synchronized with STHM without any automation. Changing the state in STHM will change it also in the keypad. The opposite synchronization is not enabled but you can create SmartThings routines to enable synchronization on the Ring Keypad. I have included sample routines on below your reference and convenience.

The driver does not require you to enter the PIN to activate the Arm (away) mode. A PIN code is necessary for the Disarm and Arm (stay) modes. The PIN Code, Exit and Entry delay and the doorbell sound and volume can be configured within the keypad settings.

PRO TIP: To keep the security mode display active at all times go into the keypad's settings and scroll all the way to the bottom to find "System security mode display". Change the default setting to the value of '601' to keep the display 'Always On'.

Review of Ring Keypad Features - YouTube:

Ring Keypad Installation Steps:

Ring Edge Driver Download Instructions

Install the Edge Driver using the following step by step instructions:

Tap on the following Hmorsti Drivers Channel Invitation

  • Accept the Channel Invitation and tap on 'Available Drivers'.

  • Tap on the 'Install' button under the driver 'Z-Wave Keypad'.

  • The edge driver will be installed on your target hub.

  • Now you are ready to install the Ring Alarm Keypad

Ring Keypad Inclusion

Bring the keypad close to your hub.

Plug the USB cable into a USB charger, this is make the Network LED start flashing green slowly. When the Network LED is flashing green, that means it isn’t paired with the hub.

This keypad supports S2 level security and performs better when using S2 mode. To put the hub into S2 pairing mode, from the SmartThings app, click + → Device → Select Generic Z-Wave Device from the list and then follow the instructions. It will prompt you for the QR code or DSK key when it pairs successfully in S2 mode.

If you’re having trouble pairing the device, power cycle your hub and try to exclude the device first.

If Network LED starts flashing red, this means that the keypad has lost it’s connection with the mesh. Move the keypad closer to the hub (or add a Z-Wave repeater)

IMPORTANT: Inclusion can be tricky with the SmartThings Hub. If you are having difficulty pairing your keypad, press and hold the 1 key. The the Network LED will begin flashing green quickly. Continue to hold the 1 key until the keypad successfully pairs then release the key.

The keypad should automatically install the 'Z-Wave Keypad' edge driver from the Hmorsti Driver Channel. You can verify the assignment of the Hmorsti driver by tapping on the ellipsis in the upper right corner while in the device details screen of your SmartThings app. Select "Driver" from the dropdown list and verify that you have the Name: "Z-Wave Keypad" and the Channel: "Hmorsti drivers"

Ring Keypad Exclusion

Bring the keypad within 5ft of the hub. Tap and hold the Ring Keypad tile to invoke the options menu. Select 'Remove' to invoke the Z-Wave Exclusion mode. With you hub in exclusion mode, use a pin to press the button in the hole behind the keypad, the network LED should flash red to indicate the exclusion was successful and then start flashing green. If the Ring Keypad was not successfully excluded insert the pin in the hole behind the keypad as many times necessary to exclude the keypad. If the exclusion still fails and gives you the option to Force Delete the keypad then tap on 'Force Delete' to remove the key pad.

Ring Keypad Factory Reset Instructions

Use a pin to press the button in the hole behind the keypad for about 10 seconds until the network LED flashes red and then starts flashing green slowly

Virtual Switches and Routines needed to manage SmartThings Home Monitor Security Mode changes:

To utilize the full potential of the Ring Alarm Keypad we will need to create routines in SmartThings and a couple of rules within the SharpTools App. If you are not familiar with SharpTools, just know that SharpTools supports integration with platforms like SmartThings, Hubitat, and Tasker, enabling users to automate their smart home devices and create routines that permit users to set up conditional actions based on triggers and events within their smart home ecosystem. Do not be overly concerned about writing these rules as I will provide guidance later in this article to help you construct these rules within SharpTools.

Before writing the rules in SharpTools you need to create five virtual switches within SmartThings using two virtual buttons and three virtual switches . The virtual buttons/switches are the five devices seen in the following screenshot. They are the devices that have the prefix "vEdge".

You will need to download TAustin’s vEdge Creator app version 2.94 to your SmartThings hub in order to create two vEdge ‘Momentary Button Only’ buttons. After you tap on the TAustin's Virtual Device Creator link you will login to your SmartThings account and then:

> Click Accept

> Click View Drivers

> Install the driver titles Virtual Devices V2

> Then return to your SmartThings app/ Select the "+" at the top of the app screen

> Next tap "Scan for nearby devices"

> The ST app will discover and install the vEdge Creator v2.94 (or most recent version)

NOTE: See the my website article if you need additional help to download TAustin's vEdge creator app!!

Pro Tip: To update your vEdge Creator to the latest version, simply delete vEdge Creator from your SmartThings app and then select the "+" at the top of the app screen and tap "Scan for nearby devices"


 
Once the vEdge Creator app is installed, tap on the the app tile and then select the settings cog next to the option to "Select & Create Virtual Device(s)". Scroll down the list and select "Momentary Button Only" then in the following screen under "Quantity to Create" tap on the setting cog to request the creation of two (2) buttons.

Once the two momentary buttons are created you must name the first momentary button as vEdge Entry Delay Button and the second button must be named vEdge Exit Delay Button.

You will also use TAustin's virtual device creator app to create the following three vEdge Security Mode switches. The device type to select for the creation of these virtual switches is the vEdge "Switch". You will name these three Security Mode switches as indicated in the following screenshot:

  • vEdge Disarm

  • vEdge Arm Stay

  • vEdge Arm Away

Once you have created the proceeding five virtual device switches/buttons I recommend that you move these devices to a common room within your SmartThings app. You should also move the Ring Keypad 2nd Gen device to this same room. I personally titled this room -SHM, which is an abbreviation for (Smart Home Monitor). You may name the room as you wish.

With your Ring Keypad is installed and the two vEdge momentary buttons and the three SmartThings mode switches are created, you must now use the vEdge virtual switches and buttons within a total of thirteen (13) SmartThings routines. The purpose of six (6) of these routines is to communicate SmartThings mode changes to the SharpTools app. (More about the SharpTools app later in this article). These first six routines are necessary because SmartThings mode changes are not available within SharpTools. The routines will use the three vEdge switches to broadcast SmartThings mode changes, Disarm, Arm(stay) and Arm(away) to the SharpTools app.

Three of the six routines coordinate the three SmartThings security modes so that when one security mode is active, the other two modes are set to inactive. As an example, the Security Disarm routine is triggered when the SmartThings Home Monitor (STHM) is changed to Disarm. The routine's actions are to turn the vEdge Disarm switch "ON", and at the same time turn the vEdge Arm(away) and vEdge Arm(stay) switches "OFF". The same logic is repeated for the other two STHM modes.

Then it is a matter of writing three additional routines that change the appropriate STHM security mode when the corresponding virtual switch is "ON". As an example, as displayed in the Security-Disarm, On routine, when the vEdge Disarm virtual switch is on then change the STHM security mode to Disarmed. You will need to write two additional routines for the Arm(stay) and Arm(away) virtual switches using the same logic.

With the first six routines completed we have seven (7) additional routines to write. The following three routines are needed to change the SmartThings Security Mode when a security mode button is pressed on the ring alarm keypad.

The first routine below changes the SmartThings mode to Armed (stay) when the Keypads' Arm Home Button (armHomeButton) is pressed. The second routine changes the SmartThings mode to Disarmed when the Keypads' Disarm Button (disarmAllButton) is pressed during the Arm(stay) Mode. The third routine changes the SmartThings mode to Disarmed when the Keypads' Disarm Button (disarmAllButton) is pressed during the Arm(away) Mode.

The next two routines are necessary to define delay periods for the Exit Delay and the Entry Delay countdown periods. The Exit delay is triggered (started) by the tap of the keypads' Arm Away Button. The Entry Delay is triggered (started) when any contact sensor on your external entrances is opened while your SmartThings Home Monitor (STHM) is in Armed Away mode. The time period for these delays can be different for Entry and Exit with the minimum delay at 1 second and the maximum delay at 180 seconds. For my demonstration I used at delay period of 30 seconds for both the Exit Delay and the Entry Delay.
 

The first routine displayed below states that IF the STHM is in the precondition of "Disarmed" and the keypads' Arm Away button is pressed, THEN turn on the vEdge(virtual ) Exit Delay Button after the time period of 30 seconds has concluded. The second routine states that IF the STHM is in the precondition of "Armed Away" and the one for the homes Exterior Door Contact sensors is OPEN, THEN turn on the vEdge(virtual ) Entry Delay Button after the time period of 30 seconds has concluded.

Note: the third, partial routine is the remaining half of the second routine:

The following two routines specify the actions that are to occur if the 30 second countdown concludes without interruption. The first routine sets the STHM to the Armed Away mode if the vEdge (virtual ) Exit Delay Button is trigger "ON" following the expiration of the 30 second delay. The second routine checks to see if the STHM remains in the Armed Away mode with the expiration of the 30 second delay and if the system stays in the Armed Away mode, as confirmed by the precondition, then when the vEdge Entry Button is triggered "ON", THEN the routine sends a notification to members to contact the police.

Note: The vEdge Exit Delay Button will not be triggered on provided the keypad's Disarm button is pressed before the end of the set delay period.

Setting Up Rules within SharpTools to Execute the exitDelay and entryDelay Keypad Functions:

Although I was able able to define the length of entry and exit delays with in the ST app, I was not able to access the exitDelay and entryDelay function within a ST routine. It appears this prohibition on accessing the exitDelay and entryDelay functions is specific to the iOS operating system (iPhone). I have been advised that Android users can access these functions when writing ST routines. To be able to access the Ring Keypad functions I decided to add the Ring Keypad to the list of devices in my SharpTools account. If you integrate the SharpTools app with SmartThings you can create "SharpTool Rules" to execute functions, similar to the creating routines in SmartThings. The SharpTools app allows you to write more complex rules (routines) that expand the capabilities of SmartThings devices.

I was pleased to see that I had access to all for the Ring Alarm commands within the SharpTools Rule maker. I proceeded to use the SharpTools Rule Engine to write the following exitDelay and the entryDelay rules.

SharpTools Rule to invoke the exitDelay function on Ring Keypad

SharpTools Rule to invoke the entryDelay function on Ring Keypad

SharpTools Rule to invoke the Door Chime function on Ring Keypad

Keep in mind that the purpose of the SharpTools rules are to start or stop the audio and visual timer on the keypad. The changes to SmartThings Home Monitor (STHM) are managed by the routines in the SmartThings app. So the exit and entry routines will work without the SharpTools rules however you will not have the visual and audible progress bar absent the SharpTools app. The capability to add these functions in SmartThings could be available in the future if the author of the driver decides to update the driver to allow access to the functions.

With the completion of the SmartThings routines and the SharpTools rules you should now have a full functioning Ring Alarm Keypad capable of managing your SmartThings Home Monitoring system.

Important Note: The SmartThings Home Monitor has settings to control which sensors and alarms are to be used while the Security Mode is in Armed Stay or in Armed Away. It is vital that make sure that any exit delay periods defined in the Ring Alarm Keypad coincide (are the same) as the Alarm delay that is set with the STHM security settings. For this example, I set the keypads' exit delay at 30 seconds. I also wrote my SmartThings routines and SharpTools rules with 30 second delays as well. Finally, I went into the STHM Security setting to SET RESPONSE for "No delay" for the Delay before alert setting and I set the RESPONSE DELAY - Delay time to "30 seconds"

In conclusion I will reiterate the driver disclaimer that was issued by the author:

"As the driver is related to safety and security and I cannot guarantee that it will work as intended, please don’t rely solely on it. Use it at your own risk."

And finally, I recommend the purchase of multiple keypads which can be mounted in the garage, a second floor and at your back and front doors for added convenience. Here is my Ring Keypad Amazon product link for your convenience.

Important Links:

Ring Alarm Keypad (Gen 2)

Ring Alarm Keypad (2nd Gen) Lights and Buttons Explained

Hmorsti SmartThings Channel Invitation

Edge Driver Name: ' Z-Wave Keypad '

SmartThings Community Article

SharpTools Overview Video

TAustins vEdge Creator Article

Creator's Comment

This was an rewarding yet difficult and time consuming project. If you benefited form my efforts please consider a gift. I would like to keep such content free to my followers and any financial gift will help me to continue offer this sort of content without resorting to a restrictive paywall.

Thank you for your kind and generous support!!

You can also support me by shopping my Amazon Store

    12