Switch On/Off#
The Z-Wave certified Switch On/Off application shows a switch implementation, that turns on any device that is connected to power. Examples include lights, appliances, etc.
Role Type | Always On End device (AOS) |
Supporting Device Type | Actuator |
Device Type | Binary Switch |
Generic Type | Switch Binary |
Specific Type | Not Used |
Requested security keys | S0, S2_UNAUTHENTICATED, and S2_AUTHENTICATED |
Supported Command Classes#
The Switch On/Off application implements mandatory and some optional command classes. The table below lists the supported Command Classes, their version, and their required Security class.
Command Class | Version | Required Security Class |
|---|---|---|
Association | 2 | Highest granted Security Class |
Association Group Info | 3 | Highest granted Security Class |
Basic | 2 | Highest granted Security Class |
Binary Switch | 2 | 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 |
Basic Command Class mapping#
Basic Command Class is mapped to Binary Switch CC
Basic Command | Mapped Command |
|---|---|
Basic Set (Value) | Binary Switch Set (Value) |
Basic Report (Current Value, Duration) | Binary Switch Report (Value, Duration) |
Association Group configuration#
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
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 | Toggles LED1 |
BTN1 | Short Press | Enter "learn mode" (sending node info frame) to add/remove the device. |
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. |
LED1 | Switch:
|
Firmware Update#
This section will describe backward compatibility when upgrading the Switch On/Off 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 |
toggle_led | - | Toggling LED1 |
send_nif | - | Sending Node Information Frame |
get_led_state | - | Get the state of the LED1. Can be "on" or "off" |