[RELEASE] Enhanced ZigBee Keypad Device Handler - Centralite, UEI, IRIS, Xfinity, Scout

[RBoy (www.rboyapps.com - Making SmartThings Easy!)]

RBoy Apps is a SmartThings partner for Centralite

Introducing the Enhanced ZigBee Keypad device handler

Make your keypad work like a lock keypad in SmartThings so it can work with SmartApps designed for managing locks/doors/garage doors, user codes and lots more. (see below for more details).

Classic App

This Device Handler is compatible with most ZigBee keypads like the Centralite, UEI, Xfinity, Lowes Iris, Scout keypads.

Detailed comparison of the keypads features here

The UEI keypad can be bought from eBay for about $15

The Xfinity keypads can be purchased from Comcast Home Security or from eBay (3400-X and XHK1) for about $10 to $20

The Lowes IRIS v3 keypad (IL021) can be bought from Lowes or from eBay for about $40

The Lowes IRIS v2 keypad (3405-L) can be bought from Lowes or from Amazon for about $40

The Centralite 3400-X keypad can be bought from Amazon or from eBay for about $45

The Centralite 3400-C/3400-G retail smart keypad can be bought from Centralite or from GoKeyless for about $35

The Scout keypad can be bought from Scout or from Amazon for about $50

Battery Notes:

• The IRIS v2/Centralite 3400-C/3400-G/Xfinity 3400-X keypads use 2 x CR123A batteries
• The newer UEI/Xfinity XHK1/IRIS v3 keypads use 4 x AA batteries and last 3 - 8 times longer than the other keypads depending on the type of battery used (Lithium, Alkaline, NiMH/NiCd)

UEI/Xfinity XHK1-> <-Centralite/Xfinity 3400-X
Iris v2 (3405-L)-> <-Iris v3 (iL02_1)
Centralite 3400-C/3400-G → ← Scout

You can find the latest features and supported models on our website

This device handler supports the following features (refer to the release notes/website for latest updates):

1. Work as a keypad lock in SmartThings
   • Set/use 4 digit codes
   • Enable/disable keypad
   • Enable/disable auto lock
   • Lock and unlock using user codes
   • Invalid code notifications
2. Ability to arm/disarm STHM from supported keypads
3. Read the following sensors
   • Temperature (auto convert to F or C depending upon your location)
   • Motion
   • Battery (new battery calibration algorithm)
     • Centralite/Iris v2/Xfinity keypad support for CR123A Lithium batteries
     • UEI/Xfinity/Iris v3 support for AA Lithium, Alkaline, NiMH/NiCD batteries
   • Tamper
4. Use as a Tone capability device (beep/chime)
5. Use as a Siren/Alarm capability device (supported models)
6. Locate keypad using a beep
7. Ability to configure the following parameters:
   • Auto lock delay
   • Number of beeps (for beep command)
   • Temperature offset (for correcting the temperature reported by the sensor)
   • Ability to configure the Inactivity timeout (the number of minutes since the last motion was detected after which the motion sensor sends a no motion detected event)
   • Select battery types for AA models
8. Use with Lock User Management (LUM) to control STHM from the keypad using virtual switches
9. Compatible with SmartLocks and lock/code management apps like Lock User Management (LUM) and Rental Lock Automater (RLA)
10. Use with Lock & Door Synchronizer to control Garage Doors, Patio Doors and synchronize with other locks/devices
11. Compatible with legacy SmartApps designed for direct keypad integration
12. Use with Chime and Notifications for Doorbells and Sensors

Siren and Chime Features

• Keypads which have a built in beeper can be used as a Chime for sensors/buttons (e.g. door bells or door open/close) using the Beep or Tone capability
• Iris keypads have a built in Siren that can be triggered with the panic button or independently as an Alarm
  • Iris v2 (3405-L) 60dB siren
  • Iris v3 (iL02_1) 85dB siren
    You can use these keypads with a compatible Chime SmartApp

Sample Use Cases for Keypads in SmartThings (requires compatible SmartApps)

• Siren/alarm (models which support it)
• Chime/beeper to notify when doors/windows are opened/closed
• Panic button
• Secondary keypad for locks
• Primary keypad for garage doors/patio doors
• Temperature sensor
• Motion sensor (for close up motion)
• Program codes and create custom actions for each code and for each button (away/night/home)
  • Run/activate/deactivate switches/controls/routines etc
  • Create custom actions
  • Arm/disarm STHM/Intruder/Security System/Hub modes
• Chime the keypad when doors/windows are opened or something is turned on/off

Supported apps like Rental Lock Automater, Lock User Management and CoRE/WebCORE can allow the keypad to arm/disarm STHM using virtual switches:

• CoRE/WebCoRE Arming → Subscribe to the attribute armMode. The reported values are:
  • 0 for Disarm
  • 1 for Armed Stay
  • 2 for Armed Night
  • 3 for Armed Away
• CoRE/WebCoRE User Events → See this post on how to capture/process user events

STHM Synchronization

• For changing STHM modes using the keypad see this post
• To change the keypad mode when changing the STHM mode in the SmartThings mobile app, see two way synchronization of the keypad with STHM see this post

• Centralite/UEI/Xfinity keypad (after programming codes):
  • to arm STHM press one of the 3 modes buttons on top followed by a valid 4 digit user code
  • to disarm STHM enter a valid 4 digit user code
• Iris v2 keypad (after programming codes):
  • to arm STHM enter a valid 4 digit user code followed by the Partial button (Armed Stay) or the On button (Armed Away)
  • to disarm STHM enter a valid 4 digit user code, press the OFF button
• Iris v3 keypad (after programming codes):
  • to arm STHM press the Partial button (Armed Stay) or the On button (Armed Away) (this keypad does NOT support user codes for arming)
  • to disarm STHM enter a valid 4 digit user code, press the OFF button
• 
  Scout keypad (after programming codes):
  • to arm STHM enter a valid 4 digit user code followed by the Zzz button (Armed Stay) or the Lock button (Armed Away)
  • this keypad has an option to enable/disable the 4 digit user code for arming
  • to disarm STHM enter a valid 4 digit user code, press the Unlock button
• When STHM is armed via the keypad, the LED light on top will glow red and the appropriate mode button will light up (if present) (required supporting SmartApp)
• When STHM is disarmed via the keypad, the LED light will be green/red OFF button will light up (requires supporting SmartApp)

NOTE:

• This device handler is compatible with Mitch Pond/Zack Cornelius dth so you can use it with the existing apps like Keypad Coordinator, SmartAlarms, SHM Delay etc
• Since the device has no “physical” locking mechanism, it is recommended to use it in conjunction with SmartApps like CoRE, WebCORE, LUM or Rental Lock Automater to control a physical switch or lock etc.
• The Iris v3 Keypad arms directly when the On/Partial button is pressed. It does not use a 4 digits code for arming like the other keywords.
• The Scout keypad has the option to enable/disable the user pin code for arming from the DTH settings page
• For operating other keypads, press an action button (off/on/night/away/stay) followed by a 4 digits user pin.

Low Battery: If your battery falls below 20% consider replacing it. The unit will start flashing a red light when the battery level is low.

More features to added, if you have any suggestions or ideas please feel free to ask and we’ll try to add it.

INSTALLATION INSTRUCTIONS

You can find the step by step instructions to install the Device Handler here.

INCLUSION INSTRUCTIONS:

It is recommended to install the Device Handler BEFORE paring the device for easier setup.

1. Remove the batteries from the device
2. Open the SmartThings mobile app and click on + or Add a thing to put the hub into pairing mode
3. Make sure you’ve inserted the covering piece at the back of the device so that pairing button is pressed

Centralite 3400-C/3400-G/Xfinity 3400-X/Iris v2

1. Remove the covering piece
2. Press and hold the tamper switch
3. While holding the tamper switch insert one battery into the device (use CR123A Lithium batteries)
4. Release the tamper switch
5. It should complete pairing within 30 seconds and it should show up on your SmartThing mobile device
6. The device wifi/signal LED should be flashing green
7. Insert the second battery and the wifi/signal LED should stop flashing
8. Re-insert the covering piece (if the LED doesn’t stop flashing see the TIPS below)

UEI/Xfinity XHK1

1. Insert the 4 batteries (use AA Lithium 1.5v batteries for best performance, AA Alkaline batteries or AA Rechargeable NiMH/NiCd batteries).
2. The Pairing LED light should start flashing (indicating it’s in pairing mode). If the light is not flashing, follow the Exclusion Instruction below to get it back into pairing mode
3. The device wifi/signal LED should be flashing green
4. On successful pairing the pairing LED should flashing and the the wifi/signal LED should be lit
5. Set the battery type (Lithium, Alkaline, Rechargeable) in the device preferences page (click the Gear icon on top right corner of the keypad page in the ST Classic app), after pairing for accurate battery life reporting

Iris v3

1. Insert the 4 batteries (use AA Lithium 1.5v batteries for best performance, AA Alkaline batteries or AA Rechargeable NiMH/NiCd batteries).
2. The Pairing LED light should start flashing blue (indicating it’s in pairing mode). If the light is not flashing, follow the Exclusion Instruction below to get it back into pairing mode
3. On successful pairing the pairing LED should flashing green
4. Set the battery type (Lithium, Alkaline, Rechargeable) in the device preferences page (click the Gear icon on top right corner of the keypad page in the ST Classic app), after pairing for accurate battery life reporting

Scout

1. Insert the 2 batteries (CR123A)
2. The Pairing LED light should start flashing green 3 times every 5 seconds indicating it’s in pairing mode. If the light is not flashing, follow the Exclusion Instruction below to get it back into pairing mode
3. On successful pairing the pairing LED should steady green

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

TIP: If the network LED continues to blink even after pairing, press the tamper button 5 times to reset it

NOTE: If all the arm mode lights are blinking in series (On/Partial/Off or Away/Stay/Night etc), this means that the keypad has lost it’s connection with the mesh. Move the keypad closer to the hub or add a ZigBee repeater. If that doesn’t work, remove the battery for a few seconds, re-insert it and then tap the refresh tile to resync and reestablish communication with the hub.

EXCLUSION INSTRUCTIONS:

Click on the gear icon (top right corner) in your SmartThings mobile phone device page. Scroll down to the bottom and click Remove and follow instructions.

FACTORY RESET INSTRUCTIONS:

Centralite/Xfinity/Iris v2/UEI

• If the exclusion was not successful (which can happen if the device did not receive the exclusion notification from the hub, when not paired the wifi/signal LED will not be lit), remove the cover and the batteries, keep the tamper/pairing button pressed while inserting the batteries and then release the tamper/pairing button. For the XHK1 models it should make the pairing LED start flashing
• Press the tamper switch 5 times to reset the keypad

Iris v3

• Remove 1 battery and wait ten seconds
• Re-insert the battery while holding down the reset button on the side and release when the status light blinks red once and then start blinking blue

Scout

• Remove both batteries
• Press the tamper switch, re-insert the battery while holding down the tamper switch
• Release the tamper switch within 4 seconds and the pairing LED should start blinking green

Comparison of Keypad Features

Check out the Ring Gen2 Keypad Device Handler

Real-Time Updates With SmartLocks

While this device handler is compatible with SmartLocks, if you would like to see real time updates to the dashboard in Smart Locks (locking, unlock etc), change the name of the device handler in metadata section from

name: “Enhanced ZigBee Keypad Lock”

to

name: “ZigBee Lock”

Save and Publish → viola, real time updates in SmartLocks

This device type handler is available on the RBoy Apps Server, http://www.rboyapps.com. Refer to our website or facebook page below to get access to the server.

Visit our Facebook page for updates on new apps and to get access to our Premium Apps. RBOY APPS SmartThings - Make your Home your Butler

(c) RBoy Apps

[kamran (MacTechGenius)]

Is this a device handler or a smart app?

So it works with Lock Manager but does it work with [RELEASE] Keypad Coordinator - Bring out the power of your Keypads

[RBoy (www.rboyapps.com - Making SmartThings Easy!)]

It’s a device handler and it works with all the legacy/older SmartApps that relied on the custom keypad DTH (see first post).

It has added new capabilities to allow it to work the SmartApps that use “lock” capabilities like Lock Code User Management, lock manager and SmartLocks.

[timd1971 (Tim)]

What are the main differences or advantages from this one?

[OBSOLETE] Lowes Iris and XFinity CentraLite keypad DTH + Apps

Continuing the discussion from [CentraLite Keypads] (CentraLite Keypads - #985 by zcorneli): This DTH is based on @mitchp’s original code, with improvements from @RudiP, as well as: Nicer tiles (largely from RudiP’s work) Better support for the tome capability Supports the panic button both as a contact sensor and a button (button 1) Supports reporting motion via the keypad wakeup sensor. Improved pairing procedure to be more reliable Support for the Tamper switch (Via tamper capability) Support for Entry and Exit delay beeps via SmartAlarm + User Lock Manager Support for Exit delay beeps via User Lock Manager Can be used with User Lock Manager, or with User Lock Manager and SmartAlarm Keypad Improved User Lock Manager SmartApp: Support multiple keypads Support Keypad exit delay Imp…

Does it work with ArnB’s Delay and Xfinity 3400?

[OBSOLETE] SHM Delay Version 2.0

Table of Contents New Install? Use the Classic app and Modes, then consider moving to the New App 1. Purpose 2. Support This Project - Donate 3. Features 4. Quick Setup Guide 5. Installing the Smartapp 6. Create Simulated Sensor 7. Settings: SHM Classic and STHM New App 8. Settings: SmartThings Home Monitor-STHM New App or SHM without Routines 9. Global Definitions 10. Delay Profile Setup 11. User/Pin Profile Setup 12. Modefix Setup and Usage, Fix keypad out of sync with SHM Arming State 13. How to Use Keypads 14. Supported Keypads, hardware setup and troubleshooting 15. Initial Testing 16. Fix Motion Sensor Intrusion During Entry Delay 17. Fix Motion Sensor Intrusion During Exit Delay 18. Using Sounds and Text to Speach 19. Fix Siren Alarm During Entry dela…

Thank you!

[RBoy (www.rboyapps.com - Making SmartThings Easy!)]

This DTH retains compatibility with the older DTH so works with the Apps you’ve mentioned (on request from users, see below)

We’ve added new capabilities of locks and user programming so that it can be used with SmartApps that are designed to work with locks. It has also new additional features like Alarms, Panic buttons for the IRIS keypads v2 and v3, enabling/disabling the keypad and lots more.

So you can use it with the SmartApps you’ve mentioned and the newer Lock/User management SmartApps (at the same time).

Yes it’s compatible with the Xfinity 3400 (see the screenshots) and the IRIS 2405, we’re working on adding more keypads models to it. If you have any requests for specific models please send them in.

[joelw135 (Joel W)]

@RBoy

This DTH retains compatibility with the older DTH so works with the Apps you’ve mentioned.

I have a problem, I replaced the standard Centralight DTH with yours and the status says unknown. Did I miss something? Is that because I have no door locks? If so it would be nice if it could be removed if no lock present.

[RBoy (www.rboyapps.com - Making SmartThings Easy!)]

That’s the “lock” status, since it’s never been used as yet it’s showing “unknown”, just tap on it and it’ll initialize itself.
Not sure what you mean by remove since this is a lock DTH so it will show the “current” status of the last action taken (locked or unlocked)

EDIT: We have a new app coming out shortly that will complement this DTH and would probably address your question for the use of the lock

[Jeremiah_Goode]

I have the device handler installed and am using your “Door lock code user management with notifications and automatic relock, Lock User Management v07.01.00” and am having an issue.

I have configured the lock “Xfinity 3400-X keypad” lock\unlock actions to the following:

Keypad Unlock Actions: Run a routine, Change mode to Home and Disarm Smart Home Monitor
Keypad Lock Actions: Run a routine, Change mode to Away and Arm Smart Home Monitor to Away
Manual Unlock Actions: Run routine, Change mode to Home and Disarm Smart Home Monitor
Manual Lock Actions: Run a routine, Change mode to Night and Arm Smart Home Monitor to Home

I hit one of the three button on the top of the Xfinity keypad and enter my code. It beeps to confirm and doesn’t change the SHM mode, the mode stays on Disarmed. If I manually change the mode to Armed(away) or Armed(stay) and push any of the three buttons on the top of the Xfinity keypad and enter my code, the SHM mode changes to Disarmed. If I just put in my code w/out pressing any of the three buttons on the top of the Xfinity keypad it also changes the SHM mode to Disarmed if in any other SHM mode besides Disarmed.

I’m not sure what I am doing wrong, is there something wrong w/ my setup?

Thanks,
JMG

[RBoy (www.rboyapps.com - Making SmartThings Easy!)]

@Jeremiah_Goode

Lock User Management v07.01.00

Update to the latest version 07.05.01, it adds support for the keypad locks - you should also see a new option to directly arm/disarm SHM from the keypads.

[Jeremiah_Goode]

Ok I’ve updated to 07.05.01. I did see a new option under lock/unlock actions for the xfinity keypad unlock actions that now says “control smart home monitor using keypad” instead of what it used to say and still says under Manual Unlock Actions “Disarm Smart Home Monitor” but I haven’t found the new option to directly arm/disarm SHM from the keypads.

Where is that option? I’m still not able to arm w/ the new version. I can disarm but can’t arm stay or away.

JMG

[RBoy (www.rboyapps.com - Making SmartThings Easy!)]

@Jeremiah_Goode

control smart home monitor using keypad

This is it

EDIT: And I verified it’s working fine with both locks and keypads.

[RBoy (www.rboyapps.com - Making SmartThings Easy!)]

On popular request:

Enhanced ZigBee Keypad Lock - Version 01.01.00

• Added support for UEI and Xfinity XHK1-UE keypads
• Updated DTH to support latest ST ZigBee framework

This is a low cost keypad and can be purchased on eBay for about $10 to $20. See first post for pairing instructions.

[Jeremiah_Goode]

under “Keypad Unlock Actions” the setting for “Control Smart Home Monitor using keypad” is enabled, it will disarm the SHM but I can’t for the life of me figure out how to get it to Arm (away or stay) the SHM.

is there a step by step walk through manual that I can follow to ensure I have the proper things setup?

I chose the option to “Seperate actions for each door” and then configured the keypad and manual lock and unlock actions but it just won’t work.

JMG

[RBoy (www.rboyapps.com - Making SmartThings Easy!)]

You’ve done it, that’s it (see the first post for step by step).

I tested it here with the Xfinity keypad, IRIS, UEI and Centralite and it’s working fine with all of them. I suspect something else may be going on with your account. Best way to check, open IDE Live Logging, Tap the Away button on your keypad, enter your 4 digit code and look at the logs. The SmartApp should send say sending an arm away signal to ST. Then look into your SHM logs to see what may be going on.

This is what you’ll see in your logs

8:54:34 PM: trace No individual routine configured to run when locked via keypad for Iris 3405-L Keypad
8:54:34 PM: trace Did not find per user lock actions, falling back to global lock actions
8:54:34 PM: info Arming Smart Home Monitor to Away
8:54:34 PM: trace No user Test specific lock action found, falling back to global actions
8:54:34 PM: trace Lock event name lock, value locked, device Iris 3405-L Keypad, description Locked by “Test”, data {“usedCode”:“1”,“codeName”:“Test”,“method”:“keypad”,“armMode”:“armedAway”,“microDeviceTile”:{“type”:“standard”,“icon”:“st.locks.lock.locked”,“backgroundColor”:“#00a0dc”}}
8:54:34 PM: trace Iris 3405-L Keypad locked by user 1 via keypad

It’s possible that your actions/routines are interfering with your SHM, turn off all actions and turn them back on one by one until you see which one is interfering.

[RBoy (www.rboyapps.com - Making SmartThings Easy!)]

In addition to the above, on the first page of the SmartApp, scroll down to the bottom and under advanced settings and enable Detailed notifications, now it’ll send you a notification for actions it’s taking (arming/disarming, running routines etc). That will tell you if the SmartApp is sending the signal to arm SHM.

[matics]

I’m experiencing the exact same issue using a Centralite 3400-x. Disarm works as expected, however, I can’t arm SHM no matter my settings.

[RBoy (www.rboyapps.com - Making SmartThings Easy!)]

@RBoy

In addition to the above, on the first page of the SmartApp, scroll down to the bottom and under advanced settings and enable Detailed notifications, now it’ll send you a notification for actions it’s taking (arming/disarming, running routines etc). That will tell you if the SmartApp is sending the signal to arm SHM.

Did you try this and look at your IDE logs?

[Jeremiah_Goode]

My issue was that I had specific actions defined for locks per user. I was trying to setup the General Settings\Lock/unlock actions and the user\custom actions/notifications settings appear to conflict. I removed the General Settings\Lock/unlock actions and defined the user\custom actions/notification settings actions and it is working good now.

The only minor issue I have now is that when I ARM(AWAY) or ARM(STAY) using my phone app (I have the rules setup to lock the Xfinity) the keypad doesn’t turn red like when it is armed from the keypad itself. I’m not sure if that can be fixed or not, if so that would be awesome. Right now we are putting in our code everytime we can to leave the house to disarm as we don’t know the SHM state w/out looking at our phones.

[RBoy (www.rboyapps.com - Making SmartThings Easy!)]

@Jeremiah_Goode

My issue was that I had specific actions defined for locks per user. I was trying to setup the General Settings\Lock/unlock actions and the user\custom actions/notifications settings appear to conflict.

Glad you figured it out. User actions take precedence over general actions when defined.
You can define the direct keypad arming/disarming also in the user specific actions so that some users can arm using the keypad while other can only lock/unlock.

@Jeremiah_Goode

The only minor issue I have now is that when I ARM(AWAY) or ARM(STAY) using my phone app (I have the rules setup to lock the Xfinity) the keypad doesn’t turn red like when it is armed from the keypad itself

This is by design, in this instance the keypad is being used as standalone lock device and not a general security keypad. The purpose of the light is to show the status of the lock device (locked or unlocked). So when you lock it via the keypad it turns red and when unlocked it’s green/white (depending on the keypad model).

[Jeremiah_Goode]

@RBoy

This is by design, in this instance the keypad is being used as standalone lock device and not a general security keypad. The purpose of the light is to show the status of the lock device (locked or unlocked). So when you lock it via the keypad it turns red and when unlocked it’s green/white (depending on the keypad model).

so if you lock the keypad from the keypad it turns red, but if you lock the keypad from the smartthings app it doesn’t, right? what’s the difference? The keypad is locked, knows its locked, but only turns red if you do it from the keypad. So it doesn’t seem to have anything to do w/ your smartapp, has something to do w/ the device itself? Or the device handler?