Yale FBB628N-ZW3 Cylindrical Commercial Grade Lever Locks Installation Guide

Yale FBB628N-ZW3 Cylindrical Commercial Grade Lever Locks

Product Information

Specifications

• Manufacturer: Yale Locks
• Supported Command Classes: Manufacturer Specific, Security, Device Reset Locally, Power Level, Version, Battery, Door Lock, Door Lock Logging, Schedule Entry Lock, User Code

FAQ

Frequently Asked Questions

• Q: How do I reset the Yale lock to factory default settings?
  • A: You can reset the Yale lock to factory default settings either by manually resetting the lock or using BLE commands via the app for BLE locks. Refer to the specific lock’s manual for detailed reset instructions.

Revision History

Yale Z-Wave Plus® Product Info

• Manufacturer ID: ASSA ABLOY (0x0129)
• Z-Wave® Device Type: Door Lock Keypad
• Z-Wave® Role Type: Listening Sleeping Slave (LSS)

Network Operations

Enroll/Add device to network (SmartStart)

SmartStart enabled products can be added into a Z-Wave® network by scanning the Z-Wave® QR Code present on the product with a controller providing SmartStart inclusion. No further action is required and the SmartStart product will be added automatically within 10 minutes of being switched on in the network vicinity.

• Open the Z-Wave® system’s smart home app via smartphone or tablet and follow the in-app prompts to add a new device.
• SmartStart works when the Z-Wave® system has the DSK saved and one of the following are true:
  • The lock has the minimum Radio Module firmware version AND is in a factory-reset state:
  • AYR-MOD-ZW3-USA: v2.35
  • The lock has the minimum Lock firmware version AND is in a factory-reset state:
  • NTB612/622/632/642: v3.2.58
  • NTB612/622/632/642-NN: v4.0.01
  • FBB618N/628N/638N/648N: v4.0.01
• An internal key has already been established.

Enroll/Add device to network (Classic Inclusion Mode) for Assure Lock

• Enter the 4–8-digit Master PIN code followed by the key.
• Press the 7 key followed by the key.
• Press the 1 key followed by the key.
• Scan the QR code, if prompted, or…
• Enter the first five (5) digits of the DSK if prompted.

Un-enroll/Remove device from network (Exclusion Mode)

• Enter the 4–8-digit Master PIN code followed by the key.
• Press the 7 key followed by the key.
• Press the 3 key followed by the key.

When the Yale lock is unenrolled/excluded from the network through the device menu mode, any changes previously made to the user code database and configuration settings will be retained, as opposed to set back to defaults.

Factory Reset

• Factory resetting the lock with the Z-Wave® module installed will clear the Z-Wave® network settings, causing the device to be removed from the network.
• The following is the method of performing a factory reset:
  1. Manual factory reset, via power cycle while holding button on inside lock escutcheon.
  • See the Lock Installation Manual for details.
  • Please use the manual factory reset procedure only when the network primary controller is missing or otherwise inoperable.

Supported Command Classes

The Yale Assure Z-Wave Plus® deadbolts follow the Z-Wave® Command Class Specifications for all command classes that are implemented. Please refer to these specifications for specifics on how each command class works. The supported command classes are listed below, and certain sections contain details about operations that may be specific to the Yale lock. If a section is blank, then please refer to the Z-Wave® specifications.

As a secure device, most of the command classes supported by the lock are required to be sent securely with Z-Wave® security. During enrollment, the controller can use the Security Command Class to get this list directly from the lock. If a command class requires security, it is also indicated as such below.

Specification used: Z-Wave® Specifications Release Dec 2021 BCD

Command Class Z-Wave Plus® Info, Version 2

The Z-Wave Plus® Info command class reports the following information:

• Role Type: Slave Sleeping Listening (0x07)
• Node Type: Z-Wave Plus® Node (0x00)
• Installer Icon Type: 0x0300
• User Icon Type: 0x0300

**Command Class Manufacturer Specific, Version 2***

• This command class requires security.

The Manufacturer Specific command class reports the following information:

• Manufacturer ID: 0x0129
  • This is the manufacturer ID assigned to ASSA ABLOY.
• Product ID:
  • The Product ID can be used to differentiate between hardware platforms, as well as between ZW2 and ZW3. See Table 1 – First 2 Digits of Product ID, below, for details.
  • Product IDs for the locks covered in this document are as follows:
  • 0x4B0C for NTB612-ZW3 or Default ID for NTB Push button Lock (2nd Generation Keyed Push Button interface)
  • 0x4B16 for NTB622-ZW3 or Default ID for NTB Touch Screen Lock (2nd Generation Keyed Touch Screen interface)
  • 0x4B20 for NTB632-ZW3 (2nd Generation Keyless Push Button interface)
  • 0x4B2A for NTB642-ZW3 (2nd Generation Keyless Touch Screen interface)
  • 0x4B1C for NTB612-NN-ZW3 or Default ID for NTB Push button Lock (2nd Generation Keyed Push Button interface with No NFC)
  • 0x4B26 for NTB622-NN -ZW3 or Default ID for NTB Touch Screen Lock (2nd Generation Keyed Touch Screen interface with No NFC)
  • 0x4B30 for NTB632-NN -ZW3 (2nd Generation Keyless Push Button interface with No NFC)
  • 0x4B3A for NTB642-NN -ZW3 (2nd Generation Keyless Touch Screen interface with No NFC)
  • 0x4B1C for FBB618N-ZW3 or Default ID for FBB Push button Lock (2nd Generation Keyed Push Button interface with No NFC)
  • 0x4B26 for FBB628N -ZW3 or Default ID for FBB Touch Screen Lock (2nd Generation Keyed Touch Screen interface with No NFC)
  • 0x4B30 for FBB638N -ZW3 (2nd Generation Keyless Push Button interface with No NFC)
  • 0x4B3A for FBB648N -ZW3 (2nd Generation Keyless Touch Screen interface with No NFC)
• Product Type ID:
  • 0x8101 for NTB612/622/632/642-ZW3 (2nd Generation Cylindrical lock)
  • 0x8112 for NTB612/622/632/642-NN-ZW3 (2nd Generation Cylindrical lock with No NFC)
  • 0x8112 for FBB618N/628N/638N/648N-ZW3 (2nd Generation Cylindrical lock with No NFC)

Table 1 – First 2 Digits of Product ID

Command Class Security, Version 1

• This command class has been implemented per the Z-Wave® Specification.

Command Class Security 2, Version 1

• This command class has been implemented per the Z-Wave® Specification.

**Command Class Device Reset Locally, Version 1***

• This command class requires security.

The Yale door locks covered in this guide can be reset to their factory default settings by manually resetting the lock or by BLE command via app for BLE locks (by following the procedure outlined in the specific lock’s manual).

Upon factory reset, all Z-Wave® network settings are cleared, all the user codes are erased from the lock (including the master code), and all configurable settings are reset to default values, except for the language setting. A factory reset leaves the lock in a completely unsecure state (waiting for master code to be set), so care should be taken if using the configuration parameter to perform a remote reset. However, if the DUT is unenrolled/excluded from the network through the device menu mode, then the user code database and configuration settings will not be reset to the defaults.

**Command Class Power Level, Version 1***

• This command class requires security.

  • This command class has been implemented per the Z-Wave® Specification.

The Power Level command class was implemented to allow controllers to set the transmit power for the door lock. This could be useful in large networks with many nodes, so that the lock can find working routes back to the controller while transmitting at a lower power. This ensures robust routes when the normal transmit power level is restored.
Currently there is no way to initiate a low power enrollment; this command class can only be used once the lock is enrolled successfully.

**Command Class Version, Version 3***

• This command class requires security.

The Yale Real Living locks are a multi-processor system with 1 additional firmware target. All processors can be updated through the Firmware Update Meta Data command class. The firmware targets are numbered as follows:

• Firmware Target 0 = Z-Wave® Chip
• Firmware Target 1 = Lock Processor

To identify the firmware version for each target, the hex data in the firmware version report must be converted to decimal prior to combining major and minor version into the full version.
After a controller sends a Version Get command the log will display the Version Report like the below:

The above Version Report will be defined as this in the Z-Wave® sniffer tool, Zniffer:

• For Firmware Target 0, the Firmware 0 Version (0x02) and Sub version (0x22) translate to module firmware decimal value of “2.34”.
• For Firmware Target 1 (the data under vg1), Firmware Version (0x2C) and Sub version (0x00) translate to lock firmware decimal value of “4.3.00”.

**Command Class Battery, Version 1***

• This command class requires security.

Per the Z-Wave Plus® Specification, the lock will send a Battery Report with a value of 0xFF to the Lifeline node when a critical battery level is reached (at about 4.2V). In addition, the Yale Locks provide 2 earlier low battery alarms through the notification command class (see Table 7 – Notification Table).

Low battery alarms will be generated if the lock is in a low battery state during one of the following events: any motor activation (keypad lock/unlock, RF lock/unlock, etc.), controller sends Get Battery command, or the unsolicited battery report was triggered. Yale locks will generate an unsolicited Battery Report at lock boot-up and every 8 hours if a node is listed in the Lifeline Group.

**Command Class Door Lock, Version 4***

• This command class requires security.

Yale Z-Wave Plus® locks support three door lock modes: Door Secured (0xFF), Door Unsecured (0x00), and Door Unsecured with timeout (0x01). When Auto Relock is enabled, the lock will automatically relock after all unlock events. Yale Z-Wave Plus® locks do not support any of the “Door Unsecured for outside Door Handles” (0x20, 0x21) or “Door Unsecured for inside Door Handles” (0x10, 0x11) modes.

**Command Class Door Lock Logging, Version 1***

• This command class requires security.

  • This command class has been implemented per the Z-Wave® Specification.

**Command Class Schedule Entry Lock, Version 3***

• This command class requires security.

Yale locks support Year Day Schedule types and Daily Repeating Schedule types. Yale locks allow the controller to apply multiple schedules to a single user. Each user has 1 Year Day Schedule slot (Slot ID 1) and 7 Daily Repeating slots (Slot IDs 1 – 7). If user scheduling is used in the lock, then the controller MUST set the lock’s time using the Time Parameters command class.

**Command Class User Code, Version 2***

• This command class requires security.

Versions 1 and 2 of this command class can address user code slots 1 through 250 via the User Code Set/Get/Report commands. Version 2 of this command class also includes extended versions of each of these commands, used to address the extended range of users.

Table 2 – Expected Reports for Set/Get Commands

Command| Slots 1-250| Slot 251| Slots 252-254| Slot 255| Slots 256- 500
---|---|---|---|---|---
User Code CC v1/v2: User Code Get| User Code Report| User Code Report| __

User Code Report

| User Code Report| __

N/A

User Code CC v1/v2: User Code Set| User Code Report| Master Code Report| __

User Code Report

| User Code Report| __

N/A

User Code CC v2: Extended User Code Get| __

Extended User Code Report

| Extended User Code Report| __

Extended User Code Report

| Extended User Code Report| Extended User Code Report
User Code CC v2: Extended User Code Set| Extended User Code Report| Extended User Code Report| Extended User Code Report| Extended User Code Report| Extended User Code Report

The master code can be accessed (read/write) using slot 251 (0xFB), if using version 1 of this command class. For version 2, the Master Code Set/Get/Report commands must be used.
Yale locks do not support bulk commands (setting or getting multiple user codes at once) or CRC functionality for this command class.

It should be noted that the lock’s operation mode (called “User Code Keypad Mode” in this command class) can be modified through Version 2 of this command class, or through parameter 8 of the Configuration command class. This is the only parameter that can be modified through more than one command class.

The following implementation notes apply specifically to non-access user codes:

• The usage of non-access users has changed slightly with ZW3, compared to ZW2, but is still backwards compatible. If a User Code Set is transmitted using version 1 of the command class, then the lock will accept a value of 0x04 as the status for the non-access user.
• Previously, a value of 0x04 was reserved for setting non-Access users, as stated above. When using version 2 of this command class, a non-Access (now called “Messaging”) user ID status is assigned a value of 0x03. This value of 0x03 should be used with the Extended User Code Set command.
• A non-access user can be identical to a “normal” PIN code, aside from the fact that it does not grant access.
• Any available user code slot (except the master code) can be used to store non-access user code.
• Schedules can be applied to non-access users.

Yale locks support the following User ID Status values:

Table 3 – User ID Status User Code CC v1 vs v2

User ID Status| User Code CC v1 Set| User Code CC v1 Report Value
---|---|---
Description| Value| Value
Available| 0x00| 0x00
Enabled / Grant Access| 0x01| 0x01
Disabled| 0x02| 0x03
0x03
Messaging:

The user code is accepted, but the lock does not grant access to the user. Instead, it generates an alarm to the Lifeline and does NOT take preventative actions for further attempts to enter the User ID and/or User Code.

| __

__

__

0x04

| __

__

__

0x04

One-Time Use:

This PIN is disabled immediately after being used for a successful unlock operation.

| __

0x06

| __

0x06

Expiring:

This PIN is disabled once a specified amount of time has passed after being used for a successful unlock operation. The expiration time is set through the Configuration command class.

| __

__

__

0x07

| __

__

__

0x07

User ID Status| User Code CC v2: Extended User Code Set| User Code CC v2: Extended User Code Report Value
---|---|---
Description| Value| Value
Available| 0x00| 0x00
Enabled / Grant Access| 0x01| 0x01
Disabled| 0x02| 0x02
Messaging:

The user code is accepted, but the lock does not grant access to the user.

Instead, it generates an alarm to the Lifeline and does NOT take preventative actions for further attempts to enter the User ID and/or User Code.

| __

__

__

__

__

__

__

0x03

| __

__

__

__

__

__

__

0x03

One-Time Use: This PIN is disabled immediately after being used for a successful unlock operation.| __

__

__

0x06

| __

__

__

0x06

Expiring:

This PIN is disabled once a specified amount of time has passed after being used for a successful unlock operation. The expiration time is set through the Configuration command class.

| __

__

__

__

__

__

0x07

| __

__

__

__

__

__

0x07

**Command Class Time Parameters, Version 1***

• This command class requires security.

The controller must set the Time Parameters in the lock anytime the lock loses power. After 10 seconds from lock enrollment, if there are no messages from the controller the lock will initially request the Time (by sending Time Get and Time Parameter Get commands). If the time is not set by the controller, then user codes with schedules applied to them cannot be granted access. When the lock is powered up, it will generate a Notification Report to indicate to the controller that power has been applied (Alarm V1 Type = 0x82, Alarm V1 Level = 0x00, Event Type = 0x08, Event Value = 0x01). This indicates to the controller that the lock no longer has a valid time set.
If the controller does not support either the Time CC or Time Parameters CC, then scheduled users will not have access.

Command Class Time, Version 2

The controller must set the Time Parameters in the lock anytime the lock loses power. Even though the Time CC is not secure, the Time Set command must be issued at the same or higher security level as when the device was enrolled for time to be set otherwise it will be rejected by the device. After 10 seconds from lock enrollment, if there are no messages from the controller the lock will initially request the Time (by sending Time Get and Time Parameter Get commands). If the time is not set by the controller, then user codes with schedules applied to them cannot be granted access. When the lock is powered up, it will generate a Notification Report to indicate to the controller that power has been applied (Alarm V1 Type = 0x82, Alarm V1 Level = 0x00, Event Type = 0x08, Event Value = 0x01). This indicates to the controller that the lock no longer has a valid time set.

If the controller does not support either the Time CC or Time Parameters CC, then scheduled users will not have access.
A time sync should occur every 8 hours, starting with the Time CC. If there is no response within a minute, the next step is to issue a Time Parameters Get to sync time.

**Command Class Firmware Update Meta Data, Version 5***

• This command class requires security.

Yale Z-Wave Plus® locks support over-the-air (OTA) upgrading of 2 firmware targets:

1. Firmware Target 0: Z-Wave® chip
2. Firmware Target 1: The lock main processor

Firmware Target 0 is used to determine the correct Z-Wave® processor image to download. ID 1 is always 0xA5, to signal this is an ASSA ABLOY Z-Wave® image, and ID 2 is specific to the region, with the lower nibble being 0x0 and the upper nibble being the value in Table 4 – Region-Specific Values for Firmware ID 0. Eventually the lower nibble will be used to separate builds within a specific region, but this will also be 0 for now, since there is only a single build of firmware.

Table 4 – Region-Specific Values for Firmware ID 0 (Upper Nibble)

Firmware 1 target will depend on which version of the lock is in use (mapped to the Product Type ID).

• For NTB612/622/632/642-ZW3 (2nd Generation Cylindrical lock), Firmware 1 ID = 0x8101
• For NTB612/622/632/642-NN-ZW3 (2nd Generation Cylindrical lock with No NFC), Firmware 1 ID = 0x8112
• For FBB618N/628N/638N/648N-ZW3 (2nd Generation Cylindrical lock with No NFC), Firmware 1 ID = 0x8112

After an OTA is performed (a Firmware Update Status Report should return with successful), there is an additional step internally where we write/apply the image to the lock/module. When the image is being applied to the lock, the lock is unresponsive until completion of the applied image. Once the completion of the OTA image is applied the lock silently reboots.

The following is the time it takes for each product to complete OTA packet transfer + image apply phase:

• For Z-Wave® Radio Chip, ~10 seconds
• For NTB612/622/632/642-ZW3 (2nd Generation Cylindrical lock), ~23 minutes
• For NTB612/622/632/642-NN-ZW3 (2nd Generation Cylindrical lock with No NFC), ~23 minutes
• For FBB618N/628N/638N/648N-ZW3 (2nd Generation Cylindrical lock with No NFC), ~23 minutes

**Command Class Association, Version 2***

• This command class requires security.

  • This command class has been implemented per the Z-Wave® Specification.

**Command Class Multi Channel Association, Version 3***

• This command class requires security.

  • This command class has been implemented per the Z-Wave® Specification.
  • Yale locks support only one group, which can contain up to 5 nodes.

**Command Class Association Group Info, Version 3***

• Command Class Requires Security

  • Yale locks support the Lifeline Association Group.

Table 5 – Association Table

__

__

__

__

__

__

1

| __

__

__

__

__

__

5

| __

__

__

__

__

__

Lifeline

| ·         Command Class Battery

o    Battery Report

·         Command Class Configuration

o    Configuration Report

·         Command Class Notification

o    Notification Report

·         Command Class Door Lock

o    Door Lock Operation Report

o    Door Lock Configuration Report

·         Command Class Device Reset Locally

o    Device Reset Locally Notification

·         Command Class User Code

o   User Code Report

o   Extended User Code Report

o   User Code Keypad Mode Report

o   Master/Admin Code Report

The following are the actions to trigger the reports:

Table 6 – Lifeline Report Trigger Table

thresholds or Power Cycle Lock
Configuration Report| Configuration Set| Change Lock Settings via Keypad
Notification Report (Access Control)| Any RF Lock Operation| Manual or Keypad Unlock/Lock
Notification Report (Power Management)| Any RF Lock Operation when lock is under the battery thresholds| Any manual/keypad Lock Operation when lock is under the battery thresholds or Power Cycle Lock
Door Lock Operation Report|  | Manual or Keypad Unlock/Lock
Door Lock Configuration Report| Door Lock Configuration Set| Enable/Disable Auto-Relock Feature via Keypad
Device Reset Locally Notification|  | HW Factory Reset
User Code Report| Add/Delete User Code via User Code Set Command| Add/Delete User Code via Keypad from Slots 1-250
Extended User Code Report| Add/Delete User Code via Extended User Code Set Command| Add/Delete User Code via Keypad from Slots 251-500
User Code Keypad Mode Report| User Code Keypad Mode Set| Enable/Disable Vacation Mode or Privacy Mode (refer to Installation Manual)
Master Code Report| Master Code Set| Update/Modify Master Code via Keypad

**Command Class Notification, Version 8***

• This command class requires security.

Table 7 – Notification Table

__

Alarm Reports

| Alarm type| Alarm Level| __

Description

| Notification Type| __

Event

---|---|---|---|---|---
__

Keypad Lock

| __

0x12

| 0x (01 –

max users)

| __

Where Alarm level represents user slot number

| __

0x06

| __

0x05

__

Keypad Unlock

| __

0x13

| 0x (01-

max users)

| Where Alarm level represents user slot number (0x00 = Master Code)| __

0x06

| __

0X06

__

__

Manual Lock

| __

__

0x15

| __

0x02

| __

by touch function (lock and leave)

| __

0x06

| __

0x01

__

0x03

| __

By inside button

| __

0x06

| __

0x01

__

RF Operate Lock

| __

0x18

| __

0x01

| __

by RF module

| __

0x06

| __

0x03

__

RF Operate Unlock

| __

0x19

| __

0x01

| __

by RF module

| __

0x06

| __

0X04

Auto Lock Operate Locked| 0x1B| 0x01| Auto re-lock cycle complete, locked.| 0x06| __

0x09

---|---|---|---|---|---
__

__

User deleted

| 0x21| 0x (01- max users)| User was deleted. Alarm level = user slot number| __ 0x06| 0X0D

(single)

0x00 ¹| __

All User codes were deleted

| 0X0C

(all)

__

Non-Access

| __

0x26

| 0x (01- max users)| A Non-Access Code was entered at the lock. Where alarm level represents user slot number| __

0x06

| __

0xFE

__

__

Door State ²

| __

__

0x2B

| 0x00| Door is open| 0x06| 0x16
0x01| Door is closed| 0x06| 0x17
0x02| Door Propped (Door Open for longer than configurable door propped time)| 0x06| 0xFE
Daily Repeating Schedule Set/Erased| __

0x60

| 0x (01- max users)| Schedule(s) has been set/erased for specified user ID| __

0x06

| __

0xFE

Daily Repeating Schedule Enabled/Disabled| __

0x61

| 0x (01- max users)| Daily Repeating Schedule(s) were enabled/disabled for User ID specified in Alarm Level. If Alarm Level = 0xFF then all users were affected.| __

0x06

| __

0xFE

Year Day Schedule Set/Erased| __

0x62

| 0x (01- max users)| Schedule(s) has been set/erased for specified user ID| __

0x06

| __

0xFE

Year Day Schedule Enabled/Disabled| __

0x63

| 0x (01- max users)| Year Day Schedule(s) were Enabled/Disabled for User ID specified in Alarm Level. If Alarm Level = 0xFF then all users were affected.| __

0x06

| __

0xFE

All Schedule Types Erased| __

0x64

| 0x (01-

max users)

| All Schedule Types were Set (erased/set) for User ID specified in Alarm Level. If Alarm Level

= 0xFF then all users were affected.

| __

0x06

| __

0xFE

---|---|---|---|---|---
All Schedule Types Enabled/Disabled| __

0x65

| 0x (01- max users)| Schedule(s) has been enable/disabled for specified user ID. If Alarm Level = 0xFF then all users were affected.| __

0x06

| __

0xFE

Master Code changed| __

0x70

| 0x00| Master code was changed at keypad or via RF| 0x06| 0x12
__

User added

| 0x (01-max users)| User added. Alarm level = user slot number| __

0x06

| __

0X0E

__

__

__

Duplicate Pin code error

| __

__

__

0x71

| __

__

0x (01-max users)

| Where Alarm level represents user slot Number, an Alarm is generated in response to add user via RF.

This alarm is not generated when attempting to add duplicate pin at the

Keypad (The lock simply denies it and plays the “Denied” sound.) Trying to duplicate the master code will result in a 0x71 0x00 alarm report.

| __

__

__

0x06

| __

__

__

0x0F

__

Battery is fully charged

| __

0x80

| 0x05| After a low battery alert was observed, the lock was powered down and powered back up with full battery.| __

0x08

| __

0x0D

Door Lock needs Time set / RF Module Power Cycled| __

0x82

| 0x00| Power to the lock was restored and the locks RTC was cleared. The controller should set the time to ensure proper logging.| __

0x08

| __

0x01

Disabled user entered at keypad| __

0x83

| 0x (01-max users)| A disabled user pin code was entered at the keypad| __

0x06

| __

0xFE

__

Valid user but outside of schedule

| __

0x84

| 0x (01- max users)| A valid user can be both a normal user and a non-Access user. If a non-access user is out of schedule this alarm will be sent instead of the non-access alarm.| __

0x06

| __

0xFE

Tamper Alarm| 0xA1| 0x01| keypad attempts exceed code entry limit| 0x06| 0X10
0x02| front escutcheon removed from main| 0x06| 0xFE
Low Battery Alarms ³| __

0xA7

| 0x (Current %)| Low Battery

Starting at 4.6V

| __

0x08

| __

0x0A

---|---|---|---|---|---
__

0xA8

| 0x (Current %)| __

Critical Battery Level Starting at 4.4V

| __

0x08

| __

0x0B

¹ Deleting all user codes will also delete any associated schedules (year day and daily repeating scheduled pin codes) assigned to user codes.
² This requires additional Hardware.
³ The Yale lock also supports a 3rd low battery alarm: too low to operate. This alarm is sent out as a Battery Report (with value = 0xFF) through the Battery Command Class. This is the last low battery alarm level before the product stops functioning. Starting at 4.2V (0x8101& 0x8112)

**Command Class Configuration, Version 4***

• This command class requires security.

Table 8 – Configurable Parameters

__

__

__

__

Param. Num.

| __

__

__

__

__

Name

| __

__

__

__

__

Length

| __

Configuration Properties

| __

Info

| Length of Info String
---|---|---|---|---|---
__

__

__

Min

| __

__

__

Max

| __

__

__

Default

|  | (Max length allowed is 90)
__

1

| __

Volume

| __

1 byte

| 0x01 (High Volume)| 0x03

(Silent)

| 0x01 (High Volume)| Set Volume Level to high (1), low (2), or silent (3).| 53
__

2

| __

Auto Relock

| __

1 byte

| 0x00

(Disable)

| 0xFF

(Enable)

| 0xFF

(Enable)

| Set Auto Relock feature to enable or disable.| __

45

__

3

| __

Relock time

| __

1 byte

| 0x01 (1

seconds) ¹

| 0xB4 (180

seconds)

| 0x03 (3

seconds)

| Adjust the time your lock will auto relock.| __

43

__

__

4

| __

Wrong Code Entry Limit

| __

__

1 byte

| __

__

0x03

| __

__

0x0A

| __

__

0x05

| Adjust the limit for wrong code entries allowed by your lock.| __

__

61

__

__

5

| __

__

Language

| __

__

1 byte

| __

0x01

(English)

| __

0x03

(French)

| __

0x01

(English)

| Set the language to English (1), Spanish (2), or French

(3).

| __

__

60

---|---|---|---|---|---|---|---
__

__

7

| __

Shut down time

| __

__

1 byte

| __

0x0A (10

seconds)

| __

0x84 (132

seconds)

| __

0x3C (60

seconds)

| Adjust the time your lock is shutdown after reaching its wrong code entry limit.| __

__

80

__

8

| __

Operating mode²

| __

1 byte

| 0x00

(Normal Mode)

| 0x03

(Passage Mode)

| 0x00

(Normal Mode)

| Set the Operating Mode to normal mode, vacation mode, privacy mode or passage mode.| __

83

__

__

11

| __

One Touch Locking

| __

__

1 byte

| __

0x00

(Disable)

| __

0xFF

(Enable)

| __

0xFF

(Enable)

| Set One Touch Locking feature to enable or disable.| __

__

51

__

12

| __

Privacy Button

| __

1 byte

| 0x00

(Disable)

| 0xFF

(Enable)

| 0x00

(Disable)

| Set Privacy Button feature to enable or disable.| __

48

__

18

| Door Propped Timer³| __

1 byte

| 0x00

(Disable) ⁴

| 0xFE (2540

seconds) ⁴

| 0x00

(Disable) ⁴

| Adjust the time to receive an alert when the door is propped open.| __

66

19| DPS Alarms ³ (AUX Sensor)| 1 byte| 0x00

(Disable)

| 0xFF

(Enable)

| 0xFF

(Enable)

| Enable or Disable DPS Alarms| 28
__

21

| Eco Mode On/Off ⁵| __

1 byte

| 0x00

(Disable)

| 0xFF

(Enable)

| 0x00

(Disable)

| Enable or Disable Eco Mode feature| __

34

__

28

| Expiring Pin Code Enabled Time| __

1 byte

| 0x00

(Disable)

| 0xFF (127

Hours)

| 0x00

(Disable)

| Timeout value used to determine time after first entry is triggered.| __

68

---|---|---|---|---|---|---|---

¹ Even know we accept value 0x01 for Auto Relock Time, we limit the lock’s minimum to value of 0x03. Therefore, if user tries to set Auto Relock Time to values 0x01 or 0x02, it will always report back value of 0x03.
² When Operation Mode feature is set to Passage Mode, this also results in disabling the following configuration parameters 2 (Auto Relock feature). The Passage Mode feature can only be set when Passage User Pin Code is used to unlock the lock.
³ Additional hardware required. These parameters are only active if the optional Door Position Switch has been installed with the lock.
⁴ The Door Propped value is represented as seconds X 10. (ie a value of 4 would mean a door propped timer of 40 seconds).
⁵ Only Supported by Touch Screen models NTB622/642, NTB622/642-NN, & FBB628N/648N.

Command Class Application Status, Version 1

• This command class has been implemented per the Z-Wave® Specification.

Command Class Transport Service, Version 2

• This command class has been implemented per the Z-Wave® Specification.

Command Class Supervision, Version 1

• This command class has been implemented per the Z-Wave® Specification.

**Command Class Indicator, Version 3***

• This command class requires security.

  • The indicator feature is set by using Indicator ID 0x50 to identify the node and Property ID 0x02 or 0x03, 0x04 and 0x05.

Table 9 – Lock UI for Indicator Set Overview

FBB628N/648N: Numbers 0-9 on Touch Screen Flash

NTB612/632, NTB612/632-NN, & FBB618N/638N: All buttons Flash

To set the Indicator ID 0x50 with Property 0x02, set values to 0x00 for off and 0x01…0x63 or 0xFF for on.
To properly set the Indicator ID 0x50 with Properties 0x03, 0x04 and 0x05, we had to map the values to our lock’s specific blink rate.

Table 10 – Minimum Values for Indicator Set Property IDs 0x03, 0x04, & 0x05 to trigger Lock UI

Property ID 0x03 (On/Off Periods) Fixed Value| Property ID 0x04 (On/Off Cycles) Minimum Value| Property ID 0x05 (On time within an on/Off period) Fixed Value
---|---|---
0x14*| 0x00…0xFF (per Z-

Wave® Spec)

| 0x0A*

NOTE: If Property IDs 0x03 and 0x05 are set to value other than the above, then the lock will blink at the different number of cycles than what you have set.

**Command Class Basic, Version 2***

• This command class requires security.

This command class is mapped to Door Lock CC:

Table 11 – Basic Mapping Overview

Mode = 0x00)

Basic Report (Current Value = 0xFF)| Door Lock Operation Report (Door Lock Mode > 0x00)

The Basic Get Current Value, Basic Get Duration, and Basic Get Target Value are mapped to Door Lock Operation Get and Basic Set is directly mapped to Door Lock Operation Set where the Duration is returned as is, but the Value and Target Door Lock State Value of the Basic Report use the following mapping:

Table 12 – Basic Report: Value

Yale Locks in Z-Wave® 700 Series System Best Practices

Communication Signal Format

Figure 1: Signal Time Format

Data from the lock to Z-Wave® 700 Series (ZW3) module takes 20 milliseconds.
Data from Z-Wave® 700 Series (ZW3) module to the lock takes 20 milliseconds.
During the communication between the lock and module, the Z-Wave® System must account for Gap time of 50 milliseconds which usually occurs when there is a configuration update, door lock state change, and user code being added/removed.

Commands Communication Timing

The following are the commands and total times that the Z-Wave® System needs to be aware of when interacting with our ZW3 Locks before sending next commands:

Table 13 – Event vs Process Time

5.348 seconds
Manual Unlock via Thumb turn/ One Touch Lock via Keypad/

User Code Unlock/Lock ¹

| 45 milliseconds
User Code Get| 40 milliseconds
User Code Set

(Adding Single User Code) ²

| 492 milliseconds
User Code Set

(Deleting Single User Code)

| 640 milliseconds
User Code Set

(Deleting All User Codes)

| 1.724 seconds
Configuration Get (Single Parameter) ³| 40 milliseconds
Configuration Set

(Single Parameter) ³, ⁴

| 40 milliseconds
Battery Get| 40 milliseconds

¹ Our Motor operating time for moving deadbolts is 2 seconds.
² When multiple user codes are added in the Yale locks, an additional registration time of 230 milliseconds needs to be accounted for from User Code Set of Slot 1 to User Code Set of Lock’s last slot.
³ During initial Configuration Get or Set commands the overall timing for completion of these commands increases due to the module requesting all values of each parameter the lock supports. If lock supports 12 parameters, the total time the initial Configuration Get or Set command will take is 1.430 seconds.
⁴ When Configuration Parameter 8, Operation Mode feature, is set to value 3, Passage Mode, this also results in disabling the following configuration parameters 2 (Auto Relock feature). Therefore, Total Time will be 260 milliseconds. When Configuration Parameter 16, Escape Return Mode feature, is enabled, this also results in disabling the following configuration parameters 2 (Auto Relock feature) and 11 (One Touch Locking feature). Therefore, Total Time will be 390 milliseconds.

Read User Manual Online (PDF format)

Download This Manual (PDF format)

Download this manual  >>