Z-Way Certification Documentation

Version 5

Application Command Classes

Go to Configuration, select the end device in the left column, go to Expert commands, select command class in the right column.

Barrier Operator Command Class

Configuration -> Expert commands -> BarrierOperator

Get

Set

State: 0 - Close, 255 - Open

SignalGet

Signal type: 0 - Not supported, 1 - Audible notification, 2 - Visual notification

SignalSet

Signal type: 0 - Not supported, 1 - Audible notification, 2 - Visual notification

State: 0 - Off, 255 - On

Basic Command Class

Configuration -> Expert commands -> Basic

Get

Set

Level: 0 - Off, 0 ... 255 - Dimmer level, 99 - Max, 255 - On

Binary Switch Command Class

Control -> Switch

Configuration -> Expert commands -> SwitchBinary

Get

Set

Level: 0 - Off, 255 - On

Duration: 0 - immediately, 1 ... 127 - in seconds, 1 ... 127 - in minutes, 255 - use device default

Central Scene Command Class

Configuration -> Expert commands -> CentralScene

Key Attribute Description
0 Key Pressed
1 Key Released
2 Key Held Down
3 Key Pressed 2 times
4 Key Pressed 3 times
5 Key Pressed 4 times
6 Key Pressed 5 times

Color Switch Command Class

Configuration -> Expert commands -> SwitchColor

Get

Color Capability: 0 - Soft White, 1 - Cold White, 2 - Red, 3 - Green, 4 - Blue

Set

Color Capability: 0 - Soft White, 1 - Cold White, 2 - Red, 3 - Green, 4 - Blue

Value: 0 ... 255

StartStateChange

Color Capability: 0 - Soft White, 1 - Cold White, 2 - Red, 3 - Green, 4 - Blue

Direction: 0 - Up, 1 - Down

Duration: 0 - immediately, 1 ... 127 - in seconds, 1 ... 127 - in minutes, 255 - use device default

Ignore: 0 - No, 1 - Yes

Start Level: 0 ... 255

StopStateChange

Color Capability: 0 - Soft White, 1 - Cold White, 2 - Red, 3 - Green, 4 - Blue

overrideDefaultDuration

If not specifically specified in Set, use this duration instead of the device default value

Duration: null - use device default, 0 - immediately, 1 ... 127 - in seconds, 1 ... 127 - in minutes

Configuration Command Class

For many devices, the UI has a description of the configuration parameters.

Configuration -> Configuration

If there is no description of the configuration parameters in the UI for the device, then you need to use the user's guide and enter the settings manually in the expert commands.

Configuration -> Expert commands -> Configuration

DefaultReset

Get

Parameter: 0 ... 255

Set

Parameter: 0 ... 255

Value: 0 ... 4294967295

Size: 0 - auto detect, 1 - 1 byte, 2 - 2 bytes, 4 - 4 bytes

SetDefault

Parameter: 0 ... 255

preferBulk

Prefer Configuration Bulk Get instead of Configuration Get: false - use Configuration Get, true - use Configuration Bulk Get

Door Lock Command Class

Control -> Locks

Configuration -> Expert commands -> DoorLock

ConfigurationGet

ConfigurationSet

Operation Mode: 1 - Constant operation, 2 - Timed operation

Timeout, seconds: 0 ... 14639

Autolock Time, seconds: 0 ... 65535

Hold and release Time, seconds: 0 ... 65535

Twist Assist: 0 - Disabled, 1 - Enabled

Block to block: 0 - Disabled, 1 - Enabled

Get

Set

Meter Command Class

Scale

Control -> Meters

Configuration -> Expert commands -> Meter

Get/Reset

Scale

Control -> Meters

Multilevel Sensor Command Class

Configuration -> Expert commands -> SensorMultilevel

Get

Scale

Control -> Sensors

Temperature Units Metric

Temperature scales are automatically converted from device units to controller units °C or °F. Controller units can be changed.

Configuration -> Expert Commands -> Z-Way (usually #1) -> Controller settings

Multilevel Switch Command Class

Control -> Switch

Configuration -> Expert commands -> SwitchMultilevel

Get

Set

Dimmer level: 0 - Off, 0 ... 99, 99 - Full, 255 - On

Duration: 0 - immediately, 1 ... 127 - in seconds, 1 ... 127 - in minutes, 255 - use device default

StartLevelChange

Direction: 0 - Up, 255 - Down

Duration: 0 - immediately, 1 ... 127 - in seconds, 1 ... 127 - in minutes, 255 - use device default

StopLevelChange

overrideDefaultDuration

If not specifically specified in Set, use this duration instead of the device default value

Duration: null - use device default, 0 - immediately, 1 ... 127 - in seconds, 1 ... 127 - in minutes

Notification Command Class

Event

Control -> Notifications

Configuration -> Expert commands -> Notification

Get

Set

Type, Status: 0 - Disable, 255 - Enable

Sound Switch Command Class

Configuration -> Expert commands -> SoundSwitch

ConfigurationGet

ConfigurationSet

Tone: 0 - Don't change, adjust only volume, 1 ... 254

Volume: 0 - Mute, 1 ... 100, 255 - Last

Example: Mute volume (set to 0)

TonePlayGet

TonePlaySet

Tone: 0 - Stop, 1 ... 254, 255 - Default

Volume: 0 - Default, 1 ... 100, 255 - Last

TonePlaySet

Example: Stop

Example: Set volume (to 100)

Example: Play tone (Tone 3)

Example: Play default tone

Thermostat Fan Mode Command Class

Configuration -> Expert commands -> ThermostatFanMode

Get

Set

Level: 0 - Off, 1 - On

Thermostat Mode Command Class

Control -> Thermostat

Configuration -> Expert commands -> ThermostatMode

Get

Set

Type: 0 - Off, 1 - Heat

SetManufacturerSpecific

Thermostat Setpoint Command Class

Control -> Thermostat

Configuration -> Expert commands -> Thermostat Setpoint

Get

Set

Value: 0 ... 100

Temperature Units Metric

Temperature scales are automatically converted from device units to controller units °C or °F. Controller units can be changed.

Configuration -> Expert Commands -> Z-Way (usually #1) -> Controller settings

User Code Command Class

Configuration -> Expert commands -> UserCode

ChecksumGet/ChecksumSet

0 - All udercodes, User Id: 1 ... 65535

Keypad Mode Get/Keypad Mode Set

Mode: 0 - Normal, 1 - Vacation, 2 - Privacy, 3 - Locked out

Master Code Get/Master Code Set

Code: 4 ... 10 Digitals

Master Code Disable

To disable the master code, send an empty field.

Set User ID

Example: set user ID 2 with code 1234

Erase User ID

Example: erase user ID 2

Management Command Classes

Go to Configuration, select the end device in the left column.

Association Command Class

For many devices, the UI has a description of the associations.

Configuration -> Association

If there is no description of the associations in the UI for the device, then you need to use the user's guide and enter the settings manually in the expert commands.

Configuration -> Expert commands -> Association

Get

Group: 1 ... 255

GroupingsGet

Remove

Group: 1 ... 255

Node: 1 ... 255

Set

Group: 1 ... 255

Node: 1 ... 255

Association Group Information Command Class

Configuration -> Expert commands -> AssociationGroupInformation

GetCommands

Group: 1 ... 255

GetInfo

Group: 1 ... 255

GetName

Group: 1 ... 255

Device Reset Locally Command Class

Controller Factory Default Reset

To reset the Z-Way controller, go to Network -> Controller, press red button "Controller Factory Default".

The List Of Reseted End Devices

The home page displays the nodeId and name of the list of reseted devices.

Firmware Update Meta Data Command Class

Go to Configuration, select the end device in the left column, go to Firmware update.

IndicatorCommandClass

Configuration -> Expert commands -> Indicator

Get

Indicator ID: 1 ... 255

Identify

Set

Indicator ID: 1 ... 255

Property ID: 0 ... 255

State: 0 ... 255

Multi Channel Association Command Class

Configuration -> Expert commands -> MultiChannelAssociation

Get

Group: 1 ... 255

GroupingsGet

Remove

Group: 1 ... 255

Node: 1 ... 255

instance: 1 ... 127

Set

Group: 1 ... 255

Node: 1 ... 255

instance: 1 ... 127

Wake Up Command Class

Configuration -> Expert commands -> Wakeup

CapabilitiesGet/Get

Set

Wakeup time, seconds: 1800 ... 432000

to Node: 1 ... 255

Sleep

Descriptions

Association

Controller Association Groups

The controller supports one group Lifeline with a maximum of 5 devices. A Device Reset Locally Notification is sent to the group.

Configuration -> Association

Select Z-Way. To get list of associated devices press button Update from Device.

To remove associated device press red X button.

Get/Remove

Set

To set new association press plus button, choose device and channel of this device, then press Add button.

End Device Association Groups

Configuration -> Association

To get list of associated devices press button Update from Device.

To remove associated device press red X button.

Get/Remove

Set

To set new association press plus button, choose device and channel of this device, then press Add button.

Indicator State

The controller supports receiving command Indicator Set and show Indicator ID, Property ID, State. Go to Configuration, select (#1) Z-Way, Expert Commands -> Indicator -> state.

Sending Identify command to controller

Network -> Controller Info -> Identification LED

Long Range

Network -> Control

To include device in the Long Range mode open SmartStart/Long Range page. Add the DSK on the SmartStart page and power up the device. The controller will automatically add the device.

Make sure that the frequency of the controller is selected with Long Range support.

SmartStart

Network -> Control

Сlick the SmartStart/Long Range button to open the DSK registration window. To include device via SmartStart add DSK code.

The "Scan QR Code" tab requests access to the camera to scan the QR code. Also you can upload a photo with QR Code.

The "Enter device key manually" tab allow you to enter a key manually, then press Register.

The "Device Key List" tab contains a list of all registered DSK. To delete a key, click on the trash.

Inclusion via scanning a QR code

Network -> Control -> SmartStart -> Scan QR code

Safari allows you to use the camera on a local network, so you can scan the QR code from your laptop or phone while on the same local network with the Z-Way controller. Chrome allows you to access the camera via https connection or from localhost.

When working with Chrome, you can forward the port from the local network (192.168.2.237:8083) to localhost (localhost:5555).

socat TCP-LISTEN:5555,reuseaddr,fork TCP:192.168.2.237:8083

Supervision

If the end device supports the Supervision command class, the controller will wrap all Set commands in Supervision.

If the end device sends a command wrapped in Supervision to the controller, in case of successful processing, controller will respond with Done, if the command is not supported, controller will respond with Not Supported.

Classic Inclusion and Exclusion

Network -> Control

To add new device to the Z-Wave network press Start Classic Inclusion.
To remove device from the Z-Wave network press Start Exclusion.

Include into Network

To include Z-Way controller into another controller start the inclusion on the customer's primary controller and press the Include into Network button. The Z-Way must be reset to factory settings before adding.

Force Interview

To start re-interview for device go to Configuration, select device, choose Interview tab, press Force Interview button

Terminology

Adding/Removing

On factory default the device does not belong to any Z-Wave network. The device needs to join an existing wireless network to communicate with the devices of this network. This process is called Adding. Devices can also leave a network. This process is called Removing. Both processes are initiated by the primary controller of the Z-Wave network. This controller will be turned into removing respective adding mode. Please refer to your primary controllers manual on how to turn your controller into adding or removing mode. Only if the primary controller is in adding or removing mode, this device can join or leave the network. Leaving the network - i.e. being removed - sets the device back to factory default.

If the device already belongs to a network, follow the removing process before adding it in your network. Otherwise adding of this device will fail. If the controller being added was a primary controller, it has to be reset first.

Copy

Replication function of copying network information from one controller to another is called Copy.

All supported Security S2 Command Classes

Command Class Version Requested Security Class
COMMAND_CLASS_APPLICATION_STATUS V1 S0, Unauthenticated, Authenticated, Access Control
COMMAND_CLASS_ASSOCIATION_GRP_INFO V3 S0, Unauthenticated, Authenticated, Access Control
COMMAND_CLASS_ASSOCIATION V3 S0, Unauthenticated, Authenticated, Access Control
COMMAND_CLASS_CRC_16_ENCAP V1 None
COMMAND_CLASS_DEVICE_RESET_LOCALLY V1 S0, Unauthenticated, Authenticated, Access Control
COMMAND_CLASS_FIRMWARE_UPDATE_MD V7 S0, Unauthenticated, Authenticated, Access Control
COMMAND_CLASS_INCLUSION_CONTROLLER V1 S0, Unauthenticated, Authenticated, Access Control
COMMAND_CLASS_INDICATOR V4 S0, Unauthenticated, Authenticated, Access Control
COMMAND_CLASS_MANUFACTURER_SPECIFIC V2 S0, Unauthenticated, Authenticated, Access Control
COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION V4 S0, Unauthenticated, Authenticated, Access Control
COMMAND_CLASS_MULTI_CMD V1 None
COMMAND_CLASS_NODE_NAMING V1 S0, Unauthenticated, Authenticated, Access Control
COMMAND_CLASS_POWERLEVEL V1 S0, Unauthenticated, Authenticated, Access Control
COMMAND_CLASS_SECURITY V1 None
COMMAND_CLASS_SECURITY_2 V1 None
COMMAND_CLASS_SUPERVISION V2 None
COMMAND_CLASS_TIME V2 S0, Unauthenticated, Authenticated, Access Control
COMMAND_CLASS_TRANSPORT_SERVICE V2 None
COMMAND_CLASS_VERSION V2 S0, Unauthenticated, Authenticated, Access Control
COMMAND_CLASS_ZWAVEPLUS_INFO V2 None