Instruction
Z-Wave Zniffer User Guide
Document No.:
INS10249
Version:
22
Description:
Description of the Z Wave Zniffer development tool used for detecting RF
communication in a Z Wave network. The tool is used during SW application
development for debugging etc.
Written By:
JFR;JRM;BBR;SEROMAN1;AYURTTAS;SCBROWNI;VOSAVOST;OBOIKO
Date:
2020-12-01
Reviewed By:
JKA;COLSEN;CRASMUSSEN;LTHOMSEN;JBU;JSI;ABUENDIA;SEROMAN1;SCBROWNI;J
FR
Restrictions:
Public
Approved by:
Date CET Initials Name Justification
2020-12-01 04:37:57 NTJ Niels 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.
INS10249-22 Z-Wave Zniffer User Guide 2020-12-01
silabs.com | Building a more connected world.
Page ii of vi
REVISION RECORD
Doc.
Rev
DateByPages
affected
Brief description of changes
1
20031126
JFR
All
Initial draft
2
20051004
TKR
MVO
All
All
Added 40kbps support and various GUI enhancements
New 1st page/header/footer contents. New Doc No.
2
20070301
JRM
JFR
Section 4
GUI description and installation updated
3
20070820
IHM
All
Getting Started section has been updated.
New features (Duty Cycle Watcher, Frame Flow Diagram, Filters) have been
described.
3
20070830
IHM
All
Changes according to Product Specification of Zniffer and XML Editor
enhancements. RSSI section has been removed.
3
20070903
IHM
All
New features (Statistics Summary, toolbar buttons, Properties dialog) have been
added
3
20070927
IHM
All
Figures/screenshots have been updated.
Chapter “3. Getting Started” has been revised.
Chapter “5. Capturing live RF traffic” has been enlarged.
4
20071119
IHM
All
Some missing topics in chapter 5 “Capturing live RF traffic”, chapter 7 “Working
with captured packets” and chapter 8 “Statistics” have been restored.
New topic “Working with encrypted frames” has been added to chapter 7
“Working with captured packets”.
5
20071119
IHM
All
Broken cross-references have been manually fixed.
6
20071228
IHM
All
Some missing abbreviations have been added.
More details about the content of Developer’s Kit CD. More details for the
installation procedure. New “Troubleshoot …” sections have been created.
Many updates of User interface (menu, toolbar and dialogs). New section with
“Keyboard shortcut” has been added. “Preferences” section has been revised.
More details have been added to all file-related actions, especially to “Export to
text file” and “Merge files”. New “File Properties” section has been added.
More details have been added to “Highlighting frames”. “Filter” section has
been enhanced.
Most of the “Statistics” chapter has been re-written.
7
20110519
DDA
All
Revised document to cover all available features
8
20121207
DDA
Section 7.9
RSSI description added.
9
20130514
MVO
All
Replaced first section and updated headers/footers
9
20130530
DDA
All
Revised document to cover all available features
Removed reference to SDK CD
10
20150914
SRO
All
Update all screenshots
Update installation path
Added Figure 13. Open Large Trace
11
20160128
SRO; VSA
3.1
4.2.5
4.2.6
7.5
7.10
Added Windows 10 as compatible OS
Added: Tools menu
Added: Help menu
Updated: load keys from file, show key after decrypt
Added: Debug output
12
20160726
VSavostianenko
3.2.2
Added: Installation of Silicon Labs ZWave programming interface
13
20180306
BBR
All
Added Silicon Labs template
14
20180531
VSavostianenko
3.1
Updated required .NET Framework version
14
20180531
VSavostianenko
All
Update all screenshots
14
20180531
VSavostianenko
3.2.1
Clarified step 7 and removed steps 8 and 9
14
20180531
VSavostianenko
All
Removed redundant screenshots
14
20180531
VSavostianenko
4.3
Updated Table
15
20190315
JFR
All
Fixed page numbers
16
20190325
SRO
3.2.2
Added missing figure
INS10249-22 Z-Wave Zniffer User Guide 2020-12-01
silabs.com | Building a more connected world.
Page iii of vi
17
20190923
seroman1
4.8
All
Added section
Update screenshots
18
20200615
seroman1
1
Added US_LR, PTI, WSTK abbreviation
18
20200615
seroman1
All
Update screenshots
18
20200616
seroman1
3.2
Update sections
18
20200617
seroman1
3.4,5.2,5.3,7.9
Added section related to WSTK board
19
20200625
seroman1
3.4.2
Added how to configure IP Address for the WSTK board
20
20200828
vosavost
3.3
Updated startup description and added CLI arguments
21
20201124
vosavost
3.4.2
Updated ‘PTI Firmware update’section
22
20201130
Scbrowni
All
Tech Pubs review for all sections add or revised since the document was last
publish at Revision 13
INS10249-22 Z-Wave Zniffer User Guide 2020-12-01
silabs.com | Building a more connected world.
Page iv of vi
Table of Contents
1 ABBREVIATIONS............................................................................................................................1
2 INTRODUCTION ............................................................................................................................1
2.1 What is Z-Wave Zniffer......................................................................................................................1
2.2 Purpose..............................................................................................................................................2
2.3 Audience and Prerequisites...............................................................................................................2
3 GETTING STARTED ........................................................................................................................3
3.1 Check the Prerequisites.....................................................................................................................3
3.2 Install the Zniffer ...............................................................................................................................3
3.2.1 Install Application....................................................................................................................3
3.2.2 Install Programming Driver .....................................................................................................3
3.3 Start the Zniffer Application ..............................................................................................................5
3.4 Quick-Start Guide ..............................................................................................................................7
3.4.1 Using 500 series module with Zniffer firmware ......................................................................7
3.4.2 Using WSTK board with PTI firmware .....................................................................................7
3.5 Auto Update 500 series module Zniffer Firmware ............................................................................8
3.6 Remove Z-Wave Zniffer.....................................................................................................................8
3.7 Troubleshoot Installation Problems ..................................................................................................8
3.7.1 Installation Stops without .NET Framework............................................................................8
3.7.2 Installation Stops with an Error Message................................................................................8
4 USER INTERFACE .........................................................................................................................10
4.1 Layout of the Zniffer Main Window ................................................................................................10
4.2 Menu Bar.........................................................................................................................................11
4.2.1 File Menu ..............................................................................................................................11
4.2.2 Edit Menu..............................................................................................................................12
4.2.3 View Menu ............................................................................................................................13
4.2.4 Capture Menu .......................................................................................................................14
4.2.5 Tools Menu............................................................................................................................14
4.2.6 Help Menu.............................................................................................................................15
4.3 The Toolbar .....................................................................................................................................16
4.4 Keyboard Shortcuts .........................................................................................................................17
4.5 Frame List Pane ...............................................................................................................................18
4.6 Frame Details Window ....................................................................................................................19
4.7 The Status Bar..................................................................................................................................19
4.8 Network Load Trace View................................................................................................................20
5 CAPTURING LIVE RF TRAFFIC .......................................................................................................21
5.1 Introduction.....................................................................................................................................21
5.2 Prerequisites....................................................................................................................................21
5.2.1 Using 500 series module with Zniffer Firmware ...................................................................21
5.2.2 Using WSTK board with PTI firmware ...................................................................................21
5.3 Capturing Interface..........................................................................................................................21
INS10249-22 Z-Wave Zniffer User Guide 2020-12-01
silabs.com | Building a more connected world.
Page v of vi
5.3.1 Using 500 series module with Zniffer Firmware ...................................................................22
5.3.2 Using WSTK board with PTI firmware ...................................................................................22
5.4 Start Capturing ................................................................................................................................22
5.5 Pause Capturing...............................................................................................................................22
5.6 Stop Capturing.................................................................................................................................22
5.7 Saving the Trace to a File on-the-Fly ...............................................................................................23
5.8 Troubleshoot Capturing Frames......................................................................................................23
5.8.1 Capture Starts but Frame List is Empty .................................................................................23
6 FILE INPUT/OUTPUT....................................................................................................................24
6.1 Open File .........................................................................................................................................24
6.2 Save a File ........................................................................................................................................24
6.3 Add a Comment to the Trace ..........................................................................................................25
6.4 Open Files Saved in older Zniffer Formats.......................................................................................25
7 WORKING WITH CAPTURED PACKETS..........................................................................................26
7.1 Navigation within Frames................................................................................................................26
7.1.1 Navigation with Go To Line Dialog ........................................................................................26
7.1.2 Navigation with Find Frame Dialog .......................................................................................26
7.2 Highlighting frames .........................................................................................................................28
7.3 Using Display Filter ..........................................................................................................................29
7.4 Control Active Filters .......................................................................................................................29
7.5 Working with Encrypted Frames .....................................................................................................30
7.6 Watch ..............................................................................................................................................33
7.7 Best Practices in Handling the Frames ............................................................................................33
7.7.1 Select the Specific Frames.....................................................................................................33
7.7.2 Operate the Large Capture....................................................................................................33
7.8 Editing the Command Classes XML File...........................................................................................34
7.9 RSSI..................................................................................................................................................34
7.9.1 Using 500 series module with Zniffer Firmware ...................................................................34
7.9.2 Using WSTK board with PTI firmware ...................................................................................35
7.10 Debug Output..................................................................................................................................35
8 REFERENCES................................................................................................................................36
Figure 1. Device Manager. Ports list. ...........................................................................................................4
Figure 2. Z-Wave Zniffer Startup Flow.........................................................................................................6
Figure 3. Z-Wave Zniffer Main Application Window..................................................................................10
Figure 4. Frame Details Window ...............................................................................................................19
Figure 5. Status bar....................................................................................................................................19
Figure 6 Network Load Trace.....................................................................................................................20
Figure 7. Go To Line dialog ........................................................................................................................26
Figure 8. Find Frame Dialog .......................................................................................................................27
List of Figures
INS10249-22 Z-Wave Zniffer User Guide 2020-12-01
silabs.com | Building a more connected world.
Page vi of vi
Figure 9. Quick filter drop-down list for Destination column ....................................................................29
Figure 10. Decrypt Button in the Frame Details Window..........................................................................30
Figure 11. Encryption Key Dialog...............................................................................................................31
Figure 12. Decryption View .......................................................................................................................32
Figure 13. Open Large Trace......................................................................................................................33
INS10249-22 Z-Wave Zniffer User Guide 2020-12-01
silabs.com | Building a more connected world.
Page 1 of 36
1 Abbreviations
Abbreviation
Explanation
ANZ
Australia and New Zealand, 921.42 MHz frequency
COM
Serial port interface on IBM PC-compatible computers
EU
European Union, 868.42 MHz frequency
HEX
Intel HEX is a file format for conveying binary information for applications like
programming microcontrollers, EEPROMs, and other kinds of chips
HK
Hong Kong, 919.82 MHz frequency
ID
Identification number
IL
Israel
IN
India, 865.22 MHz frequency
JP
Japan, 950.95 MHz frequency
KR
South Korea
MY
Malaysia, 868.2 MHz frequency
NaN
Not a number
PC
Personal computer
PTI
Packet Trace Interface
RF
Radio Frequency
RSSI
Received Signal Strength Indicator
SDK
Software Developer’s Kit
SW
Software
TF
Test Frequency
US
United States, 908.42 MHz frequency
US_LR
United States, Long Range
USB
Universal Serial Bus, a serial bus standard to interface devices
WSTK
Wireless Starter Kit
XML
Extensible Markup Language
RU
Russia, 869.2 MHz frequency
2 Introduction
2.1 What is Z-Wave Zniffer
The Z-Wave Zniffer application is a development tool for capturing Z-Wave RF communication and
presenting the frames in a graphical user interface on a PC. The tool shows the node ID of the Source
and Destination for the communication, the type of frame [2] being sent, and the application content,
i.e. the specific command, which is being sent.
The Zniffer tool listens passively to the Z-Wave network traffic and will only display the RF
communications taking place within direct RF range. Be aware that Zniffer can occasionally miss RF
communication even from Z-Wave nodes within direct range.
INS10249-22 Z-Wave Zniffer User Guide 2020-12-01
silabs.com | Building a more connected world.
Page 2 of 36
2.2 Purpose
The purpose of this document is to describe the Z-Wave Zniffer development tool used during SW
application development for debugging, etc.
2.3 Audience and Prerequisites
The audience is external R&D software application programmers.
INS10249-22 Z-Wave Zniffer User Guide 2020-12-01
silabs.com | Building a more connected world.
Page 3 of 36
3 Getting Started
3.1 Check the Prerequisites
The .NET Framework 4.6.1 or later should be installed on the machine that you need to run Z-Wave
Zniffer Windows application.
Limitation: Z-Wave Zniffer has been tested on Windows 10. The PC application is a ‘desktop
application’.
Important: Make sure you have the latest service pack and critical updates for the version of Windows
that you are running.
3.2 Install the Zniffer
3.2.1 Install Application
1. Run “.msi” installer file. Follow the instructions.
2. Please note the copyright notification on the welcome page and click Next button.
3. Select the installation folder. Please note that it is recommended one does not move the Zniffer
application manually after it has been installed into the above specified folder. When done,
click Next. Then follow the installation procedure. The actual installation procedure will pass
with a progress indicator. After the final confirmation appears, click Close to complete the
installation.
3.2.2 Install Programming Driver
Skip this section if you do not have a 500 series USB Sniffer stick.
1. Exit all programs.
2. Install driver with name “zw05xxprg.inf” in the “<drive name>\SDK\Tools\PC
Programmer\PC\ZW050x_USB_Programming_Driver” from file context menu.
To update Zniffer firmware one must install the “Sigma Designs ZWave programming interface” driver.
If the driver is installed and the Zniffer update fails or does not start, try to repeat the previous steps
after successfully removing the ZWave programming interface from device manager.
1. Open Device Manger.
2. Expand Ports (COM & LTP) in tree.
3. Check Show hidden devices in Main Menu -> View to enable view of unconnected “Sigma
Designs ZWave programming interface”.
4. Select any “Sigma Designs ZWave programming interface” and run uninstall from context menu
(Figure 1 below).
INS10249-22 Z-Wave Zniffer User Guide 2020-12-01
silabs.com | Building a more connected world.
Page 4 of 36
Figure 1. Device Manager. Ports list.
INS10249-22 Z-Wave Zniffer User Guide 2020-12-01
silabs.com | Building a more connected world.
Page 5 of 36
3.3 Start the Zniffer Application
To open Z-Wave Zniffer, click its icon shown on the desktop. If you do not see its icon there, type
“Zniffer” in the windows search input.
Each time you start Z-Wave Zniffer, you are actually running the %ProgramFiles(x86)%\Silicon Labs\Z-
Wave Zniffer 4 \ZWaveZnifferUI.exe executable file (default installation location), although you do not
usually type its name or even see it.
Another way to start the Zniffer application is possible from CLI using arguments:
- ZWaveZnifferUI.exe <trace file>
- ZWaveZnifferUI.exe <trace file> -f <freq>
- ZWaveZnifferUI.exe -t <trace file> -f <freq>
Where –f <freq> is parameter to set frequency and –t <trace file> is destination to trace file. If
parameters are not set will be used defaults, for the frequency, it is last used and for trace - temporary
file.
After the application has started it tries to initialize a connected device by the next algorithm:
INS10249-22 Z-Wave Zniffer User Guide 2020-12-01
silabs.com | Building a more connected world.
Page 6 of 36
Figure 2. Z-Wave Zniffer Startup Flow
INS10249-22 Z-Wave Zniffer User Guide 2020-12-01
silabs.com | Building a more connected world.
Page 7 of 36
3.4 Quick-Start Guide
commander.exe adapter ip -s 440155278
commander.exe adapter ip -s 440155278 --dhcp
commander.exe adapter ip -s 440155278 --addr 192.168.2.102/24
3.4.1 Using 500 series module with Zniffer firmware
Steps:
1. Flash the appropriate hex file to a Z-Wave module. Refer to [1] for instructions on how to do
this. Connect the Z-Wave module / Z-Wave Interface module to a COM/USB port on your PC.
2. Open Z-Wave Zniffer.
3. Select the COM port in the ‘Capture’ – ‘Port Selection’ sub-menu or from the port selection
dropdown list on the toolbar. You may also check the Frequency Selection item.
4. To start capturing the RF traffic, click the Start button at the toolbar or press F5 key on your
keyboard.
5. To save your log file, click the Save button at the toolbar or press Ctrl+S keyboard shortcut on
your keyboard, type a name for the file in the Save As box, and then click Save.
3.4.2 Using WSTK board with PTI firmware
In order to use WSTK board it must be configured to use IP Address. If you have DHCP server in your
network, then the WSTK board automatically receives the IP Address, otherwise configure static IP
address like:
Configure static IP address for the ethernet adapter (example: 192.168.2.100).
Configure static IP address of the WSTK board using Simplicity Commander (example
192.168.2.101). You can do this using Simplicity Commander in GUI mode or command line
commands. Example for WSTK board with USB serial number = 440155278
o Get IP configuration:
o Set DHCP mode:
o Set static IP Address:
The adapter must be restarted to acquire a new IP address.
Steps:
1. Install 700 series module (ZGM130S) on the WSTK board. Run Simplicity Commander[4] and
program it with PTI enabled application (Example of the PTI enabled application – ZnifferPTI, Z-
Wave ZnifferPTI US_LR Region 7.xx.x, placed in Simplicity Studio v5 ‘Example Project and
Demos’)
2. Make sure you can connect to the WSTK board with its IP Address using Simplicity Commander.
3. Open Z-Wave Zniffer.
Loading...