User Manual Version 2.0
Contents
1. b gt Works Page 6 WiSens Classic User Manual Version 2 0 1 WiSens Classic Introduction The words WiSens Classic and WiSens mean the same in the scope of this document and they are used interchangeably in this document WiSens is a wireless sensor network sniffer analyser tool which meets the needs of engineers in the IEEE 802 15 4 ZigBee development and deployment domain It detects and captures wireless radio signal packets in the ambience during a testing commissioning session and presents them in convenient graphic displays WiSens presents users with a wide variety of choices in displays to help them evaluate diagnose and fix wireless communication related issues bugs Further each session can be saved printed or attached as electronic documents which can be archived for future analysis or for attachment as test records WiSens captures all conversations between devices nodes in a network communicating in a specified channel just as you would capture a chat session with a friend The sentences give way to packets graphically displayed and you see the conversation The packets are captured displayed and stored sequentially and can be traced to which device communicated to which other device and at what time If there is a glitch you see it in vivid detail on the screen making it is easy to diagnose and fix a problem Meet friendly diagnostic speci2. To uninstall WiSens Click Start gt Programs gt WiSens Packet Sniffer gt Uninstall mi Teamviewer 3 All Programs 6 wisens Classic SNA Python 2 3 a Uninstall wincvs 4 License Agreement 5 wiSens pri WiSensi Help Uninstalling WiSens Dialog box as below appears i WiSens_Packet_Sniffer MER elcome to the WiSens_Packet_Sniffer Setup Wizard Select whether vou want to repair or remove Wiiens_Packet_Sniffer gt Repair wiSens_Packet_Sniffer C2 Remove WwiSens_Packet_Sniffer Cancel lt Back Finish Uninstalling WiSens Select Remove WiSens_Packet_ Sniffer Click Finish to uninstall WiSens Classic is uninstalled now You are ready to install now b gt Works Page 10 WiSens Classic User Manual Version 2 0 2 1 2 Installing WiSens WiSens software be easily installed following onscreen guided steps To install WiSens Insert CD supplied along with the hardware Select Your CD drive and open e Windows Installer Package 1 295 Double click Opens dialog box as below id Wisens Classic SNA Welcome to the WiSens Classic SNA Setup Wizard The installer will guide you through the steps required to install VSens Classic on your computer WARNING This computer program protected by copyright law and international treaties Unauthorized dupl
3. WiSens Classic Wireless Sensor Network Sniffer Analyser IEEE 802 15 4 ZigBee version User Manual Version 2 0 B2ZWorks Pte Ltd ONE SIMS LANE 06 04 SINGAPORE 387355 Business Registration No 200301972 G sales bzworks com for Sales Enquiries supporti b7works com for Product Enquiries contact bzworks com for General Enquiries 65 68486363 65 68486377 WiSens Classic User Manual Version 2 0 PLEASE READ THE NO WARRANTY NO LIABILITY STATEMENTS AND TRADEMARK INFORMATION DESCRIBED ON THE LAST FEW PAGES OF THIS USER MANUAL BEFORE USING THE PRODUCT OR THE DOCUMENT FURTHER b gt Works Page 2 WiSens 1 1 1 17 1 3 2 3 3 1 3 2 3 3 3 4 4 4 1 Classic User Manual Version 2 0 Table of Contents WiSenso Classic Introduction ssscocesssscoccsssssocesssccocesssscocesssscocesssscocesssssocesssssosessssssses 7 WiSens The ZigBee technology development tool 7 Pre requisites for using WiSens rr 7 Hardware and software of 1 7 TD A 8 DZ T __ __ _ _ 6 6_ _ 8 Wo 07S 9 l stalling yy isens O Classici aaa 10 LEN Uninstalline WiISCHS siciliani isso 10 NM AS TA 11 Llo LIO MH 14 Understanding WiSens GUI 15 SW 15 MendndboolBi 16 Ri LIMO E Sien
4. MER aiar 11 Selecting metalation Tolder __ 12 13 Completion of installation 7 13 Uninstalling WV IS INS 14 Uninstalling WiSens O 14 ___ _ 15 uis __ ___ __ _ E 16 MEO QUO 17 WS A OO WOM Palena 17 View with the bottom pane 18 RUS V 18 A selected Merz Lo PAGE ______ 19 Hardware Handshake aaa 19 Moro ge E _____ _________ ______ cess 20 SAI _ 21 __ 21 Session ON 22 IS Eolo 91g m 24 Node ld ntification tab __________ _______ _ 24 ISB IMAG CE METTE D T UI TEM 25 Node 25 Navigating through Node Packets 26 b gt Works Page 5 c WiSens Classic User Manual Version 2 0 TR m
5. b gt Works Page 26 WiSens Classic User Manual Version 2 0 Print Preview b gt Works Page 27 WiSens Classic User Manual Version 2 0 5 Error Messages In the event of a suspected malfunction minor or major WiSens generates several intuitive error messages to caution the user to take remedial action As the nature of the error messages are self explanatory we do not list them here In the event of any serious errors that the user encounters or would like to find out more about particular error messages please contact BzWorks support personnel by emailing them at support bzworks com or by reporting the error at www bzworks com support b gt Works Page 28 WiSens Classic User Manual Version 2 0 6 IMPORTANT INFORMATION DECLARATIONS NO WARRANTY WiSens Classic is provided as is and use of WiSens is at licensee s risk BzWorks expressly disclaims all warranties representations of conditions of any kind express or implied or statutory including but not limited to any warranty of merchantable quality or fitness for a particular purpose and any warranty that WiSens is delivered free of any third party claims by way of infringement or otherwise BzWorks does not warrant nor make any condition or representations that the functions contained in WiSens will meet the requirements of the licensee that the operation of WiSens will be uninterrupted nor error free or virus free that defects in WiSens
6. 512 MB RAM 2 WiSens sniffer USB stick 1 Deliverable by BzWorks strongly recommend usage of Pentium 4 or better versions of the hardware for best results A minimum of 512 MB RAM is needed to run the application well The higher the RAM capacity the better the sniffing and packet capture performance 1 3 2 Software Required SI No Description Remarks 1 WiSens Classic sniffer software version as Deliverable by BzWorks sold or as updated latest at the website 2 Windows XP Professional Vista 7 User s responsibility 3 NET Framework 2 0 User s responsibility WiSens Classic needs NET framework version 2 0 User is required to download the free distribution of NET framework version 2 0 available at http www microsoft com downloads en details aspx FamilyID 0856eacb 4362 4b0d 8edd aab15c5e04f5 amp displaylang en before installing WiSens Classic b gt Works Page 8 WiSens Classic User Manual Version 2 0 1 3 3 WiSens Hardware The WiSens hardware is supplied as a compactly packed and sleek USB stick housing see picture below e 2 euo WiSens USB stick Data sheets for the supported hardware are available at www bzworks com downloads b gt Works Page 9 WiSens Classic User Manual Version 2 0 2 Installing WiSens Classic Before starting installation of a newer version of WiSens uninstall the older version if any first 2 1 1 Uninstalling WiSens
7. L Start Stop Capture Select Channel Show Hide bottom pane session clears current session Opens a stored session Saves current session in WiSens Classic Mode Configure WiSens Print View data Packets in Black white and grey mode Print preview Tool bar 3 3 Bottom Pane The pane at the bottom of the window has six tabs as below Hardware Info Configure Mode Identification Display Manager Node Fackets Graph Tabs at bottom pane This pane can be hidden when you desire to have the full screen for viewing the packets This pane is very important as here you control the properties of the display Following table presents the basic objectives of each of the tabs in the bottom pane Tab Description Hardware Info The hardware details are displayed Configure This tab allows user to set the properties of the session to be captured such as the channel the time with its unit the display characters etc Node Identification All the nodes participating in a session are registered and listed in this pane along with its PAN ID short address and IEEE address Display Manager The user sets the display properties in this tab b gt Works Page 17 WiSens Classic User Manual Version 2 0 Node Packets Graph This tab complements packets view The time line helps user analyse and navigate to the correct frame for viewing in the display pane 3 3 1 Hiding the bottom pane To hide the bottom pane Cl
8. Number 01 29 Model Number BAW z 1512 2420 1 Device Identification BzZ 1234 Senal Number B 06 03 0001 Hardware Handshake Data b gt Works Page 19 WiSens Classic User Manual Version 2 0 4 Working with WiSens This session details how to capture open a session and work around to derive optimum benefit 4 1 Capturing a session The first and foremost requirement to start work with WiSens is to set the communication settings set the channel number and other parameters in which the sniffing to be carried out etc 411 Configuring the COM port To configure the communication port Click File Configuration or Click Edl Opens following dialog box Capture Settings Seral Port Settings Port Baud Rate 115200 Capture Buffer Total capture buffer memory available in MBytes 3257 100 of total Selected capture buffer memory MBytes 3257 Configuring COM port Set the port baud rate and buffer sizes as shown in the figure above and click Configure b gt Works Page 20 8 WiSens Classic User Manual Version 2 0 4 1 2 Configuring data packet properties The Configure tab allows you to set some of the properties of parameters you need for the display Hardware Info Configure Made Identification Display Manager Node Packets Graph Display Options Show Fields igbee Version gt 7 Ti Microseconds Zigbee Version 2 0Zigb
9. alist and consultant mascot for BzWorks products gives valuable tips and suggestions that allow the user to enjoy maximum performance from usage of BzWorks products 11 WiSens The ZigBee technology development tool WiSens is a tool for professionals who work on IEEE 802 15 4 and ZigBee technology hardware communication stack software development and application developments It is used to sniff detect IEEE 802 15 4 PHY MAC radio signal packets with encapsulated ZigBee 2004 2006 of 2007 frames transmitted in a specified channel The packets sniffed are filtered as per the user defined settings decoded and displayed 1 2 Pre requisites for using WiSens As the packets are displayed according to IEEE 802 15 4 and ZigBee specifications users are expected to possess some knowledge of these formats in order to work effectively with this tool 1 3 Hardware and software of WiSens WiSens Classic is a product consisting of hardware and software components b gt Works Page 7 WiSens Classic User Manual Version 2 0 Sniffer hardware USB stick Sniffer software loaded on to the PC For the sniffer hardware used the corresponding USB driver software needs to be installed separately by the user 1 3 1 Hardware Required The hardware required to setup a complete sniffer system is tabulated below SI No Description Qty Remarks 1 PC Pentium 4 or above equivalent with USB port 1 User to arrange and a minimum of
10. aw data mode shows the raw over the air packet in hexadecimal bytes 4 2 Opening a session To open an archived session Click File gt Open or Click Browse to the folder which the stored file is available and select the desired file Click Open 4 2 1 Saving a session To save a captured session Click File gt Save As The Save As dialog box opens or Click Browse to the folder which to save the session Enter a name for the file Click Save 4 2 2 Setting up display characteristics The display can be set for the colourful WiSens classic or grey scale To set display properties Click File gt Display gt WiSens Classic or Click Click File gt Display gt Black White Gray or Click b gt Works Page 23 WiSens Classic User Manual Version 2 0 WiSens Classic Wireless Sensor Network Analyse Help Mew Open Chrl 0 Save Cris Capture Settings Start Capture F5 Display Hide Configuration Pane Black White Gray Data Page Setup Print Previews 48 Print ej Exit ctr x beng Display options 4 3 Node Identification Every device that joins the network is automatically registered and listed under this tab Node Identification tab helps you manage the housekeeping tasks The nodes listed here appear in TimeLine view Often times the list gets unwieldy with a number of inactive nodes cluttering t
11. ckets Graph SOURCE 1 in 20 40 E fi 71 80 UnMamed Proadcast Node Packets graph The horizontal time line bar at the top of the tab view time correlation for each packet captured during a session by the sniffer b gt Works Page 25 WiSens Classic User Manual Version 2 0 The orange cross mark x appears at the coordinate to correlate the device which transmitted and the time at the top horizontal scale Following figure illustrates how to select a packet at the Node Packets Graph tab WiSens Classic Wireless Sensor Network Analyser Zigbee version File Help oela eels fo 2410 MHe D nedl 2n Ox17 Hardware Info Ly igure Node Identification Display Manager Node Packets Graph SOURCE UnMamed padat 4 Packet Count 4 Selected Packet Index 0 Packets Hecereed 4 Filter OFF Hardware Founc 4 Navigating through Node Packets Graph Note that the selected packet is high lighted with a blue background 4 6 Printing To print Click File gt Print Print dialog box opens Set all the print settings including the number of copies and paper orientation Click OK WiSens fits the packet length in more than one line in case it is too long It breaks the packet and shifts the excess length to the next line thus completing the entire display of the packet for convenient viewing
12. ee 2007 V Length La ASSI fio gt Source W FCS FES E Configuring the sniffer oelect the channel at which you need the sniffer active from the Channel drop down menu The channel selected should be the one at which the target PAN is operating For 2 4 GHz transceivers channel numbers 11 to 26 are valid selections The channel numbers field accepts hexadecimal values equivalent to values 11 to 26 Enter the value and click Set Channel Select the unit of time for display in the packet at the Time field drop down menu Select the parameter for display along with the sniffed packets at Show field drop down menu If you require packet Index displayed at the status bar at the bottom of the window check mark the check box for Packet Index The sniffer is now ready to capture the packets in the ambience To start capture Click Click File gt Start Capture The system automatically clears the display on the screen prior to start of any capture session Classic Wireless Ser Mew Open Save Ctrl 5 Capture Settings Display Hide Configuration Pane Page Setup Prink Preview Print Ctrl P Exit Capturing data packets While viewing display of packets of a session the focus can be easily shifted from one layer to b gt Works Page 21 WiSens Classic User Manual Version 2 0 another i e even as the capture is APSDU for the same packet
13. ens is a registered trademark of BzWorks Pte Ltd Other trademarks or registered trademards are the property of their respective manufacturers or owners Price amp Specifications Price and specifications are subject to change without notice b gt Works Page 30
14. he view This tab helps you remove the inactive nodes and maintain an uncluttered view in Timeline tab Hardware Info Configure Mode Identification Display Manager Node Packets Graph Node Order PAN ID Short Address IFFE Extended Address Add Node Undlaned0 0x2255 OxFFFF OxFFFFFFFFFFFFFFFF DNE PANID Move Up Short Address oxoooo rl a IEEE Address OxPRFFFFFFFFE M Node Identification tab Each device is identified in the list with its node name the PAN ID to which the node is joined the short address and the IEEE extended address Move Up and Move Down buttons help you navigate the list Any selected list item can be removed from the list using the Remove button The fields at the right help you to quickly accomplish the task of removing a node from the list by selecting the node using the drop down menus You can also manually add to the list by entering a node name PAN ID short address and b gt Works Page 24 8 WiSens Classic User Manual Version 2 0 IEEE address and clicking the Add button 4 4 Display Manager Display Manager allows you to select focus the display to present the details you wish to see analyze This powerful feature adds to the flexibility and versatility of WiSens Hardware Into Configure Node Identification Display Manager Made Packets Graph Beacon Reset Filter D estination m Source Anynode E D ata 7 Destination node Ack Apply F
15. ication or distribution of this program or any portion of it may result in severe civil or criminal penalties and will be prosecuted to the maximum extent possible under the law WiSens Setup wizard Click Next Opens b gt Works Page 11 WiSens Classic User Manual Version 2 0 iz WiSens Classic SNA DO Select Installation Folder The installer will install Wisens Classic SNA to the following Folder To install n this folder click Next To install to a different folder enter it below ar click Browse Folder C Program Files Baworks wiSens Classic SNA Install Wisens Classic SNA for yourself or for anyone who uses this computer Everyone Just me Selecting installation folder Click Next b gt Works Page 12 WiSens Classic User Manual Version 2 0 i WiSens Classic SNA Confirm Installation The installer i ready to install Classic SNA on your computer Chek Nest to start the installation Confirm Installation Click Next The program installs and displays completion message i WiSens Classic SNA Installation Complete WiSens Classic has been successfully installed Click Close to exit Please use Windows Update to check for any critical updates to the Framework Close Completion of installation message ui The icon is placed on your desk top after the installation is completed Also the Start menu lists WiSen
16. ick File gt Show Hide or Click L WiSens Classic Wireless Sensor Network Analyser Zigbee version C WiSensData zps File Help ileal le els Packet Count 503 Selected Packet Index 1 Packets Recenved 503 Filter p View with the bottom pane hidden 3 3 2 Status Bar The status bar at the bottom of the window dynamically displays vital information such as packet counts packet buffer size filter status and selected packet index Packet Count 503 Selected Packet Index 1 Packets Hecerveed 503 Filter OFF y Status bar Packet counts Displays the total number of packets captured during a session b gt Works Page 18 WiSens Classic User Manual Version 2 0 The packet buffer size The packet buffer size is set by the user as part of setting the properties using Configure tab The packet buffer size display at the status bar captures the extent of usage of the buffer in percentage Selected packet index Displays the sequential number of the packet which is selected at any given moment Filter Indicates whether the filter is ON or OFF The packet selected has a distinctly marked blue background cursor as below A selected packet 3 4 Hardware Information The tab Hardware Info at the bottom pane displays the sniffer hardware data Hardware Info Configure Node Identification Display Manager Node Packets Graph Version
17. ilter Command Filter Display Manager At the list box at left you can choose any one or a combination or all packet types in a ZigBee network Beacon Data Acknowledgement and Command for viewing After selecting the desired combination of data packets for viewing click Apply Filter to get the display reflect your choice The Reset Filter button reverts the display to default display i e all the packets in view The TurnOff Filter renders all filtering ineffective Further filtering options to the users presented is selection of Destination and Source addresses The display renders only the transmission packets between the selected addresses Alternatively the desired nodes can be selected from the list at the list box for Destination Node and Source Node and clicking the Include button The Remove button takes the selected node off the display 4 5 Node Packets graph Node Packets Graph tab offers a convenient navigation and valuable visual depiction of important information like missing packets the node whose packet is missing and the ability to quickly view the group of packets in question The blue vertical bar in can be moved across in the horizontal plane to focus the view on to the packets of interest in the display pane at the top The green vertical line seen on either sides of the blue line demarcate the group of packets on display Hardware Info Configure Node Identification Display Manager Node Pa
18. ire screen for display of packets Hardware Info Configure Node Identification Display Manager Hode Fa et Graph Display Options Show Fields igbee Version mec Ed Microseconds Zigbee Version 2 2007 Length v LOI RSSI rai TER Iw Source Iw FCS FCS Packet Count 0 Selected Packet Index Hone Packets Recelved 0 Filter OFF WiSens Screen The user can control the display content using the fields for user inputs on the pane at the bottom of the window b gt Works Page 15 WiSens Classic User Manual Version 2 0 3 2 Menu and Tool Bar The menu bar comprises simple File and Help menus 3 2 1 File menu The file menu with all its sub menus is pictured below The file menu facilitates opening a new file or a saved file It also helps in saving and printing the sessions a Wisens Classic Wireless Sei New Open Save Ctrl S Capture Settings Start Capture Display Hide Configuration Pane Page Setup Print Preview Print Ctrl P Exit File menu The sub menus are explained elsewhere in detail 3 2 2 Help menu The contents of the help menu and how to use it will be captured here 3 2 3 Tool Bar The WiSens application presents a set of tools at the tool bar to help users easily and quickly perform required tasks b gt Works Page 16 WiSens Classic User Manual Version 2 0 2405 MHz O
19. na iaia eri 16 9702 Faleria 16 a TO D E N E 16 BOU e ie 17 3 34 Hiding AEREI 18 rai 18 100 1018 6 19 Working with oss sssessssccsssisssescdassssssdsssdsessscsessessssenacsscsssusdsssdsusdscsectsusssenasesssestcesesest 20 SCS SION RR 20 deh COMMIT TOP QUE DOV 20 4 1 2 Configuring data packet properties sees 21 b gt Works Page 3 WiSens Classic User Manual Version 2 0 4 2 ___________8_8____ ___ 22 424 DOO _____________ _ _ _ 23 23 zs INDUGIO 24 O II 25 4 5 Packets m MES 25 40 ____ 26 5 gan dli RETAIL 28 6 IMPORTANT INFORMATION DECLARATIONS e ecce eee ee eee eene eeu 29 b gt Works Page 4 WiSens Classic User Manual Version 2 0 Table of Figures WiSensO USB StiCK CM 9 Uninstalling _ __ ___ 10 10 WISENS
20. or a fundamental breach In no event shall licensor be liable to the other party for any loss or injuries to earnings profits or good will or for any incidental special punitive or consequential damages of any person or entity whether arising in contract tort or otherwise even If either party has been advised of the possibility of such damages Copyright Information for the Manual Copyright 2005 2011 BzWorks All rights reserved This program is protected by US and International copyright laws Warning This program is protected by copyright law and international treaties Unauthorized reproduction or distribution of this program or any portion of it may result in severe civil or criminal penalties and will be prosecuted to the maximum extent possible under the law Disclaimer for the Manual BzWorks have taken care in preparation of this manual but make no expressed or implied warranty of any kind and assume no responsibility for errors or omissions No liability is assumed for incidental or consequential damages in connection with or arising out of the use of the information or programs contained herein Information contained in this publication regarding device applications and the like is b gt Works Page 29 WiSens Classic User Manual Version 2 0 provided only for your convenience and may be superseded by updates and is subject to change without notice Trademark Information Copyright Bzworks Pte Ltd 2005 2011 WiS
21. s Packet Sniffer as a short cut to access the software b gt Works Page 13 WiSens Classic User Manual Version 2 0 2 1 3 Uninstalling WiSens To uninstall WiSens Click Start gt Programs gt WiSens Packet Sniffer gt Uninstall All Programs 7 Tai 2 P Teamviewer 3 n WiSensi Classic SNA Python 2 3 Ww Uninstall wincvs 4 License Agreement Wi SensiEl k c WiSensrE Help Uninstalling WiSens Dialog box as below appears i WiSens Classic SNA Welcome to the Wisens Classic SNA Setup Wizard Select whether you want to repair or remove Wisens Classic SNA Repair WiSens Classic SNA Remove WiSens Classic SNA Uninstalling WiSens Click Finish to uninstall b gt Works Page 14 WiSens Classic User Manual Version 2 0 3 Understanding WiSens GUI To get started check if e WiSens Classic is installed on your PC e The WiSens hardware is connected to the PC s USB or serial ports 3 1 Starting WiSens Classic The installation when completed places an icon the desktop To start WiSens double click the icon on the desk top The application opens as shown below 4 WiSens Classic Wireless Sensor Network Analyser Zigbee version File Help 2 0 Haleja 10 08 2405 MHz e Packets display area This bottom pane lets you set properties navigate etc You can hide this pane and have the ent
22. will be corrected Further BzWorks does not warrant or make any conditions or representations regarding the use or the results of the use of WiSens in terms of its correctness accuracy reliability or otherwise No oral or written information or advice given by BzWorks or others shall create a warranty condition or representation or in any way extend the scope of the as is provision WiSens NO LIABILITY The entire risk as to the results and performance of this WiSens is assumed by licensee or purchaser Neither BzWorks nor its affiliates distributors resellers suppliers agents officers and directors shall have any liability to licensee or to any other person or entity for any damages howsoever caused including but not limited to direct indirect incidental special general consequential punitive or exemplary damages whatsoever including but not limited to loss of revenue or profit damages to property or persons lost or damaged data or other commercial or economic loss even if BzWorks has been advised of the possibility of such damages or they are foreseeable or for claims by third party BzWorks maximum aggregate liability and that of its affiliates distributors resellers suppliers agents officers and directors to licensee shall not exceed the amount paid by the licensee for WiSens This section shall apply whether or not the breach default nonperformance of failure is a breach of fundamental condition or term
23. you can chose to view up to only the MSDU in order to have a closer study and switch to APSDU view or to NSDU views This kind of switching views only affects the display and not the captured packets during a session e WiSens Classic Wireless Sensor Network Analyser Zigbee version C WiSensData zps File Help Ez Ead e ra 2410 MHz Hardware Info Display Options Packet Index Time Microseconds Ziabee Version 2 0 Zigbee 2007 Length LOI RSSI i Source FCS FOS Packet Count 503 Selected Packet Index 0 Packets 503 Filter OFF Li Session on display _ igbee wersion Click MAC Fields to view IEEE 802 15 4 protocol packets Click NWK Fields to view ZigBee Network protocol packets Click APS Fields to view ZigBee Application Support Sub layer protocol packets For each of the packet received the user can select deselect any of the following parameters for display on screen i Packet Index 1 Length iii Source iv Time v LQI RSSI vi FCS b gt Works Page 22 WiSens Classic User Manual Version 2 0 9 For the same packet all the three different modes of viewing are available viz WiSensO Classic Mode Black White Gray Mode and Raw Data Mode While WiSensO Classic mode offers the best choice of colors the Black White Gray mode is good for printing to a non color printer while the r
Download Pdf Manuals
Related Search