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 LED0 changes state.

2

KEY1

Y

Basic Set Command

3

Y

Switch Multilevel CC

4

KEY2

Y

Basic Set Command

5

Y

Switch Multilevel CC

6

KEY3

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#

We are differentiating four different types of button presses. The following types are the same for the BTN0 and BTN1 on the WSTK board. The duration values can be configured under the config directory in app_button_press_config.h file in each generated application/project.

Please note external wakeup is not supported on button 1 in case of brd2603a and brd2603b.

Press Type

Duration

Short Press

0 - 400 ms

Medium Press

401 - 1500 ms

Long Press

1501 - 5000 ms

Very Long Press

Every press longer than Long Press

Button

Action

Description

RST

Press

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

BTN0

Short Press

Triggers association group 2: Basic Set

Hold longer than Short Press

Association group 3: Multilevel Switch Start Level Change

Released after being held longer than Short Press

Association group 3: Multilevel Switch Stop Level Change

BTN1

Short Press

Enter "learn mode" (sending node info frame) to add/remove the device.
Removing the device from a network will reset it.

Very Long Press

Perform a reset to factory default operation of the device, and a Device Reset Locally Notification Command is sent via Lifeline.

LED

Description

LED0

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

Firmware Update#

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

Firmware update from previous versions should work without any additional steps.

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 used to determine the action of the specified key, which can be press, hold or release.

Triggering central scene key