Wall Controller#

The Z-Wave certified Wall Controller application shows a push-button switch panel implementation to control devices in the Z-Wave network from push buttons (physical or virtual) on a device that is meant to be mounted on a wall. Examples include scene and zone controller and wall-mounted AV controllers.

The Wall controller application implements a wall-mounted switch that has three individually configurable buttons. Each button has support for on/off and dimming.

The Wall Controller application is based on:

Role Type

Always On End device (AOS)

Supporting Device Type

Actuator

Device Type

Central Scene

Generic Type

Wall Controller

Specific Type

Not Used

Requested security keys

S0, S2_UNAUTHENTICATED, and S2_AUTHENTICATED The Wall Controller features do not depend on the security level.

Supported Command Classes#

Command Class

Version

Required Security Class

Association

2

Highest granted Security Class

Association Group Info

3

Highest granted Security Class

Central Scene

3

Highest granted Security Class

Device Reset Locally

1

Highest granted Security Class

Firmware Update Meta Data

5

Highest granted Security Class

Indicator

3

Highest granted Security Class

Manufacturer Specific

2

Highest Granted Security Class

Multi-Channel Association

3

Highest granted Security Class

Powerlevel

1

Highest granted Security Class

Security 0

1

None

Security 2

1

None

Supervision

1

None

Transport Service

2

None

Version

3

Highest granted Security Class

Z-Wave Plus Info

2

None

Use case:

The wall controller's three buttons are configurable to control nodes. Each button action is sent over the Lifeline as scene actions.

Basic Command Class mapping#

Basic Command Class is not mapped to any of the supported command classes.

Association Groups#

The following association groups are available for Z-Wave and Z-Wave Long Range respectively.

ID

Name

Node Count

Description

1

Lifeline

X

Supports the following command classes:

  • Device Reset Locally: triggered upon reset.

  • Central Scene: triggered by button press.

  • Indicator Report: Triggered when LED1 changes state.

2

BTN0

Y

Basic Set Command

3

Y

Switch Multilevel CC

4

BTN2

Y

Basic Set Command

5

Y

Switch Multilevel CC

6

BTN3

Y

Basic Set Command

7

Y

Switch Multilevel CC

X: For Z-Wave node count is equal to 5 and for Z-Wave Long Range it is 1.

Y: For Z-Wave node count is equal to 5 and for Z-Wave Long Range it is 0.

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

Radio Board 1

Thunderboard 1

RST

Press

Resets the firmware of an application (like losing power). All volatile memory will be cleared.

BTN0

Press

  • Lifeline with Central Scene Key Attribute "Key Pressed 1 Time"

  • Trigger association group 2: Basic Set

Hold start

  • Lifeline with Central Scene Key Attribute "Key Held Down"

  • Trigger association group 3: Multilevel Switch Start Level Change

Hold release

  • Lifeline with Central Scene Key Attribute "Key Released"

  • Trigger association group 3: Multilevel Switch Stop Level Change

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

Press

  • Lifeline with Central Scene Key Attribute "Key Pressed 1 Time"

  • Trigger association group 4: Basic Set

Not supported

Hold start

  • Lifeline with Central Scene Key Attribute "Key Held Down"

  • Trigger association group 5: Multilevel Switch Start Level Change

Hold release

  • Lifeline with Central Scene Key Attribute "Key Released"

  • Trigger association group 5: Multilevel Switch Stop Level Change

BTN3

Press

  • Lifeline with Central Scene Key Attribute "Key Pressed 1 Time"

  • Trigger association group 6: Basic Set

Hold start

  • Lifeline with Central Scene Key Attribute "Key Held Down"

  • Trigger association group 7: Multilevel Switch Start Level Change

Hold release

  • Lifeline with Central Scene Key Attribute "Key Released"

  • Trigger association group 7: Multilevel Switch Stop Level Change

LED

Description

LED1

Blinks with 1 Hz when learn mode is active. Used for Indicator Command Class.

1: A Radio Board is plug-in board for the Wireless Pro Kit Mainboard. A Thunderboard is a stand-alone kit with a direct USB Type-C connection.

Firmware Update#

This section will describe backward compatibility when upgrading the Wall Controller application from one SDK to a newer version.

CLI Support#

Please note the zw_cli_common component will modify the power consumption in case of sleeping applications. Like door lock keypad, sensor pir or multilevel sensor. CLI cannot work with sleep mode, after a reset the application stays awake until the user issues the enable_sleeping command. From that point CLI won't work and sleep mode will be reached until the next reset.

Command

Arguments

Description

set_learn_mode

Toggling the learn mode functionality. In case the learn mode started, but inclusion does not happen,learn mode will automatically stop after about 30 seconds

factory_reset

-

Executing factory reset

get_dsk

-

Printing out the generated DSK of the device

get_region

-

Printing out the set region of the application

send_central_scene_key

First argument is the number of the key, which could be 1, 2 or 3. Second argument is the action we want to do, which could be press, hold or release. The funcitonality of the keys are equivalent to BTN0, BTN2 and BTN3's from above. Functionality mapping: BTN0 -> parameter 1 BTN2 -> parameter 2 BTN3 -> parameter 3

Triggering central scene key