The openHAB Documentation Has Moved

The documentation has moved to openhab.org/docs and openhab.org/addons.

Please use the link below to be redirected to the new version of this article, and update your bookmarks.

YRD120 Touchscreen deadbolt without key

This describes the Z-Wave device YRD120, manufactured by ASSA ABLOY with the thing type UID of yale_yrd120_00_000.

The device is in the category of Lock, defining Devices whose primary pupose is locking something.

The YRD120 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is unable to participate in the routing of data from other devices.

Overview

Inclusion Information

The lock can be included in a Z-Wave Network from the touchscreen as follows:

  1. Touch the lock screen to activate
  2. Enter the master pin and press #
  3. Press 7, then #
  4. Press 1, then #

The lock will now be in inclusion mode. Alternatively, the lock can be included by pressing and holding the radio button until the unit beeps 2 times. Release the button and the unit will enter inclusion mode.

Exclusion Information

The lock can be excluded from a Z-Wave Network from the touchscreen as follows:

  1. Touch the lock screen to activate
  2. Enter the master pin and press #
  3. Press 7, then #
  4. Press 3, then #

The lock will now be in exclusion mode. Alternatively, the lock can be excluded by pressing and holding the radio button until the unit beeps 5 times. Release the button and the unit will enter exclusion mode.

Channels

The following table summarises the channels available for the YRD120 -:

Channel Channel Id Category Item Type
Door Lock lock_door Door Switch
Alarm alarm_general Door Switch
Alarm Number alarm_number    
Alarm Raw alarm_raw   String
Battery Level battery-level Battery Number

Door Lock

Lock and unlock the door.

The lock_door channel supports the Switch item and is in the Door category.

Alarm

Indicates if an alarm is triggered.

The alarm_general channel supports the Switch item and is in the Door category. This is a read only channel so will only be updated following state changes from the device.

The following state translation is provided for this channel to the Switch item type -:

Value Label
OFF Ok
ON Alarm

Alarm Number

Channel type information on this channel is not found.

Alarm Raw

Provides alarm parameters as json string.

The alarm_raw channel supports the String item. This is a read only channel so will only be updated following state changes from the device.

Battery Level

Represents the battery level as a percentage (0-100%). Bindings for things supporting battery level in a different format (e.g. 4 levels) should convert to a percentage to provide a consistent battery level reading.

The battery-level channel supports the Number item and is in the Battery category.

Device Configuration

The following table provides a summary of the 6 configuration parameters available in the YRD120. Detailed information on each parameter can be found in the sections below.

Param Name Description
1 Audio Volume Sets the volume level of the beeps and voice prompts
2 Auto Re-lock When enabled, the unit will automatically re-lock
3 Re-lock time Time after unlocking that the device will lock
4 Wrong Code Entry Limit The number of invalid tries before the lock shuts down and sends an alarm
7 Shutdown Time Number of times the device is locked out after the invalid retries are exceeded
8 Operating Mode Sets if the unit operates normal, or disables the keypad and Z-Wave lock/unlock
  Lock Timeout Sets the time after which the door will auto lock

Parameter 1: Audio Volume

Sets the volume level of the beeps and voice prompts 1 = Silent

2 = Low

3 = High The following option values may be configured -:

Value Description
1 Silent
2 Low
3 High

The manufacturer defined default value is 3 (High).

This parameter has the configuration ID config_1_1 and is of type INTEGER.

Parameter 2: Auto Re-lock

When enabled, the unit will automatically re-lock 0 = Off

255 = On The following option values may be configured -:

Value Description
0 Off
255 On

The manufacturer defined default value is 0 (Off).

This parameter has the configuration ID config_2_1 and is of type INTEGER.

Parameter 3: Re-lock time

Time after unlocking that the device will lock

Values in the range 5 to 255 may be set.

The manufacturer defined default value is 30.

This parameter has the configuration ID config_3_1 and is of type INTEGER.

Parameter 4: Wrong Code Entry Limit

The number of invalid tries before the lock shuts down and sends an alarm

Values in the range 1 to 7 may be set.

The manufacturer defined default value is 5.

This parameter has the configuration ID config_4_1 and is of type INTEGER.

Parameter 7: Shutdown Time

Number of times the device is locked out after the invalid retries are exceeded

Values in the range 1 to 255 may be set.

The manufacturer defined default value is 30.

This parameter has the configuration ID config_7_1 and is of type INTEGER.

Parameter 8: Operating Mode

Sets if the unit operates normal, or disables the keypad and Z-Wave lock/unlock 0 = Normal

1 = Vacation Mode (User Codes Disabled)

2 = Privacy Mode (User Codes and Z-Wave Disabled) The following option values may be configured -:

Value Description
0 Normal
1 Vacation
2 Privacy

The manufacturer defined default value is 0 (Normal).

This parameter has the configuration ID config_8_1 and is of type INTEGER.

Lock Timeout

Sets the time after which the door will auto lock.

This parameter has the configuration ID doorlock_timeout and is of type INTEGER.

Association Groups

Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic.

The YRD120 supports 1 association group.

Group 1: Alarm Reports

Alarm reports are sent out to all devices in the association group This group supports 5 nodes.

Technical Information

Endpoints

Endpoint 0

Command Class Comment
COMMAND_CLASS_NO_OPERATION_V1  
COMMAND_CLASS_BASIC_V1  
COMMAND_CLASS_DOOR_LOCK_LOGGING_V1  
COMMAND_CLASS_SCHEDULE_ENTRY_LOCK_V1  
COMMAND_CLASS_DOOR_LOCK_V1  
COMMAND_CLASS_USER_CODE_V1  
COMMAND_CLASS_CONFIGURATION_V1  
COMMAND_CLASS_ALARM_V1  
COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1  
COMMAND_CLASS_PROTECTION_V1  
COMMAND_CLASS_BATTERY_V1  
COMMAND_CLASS_VERSION_V1  
COMMAND_CLASS_TIME_V1  
COMMAND_CLASS_TIME_PARAMETERS_V1  
COMMAND_CLASS_SECURITY_V1  

Did you spot an error in the above definition or want to improve the content? You can contribute to the database here.