Door Lock#
The Z-Wave certified Door Lock application shows a lock implementation. It supports user codes to open a door and thereby eliminate the need for traditional keys. It is possible to both lock and unlock the door remotely through the Z-Wave protocol.
The Door Lock application is based on:
Role Type | Listening Sleeping End device (LSS / FLiRS) |
Supporting Device Type | Actuator |
Device Type | Lock |
Generic Type | Entry Control |
Specific Type | Door Lock |
Requested security keys | S0 and S2_ACCESS The Door Lock features depend on the security level |
The application will only work when securely added to a network by a controller supporting security. The controller MUST support security S2_Access_Control or S0 in order to be able to control the door lock.
Not implemented Door lock functionality:
Timed Operation mode
Door Lock condition
Inside Door Handle State
Functionality handling Lock timeout
Target mode
Auto-Relock, Hold And Release, Block to Block, and Twist Assist
Supported Command Classes#
The Door Lock application implements mandatory and some optional command classes. The table below lists the supported Command Classes, their version, and their required Security class, if any.
Command Class | Version | Required Security Class |
|---|---|---|
Association | 2 | S0 or Access Control |
Association Group Info | 3 | S0 or Access Control |
Basic | 2 | S0 or Access Control |
Battery | 1 | S0 or Access Control |
Device Reset Locally | 1 | S0 or Access Control |
Door Lock | 4 | S0 or Access Control |
Firmware Update Meta Data | 5 | S0 or Access Control |
Indicator | 3 | S0 or Access Control |
Manufacturer Specific | 2 | S0 or Access Control |
Multi-Channel Association | 3 | S0 or Access Control |
Powerlevel | 1 | S0 or Access Control |
Security 0 | 1 | None |
Security 2 | 1 | None |
Supervision | 1 | None |
Transport Service | 2 | None |
User Code | 1 | S0 or Access Control |
Version | 3 | S0 or Access Control |
Z-Wave Plus Info | 2 | None |
Basic Command Class mapping#
The Basic Command Class is mapped according to the table below.
Basic Command | Mapped Command |
|---|---|
Basic Set (Value) | Door Lock Operation Set (Door Lock Mode) |
Basic Report (Current Value = 0x00) | Door Lock Operation Report (Door Lock Mode = 0x00) |
Basic Report (Current Value = 0xFF) | Door Lock Operation Set (Door Lock Mode) |
Association Groups#
The table below shows the available association groups, including supported command classes for Z-Wave and Z-Wave Long Range respectively.
ID | Name | Node Count | Description |
|---|---|---|---|
1 | Lifeline | X | Supports the following command classes:
|
X: For Z-Wave node count is equal to 5 and for Z-Wave Long Range it is 1.
Usage of Buttons and LED Status
To use the sample app, the BRD8029A Button and LEDs Expansion Board must be used. BTN0-BTN3 and LED0-LED3 refer to the buttons and LEDs on the Expansion Board.
The following LEDs and buttons shown in the next table below are used.
Button | Action | Description |
|---|---|---|
RST | Press | Resets the firmware of an application (like losing power). All volatile memory will be cleared. |
BTN0 | Button up/down | If the outside door handle state is active: Button down sets the outside door handle mode active. Button up sets the outside door handle mode inactive. |
BTN1 | Press | Enter "learn mode" (sending node info frame) to add/remove the device. Removing the device from a network will reset it. |
Hold for at least 5 seconds and release | Perform a reset to factory default operation of the device, and a Device Reset Locally Notification Command is sent via Lifeline. | |
BTN2 | Button press | Sends Battery Report. |
BTN3 | Button press | Simulates entering a user code on a keypad. The entered user code is hard-coded with the value of the default user code of the application. The default user code is 1234. A valid user code entry (i.e., button press) toggles the Door Lock Mode between Secured and Unsecured, with a delay of 2 seconds, to simulate timed hardware operation. If the user code for user ID 1 is changed to something else than the default user code, the Door Lock Mode can no longer be toggled by pressing this button. |
LED | Description | ||
|---|---|---|---|
LED0 | Latch: | Led on -> latch open [bit 0] | Led off -> latch closed [bit 1] |
LED1 | Blinks with 1 Hz when learn mode is active. Used for Indicator Command Class. | ||
LED3 | Bolt: | Led on -> bolt locked [bit 0] | Led off -> bolt unlocked [bit 1] |
Firmware Update#
This section will describe backward compatibility when upgrading the Door Lock application from one SDK to a newer version.
SDK 7.1x is the first SDK running on Z-Wave 700.