confidential - silabs.com€¦ · the data contained herein, in whole or in part, ... nwe added...
TRANSCRIPT
CONFIDENTIAL
Instruction
Z-Wave PC based Controller v5 User Guide
Document No.: INS13114
Version: 9
Description: -
Written By: JFR;SRO;MVO;AVASILEVSKY;VSAVOSTIANENKO;BBR
Date: 2018-03-05
Reviewed By: JKA;COLSEN;CRASMUSSEN;LTHOMSEN;JBU;JSI;ABUENDIA;NSHARMA;RREYES
Restrictions: Partners Only
Approved by:
Date CET Initials Name Justification
2018-03-05 14:40:04 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.
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page ii of viii
CONFIDENTIAL
REVISION RECORD
Doc. Rev Date By Pages affected Brief description of changes
1 20141217 SRO;AVA;VSA All Initial version based on INS10240-13
1 20150226 SRO;AVA;VSA All Updated all screenshots,
Updated Association, Command Class, Encrypt/Decrypt, Firmware
Update, Backup/Restore NVM topics
Added IMA, Settings Trace Capturing, Polling functionality, Setup
Route functionality topic
1 20150226 SRO 5.18.1 Added Power shell script example
2 20160128 SRO;VSA All
4.1.1
0
4.2
4.2.3
4.2.4
4.4
4.10
4.14, 5.15
4.15,
5.1
5.2.2
5.2.5
5.2.10
5.2.21
5.2.19
5.3.3
Update all screenshots
Added new settings view
Updated description for Security S0 test settings and added
description for Security S2 keys and test settings
Update list of views available from start screen
Described ‘Floating View’ option
Added screenshot for additional Bridge Controller actions(Add,
Remove virtual)
Updated description of the available nodes actions including
Security S2 related actions
Added screenshot for additional Bridge Controller action(Slave Learn
Mode)
Updated description of the available controller actions
Added description of the Set Node Information action.
Updated description of the available options on the Command
Classes view
Added Security S2 Encrypt/Decrypt description
Added: Configuration Command Class support
Added: UL Monitor Tool
Update Table1
Added: Nodes with Endpoints
Added: NWE
Added warning screenshot if SIS already present in network
Added: Select Security scheme
Added: Reset SPAN
Added: Set Node Info
3 20160224 SRO All
4.1.1
5.2.1
Update all screenshots
Updated: Settings also contains connection args input field
Changed: added secure S2 node inclusion dialogs description
4 20160708 SRO 4.1.1
4.2
4.2.4
4.3
4.1, 4.2, 4.2.3
4.2.4
Updated Tab S2 Security Test Scheme topic (new test settings and
CSA option)
Updated screenshot
Updated screenshot, added MPAN table description
Updated Association view screenshot and description
Added screenshots for Z/IP controller
Added screenshots for Z/IP controller, Unsolicited destination
description
4 20160708 SRO 5.5 Updated topic
5 20160726 AVASILEVSKY 5, 5.2.1 Added reminders to set up unsolicited destination for Z/IP Gateway
5 20160726 AVASILEVSKY 4.4 Update command classes view screenshot
Added description of ‘Auto increment’ session id functionality for
supervision encapsulation
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page iii of viii
CONFIDENTIAL
REVISION RECORD
Doc. Rev Date By Pages affected Brief description of changes
5 20160805 AVASILEVSKY 5.14 Added clarifications on how NVM restores from zip and hex files
6 20160912 AVASILEVSKY 4.1, 4.2, 4.11,
5.2
Updated screenshots
Added description for new buttons and views
6 20160913 AVASILEVSKY 5.7 Added explanations how to configure security test schema
6 20160927 JFR 2.3 Updated necessary tools for PC based Controller build environment.
7 20161206 SRO 3.3 Updated installation steps
All Updated screenshots
Removed “Start the Z-Wave PC Controller” section
4.1.1.3 Updated section: Security Test Schema button
7 20161212 SRO 5.7 Updated section: Security Test Schema view
5.12 Added S2 message encapsulation frame decrypt description
5.14 Include mention of the wake up settings of the Sensor PIR nodes
8 20170922 VSAVOSTIANENKO Removed image “Node settings pop-up window”
4.1.1.3 Added property “Is Broadcast”
5.7.2 Added property “Is Broadcast” explanation
Removed “UL Tool Monitor View” section
Removed “UL Tool Monitor” Section
4.15 Added “Smart Start View” section
5.16 Added “Smart Start” section
All Updated screenshots
5.7.3 Added description of “Applied Action” and updated examples
9 20180305 BBR Added Silicon Labs template
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page iv of viii
CONFIDENTIAL
Table of Contents
1 ABBREVIATIONS.................................................................................................................... 8
2 INTRODUCTION ...................................................................................................................... 8
2.1 Purpose ............................................................................................................................................. 8
2.2 Audience and prerequisites ........................................................................................................... 8
2.3 Implementation ................................................................................................................................ 8
3 THE Z-WAVE PC BASED CONTROLLER ........................................................................... 10
3.1 Check the prerequisites ................................................................................................................10
3.2 Required Z-Wave hardware .........................................................................................................11
3.3 Install the Z-Wave PC Controller .................................................................................................11
3.4 Remove Z-Wave PC Controller ...................................................................................................11
4 USER INTERFACE ................................................................................................................ 13
4.1 Main Menu View ............................................................................................................................13
4.1.1 Title bar .................................................................................................................................14
4.1.1.1 Home button .................................................................................................................15
4.1.1.2 Commands Queue button ..........................................................................................15
4.1.1.3 Security Test Schema button.....................................................................................16
4.1.2 Content View ........................................................................................................................20
4.1.3 Log bar ..................................................................................................................................21
4.2 Network Management View .........................................................................................................22
4.2.1 Node List View .....................................................................................................................24
4.2.2 Node Information View .......................................................................................................25
4.2.3 Nodes Actions View ............................................................................................................26
4.2.4 Controller View ....................................................................................................................28
4.3 Associations view ..........................................................................................................................35
4.4 Command Class view ...................................................................................................................36
4.5 Setup Route view ..........................................................................................................................40
4.6 ERTT View......................................................................................................................................41
4.7 Polling View ....................................................................................................................................43
4.8 Topology Map View .......................................................................................................................44
4.9 IMA Network View .........................................................................................................................46
4.10 Encrypt/Decrypt View ....................................................................................................................50
4.11 Firmware Update (OTA) View .....................................................................................................52
4.12 Firmware Update (OTW) View ....................................................................................................54
4.13 Backup/Restore NVM ...................................................................................................................54
4.14 Configuration Parameters ............................................................................................................55
4.15 Smart Start View ............................................................................................................................55
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page v of viii
CONFIDENTIAL
5 FUNCTIONALITY .................................................................................................................. 58
5.1 The SC Properties .........................................................................................................................59
5.2 Node View ......................................................................................................................................61
5.2.1 How to add a node ..............................................................................................................61
5.2.2 How to add MultiChannel Node with EndPoints .............................................................63
5.2.3 How to remove a node .......................................................................................................63
5.2.4 Network Wide Inclusion ......................................................................................................63
5.2.5 Network Wide Exclusion ....................................................................................................64
5.2.6 Send NOP ............................................................................................................................64
5.2.7 How to send a failure signal to a node .............................................................................64
5.2.8 How to replace a failed node .............................................................................................64
5.2.9 How to remove a failing node ............................................................................................65
5.2.10 Set SIS ..................................................................................................................................65
5.2.11 Request Node Neighbours Update...................................................................................65
5.2.12 Node Info ..............................................................................................................................65
5.2.13 Version Get ..........................................................................................................................65
5.2.14 Switching a node or a subset of nodes on and off .........................................................66
5.2.15 Set Wake-Up Interval ..........................................................................................................66
5.2.16 ‘Switch All On’ command ...................................................................................................66
5.2.17 ‘Switch All Off’ command ...................................................................................................66
5.2.18 Start/Stop Basic Test ..........................................................................................................66
5.2.19 Reset SPAN .........................................................................................................................66
5.2.20 Next SPAN ...........................................................................................................................66
5.2.21 Security Scheme .................................................................................................................67
5.3 Controller View ...............................................................................................................................67
5.3.1 Reset controller....................................................................................................................67
5.3.2 Send Node Info ....................................................................................................................67
5.3.3 Set Node Info .......................................................................................................................68
5.3.4 Controller shift ......................................................................................................................68
5.3.5 Request update of PC based SC ......................................................................................68
5.4 Command Class View ..................................................................................................................68
5.5 Association View ............................................................................................................................68
5.5.1 Create Association ..............................................................................................................69
5.5.2 Remove Association ...........................................................................................................69
5.6 Setup Route View ..........................................................................................................................69
5.6.1 Assign a route ......................................................................................................................69
5.6.2 Delete a route ......................................................................................................................69
5.7 Security Test Schema View .........................................................................................................69
5.7.1 Test S2 Parameters overrides ..........................................................................................70
5.7.2 Test S2 Messages overrides .............................................................................................70
5.7.3 Test S2 Message Encapsulation extensions overrides .................................................72
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page vi of viii
CONFIDENTIAL
5.8 ERTT View......................................................................................................................................73
5.9 Polling View ....................................................................................................................................75
5.10 Topology Map View .......................................................................................................................75
5.11 IMA Network View .........................................................................................................................75
5.11.1 Network Health ....................................................................................................................76
5.11.2 Power Level Test .................................................................................................................76
5.12 Security Encrypt/Decrypt ..............................................................................................................76
5.13 Firmware Update ...........................................................................................................................78
5.14 NVM Backup/Restore ...................................................................................................................78
5.15 Configuration Parameters ............................................................................................................79
5.16 Smart Start......................................................................................................................................79
5.17 Z-Wave PC Controller Log ...........................................................................................................80
5.18 Settings Trace Capturing ..............................................................................................................80
5.18.1 Open saved capture trace file ...........................................................................................80
6 REFERENCES ....................................................................................................................... 83
INDEX ........................................................................................................................................... 84
List of Figures
Figure 1: PC with a Z-Wave module connected ............................................................................... 10
Figure 2 Main Menu View ...................................................................................................................... 13
Figure 3 Settings View ........................................................................................................................... 14
Figure 4 Commands Queue view ......................................................................................................... 15
Figure 5 Security Test Settings ............................................................................................................ 16
Figure 6 Security Parameter overrides ................................................................................................ 18
Figure 7 Security Message overrides .................................................................................................. 18
Figure 8 Security Extension overrides ................................................................................................. 20
Figure 9 Content View............................................................................................................................ 21
Figure 10 Content View with Z/IP Controller connected ................................................................... 21
Figure 11 Log bar view .......................................................................................................................... 22
Figure 12 Log window view .................................................................................................................. 22
Figure 13 Network Management View ................................................................................................ 23
Figure 14 Network Management View with Z/IP controller connected ........................................... 24
Figure 15 Nodes View ............................................................................................................................ 24
Figure 16 Node Information View ......................................................................................................... 25
Figure 17 Nodes Actions View .............................................................................................................. 26
Figure 18 Nodes Actions View when Z/IP controller connected...................................................... 26
Figure 19 Bridge Controller additional actions ................................................................................... 26
Figure 20 Controller View ...................................................................................................................... 28
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page vii of viii
CONFIDENTIAL
Figure 21 Z/IP Controller view .............................................................................................................. 29
Figure 22 Bridge Controller additional action ..................................................................................... 29
Figure 23 Set Node Information view .................................................................................................. 32
Figure 24 Mpan table view .................................................................................................................... 33
Figure 25 Unsolicited Destination view ............................................................................................... 33
Figure 26 Associations view .................................................................................................................. 35
Figure 27 Command Classes View ...................................................................................................... 37
Figure 28 Setup Route View ................................................................................................................. 40
Figure 29 ERTT View ............................................................................................................................. 42
Figure 30 Polling View ........................................................................................................................... 43
Figure 31 Topology Map ........................................................................................................................ 44
Figure 32 IMA Network View ................................................................................................................ 46
Figure 33 IMA Network Health status description (Details) ............................................................. 48
Figure 34 IMA Network Health Value description (Legend) ............................................................. 49
Figure 35 IMA Nodes View description (Legend) .............................................................................. 50
Figure 36 Encrypt/Decrypt View S0 Tab ............................................................................................. 51
Figure 37 Encrypt/Decrypt View S2 Tab ............................................................................................. 51
Figure 38 Firmware Update (OTA) View ............................................................................................. 52
Figure 39 File Dialog View .................................................................................................................... 54
Figure 40 Configuration Parameters View .......................................................................................... 55
Figure 41 Smart Start View ................................................................................................................... 56
Figure 42 Z/IP Controller connected Smart Start View ..................................................................... 56
Figure 43 Popup message after pressing 'Add' button ..................................................................... 62
Figure 44 Network keys request ........................................................................................................... 62
Figure 45 Enter DSK Dialog .................................................................................................................. 62
Figure 46 Multi Channel Node with End Points View ........................................................................ 63
Figure 47 Popup message after pressing 'Remove' button ............................................................. 63
Figure 48 Set SIS Warning Message .................................................................................................. 65
Figure 49 Select Security Scheme Dialog .......................................................................................... 67
Figure 50 Test frame configuration for Example 1 ............................................................................ 71
Figure 51 Test frame configuration for Example 2 ............................................................................ 72
Figure 52 Last Used Temp Key ............................................................................................................ 77
Figure 53 S2 Message Encapsulation frame ..................................................................................... 77
Figure 54 S2 Message Encapsulation frame hex data ..................................................................... 78
Figure 55 S2 Message Encapsulation frame decrypt ....................................................................... 78
Figure 56 Provisioning list item delete popup..................................................................................... 79
Figure 57 Smart Start added Device Locally Reset popup .............................................................. 80
List of Tables
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page viii of viii
CONFIDENTIAL
Table 1 Overview of the Static Controller properties ......................................................................... 60
1 ABBREVIATIONS
Abbreviation Explanation
API Application Programming Interface
DLL Dynamic Link Library
IMA Installation and Maintenance Application
NVM Non-volatile memory
OTA Over-the-air
OTW Over-the-wire
SC Static Controller
SUC Static Update Controller
SIS SUC ID Server
ERTT Enhanced Reliability Test Tool
DSK Device Specific Key
2 INTRODUCTION
2.1 Purpose
The Z-Wave PC based Controller application is an example on how Static/Bridge Controller Serial API
functionality can be used to implement a Z-Wave enabled PC application.
2.2 Audience and prerequisites
The audience is Z-Wave partners and Silicon Labs. It is assumed that the Z-Wave partner already is
familiar with the current Z-Wave Developer's Kit.
2.3 Implementation
The Z-Wave PC based Controller application is implemented in Visual Studio .NET 2008 C# and uses the
.NET Framework 3.5. It based on the Z-Wave DLL. The solution also contains Setup project for creating
msi setup file and xxx.UnitTest project with unit tests. Both can be excluded safely from the solution.
However, in order to build Setup project and UnitTest projects solution requires:
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 9 of 76
CONFIDENTIAL
The WiX toolset (http://wixtoolset.org) lets developers create installers for Windows Installer,
the Windows installation engine. Must install specific version WiX toolset 3.8
https://wix.codeplex.com/releases/view/115492 and execute win38.exe
NUnit (http://www.nunit.org) is a unit-testing framework for all .Net languages. Must install
specific version NUnit 2.6.4 https://github.com/nunit/nunitv2/releases/tag/2.6.4 and execute
NUnit-2.6.4.msi
Note: Regarding a detailed description about the Z-Wave DLL, please refer [4].
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 10 of 76
CONFIDENTIAL
3 THE Z-WAVE PC BASED CONTROLLER
1 The Z-Wave PC based Controller is an application designed for the Windows platform that is capable
of communicating with Z-Wave nodes like switches and sensors through a Static Controller (SC).
Figure 1: PC with a Z-Wave module connected
3.1 Check the prerequisites
The following components should be pre-installed on the machine that you need to run Z-Wave PC
based Controller Windows application:
1. .NET Framework, version 3.5 SP1 or later
2. Windows Installer 3.0 (Windows Installer 3.1 or later is recommended)
Limitation: Z-Wave Zniffer has been tested on Windows 7, Windows 8 and Windows 10. The PC
application is a ‘desktop application’ that runs on X86 (32bit and 64bit) architecture.
Important: Make sure you have the latest service pack and critical updates for the version of Windows
that you are running. To find the recent security updates, visit Windows Update.
Z-Wave
module
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 11 of 76
CONFIDENTIAL
3.2 Required Z-Wave hardware
Z-Wave PC Controller application requires a Z-Wave module programmed with Static Controller Serial
API application and connected to the appropriate serial or USB port.
To program the Z-Wave module, use the firmware HEX file (usually
serialapi_controller_static_ZW050x_XX.hex, USB version has USBVCP in its name)
located in the directory ‘C:\DevKit_X_YY\SDK\ProductPlus\Bin\
SerialAPI_Controller_Static\’. Finally connect the Z-Wave module to the COM port on the
PC.
UZB is the Z-Wave USB Adapter. It is a USB-based Static Controller.
As the device exports a USB CDC/ACM class compliant interface, it appears as a serial port, reusing
existing standard drivers on most popular PC operating systems. As such there is no vendor driver
required. Over the serial port, the Z-Wave Serial API is exported.
UZB.INF is provided that reuses the standard Windows usbser.sys or usbser64.sys driver. The device
appears in the Device Manager under the Ports section, and is accessible through the Windows
CreateFile API by applications as “//.//COMxxx” where xxx is the COM Port number assigned by the OS.
For more info on UZB, see INS11850, Instruction, UZB User Manual.
3.3 Install the Z-Wave PC Controller
1. Exit all programs.
2. Run the installation file of the Z-Wave PC Controller application and then follow the installation
wizard.
3. The actual installation procedure will pass with progress indicator and final confirmation
appears.
4. Click Finish to complete the installation.
3.4 Remove Z-Wave PC Controller
You can uninstall Z-Wave PC Controller from your computer if you no longer use it.
1. Open “Add or Remove Programs” in Control Panel.
To do it, click “Start”, then click “Control Panel” (in Classical View – click “Start”, then point to
“Settings”, and click “Control Panel”), and then double-click “Add or Remove Programs”.
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 12 of 76
CONFIDENTIAL
2. Click the program in the list and then click the “Remove” button. You can sort programs by
selecting different options in “Sort by”.
3. Standard confirmation dialog appears. Click “Yes” to continue the removal of the Z-Wave PC
Controller software.
4. Z-Wave PC Controller and its settings will be removed without prompting you further.
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 13 of 76
CONFIDENTIAL
4 USER INTERFACE
4.1 Main Menu View
The Z-Wave PC Controller application's Main menu view consists of the following items:
Title bar
Content view (current view depends on selected button on Main menu view)
Log bar
Figure 2 Main Menu View
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 14 of 76
CONFIDENTIAL
4.1.1 Title bar
Title bar is located on top of the Main Menu View. It is accessible from any view. It has the following
items:
Settings
Pressing on Settings button opens a new window in which controller device can be selected. Also in this
window possible to set up trace capture settings.
Figure 3 Settings View
Menu item Description
Detect Detect library type for available devices
Refresh Refreshes list of connected devices
Clear All Clears list of ZIP Gateway Data Source
Discover Detects available ZIP Gateway
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 15 of 76
CONFIDENTIAL
Add Add custom IP Address to list
Connection args Allows to change Dtls1 connection arguments
Capture communication trace to Enables trace capturing
… (Browse For Folder) Select folder for saving files of capture
Auto split Enables splitting files by size and/or duration and
count of file parts
Ok Selects chosen COM port as controller and closes the
window and applies changes of trace capturing.
Cancel Closes the window without changes
4.1.1.1 Home button
Pressing Home button opens Main menu view.
4.1.1.2 Commands Queue button
Pressing “Commands Queue” button shows the queue commands for nodes in the new window. Each
node has its own group.
Figure 4 Commands Queue view
Menu item Description
Delete Delete selected command from queue
Clear Clear queue
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 16 of 76
CONFIDENTIAL
4.1.1.3 Security Test Schema button
Pressing on Security Test Schema button opens a new window Security Settings which contains the list
security of network keys and the list of test properties for Security and Security version 2.
Figure 5 Security Test Settings
Menu item Description
Save Saves current Security S2 test schema to file
Load Loads Security S2 test schema from file
OK Applies current Security settings and Security Test
Settings if they enabled and closes Security Settings
dialog.
Cancel Closes Security Settings dialog without apply changes
made.
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 17 of 76
CONFIDENTIAL
Apply Applies current Security settings and Security Test
Settings if they enabled without closing Security
Settings dialog.
Security Test Schema functionality is available for the purposes of testing secure networks for failures in
case of device malfunctioning.
Checkboxes “Enable S0”, “Enable S2 Unauthenticated”, “Enable S2 Authenticated” and “Enable S2
Access” turns on/off corresponding security class.
Checkbox “Join with CSA” allows PC Controller to send KEX Report with CSA flag set to 1. This flag will
only be set when PC Controller is being included in network as secondary controller.
Current Network Keys are shown in greyed (disabled editing) textboxes according to security level:
Network Key S0, Unauthenticated, Authenticated and Access. Near with each network key are placed
buttons to copy value to clipboard and checkboxes to use Permanent Key from white (enabled editing)
textbox.
Save Security Keys to Storage checkbox is enables saving network keys to file on applying settings, reset
controller and on adding controller to another network. Button “…” change storage folder path. Values
will be added to file with current network home id name.
Tab S0 Security Test Scheme
Security Test Schema S0 can be configured for both Including Controller and Included Node. To enable
Schema should be checked “Enable security test schema” checkbox.
All changes made on this view will be applied after “OK” or “Apply” button click.
Tab S2 Security Test Scheme
To enable Schema should be checked “Enable security test schema” checkbox. Refer to [5] more details
All changes made on this view will be applied after “OK” or “Apply” button click.
Group “Security parameters overrides” allows changing encryption parameters:
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 18 of 76
CONFIDENTIAL
Figure 6 Security Parameter overrides
Test Span – replaces current SPAN with specified value during data encryption
Test Sender Entropy Input S2 – replaces sender Entropy Input with specified value during data
encryption
Test Secret Key S2 – replaces current secret key of the S2 keypair. DSK value will be calculated
based on secret key.
Test Sequence Number S2 – replaces current Sequence Number with specified value during
data encryption
Test Reserved field S2 – replaces Reserved field with specified value during data encryption
Group “Message overrides” contains set of test frames with properties: “Command”, Delay, “Is
Encrypted”, “Is Multicast”, “Is Broadcast”, “Network Key” and “Is Temp Network Key”. Click
corresponding checkbox to activate parameter override and specify new value. If parameter override is
not active PC Controller will use valid specific frame parameter value. For example “KEXGet” is not
encrypted but KexGetEcho is encrypted if “IsEncrypted” parameter is not active.
Figure 7 Security Message overrides
Test Frame types:
KEXGet,
KEXReport,
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 19 of 76
CONFIDENTIAL
KEXSet,
PublicKeyReportB – joining node’s Public Key Report frame,
PublicKeyReportA – including controller’s Public Key Report frame,
KEXSetEcho,
KEXReportEcho,
NetworkKeyGet_S0,
NetworkKeyReport_S0,
NetworkKeyVerify_S0,
NetworkKeyGet_S2Unauthenticated,
NetworkKeyReport_S2 Unauthenticated,
NetworkKeyVerify_S2 Unauthenticated,
NetworkKeyGet_S2 Authenticated,
NetworkKeyReport_S2 Authenticated,
NetworkKeyVerify_S2 Authenticated,
NetworkKeyGet_S2Access,
NetworkKeyReport_S2 Access,
NetworkKeyVerify_S2 Access,
TransferEndA_S0 – including controller,
TransferEndA_S2Unauthenticated– including controller,
TransferEndA_S2Authenticated – including controller,
TransferEndA_S2 Access – including controller,
TransferEndB – joining node,
NonceGet,
NonceReport,
MessageEncapsulation,
CommandsSupportedReport,
InclusionInitiate1,
InclusionInitiate2,
InclusionComplete1,
InclusionComplete2.
Group “Extension overrides” table allows user to set custom extensions for any S2 Message
encapsulation. Message type filters: “SinglecastAll”, “SinglecastWithSpan”, “SinglecastWithMpan”,
“SinglecastWithMpanGrp”, “SinglecastWithMos” and “MulticastAll”. Extension type: “Span”, “Mpan”,
“MpanGrp”, “Mos” and “Test”. Other parameters: “Is Encrypted”, “Extension Length”, “More To
Follow”, “Is Critical” and “Number of usage” Click corresponding checkbox to activate parameter
override and specify new value. If parameter override is not active PC Controller will use valid specific
extension parameter value. For Example: Extension Length will be calculated based on Extension value
unless specific parameter value is activated.
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 20 of 76
CONFIDENTIAL
Figure 8 Security Extension overrides
Checkbox “Cleanup existing extensions first” overrides existing extensions in selected message type
when applying test extensions. When this checkbox is not set – test extension will be added to default
extensions.
4.1.2 Content View
The Content View consists of command buttons and one Information item:
Network Management
Command Classes
Encrypt/Decrypt
ERTT
Polling
Setup Route
Topology Map
Associations
IMA Network
Firmware Update (OTA)
Firmware Update (OTW)
Backup/Restore (NVM)
Configuration Parameters
UL Tool
Controller Information (active when controller is selected and active)
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 21 of 76
CONFIDENTIAL
Figure 9 Content View
Figure 10 Content View with Z/IP Controller connected
4.1.3 Log bar
Log bar contains information about last action and a Show Log button.
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 22 of 76
CONFIDENTIAL
Figure 11 Log bar view
Pressing Show Log button opens new window with brief information about action and its time.
Figure 12 Log window view
Menu item Description
Clear Clears log items
Auto Scroll Enable auto scroll
4.2 Network Management View
The Network Management View contains Node List and Node information for the selected node, Nodes
Actions and Controller Actions.
It is used for operations with nodes and basic controller actions.
If check ‘Floating View’ checkbox Network Management View will be shown in other window.
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 23 of 76
CONFIDENTIAL
Figure 13 Network Management View
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 24 of 76
CONFIDENTIAL
Figure 14 Network Management View with Z/IP controller connected
4.2.1 Node List View
Figure 15 Nodes View
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 25 of 76
CONFIDENTIAL
Uses for view and selecting Nodes, contains next columns:
o Id – shows the node numbers of all nodes in the network;
o Type – device type - shows description of the type of every node in the network;
o IL – checked if node is a listening node;
o QO – Queue override check box;
o IV – checked if node is a virtual node.
Current controller node is highlighted bold font
Button on bottom line is return ‘Network Management View’ from other views.
4.2.2 Node Information View
Figure 16 Node Information View
The Node Info section gives structured information about the selected node. For more information,
please refer to Z-Wave Device Class Specification documentation.
Button on top near header calls ‘Command Classes View’. Also ‘Command Classes View’ is possible to
by double click on item from Command Classes or Securely S0/S2 Supported Command Classes lists.
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 26 of 76
CONFIDENTIAL
4.2.3 Nodes Actions View
Figure 17 Nodes Actions View
Figure 18 Nodes Actions View when Z/IP controller connected
View contains all available actions for selected node. An action button is greyed out if current action
isn't available for selected node.
Additional buttons for Bridge Controller:
Figure 19 Bridge Controller additional actions
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 27 of 76
CONFIDENTIAL
Menu item Description
Add To Add a node
Remove To Remove a node
NWI
(Network Wide Inclusion)
Network Wide Inclusion, to include all nodes into network once
they have been reset and given power
NWE
(Network Wide Exclusion)
Network Wide Exclusion, to exclude all nodes from network
once they have been reset and given power
Add Virtual To add a virtual node for Bridge Controller
Remove Virtual To remove a virtual node from Bridge Controller
NOP
(Send NOP)
‘No Operation’ – to send a frame not carrying any functional
info to a node
Is Failed To send a Failure signal to a node
Replace failed To Replace a failed node
Remove Failed To Remove a failed node
Set SIS To set the “Set SIS” command to the selected Controller
Neighbor Update
(Request Node Neighbor
Update)
To get the neighbors from the specified node
Node Info To request Node information from a node
Version Get To send Version Get command to the selected node
Basic Set On Send the BASIC SET ON command to Switch a selected node(s)
ON
Basic Set Off Sends the BASIC SET OFF command to Switch a selected
node(s) OFF
Wake Up Interval To set up the Wake Up Interval for a non-listening node
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 28 of 76
CONFIDENTIAL
Switch All On To switch all nodes in the network ON
Switch All Off To switch all nodes in the network OFF
Start Basic Test/ Stop Basic Test To start and strop basic test functionality to the selected item
Node Settings Opens a pop-up with following actions for selected node ‘Reset
SPAN’, ‘Next SPAN’, ‘Security Scheme’
Reset SPAN Available under ’Node Settings’. Clears SPAN table for selected
node
Next SPAN Available under ’Node Settings’. Rolls SPAN record one time on
each click for selected node
Security Scheme Available under ’Node Settings’. Sets active security scheme for
selected node
4.2.4 Controller View
The Controller view includes Network Role Option, Controller Actions and Controller Information
sections.
The Controller view is used for operations with controllers.
Figure 20 Controller View
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 29 of 76
CONFIDENTIAL
Figure 21 Z/IP Controller view
Additional button for Bridge Controller:
Figure 22 Bridge Controller additional action
The Controller view has the following actions:
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 30 of 76
CONFIDENTIAL
Menu item Description
Learn Mode
(Start Learn Mode)
Starts learn mode for the controller if it is needed to include it in another
controller’s network
Slave Learn Mode Start slave learn mode for the bridge controller(secondary) to include virtual
node with the primary (inclusion) controller
Reset Resets a controller
Send Node Info Broadcast node info from controller
Set Node Info Change node information for controller
Shift Shift primary role to another controller in the network
Update
(Request Update)
An Inclusion controller can request network updates from a SIS
Mpan Table Modify existing Mpan table in PC Controller
Unsolicited Destination Get and set unsolicited destination for Z/IP Gateway
The Network Role Option section has controls to assign the role of the SC in the network:
SIS – Static Update Controller with ID server
None
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 31 of 76
CONFIDENTIAL
General information regarding the SC is displayed in the Controller Information section in the following
items:
Section Description
Controller ID Displays the node ID of the PC based SC
Controller Home ID Displays the current Home ID of the PC based SC
Controller Network
Role
Displays the PC based SC network role
Serial Port Displays the serial port in use.
Source Displays connection address (for Z/IP Controller)
DSK Displays DSK of current controller
Z/IP application
version
Displays current firmware version of Z/IP Gateway application
Set node Information View
Call from Controller View by clicking on ‘Set Node Info’ button opens new window ‘Set Node
Information’. On applying setting changes node information of the controller: list of the supported
command classes, device option, generic and specific device types.
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 32 of 76
CONFIDENTIAL
Figure 23 Set Node Information view
Menu item Description
Default Select default command classes according to specification
Clear Unselect all selected items
Device option To change device option of controller
Generic To change device generic type
Specific To change device specific type, sub item from generic
Mpan Table View
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 33 of 76
CONFIDENTIAL
Call from Controller View by clicking on ‘Mpan Table’ button opens new window ‘Mpan Table
configurations’. Group id, Owner id, MOS state, MPAN, Node ids list will be listed for each record in
table after pressing “Load MPANs” button.
Figure 24 Mpan table view
Buttons Description
Load MPANs Retrieves current state of Mpan table of PC Controller
Remove Removes the selected item from Mpan table
Clear Deletes all entries in Mpan table
Update Updates data in Mpan table for entered Group id and Owner id. If data
wasn’t present in table then new record will be created
Unsolicited destination
Call from Controller View by clicking on ‘Unsolicited Destination’ button opens new window ‘Z/IP
Unsolicited Destination’. Pressing “Set” button will update unsolicited destination address on Z/IP
Gateway and restart an unsolicited listener in PC Controller for selected port.
Figure 25 Unsolicited Destination view
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 34 of 76
CONFIDENTIAL
Button Description
Get current Retrieves current unsolicited destination address from Z/IP Gateway
Set Sends Unsolicited destination set command to Z/IP Gateway
Close Closes the window
Checkbox “Select from local addresses” triggers the “Unsolicited address” view from text input to drop
down list selector with list of all IP Addresses of current machine.
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 35 of 76
CONFIDENTIAL
4.3 Associations view
The Associations view has a Nodes List View, Node Information View and Association Actions View. It is
used to set up associations between nodes.
Figure 26 Associations view
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 36 of 76
CONFIDENTIAL
The Association Actions:
Menu item Description
Create Creates an association between selected nodes
Remove Removes selected association
Get Groups Info Return groups for selected node in association's tree view with
information about group’s Profile and group’s supported command
classes
Get Nodes Return nodes for selected group in association's tree view
The Associations View shows a tree of available source nodes that support the Association command
class, e.g. Binary sensor.
The Groups node shows the association groups that can be or have been created, information based on
Association Group Info command class and provides profile and supported command classes for each
group.
The “Assign Return Routes” checkbox is to define whether the Controller should assign return routes
together with setting the association.
4.4 Command Class view
The Command Class view is used to send a specified command class to a selected node with
parameters.
Command Classes View can be shown in separated window when Floating View is checked.
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 37 of 76
CONFIDENTIAL
Figure 27 Command Classes View
Command Classes View consists of following items:
1) Nodes and Node Info views (on the left)
2) Group of checkboxes for wrapping selected command with another (on the top)
3) Command selection view (in the middle, includes command class selection and send data text
box)
4) Sending mode radio buttons and control buttons (on the bottom)
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 38 of 76
CONFIDENTIAL
Item Description
CRC16 Wrap selected command with CRC16 command
Suppress Multicast Follow up Disables follow up Singlecast frames after multicast frame
Force Multicast Use multicast even if only one frame selected
Supervision Get Wrap selected command with Supervision command
Session Id Session Id will be present in Supervision encapsulated
command. Can be set manually or auto incremented by
enabling the ‘Auto increment’ checkbox
Multi Channel Enables multi-channel wrapping
End Point (Src) Set Source End Point when wrapping multi-channel is enabled
End Point (Dst) Set Destination End Point when wrapping multi-channel is
enabled
Bit Address Set Bit Address flag for Multi Channel Command
Command class Shows selected command class
Command To select command from selected Command Class and shows
selected command from ‘Select Command View’
Select Open ‘Select command’ view (fig. 26) to choose command.
Delay Sets ‘wake up no more information’ delay
Max bytes Sets max length in encrypted packet fragments
Transport service max segment size Sets Transport service max segment size
Send data Shows command which can be sent in HEX format string
Default Radio button to set security mode to default (Secure for
securely included nodes, non-secure for normally included
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 39 of 76
CONFIDENTIAL
nodes)
Secure Radio button to enable force secure commands sending
Non-secure Radio button to enable force non-secure commands sending
Node Info Gets node information from selected node
Send Button to send command to selected node
Reload XML Reloads XML from local machine if changes was made in it
The Select Command view is used to show and select all available command with info about for
selected node. Consist of:
List of Command classes and commands (on the left);
Information about selected command (on the right).
Figure 22 select command view
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 40 of 76
CONFIDENTIAL
Item Description
All Command Classes Allows to choose all command classes and not only supported by device
Ok Confirm selection
Cancel Close window without selection
4.5 Setup Route view
Setup Route View allows assigning or deleting routes between nodes.
Figure 28 Setup Route View
Setups in the top of view are change modes of assigning route
Source Node list(left) and Destination Node list(right) shows lists of source and destination nodes in a
routed network respectively.
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 41 of 76
CONFIDENTIAL
Item Description
Return Route Enables ‘Return Route’ mode
Priority Return Route Enable ‘Priority Return Route’ mode
SUC Return Route Enable ‘SUC Return Route’ mode
Priority SUC Return
Route
Enable ‘Priority SUC Return Route’ mode
Get/Set Priority Route Enable ‘Get/Set Priority Route’ mode
Priority Route Repeaters array from route
Route Speed Selects Route Speed
Get Priority Route Gets priority route for selected node
Set Priority Route Sets priority route for selected node
Assign Assigns routes via selected nodes
Delete Deletes assigned routes for selected node
4.6 ERTT View
ERTT (Enhanced Reliability Test Tool) View allows configuring test scenario and shows status of test
running.
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 42 of 76
CONFIDENTIAL
Figure 29 ERTT View
ERTT View itself consists of following items:
1) Nodes and Node Info views (on the left)
2) ERTT configuration view (in the middle)
Item Description
Test Iterations Repeats the test selected number of times
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 43 of 76
CONFIDENTIAL
Run forever Repeats the test infinite times with 100ms delay
between requests
Low power Send frames with low power when selected
Test Mode Sends basic set with selected value by radio buttons
TX Controlled by Module Enable TX mode to start test from device, only for
supported devices
Stop on Error Stops the test if error occurs
Start/Stop To start or stop running test
Retransmission When checked enables frame retransmission
4.7 Polling View
Polling View allows enabling polling for all available nodes in network.
Figure 30 Polling View
Item Description
Start button Run the Polling for all nodes in the list
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 44 of 76
CONFIDENTIAL
Stop button Stops the process
Edit buttons On list items allows to set Poll Time, sec. and
Report Time, sec parameters for polling
Done button Is used to finish editing parameters and exit Edit
mode
4.8 Topology Map View
View shows graphical representation of nodes network and access between.
Figure 31 Topology Map
The Topology Map view consists of:
The Graphical topology scheme itself,
Node Type Colors section,
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 45 of 76
CONFIDENTIAL
The Map
Item Description
Graphical topology
scheme
Graphically represents the network scheme, showing the nodes of all types
differentiated through colorization, and the link statuses between the
Installer controller and slave nodes.
Reload Topology To reload the topology
Node Type Colors
Node Type Colors is a list of node types with colors assigned for graphical representation on the
Topology Scheme. It is possible to select a special color for each node type.
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 46 of 76
CONFIDENTIAL
4.9 IMA Network View
The IMA Network view has a Network Actions View Nodes, Nodes View, IMA Details View and Network
Layout Properties View. Installation and Maintenance Application (IMA) is designed to perform analysis
of network health.
Figure 32 IMA Network View
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 47 of 76
CONFIDENTIAL
The Network Actions:
Menu item Description
Network Health Perform algorithm for gathering measurements to calculate Network
Health Value. These measurements are: RC, PER, NB, LWRdB, LWRRSSI
Request Node Info Send Node info get command
Get Version Send Version get command
Ping Node(s) Send NOP command and waits for Ack from the node
Reload Routing Info Execute Get routing info command and rebuilds neighbors list
Rediscovery Send Get Nodes In Range command
Src / Dest Specify source and destination node for commands with source and
destination arguments
Power Level Test Performs power level test (only for selected nodes Src and Dest)
The Nodes View shows the nodes in the network and controller. Also, neighbor’s connections of
selected node and, after the Network health completed the connections between nodes. Each node can
be moved on canvas. Multiple nodes can be selected.
To move the canvas use ALT + drag.
To zoom in/out the canvas use CTRL + scroll.
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 48 of 76
CONFIDENTIAL
The IMA Details View contains detailed information about each step of Network Health algorithm.
Empty entries show that such measurement can’t be calculated for selected node.
Menu item Description
Details Shows the list of recommended actions according to the Network Health
status. See figure 20
Legend Opens popup window with information about the measurements. See
figure 21
Figure 33 IMA Network Health status description (Details)
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 49 of 76
CONFIDENTIAL
Figure 34 IMA Network Health Value description (Legend)
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 50 of 76
CONFIDENTIAL
The Network Layout Properties View allows changing the view of the Nodes, its scale and background.
Figure 35 IMA Nodes View description (Legend)
Menu item Description
Zoom Changes the scale of the canvas
Image Opens a dialog window to choose the picture background for the canvas
Fill A color of filling can be chosen when the checkbox is activated
Legend Opens popup window with information about the elements shown on
Nodes View. See figure 21
4.10 Encrypt/Decrypt View
Encrypt/Decrypt Message View allows to either Encrypt or Decrypt message.
S0 Tab to use Security S0 encrypt algorithms
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 51 of 76
CONFIDENTIAL
Figure 36 Encrypt/Decrypt View S0 Tab
Encrypt/Decrypt View itself consist of Encrypt/Decrypt view.
Item Description
Use Current Insert current network key to field from security scheme
Decrypt Decrypts the message set in Encrypted message with parameters from
input fields
Encrypt Encrypts the message set in Decrypted message with parameters from
input fields
S2 Tab to use Security S2 encrypt algorithms
Figure 37 Encrypt/Decrypt View S2 Tab
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 52 of 76
CONFIDENTIAL
Item Description
Decrypt Decrypts the message set in Encrypted message with parameters from input
fields
Encrypt Encrypts the message set in Decrypted message with parameters from input
fields
4.11 Firmware Update (OTA) View
Firmware Update (Over the Air) View provides functionality to update devices over the air.
Figure 38 Firmware Update (OTA) View
Firmware Update View itself consists of following items:
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 53 of 76
CONFIDENTIAL
Nodes and Node Info views (on the left)
Firmware configuration view (in the middle)
Item Description
Get Gets the information about current firmware of selected node
File selection Allows to select file with .hex or any other extension
Update Starts the update process on selected node
Activate Sends Firmware Update Activation Set command to start delayed
activation process. Button available only for Firmware Update MD
Command Class version 4.
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 54 of 76
CONFIDENTIAL
4.12 Firmware Update (OTW) View
Firmware Update (Over the Wire) View provides functionality to update devices that are connected to
PC. It opens file dialog window to choose the update file.
Figure 39 File Dialog View
4.13 Backup/Restore NVM
NVM (Non-volatile Memory) Backup/Restore View provides functionality to save and upload non-
volatile memory content of device.
Figure 29 NVM Backup/restore View
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 55 of 76
CONFIDENTIAL
Item Description
… (Save As) Select destination file to save data
Backup Start backup to file
… (Open) Select source file of NMV
Restore Start restore file to device
4.14 Configuration Parameters
Configuration Parameters View to manage node settings using Configuration Command Class
Figure 40 Configuration Parameters View
Item Description
Get List Gets list of configuration parameters for selected controller
Set To set configuration parameters
4.15 Smart Start View
Smart Start View contains provisioning list of DSKs provided by PC Controller and gives the possibility to
manage it.
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 56 of 76
CONFIDENTIAL
Figure 41 Smart Start View
Figure 42 Z/IP Controller connected Smart Start View
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 57 of 76
CONFIDENTIAL
Item Description
Get Gets the Included Node Information Frame
Set Sets the Included Node Information Frame
Refresh List Reload provisioning list
Add Add new DSK to provisioning list
Remove Remove selected DSK from provisioning list
Remove All Clear provisioning list
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 58 of 76
CONFIDENTIAL
5 FUNCTIONALITY
For each SC in the network, a separate instance of the PC based Controller application must be started.
Note: for correct behavior of Z/IP Gateway as SIS in network and for support of Inclusion controller
command class remember to set up unsolicited destination, see section 4.2.4.
The SC can be configured to one of the following controller types:
Primary SC
Secondary SC
Primary SC with SUC and node ID Server functionality (SIS)
Inclusion SC
Primary SC
When configured as primary the SC can be used to include/exclude nodes in the Z-Wave network. The
primary SC will automatically update a SUC if present in the Z-Wave network. Only one primary
controller is allowed in the Z-Wave network.
Secondary SC
When configured as secondary, the SC cannot include/exclude nodes in the Z-Wave network. Several
secondary controllers are allowed in the Z-Wave network.
Primary SC with SUC and node ID Server functionality (SIS)
The SIS enables other controllers to include/exclude nodes in the network on its behalf. The SIS is the
primary controller in the network because it has the latest update of the network topology and
capability to include/exclude nodes in the network. When including additional controllers to the
network they become inclusion controllers because they have the capability to include/exclude nodes
in the network on behalf of the SIS. The SIS cannot shift its primary role to other controllers in the
network.
To read more about SIS functionality, see reference [3].
Inclusion SC
The inclusion SC has the capability to include/exclude nodes in the network on behalf of the SIS. The
inclusion SC’s network topology is dated from last time a node was included or it requested a network
update from the SIS and therefore it can’t be classified as a primary controller.
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 59 of 76
CONFIDENTIAL
5.1 The SC Properties
Depending on functionality required in the network, the PC based Controller (SC and BC) can shift role
to obtain the wanted functionality.
Primary
If the SC is the first node in a network it will automatically be configured to act as primary.
Secondary
If the SC is not the first node in a network it will automatically be configured to act as secondary.
SIS
It is possible to set the Network Role Option by pressing Set as SIS command.
The table below shows which functionality is available for the PC based SC depending on the
configuration on the controller.
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 60 of 76
CONFIDENTIAL
Table 1 Overview of the Static Controller properties
Primary Inclusion SIS Secondary
Node:
Add Node X X X -
Add Node with DSK X X X -
Remove Node X X X -
Network Wide Inclusion X X X -
Network Wide Exclusion X X X -
NOP X X X X
Mark Node as Failed X X X X
Replace Failed Node X X X -
Remove Failed Node X X X -
Set as SIS X X X -
Neighbours Update X X X X
Request Node Info X X X X
Basic Set On X X X X
Basic Set Off X X X X
Set wake Up Interval X - - -
Switch All On X X X X
Switch All Off X X X X
Toggle Basic Get X X X X
Change Security Scheme X X X X
Reset SPAN X X X X
Controller:
Receive Information X X - X
Send Information X X X -
Create New Primary - - - -
Controller Shift X - - -
Reset Controller X X X X
Request Update - X - X
Set Node Information X X X X
Command Class:
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 61 of 76
CONFIDENTIAL
Send X X X X
Association:
Create Association X X X X
Remove Association X X X X
Get Associations X X X X
Setup Route:
Assign Route X X X X
Delete Route X X X X
Get Priority Route X X X X
Set Priority Route X X X X
General:
All On X X X X
All Off X X X X
Abort X X X X
OTA Firmware Update X X X X
OTA Firmware Update X X X X
IMA Network X X X X
NWM Backup/Restore X X X X
Configure Parameters X X X X
Smart Start X X X -
5.2 Node View
5.2.1 How to add a node
PC based SC is Primary / Inclusion / SIS
In order to add a node to the Z-Wave network, activate the button ‘Add’ on 'Network Management'
view. When activating this button, the Status popup message will display ‘Press shortly the pushbutton
on the node to be included in the network’. Select the node that should be added to Z-Wave network
by activating the node’s button. During the inclusion process, the node must be located at its final
position, so that it can obtain the correct neighbours within its range. If the operation was successful,
information regarding the node type will be displayed in the node list. The PC based controller reduces
the RF output power during the inclusion process which can cause range problems because it is static,
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 62 of 76
CONFIDENTIAL
i.e. located in a fixed position. It is therefore recommended to use a portable controller as primary for
adding new nodes to the Z-Wave network.
Note: for correct behavior of Z/IP Gateway as SIS in network and for support of Inclusion controller
command class remember to set up unsolicited destination, see section 4.2.4.
Figure 43 Popup message after pressing 'Add' button
A secure S2 node asks for network keys during inclusion. PC Controller application shows dialog:
Figure 44 Network keys request
Secure inclusion flow will be cancelled if user press Cancel button. Node will be included non-securely.
Device Specific Key (DSK) may be required during a secure S2 node inclusion. PC Controller application
shows dialog:
Figure 45 Enter DSK Dialog
Secure inclusion flow will be cancelled if user press Cancel button. Node will be included non-securely.
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 63 of 76
CONFIDENTIAL
PC based Controller is Secondary
It is not possible to add nodes to the Z-Wave network.
5.2.2 How to add MultiChannel Node with EndPoints
The process of inclusion a MultiChannel node is the same as for other nodes. When adding the node
with supported command class Multi Channel PC Controller will additionally ask End Points list and
capability for each.
Figure 46 Multi Channel Node with End Points View
5.2.3 How to remove a node
PC based SC is Primary / Inclusion / SIS
To remove a node from the Z-Wave network, select the node in the node list and activate the button
‘Remove’. After activating the button the Status popup message will display ‘Press shortly the
pushbutton on the node to be excluded from the network’. If this operation was completed
successfully, the node and its information will now be removed from the node list. The PC based
Controller reduces RF output power during the exclusion process which can cause range problems
because it is static, i.e. located in a fixed position. It is therefore recommended to use a portable
controller as primary to remove a node when having range problems.
Figure 47 Popup message after pressing 'Remove' button
PC based Controller is Secondary
It is not possible to remove nodes from the Z-Wave network.
5.2.4 Network Wide Inclusion
The NWI button on the PC Controller results in the PC Controller calling AddNodeToNetwork, and after
a successful inclusion, the AddNodeToNetwork is called again.
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 64 of 76
CONFIDENTIAL
To start the process of mass inclusion of nodes to the controller, press the Network Wide Inclusion
button. The dialog will appear carrying the text: “Controller is waiting for the node information… Press
shortly the pushbutton on the node to be included in the network.”
Once all nodes have been included, press the ‘Abort Operation’ button to stop NWI
5.2.5 Network Wide Exclusion
Pressing NWE button on the PC Controller call RemoveNodeFormNetwork, and after a successful
exclusion, the RemoveNodeFormNetwork is called again.
To start Network Wide Exclusion nodes from the controller, press the NEW button and shortly press the
pushbutton on each node to exclude it.
5.2.6 Send NOP
This button is used to send a NOP frame to a selected node. Enter the Node ID of the target node in the
text box and press the ‘NOP’ button.
5.2.7 How to send a failure signal to a node
If a node is corrupt and does not respond to commands, it can be marked as failed, and then either
replaced or removed.
Push “Is Failed” button for the selected node. The node will be marked in the list as failed (with red
typing).
5.2.8 How to replace a failed node
PC based SC is Primary / Inclusion / SIS
A non-responding node can be replaced by another node from the node list in the Z-Wave network by
activating the button ‘Replace Failed’. The following message will appear: “Replacing the non-
responding node… Press shortly the pushbutton on the replacement node to be used instead of the
failed one”. If the operation was successful, the failed node is removed and the other node will take the
node ID of the failed node. Association setup in the failed node will be lost and must be reprogrammed.
PC based SC is Secondary
It is not possible to replace a failing node.
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 65 of 76
CONFIDENTIAL
5.2.9 How to remove a failing node
PC based SC is Primary / Inclusion / SIS
A non-responding node can be removed from the Z-Wave network by activating the button ‘Remove
Failed’. If the operation was successful, the node and its information will be removed from the node list.
Responding nodes cannot be removed.
PC based SC is Secondary
It is not possible to remove a failed node.
5.2.10 Set SIS
It is possible to assign SIS network role to the selected controller by sending CmdZWaveSetSucNodeId
to it. To perform this operation press on 'Set as SIS' button on the 'Network Management View'.
It is possible to set only one SIS in the network in other case the PC Controller will show a warning
Figure 48 Set SIS Warning Message
5.2.11 Request Node Neighbours Update
It is possible to send the Find Nodes in Range command to the selected node.
5.2.12 Node Info
When the Node Info button is pressed, the PC Controller application sends a REQUEST NODE INFO
command to the selected node.
For MultiChannel nodes the application will update End Points list and capability for each.
5.2.13 Version Get
Send Version Get command to the selected node(s).
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 66 of 76
CONFIDENTIAL
5.2.14 Switching a node or a subset of nodes on and off
Basic Set On
Activate the button ‘On’ to send the ‘On’ command to the selected node(s).
Basic Set Off
Activate the button ‘Off’ to send the ‘Off’ command to the selected node(s).
5.2.15 Set Wake-Up Interval
It is possible to set the wake up interval for a non-listening node. Enter the desired wake up interval (in
minutes) into the textbox, and press the ‘Set Wake Up Interval’ button. The WAKE UP INTERVAL SET
command will be queued in the application memory and sent to the non-listening node the next time it
wakes up.
5.2.16 ‘Switch All On’ command
In order to send an ‘All on’ command to all nodes in the Z-Wave network, press the button ‘Switch All
On’.
5.2.17 ‘Switch All Off’ command
In order to send an ‘All off’ command to all nodes in the Z-Wave network: press the button ‘Switch All
Off’.
5.2.18 Start/Stop Basic Test
This option is for stress test purposes. When the ‘Start Basic Test’ button is presses, the PC Controller
consequently sends a BASIC GET command to the selected node(s). After a BASIC REPORT is received
from the node in queue, the next BASIC GET command is sent either to the same node (if it is the only
node selected for operation), or to the next node in the list. If the node does not respond, the controller
sends the next command or moves to the next node after a timeout of 10 seconds.
Security settings contains following actions:
5.2.19 Reset SPAN
To clear Singlecast Pre-Agreed Nonce table for selected node.
5.2.20 Next SPAN
To roll Singlecast Pre-Agreed Nonce entry for selected node.
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 67 of 76
CONFIDENTIAL
5.2.21 Security Scheme
Controller can change the security scheme for communication with selected node.
Figure 49 Select Security Scheme Dialog
5.3 Controller View
When including a PC based SC to a network, activate the ‘Add’ button on the primary controller, and
then activate the ‘Learn Mode’ button on the second PC based SC (the sequence of these two steps is
not vital). This will include the SC into the Z-Wave network and transfer the complete network
topology. Further it is possible to update the network topology in an existing secondary controller.
If the replication went successfully, then the second PC based SC’s functionality depends on the
selected option button:
If ‘SIS’ has been chosen, and there does not already exist one in the network, the SC will become the SIS
in the network. If a SIS is already present, the SC will become an Inclusion controller.
If ‘None’ has been chosen, then SC will become a secondary or inclusion controller.
PC based SC is Inclusion / SIS / Secondary
It is not possible to shift primary role from the PC based SC.
5.3.1 Reset controller
To reset the PC based SC, activate the ‘Reset’ button. See also paragraph 5.2.3 regarding how to
exclude nodes from the network.
5.3.2 Send Node Info
Send broadcast node info from controller.
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 68 of 76
CONFIDENTIAL
5.3.3 Set Node Info
To change Node Information of the Controller: supported command classes, device option and generic
and specific device type.
5.3.4 Controller shift
PC based SC is Primary
To shift the primary role from the PC based SC to another controller in the network; activate the ‘Learn
Mode’ button within the controller to be made primary, and the ‘Shift’ button within the second
controller interface. The second PC based SC will now become Secondary, whilst the first one will
become Primary.
5.3.5 Request update of PC based SC
PC based SC is Primary / SIS / Secondary
It is not possible to request network topology update from another controller.
PC based SC is Inclusion
The PC based SC can request network topology updates from a SIS by pressing the ‘Update’ button.
5.4 Command Class View
Open the 'Command Class ' view to send specific command classes to nodes.
Select the node ID to receive the command from the node list.
To select a command class and command click on button ’Select’. ‘Select Command’ view will only
contain those commands that are supported by the selected nodes, however it is possible to show all
command classes by enabling of ‘All Command Classes’ check-box. Some commands require setting a
value, e.g. Value. In such case additional value fields will appear below with their names. All selected
and entered values will be shown in HEX string in Send Data text block. This text block allows changing
manually Send data to send.
Finally, send the frame by activating the button ‘Send’.
5.5 Association View
Open the 'Associations' view to configure associations between nodes.
Add any nodes that support the Association command class, e.g. Binary sensor.
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 69 of 76
CONFIDENTIAL
To view current association groups of selected node press button 'Get Groups Info'. To get all the nodes
in selected group press 'Get Nodes' button..
5.5.1 Create Association
Select the node you want to associate with the node that supports the Association command class,
Select Group, and push the ‘Create’ button. The node ID will appear in the appropriate group.
5.5.2 Remove Association
Select the node to be removed from the association in the Groups list, and press ‘Remove’.
5.6 Setup Route View
Open the ‘Setup Route' view to assign return routes between two nodes in the network.
5.6.1 Assign a route
The PC based SC supports assignment of a route between e.g. a Binary Sensor and any other node.
Assigning a route specifies how the binary sensor can communicate with the node. To assign a route
select first a source and a destination node. The source node could be any node based on the routing
slave library while destination node could be any node that is always in listening mode. Activate ‘Assign’
button to generate a route between the two nodes. For a binary battery sensor, the route assignment
will be executed when it wake up next time. Until then, the request is queued in the PC based
Controller.
5.6.2 Delete a route
To delete the routes in a node, press the ‘Delete’ button. All routes assigned to the source node will be
deleted. The new routing can be built either automatically or manually.
For a binary battery sensor, the route deletion will be executed when it wakes up next time. Until then,
the request is queued in the PC based Controller.
5.7 Security Test Schema View
In Z-Wave Security PC Controller, Security Test Schema functionality is available for the purposes of
testing secure networks for failures in case of device malfunctioning with using Security or Security
version 2 Command Classes.
With this feature, it is possible to simulate different malfunctions of a Security PC Controller. This is
needed to test proper functioning of other devices in the network.
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 70 of 76
CONFIDENTIAL
To use this feature, the “Enable Security Test Schema” checkbox must be checked.
'Use Permanent Network Key' checkbox allows overriding generated by controller Network Key. It will
use specified Network Key for all operations after pressing “OK” or “Apply” button.
The testing Controller in Security version 0 can be configured either as the Including Controller, or as
the Included Node. The corresponding options for an Including Controller or Included Node are present
dependent on the selection. All changes will be applied after pressing “OK” or “Apply” button.
The testing Controller in Security version 2 can be configured by using security parameters, messages
and extensions overrides. All changes will be applied after pressing “OK” or “Apply” button.
Save Security Keys to Storage is used to generate file with network keys to load it from Zniffer
Application.
5.7.1 Test S2 Parameters overrides
“Test Span S2” field is used to encrypt S2 Message Encapsulation with specific SPAN. It will ignore
Receivers Entropy input that is sent with S2 Nonce Report.
“Test Sender Entropy Input S2” field is used to substitute SPAN extension value in S2 Message
Encapsulation in response to S2 Nonce Report is sent.
“Test Secret Key S2” – replaces current secret key of the S2 keypair. DSK value will be calculated based
on secret key.
“Test Sequence Number S2” is used to override S2 Message Encapsulation’s Sequence Number
property with specific value.
“Test Reserved field S2” is used to override S2 Message Encapsulation’s Reserved property with specific
value.
5.7.2 Test S2 Messages overrides
“Test Frame” list contains all frames that are normally sent during S2 inclusion. Therefore user is
allowed interfering inclusion process with custom frames. Click corresponding checkbox to activate
parameter override and specify new value. If parameter override is not active PC Controller will use
valid specific frame parameter value.
“Command” field is used to substitute selected “Test Frame” with any command that is entered.
When enabled “Delay” field it will postpone sending selected “Test Frame” for specified amount of
time.
“Is Multicast” field allows to send “Test Frame” as multicast or singlecast.
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 71 of 76
CONFIDENTIAL
“Is Broadcast” field allows to send “Test Frame” as broadcast or singlecast.
“Is Encrypted” checkbox allows to force send frame encrypted or force send message unencrypted.
“Network Key” field is used to encrypt selected “Test Frame” with specified bytes. It will only be used if
‘Is Encrypted’ checkbox is enabled and set.
“Is Temp Network Key” field is used to encrypt selected “Test Frame” using temporary expansion
algorithm. It will only be used if ‘Is Encrypted’ checkbox is enabled and set. It will also use “Network
Key” value as a security key to obtain temporary key.
Example 1: User wants to substitute KEX Report (Echo) with KEX Report frame that is unencrypted,
delayed for 2 seconds and with Echo flag set to 0.
KEX Report (Echo) test frame should be configured on including controller. Following screenshot shows
all necessary properties that should be set.
Figure 50 Test frame configuration for Example 1
Example 2: User wants to substitute “Network Key Verify S2 Unauthenticated” frame which will not be
delayed, command will be used default but should be encrypted with custom temporary key.
Network Key Verify test frame should be configured on joining controller. Following screenshot shows
all necessary properties that should be set.
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 72 of 76
CONFIDENTIAL
Figure 51 Test frame configuration for Example 2
5.7.3 Test S2 Message Encapsulation extensions overrides
“Clean up existing extensions first” checkbox is used to delete all default extensions that should be
added in normal flow. Note: this will take effect even if no test extension is specified deleting all
extensions of S2 messages.
Message type allows to filters S2 message encapsulation frame which extensions will be changed:
Type “Singlecast All” means all S2 message encapsulation singlecast frames.
Type “Singlecast with SPAN” means all S2 message encapsulation singlecast frames containing
SPAN extension.
Type “Singlecast with MPAN” means all S2 message encapsulation singlecast frames containing
MPAN extension.
Type “Singlecast with MPAN Group” means all S2 message encapsulation singlecast frames
containing MGRP extension.
Type “Singlecast with MOS” means all S2 message encapsulation singlecast frames containing
MOS extension.
Type “Multicast All” means all S2 message encapsulation multicast frames.
Extension type allows select specific extension to add to the filtered S2 message encapsulation frame:
SPAN,
MPAN,
MGRP (MPAN Group),
Test (value=FF).
Applied Action value is significances how to apply set test extension to next message encapsulation and
contains next:
“Add” – add predefined extension, even if extension was not added by application;
“Add Or Modify” – remove extension filtered by extension type if it was add by application, add
predefined extension;
“Modify If Exists” – replace extension filtered by extension type with predefined only if it was
added by application;
“Delete” – remove extensions which are matches to filter item if it was added by application.
Extension length is auto-calculated field.
Extension value allows specifying extension data.
Click corresponding checkbox to activate parameter override and specify new value. If parameter
override is not active PC Controller will use valid specific extension parameter value.
Extension parameters:
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 73 of 76
CONFIDENTIAL
“Is Encrypted” option allows to override selected extension encryption.
“More to follow” option allows change “more to follow” parameter of the selected extension if
activated.
“Is Critical” option allows change “Critical” parameter of the selected extension if activated.
“Number of usage” option allows limit number of filtered S2 message encapsulation frames. After you
add extension with number of usage active counter will be “0 of N”. To reset counter select frame and
click button “Set”. Remember to click “OK” or “Apply” to make new test settings active.
Examples: 1. Filter message with SPAN extension by message type <Singlecast With SPAN>
a. Put override <Add>, < SPAN > extension type, <NEWSPAN> value – Resulting message with SPAN and <NEWSPAN>;
b. Put override <Add Or Modify>, <SPAN> extension type, <NEWSPAN> value – Resulting message with <NEWSPAN>
c. Put override <Modify If Exists>, < SPAN> extension type, <NEWSPAN> value – Resulting message with <NEWSPAN>, if needed SPAN synchronization;
d. Put override <Delete>, < SPAN> extension type – Resulting message without any <SPAN> extension, extension added by application can exists
2. Filter message with MPAN by message type <Singlecast With MPAN> and that message
doesn’t have SPAN a. Put override <Add>, < MPAN > extension type, <NEWMPAN> value – Resulting
message with MPAN and <NEWSPAN>; b. Put override <Add Or Modify>, <MPAN> extension type, <NEWMPAN> value –
Resulting message with MPAN and <NEWSPAN>; c. Put override <Modify If Exists>, < MPAN> extension type, <NEWMPAN> value –
Resulting message with NEWMPAN; d. Put override <Delete>, < SPAN> extension type – Resulting message without any
MPAN extension, extension added by application can exists
5.8 ERTT View
The ERTT (Enhanced Reliability Test Tool) is used to test the reliability of an RF link by sending a defined
number of frames and
performing a simple count on how many frames where not received correctly.
A DUT node must be included to the network first. Then, select the DUT in the node list of the PC
Controller, and configure the ERTT.
The following controls are available:
Test Iterations – enter the required number of iterations.
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 74 of 76
CONFIDENTIAL
Run forever – check this box for the test to run until stopped.
Test Mode – select the data format to be used in the test (Basic Set, value 0; Basic Set, value 255; Basic
Set, value 0/255).
Stop on error – check this box for the test to stop on an error.
Low Power – check this box to use low power RF transmission.
TX Control – an optional group of controls which is active only if SerialAPI reports support for (#define
FUNC_ID_SERIAL_API_TEST 0x95):
TX is Controlled by module – If ticked, ZW_Test is used instead of SendData, and the module is
informed to send the specified command the defined amount of times. If checked, the
following fields must become available:
o TX Delay Field: Define delay between each transmitted frame
o Payload length field
Retransmission - if not ticked, send data will be called with TRANSMIT_OPTION_NO_RETRANSMIT =
0x40.
Packets sent: shows the numbers of sent packets.
Packets received: shows the number of reply packets received from the node.
UART Errors: shows the number of UART errors. These errors are logged when the Serial API returns
transmit completion status TRANSMIT_COMPLETE_FAIL (0x06).
The UART error is a count of packages not sent to the other Z-Wave device on air traffic. Z-Wave does
listen before talk to avoid interference with undergoing communication. So if the Z-Wave protocol "is
listening" to Z-Wave air traffic, it will not send the package. Normally the Z-Wave protocol will
automatically do a random back off and re-try communication. But the ERTT is a special version and will
not do the random back-off. The ERTT will therefore have a higher count of non-transmitted packages.
When calculating the Frame Error Rate (FER), the UART error must be subtracted from the Packets sent
to obtain the number of Packets transmitted:
Packets transmitted = Packets sent – UART Errors
FER = (Errors/Packets transmitted)*100 (%)
Node list grid: displays information about the nodes which ERTT communicates with:
Node ID
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 75 of 76
CONFIDENTIAL
Device type
Status – current transmit completion status for the node. 0 stands for
TRANSMIT_COMPLETE_OK. For other transmit statuses, see [2].
Errors – the total number of errors (all transmit completion statuses different from
TRANSMIT_COMPLETE_OK).
5.9 Polling View
Polling is an infinite process for sending Basic Get command to each node in the list with the interval
‘Poll Time, sec’ after the last polling command was sent and ‘Report Time, sec’ before Ack received and
before sending to next node. To perform Polling the ‘Poll Time, sec’ should be set for the needed nodes
and to start press button ‘Start’. To stop the process press button ‘Stop’.
‘Requests’ column shows the number of iterations for specific node.
‘Failure’ shows the number of failed transmits.
‘Missing Report’ shows the number of requests without reports.
‘Max Command Time, ms’ shows the maximum delay in sending Basic Get command and receiving
callback.
5.10 Topology Map View
The small squares on the sides of the graphic map use the color codes shown in the Node type Colors
area.
The larger squares indicate the state of link between two units. Blue squares indicate that the link
between two nodes exist, red squares indicates that the link does not exist and white squares indicate
that no link can exist. Note that the table always will be symmetrical around the white line.
The “Reload” button loads the Topology map from the Z-Wave module. This is not done during startup
because of the time it takes when the Z-Wave module holds a large network setup.
5.11 IMA Network View
Open the 'IMA Network’ view to perform analysis of network health. Add any listening node to start
execution of the algorithm.
The selection works as follows:
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 76 of 76
CONFIDENTIAL
If no node selected:
1) Nodes range = all nodes except non-listening and controller itself.
2) If nodes range is empty do nothing
If one or many nodes selected:
1) Nodes range = selected nodes except non-listening and controller itself.
2) If nodes range is empty, range = all nodes except non-listening and controller itself.
3) If nodes range is empty do nothing.
For Non-listening nodes it is possible to set “Queue overridden” check mark in the node list view, then
node will be considered as listening.
5.11.1 Network Health
Starts network health algorithm. This is a time consuming process and can be aborted. After the process
is finished the Last Working Route for each node will be shown, Network Health Status will be displayed
on each node. The iteration information is shown on the right side of the view.
5.11.2 Power Level Test
To perform the test, make sure that the selected nodes, marked as Source (Src) and Destination (Dest)
support power level command class. The test will be started from -9 dB reduction and continue to lower
reduction until the report is received with OK status.
5.12 Security Encrypt/Decrypt
In case of Security (tab S0) enter External Nonce, Internal Nonce, and Security Key. Then put the
encrypted message and click the “Decrypt” button or enter the decrypted message and press the
Encrypt button. The outcome will be presented in the corresponding field.
For Security version 2 (tab S2) it is needed to fill all fields including network key entered manually.
Select key extract algorithm. After enter a message to corresponding field and click ‘Decrypt’ or
‘Encrypt’ according to case.
Example of the S2 encapsulated message decryption using temp key:
After including node PC Controller displays last used temp key at the Security Settings view:
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 77 of 76
CONFIDENTIAL
Figure 52 Last Used Temp Key
Choose S2 Message encapsulation frame from the Z-Wave PC Zniffer:
Figure 53 S2 Message Encapsulation frame
Fill all fields in the S2 Encrypt/Decrypt tab
Home Id = EC 2E CF D0
Sender Id = 04
Receiver Id = 01
Sequence Number = 6D (look in the frame details of the selected S2 Message Encapsulation
frame)
Generations = 1 (first frame after S2 synchronization, you may specify range 1..N)
Receiver Nonce = 45 D7 23 53 64 1E 5D 76 76 92 29 AF F4 65 B0 CD (look NonceReport frame
from receiver to source which was used for S2 synchronization)
Sender Nonce = 73 35 2F 2C 32 B0 3E 93 84 EC 37 C7 85 1C 02 40 (look in the frame details of
the first S2 Message Encapsulation frame after synchronization with SPAN extension, this is
selected frame in our example)
Security Key - 08 7A B4 94 18 E3 B9 2C 69 67 3A 33 D0 9C 92 8F (last used temp key after node
inclusion)
Key Extract algorithm – Temp
Encrypted message - 9F 03 6D 01 12 41 73 35 2F 2C 32 B0 3E 93 84 EC 37 C7 85 1C 02 40 9B B4
52 12 38 43 76 3F A4 13 0B 68 DD 9E (look in the hex data of the selected frame, starting from
9F 03 to end of frame without checksum bytes. Selected frame has 2 bytes checksum).
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 78 of 76
CONFIDENTIAL
Figure 54 S2 Message Encapsulation frame hex data
After enter a message to corresponding field and click ‘Decrypt’
Original message command - 9F 06 01 02 01 81
Figure 55 S2 Message Encapsulation frame decrypt
5.13 Firmware Update
If the device supports the Firmware Update Meta Data command class, it is possible to use this feature
to update its firmware over the air.
Current firmware ID and manufacturer ID of the device can be checked. Press the 'Get' button to send
Firmware MD Get command to the device.
New firmware file can be uploaded through selecting the file and pressing the 'Update' button.
If the update needs to be delayed, the ‘Activation’ checkbox should be checked before pressing the
‘Update’ button. After the process is finished, the ‘Activate’ button should be pressed to send Firmware
Update Activation Set command and start local update process on the device. This functionality is
available only for Firmware Update MD Command Class version 4.
5.14 NVM Backup/Restore
This is functionality to save and upload non-volatile memory content of device.
Buttons with label ‘…’ are used to create or select hex-file for device data.
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 79 of 76
CONFIDENTIAL
Press ‘Backup’ to copy content of device non-volatile memory to selected file. File will be auto created if
it does not exist. Backup file can be either saved in ‘.zip’ format or ‘.hex’. Compressed ‘.zip’ file contains
additional information from PC Controller, such as Security keys.
‘Restore’ will write data from file to device.
Note: When restoring from backup file which is ‘.hex’ format then it will only restore device’s memory.
To backup Security keys and other additional information including all non-listening nodes (for example
Sensor PIR) Wake Up interval settings use ‘.zip’ format file.
5.15 Configuration Parameters
The Devices Configurations view realizes the Configuration Command Class which allows product
specific configuration parameters to be changed. One example could be the default dimming rate of a
light dimmer.
Configuration parameters MUST be specified in the product documentation. Configuration parameters
accessed via this command class MUST NOT replace similar commands provided by other existing
Command Classes.
A device MUST be able to operate with default factory configuration parameter values.
5.16 Smart Start
PC Controller provides Z-Wave Smart Start functionality which ensures that S2 network keys are not
handled out to an attacker. In the ‘Smart Start’ view possible to add new or view existing DSK to allow
inclusion of devices with Security S2 without user’s participation.
Smart Start contains Device Specific Key (DSK) list – the Provisioning List. During inclusion with Security
S2 the PC Controller selects required key. In case of successful security inclusion used item from list will
be marked with included Node Id and never used again until device reset or removed from the network.
Items can be removed from list, but if selected DSK corresponds to added node user will be notified
that device will stays in the network and is needed to remove manually by next popup:
Figure 56 Provisioning list item delete popup
PC Controller reacts on device reset event removes node from nodes list and drop link with current DSK
in the provisioning list. User may choose to delete item from list or not:
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 80 of 76
CONFIDENTIAL
Figure 57 Smart Start added Device Locally Reset popup
5.17 Z-Wave PC Controller Log
Allow to show application action log in the single view. Log contains all received and requested
messages in controller in readable for user form. Also log writes info about application work e.g.
successfully connection or errors in settings. To clear log window press button Clear, and auto scroll to
enable scrolling of log items list.
5.18 Settings Trace Capturing
It is possible to enable capturing of communication trace in settings view. This functionality allows
saving sent and received messages of device to file in capture folder. Path to folder can be changed by
user, but name of file will be auto-generated by app and consist from ZWaveControllerDump, com port
name and .ZWLF extension, e.g. ZWaveControllerDump_COM1.zwlf.
The Auto split possibility will separate capture file on parts by size or/and duration. Name of these will
be the same as main file of trace plus date time of saving. Keep last files controls count of temp files
(parts) in a system. All separated parts are saves in capture folder.
5.18.1 Open saved capture trace file
Saved capture trace file can be converted to readable format using any external script
Example of Powershell script:
##################################################
#
# Script for reading zwlf trace capture file
#
##################################################
#take trace file from arguments
$FILENAME=$args
$pos=0
function ReadHeader([IO.BinaryReader] $bReader)
{
$header = $bReader.ReadBytes(2048)
$i = 0
While ($i -lt 64)
{
$j = 0
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 81 of 76
CONFIDENTIAL
$outStr = ""
While ($j -lt 32)
{
$outStr += "{0:X2} " -f $header[$i * 32 + $j]
$j ++
}
$i ++
$outStr
}
}
function ReadDataChunk([IO.BinaryReader] $bReader)
{
$outStr = ""
$tmpBuffer = $bReader.ReadBytes(8);
$TimeStamp = [DateTime]::FromBinary([BitConverter]::ToInt64($tmpBuffer, 0));
$outStr += "{0:HH:mm:ss.fff}" -f $TimeStamp
$tmpBuffer = $bReader.ReadBytes(1);
$IsOutcome = $tmpBuffer[0] -ge 0x80
if($IsOutcome)
{
$outStr += " >> "
}
else
{
$outStr += " << "
}
$SessionId = $tmpBuffer[0] -band 0x7F
$outStr += "[{0:00}" -f $SessionId
$tmpBuffer = $bReader.ReadBytes(4)
$DataBufferLength = [BitConverter]::ToInt32($tmpBuffer, 0);
$Data = $bReader.ReadBytes($DataBufferLength);
$tmpBuffer = $bReader.ReadBytes(1);
$outStr += ":{0:X2}] " -f $tmpBuffer[0]
foreach ($i in $Data)
{
$outStr += "{0:X2} " -f $i
}
$outStr
}
$scriptPath = split-path -parent $MyInvocation.MyCommand.Definition
if(Test-Path ($FILENAME))
{
$FILENAME = (Get-Item $FILENAME).FullName
}
else
{
$FILENAME = Join-Path($scriptPath,$FILENAME)
}
"Opening "+$FILENAME
$stream = New-Object -TypeName IO.FileStream -ArgumentList $FILENAME, Open, Read, ReadWrite
"Stream opened"
$binStream = New-Object -TypeName IO.BinaryReader -ArgumentList $stream
"Binany wrapper set"
$done = $false
"HEADER:"
""
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 82 of 76
CONFIDENTIAL
ReadHeader $binStream
""
"CONTENT:"
""
while (!($done))
{
if($binStream.BaseStream.Position -lt $binStream.BaseStream.Length)
{
ReadDataChunk $binStream
}
else
{
$done=$true
}
}
$binStream.Close()
$stream.Close()
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 83 of 76
CONFIDENTIAL
6 REFERENCES
[1] Silicon Labs, INS10236, Instruction, Development Controller User Guide.
[2] Silicon Labs, INS12308, Instruction, Z-Wave 500 Series Appl. Prg. Guide v6.51.xx.
[3] Silicon Labs, INS10244, Instruction, Z-Wave Node Type Overview and Network Installation Guide.
[4] Silicon Labs, INS13113, Instruction, Z-Wave DLL v5 User Guide.
[5] Silicon Labs, SDS11274, Specification, Security 2 Command Class
INS13114-9 Z-Wave PC based Controller v5 User Guide 2018-03-05
silabs.com | Building a more connected world. Page 84 of 76
CONFIDENTIAL
INDEX
Configuration Command Class .................................................................................................................. 79
Windows 10 ............................................................................................................................................... 10
Windows 7 ................................................................................................................................................. 10
Windows 8 ................................................................................................................................................. 10
http://www.silabs.com
Silicon Laboratories Inc.400 West Cesar ChavezAustin, TX 78701USA
Smart. Connected. Energy-Friendly.
Productswww.silabs.com/products
Qualitywww.silabs.com/quality
Support and Communitycommunity.silabs.com
DisclaimerSilicon Labs intends to provide customers with the latest, accurate, and in-depth documentation of all peripherals and modules available for system and software implementers using or intending to use the Silicon Labs products. Characterization data, available modules and peripherals, memory sizes and memory addresses refer to each specific device, and "Typical" parameters provided can and do vary in different applications. Application examples described herein are for illustrative purposes only. Silicon Labs reserves the right to make changes without further notice and limitation to product information, specifications, and descriptions herein, and does not give warranties as to the accuracy or completeness of the included information. Silicon Labs shall have no liability for the consequences of use of the information supplied herein. This document does not imply or express copyright licenses granted hereunder to design or fabricate any integrated circuits. The products are not designed or authorized to be used within any Life Support System without the specific written consent of Silicon Labs. A "Life Support System" is any product or system intended to support or sustain life and/or health, which, if it fails, can be reasonably expected to result in significant personal injury or death. Silicon Labs products are not designed or authorized for military applications. Silicon Labs products shall under no circumstances be used in weapons of mass destruction including (but not limited to) nuclear, biological or chemical weapons, or missiles capable of delivering such weapons.
Trademark InformationSilicon Laboratories Inc.® , Silicon Laboratories®, Silicon Labs®, SiLabs® and the Silicon Labs logo®, Bluegiga®, Bluegiga Logo®, Clockbuilder®, CMEMS®, DSPLL®, EFM®, EFM32®, EFR, Ember®, Energy Micro, Energy Micro logo and combinations thereof, "the world’s most energy friendly microcontrollers", Ember®, EZLink®, EZRadio®, EZRadioPRO®, Gecko®, ISOmodem®, Micrium, Precision32®, ProSLIC®, Simplicity Studio®, SiPHY®, Telegesis, the Telegesis Logo®, USBXpress®, Zentri, Z-Wave and others are trademarks or registered trademarks of Silicon Labs. ARM, CORTEX, Cortex-M3 and THUMB are trademarks or registered trademarks of ARM Holdings. Keil is a registered trademark of ARM Limited. All other products or brand names mentioned herein are trademarks of their respective holders.