Z-wave Cloudapi Inclusion Or Exclusion Installation Guide

Z-wave Cloudapi Inclusion Or Exclusion Installation Guide

Z Wave logoCloudAPI Inclusion or Exclusion
Installation Guide

CloudAPI Inclusion or Exclusion

This device is a security enabled Z-Wave Plus™ product that can use encrypted Z-Wave Plus messages to communicate to other security enabled Z-Wave Plus products.

D.1 CloudAPI – Inclusion/Exclusion

Inclusion S0 device:
For inclusion one Z-Wave™ device is in add mode and the other one is in learn mode.

  1. Include a Z-Wave device (Door lock, Switch, Dimmer…), clickZ Wave CloudAPI Inclusion or Exclusion - ICON 1 buttonZ Wave CloudAPI Inclusion or Exclusion - Z Wave device
  2. Then pop up the inclusion mode window, display searching for Z-Wave DeviceZ Wave CloudAPI Inclusion or Exclusion - display searching
  3. Press the button on the device which you want to include, wait for the inclusion to end, display device information, click doneZ Wave CloudAPI Inclusion or Exclusion - device list
  4. View Z-Wave device list, the newly registered device should showZ Wave CloudAPI Inclusion or Exclusion - S2 device

Inclusion S2 device: 

  1. Include a Z-Wave S2 device, clickZ Wave CloudAPI Inclusion or Exclusion - ICON 1 buttonZ Wave CloudAPI Inclusion or Exclusion - device information
  2. Press the button on the device which you want to include, wait for a dialog and input first 5 digits DSK, click OkZ Wave CloudAPI Inclusion or Exclusion - 5 digits DSK
  3. wait for the inclusion to end, display device information, click doneZ Wave CloudAPI Inclusion or Exclusion - display device information
  4. View Z-Wave device list, the newly registered device should showZ Wave CloudAPI Inclusion or Exclusion - registered device

Exclusion:
For exclusion one Z-Wave device is in removing mode and the other one is in learn mode.

  1. Exclude a Z-Wave device (Door lock, Switch, Dimmer…), clickZ Wave CloudAPI Inclusion or Exclusion - Delete button  Z Wave CloudAPI Inclusion or Exclusion - Door lock
  2. Then pop up the exclusion mode window, display deleting for Z-Wave DeviceZ Wave CloudAPI Inclusion or Exclusion - display deleting
  3. Press the button on the device which you want to exclude, wait for the exclusion to end, display device information, click doneZ Wave CloudAPI Inclusion or Exclusion - exclusion to end

D.2 CloudAPI – Device information

Device information:

  1. ClickFinori VNA53A Buffet Cabinet - Icon 9 button, Device information should display: Device name / Device Type / Node ID / Product ID / Product Type/ Vendor NameZ Wave CloudAPI Inclusion or Exclusion - Device information
  2. Display device informationZ Wave CloudAPI Inclusion or Exclusion - Display device information 2

D.3 CloudAPI – Basic operation

Basic Z-Wave device operation:
Basic operation of Switch on the Cloud API interface

  1. Device is already registered(Switch as an example)Z Wave CloudAPI Inclusion or Exclusion - registered
  2. ClickZ Wave CloudAPI Inclusion or Exclusion - ICON 2 button, control switch ON/OFFZ Wave CloudAPI Inclusion or Exclusion - control switch

D.4 CloudAPI – Network information

Network information:

  1. ClickZ Wave CloudAPI Inclusion or Exclusion - ICON 3 button Z Wave CloudAPI Inclusion or Exclusion - Network information
  2. Display Z-Wave Network informationZ Wave CloudAPI Inclusion or Exclusion - Network information 2

D.5 Controllers – Replication

Controller replication (Copy) is achieved through Inclusion and Set Learn Mode.
Entering learn mode while in a network will trigger a replication if the primary controller is in add node mode. So, replication and Learn Mode are the same and you just need to do Learn Mode here.

  1. Prepare two mains powered Z-Wave DUTs and cloud API web shows as below
    #2 DUT do factory reset first,Z Wave CloudAPI Inclusion or Exclusion - factory reset
  2. Click “Inclusion Mode” on the 1#Z Wave CloudAPI Inclusion or Exclusion - Inclusion Mode
  3. Click “Enter Learn Mode” on the 2#Z Wave CloudAPI Inclusion or Exclusion - Enter Learn Mode

D.6 Controllers – Learn Mode

  1. Click “Enter Learn Mode” on the webZ Wave CloudAPI Inclusion or Exclusion - Enter Learn Mode 2
  2. Then will show this DSK pin informationZ Wave CloudAPI Inclusion or Exclusion - DSK pin information

D.7 Controllers – Including the DUT

  1. Prepare two mains powered Z-Wave DUTs, #2 DUT do factory reset first.Z Wave CloudAPI Inclusion or Exclusion - factory reset 2
  2. Click “Inclusion Mode” on the 1#Z Wave CloudAPI Inclusion or Exclusion - Inclusion Mode 2
  3. Click “Enter Learn Mode” on the 2#Z Wave CloudAPI Inclusion or Exclusion - Enter Learn Mode 3
  4. Then you will see DSK information below, remember the first five numbers underline.Z Wave CloudAPI Inclusion or Exclusion - DSK information below
  5. Soon 1# web will pop out the DSK input box, fill the box with the first five numbers shows in 2#, and then click OK buttonZ Wave CloudAPI Inclusion or Exclusion - DSK input box
  6. Later will shows the 2#’s information, then click DONE button, refresh the 1# web, in the Z-Wave list, it will show the new included controller info, it means the operation of including the DUT successfully Z Wave CloudAPI Inclusion or Exclusion - DONE button

D.8 Controllers – Basic Documentation

This product supports Basic Command and can give action if received a Basic Command.

D.9 Terminology

Z-Wave functionalityDocumentation terminologyExample
InclusionAddThe process of adding a node to the Z-Wave network.
ExclusionRemoveThe process of removing a node from the Z- Wave network.
ReplicationCopyThe process of copying network information from one controller to another.

D.10 Devices from multiple manufacturers in one network

This product can be operated in any Z-Wave network with other Z-Wave certified devices from other manufacturers. All non-battery-operated nodes within the network will act as repeaters regardless of vendor to increase reliability of the network.

D.11 Documentation for Association CC

The association group available in our product is described as follows.

Group IDMaximum NodesDescription
11Z-Wave PlusTM Lifeline

D.12 Documentation related to BASIC commands

The Basic Command Class mapping is listed below. Basic set and basic get commands are described separately.

Basic Set Command MappingParameterValue
KEX SetSelected KEX Scheme02
Selected ECDH Profile01
Granted KeysUnauthenticated01
Authenticated02
Access04
S080
Association SetGrouping Identifier01
Node ID1
Basic Get Command MappingParameterValue
Z-Wave+ Info GetNoneNone
KEX GetNoneNone
S2 Network Key GetRequested KeyUnauthenticated00
Authenticated01
Access02
S007
S2 Commands Supported GetNoneNone
S2 Nounce GetSequence NumberRandom
Security Nounce GetNoneNone
Security Commands Supported GetNoneNone
DSK GetSeq No00
Add Modefalse
PowerLevel GetNoneNone
PowerLevel Test Node GetNoneNone
Manufacturer Specific GetNoneNone
Version Command Class GetNoneNone
Version GetNoneNone
Version Capabilities GetNoneNone
Version Z-Wave Software GetNoneNone
Association GetGrouping Identifier01
Association Groupings GetNoneNone
Association Specific Group GetNoneNone
Association Group Name GetGrouping Identifier01
Association Group Info GetList Modetrue
Refresh Cachefalse
Grouping Identifier01
Association Group Command List GetAllow Cachetrue
Grouping Identifier01
Device Specific GetNoneNone

D.13 Documentation related to BASIC commands

The following basic commands are used for our product to control some devices.

ObjectControl CommandValueBehavior of device
Door Lock (Entry Control Keypad)Basic Set0xFFignore any received basic commands
0x00
On/Off SwitchSwitch Binary Set0xFFTurn on
0x00Turn off
Power StripSwitch Binary Set0xFFTurn on
0x00Turn off
Switch Multilevel Set0xFFTurn on
0x00Turn off
Fan SwitchSwitch Multilevel Set0xFFTurn on
0x00Turn off
Light Dimmer SwitchSwitch Multilevel Set0xFFTurn on
0x00Turn off
Thermostat, HVACThermostat Mode Set0xFFComfort Mode
0x00Energy Save Mode

D.14 Documentation for Factory Default Reset

  1. Prepare two mains powered Z-Wave DUTs and navigate to system UI as below, clickZ Wave CloudAPI Inclusion or Exclusion - ICON 4 buttonZ Wave CloudAPI Inclusion or Exclusion - system UIClick “Setting”Z Wave CloudAPI Inclusion or Exclusion - Setting

D.19 Documentation for S2 Security CC

Command ClassVersionRequired Security Class
Z-Wave Plus Info2None
Transport Service2None
CRC-16 Encapsulation1None
Application Status1None
Security 21None
Security 01None
Inclusion Controller1None
Supervision1None
Multi Command1None
Network Management inclusion3Access Control
Network management basic2Access Control
Network Management Proxy2Access Control
Association Group Information3Access Control
Device Reset Locally1Access Control
Network Management Installation Maintenance2Access Control
Manufacturer Specific2Access Control
Powerlevel1Access Control
Node Provisioning1Access Control
Firmware Update Meta Data5Access Control
Association2Access Control
Version3Access Control
Basic2Access Control

D.21

D.21.1
Documentation about how to activate any functionality available in the device related to Z-Wave behavior is listed below.
Z Wave CloudAPI Inclusion or Exclusion - ICON 5 DRAFT COPY – R800-27957A_PROA7
Z Wave CloudAPI Inclusion or Exclusion - ICON 5 DRAFT COPY – R800-27956A_PROA7-

D.21.2
None

D.21.3
About how to send any controlled command from the controller PC controller tool is preferred.

  1. Double click to select the controlled device, you will see the device is in greyed colorZ Wave CloudAPI Inclusion or Exclusion - controlled device
  2. Double click one command of command classes or secure command classes to choose such as associationZ Wave CloudAPI Inclusion or Exclusion - command classes
  3. Choose command in command list and then click send buttonZ Wave CloudAPI Inclusion or Exclusion - command listZ Wave logo

Documents / Resouces

Download manual
Here you can download full pdf version of manual, it may contain additional safety instructions, warranty information, FCC rules, etc.


Related Manuals