openhab-docs/_addons_bindings/zwave/doc/yale/yrd240_0_0.md

11 KiB

layout title
documentation YRD240-ZW2 - ZWave

{% include base.html %}

YRD240-ZW2 Yale Assure Lock 2

This describes the Z-Wave device YRD240-ZW2, manufactured by ASSA ABLOY with the thing type UID of yale_yrd240_00_000.

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

YRD240-ZW2 product image

The YRD240-ZW2 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

Never worry about carrying around or losing your keys again. The Assure Lock 2 features Z-Wave and seamlessly integrates into 50+ home automation and security systems including SmartThings, Alarm.com, Honeywell, ADT, Wink and more! When added to most Z-Wave™ automation systems, lock and unlock your door, create pin codes, view access history and receive notifications from anywhere.

Inclusion Information

To include the lock in a Z-Wave Network (taken from the installation manual):

  • On your lock keypad, enter your programming code, followed by the gear icon
  • Press the 7 key, followed by the gear icon
  • Press the 1 key, followed by the gear icon

Exclusion Information

To exclude the lock from a Z-Wave Network (taken from the installation manual):

  • On your lock keypad, enter your programming code, followed by the gear icon
  • Press the 7 key, followed by the gear icon
  • Press the 3 key, followed by the gear icon

General Usage Information

Please note that for my lock, YMMV, it is not possible to set the re-lock configurations, these must be set via the Yale app or some other means. The re-lock timing cannot be changed at all, and the re-lock can be changed to off, but not to on.

Channels

The following table summarises the channels available for the YRD240-ZW2 -:

Channel Name Channel ID Channel Type Category Item Type
Door Lock lock_door lock_door Door Switch
Alarm (entry) alarm_entry alarm_entry Door Switch
Alarm (battery) alarm_battery alarm_battery LowBattery Switch
Alarm (raw) alarm_raw alarm_raw String
Battery Level battery-level system.battery_level Battery Number
Clock Time Offset time_offset time_offset Time Number

Door Lock

Lock and unlock the door.

The lock_door channel is of type lock_door and supports the Switch item and is in the Door category. The following state translation is provided for this channel to the Switch item type -:

Value Label
ON Locked
OFF Unlocked

Alarm (entry)

Indicates if the entry alarm is triggered.

The alarm_entry channel is of type alarm_entry and 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
ON Open
OFF Closed

Alarm (battery)

Indicates if the low battery alarm is triggered.

The alarm_battery channel is of type alarm_battery and supports the Switch item and is in the LowBattery 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 (raw)

Provides alarm parameters as json string.

The alarm_raw channel is of type alarm_raw and supports the String item. This is a read only channel so will only be updated following state changes from the device. This channel sets, and provides the alarm state as a JSON string. It is designed for use in rules.

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 system.battery-level channel is of type system.battery-level and supports the Number item and is in the Battery category. This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%.

Clock Time Offset

Provides the current time difference for the devices time.

The time_offset channel is of type time_offset and supports the Number item and is in the Time category.

Device Configuration

The following table provides a summary of the 11 configuration parameters available in the YRD240-ZW2. Detailed information on each parameter can be found in the sections below.

Param Name Description
1 Volume Level
2 Auto Relock
3 Auto Relock Time Auto Relock after 10 to 180 seconds
4 Wrong Code Entry Limit 3 to 10 attempts allowed
5 Language
7 Shut Down Time (after wrong code entries) 10 to 180 seconds before more attempts
8 Operating Mode
11 One Touch Locking
12 Privacy Mode Disables using a passcode to unlock
13 Lock Status LED
15 Reset to Factory Defaults Lock will execute Reset To Factory!
Lock Timeout Sets the time after which the door will auto lock

Parameter 1: Volume Level

The following option values may be configured, in addition to values in the range 1 to 3 -:

Value Description
1 High
2 Low
3 Silent

The manufacturer defined default value is 2 (Low).

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

Parameter 2: Auto Relock

The following option values may be configured, in addition to values in the range 0 to 0 -:

Value Description
-1 Off
0 On

The manufacturer defined default value is -1 (Off).

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

Parameter 3: Auto Relock Time

Auto Relock after 10 to 180 seconds

Values in the range 10 to 180 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

3 to 10 attempts allowed

Values in the range 3 to 10 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 5: Language

The following option values may be configured, in addition to values in the range 1 to 3 -:

Value Description
1 English
2 Spanish
3 French

The manufacturer defined default value is 1 (English).

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

Parameter 7: Shut Down Time (after wrong code entries)

10 to 180 seconds before more attempts

Values in the range 10 to 180 may be set.

The manufacturer defined default value is 60.

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

Parameter 8: Operating Mode

The following option values may be configured, in addition to values in the range 0 to 3 -:

Value Description
0 Normal Mode
1 Vacation Mode, key only
2 Privacy Mode, no keypad
3 Passage Mode, no auto lock

The manufacturer defined default value is 0 (Normal Mode).

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

Parameter 11: One Touch Locking

The following option values may be configured, in addition to values in the range 0 to 0 -:

Value Description
-1 On
0 Off

The manufacturer defined default value is -1 (On).

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

Parameter 12: Privacy Mode

Disables using a passcode to unlock

The following option values may be configured, in addition to values in the range 0 to 0 -:

Value Description
-1 On
0 Off

The manufacturer defined default value is 0 (Off).

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

Parameter 13: Lock Status LED

The following option values may be configured, in addition to values in the range 0 to 0 -:

Value Description
-1 On
0 Off

The manufacturer defined default value is 0 (Off).

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

Parameter 15: Reset to Factory Defaults

Lock will execute Reset To Factory! This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. The following option values may be configured, in addition to values in the range 0 to 0 -:

Value Description
-1 Reset to Factory On
0 Reset to Factory Off

The manufacturer defined default value is 0 (Reset to Factory Off).

This parameter has the configuration ID config_15_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 YRD240-ZW2 supports 1 association group.

Group 1: Lifeline

The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. Z-Wave Plus Lifeline Lifeline / Alarm / Battery

Association group 1 supports 1 node.

Technical Information

Endpoints

Endpoint 0

Command Class Comment
COMMAND_CLASS_NO_OPERATION_V1
COMMAND_CLASS_DOOR_LOCK_LOGGING_V1
COMMAND_CLASS_SCHEDULE_ENTRY_LOCK_V1
COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1
COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1
COMMAND_CLASS_ZWAVEPLUS_INFO_V1
COMMAND_CLASS_DOOR_LOCK_V1
COMMAND_CLASS_USER_CODE_V1
COMMAND_CLASS_CONFIGURATION_V1
COMMAND_CLASS_ALARM_V4
COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1
COMMAND_CLASS_POWERLEVEL_V1
COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1
COMMAND_CLASS_BATTERY_V1
COMMAND_CLASS_ASSOCIATION_V2
COMMAND_CLASS_VERSION_V2
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.