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
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 | Press | Toggle LED0 |
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. |
LED | Description |
|---|---|
LED0 | Switch: LED ON indicates SWITCH ON / LED OFF indicates SWITCH OFF |
LED1 | 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 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 LED0 |
send_nif | - | Sending Node Information Frame |