Silicon Labs PC based Controller User Manual
Instruction
PC based Controller User Guide
Document No.:
INS10240
Version:
14
Description:
This document describes how to use the PC based Controller application with a ZWave module using static controller serial API.
Written By:
DDA;JFR;MVO;BBR
Date:
2018-03-06
Reviewed By:
JFR;JKA;CHL
Restrictions:
Public
Approved by:
Date CET Initials Name Justification
2018-03-06 09:27:28 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.
INS10240-14 PC based Controller User Guide 2018-03-06
silabs.com | Building a more connected world.
Page ii of v
REVISION RECORD
Doc. Rev
Date
By
Pages affected
Brief description of changes
1
20050317
HEH
Section 5.59
Support for Association command class added.
2
20050720
JCH
3.6.1 & 3.7
Support for Command Class added and Network Role Options.
3
20060105
MVO
All
New 1st page/header/footer contents. New Doc No
4
20060220
JCH
Section 2 and 3 and
drawings
Updated text to latest controller functionality
5
20081104
DDA
All
Review and update to version 4.0x
6
20090409
DDA
All
Minor update regarding version 4.19
7
20090615
DDA
Section 4.2 & 5.1
Minor update regarding interface changes.
8
20100115
DDA
Section 3
Section 4.1.1
Section 4.2
Section 4.4
Updated the whole section
Added Security Test Schema
Screenshot and menu items.
Screenshot and text.
9
20100719
DDA
Section 5.4.5
Sections 4.8, 5.6
Sections 5.1, 5.2
Section 3.5
Section 4.2
Section 4.9 & 5.9
Section 5.3.5
Added Set SUC/SIS.
Added Security Test Schema
Moved from Section 3
Removed Command Prompt description
Screenshot and text
ERTT description added
Section added
10
20110225
DDA
Section 5.3.3
Section reviewed.
11
20110901
DDA
Section 3.2.1
Section regarding USB Adaptor added.
12
20120306
DDA
Section 5.9
Section 4.10
Section 4.14, 5.12
Section reviewed
Section reviewed
Firmware Update description added
13
20130514
MVO
All
Changed first two pages and headers/footers
14
20180306
BBR
All
Added Silicon Labs template
INS10240-14 PC based Controller User Guide 2018-03-06
silabs.com | Building a more connected world.
Page iii of v
Table of Contents
1 ABBREVIATIONS ................................................................................................................................. 1
2 INTRODUCTION ................................................................................................................................... 1
2.1 Purpose .............................................................................................................................................. 1
2.2 Audience and prerequisites ................................................................................................................ 1
2.3 Implementation ................................................................................................................................... 1
2.4 Limitations .......................................................................................................................................... 2
3 THE PC BASED CONTROLLER.......................................................................................................... 3
3.1 Check the prerequisites ...................................................................................................................... 3
3.2 Required Z-Wave hardware ............................................................................................................... 3
3.2.1 UZB .......................................................................................................................................... 4
3.3 Limitations .......................................................................................................................................... 4
3.4 Install the Z-Wave PC Controller application ..................................................................................... 4
3.5 Start the Z-Wave PC Controller application ....................................................................................... 7
3.6 Remove Z-Wave PC Controller .......................................................................................................... 8
4 USER INTERFACE ............................................................................................................................... 9
4.1 Main Menu .......................................................................................................................................... 9
4.1.1 Categories Menu ...................................................................................................................... 9
4.1.2 Help menu ................................................................................................................................ 9
4.2 Node View ........................................................................................................................................10
4.3 Controller view ..................................................................................................................................12
4.4 Associations view .............................................................................................................................14
4.5 Command Class view .......................................................................................................................15
4.6 Setup Route view .............................................................................................................................16
4.7 Setup Route view .............................................................................................................................17
4.8 Security Test Schema ......................................................................................................................18
4.9 ERTT ................................................................................................................................................19
4.10 Log View ...........................................................................................................................................20
4.11 Status Bar .........................................................................................................................................21
4.12 Topology Map ...................................................................................................................................21
4.12.1 The Map .................................................................................................................................22
4.12.2 Node Type Colors ..................................................................................................................22
4.13 Security Encrypt/Decrypt ..................................................................................................................22
4.14 Firmware Update ..............................................................................................................................23
5 FUNCTIONALITY................................................................................................................................24
5.1 PC based Controller application .......................................................................................................24
5.2 The SC Properties ............................................................................................................................25
5.3 Node .................................................................................................................................................27
5.3.1 How to add a node .................................................................................................................27
5.3.1.1 PC based SC is Primary / Inclusion / SIS ......................................................................27
5.3.1.2 PC based SC is Secondary ............................................................................................27
5.3.1.3 PC based SC is SUC .....................................................................................................27
5.3.2 How to remove a node ...........................................................................................................27
5.3.2.1 PC based SC is Primary / Inclusion / SIS ......................................................................27
5.3.2.2 PC based SC is Secondary ............................................................................................27
5.3.2.3 PC based SC is SUC .....................................................................................................27
5.3.3 Network Wide Inclusion ..........................................................................................................27
5.3.4 Node Info ................................................................................................................................28
5.3.5 Request Node Neighbor Update ............................................................................................28
5.3.6 Set SUC/SIS ..........................................................................................................................28
INS10240-14 PC based Controller User Guide 2018-03-06
silabs.com | Building a more connected world.
Page iv of v
5.3.7 ‘Switch All On’ command .......................................................................................................28
5.3.8 PC based SC is Primary / Inclusion / SIS / Secondary / SUC ...............................................28
5.3.9 ‘Switch All Off’ command .......................................................................................................28
5.3.9.1 PC based SC is Primary / Inclusion/ SIS / Secondary / SUC ........................................28
5.3.10 Toggle Basic Get ....................................................................................................................28
5.3.11 Switching a node or a subset of nodes on and off .................................................................28
5.3.11.1 PC based SC is Primary / Inclusion / SIS / Secondary / SUC .......................................28
5.3.12 Send NOP ..............................................................................................................................29
5.3.13 How to send a failure signal to a node ...................................................................................29
5.3.13.1 PC based SC is Primary / Inclusion / SIS ......................................................................29
5.3.14 How to replace a failed node..................................................................................................29
5.3.14.1 PC based SC is Primary / Inclusion / SIS ......................................................................29
5.3.14.2 PC based SC is Secondary ............................................................................................29
5.3.14.3 PC based SC is SUC .....................................................................................................29
5.3.15 How to remove a failing node ................................................................................................29
5.3.15.1 PC based SC is Primary / Inclusion / SIS ......................................................................29
5.3.15.2 PC based SC is Secondary ............................................................................................29
5.3.15.3 PC based SC is SUC .....................................................................................................30
5.3.16 Set Wake-Up Interval .............................................................................................................30
5.4 Controller ..........................................................................................................................................30
5.4.1 Including a PC based SC to a network ..................................................................................30
5.4.1.1 PC based SC is Primary / Inclusion / Secondary / SUC ................................................30
5.4.1.2 PC based SC is Primary .................................................................................................30
5.4.1.3 PC based SC is SIS .......................................................................................................30
5.4.1.4 PC based SC is Secondary / SUC .................................................................................30
5.4.2 Controller shift ........................................................................................................................31
5.4.2.1 PC based SC is Primary .................................................................................................31
5.4.2.2 PC based SC is Inclusion / SIS / Secondary / SUC .......................................................31
5.4.3 Create new primary ................................................................................................................31
5.4.3.1 PC based SC is Primary / Inclusion / SIS ......................................................................31
5.4.3.2 PC based SC is Secondary ............................................................................................31
5.4.3.3 PC based SC is Secondary with SUC functionality........................................................31
5.4.4 Reset controller ......................................................................................................................31
5.4.4.1 PC based SC is Primary /Inclusion / SIS / Secondary / SUC ........................................31
5.4.5 Request update of PC based SC ...........................................................................................31
5.4.5.1 PC based SC is Primary / SIS / SUC / Secondary .........................................................31
5.4.5.2 PC based SC is Inclusion ...............................................................................................32
5.4.6 Save Command Classes to device memory ..........................................................................32
5.4.7 Load Command Classes from device memory ......................................................................32
5.5 Command Class ...............................................................................................................................32
5.5.1 Send frame with a specific command ....................................................................................32
5.5.1.1 PC based SC is Primary /Inclusion / SIS / Secondary / SUC ........................................32
5.6 Association .......................................................................................................................................32
5.6.1 Create Association .................................................................................................................32
5.6.2 Remove Association ..............................................................................................................33
5.7 Routing Setup ...................................................................................................................................33
5.7.1 Assign a route ........................................................................................................................33
5.7.1.1 PC based SC is Primary / Inclusion / SIS / Secondary / SUC .......................................33
5.7.2 Delete a route .........................................................................................................................33
5.7.2.1 PC based SC is Primary / Inclusion / SIS / Secondary / SUC .......................................33
5.8 Security Test Schema ......................................................................................................................33
5.9 ERTT ................................................................................................................................................34
5.10 Topology Map ...................................................................................................................................35
5.10.1 Reload Topology ....................................................................................................................35
5.11 Security Encrypt/Decrypt ..................................................................................................................35
5.12 Firmware Update ..............................................................................................................................35
INS10240-14 PC based Controller User Guide 2018-03-06
silabs.com | Building a more connected world.
Page v of v
6 REFERENCES ....................................................................................................................................36
INDEX .........................................................................................................................................................37
List of Figures
Figure 1. PC with a Z-Wave module connected ......................................................................................... 3
Figure 2. Welcome page of Z-Wave PC Controller installation. .................................................................. 4
Figure 3. Installation folder .......................................................................................................................... 5
Figure 4. Confirmation page of Z-Wave PC Controller installation ............................................................. 6
Figure 5. Installation complete ..................................................................................................................... 6
Figure 6. 7PC based Controller Main Window ............................................................................................ 7
Figure 8. Node section............................................................................................................................... 10
Figure 9. Controller view ............................................................................................................................ 12
Figure 10. Associations view ..................................................................................................................... 14
Figure 11. Command Class view ............................................................................................................... 15
Figure 12. Setup Route view ..................................................................................................................... 16
Figure 13. Setup Route view ..................................................................................................................... 17
Figure 14. Security Test Schema .............................................................................................................. 18
Figure 15. ERTT ........................................................................................................................................ 19
Figure 16. Log View ................................................................................................................................... 20
Figure 17. Status Bar ................................................................................................................................. 21
Figure 18. Topology Map ........................................................................................................................... 21
Figure 19. Security Encrypt/Decrypt .......................................................................................................... 22
Figure 20. Firmware Update ...................................................................................................................... 23
List of Tables
Table 1. Overview of the Static Controller properties ................................................................................ 26
INS10240-14 PC based Controller User Guide 2018-03-06
silabs.com | Building a more connected world.
Page 1 of 37
Abbreviation
Explanation
API
Application Programming Interface
DLL
Dynamic Link Library
OTA
Over-the-air
SC
Static Controller
SUC
Static Update Controller
SIS
SUC ID Server
ERTT
Enhanced Reliability Test Tool
1 ABBREVIATIONS
2 INTRODUCTION
2.1 Purpose
The PC based Controller application is an example on how Static 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 Zensys. It is assumed that the Z-Wave partner already is familiar
with the current Z-Wave Developer's Kit.
2.3 Implementation
The PC based Controller application is implemented in Visual Studio .NET 2005 C# and uses the .NET
Framework based Zensys Z-Wave DLL for protocol related communication.
Zensys.ZWave.SerialPortTransport – provides an implementation for the communication layer to the
underlying communication hardware and acts as an abstraction layer between the physical hardware and
the communication.
Zensys.ZWave.SerialPortSession – provides an implementation for the session layer to the underlying
sessions, requests and responses.
Zensys.ZWave.SerialPortFrame – provides an implementation for the frame layer to the underlying
frame parsing and generation.
Zensys.ZWave.SerialPortApplication – provides an Application Programming Interface (API) to the
Z-Wave protocol.
Zensys.ZWave – provides classes, interfaces, enumerations and definitions to the Z-Wave protocol
Zensys.ZWave.CommandClasses – provides a list of existing Command Classes, classes and
enumerations in use by the working system.
Zensys.Framework – provides common classes, helpers and functions.
INS10240-14 PC based Controller User Guide 2018-03-06
silabs.com | Building a more connected world.
Page 2 of 37
Note: Regarding a detailed description about the Z-Wave DLL, please refer to Z-Wave DLL
documentation.
2.4 Limitations
The PC based Controller application has been tested on Windows XP and Windows 7.
Secure PC Controller application should not be used together with Z-Wave module running
SerialAPI_Ctl_Static_Single binary since CmdZWaveGetRandom is not implemented in the Z-Wave
device.
INS10240-14 PC based Controller User Guide 2018-03-06
silabs.com | Building a more connected world.
Page 3 of 37
Z-Wave
module
3 THE PC BASED CONTROLLER
The 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
Controller Windows application:
1. .NET Framework, version 2.0 or later
2. Windows Installer 3.0 (Windows Installer 3.1 or later is recommended)
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.
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_Ctl_Bridge_ZW0x0x_XX.hex) situated in the directory
‘C:\DevKit_X_YY\Product\Bin\SerialAPI_Bridge\’. Finally connect the Z-Wave module to the
COM port on the PC.
INS10240-14 PC based Controller User Guide 2018-03-06
silabs.com | Building a more connected world.
Page 4 of 37
3.2.1 UZB
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 b y the OS.
For more info on UZB, see INS11850, Instruction, UZB User Manual.
3.3 Limitations
Z-Wave PC Controller application has been tested on Windows XP with Service Pack 3 (x86 platform)
and Windows 7.
3.4 Install the Z-Wave PC Controller application
1. Exit all programs.
2. Run the installation file of the Z-Wave PC Controller application.
Figure 2. Welcome page of Z-Wave PC Controller installation.
INS10240-14 PC based Controller User Guide 2018-03-06
silabs.com | Building a more connected world.
Page 5 of 37
3. Select the installation folder and who should be able to use the Z-Wave PC Controller
application.
Please note, that it is not recommended to move the Z-Wave PC Controller application manually
after it has been installed into the above specified folder.
When done, click Next.
Figure 3. Installation folder
4. Installation confirmation appears. Click Next again to confirm and start the installation.
INS10240-14 PC based Controller User Guide 2018-03-06
silabs.com | Building a more connected world.
Page 6 of 37
Figure 4. Confirmation page of Z-Wave PC Controller installation
5. The actual installation procedure will pass with progress indicator and final confirmation appears.
6. Click Close to complete the installation.
Figure 5. Installation complete
INS10240-14 PC based Controller User Guide 2018-03-06
silabs.com | Building a more connected world.
Page 7 of 37
3.5 Start the Z-Wave PC Controller application
You can start the Z-Wave PC Controller using the Start menu. To open the Start menu, click the Start
button in the lower-left corner of your screen. Or, press the Windows logo key on your keyboard. The
Start menu appears.
To open Z-Wave PC Controller, click its icon shown in the left pane of the Start menu that displays the
most frequently used programs list. If you don't see its icon there, click All Programs at the bottom of the
left pane. Instantly, the left pane displays a long list of programs in alphabetical order, followed by a list of
folders. Click Zensys folder, then click Z-Wave PC Controller folder and finally Z-Wave PC Controller
icon.
Each time you start Z-Wave PC Controller, you are actually running the “C:\Program
Files\Zensys\Z-Wave PC Controller\ZWaveController.exe” executable file, although you do
not usually type its name or even see it.
Run the PC based Controller application, and the Main window will appear as shown below:
Figure 6. 7PC based Controller Main Window
INS10240-14 PC based Controller User Guide 2018-03-06
silabs.com | Building a more connected world.
Page 8 of 37
3.6 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.
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.
Loading...