A “future proof” Universal Enhanced Z-Wave Lock driver
This driver is enhanced to fix bugs in the stock ST ZWave Lock driver, include patches for bugs in lock firmwares and bring out additional features for Schalge, Yale, Kwikset, IDLock, Popp, Samsung, Delaney, August Pro, Danalock, KeyWe, Philia, Vivint, Locstar etc zwave locks (see below for a full list of models and features). This works with all ZWave locks and newer ZWave Plus locks (see below for a list of locks tested).
It discovers/learns the lock features and automatically configures them. If a feature is not supported by the lock it will not show up or say Unsupported.
You need SmartThings Smart Lock Guest Access (SLGA), Advanced Web UI or a SmartApp like Lock User Management (LUM), Rental Lock Automater (RLA) to program user codes, create actions for locking/unlocking/user codes and notify you.
You can also use Routines and Scenes to create rules and access advanced features like the built in Alarms, One touch lock, Auto lock, Audio, Code entry, Action types, User names, User slot id’s, User pin codes and other lock features. These rules will run locally on the hub.
Automation Examples
Classic App
Comparison of lock model features
Cheapest and Best Z-Wave Smart Locks
Recommend reading these posts about limitations of specific lock models
Tested and verified and optimized on the following lock models:
- Yale Z-Wave/Plus locks (zw, zw2, zw3 modules) (YRD 652/642/622/612/450/446/440/430/420/410/256/240/226/216/210/110, YRL 256/226/216, YRC 652/642/622/612/157/137, B1L, T1L, YRDxxx, YRLxxx, YRCxxx, Assa Abloy, Keyfree, Assure, Conexis, Touchscreen, Deadbolt, RealLiving, nexTouch, YDM7116) (DPS sensor)
- Schlage Z-Wave/Plus locks (FE469, BE469, BE468, FE599, JEF109, BE369, Mortise S-6500F)
- Kwikset Z-Wave/Plus locks (954/Obsidian, 916, 914, 912, 910, 888, 620, 6xx, 8xx, 9xx)
- Vivint Z-Wave locks
- DanaLock Z-Wave/Plus locks (V2/V3)
- August Pro Z-Wave/Plus locks (door sensor)
- IDLock Z-Wave/Plus locks (101/150) (door sensor)
- Samsung Z-Wave/Plus locks (SHP-xxx, SHS-xxx)
- Ultraloq (U-Bolt, U-Bolt Pro)
- Alfred locks
- Delaney Z-Wave/Plus locks (ZWxxx)
- Locstar Z-Wave/Plus locks
- Monoprice Z-Wave locks
- KeyWe Z-Wave/Plus locks (door sensor)
- Philia Z-Wave/Plus locks (door sensor)
- Popp Z-Wave/Plus strike lock (POPE 012501) / keypad
- TLJ Z-Wave Plus access control (deadbolt, lever, keypad)
Key features supported by driver (depending on lock model)
- Automatic discovery of lock features
- Program user and master codes
- Scan for existing user codes / RFID tags
- Display programmed user codes and RFID tags
- Lock/Unlock
- Privacy/Vacation/keypad control
- Autolock
- Audio/volume control
- One touch/Lock n leave
- Alarm mode
- Alarm sensitivity
- DPS/Door sense
- Passage mode (semi-permanent unlock)
- Manual/Keypad/Autolock/RFID/Bluetooth reporting
- Temperature alarm
- Tamper alerts
- Emergency alerts (police/fire)
- Battery life optimization
- Configure lock settings (device settings page)
- Enhanced programming communication for a weak mesh
- Handling of missing information while pairing locks
- Patch for firmware defects lock firmware which causes a loss of user details in lock/unlock notifications
- Fix for pairing of some lock models causing loss of notifications
Most features can be accessed by the SmartThings mobile app Scenes and Routines to create custom rules and automations.
Pull down on the device page from the SmartThings mobile app to trigger a refresh and discover the locks capabilities and the supported tiles will be enabled.
NOTE: Only features for supported/discovered features will be enabled (if it’s greyed out or says Unsupported, it means the lock doesn’t support the feature/isn’t responding to the discovery request). It helps to add a buffering device/repeater within 20ft of your lock for best performance
You can find the installation/update instructions here.
List of available custom commands to use via SmartThings CLI/API:
disableAutolockenableAutolockenableKeypaddisableKeypadenableAudiodisableAudiodisableOneTouchLockenableOneTouchLocksetAlarm(“off”, “alert”, “tamper”, “forced”)setSensitivity(“lowest”, “low”, “medium”, “high”, “highest”)
If you’re looking to capture specific events (e.g. invalid codes) and create custom actions/rules in CoRE/WebCoRE refer to this post.
You can use triggers to create custom automations to adjust the mode/sensitivity of the built in Schlage siren/alarm using the SmartThings mobile app scenes and routines with this driver.
There is also a legacy app.
Additional Z-Wave/Plus Lock Features (varies by model)
Schlage Locks
- Configure the Local Alarm Mode on the lock (Off/Alert/Tamper/Forced Entry) (FE469/BE469/BE469ZP)
- Configure the sensitivity of the Alarm for each mode (from Highest to Lowest in 5 steps) (FE469/BE469/BE469ZP)
- Change user pin code length for Schlage Connect (468/469/109 series)
- Enable/disable interior alarm buttom on lock (FE469/BE469/BE469ZP/469)
- Enable/disable AutoLock (JFE109/FE469/BE469/BE468/BE468ZP/BE469ZP/S-6500F)
- Enable/disable Keypad (Vacation Mode)
- Enable/disable Lock n Leave (one touch locking)
- Enable/disable the keypad Beeper
- Report if the user entered invalid codes through the ‘invalidCode’ attribute (fixed by lock at one report for every 4 attempts)
- Door position sensor (S-6500F)
- Workaround for lock firmware bug in the FE599 and BE369 where it does not report the relock event after a user unlocks using a code
- Patch for firmware defect in Schlage Connect, JFE109/BE469/BE468/BE468ZP/BE469ZP/FE469ZP which causes a loss of user details in lock/unlock notifications
Yale Locks
- Enable/disable AutoLock
- Enable/disable Keypad (Vacation/Privacy Mode)
- Enable/disable the Audio/Speech and adjust volume
- Enable/disable One Touch Locking (Lock n Leave)
- Report if the user entered too many invalid codes through the ‘invalidCode’ attribute for SmartApps to use (configurable via device settings in Classic app)
- Report bluetooth/RFID cards usage (if reported)
- Configuration options (device settings page)
- Auto relock timeout
- Wrong code reporting threshold
- Select volume level
- Set vacation/privacy/passage mode
- Eco mode
- Activating/Reporting Yale Door Position Sensor (DPS) (if installed/reported)
- Patch for firmware defect in Yale keyless which causes a loss of user details in lock/unlock notifications
Kwikset Locks
- 6xx Series Locks
- Enable/disable audio
- Configuration options (device settings page)
- Enable/Disable Program button
- 8xx Series Locks
- Enable/disable auto lock
- Configure auto lock timeout
- Enable/disable audio
- Configuration options (device settings page)
- Auto relock timeout
- 9xx Series Locks (DIP Switch)
- Report auto lock state (programmed via the dip switch on the lock)
- Report auto buzzer (audio) state (programmed via the dip switch on the lock)
IDLock Locks
- Enable/disable away mode
- Enable/disable auto lock
- Enable/disable audio/beeping
- Report door open/close state
- Report RFID card usage
- Program users and master codes
- Configuration options (device settings page)
- Volume level
- Unopened relock
- Patch for firmware defect in IDLock 150 which causes a loss of user details in lock/unlock notifications
Danalock Locks
- Enable/disable audio/beeping (v2)
- Enable/disable auto lock (v2/v3)
- Configuration options (device settings page)
- Turn speed (v2)
- Brake n go (v2)
- Turn n go (v2)
- Auto relock timeout (v2/v3)
- Bluetooth always allowed (v2/v3)
Samsung Locks
- Enable/disable privacy mode (keypad lockout)
August Pro Locks
- Report door open/close state
Keywe Locks
- Report door open/close state
Philia Locks
- Report door open/close state
Popp Keypad
- Enable/disable audio/beeping
Popp Strike Lock (POPE021501)
- Enable automatic relock after unlocking
- Adjust relock timeout
- Report door open/close state (DPS)
TLJ Locks
- Report door position sensor (DPS)
- Report RFID usage
NOTES
- August Pro locks with the Door Position Sensor (DPS) and Yale locks which support the optional DPS sensor/module report door status over Z-Wave, Yale-August locks firmware don’t report DPS over Z-Wave
- Some Yale L1 locks reports RFID usage over Z-Wave, RFID locks cannot be programmed over Z-Wave with this Driver
- August Pro locks do not allow remote programming over Z-Wave (only reporting usage)
- Monoprice locks do not report usage over Z-Wave (only programming)
- Schlage BE369 report user code locked events as unlocked due to a lock firmware bug
- Kwikset/Vivint locks should have anti theft disabled or should be excluded from the old controller otherwise they won’t pair with the SmartThings hub
- Schlage locks with built in siren/alarm cannot be triggered externally, they only report when the siren/alarm is activated over Z-Wave. The mode and sensitivity can be configured over Z-Wave using this app
- Some locks with limited button keypads have restrictions on user codes, see this post for more details
- Locks report and behave differently to battery levels. Deadbolt locks have a higher battery drain, Schlage deadbolt locks tend to have communication issues when the battery level falls below 50% and can even die prematurely due to voltage drop issues. See this post of more details.
If you have any suggestions or requests please feel free to let us know
Check out these other SmartApps
[RELEASE] Door Chimes and Notifications for Doorbells and Sensors
[RELEASE] Security System: Intruder Alert with Actions
This driver is available on the RBOY APPS Server
Refer to our facebook page RBOY APPS SmartThings - Make your Home your Butler to get the latest news and updates.
The latest version is available on the RBOY APPS server
