Table of Contents
Advertisement
Quick Links
Advertisement
Table of Contents
Summary of Contents for ZWaveProducts ZWP-TBX
- Page 2 ZWP TBX Z-Wave ToolBox Learn more about Z-Wave* and ZWaveProducts by visiting us on the web: www.zwaveproducts.com *Z-Wave and Z-Wave Plus are registered trademarks of Sigma Designs and its subsidiaries in the United States and other countries.
- Page 3 About This User’s Manual This manual starts with the Quick Start Guide. The QSG gets your feet wet and tries not to over-explain the tasks. If you find the depth of knowledge inadequate, please follow the page numbers we’ve included to more detailed information further on. The second part of this manual is the User’s Manual.
-
Page 4: Table Of Contents
Z-Wave ToolBox User’s Manual – Table of Contents Quick Start Guide ....4 Personalization Menu ..... 30 QSG - Parts Identifier . -
Page 5: Quick Start Guide
Quick Start Guide • Parts Identifier The Z-Wave ToolBox Service • Indicator Lights: Shows Z-Wave, WiFi, WAN (not used), and Power connections • Service (not used - may be used in the USB Port future to expand capabilities) Sync Ethernet Port •... -
Page 6: Qsg - Connection Types
Quick Start Guide • Connection Types Client WiFi Client WiFi Z-Wave Z-Wave Target Target Z-Wave Toolbox Z-Wave Controller/ Z-Wave Controller/ Panel Panel 120V 120V power power Ethernet Ethernet cable cable Ethernet cable Ethernet cable Home Network Router Home Network Router ToolBox to Monitoring Device (tablet, smart phone, computer) via Client WiFi The ToolBox has internal WiFi that is the standard connection during troubleshooting (pg 24) This allows you to view the ToolBox interface on any web browser. -
Page 7: Qsg - Connecting To The Toolbox
Quick Start Guide • Connecting To The ToolBox There are 2 ways to connect the ToolBox to your Monitoring Device 1. Via ToolBox WiFi (Please see page 24 for more detailed instructions) item a. Power Up the ToolBox Plug in your ToolBox and wait up to 90 seconds for loading. See page 5 to see a diagram;... -
Page 8: Qsg - Toolbox Sign In
Quick Start Guide • ToolBox Sign In After connecting your Monitoring Device, you should see this screen on your browser: item Enter User Name Default Login is user Enter Password Default Password is p ssword The complete instructions are on page 27 03.16.18... -
Page 9: Sample Troubleshooting Workflows
Workflow • Updating the ToolBox Firmware 1. Open The Update Firmware panel. Updating the Firmware should be To start, click the Blue ToolBox to done when the ToolBox is first access the Personalization Menu; purchased, and then periodically as features are added and bugs fixed. Difficulty Level: EASY Time to Complete Task: 20 min. -
Page 10: Qsg - Evaluating A Site Before Installing
Workflow • Evaluating a Site Before Installing 7. Click the Start button to start the Connection Type: test. You can move the ToolBox The Site Survey Widget is a quick, around as needed. non-intrusive way to evaluate a location for a new gateway. Use Site Survey to show the Client WiFi Client WiFi... -
Page 11: Qsg - Finding The Best Repeater Location
Workflow • Finding the Best Repeater Location If you’ve done your homework and 10. Wait for the devices to connect. If Use the Repeater Finder Widget. are still ready to install a repeater, let’s the status is blue and you still don’t Finding THE place for a repeater continue! see a list of devices, try clicking... - Page 12 Workflow • Finding the Best Repeater Location . . . Or maybe here? 17. After you have completed this test, be sure to remove the ToolBox from the network. On the Target Z- Wave Controller’s interface, start the process to EXCLUDE a generic Z-Wave Device (or the process to delete the ToolBox if it showed up on your GUI).
-
Page 13: Qsg - Exercise • Using The Control Panel
Workflow • EXERCISE - Using the Control Panel 3. From the Monitoring Device, 12. You can use the ON/OFF dialog This workflow is not a test, per se, navigate to access WiFi networks. buttons to cycle any powered Z-Wave but its a great skill to be used with device to determine what it is. -
Page 14: Qsg - Checking For Noise/Interference
Workflow • Checking for Noise/Interference 8. As you walk around, check the The Spectrum Analyzer is a non- Steps: RSSI levels, which will reply in real intrusive way to see the levels of 1. Connect the Z-Wave Toolbox to time. the extension cord, then plug the noise in the 900 MHz range. -
Page 15: Qsg - Viewing The Z-Wave Routing Table
Workflow • Viewing the Z-Wave Routing Table 3. From the Monitoring Device, 13. You can use the arrows to expand This workflow can be a test or just navigate to access WiFi networks. this window, and direct select each an exercise to be combined with Node ID to move it around to see it’s other tools on the Network Health 4. -
Page 16: Qsg - Pinging Z-Wave Devices
Workflow • Pinging Z-Wave Devices 3. From the Monitoring Device, • Battery operated devices need to be This workflow can be a stand-alone navigate to access WiFi networks. woken manually/locally if included in test or combined with other tools on this test. -
Page 17: Qsg - Z-Wave Device Still In The Network
Workflow • Is a Z-Wave Device still in the Network? 7. Using the navigation on the left, A frustrating part of Z-Wave Items Needed: select Network Health / Testers. networks is a flaky node. ToolBox Computer/App to access Target Sometimes it works. Sometimes it 8. -
Page 18: Qsg - Pinging Z-Wave Routes And Devices
Workflow • Testing Communication Link Strength 3. From the Monitoring Device, • Battery operated devices need to be This workflow can be a stand-alone navigate to access WiFi networks. woken manually/locally if included in test or combined with other tools on this test. - Page 19 03.16.18...
-
Page 20: User's Manual
ZWP TBX Z-Wave ToolBox User’s Manual Learn more about Z-Wave* and ZWaveProducts by visiting us on the web: www.zwaveproducts.com *Z-Wave and Z-Wave Plus are registered trademarks of Sigma Designs and its subsidiaries in the United States and other countries. 03.16.18... -
Page 21: Z-Wave Toolbox Parts Identifier
Z-Wave ToolBox Parts Identifier Service USB Port Sync Ethernet Port Power Supply (not shown) Reset • Indicator Lights: Shows Z-Wave, WiFi, WAN (not used), and Power connections • Service (not used - may be used in the future to expand capabilities) •... -
Page 22: Home Automation Parts Identifier
Home Automation Network Parts Identifier Here are devices that you will find on site, and definitions of what we call them in this User Manual: Monitoring Device This could be any device (smart phone, tablet, laptop, etc) that you use to connect to the ToolBox. The ToolBox is web-based so it will work with any internet browser. -
Page 23: Z-Wave Toolbox Connection Types
Z-Wave ToolBox Connection Types Client WiFi Client WiFi Z-Wave Z-Wave Target Target Z-Wave Toolbox Z-Wave Controller/ Z-Wave Controller/ Panel Panel 120V 120V power power Ethernet Ethernet cable cable Ethernet cable Ethernet cable Home Network Router Home Network Router ToolBox to Monitoring Device (tablet, smart phone, computer) via Client WiFi The ToolBox has internal WiFi that is the standard connection during troubleshooting. - Page 24 Z-Wave ToolBox Connection Types Client WiFi Client WiFi Z-Wave Z-Wave Target Target Z-Wave Toolbox Z-Wave Controller/ Z-Wave Controller/ Panel Panel 120V 120V power power Connections with the Network Health Tool (pg 37) and Packet Analyzer (pg 47) Z-Wave Toolbox 120V 120V power power...
-
Page 25: Connecting To Monitoring Device Via Wifi
Connecting the ToolBox to the Monitoring Device via WiFi We set up the ToolBox to use it’s own WiFi network to connect to your device Power Up the ToolBox Plug in your ToolBox using the power adapter (or battery pack). Wait up to 90 seconds for loading. -
Page 26: Tips On Toolbox Wifi
Tips on ToolBox WiFi If you are having difficulty finding or connecting to the ToolBox via WiFi: • Your WiFi SSID is Z-WaveToolBoxXXXX (the XXXX is the last 5 or 6 digits of your TB Serial Number) • Once connected to the ToolBox via WiFi, you will not have internet access. Your monitoring device could be a tablet, computer, or smart phone. -
Page 27: Connecting To The Home Network Router
Connecting the ToolBox to the Home Network Router The primary reasons to connect the ToolBox to a Home Network Router are to perform firmware updates or receive remote ToolBox troubleshooting from our support team Connect the ToolBox to the Home Network Router using the CAT5 cable See page 22 for the diagram;... -
Page 28: Toolbox Sign In
ToolBox Sign In After connecting your Monitoring Device, you should see this screen on your browser: Enter User Name item Default Login is user Enter Password Default Password is p ssword Please keep these notes in mind regarding Sign In: •... -
Page 29: Navigating The Toolbox Interface
Navigating the ToolBox Interface From The Sign In page The ToolBox interface initially loads to the Network Health Pane/Testers. Navigating the ToolBox Interface The interface consists of a navigation bar on the left, and various information windows on the right. Each Icon on the navigation bar represents a specific panel on the ToolBox. -
Page 30: Navigation Bar Icons
Navigation Bar Icons ToolBox Interface Navigation Bar Icons User Profile User Profile/Time Options/Update Firmware, and Tool Selector Reset ToolBox Widgets Resets colors, sizes, order of Network Health Tool Widgets Network Health Tool Testers/Maps/Utils (Tester also contains the Control Panel) Z-Wave Analyzers Packet Analyzer/Site Survey Spectrum Analyzer Help Contact... -
Page 31: Personalization Menu
The Personalization Menu Access The Personalization Menu The Personalization Menu is accessed by clicking the blue ToolBox Icon with the green stripe, in the upper left corner of the Navigation Screen. After clicking the Blue ToolBox a slider will open with the Personalization Icons: The selections here allow some personalization and customization of the tool. -
Page 32: Time Options
The Personalization Menu Time Options Clicking Time Options brings up the Time Settings dialog box, which allows the user to set his/her time zone. Update Firmware Clicking the Update firmware Icon brings up the Firmware Update page. Details on page 33. 03.16.18... -
Page 33: Tool Selector
Click Tool Selector only if instructed by the ZWP help desk. Finding your ToolBox Firmware Version Firmware Version The current firmware version number of your ToolBox is located in the lower-left corner of the navigation window. Please share this information if contacting ZWaveProducts for assistance. 03.16.18... -
Page 34: Updating The Toolbox Firmware
Updating the ToolBox Firmware Z-Wave Toolbox 120V 120V power power Ethernet Ethernet cable cable item Ethernet cable Ethernet cable Home Network Router Home Network Router CONNECTIONS: Updating the ToolBox firmware Both your monitoring device and the ToolBox will be connected to the Home Network Router via a CAT5 Ethernet cable. The ToolBox should be powered up following the steps on page 26. - Page 35 Updating the ToolBox Firmware Did you Get a 404 Error? Please see the Changing The Target URL for Firmware Updates on page 35 Update ToolBox Firmware You will be shown your version, and a new version (if available). Click Update. Do not close the internet browser window or unplug the ToolBox.
-
Page 36: Toolbox Firmware - Changing The Target Url
ToolBox Firmware - Changing the Target URL Changing the Target URL for Firmware Updates A few months into deployment of the Z-Wave ToolBox, we changed the server where the firmware updates reside. If you are having trouble updating your ToolBox firmware (404 errors, time-outs, etc.) please check the Current Server in the Server Selector dialog box. - Page 37 A Word About Battery-Operated Z-Wave Devices technical (This is a very simplified version of relationship between battery operated devices and a Z-Wave network) In the upcoming series of tests, The ToolBox may ping a battery operated device, and it will fail. This is because Z-Wave uses a complicated protocol to wake up battery operated devices.
-
Page 38: Network Health Tool
The Network Health Tool Client WiFi Client WiFi Z-Wave Z-Wave Target Target Z-Wave Toolbox Z-Wave Controller/ Z-Wave Controller/ Panel Panel 120V 120V power power Connections: The above diagram shows General Troubleshooting for MOST Network Health Tool Tasks Network Health Tool The Network Health Tool is one of the three main tools of the ToolBox. -
Page 39: Pairing With The Target Z-Wave Controller
Pairing The ToolBox with Target Z-Wave Controller Connection toolbar Status Indicates activity; Working (green), Idle (blue), Error (red) Connect To Network Connects/disconnects the ToolBox and the Target Z-Wave Controller Refresh Network Refreshes the information in the widgets but keeps the ToolBox connection Reset Forces a Reset of the ToolBox connection Connecting the ToolBox and the Target Z-Wave Controller... -
Page 40: The Network Health Tool - Control Panel
The Network Health Tool - Control Panel Control Panel Control Panel Navigation Bar Icons Save Names Allows user to create ‘nicknames’ for devices in the list Help Brings up interactive help menu Colors Allows user to change the color of the Network Health Tool widget boxes Collapse Minimizes the widget box Fullscreen... -
Page 41: The Network Health Tester
The Network Health Tester Network Health Tester Network Health Tester Navigation Bar Icons Test All Tests all devices in the list Test Click on a device in the list, the select Test to check one or more devices. Stop Stops test Help Brings up interactive help menu Collapse... -
Page 42: The Simple Connection Tester
The Simple Connection Tester Simple Connection Tester Simple Connection Tester Navigation Bar Icons Test All Tests all devices in the list Stop Stops test Help Brings up interactive help menu Collapse Minimizes the widget box Fullscreen Expands the widget box Network Health Tester Navigation Bar Column Headers Device ID Z-Wave Node ID of the Z-Wave device... -
Page 43: The Static Network Map
The Static Network Map Static Network Map Static Network Map Navigation Bar Icons Update Neighbors May be used in the future to expand capabilities Help Brings up interactive help menu Collapse Minimizes the widget box Fullscreen Expands the widget box Static Network Map Graphic Icons Device # Z-Wave Node ID of the Z-Wave device... -
Page 44: The Static Connection Grid
The Static Connection Grid Static Connection Grid Static Network Grid Navigation Bar Icons Help Brings up interactive help menu Collapse Minimizes the widget box Fullscreen Expands the widget box • The Static Connection Grid shows the relationship between two devices on the X & Y axis of the table. -
Page 45: The Repeater Finder
The Repeater Finder Repeater Finder easy! Repeater Finder Navigation Bar Icons Start Starts Repeater Finder test Stop Stops Repeater Finder test Help Brings up interactive help menu Collapse Minimizes the widget box • The Repeater Finder shows the communication strength of the ToolBox talking to any 2 Z-Wave devices in the Target Z-Wave Controller’s network •... -
Page 46: Background Rssi
Background RSSI Background RSSI Background RSSI Navigation Bar Icons Start Starts Background RSSI test Stop Stops Background RSSI test Help Brings up interactive help menu Collapse Minimizes the widget box Fullscreen Expands the widget box • RSSI means Received Signal Strength Indication; a scale of Z-Wave communication health •... - Page 47 A Word About the Z-Wave Analyzers technical The Z-Wave Packet Analyzer is our version of the “Sniffer.” You may have heard “Sniffer Trace” or “Trace” among developers and engineers. The Packet Analyzer is probably one of the more difficult tools to decipher, as there is on overabundance of information. It is also very powerful.
-
Page 48: The Z-Wave Analyzers
The Z-Wave Analyzers Client WiFi Client WiFi Z-Wave Z-Wave Target Target Z-Wave Toolbox Z-Wave Controller/ Z-Wave Controller/ Panel Panel 120V 120V power power Connections: The above diagram shows General Troubleshooting for MOST Z-Wave Analyzer Tasks Z-Wave Analyzers Z-Wave Analyzers is one of the three main tools of the ToolBox. Each of these tools is broken out into sections to make the ToolBox easier to use. -
Page 49: The Packet Analyzer
The Packet Analyzer Packet Analyzer Packet Analyzer Navigation Bar Icons Status Indicates activity; Working (green), Idle (blue), Error (red) Capture Starts the Trace. Traffic autoscrolls with the most recent at the bottom Pause Trace continues, but autoscroll stops. Allows closer examination of traffic Stop Stops the Trace (trace will clear when new Capture is started) Join... - Page 50 The Packet Analyzer Packet Analyzer Navigation Bar Icons Reload Refreshes the browser Columns Show or hide columns of data Search Searches the Trace Packet Analyzer Navigation Bar Column Headers Date Timestamp of entry RSSI Received Signal Strength Indication; a scale of Z-Wave communication health Source Where the transmission originated Route...
-
Page 51: Decoding The Packet Analyzer
The Packet Analyzer Decoding the Packet Analyzer Tips for Using the Packet Analyzer • For the most accurate results, keep the ToolBox close to the gateway (or the device you are troubleshooting) • In the ROUTES column on the Packet Analyzer, the source and destination are in parenthesis () •... -
Page 52: The Site Survey
The Site Survey Site Survey easy! Site Survey Navigation Bar Icons Status Indicates activity; Working (green), Idle (blue), Error (red) Capture Starts the Trace. Traffic autoscrolls with the most recent at the bottom Pause Trace continues, but autoscroll stops. Allows closer examination of traffic Stop Stops the Trace (trace will clear when new Capture is started) Fullscreen... - Page 53 The Site Survey • Really weak or incomplete signals will show up as CRC errors. CRC means “Cyclic Redundancy Check” and is the Z-Wave protocol’s way of knowing that a complete command was received. A few CRC errors are not necessarily cause for alarm. •...
-
Page 54: The Spectrum Analyzer
The Spectrum Analyzer Client WiFi Client WiFi Z-Wave Z-Wave Z-Wave Toolbox 120V 120V power power Connections: The above diagram shows General Troubleshooting for MOST Spectrum Analyzer Tasks Spectrum Analyzer The Spectrum Analyzer is one of the three main tools of the ToolBox. Each of these tools is broken out into sections to make the ToolBox easier to use. - Page 55 The Spectrum Analyzer Spectrum Analyzer easy! This graph indicates an acceptable result. The blue portion of the graph is under 50%, leaving plenty of room in either of the two Z-Wave channels (grey shaded columns). Spectrum Analyzer Control Icons Capture Starts the test Stop Stops the test Status...
-
Page 56: The Spectrum Analyzer - Bad Sample
The Spectrum Analyzer Spectrum Analyzer Bad Sample This graph indicates interference that may block Z-Wave transmissions. The blue portion has risen to 80%, showing noise in the classic (908.4) Z-Wave channel. Above is a screenshot of a case of interference which will block normal Z-Wave traffic. Increased ‘pyramid or buttress’... -
Page 57: Putting It All Together Thinking Z-Wave
Using The Z-Wave ToolBox - Symptoms and Remedies What Tool at What Time? Here are some very general symptoms and what tool can be used to diagnose the issue Z-Wave Device suddenly is not responsive to the Target Z-Wave Controller •... - Page 58 Using The Z-Wave ToolBox - Thinking Z-Wave Thinking Z-Wave We have gone through an extraordinary effort to make this a tool for installers. Still, there is a big unknown to many when it comes to Z-Wave. This ToolBox is awesome, but it requires some understanding.
-
Page 59: Specifications
• User Group: www.facebook.com/groups/ZwaveToolBox/ Options: • Battery Pack will be available for true mobile troubleshooting • Packet Analyzer trace reading service available from Zwaveproducts.com Advanced: Association Command Class Description: The Z-Wave ToolBox Supports Association Command Class. It has 1 Association group, and one Destination.
Need help?
Do you have a question about the ZWP-TBX and is the answer not in the manual?
Questions and answers