Skip to content

Latest commit

 

History

History
executable file
·
327 lines (200 loc) · 10.7 KB

yrl256_1_78.md

File metadata and controls

executable file
·
327 lines (200 loc) · 10.7 KB
layout title
documentation
US2.0 CP2-5-3 - ZWave

{% include base.html %}

US2.0 CP2-5-3 Yale Real Living™ Z-Wave Module

This describes the Z-Wave device US2.0 CP2-5-3, manufactured by ASSA ABLOY with the thing type UID of yale_yrl256_01_078. This version of the device is limited to firmware versions above 1.78

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

US2.0 CP2-5-3 product image

The US2.0 CP2-5-3 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

  • Adds Z-wave connectivity to compatible Yale Real Living locks. Must be paired with a Z-wave controller (sold separately) in order to add remote control and access functionality to your Yale lock.
  • Compatible with these deadbolt and lever locks: YRD210, YRD220, YRD240, YRL210, YRL220
  • Not compatible with Yale Assure Locks or NexTouch Locks. Also not compatible with Apple Home Kit

Inclusion Information

To include the lock in a Z-Wave Network:

  1. Touch the Yale Icon on the touchscreen 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.

Exclusion Information

To exclude the lock in a Z-Wave Network:

  1. Touch the Yale Icon on the touchscreen 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.

Channels

The following table summarises the channels available for the US2.0 CP2-5-3 -:

Channel Name Channel ID Channel Type Category Item Type
Door Lock [Deprecated] lock_door lock_door Door Switch
Alarm (access) alarm_access alarm_access Door Switch
Alarm (power) [Deprecated] alarm_power alarm_power Energy Switch
Alarm (raw) [Deprecated] alarm_raw alarm_raw String
Battery Level battery-level system.battery_level Battery Number
Clock Time Offset [Deprecated] time_offset time_offset Time Number

Door Lock [Deprecated]

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

Note: This channel is marked as deprecated so should not be used.

Alarm (access)

Indicates if the access control alarm is triggered.

The alarm_access channel is of type alarm_access 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
OFF OK
ON Alarm

Alarm (power) [Deprecated]

Indicates if a power alarm is triggered.

The alarm_power channel is of type alarm_power and supports the Switch item and is in the Energy 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

Note: This channel is marked as deprecated so should not be used.

Alarm (raw) [Deprecated]

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. Note: This channel is marked as deprecated so should not be used.

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 [Deprecated]

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.

Note: This channel is marked as deprecated so should not be used.

Device Configuration

The following table provides a summary of the 9 configuration parameters available in the US2.0 CP2-5-3. Detailed information on each parameter can be found in the sections below.

Param Name Description
1 Silent Mode on/off Changes speaker settigs
2 Auto Relock On/Off
3 Auto Relock Time
4 Wrong Code Entry Limit
7 Shut Down Time (after wrong code entries)
8 Operating Mode
11 One Touch Locking
13 Lock Status LED
15 Reset to Factory Defaults
Lock Timeout Sets the time after which the door will auto lock

Parameter 1: Silent Mode on/off

Changes speaker settigs

  1. High Volume
  2. Low Volume
  3. Silent The following option values may be configured -:
Value Description
1 High
2 Low
3 Silent

The manufacturer defined default value is 1 (High).

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

Parameter 2: Auto Relock On/Off

The following option values may be configured -:

Value Description
-128 Auto Relock On
0 Auto Relock Off

The manufacturer defined default value is 0 (Auto Relock Off).

This parameter has the configuration ID config_2_1_wo and is of type INTEGER. This is a write only parameter.

Parameter 3: Auto Relock Time

Values in the range 10 to 127 may be set.

The manufacturer defined default value is 127.

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

Parameter 4: Wrong Code Entry Limit

Values in the range 3 to 10 may be set.

The manufacturer defined default value is 3.

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

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

Values in the range 10 to 127 may be set.

The manufacturer defined default value is 10.

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 -:

Value Description
0 Normal Mode (Default)
1 Vacation Mode (Keypad Locked Out)
2 Privacy Mode (Keypad Locked, RF Unlock Functional)

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

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 -:

Value Description
-128 One Touch Locking On
0 One Touch Locking Off

The manufacturer defined default value is 0 (One Touch Locking Off).

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

Parameter 13: Lock Status LED

The following option values may be configured -:

Value Description
-128 LED On
0 LED Off

The manufacturer defined default value is 0 (LED Off).

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

Parameter 15: Reset to Factory Defaults

The following option values may be configured -:

Value Description
-128 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 US2.0 CP2-5-3 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.

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

Documentation Links


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