[DEPRECATED] - Universal ZigBee Lock DTH with Lock Codes

[jhamstead]

** Version 1.6a Released. Added fingerprint for Yale YRD226 and YRD246 locks.

---

---

** If you are using a version prior to 0.7a, after upgrade, you must remove and re-add your lock to SmartThings. For fresh installs and all others, hit force reconfigure in the mobile app once after installation.

---

---

Added Features:
Setting/Deleting/Updating Lock User Codes as well as reporting their use to lock manager SmartApps. Enhanced lock action status: jammed lock, used code information, manual/remote notification.
Yale Locks Only: Volume, AutoLock, Privacy Mode, Wrong Code Entry Limit, Invalid Code Entry Lockout Time, and One Touch Locking are all configurable.

This DTH has fully implemented the following commands:
command "resetTamperAlert"
command "setCode"
command "deleteCode"
command “requestCode”*
command "updateCode"
command “reloadAllCodes”*
command “deleteAllCodes”

Yale Locks Only:
command "enableAutolock"
command "disableAutolock"
command "enableOneTouch"
command "disableOneTouch"
command "enableKeypad"
command "disableKeypad"
command "enablePrivacyButton"
command "disablePrivacyButton"
command "enableInternalLED"
command "disableInternalLED"
command "enableAudio"
command "enableAudioLow"
command "enableAudioHigh"
command “disableAudio”

*Unfortunately due to limitations of the manufacturer’s implementation, I cannot retrieve codes directly from the lock. Any code set outside of SmartThings will report as unknown.

The code can be found here or from my GitHub jhamstead/jhamstead

How to…Add Device Handler:
Navigate to: https://graph.api.smartthings.com/ide/devices or
https://graph-na02-useast1.api.smartthings.com/ide/devices
Click ‘New SmartDevice’ in the upper right.
Click 'From Code’
Paste the code from the link (github) above into the text area:
Click 'Create’
Click 'Save’
Click ‘Publish’ > 'For Me’
Change lock device handler to new code:
Navigate to ‘My Devices’: https://graph.api.smartthings.com/device/list or
https://graph-na02-useast1.api.smartthings.com/device/list
Locate your lock and click on the name in the first column
Click ‘Edit’ on the bottom of the page view
In the ‘Type’ drop-down scroll to the bottom and select 'Universal Enhanced ZigBee Lock’
Click ‘Update’ to save changes

NOTE: Hit force reconfigure in the mobile app once after installation to ensure lock gets the correct configuration.

Enjoy! Let me know of any issues or problems.

[jhamstead]

Several threads exist stating that the use of runIn is flaky. As I see it, this is a necessity for Yale locks due to their nonstandard HA implementation. However kwikset does not have this issue. In my next update I’ll remove the need for runIn if you use a kwikset ZigBee lock.

runIn does not run at specific intervals

I’m writing a code that has to perform 60 actions with a 10 second delay in between so I use the runIn(10, function) to do that. The function schedules a call back to itself using the same runIn(10, function) After about 7 times it stops getting called. However if I use runIn(7, function) it works fine and calls the function in 7 seconds 60 times without an issue. But I need 10 seconds, any one know why in 10 seconds the runIn stop working after a few times but work with 7 seconds? @bflorian , @duncan looping you guys in from a coding/platform perspective.

[joelde (Joel)]

Curious as to the process for adding DTH - as we’ve chatted it’s recommended to delete the device and re add it to force it to use custom DTH right?

but here and on user lock code manager instructions it’s as simple as just editing device and selecting the Device type there. Which I’m guessing should work for most use cases.

[jhamstead]

I pulled this from the lock code manager instructions as they seemed simpler and I would recommend that process once I feel the code is stable. As for alpha versions, I recommend deleting and readding for a cleaner installation, just to eliminate possible holdovers from old code (state variables), though this would require more setup each time.

[joelde (Joel)]

makes sense - good point it is alpha. thanks

[jhamstead]

Joel - This has been updated to a new version. Hopefully this will resolve your issues.

[jhamstead]

New version Alpha 0.3 Please update the code, then delete your lock, then rejoin it. Too many code changes and old state variables.

If possible, please let me know if the auto lock time works for values other than 30 with Kwikset as I only have a Yale lock to test with.

Thanks!

[jhamstead]

New update to Alpha 0.4. This is my last planned alpha version. If anyone has a Kwikset lock who can test the additional features, it would be greatly appreciated.

[jhamstead]

So I’ve been told that Kwikset does not support these additional features (at least they don’t in Z-Wave). I’d prefer if someone can verify this before rolling out an update to disable these features for Kwikset locks.

[jhamstead]

I have another update ready which will disable the additional features that are likely not compatible with Kwikset. This update also streamlines the command and attribute names with @RBoy’s Z-Wave DTH. If I don’t hear if these features work for Kwikset by this weekend, I will assume they don’t work and replace Alpha 0.4 with Beta 0.5.

[jhamstead]

Upgraded to Version 0.5

[jhamstead]

New version 0.5a. I have fixed a bug with user reporting and a critical bug where there was a chance the lock would possibly not report lock/unlock states. Please update as soon as possible.

[enroberts (Neal Roberts)]

Hey there. I’m using your code with a ZigBee Yale lock. It pulls data and controls the lock perfectly. My problem is I can’t find where to enter user codes in the app for this lock. Any guidance would be appreciated! Thanks.

[jhamstead]

Certainly. My code is a device handler for talking directly to ZigBee door locks. It has command methods to add/delete/update user codes but you need a SmartApp to execute those commands.

Two free SmartApps by ethlayer are

[Depricated] Lock Code Manager

There’s a new app! Please go to this thread for the new Lock Manager App, which is in active development. ##Legacy App: This app is no longer being maintained. Support and bug fixes are no longer being provided. Welcome to Lock Manager! Now with custom device type! Use the attached device type zwave-lock.groovy for added functionality. Minimal changes to SmartThings code. More reliable code set/delete. Codes will be reconciled on each poll() event. App will function without custom device type, but not as well. Features: Assign Codes to Multiple Users. Manage Multiple Locks. See what codes are active. See how many times a code is used (reset usage manually) Be notified when a user uses their code. Delete codes after they are used*. Optionally Schedule Users so that they only have ac…

And his new version

[RELEASE] Lock Manager

Lock Manager Incomplete List of features: Manage user codes on locks. Manage Keypads. Review and manage active lock codes. Set lock access based on schedules. Receive notifications when a user used their code. Run Hello Home phrases based on lock/unlock events. Manage Hello Home phrases based on keypad inputs. This app works using 3 child apps and 1 parent app. It is recommended that you install all 4 apps, however if you do not use keypad devices, it is not required to install the keypad child app. Note: If upgrading from any beta version, it is required to uninstall the app completely before installing. The architecture of this app has changed in a way that is incompatible with previous versions. How To Install User guide has old information. There is now only one app to install…

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

@jhamstead assuming you’re also using the DH with the RBoy app

[RELEASE] Lock User Management (LUM)

Lock User Management (LUM) is a reliable Lock Manager for remotely managing users and locks It works with the standard Z-Wave Lock/ZigBee device handler that comes with SmartThings and works with any lock that supports remote codes. It can be used to program user codes, be notified when user codes are used and also take actions when codes are used. For automatically generating user codes for rental properties check out Rental Lock Automater (RLA). [File_015] [File_016] [File_008] [File_009] [File_017] [File_018] [File_019] [File_020] [File_021] [File_022] [File_023] [File_010] [File_011] [File_012] [File_013] [File_014] You can find installation instructions for LUM here Lock Code User Management (LUM) is a very reliable and comprehensive commercial grade Lock and User Code Man…

[suddin (Sal)]

First of all thank you jhamstead, this is good and works for me (i have a Yale zigbee lock). The best thing which i have been able to achieve is customization of user codes remotely. I have some quick questions on the usage so that i can adapt to it better.

When i look at the details of the lock - i see the Lock, UnLock, Battery %, No Alerts, Timed Auto Lock…, One Touch Lock…, Low, Reload, Force Reconfig…

I understand Lock, Unlock, Battery%, but dont understand how to use

1. No Alerts - What does this mean?
2. How do i use Timed Auto Lock ? if i press that once nothing happens, does it take time for that command to execute?
3. One touch Lock ? Same how do i know One touch is enabled or disable ? or does it take time for that command to execute?
4. Volume: Low ??? How do i change the volume ? Does it take time?
5. Force Reconfig? - What does this do ?

Please help me understand on how to use this buttons?

Thanks in advance.

[jhamstead]

Welcome and thanks for installing the DTH. I’ve been trying to expand the testing community for ZigBee locks. First, what version of Yale lock do you have?

Second here are the answers to your questions. Let me know if you need any additional information.

1. No Alerts - What does this mean?

If someone enters too many wrong codes, if the lock jams or if the lock sends any other type of alert, such as faceplate removed (have not tested that), an alert will appear.

2. How do i use Timed Auto Lock ? if i press that once nothing happens, does it take time for that command to execute?

So if you press it, it is supposed to turn on/off auto locking with the time delay being what you configure in the settings. If this is not working it is possible your lock did not configure correctly or it is not supported/working on that particular lock model.

3. One touch Lock ? Same how do i know One touch is enabled or disable ? or does it take time for that command to execute?

Mostly same as above. One touch locking is if the lock is unlocked and you press the keypad, the lock automatically locks. Disabled and you need to enter a code to lock.

4. Volume: Low ??? How do i change the volume ? Does it take time?

The volume should toggle between silent, low and high.

5. Force Reconfig? - What does this do ?

Since none of the settings above seem to be working, I would think about trying force reconfigure. What this does is resend the configure commands to the lock for subscription to certain lock attribute/event changes. If they are not configured, your lock will not report those changes to SmartThings. It is really a debugging tool at the moment and should not exist in the final version.

The standard refresh only requests the current attribute values.

[suddin (Sal)]

Thanks for the detailed response I have a YRD 210 Push Button Deadbolt with a ZigBee ha 2.1 network module. I will try and force reconfigure and then take it from there.

[jhamstead]

According to documentation I see on the YRD 210, all of those features should work. Unfortunately I only have access to a YRD 240 so my testing is limited. Let me know how it goes. As a note, I am working on adding privacy mode as well.

[suddin (Sal)]

i forced reconfigure and am able to get everything to work. One more question, the tile shows the text as incomplete it shows “Timed Auto Lock…” and a X on top, “One Touch Lock…” a house sign with an open lock what do i make out of those icons? and incomplete text ? Can i reduce the font size to see the complete text somehow?