Instruction
Z-Ware Web User Guide for SDK v1.11
Document No.:
INS14072
Version:
5
Description:
Z-Ware Web Server is a secure Z-Wave Web Gateway functioning as a single local
or multiple secure remote Z/IP clients. It comes with sample consumer Z-Ware
Apps as web pages for PC/Tablet and Phone, as well as an Engineering version
Written By:
SAMBAT;BBR
Date:
2018-03-08
Reviewed By:
NTJ
Restrictions:
Public
Approved by:
Date CET Initials Name Justification
2018-03-08 13:15:47 NTJ Niels Thybo Johansen
This document is the property of Silicon Labs. The data contained herein, in whole
or in part, may not be duplicated, used or disclosed outside the recipient for any
purpose. This restriction does not limit the recipient's right to use information
contained in the data if it is obtained from another source without restriction.
INS14072-5 Z-Ware Web User Guide for SDK v1.11 2018-03-08
silabs.com | Building a more connected world.
Page ii of vi
REVISION RECORD
Doc. Ver.
Date
By
Pages
affected
Brief description of changes
1
20170901
SNA
ALL
SDK v1.10: Cloned for new UI and SmartStart
2
20171108
SNA
8,32,31,33
Added native UI download & display information; updated About pages
3
20171212
SNA
3,26,30,
32,42,47,50
SDK v1.11: CC updates, iPhone native scanning for Add Node & Smart Start,
Eng UI – SmartStart, Basic, Thermostat State, Configuration
4
20180116
SNA
8,32,
3,
31,33,44,46,
26
Added Android & iPad Native Apps support; removed WebRenderer,
Corrected Controlled CCs for Config CC to v2, Corrected 2.8x NIF for Security CC,
Updated Tab UI About; Eng UI About, Binary Switch & Doorlock Pages
Added note on unpredictable effects of Abort during Add Node
,
INS14072-5 Z-Ware Web User Guide for SDK v1.11 2018-03-08
silabs.com | Building a more connected world.
Page iii of vi
Table of Contents
1 INTRODUCTION ................................................................................................................................... 1
1.1 Purpose .............................................................................................................................................. 1
1.2 Audience and prerequisites ................................................................................................................ 1
2 OVERVIEW ........................................................................................................................................... 2
2.1 Z-Ware Library.................................................................................................................................... 2
2.1.1 Role .......................................................................................................................................... 2
2.1.2 Network Operations ................................................................................................................. 2
2.1.3 Device Control .......................................................................................................................... 3
2.1.4 Command Class Support ......................................................................................................... 3
2.1.5 Network Initialization ................................................................................................................ 5
2.1.6 Node Update ............................................................................................................................ 6
2.1.7 Network Update ....................................................................................................................... 7
2.1.8 Background Polling .................................................................................................................. 7
2.1.9 Post-Set Polling ........................................................................................................................ 7
2.1.10 Command Class Configuration ................................................................................................ 7
2.2 Scenes ................................................................................................................................................ 8
2.3 Bundled Z-Ware Apps ........................................................................................................................ 8
3 ACCESS ................................................................................................................................................ 9
3.1 Login ................................................................................................................................................... 9
3.1.1 CE ............................................................................................................................................ 9
3.1.2 Portal ........................................................................................................................................ 9
3.1.2.1 Registration ...................................................................................................................... 9
3.1.2.2 Reset password ..............................................................................................................10
4 TABLET/PC AND PHONE UI .............................................................................................................12
4.1 Scenes ..............................................................................................................................................12
4.1.1 Scene Summary .....................................................................................................................14
4.1.2 Scene Action ..........................................................................................................................15
4.1.3 Scene Schedule .....................................................................................................................16
4.1.4 Scene Trigger .........................................................................................................................16
4.1.5 Security Scene Summary .......................................................................................................17
4.1.6 Security Scene Arming ...........................................................................................................17
4.1.7 Security Scene Disarming ......................................................................................................18
4.1.8 Security Scene Alarm .............................................................................................................18
4.1.9 Security Scene Alarm Popup .................................................................................................19
4.2 Devices .............................................................................................................................................20
4.2.1 Binary Sensor Device .............................................................................................................21
4.2.2 Alarm/Notification Device .......................................................................................................21
4.2.3 Meter Device ..........................................................................................................................22
4.2.4 Multilevel Sensor Device ........................................................................................................22
4.2.5 Binary Switch Device .............................................................................................................22
4.2.6 Dimmer Device .......................................................................................................................22
4.2.7 Shades Device .......................................................................................................................23
4.2.8 Door Lock Device ...................................................................................................................23
4.2.9 Central Scene Controller ........................................................................................................24
4.2.10 Thermostat Device .................................................................................................................25
4.2.11 Barrier Operator Device .........................................................................................................25
4.3 More .................................................................................................................................................25
4.3.1 Maintenance ...........................................................................................................................26
4.3.1.1 Add/Remove Devices (Optionally On Behalf) ................................................................26
4.3.1.2 Reset Network ................................................................................................................28
4.3.1.3 Update Network ..............................................................................................................28
INS14072-5 Z-Ware Web User Guide for SDK v1.11 2018-03-08
silabs.com | Building a more connected world.
Page iv of vi
4.3.1.4 Set Learn Mode ..............................................................................................................28
4.3.1.5 Broadcast NIF.................................................................................................................29
4.3.1.6 Remove/Replace Failed Devices (Optionally On Behalf) ..............................................29
4.3.1.7 Update Device ................................................................................................................29
4.3.1.8 Send NIF ........................................................................................................................30
4.3.2 SmartStart ..............................................................................................................................30
4.3.2.1 Add Device .....................................................................................................................30
4.3.2.2 Edit Device .....................................................................................................................31
4.3.2.3 Z-Wave Reset Requirement Detection ..........................................................................31
4.3.3 About ......................................................................................................................................31
4.4 Native UI ...........................................................................................................................................32
5 ENGINEERING UI ...............................................................................................................................33
5.1 Home ................................................................................................................................................33
5.2 About ................................................................................................................................................33
5.3 Network Manager .............................................................................................................................34
5.3.1 Security 2 Operations .............................................................................................................35
5.3.2 Network Health Check ...........................................................................................................37
5.4 SmartStart ........................................................................................................................................37
5.5 Controller ..........................................................................................................................................40
5.6 Interfaces ..........................................................................................................................................42
5.6.1 Basic .......................................................................................................................................42
5.6.2 Binary Sensor .........................................................................................................................42
5.6.3 Multi-Level Sensor .................................................................................................................43
5.6.4 Alarm/Notification ...................................................................................................................43
5.6.5 Meter ......................................................................................................................................44
5.6.6 Battery ....................................................................................................................................44
5.6.7 Binary Switch .........................................................................................................................44
5.6.8 Multi-level Switch ...................................................................................................................44
5.6.9 Color Switch Interface ............................................................................................................45
5.6.10 Central Scene Controller ........................................................................................................45
5.6.11 Door Lock ...............................................................................................................................46
5.6.12 User Code ..............................................................................................................................46
5.6.13 Barrier Operator Interface ......................................................................................................47
5.6.14 Thermostat related interfaces ................................................................................................47
5.6.14.1 Thermostat Fan ..............................................................................................................47
5.6.14.2 Thermostat Mode And Operating State .........................................................................47
5.6.14.3 Thermostat SetPoint .......................................................................................................48
5.6.15 Naming/Location ....................................................................................................................48
5.6.16 Association .............................................................................................................................49
5.6.17 Configuration ..........................................................................................................................50
5.6.18 Wake up .................................................................................................................................51
5.6.19 Command Queuing ................................................................................................................51
5.6.20 Firmware Update ....................................................................................................................52
5.6.21 Z/IP Gateway .........................................................................................................................52
5.7 Scenes ..............................................................................................................................................55
5.8 Security Scenes................................................................................................................................57
REFERENCES ...........................................................................................................................................60
Table of Tables
Table 1: ZIPGW Versions vs Features as used by Z-Ware ........................................................................ 2
Table 2: UI Controlled Z-Wave CCs ............................................................................................................ 3
INS14072-5 Z-Ware Web User Guide for SDK v1.11 2018-03-08
silabs.com | Building a more connected world.
Page v of vi
Table 3: Controlled Z-Wave CCs inherited through Library ........................................................................ 3
Table 4: ZIPGW SDK 2.8x Supported Z-Wave CCs ................................................................................... 4
Table 5: ZIPGW SDK 2.1x Supported Z-Wave CCs ................................................................................... 4
Table 6: ZIPGW SDK 2.0x Supported Z-Wave CCs ................................................................................... 4
Table 7: Node Update get/set CCs .............................................................................................................. 6
Table 8: Node Update endpoint get/set CCs ............................................................................................... 6
Table 9: Bundled Z-Ware Apps and URIs ................................................................................................... 8
Table 10: Z-Wave Network Buttons mapping ............................................................................................ 35
Table of Figures
Figure 1: Z-Ware CE running within a home on RPi3 ................................................................................. 1
Figure 2: Z-Ware Portal in the Cloud connected to multiple homes ............................................................ 1
Figure 3: Login page .................................................................................................................................... 9
Figure 4: Portal Registration Page ............................................................................................................ 10
Figure 5: Portal Reset Password Page ..................................................................................................... 11
Figure 6: Tab UI - Scenes ......................................................................................................................... 12
Figure 7: Tab UI - Scenes Edit .................................................................................................................. 13
Figure 8: Tab UI - Scenes Toggle ............................................................................................................. 14
Figure 9: Tab UI: Scene View Summary ................................................................................................... 15
Figure 10: Tab UI - Scene View Action ..................................................................................................... 16
Figure 11: Tab UI - Scene Schedule ......................................................................................................... 16
Figure 12: Tab UI - Scene Trigger ............................................................................................................. 17
Figure 13: Tab UI - Security Scene Summary ........................................................................................... 17
Figure 14: Tab UI - Security Scene Arm.................................................................................................... 18
Figure 15: Tab UI - Security Scene Disarm ............................................................................................... 18
Figure 16: Tab UI - Security Scene Alarm ................................................................................................. 19
Figure 17: Tab UI - Security Scene Alarm Popup ..................................................................................... 19
Figure 18: Tab UI - Devices ....................................................................................................................... 20
Figure 19: Tab UI - Show Details .............................................................................................................. 21
Figure 20: Tab UI - Binary Sensor ............................................................................................................. 21
Figure 21: Tab UI – Alarm/Notification Interface Type/Event .................................................................... 22
Figure 22: Tab UI - Meter Interface ........................................................................................................... 22
Figure 23: Tab UI - Multilevel Sensor Interface ......................................................................................... 22
Figure 24: Tab UI - Binary Switch Device.................................................................................................. 22
Figure 25: Tab UI - Dimmer (Multilevel Switch Non-Motor) Device .......................................................... 23
Figure 26: Tab UI - Shades (Multilevel Switch Motor) Device ................................................................... 23
Figure 27: Tab UI - Door Lock Device ....................................................................................................... 24
Figure 28: Tab UI - Central Scene Controller Device ................................................................................ 24
Figure 29: Tab UI - Thermostat Device ..................................................................................................... 25
Figure 30: Tab UI - Barrier Operator Device ............................................................................................. 25
Figure 31: Tab UI – Maintenance (Network) ............................................................................................. 26
Figure 32: Tab UI - Add New Device: Initiate ............................................................................................ 26
Figure 33: Tab UI - Add New Device: Grant Keys ..................................................................................... 27
Figure 34: Tab UI - Add New Device: DSK ............................................................................................... 27
Figure 35: Tab UI - Add New Device: CSA DSK info ................................................................................ 27
Figure 36: Tab UI – Set Learn Mode ......................................................................................................... 28
Figure 37: Tab UI - Replace Failed Device ............................................................................................... 29
Figure 38: Tab UI – SmartStart ................................................................................................................. 30
Figure 39: Tab UI - SmartStart Add Device ............................................................................................... 30
Figure 40: Tab UI - SmartStart Edit Device ............................................................................................... 31
Figure 41: Tab UI - SmartStart Z-Wave Reset Requirement Detection .................................................... 31
Figure 42: Tab UI - About .......................................................................................................................... 31
Figure 43: Eng UI - Home Page ................................................................................................................ 33
INS14072-5 Z-Ware Web User Guide for SDK v1.11 2018-03-08
silabs.com | Building a more connected world.
Page vi of vi
Figure 44: Eng UI - About Page ................................................................................................................ 33
Figure 45: Eng UI - Network Manager Page ............................................................................................. 34
Figure 46: Eng UI - Network operation progress UI .................................................................................. 35
Figure 47: Eng UI - S2 Accepting Security Keys ....................................................................................... 36
Figure 48: Eng UI - S2 Entering DSK ........................................................................................................ 36
Figure 49: Eng UI - S2 CSA ...................................................................................................................... 37
Figure 50: Eng UI – Network Health Check .............................................................................................. 37
Figure 51: Eng UI - SmartStart List ........................................................................................................... 38
Figure 52: Eng UI - SmartStart Add/Edit Device ....................................................................................... 39
Figure 53: Eng UI – SmartStart Z-Wave Reset Required Detection ......................................................... 40
Figure 54: Eng UI - Node Controller Page ................................................................................................ 41
Figure 55: Eng UI - Node Version/Info UI .................................................................................................. 41
Figure 56: Eng UI - Endpoint Z-Wave+ Info UI.......................................................................................... 42
Figure 57: Eng UI - Basic Interface UI ....................................................................................................... 42
Figure 58: Eng UI - Binary Sensor Interface UI ......................................................................................... 42
Figure 59: Eng UI - Multilevel Sensor Interface UI .................................................................................... 43
Figure 60: Eng UI – Alarm/Notification Interface UI .................................................................................. 43
Figure 61: Eng UI - Meter Interface UI ...................................................................................................... 44
Figure 62: Eng UI - Battery Interface UI .................................................................................................... 44
Figure 63: Eng UI - Binary Switch Interface UI .......................................................................................... 44
Figure 64: Eng UI - Multilevel Switch Interface UI ..................................................................................... 45
Figure 65: Eng UI - Color Switch Interface ................................................................................................ 45
Figure 66:: Eng UI - Central Scene Controller Interface UI ....................................................................... 45
Figure 67: Eng UI - Door Lock Interface UI ............................................................................................... 46
Figure 68: Eng UI - User Code Interface UI .............................................................................................. 46
Figure 69: Eng UI - Barrier Operator Interface UI ..................................................................................... 47
Figure 70: Eng UI - Thermostat Fan Interface UI ...................................................................................... 47
Figure 71: Eng UI - Thermostat Mode And State Interface UI .................................................................. 48
Figure 72: Eng UI - Thermostat Setpoint Interface UI ............................................................................... 48
Figure 73: Eng UI - Name/Location Interface UI ....................................................................................... 49
Figure 74: Eng UI - Group Interface UI...................................................................................................... 49
Figure 75: Eng UI - Group with AGI Interface UI ....................................................................................... 50
Figure 76: Eng UI - Configuration Interface UI .......................................................................................... 51
Figure 77: Eng UI - Wakeup Interface UI .................................................................................................. 51
Figure 78: Command Queuing Interface UI .............................................................................................. 52
Figure 79: Eng UI - Firmware Update Interface UI .................................................................................... 52
Figure 80: Eng UI – ZIPGW Interface Portal Mode UI .............................................................................. 53
Figure 81: Eng UI - ZIPGW Interface Standalone Mode UI ...................................................................... 54
Figure 82: Eng UI - Scenes Page .............................................................................................................. 55
Figure 83: Eng UI - Scene Edit UI ............................................................................................................. 56
Figure 84: Eng UI - Security Scenes Page ................................................................................................ 57
Figure 85: Eng UI - Security Scene Edit UI ............................................................................................... 58
Figure 86: Eng UI - Security Scene Notification Edit UI ............................................................................ 59
INS14072-5 Z-Ware Web User Guide for SDK v1.11 2018-03-08
silabs.com | Building a more connected world.
Page 1 of 61
1 INTRODUCTION
1.1 Purpose
Z-Ware is a Z-Wave controller middleware running over a Z-Wave over IP (Z/IP) Gateway (ZIPGW) as a
Web Gateway. Z-Ware Apps (Z-Apps) are web pages built into the Z-Ware Web Server providing UI for
phones and tablets/PCs. Z-Ware can be run in either Consumer Electronic (CE) on BBB (BeagleBone
Black – see https://beagleboard.org/black) or RPi3 (Raspberry Pi 3 – see
https://www.raspberrypi.org/products/raspberry-pi-3-model-b/) platforms in the home or Portal mode on a
Linux Virtual Machine (VM) in the Cloud as shown below.
Figure 1: Z-Ware CE running within a home on RPi3
Figure 2: Z-Ware Portal in the Cloud connected to multiple homes
This document covers the usage of Z-Ware Web Server and Apps for both CE and Portal and will
explicitly state if instructions are for any particular mode.
The diagrams shown in this guide are for Windows with Internet Explorer 8 unless otherwise specified.
Your experience may vary slightly depending on your platform configuration.
1.2 Audience and prerequisites
Z-Wave Web users
Z-Wave
Device
iPad/iPhone
Android Phone/Tab
RPi3
Z-Ware Web Server
Z-Ware Library
ZIPGW
Z-Ware Native Apps
Z-Wave
Device
PC Web Browser
Z-Ware Web Apps
RPi3
Z-Wave
Device
iPad/iPhone
Android Phone/Tab
Cloud Linux VM
Z-Ware Web Server
Z-Ware Library
ZIPGW
Z-Ware Native Apps
Z-Wave
Device
PC Web Browser
Internet
Z-Ware Apps
INS14072-5 Z-Ware Web User Guide for SDK v1.11 2018-03-08
silabs.com | Building a more connected world.
Page 2 of 61
2 OVERVIEW
2.1 Z-Ware Library
The Z-Ware Library, which abstracts the ZIPGW, provides Z-Wave Command Class (CC) level APIs,
discovery of device capability and state, is statically linked into the Z-Ware web server. It provides the
following features.
2.1.1 Role
Z-Ware is a Z-Wave Plus Security Enabled device in the Static PC Controller class, that is mainly used in
the role of a Static Update Controller (SUC) Identity Server (SIS), and the Z-Wave Plus role of a Central
Static Controller.
2.1.2 Network Operations
As a Z/IP client, it works in conjunction with a ZIPGW. Z-Ware sets itself as the (first) unsolicited IP
address of the ZIPGW that it is connected with. Z-Ware works with the different versions of ZIPGWs
using the following features:
Table 1: ZIPGW Versions vs Features as used by Z-Ware
ZIPGW SDK
Mailbox
Security
N/W Health
Smart Start
2.0x
Unused; Uses Wakeup CC directly
S0
N.A.
N.A.
2.1x
Used
S0, S2
N.A.
N.A.
2.8x
Used
S0, S2
Used
Used
Similarly ZIPGW works with different versions of Z-Wave Protocols and certain features may not be
available on older versions. SmartStart is only available with Z-Wave Protocol SDK 6.8x onwards.
Z-Ware supports Inclusion, Exclusion, Reset (Set Default), Replace/Remove Failed Node, and Send
Node NIF (Node Information Frame). If it is assigned a primary controller role, it will always upgrade
itself to an SIS unless there is an SUC already present. Hence it cannot initiate controller shift as a
primary.
Z-Ware supports Set Learn mode but this can only be performed when Z-Ware is not already in a
network and will typically make Z-Ware an Inclusion or Secondary Controller, in which case, some of its
facilities will not be available. Controller replication (Copy) is achieved through Inclusion and Set Learn
Mode.
Additionally it also supports Node and Network Update. Z-Ware discovers a Z-Wave node’s capabilities
during inclusion through a series of comprehensive queries. This process may take some time,
especially for a secure Frequently Listening Routing Slave (FLIRs) device. This operation may be
aborted at any time. Node Update re-queries the information that was obtained during inclusion. This
allows discovering any changes that were not made through this Z-Ware. Network Update requests
topology from an SUC if available, and then performs neighbor update if available or node update to
every node it is aware of.
Z-Ware supports SmartStart which uses a configurable provisioning list of devices to allow Z-Wave
network wide inclusion without having to manually configure a new node into Z-Wave learn mode. The
availability of this feature is dependent on the underlying ZIPGW and protocol.
INS14072-5 Z-Ware Web User Guide for SDK v1.11 2018-03-08
silabs.com | Building a more connected world.
Page 3 of 61
2.1.3 Device Control
Z-Ware 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.
Z-Ware is able to control/monitor Z-Wave-certified device of different categories from various vendors
through their CCs. CCs that are automatically handled are not exposed to the user. Z-Ware controls the
following CCs and versions:
Table 2: UI Controlled Z-Wave CCs
CC
Ver
CC
Ver
ASSOCIATION
2
NOTIFICATION/ALARM
8
ASSOCIATION_GRP_INFO
3
SECURITY
1
BARRIER_OPERATOR
1
SECURITY 2*
1
BASIC
2
SENSOR_BINARY
2
BATTERY
1
SENSOR_MULTILEVEL
11
CENTRAL_SCENE
3
SWITCH_BINARY
2
CONFIGURATION
2
SWITCH_COLOR
3
DOOR_LOCK
3
SWITCH_MULTILEVEL
4
FIRMWARE_UPDATE_MD
5
THERMOSTAT_FAN_MODE
4
MANUFACTURER_SPECIFIC
2
THERMOSTAT_FAN_STATE
2
METER
3
THERMOSTAT_MODE
3
MULTI_CHANNEL
4
THERMOSTAT_OPERATING_STATE
2
MULTI_CHANNEL_ASSOCIATION
3
THERMOSTAT_SETPOINT
3
NW_MGMT_BASIC
2
USER_CODE
1
NW_MGMT_INCLUSION
3
VERSION
2
NW_MGMT_INSTALLATION_MAINTENANCE*
1
WAKE_UP
2
NW_MGMT_PROXY
2
ZIP_GATEWAY
1
NODE_NAMING
1
ZIP_PORTAL
1
NODE_PROVISIONING*
1
ZWAVEPLUS_INFO
2
* Security 2, Network Management Installation Maintenance and Node Provisioning CCs only controlled
if the underlying ZIPGW supports them.
Table 3: Controlled Z-Wave CCs inherited through Library
CC
Ver
CC
Ver
ALARM SENSOR
1
NO_OPERATION
1
APPLICATION_STATUS
1
POWERLEVEL
1
CRC_16_ENCAP
1
SUPERVISION
1
DEVICE_RESET_LOCALLY
1
ZIP
3
MULTI_CMD
1
ZIP_ND
1
2.1.4 Command Class Support
Z-Ware does nothing on receiving Basic CC Set or Get, unless Basic Set from any particular
node/endpoint is used as a Scene trigger. Z-Ware supports only 1 Association group supporting 1 node
for Lifeline. This node will receive the Device Reset Locally command.
For easier reference during certification the associated ZIPGW supported CCs are tabularized below.
INS14072-5 Z-Ware Web User Guide for SDK v1.11 2018-03-08
silabs.com | Building a more connected world.
Page 4 of 61
Table 4: ZIPGW SDK 2.8x Supported Z-Wave CCs
CC
Ver
Not
added
Non-secure
added
Securely added
Non-Secure
Secure
APPLICATION_CAPABILITY
1
X
X
X
APPLICATION_STATUS
1
X
X
X
ASSOCIATION *
2
X
X
X
ASSOCIATION_GRP_INFO *
3
X
X
X
CRC_16_ENCAP
1
X
X
X
DEVICE_RESET_LOCALLY *
1
X
X
X
FIRMWARE_UPDATE_MD
5
X
INCLUSION_CONTROLLER **
1
X
X
X
MANUFACTURER_SPECIFIC
2
X
X
X
MULTI_CMD *
1
X
X
X
NODE PROVISIONING ***
1
X
NW_MGMT_BASIC
2
X
NW_MGMT_INCLUSION **
3
X
NW_MGMT_INSTALLATION_MAINTENANCE
1
X
NW_MGMT_PROXY
2
X
POWERLEVEL
1
X
X
X
SECURITY
1
X
X
SECURITY_2
1
X
X
X
SUPERVISION
1
X
X
X
TRANSPORT_SERVICE
2
X
X
X
VERSION
2
X
X
X
ZWAVEPLUS_INFO
2
X
X
X
Table 5: ZIPGW SDK 2.1x Supported Z-Wave CCs
CC
Ver
Not
added
Non-secure
added
Securely added
Non-Secure
Secure
APPLICATION_STATUS
1
X
X
X
ASSOCIATION *
2
X
X
X
ASSOCIATION_GRP_INFO *
3
X
X
X
CRC_16_ENCAP
1
X
X
X
DEVICE_RESET_LOCALLY *
1
X
X
X
FIRMWARE_UPDATE_MD
5
X
INCLUSION_CONTROLLER **
1
X
X
X
MANUFACTURER_SPECIFIC
2
X
X
MULTI_CMD *
1
X
X
X
NW_MGMT_BASIC
2
X
NW_MGMT_INCLUSION **
2
X
NW_MGMT_INSTALLATION_MAINTENANCE
1
X
NW_MGMT_PROXY
2
X
POWERLEVEL
1
X
X
SECURITY
1
X
X
SECURITY_2
1
X
X
X
SUPERVISION
1
X
X
X
TRANSPORT_SERVICE
2
X
X
X
VERSION
2
X
X
ZWAVEPLUS_INFO
2
X
X
X
Table 6: ZIPGW SDK 2.0x Supported Z-Wave CCs
CC
Ver
Not
Non Secure
Securely Added
INS14072-5 Z-Ware Web User Guide for SDK v1.11 2018-03-08
silabs.com | Building a more connected world.
Page 5 of 61
Added
Added
Non Secure
Secure
SECURITY
1
X
X
X
TRANSPORT SERVICE
2
X
X
X
CRC16
1
X
X
X
MULTI CMD *
1
X
X
X
NW MGMT BASIC
2
X
NW MGMT INCLUSION **
2
X
NW MGMT PROXY
2
X
NW MGMT INSTALLATION MAINTENANCE
1
X
DEVICE RESET LOCALLY *
1
X
X
X
ZIP
3
X
ZIP PORTAL
1
X
ZIP GATEWAY
1
X
ZIP NAMING
1
X
FIRMWARE UPDATE MD
5
X
MAILBOX
1
X
POWER LEVEL
1
X
APPLICATION STATUS
1
X
X
X
ZWAVEPLUS INFO
2
X
X
X
MANUFACTURER SPECIFIC
2
X
VERSION
2
X
ASSOCIATION *
2
X
X
X
ASSOCIATION GRP INFO *
3
X
X
X
* ASSOCIATION, ASSOCIATION_GRP_INFO, MULTI_CMD and DEVICE_RESET_LOCALLY CCs are
added by Z-Ware to the ZIPGW NIF
** INCLUSION_CONTROLLER and NW_MGMT_INCLUSION CCs are only present if the ZIPGW is an
inclusion controller.
*** NODE_PROVISIONING is only available in an S2 enabled network.
2.1.5 Network Initialization
The following steps are carried out during network initialization:
1. Get ZIPGW’s Z-Wave Home ID, Node ID and Home Area Network (HAN) IP address.
2. Get ZIPGW attached controller’s cached node information.
3. Get CC versions present in the ZIPGW cached node information to create corresponding Z-Ware
interfaces.
4. Get ZIPGW’s hardware and firmware versions if VERSION CC is v2 or higher.
5. Get ZIPGW’s manufacturer, product type and product id if MANUFACTURER_SPECIFIC CC
presents.
6. Get node list of the HAN.
7. Turn on mailbox for ZIPGW SDK v2.1x and above. This will enable multi-client support and receive
wake up notification from device through mailbox ACK message.
8. Get ZIPGW dynamic DSK key for adding new node.
9. Set supported CCs in the ZIPGW attached controller’s NIF
10. For Portal version, set unsolicited destination address. For CE version, get unsolicited destination
address and if its IPv6 address is all zeroes, set it to the Z/IP client IPv6 address.
11. Resolve all the nodes in node list into corresponding HAN IPv6 addresses.
12. Perform Node Update (see 2.1.6 Node Update) through HAN network for nodes that are not loaded
with detailed node information from persistent storage.
INS14072-5 Z-Ware Web User Guide for SDK v1.11 2018-03-08
silabs.com | Building a more connected world.
Page 6 of 61
2.1.6 Node Update
The following steps are carried out to acquire detailed node information based on the CCs present at
node and endpoint levels:
1. Get cached node information of the node of interest from the ZIPGW.
2. Assign the ZIPGW attached controller’s Z-Wave Return Route to the node.
3. Get CC versions of each CC listed in the node information.
4. Get library, protocol and application versions.
5. Get node’s hardware and firmware versions if Version CC is v2 or higher.
6. Get MANUFACTURER_SPECIFIC CC Manufacturer ID, Product Type and Product ID. Based on
these, get device category from the device setting database. Get Device Serial Number if supported.
7. If the node has just been added into the network, set the WAKEUP CC notification receiving Node ID
to SIS with/without changing the wakeup interval. The wakeup interval will be changed if global
setting for wakeup interval is non-zero in device database.
8. For each endpoint in the node :-
a) Get security supported CCs at the endpoint if the node is included securely
b) Get version of CCs at the endpoint
c) If the node has just been added into the network, set device specific configuration parameters
based on Device Database
d) Get ASSOCIATION CC’s maximum supported group. If the node has just been added into the
network, and group 1 is “Lifeline”, set SIS node id into group 1
e) Get Central Scene CC number of supported scenes. . If the node has just been added into the
network, and Central Scene CC version is 3 and greater, then set it to slow refresh.
f) Get Z-Wave Plus Information
g) Get Multilevel Sensor CC supported types, units and current value
h) Get ASSOCIATION GROUP INFORMATION CC details
i) Get Thermostat Fan Operating Mode CC supported modes, Thermostat Mode CC supported and
current mode, Thermostat Setpoint CC supported and current type and also temperature range,
Thermostat Operating State CC current state
j) Get Multilevel Switch CC supported types and current value
k) Get Simple AV CC supported controls
l) Get Alarm/Notification CC supported types and events
m) Get Protection CC supported states
n) Get User Code CC maximum supported codes
o) Get Meter CC capabilities and descriptor
p) Get Binary Sensor CC supported types and current value
q) Get Door Lock CC current state
r) Get Alarm Sensor CC supported types and current value
s) Get Barrier Operator CC current state
t) Get Color Switch CC supported components and current values
u) Get Binary Switch CC current state
v) Get Battery CC current level
w) Get Node Naming CC current name and location
Table 7: Node Update Get/Set CCs
CC
CC
MANUFACTURER_SPECIFIC
VERSION
WAKE_UP
Table 8: Node Update Endpoint Get/Set CCs
CC
CC
ASSOCIATION
SENSOR_BINARY
ASSOCIATION_GRP_INFO
SENSOR_MULTILEVEL
BARRIER_OPERATOR
SIMPLE_AV_CONTROL
INS14072-5 Z-Ware Web User Guide for SDK v1.11 2018-03-08
silabs.com | Building a more connected world.
Page 7 of 61
BATTERY
SWITCH_BINARY
CENTRAL_SCENE
SWITCH_COLOR
CLOCK
SWITCH_MULTILEVEL
CONFIGURATION
THERMOSTAT_FAN_MODE
DOOR_LOCK
THERMOSTAT_FAN_STATE
METER
THERMOSTAT_MODE
METER_TBL_MONITOR
THERMOSTAT_OPERATING_STATE
MULTI_CHANNEL_ASSOCIATION
THERMOSTAT_SETPOINT
NODE_NAMING
USER_CODE
NOTIFICATION/ALARM
VERSION
PROTECTION
2.1.7 Network Update
The following steps are carried out to update the network:
1. Repeat steps 1 to 4 of Section 2.1.5 Network Initialization.
2. Request network update by using the command
COMMAND_CLASS_NETWORK_MANAGEMENT_BASIC -> NETWORK_UPDATE_REQUEST
3. Get node list of the HAN.
4. Resolve all the nodes in node list into corresponding HAN IPv6 addresses.
5. Request node neighbor update for each of the node in the node list. Repeat for up to 3 iterations
if the request node neighbor update failed for some nodes that may be out-of-range.
6. Perform Node Update for each node in network (See 2.1.6 Node Update).
2.1.8 Background Polling
Z-Ware Library performs automatic background polling to cache device supported interface details (e.g.
supported sensor types and units) and device values (e.g. sensor readings for each supported type). For
always-on devices, polling is carried out for all relevant interfaces in a device followed by an interval of
10 seconds before the next device is polled. For FLIRS (Frequently Listening Routing Slave) devices,
polling is carried out only every 12 hours per device so as not to run the device’s batteries out. For
sleeping devices, polling is carried out whenever they wake up. As sleeping devices will go to sleep
mode when they don’t receive any Z-Wave messages, this type of polling has higher priority than the
other two types of polling. The polling sequence of CCs are the same as those listed for each endpoint
in Section 2.1.6 Node Update.
2.1.9 Post-Set Polling
Some devices take time to reach their target settings especially mechanical devices. Z-Ware Library
performs post-set polling for door lock, multi-level switch motor and barrier operator interfaces. For door
locks, the polling intervals are 1, 2, 3 seconds; whereas for multi-level switch, the intervals are 1, 2, 3, 4
seconds before timeout occurs. For Barrier Operator CC, the intervals are 1 to 7 seconds incrementally.
If the endpoint supports the Supervision CC, then polling is not performed and notification is expected
from the device on completion. This allows the client to be informed if/when the device has reached its
target state
2.1.10 Command Class Configuration
Some library clients may want to only implement control for selected CCs of those offered. However this
leads to Z-Wave certification form failures as the library performs background polling and information
caching for CCs not listed in the form. A CC configuration option file “cmd_class.cfg” list all CCs offered
allowing the client developer to comment out undesired CCs.
INS14072-5 Z-Ware Web User Guide for SDK v1.11 2018-03-08
silabs.com | Building a more connected world.
Page 8 of 61
2.2 Scenes
A Z-Ware Scene is a set of actions that may be activated by triggers. An action is a Z-Wave SET
command, for e.g., to turn on a switch. A trigger may be a user request through a UI element, by
schedule or on an event. A schedule can be set to execute a Scene on any or every day of the week at
a preset time. A schedule remains active till it is disabled or deleted. An event refers to the receipt of a
Z-Wave report, typically a sensor report e.g. motion sensed. The state of a scene, i.e. whether it is
completely activated, can also be monitored.
A Z-Ware Security Scene is a special Scene that can be armed or disarmed by a key fob or a door lock
event or through the UI. It can only be triggered when it is armed. When triggered, it can send out alerts
using email and/or SMS. Arming, disarming and triggering can also be configured to activate normal
scenes.
Supported actions are Basic, Binary Switch, Multilevel Switch, Door Lock, Thermostat Setpoint CC SET
commands. Supported events are Binary Sensor, Multilevel Sensor, Alarm/Notification, Door Lock CC
REPORT commands as well as a Basic SET command received from trigger sources.
2.3 Bundled Z-Ware Apps
Consumer-friendly UIs targeted for Tablet/PC and Phone are included, as well as an Engineering version
meant to demonstrate the server’s capabilities.
Table 9: Bundled Z-Ware Apps and URIs
UI
Base URI or location
Tablet/PC Web
/ui/pc/index.html
Phone Web
/ui/phone/index.html
Engineering Web
/ui/eng/index.html
iOS Native
https://itunes.apple.com/app/z-wave/id1296166426
Android Native
https://play.google.com/store/apps/details?id=com.sigmadesigns.zwareapp
On web login, the Tablet or Phone UI is automatically selected by the server based on the User Agent of
the web browser used.
Differences in the UIs are as follows:
Engineering UI exposes advanced Z-Wave interfaces related to the Association and
Configuration CCs.
Network Health functionality is only available on the Engineering UI.
Scanning of QR code is only available in the Native UIs.
Users can build their own apps over the Z-Ware Web API – see [1].
INS14072-5 Z-Ware Web User Guide for SDK v1.11 2018-03-08
silabs.com | Building a more connected world.
Page 9 of 61
3 ACCESS
3.1 Login
Figure 3: Login page
3.1.1 CE
CE users access their accounts on the machine they have installed at https://<machine IP address>.
The default username and password are ‘sigma’ and ‘sigmadesigns’ respectively. The page will be titled
“CE” instead of “Portal” and the links at the bottom will not be there.
3.1.2 Portal
Z-Ware Portal users access their accounts at https://z-ware.sigmadesigns.com . They can login and
create their account or reset the account password through the links at the bottom.
3.1.2.1 Registration
To create the Portal account, the user needs to fill in the registration details.
INS14072-5 Z-Ware Web User Guide for SDK v1.11 2018-03-08
silabs.com | Building a more connected world.
Page 10 of 61
Figure 4: Portal Registration Page
First and last names are alphabets only and between 3 to 25 characters in length. Username is of the
same length but can be alphanumeric, in addition supporting both ‘_’ (underscore) and ‘.’ (period) special
characters. Password must be between 8 to 16 characters in length.
The Gateway ID is the ZIPGW platform Ethernet MAC address which can be obtained as specified in the
ZIPGW documentation. The Gateway PIN is optional and only relevant to the ZIPR which comes labeled
with the PIN, and the RAC (Remote Access Code) should be used as Gateway ID. The time zone
setting allows the server to convert time information in accordance to the locality of the ZIPGW.
On registration, an email is sent to the registered email address which contains an unregister link in case
the user entered the wrong details and wishes to reregister and a link to download certificates to the
ZIPGW platform as specified in the ZIPGW documentation.
3.1.2.2 Reset password
The Portal account name needs to be specified to confirm resetting password. An email will be sent with
an unregister link, and the process will be the same as creating a new account.
INS14072-5 Z-Ware Web User Guide for SDK v1.11 2018-03-08
silabs.com | Building a more connected world.
Page 12 of 61
4 TABLET/PC AND PHONE UI
For the Tablet UI, the main menu appears on the left while for the Phone UI, it appears at the bottom.
There are not many other differences between the 2 UIs except layout. On the top right, for the Portal
version only, an icon shows the connection to the portal, blue when connected, grey otherwise. Users
can also log out on the top right of the Tablet UI.
4.1 Scenes
The scenes page allows monitoring, manual activation and editing of a list of scenes. For more
information on Scenes, see Section 2.2 Scenes.
Figure 6: Tab UI - Scenes
Normal scenes can be manually activated by the play icon. Security scenes can be armed or disarmed
with the bell or crossed bell icons respectively. Normal Scenes in active state and Security scenes in
armed state are shown in orange while others are in grey.
New scenes can be created with the ‘Scenes +’ and Security Scenes +’ links. Clicking on a scene will
enter the summary page.
have a clapper board icon and those that have configured schedule or event triggers have a clock
superimposed on the icon. Security Scenes have a bell superimposed on the icon. The turning wheel at
the top right indicates that the scenes are updating their status. Scene status is updated only when
Home or Scenes buttons are clicked, or when a scene is triggered. Clicking on a scene triggers it
manually, turning its tab blue and starting the status update. If for some reason, it is not activated, it
returns to its original color. As the same devices may be activated by multiple scenes, triggering 1 scene
INS14072-5 Z-Ware Web User Guide for SDK v1.11 2018-03-08
silabs.com | Building a more connected world.
Page 13 of 61
may affect the state of multiple scenes. The “Toggle View” button, only on the Tablet UI, can switch the
scenes arrangement to columns and rows, instead of just 1 column.
Figure 7: Tab UI - Scenes Edit
INS14072-5 Z-Ware Web User Guide for SDK v1.11 2018-03-08
silabs.com | Building a more connected world.
Page 14 of 61
Figure 8: Tab UI - Scenes Toggle
4.1.1 Scene Summary
When a preconfigured scene is viewed by clicking on it or a new scene created by clicking on the ‘+
SCENE’ button, the summary is shown which condenses the associated schedules, triggers and actions
into 1 page. For a new scene these will be empty and would need to be configured. The scene can be
deleted using the DELETE link and renamed in the Name text box. The tabs are for editing and viewing
details for Schedule, Trigger and Action.
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
/
