[DEPRECATED] - Universal ZigBee Lock DTH with Lock Codes

yale
zigbeelocks
dth_locks
kwikset

#1

** 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.


Zigbee Lock User Code addition
What's the deal with Z-Wave and locks?
[RELEASE] Universal Enhanced Z-Wave Lock, Schlage, Yale, Kwikset, IDLock, DanaLock, August Pro, Samsung, Locstar, KeyWe Locks and Popp Z-Wave Keypad Device Handler with Alarm Control, Notification, RFID, Door Sensor and advanced features
[RELEASE] Lock User Management: Door lock code manager (create, delete and schedule codes) with automatic lock/unlock, custom user actions and SHM/ADT integration
Yale Zigbee keyless deadbolt $85 amazon Prime after coupon "LOCKS485"
[RELEASE] Lock Manager
[RELEASE] User Unlock/Lock Door Notifications and Actions
Yale ZigBee Lever Locks - Amazon Warehouse - Used: Very Good - $75
[RELEASE] Lock Manager
Easy Access EasyCode Door Lock- ZigBee Module Compatible with SmartThings HUB
[RELEASE] User Unlock/Lock Door Notifications and Actions
Yale ZigBee Push Button Electronic deadbolt going to work with UK smart things hub?
[RELEASE] Lock Manager
[RELEASE] Rental Lock Automater - Automate user codes with AirBnB, HomeAway, VRBO and Booking.com for multiple properties
[RELEASE] Lock User Management: Door lock code manager (create, delete and schedule codes) with automatic lock/unlock, custom user actions and SHM/ADT integration
CentraLite Plug-In Dimmer and Appliance Modules 2/$40 1/$24.90 Free Shipping
[RELEASE] Lock User Management: Door lock code manager (create, delete and schedule codes) with automatic lock/unlock, custom user actions and SHM/ADT integration
[Depricated] Lock Code Manager
[RELEASE] Lock User Management: Door lock code manager (create, delete and schedule codes) with automatic lock/unlock, custom user actions and SHM/ADT integration
[RELEASE] Lock Manager
[Depricated] Lock Code Manager
[RELEASE] Lock Manager
[RELEASE] Lock Manager
[RELEASE] Lock User Management: Door lock code manager (create, delete and schedule codes) with automatic lock/unlock, custom user actions and SHM/ADT integration
[Depricated] Lock Code Manager
[Depricated] Lock Code Manager
[RELEASE] Lock User Management: Door lock code manager (create, delete and schedule codes) with automatic lock/unlock, custom user actions and SHM/ADT integration
[RELEASE] Lock User Management: Door lock code manager (create, delete and schedule codes) with automatic lock/unlock, custom user actions and SHM/ADT integration
[RELEASE] Lock Manager API - Control your locks and manage users remotely
[RELEASE] Lock User Management: Door lock code manager (create, delete and schedule codes) with automatic lock/unlock, custom user actions and SHM/ADT integration
[RELEASE] Lock User Management: Door lock code manager (create, delete and schedule codes) with automatic lock/unlock, custom user actions and SHM/ADT integration
New devices certified from Leviton and Kwikset! ZigBee lock support! Oct 19, 2015
[RELEASE] Lock User Management: Door lock code manager (create, delete and schedule codes) with automatic lock/unlock, custom user actions and SHM/ADT integration
[RELEASE] Lock Manager
Best Lock to Use with ST?
Kwikset Zigbee Locks
[RELEASE] Lock Manager
Yale YRD220 Zigbee Touchscreen Lock Status not Updating
Kwikset Zigbee Lock turn off alarm
[RELEASE] Lock Manager
Yale Touchscreen Deadbolt with ZigBee
#2

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.


(Joel) #3

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.


#4

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.


(Joel) #5

makes sense - good point it is alpha. thanks


#6

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


#7

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!


#8

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.


#9

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.


#10

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.


#11

Upgraded to Version 0.5


#12

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.


(Neal Roberts) #13

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.


#14

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

And his new version


Activate a routine but if a window sensor is on then don’t turn on?
(www.rboyapps.com - Make your home your butler!) #15

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


(Sal) #16

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.


#17

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.

  1. 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.

  1. 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.

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

The volume should toggle between silent, low and high.

  1. 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.


(Sal) #18

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.


#19

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.


(Sal) #20

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?