Silicon Labs Z-Ware Web User guide

Instruction

Z-Ware Web User Guide

Document No.:

INS12903

Version:

19

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-05

Reviewed By:

NTJ;TMORTENSEN

Restrictions:

Public

Approved by:

Date CET Initials Name Justification

2018-03-05 14:41:15 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.

INS12903-19 Z-Ware Web User Guide 2018-03-05

silabs.com | Building a more connected world.

Page ii of vi

REVISION RECORD

Doc. Ver.

Date

By

Pages

affected

Brief description of changes

8

20160830

SNA

ALL

Public version

9

20160922

SNA

ALL

Merged CE version; Updated for v0.42

10

20170106

20170113

SNA

1

18,21,33,35,

2,2,

Updated for v0.46. Added RPi3 as CE platform

Added Color Switch & Barrier Operator

Removed Portal mode ZIPGW mbox incompatibility clause, Updated CC control

Updated n/w init procedure, Corrected CC table

11

20170223

SNA

10

Update for v0.47 - ZIPR & ZIPGW registration difference

12

20170223

SNA

5,3

Update for v0.48 – removed basic probing in node update; CSC v3, Setpoint v3

13

20170301

SNA

2

Updated for certification with necessary text & support CC conditions

14

20170324

SNA

ALL

v0.50 update

15

20170406

SNA

3

Added ZIPGW supported CC table for certification

16

20170630

SNA

2,3,25,26,47

V0.53: Added ZIPGW 2.01.02 NIF, Updated CC versions, About, CC ref

17

20170717

SNA

3

Added ZIPGW 2.2x NIF & supported CC versions for all

18

20170830

SNA

3

Fixed ZIPGW 2.2x & 2.1x NIFs

19

20180305

BBR

All

Added Silicon Labs template

INS12903-19 Z-Ware Web User Guide 2018-03-05

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 .......................................................................................................................... 2

2.1.4 Command Class Support ......................................................................................................... 3

2.1.5 Network Initialization ................................................................................................................ 5

2.1.6 Node Update ............................................................................................................................ 5

2.1.7 Network Update ....................................................................................................................... 7

2.1.8 Background Polling .................................................................................................................. 7

2.1.9 Post-Set Polling ........................................................................................................................ 7

2.2 Scenes ................................................................................................................................................ 7

2.3 Bundled Z-Ware Apps ........................................................................................................................ 8

3 ACCESS ................................................................................................................................................ 9

3.1 Login ................................................................................................................................................... 9

3.1.1 Portal ........................................................................................................................................ 9

3.1.2 CE ............................................................................................................................................ 9

3.2 Registration (Portal Only) .................................................................................................................10

3.3 Reset password (Portal Only) ..........................................................................................................11

4 TABLET/PC & PHONE UI ..................................................................................................................12

4.1 Home ................................................................................................................................................12

4.2 Scenes ..............................................................................................................................................13

4.2.1 Create .....................................................................................................................................13

4.2.2 Edit/View ................................................................................................................................13

4.2.2.1 Normal Scene .................................................................................................................13

4.2.2.2 Security Scene ...............................................................................................................14

4.3 Devices .............................................................................................................................................16

4.3.1 Unknown Interface .................................................................................................................16

4.3.2 Binary Sensor Device .............................................................................................................16

4.3.3 Alarm/Notification Device .......................................................................................................17

4.3.4 Meter Device ..........................................................................................................................17

4.3.5 Multilevel Sensor Device ........................................................................................................17

4.3.6 Binary Switch Device .............................................................................................................18

4.3.7 Dimmer Device .......................................................................................................................18

4.3.8 Shades Device .......................................................................................................................18

4.3.9 Door Lock Device ...................................................................................................................19

4.3.10 Central Scene Controller ........................................................................................................19

4.3.11 Thermostat Device .................................................................................................................19

4.3.12 Barrier Operator Device .........................................................................................................21

4.4 More .................................................................................................................................................21

4.4.1 Add/Remove Devices (Optionally On Behalf) ........................................................................21

4.4.2 Remove/Replace Failed Devices (Optionally On Behalf) ......................................................24

4.4.3 Reset Network ........................................................................................................................24

4.4.4 Update Network .....................................................................................................................24

4.4.5 Set Learn Mode ......................................................................................................................24

4.4.6 About ......................................................................................................................................25

INS12903-19 Z-Ware Web User Guide 2018-03-05

silabs.com | Building a more connected world.

Page iv of vi

5 ENGINEERING UI ...............................................................................................................................26

5.1 Home ................................................................................................................................................26

5.2 About ................................................................................................................................................26

5.3 Network Manager .............................................................................................................................27

5.4 Controller ..........................................................................................................................................28

5.5 Interfaces ..........................................................................................................................................29

5.5.1 Basic .......................................................................................................................................29

5.5.2 Binary Sensor .........................................................................................................................30

5.5.3 Multi-Level Sensor .................................................................................................................30

5.5.4 Alarm/Notification ...................................................................................................................31

5.5.5 Meter ......................................................................................................................................31

5.5.6 Battery ....................................................................................................................................32

5.5.7 Binary Switch .........................................................................................................................32

5.5.8 Multi-level Switch ...................................................................................................................32

5.5.9 Color Switch Interface ............................................................................................................33

5.5.10 Central Scene Controller ........................................................................................................33

5.5.11 Door Lock ...............................................................................................................................34

5.5.12 User Code ..............................................................................................................................34

5.5.13 Barrier Operator Interface ......................................................................................................35

5.5.14 Thermostat related interfaces ................................................................................................35

5.5.14.1 Thermostat Fan ..............................................................................................................35

5.5.14.2 Thermostat Mode & State ..............................................................................................35

5.5.14.3 Thermostat SetPoint .......................................................................................................36

5.5.15 Naming/Location ....................................................................................................................36

5.5.16 Association .............................................................................................................................36

5.5.17 Configuration ..........................................................................................................................38

5.5.18 Wake up .................................................................................................................................38

5.5.19 Command Queuing ................................................................................................................38

5.5.20 Firmware Update ....................................................................................................................39

5.5.21 Z/IP Gateway .........................................................................................................................39

5.6 Scenes ..............................................................................................................................................42

5.7 Security Scenes................................................................................................................................44

REFERENCES ...........................................................................................................................................47

Table of Tables

Table 1: ZIPGW Versions vs Features as used by Z-Ware ........................................................................ 2

Table 2: UI Controlled Z-Wave CCs ............................................................................................................ 3

Table 3: Controlled Z-Wave CCs inherited through Library ........................................................................ 3

Table 5: ZIPGW SDK 2.20.00 Supported Z-Wave CCs .............................................................................. 3

Table 5: ZIPGW SDK 2.11.01 Supported Z-Wave CCs .............................................................................. 4

Table 6: ZIPGW SDK 2.01.02 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 & URIs ....................................................................................................... 8

Table 10: Z-Wave Network Buttons mapping ............................................................................................ 28

Table of Figures

Figure 1: Z-Ware CE running within a home on a RPi3 .............................................................................. 1

INS12903-19 Z-Ware Web User Guide 2018-03-05

silabs.com | Building a more connected world.

Page v of vi

Figure 2: Z-Ware Portal in the Cloud connected to multiple homes ............................................................ 1

Figure 3: Login page .................................................................................................................................... 9

Figure 4: Registration Page ....................................................................................................................... 10

Figure 5: Reset Password Page ................................................................................................................ 11

Figure 6: Tablet UI Home .......................................................................................................................... 12

Figure 7: Phone UI Home .......................................................................................................................... 12

Figure 8: Tablet UI Scene Toggle .............................................................................................................. 12

Figure 9: Tab UI - New Scene Page .......................................................................................................... 13

Figure 10: Tab UI - New Security Scene Page ......................................................................................... 13

Figure 11: Tab UI - Scene Edit/View Page ................................................................................................ 14

Figure 12: Tab UI - Security Scene View/Edit Page .................................................................................. 15

Figure 13: Tab UI - Security Scene Alarm Pop Up .................................................................................... 15

Figure 14: Tab UI - Device View/Edit Page Header .................................................................................. 16

Figure 15: Tab UI - Basic Interface ............................................................................................................ 16

Figure 16: Tab UI - Binary Sensor ............................................................................................................. 16

Figure 17: Tab UI – Alarm/Notification Interface Type/Event .................................................................... 17

Figure 18: Tab UI – Alarm/Notification Interface Event List ...................................................................... 17

Figure 19: Tab UI - Meter Interface ........................................................................................................... 17

Figure 20: Tab UI - Multilevel Sensor Interface ......................................................................................... 17

Figure 21: Tab UI - Binary Switch Device.................................................................................................. 18

Figure 22: Tab UI - Dimmer (Multilevel Switch Non-Motor) Device .......................................................... 18

Figure 23: Tab UI - Shades (Multilevel Switch Motor) Device ................................................................... 18

Figure 24: Tab UI - Door Lock Device ....................................................................................................... 19

Figure 25: Tab UI - Central Scene Controller Device ................................................................................ 19

Figure 26: Tab UI - Thermostat Device ..................................................................................................... 20

Figure 27: Tab UI - Thermostat Device Related Interfaces ....................................................................... 20

Figure 28: Tab UI - Barrier Operator Device ............................................................................................. 21

Figure 29: Tab UI - Add New Device: Initiate ............................................................................................ 22

Figure 30: Tab UI - Add New Device: Grant Keys ..................................................................................... 22

Figure 31: Tab UI - Add New Device: DSK ............................................................................................... 23

Figure 32: Tab UI - Add New Device: CSA DSK info ................................................................................ 23

Figure 33: Tab UI - Replace Failed Device ............................................................................................... 24

Figure 34: Tab UI – Set Learn Mode ......................................................................................................... 24

Figure 35: Tab UI - About .......................................................................................................................... 25

Figure 36: Eng UI - Home Page ................................................................................................................ 26

Figure 37: Eng UI - About Page ................................................................................................................ 26

Figure 38: Eng UI - Network Manager Page ............................................................................................. 27

Figure 39: Eng UI - Network operation progress UI .................................................................................. 27

Figure 40: Eng UI - Node Controller Page ................................................................................................ 28

Figure 41: Eng UI - Node Version/Info UI .................................................................................................. 29

Figure 42: Eng UI - Endpoint Z-Wave+ Info UI.......................................................................................... 29

Figure 43: Eng UI - Basic Interface UI ....................................................................................................... 29

Figure 44: Eng UI - Binary Sensor Interface UI ......................................................................................... 30

Figure 45: Eng UI - Multilevel Sensor Interface UI .................................................................................... 30

Figure 46: Eng UI – Alarm/Notification Interface UI .................................................................................. 31

Figure 47: Eng UI - Meter Interface UI ...................................................................................................... 31

Figure 48: Eng UI - Battery Interface UI .................................................................................................... 32

Figure 49: Eng UI - Binary Switch Interface UI .......................................................................................... 32

Figure 50: Eng UI - Multilevel Switch Interface UI ..................................................................................... 32

Figure 51: Eng UI - Color Switch Interface ................................................................................................ 33

Figure 52:: Eng UI - Central Scene Controller Interface UI ....................................................................... 33

Figure 53: Eng UI - Door Lock Interface UI ............................................................................................... 34

Figure 54: Eng UI - User Code Interface UI .............................................................................................. 34

Figure 55: Eng UI - Barrier Operator Interface UI ..................................................................................... 35

Figure 56: Eng UI - Thermostat Fan Interface UI ...................................................................................... 35

Figure 57: Eng UI - Thermostat Mode & State Interface UI ...................................................................... 36

Figure 58: Eng UI - Thermostat Setpoint Interface UI ............................................................................... 36

INS12903-19 Z-Ware Web User Guide 2018-03-05

silabs.com | Building a more connected world.

Page vi of vi

Figure 59: Eng UI - Name/Location Interface UI ....................................................................................... 36

Figure 60: Eng UI - Group Interface UI...................................................................................................... 37

Figure 61: Eng UI - Group with AGI Interface UI ....................................................................................... 37

Figure 62: Eng UI - Configuration Interface UI .......................................................................................... 38

Figure 63: Eng UI - Wakeup Interface UI .................................................................................................. 38

Figure 64: Command Queuing Interface UI .............................................................................................. 39

Figure 65: Eng UI - Firmware Update Interface UI .................................................................................... 39

Figure 66: Eng UI – ZIPGW Interface Portal Mode UI .............................................................................. 40

Figure 67: Eng UI - ZIPGW Interface Standalone Mode UI ...................................................................... 41

Figure 68: Eng UI - Scenes Page .............................................................................................................. 42

Figure 69: Eng UI - Scene Edit UI ............................................................................................................. 43

Figure 70: Eng UI - Security Scenes Page ................................................................................................ 44

Figure 71: Eng UI - Security Scene Edit UI ............................................................................................... 45

Figure 72: Eng UI - Security Scene Notification Edit UI ............................................................................ 46

INS12903-19 Z-Ware Web User Guide 2018-03-05

silabs.com | Building a more connected world.

Page 1 of 49

1 INTRODUCTION

1.1 Purpose

Z-Ware is a Z-Wave controller middleware running over Z-Wave over IP (Z/IP) interface 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 https://beagleboard.org/black) or RPi3 (Raspberry Pi 3

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 a RPi3

Figure 2: Z-Ware Portal in the Cloud connected to multiple homes

This document covers the usage of Z-Ware Web Server & Apps for both CE & 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

Web users

Z-Wave

Device

iPad/iPhone

Android Phone/Tab

RPi3

Z-Ware Web Server

Z-Ware Library

Z/IP Gateway

Z-Ware Client

Z-Wave

Device

PC Web Browser

Z-Ware Apps

BeagleBone Black

Z-Wave

Device

iPad/iPhone

Android Phone/Tab

Cloud Linux VM

Z-Ware Web Server

Z-Ware Library

Z/IP Gateway

Z-Ware Client

Z-Wave

Device

PC Web Browser

Internet

Z-Ware Apps

INS12903-19 Z-Ware Web User Guide 2018-03-05

silabs.com | Building a more connected world.

Page 2 of 49

2 OVERVIEW

2.1 Z-Ware Library

The Z-Ware Library, which abstracts the ZIPGW, provides CC level APIs, discovery of device capability

& 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.

As a Z/IP secure remote client, it works in conjunction with a ZIPGW such as the ZIPR. Z-Ware sets

itself as the (first) unsolicited IP address of the ZIPGW that it is connected with. Z-Ware works with 3

versions of ZIPGWs using the following features:

Table 1: ZIPGW Versions vs Features as used by Z-Ware

ZIPGW Features

vs SDK

Mailbox

Dual unsolicited

destination

Discovery

Security

ZIPR

Unavailable

ZIP discovery

S0

2.01.02

Unused

mdns

S0

2.11.01

Used

mdns

S2 with CSA/IOB

For Client Side Authentication (CSA), see Security 2 CC in [7]. For Inclusion or Replace Failed Node on

Behalf of another Inclusion Controller (IOB) – see Inclusion Controller CC in [6].

2.1.2 Network Operations

Z-Ware supports Inclusion (with CSA and IOB), Exclusion, Reset (Set Default), Replace/Remove Failed

Node (with CSA & IOB), Send Node Info. 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. However it can also be used as a secondary or inclusion controller in which case many of its

features cannot be used.

Z-Ware supports Set Learn mode. Controller replication (copy) is achieved through Inclusion and Set

Learn Mode.

Additionally it also supports Update Node and Update Network. 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.

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.

INS12903-19 Z-Ware Web User Guide 2018-03-05

silabs.com | Building a more connected world.

Page 3 of 49

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

ASSOCIATION_GRP_INFO

3

BARRIER_OPERATOR

1

BASIC

2

BATTERY

1

CENTRAL_SCENE

3

CONFIGURATION

1

DOOR_LOCK

3

FIRMWARE_UPDATE_MD

5

MANUFACTURER_SPECIFIC

2

METER

3

MULTI_CHANNEL

4

MULTI_CHANNEL_ASSOCIATION

3

NW_MGMT_BASIC

2

NW_MGMT_INCLUSION

2

NW_MGMT_PROXY

2

NODE_NAMING

1

NOTIFICATION/ALARM

8

SECURITY

1

SECURITY 2 *

1

SENSOR_BINARY

2

SENSOR_MULTILEVEL

9

SWITCH_BINARY

2

SWITCH_COLOR

3

SWITCH_MULTILEVEL

4

THERMOSTAT_FAN_MODE

4

THERMOSTAT_FAN_STATE

2

THERMOSTAT_MODE

2

THERMOSTAT_OPERATING_STATE

1

THERMOSTAT_SETPOINT

2

USER_CODE

1

VERSION

2

WAKE_UP

2

ZIP_GATEWAY

1

ZIP_PORTAL

1

ZWAVEPLUS_INFO

2

* Security 2 is only controlled if the underlying ZIPGW supports S2.

Table 3: Controlled Z-Wave CCs inherited through Library

CC

Ver

CC

Ver

ALARM SENSOR

1

APPLICATION_STATUS

1

CRC_16_ENCAP

1

DEVICE_RESET_LOCALLY

1

MULTI_CMD

1

NO_OPERATION

1

POWERLEVEL

1

SUPERVISION

1

ZIP

3

ZIP_ND

1

2.1.4 Command Class Support

Z-Ware does nothing on receiving Basic CC Set or Get. 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.

Table 4: ZIPGW SDK 2.2x Supported Z-Wave CCs

CC

Ver

Not

added

Non-secure

added

Securely added

Non-Secure

Secure

APPLICATION_STATUS

1

X

ASSOCIATION *

2

X

ASSOCIATION_GRP_INFO *

3

X

CRC_16_ENCAP

1

X

INS12903-19 Z-Ware Web User Guide 2018-03-05

silabs.com | Building a more connected world.

Page 4 of 49

DEVICE_RESET_LOCALLY *

1

X

FIRMWARE_UPDATE_MD

5

X

INCLUSION_CONTROLLER **

1

X

MANUFACTURER_SPECIFIC

2

X

MULTI_CMD *

1

X

NODE PROVISIONING

1

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

SECURITY

1

X

SECURITY_2

1

X

SUPERVISION

1

X

TRANSPORT_SERVICE

2

X

VERSION

2

X

ZWAVEPLUS_INFO

2

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

ASSOCIATION *

2

X

ASSOCIATION_GRP_INFO *

3

X

CRC_16_ENCAP

1

X

DEVICE_RESET_LOCALLY *

1

X

FIRMWARE_UPDATE_MD

5

X

INCLUSION_CONTROLLER **

1

X

MANUFACTURER_SPECIFIC

2

X

MULTI_CMD *

1

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

SECURITY

1

X

SECURITY_2

1

X

SUPERVISION

1

X

TRANSPORT_SERVICE

2

X

VERSION

2

X

ZWAVEPLUS_INFO

2

X

Table 6: ZIPGW SDK 2.0x Supported Z-Wave CCs

CC

Ver

Not

Added

Non Secure

Added

Securely Added

Non Secure

Secure

SECURITY

1

X

TRANSPORT SERVICE

2

X

CRC16

1

X

MULTI CMD *

1

X

NW MGMT BASIC

2

X

NW MGMT INCLUSION **

2

X

NW MGMT PROXY

2

X

NW MGMT INSTALLATION MAINTENANCE

1

X

INS12903-19 Z-Ware Web User Guide 2018-03-05

silabs.com | Building a more connected world.

Page 5 of 49

CC

Ver

Not

Added

Non Secure

Added

Securely Added

Non Secure

Secure

DEVICE RESET LOCALLY *

1

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

ZWAVEPLUS INFO

2

X

MANUFACTURER SPECIFIC

2

X

VERSION

2

X

ASSOCIATION *

2

X

ASSOCIATION GRP INFO *

3

X

* ASSOCIATION, ASSOCIATION_GRP_INFO, MULTI_CMD & DEVICE_RESET_LOCALLY CCs are

added by Z-Ware to the ZIPGW NIF

** INCLUSION_CONTROLLER & NW_MGMT_INCLUSION CCs are only present if the ZIPGW is an

inclusion controller.

2.1.5 Network Initialization

The following steps are carried out during network initialization:

1. Get ZIPGW’s Z-Wave Home ID, Node ID & 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 version 2 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 version 2.58 and above. This will enable multi-client support and receive

wake up notification from device through mailbox ACK message.

8. Get Dynamic Z/IP gateway 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) through HAN network for nodes that are not loaded with detailed

node information from persistent storage.

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 version is 2 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.

INS12903-19 Z-Ware Web User Guide 2018-03-05

silabs.com | Building a more connected world.

Page 6 of 49

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 & events

m) Get Protection CC supported states

n) Get User Code CC maximum supported codes

o) Get Meter CC capabilities & descriptor

p) Get Binary Sensor CC supported types & current value

q) Get Door Lock CC current state

r) Get Alarm Sensor CC supported types & current value

s) Get Barrier Operator CC current state

t) Get Color Switch CC supported components & 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

Ver

CC

Ver

VERSION

2

MANUFACTURER_SPECIFIC

2

WAKE_UP

2

Table 8: Node Update endpoint get/set CCs

CC

Ver

CC

Ver

ASSOCIATION

2

ASSOCIATION_GRP_INFO

3

BARRIER_OPERATOR

1

BATTERY

1

CLOCK

1

CONFIGURATION

1

DOOR_LOCK

1

METER

3

METER_TBL_MONITOR

1

MULTI_CHANNEL_ASSOCIATION

3

NODE_NAMING

1

NOTIFICATION/ALARM

7

SIMPLE_AV_CONTROL

1

PROTECTION

2

SENSOR_BINARY

2

SENSOR_MULTILEVEL

9

SWITCH_BINARY

1

SWITCH_COLOR

3

SWITCH_MULTILEVEL

3

THERMOSTAT_SETPOINT

3

THERMOSTAT_FAN_MODE

1

THERMOSTAT_FAN_STATE

2

THERMOSTAT_MODE

1

THERMOSTAT_OPERATING_STATE

1

USER_CODE

1

VERSION

2

INS12903-19 Z-Ware Web User Guide 2018-03-05

silabs.com | Building a more connected world.

Page 7 of 49

CENTRAL_SCENE

3

2.1.7 Network Update

The following steps are carried out to update the network:

1. Repeat steps 1 to 4 of Network Initialization (see 0).

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 0).

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 0.

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.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.

INS12903-19 Z-Ware Web User Guide 2018-03-05

silabs.com | Building a more connected world.

Page 8 of 49

2.3 Bundled Z-Ware Apps

Consumer-friendly UIs targeted for Tablet/PC & Phone are included, as well as an Engineering version

meant to demonstrate the server’s capabilities.

Table 9: Bundled Z-Ware Apps & URIs

Target

Base URI

Tablet/PC

/ui/pc/index.html

Phone

/ui/phone/index.html

Engineering

/ui/eng/index.html

On login, the Tablet or Phone UI is automatically selected by the server based on the User Agent of the

web browser used.

Engineering UI exposes advanced Z-Wave interfaces related to the Association and Configuration CCs,

and it always exposes Basic CC control for all endpoints. However it does not currently support S2

security based inclusion and replace fail node operations. The Tablet and Phone UI only expose the

Basic CC control for non-controller devices that are unknown and have no other way of controlling them,

in order to reduce clutter on the screen.

Full screen UI experience on iOS & Androind are provided at:

https://itunes.apple.com/sg/app/z-ware/id886591150

https://play.google.com/store/apps/details?id=com.sigmadesigns.Z-Wave

Users can build their own apps over the Z-Ware Web API – see [1].

INS12903-19 Z-Ware Web User Guide 2018-03-05

silabs.com | Building a more connected world.

Page 9 of 49

3 ACCESS

3.1 Login

Figure 3: Login page

3.1.1 Portal

Portal users access their accounts at https://z-ware.sigmadesigns.com . They can login & create their

account or reset the account password through the links at the bottom.

3.1.2 CE

CE users access their accounts on the machine they have installed at https://<machine IP address>.

The default username & password are ‘sigma’ & ‘sigmadesigns’ respectively. The page will be titled

“CE” instead of “Portal” and the links at the bottom will not be there.

INS12903-19 Z-Ware Web User Guide 2018-03-05

silabs.com | Building a more connected world.

Page 10 of 49

3.2 Registration (Portal Only)

To create the Portal account, the user needs to fill in the registration details.

Figure 4: Registration Page

First & 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 Remote Access Code (RAC) & PIN can be found on the label of the purchased ZIPR. The time

zone setting allows the server to convert time information in accordance to the locality of the ZIPR. For

ZIPGW running on other non-ZIPR platforms, the platform’s Ethernet MAC address should be used as

INS12903-19 Z-Ware Web User Guide 2018-03-05

silabs.com | Building a more connected world.

Page 11 of 49

RAC by the user & the PIN will not be prompted. The Ethernet MAC address can be obtained as

specified in the ZIPGW User Guide.

On registration, an email is sent to the registered email address which contains an unregister link in case

the user entered the wrong details & wishes to reregister. For ZIPGW running on non ZIPR platforms, a

link to download certificates is also enclosed and these certificates will have to be downloaded to the

platform as specified in the ZIPGW User Guide.

3.3 Reset password (Portal Only)

The account name needs to be specified to confirm. An email will be sent with an unregister link, and the

process will be the same as creating a new account.

Figure 5: Reset Password Page

INS12903-19 Z-Ware Web User Guide 2018-03-05

silabs.com | Building a more connected world.

Page 12 of 49

4 TABLET/PC & 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 Home

The home page allows monitoring & manual activation of a list of scenes.

Figure 6: Tablet UI Home

There are 2 scenes in this diagram. All scenes 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 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: Phone UI Home

Figure 8: Tablet UI Scene Toggle

INS12903-19 Z-Ware Web User Guide 2018-03-05

silabs.com | Building a more connected world.

Page 13 of 49

4.2 Scenes

The Scenes page looks the same as Home page except for a ‘New Scene’ that allows scene creation

and that clicking on a scene allows viewing and editing it.

4.2.1 Create

The ‘Create Scene’ option shows a popup that allows naming the scene and selecting the devices that

will, for normal scenes, be controlled through actions, while for security scenes, cause an alarm. Basic

Set Command can be used as an event or an action as is exposed optionally only with Proprietary flag to

prevent cluttering up the screen with devices.

Figure 9: Tab UI - New Scene Page

Figure 10: Tab UI - New Security Scene Page

4.2.2 Edit/View

Clicking on a scene allows it to be viewed or edited to add more schedules, events or action devices

through the add buttons at the top right of the relevant collapsible compartments. The scene or elements

in the scene can be deleted by the cross buttons.

4.2.2.1 Normal Scene

There are 3 collapsible compartments for Actions, Schedules and Triggers which allow adding/deleting

elements within limits shown on the title bar.

In the Action compartment, devices are set to the Target value on the right of the compartment when the

Scene is activated, while the left side shows the current value, and the icon identifying the interface. The

active indicator is blue if the current and target values are aligned, and gray otherwise.

In Schedules, multiple days of the week can be selected along with the trigger time. In Events, the

trigger condition can be set on the right while the current state is shown on the left.

INS12903-19 Z-Ware Web User Guide 2018-03-05

silabs.com | Building a more connected world.

Page 14 of 49

Figure 11: Tab UI - Scene Edit/View Page

4.2.2.2 Security Scene

There are 4 collapsible compartments for Arm, Disarm, Alarm Events; and Notification. The 1

st

3 allow

adding/deleting events within limits shown on the title bar.

Page is loading ...

Silicon Labs Z-Ware Web User guide

Silicon Labs Z-Ware Web User guide

Related papers

Other documents