ControlNet Traffic Analyzer

Transcription

1 ControlNet Traffic Analyzer 9220-WINTA Reference Manual

2 Important User Information Because of the variety of uses for the products described in this publication, those responsible for the application and use of these products must satisfy themselves that all necessary steps have been taken to assure that each application and use meets all performance and safety requirements, including any applicable laws, regulations, codes and standards. In no event will Rockwell Automation be responsible or liable for indirect or consequential damage resulting from the use or application of these products. Any illustrations, charts, sample programs, and layout examples shown in this publication are intended solely for purposes of example. Since there are many variables and requirements associated with any particular installation, Rockwell Automation does not assume responsibility or liability (to include intellectual property liability) for actual use based upon the examples shown in this publication. Allen-Bradley publication SGI-1.1, Safety Guidelines for the Application, Installation and Maintenance of Solid-State Control (available from your local Rockwell Automation office), describes some important differences between solid-state equipment and electromechanical devices that should be taken into consideration when applying products such as those described in this publication. Reproduction of the contents of this copyrighted publication, in whole or part, without written permission of Rockwell Automation, is prohibited. Throughout this publication, notes may be used to make you aware of safety considerations. The following annotations and their accompanying statements help you to identify a potential hazard, avoid a potential hazard, and recognize the consequences of a potential hazard: WARNING! Identifies information about practices or circumstances that can cause an explosion in a hazardous environment, which may lead to personal injury or death, property damage, or economic loss. ATTENTION! Identifies information about practices or circumstances that can lead to personal injury or death, property damage, or economic loss.

3 IMPORTANT Identifies information that is critical for successful application and understanding of the product. Rockwell Automation Support Before you contact Rockwell Automation for technical assistance, we suggest you please review the troubleshooting information contained in this publication first. If the problem persists, call your local distributor or contact Rockwell Automation in one of the following ways: Phone United States/Canada Outside United States/Canada You can access the phone number for your country via the Internet: 1. Go to 2. Click on Product Support ( 3. Under Support Centers, click on Contact Information Internet 1. Go to 2. Click on Product Support ( Your Questions or Comments on this Manual If you find a problem with this manual, please notify us of it on the enclosed How Are We Doing form. Rockwell Automation is a trademark of Rockwell Automation ControlNet is a trademark of ControlNet International. Microsoft, Windows, Windows 95 and Windows NT are registered trademarks of Microsoft Corporation.

4

5 Summary of Changes Summary of Changes This release of the ControlNet Traffic Analyzer Reference Manual contains new and updated information, specifically about Windows 2000 and Windows XP. You will see change bars, as shown to the left of this paragraph, throughout this manual to help you quickly identify revisions. 1 Publication 9220-RM052C-EN-P - August 2002

6 Summary of Changes 2 Publication 9220-RM052C-EN-P - August 2002

7 Table of Contents Chapter 1 Introduction What This Chapter Contains Main Structure of ControlNet Information Exchange on a ControlNet Network Link ControlNet Messages ControlNet MAC Frame Structure Audience Software Package Hardware Recommendations Install the Traffic Analyzer Uninstall the Previous Version of the Traffic Analyzer Install the Traffic Analyzer Terminology Common Techniques Used in This Manual Rockwell Automation Support Local Product Support Technical Product Assistance Your Questions or Comments About This Manual The ControlNet Traffic Analyzer Tool Chapter 2 What This Chapter Contains The User Interface The Control Panel View (the Upper Part) The Filter/Trigger View (the Middle Part) The MAC Frame Data View (the Lower Part) Chapter 3 Accessories and Menus What This Chapter Contains Accessories The Toolbar The Status Bar Menus and Shortcuts Main Menu File Menu Edit Menu Actions Menu View Menu Window Menu Help Menu Pop-up Menus Stop Trigger List Pop-up Menu Start Trigger List Pop-up Menu Pre-Filter List Pop-up Menu Post-Filter List Pop-up Menu MAC Frame Data View Pop-up Menu i Publication 9220-RM052C-EN-P - August 2002

8 Table of Contents ii Chapter 4 Triggers and Filters What This Chapter Contains Triggers Start Trigger View Stop Trigger View How to Configure a Trigger Status of Frames Type of Frame How to Configure a Start Trigger on Data Example 1: Fixed LPacket Example 2: Generic LPacket Example 3: Fixed LPacket Using the UCMM Service List. 4-8 Filters Pre-Filter View Disable Time Stamp How to Configure a Pre-Filter Post-Filter View How to Configure a Post-Filter Interpreting Control Bits Chapter 5 Display Information What This Chapter Contains Display View Options Time Display Data Format MAC Frames LPackets Interpreted LPacket Header for a Fixed Tag: Lpacket Header for a Generic Tag: Other Options Tools to Manage Frames Bookmarks Find Data Simple Find Advanced Find Select a Range of Frames Compute Time Difference Copy Data to the Clipboard Publication 9220-RM052C-EN-P - August 2002

9 Table of Contents iii Network Information and Statistics Chapter 6 What This Chapter Contains Network Information Statistics Statistical Data: Network Traffic Statistical Data: Network Utilization Chapter 7 Other Commands and Options What This Chapter Contains Save a Document Create a Report Go Offline/Online Hardware Settings Reset the ControlNet Card and Time Application Options Save Options Buffer Size Report Option Default Display View Options Chapter 8 Troubleshooting What This Chapter Contains Warning Messages Overflow/Underflow FIFO Error in the ControlNet ASIC The PC Is Not Able to Unload All the Received Data Good Scheduled Data Example All Unscheduled Data Starting on Good Moderator Example Overflow Error in the ControlNet Traffic Analyzer Internal Buffer Publication 9220-RM052C-EN-P - August 2002

10 Table of Contents iv Appendix A Function and Shortcut Keys What This Appendix Contains A-1 Function Keys A-1 Shortcut Keys A-2 File Menu Shortcut Keys A-2 Edit Menu Shortcut Keys A-2 Actions Menu Shortcut Keys A-3 View Menu Shortcut Keys A-3 Window Menu Shortcut Keys A-3 Help Menu Shortcut Keys A-4 Start Trigger Menu Shortcut Keys A-4 Stop Trigger Menu Shortcut Keys A-4 Pre-Filter Menu Shortcut Keys A-5 Post-Filter Menu Shortcut Keys A-5 MAC Frame Data View Menu Shortcut Keys A-6 Publication 9220-RM052C-EN-P - August 2002

11 Chapter 1 Introduction What This Chapter Contains This chapter introduces you to the ControlNet Traffic Analyzer tool. The following table describes what this chapter contains and where to find specific information. For information about See page the main structure of ControlNet 1-1 the audience for this manual 1-3 the Traffic Analyzer tool s software package 1-4 hardware recommendations 1-4 installation of the Traffic Analyzer tool 1-5 terminology used in this manual 1-8 common techniques used in this manual 1-9 Rockwell Automation support 1-9 Main Structure of ControlNet The ControlNet Traffic Analyzer tool is a 32-bit Windows application running on top of a 32-bit ControlNet Driver. This application is used to examine, store, and analyze network data on a ControlNet network. You can view the behavior of frames on the network, test ControlNet reliability, and make sure that every transmission on the network is correct. Information Exchange on a ControlNet Network Link A ControlNet network link s most important function is to transport time-critical control information (i.e., I/O status and control interlocking). Other information (i.e., non time-critical messages such as program uploads and downloads) is also transported, but does not interfere with time-critical messages because of ControlNet s unique time-slice algorithm. On a ControlNet network link, information is transferred between nodes by establishing connections. Each message sent by a producer contains a Connection ID (CID). Nodes that have been configured to recognize the CID consume the message, therefore becoming a consumer. 1

12 1-2 Introduction See the ControlNet International Specification for more information about information exchange on a ControlNet network link. The ControlNet International Specification can be purchased from ControlNet International. The following illustration describes the ControlNet network s link layer services. Link Layer Services Network Update Time (NUT) Scheduled Service Unscheduled Service Network Maintenance Service the Guardband 0... SMAX 0... SMAX SMAX Time ControlNet Messages The repetitive time interval in which data can be sent on a link is called the Network Update Time (NUT). The NUT is divided into three parts containing three defined types of Media Access Control (MAC) frames: Scheduled Every scheduled node in sequential order is guaranteed one opportunity to transmit. Information that is time-critical is sent during the scheduled part of the interval. The bandwidth is reserved in advance to support real time data transfers. Real time data transfers include: real time control data (I/O updates) analog data peer to peer interlocking Unscheduled All nodes transmit on a rotating basis in sequential order. This rotation repeats until the time allocated for the unscheduled portion is used up.

13 Introduction 1-3 The amount of time available for the unscheduled portion is determined by the traffic load of the scheduled portion. ControlNet guarantees at least one node will have the opportunity to transmit unscheduled data every interval. The starting node for each NUT rotates to guarantee each node will have an unscheduled transmit time. The remaining bandwidth supports non time-critical data transfers. Non time-critical data transfers include: connection establishment peer to peer messaging programming (uploads and downloads) Moderator The node with the lowest MAC ID (node address) assumes the moderator role. The moderator frame is transmitted to keep the other nodes synchronized. This moderator frame is sent in the guardband. ControlNet MAC Frame Structure All transfers use the MAC frame format shown in the following illustration. MAC Frame Source MAC Bytes Max LPacket LPacket... LPacket Each node can send only one MAC Frame at each opportunity to transmit. Each MAC Frame contains one or more LPackets (Link-Packets). Each LPacket contains one piece of application information. Audience This interface software is written for network specialists. It will assist network engineers in designing and debugging of ControlNet products and will help maintenance personnel during installation or troubleshooting of a ControlNet network.

14 1-4 Introduction Software Package The software package is a Windows based product so as to maintain consistency across all ControlNet software products and to provide a user-friendly human interface. It is composed of a CD-ROM installation disk plus the reference manual. Hardware Recommendations The ControlNet Traffic Analyzer requires a dedicated computer with the following minimum configuration for: Microsoft Windows 95 or Windows 98 or Windows Me 166MHz Pentium-based PC 32MB RAM 10MB free hard drive space a color monitor with an 800 x 600 minimum resolution (1,024 x 768 recommended) Microsoft Windows NT MHz Pentium-based PC 80MB RAM 10MB free hard drive space a color monitor with an 800 x 600 minimum resolution (1,024 x 768 recommended) Microsoft Windows 2000 or Windows XP 366MHz Pentium-based PC 128MB RAM 10MB free hard drive space a color monitor with an 800 x 600 minimum resolution (1,024 x 768 recommended) To capture data on a ControlNet network, one of the following interface cards is required: 1784-PCC Series B Allen-Bradley ControlNet Interface Card (PCMCIA) with: installation disk version 1.6 or later (shipped with the 1784-PCC card). If your installation disk is earlier than 1.6, we recommend that you download the latest version from the website Microsoft Windows 95, Windows 98, Windows Me, Windows NT 4.0, Windows 2000, or Windows XP

15 Introduction PCC Series A Allen-Bradley ControlNet Interface Card (PCMCIA) with: installation disk version 1.6 or later (shipped with the 1784-PCC card). If your installation disk is earlier than 1.6, we recommend that you download the latest version from the website Microsoft Windows 95, Windows 98, Windows Me, Windows 2000, or Windows XP CN-1000 Pyramid Solutions ControlNet Interface Card (ISA) with: 1.4.1F firmware or later 1.2 driver or later Microsoft Windows 95, Windows 98, Windows Me, Windows NT 4.0, Windows 2000, or Windows XP These interface cards contain a ControlNet ASIC that captures all data on the network. No ControlNet MAC ID is required for the Traffic Analyzer, since the ASIC is in listen-only mode. The data will be analyzed by the Traffic Analyzer tool after it has been processed by the ASIC. Install the Traffic Analyzer Before you install the 1784-PCC driver and the Traffic Analyzer, you should uninstall the previous version of the Traffic Analyzer. Uninstall the Previous Version of the Traffic Analyzer To uninstall the previous version of the Traffic Analyzer: 1. Click Start>Settings>Control Panel. 2. Double click the Add/Remove icon. 3. Double click ControlNet Traffic Analyzer. 4. Click Yes to uninstall the Traffic Analyzer. TIP If you are prompted to remove unused shared files, select No to All.

16 1-6 Introduction Install the Traffic Analyzer IMPORTANT We recommend that you exit all Windows programs before running this Setup program. TIP The CD-ROM supports Windows Autorun. If you have Autorun configured, once the CD is inserted into the CD-ROM drive, the installation will automatically start at the first setup screen. 1. Insert the CD-ROM into the computer s CD-ROM drive. If Auto Insert Notification (Autorun) is enabled on your CD-ROM drive, the Setup Utility will start automatically. Go to step 5. Otherwise, continue with step Select Start>Run. 3. At the Run pop-up window, type x:\setup, where x is the CD-ROM drive. 4. Click OK. 5. You see this screen: 6. Click on Install Products.

17 Introduction 1-7 You see this screen: 7. Click on Install ControlNet Traffic Analyzer. 8. Follow the on-screen instructions to install the driver and the Traffic Analyzer. You need to have a ControlNet 1784-PCC PC card or a CN-1000 ISA card installed to work on line. If you do not have a card, ask your local Rockwell Automation representative for a 1784-PCC card package at: Telephone: or contact Pyramid Solutions for a CN-1000 card at: Web: The ControlNet Traffic Analyzer has to be the single client of the ControlNet card. You can use the ControlNet 1784-PCC PC card or the CN-1000 ISA card for applications other than the Traffic Analyzer, but you cannot run these applications simultaneously with the same card. If you use another application with the card, you must go in offline mode or close the Traffic Analyzer tool. For more information about the online/offline modes, see page 7-3. IMPORTANT Some screen savers take all the CPU resources. When the Traffic Analyzer tool is in data recording mode, it may lose some data. You must choose the blank screen or none option in the display properties of the Screen Saver.

18 1-8 Introduction IMPORTANT You may need to disable Power Management if data captures are missing data. IMPORTANT The ControlNet Traffic Analyzer and RSLinx cannot run simultaneously via the same network interface card. Terminology Use the following table to become familiar with some terms specific to the Traffic Analyzer tool. Term Refers to CNA10 the ControlNet ASIC containing the Media Access Control interface circuitry used to send and receive data on a ControlNet network. Connection ID (CID) an identifier assigned to a transmission that is associated with a particular connection between producers and consumers that identifies a specific piece of application information. Filter a selection used to let frames that meet a specified condition to pass from the network to the buffer, or from the buffer to the display. For example, you may set up an input filter that will only allow frames with a source MAC ID of 10 to pass from the network to the collection buffer. Fixed Tag a two byte tag that identifies a specific service to be performed by the node identified in the second byte of the fixed tag. The second byte of the fixed tag contains the MAC ID of the destination node. Generic Tag a three byte tag that identifies a specific piece of application information (same as Connection ID). LPacket link packet - data packaged and labeled by a node in preparation for transmission. LPackets contain a header and data. MAC Frame a collection of MAC symbols transmitted on the medium that contains a preamble, start delimiter, source MAC ID, LPackets, CRC, and end delimiter. After the ASIC processing, a MAC frame contains time, status, type, source MAC ID and LPackets. MAC Symbol symbols that represent the data bits to be encoded and transmitted by the Physical Layer. Trigger a collection that causes data collection to start or stop. You specify the condition the same way that a filter is specified. Trigger Point a point within the collection buffer where a trigger occurs. If the trigger point is at the start of the buffer, data collection will begin when a trigger condition is detected. If the trigger point is at the end of the buffer, data collection will stop when a trigger condition is detected. Unconnected Message Manager (UCMM) the component within a node that transmits and receives unconnected explicit messages and sends them directly to the Message Router object.

19 Introduction 1-9 Common Techniques Used in This Manual The following conventions are used throughout this manual: bulleted lists provide information, not procedural steps numbered lists provide sequential steps text written like this identify screen, menu, and toolbar names information in bold contained within text, identify areas of the screen, such as field names, radio buttons and check boxes text written like this identify icons a menu item in this format Control Panel>Define Start Trigger identifies the submenu item after the caret (>) accessed from the menu pictures of symbols and/or screens represent the actual symbols you see or the screens you use TIP This symbol identifies helpful tips Rockwell Automation Support Rockwell Automation offers support services worldwide, with over 75 sales/support offices, 512 authorized distributors, and 260 authorized systems integrators located throughout the United States alone, plus Rockwell Automation representatives in every major country in the world. Local Product Support Contact your local Rockwell Automation representative for: sales and order support product technical training warranty support support service agreements Technical Product Assistance If you need to contact Rockwell Automation for technical assistance, call your local Rockwell Automation representative.

20 1-10 Introduction Your Questions or Comments About This Manual If you find a problem with this manual, please notify us of it on the enclosed How Are We Doing form (at the back of this manual). If you have any suggestions about how we can make this manual more useful to you, please contact us at the following address: Rockwell Automation, Allen-Bradley Company, Inc. Control and Information Group Technical Communication 1 Allen-Bradley Drive Mayfield Heights, OH

21 Chapter 2 The ControlNet Traffic Analyzer Tool What This Chapter Contains Read this chapter for a description of the options provided in the Traffic Analyzer tool. The following table describes what this chapter contains and where to find specific information. For information about See page the user interface 2-1 the Control Panel view 2-2 the Filter/Trigger view 2-4 the MAC Frame Data view 2-5 The User Interface The User interface of the ControlNet Traffic Analyzer tool was designed to be easy to use and to give you the maximum amount of information. When you open a document, you see a window divided into three parts: the Control Panel view (upper part) the Filter/Trigger view (middle part) the MAC Frame Data view (lower part) These three parts are separated by horizontal splitters that are used to resize the views. Horizontal splitters Horizontal splitters

22 2-2 The ControlNet Traffic Analyzer Tool The Control Panel View (the Upper Part) When you launch the Traffic Analyzer tool and open a project, you see a screen similar to the one shown below. The Control Panel allows you to follow data flow, start and stop analysis, access trigger and filter definitions, and display view options. You can also change data storage behavior (Full or Ring Buffer). TIP If the Start icon in the Control Panel contains a red X ( ), you can click the Start icon to access the Hardware Settings dialog box. See "Go Offline/Online Hardware Settings", page 7-3, for more information.

23 The ControlNet Traffic Analyzer Tool 2-3 The Control Panel view has two main functions: control the document during the configuration of the next record. You can: configure triggers and filters in the Filter/Trigger view (but only one type of filter or trigger at a time). You do this via the Control Panel by clicking on the Start Trigger, Stop Trigger, Pre-Filter or Post-Filter icons. You select one topic for the current view. See the Trigger/Filter views in Chapter 4 for more information. click on the Full/Ring Buffer icon to define in which type of buffer the next record will be configured. click on the Display icon to access a dialog box in which you choose display options for the MAC Frame Data view. See Display View Options, page 5-1, for more information. The following illustration shows the function of each element of the Traffic Analyzer Control Panel when the Traffic Analyzer is not in data recording mode. Click on the Start Trigger, Pre-Filter, Post-Filter, or Stop Trigger icons to view the corresponding parameters in Filter/Trigger view. Click on this icon to view the Display View Options dialog box. Click on this icon to change the data buffer behavior. the second function of the Control Panel is to control the record itself. You can: start and stop the data record by clicking on the Start or Stop icons. You can also perform these two actions from the Actions menu or by pressing the F10 and F11 keys respectively. see how long the data record has been Started via a clock. know the number of frames filtered per second after the ASIC and after the pre-filter, respectively via two progress bars (Frames/s) with small edits above.

24 2-4 The ControlNet Traffic Analyzer Tool The following illustration shows the function of each element of the Traffic Analyzer Control Panel when the Traffic Analyzer is in data recording mode. Click on the Start icon to start analyzing the frames. Click on Start Trigger to process the data. The time the data capture has been running or started. Displays the data traffic after CNA10 ASIC filtering of ControlNet. Click on the Stop icon to stop analyzing the frames. Displays the data traffic after pre-filtering. The Filter/Trigger View (the Middle Part) The Filter/Trigger view is used to configure the triggers or the filters you need for your analysis. Depending on the selection you made in the Control Panel (upper part of the document), you see one of the following four parameters: Start Trigger Stop Trigger Pre-filter Post-filter The middle part of the user interface is shown in the following illustration. The Pre-Filter option has been selected. See Chapter 4 for a more detailed explanation of the Filter/Trigger view.

25 The ControlNet Traffic Analyzer Tool 2-5 The MAC Frame Data View (the Lower Part) The MAC Frame Data view is used to show the ControlNet MAC frames captured during the analysis. You can have it filtered through the post-filter before the data is displayed. IMPORTANT If you filter data through the post-filter, you will see only the data after a post-filtering and not necessarily all data recorded in the buffer. By default, when you open a new document, post-filtering is disabled. You have the possibility to view the data in different formats using the display options. Display options are explained in Display Information, Chapter 5. The following graphic shows an example of MAC Frame Data view, showing three frame records in Interpreted format. See Data Format, page 5-2, for an explanation of the three data formats. MAC Frame Data view information is interpreted as follows: Column header name Frame # Time Status Identifies the number of the recorded MAC frame in the collection buffer. the time formats. The four time formats are days, hours, minutes, and seconds. See Time Display, page 5-2 for an explanation of each option. the status of frames. The three statuses are Good, Bad, and Null. See Status of Frames, page 4-4 for an explanation of each status. In short display, only the first letter (G, B, or N) of each term displays. the displayed types. The four types are Sched.. (scheduled), Unsch.. (unscheduled), Moder.. (moderator), or Aborted (a special case used only for bad frames). See ControlNet Messages, page 1-2 for an explanation of each type. In short display, only the first letter (S, U, M, or A) of each term displays. the source MAC ID.

26 2-6 The ControlNet Traffic Analyzer Tool Column header name Data ASCII Identifies the data formats. The three data formats are MAC Frame, Lpacket, and Interpreted. See Data Format, page 5-2 for an explanation of the data formats. an ASCII interpretation of the frame data.

27 Chapter 3 Accessories and Menus What This Chapter Contains Read this chapter for a description of the menu options and other accessories provided in the Traffic Analyzer tool. The following table describes what this chapter contains and where to find specific information. For information about See page accessories 3-1 menus and shortcuts 3-2 Accessories The Toolbar The toolbar contains buttons for commonly used menu items. Use the toolbar to access these items quickly without opening the menu. Each button is a graphical representation of a command. The toolbar is shown below. Only the buttons specific to the Traffic Analyzer tool are defined. Network Information Add Bookmark Previous Bookmark Advanced Find Find Previous Compute Time Difference About Statistics Next Bookmark Delete All Bookmarks Simple Find Find Next Display Range Data view (Full Screen) Help

28 3-2 Accessories and Menus The Status Bar The Status Bar contains three panes. Each pane s function is described in the following illustration. This pane is used to pass messages. These messages appear when you select an action from a menu or from the toolbar. It gives a brief description of the function. This pane represents an LED and tells the ControlNet driver status. This pane is used to show status messages from the ControlNet driver. These messages appear when the driver state has changed and could indicate a driver error. Menus and Shortcuts Menus are used as entry points to do a specific action within your application. You will sometimes find shortcuts associated to menu entries. A shortcut is a simple way to do an action using a key or a combination of keys. See Appendix A for a list of function and shortcut keys. You may use the Traffic Analyzer tool without the mouse interface - expect a mouse is required to use the Compute Time Difference dialog box which makes use of the drag and drop function. Main Menu The main menu is the entry point to the main actions you can perform in the Traffic Analyzer tool. You will find the standard main menu functions (i.e., New, Open, Save) as well as functions specific to the Traffic Analyzer tool. The following sections contain a summary of all menu options and the corresponding shortcuts. File Menu The File menu contains the following options, if a project is not open: The most recently opened project(s) show in this area. Up to four can be listed.

29 Accessories and Menus 3-3 If a project is open, you see the following menu: Creates a report in RTF format. Edit Menu When you click on Edit, you see the following menu: Or, you see the bookmark menu:

30 3-4 Accessories and Menus Or the Find menu: Once you define a find criterion, you can find the next or previous string that matches the criterion. Actions Menu When you click on Actions, you see the following menu if a project is not open: Display the Network Monitoring window. You must be connected to a ControlNet network. Display the Statistical Information window. You must be connected to a ControlNet network. Switch to online mode or offline mode. Reset the ControlNet card and ASIC timer. You see the following menu if a project is open: Start or stop recording the current project. Only the frames you select will display. Displays the Compute Time Difference dialog box.

31 Accessories and Menus 3-5 Or, you see the Control Panel menu: View Menu When you click on View, you see the following menu if a project is not open: Displays the Options dialog box. Or, if a project is open, you see the following menu: Make MAC Frame Data view the full screen. Click again to return to normal view.

32 3-6 Accessories and Menus Window Menu You see the following menu when you click on Window: Help Menu You see the following menu when you click on Help: Pop-up Menus A pop-up menu is hidden until you perform an action that causes it to display. In the ControlNet Traffic Analyzer, pop-up menus are implemented only from Filter/Trigger view or MAC Frame Data view by clicking the right mouse button.

33 Accessories and Menus 3-7 Stop Trigger List Pop-up Menu You see the following pop-up menu when you click the right mouse button in the stop trigger list area of Filter/Trigger view: Displays the Edit Trigger dialog box so you can add or edit a trigger condition. Start Trigger List Pop-up Menu You see the following pop-up menu when you click the right mouse button in the start trigger list area of Filter/Trigger view: Displays the Trigger on data dialog box so you can add or edit a trigger on a condition. Pre-Filter List Pop-up Menu You see the following pop-up menu when you click the right mouse button in the pre-filter list area of Filter/Trigger view: Displays the Edit Filter dialog box so you can add or edit a filter condition.

34 3-8 Accessories and Menus Post-Filter List Pop-up Menu There are two list areas for a post-filter. They are referred to as the top list and the bottom list. You see the following pop-up menu when you click the right mouse button in the post-filter top list area: Displays the Edit Filter dialog box so you can add or edit a filter condition. You see the following pop-up menu when you click the right mouse button in the post-filter bottom list area: Displays the Edit LPacket dialog box so you can add or edit an LPacket condition. MAC Frame Data View Pop-up Menu You see the following pop-up menu when you click the right mouse button in MAC Frame Data view: Displays the Display View Options dialog box so you can change display options.

35 Chapter 4 Triggers and Filters What This Chapter Contains The following table describes what this chapter contains and where to find specific information. For information about See page triggers 4-1 filters 4-8 Triggers A trigger is used to initiate a process or to act as a reaction. There are two types of triggers: start and stop. A start trigger initiates the process; a stop trigger stops the process. Start Trigger View You see the Start Trigger view when you click the Start Trigger icon in the Control Panel or from the Actions menu, click on Control Panel>Define Start Trigger. A trigger is a prerequisite condition, a passage toward the pre-filter phase. Once you start a trigger condition, there is nothing else to do. There are two types of trigger conditions: one related to the contents of the frames and the other related to the time elapsed. You can combine the two types of conditions. Triggering will start provided at least one condition is met. The Start Trigger view is shown below. Start without conditions. Start with conditions. Define how much time is needed to start the analysis. Enable/disable trigger condition. Start trigger condition.

36 4-2 Triggers and Filters You can initiate only one specific Start Trigger: a Start Trigger on Data. See page 4-4 for more information. The following illustration shows start trigger conditions with a Start Trigger on Data added. Start Trigger on Data. Stop Trigger View You see the Stop Trigger view when you click the Stop Trigger icon in the Control Panel or from the Actions menu, click on Control Panel>Define Stop Trigger. There are two types of trigger conditions: one related to the contents of the frames and the other related to the time elapsed. You can combine the two types of conditions. Triggering will stop provided at least one condition is met. You can check the Center Trigger in Ring Buffer box to add data following the first Stop on Conditions and keep the preceding data as well. Otherwise, when the box is not checked, the data in the buffer is the data preceding the Stop Trigger. The Stop Trigger view is shown below. Stop without conditions. Stop with conditions. Define how much time is needed to stop the analysis after a Start. Stop the trigger in the center of the Ring buffer, keeping data preceding and adding data following the given condition. Enable/disable trigger condition. Stop trigger condition.

37 Triggers and Filters 4-3 How to Configure a Trigger When you choose to start or stop a trigger on a condition, a trigger list area appears. You can add, edit, or delete conditions in this list area by clicking the right mouse button. A pop-up menu appears. TIP Another way you can add, edit, or delete a trigger condition is by pressing the Insert, Enter, or Delete key, respectively. When you add or edit a trigger condition, you see the following box: Define the Producer MAC ID(s) you want to trigger. You can define: a single Producer MAC ID (in a range 0-255). a group of IDs. Separate the range by a hyphen (2-88). The range can extended from 0 to 255. multiple IDs. Separate the IDs by a semi-colon (2;9;27) a group and multiple IDs (2-7;3;8). If you do not enter a value in this field, the full range (0-255) becomes the default value. Define the Producer MAC ID(s) you want to trigger in each LPacket. For a Generic LPacket, it is the Producer/Consumer ID. For a Fixed LPacket, it is the Destination ID. For a Broadcast ID, it is 255. You can define: a single Producer/Consumer MAC ID (in a range 0-255). a group of IDs. Separate the range by a hyphen (2-88). The range can extended from 0 to 255. multiple IDs. Separate the IDs by a semi-colon (2;9;27). a group and multiple IDs (2-7;3;8).

38 4-4 Triggers and Filters TIP For a definition of Status, see below. For a definition of Type, see page 1-2. Status of Frames A frame status can be defined in three ways: Good: a frame correctly received by the Traffic Analyzer tool. Bad: the Traffic Analyzer tool has detected a problem with this frame (e.g. a CRC problem). Null: a frame without any data. Type of Frame A frame type can also be defined in three ways: Scheduled Unscheduled Moderator See page 1-2 for a definition of frame types. How to Configure a Start Trigger on Data When you want to add trigger onto data, you add a Start Trigger on Data condition. This implies that you are looking for a specific element and that you know its source, the type of frame, and its destination. At the LPacket level, the standard trigger only checks for the Producer/Consumer MAC ID in a Generic LPacket or for the Destination MAC ID in a Fixed LPacket. Within these limits, you can create an unlimited list of trigger conditions that will not affect the processing time during the record. If you want to start after a specific LPacket - for example if there is a sign of future network troubles - you can create a unique and elaborate trigger condition on an LPacket.

39 Triggers and Filters 4-5 Each byte in the LPacket Header can be checked; a sequence of a maximum of 8 bytes will appear in the LPacket data field. When you choose to start a trigger on a condition, a trigger list area appears. You can add, edit, or delete a Start Trigger on Data condition in this list area by clicking the right mouse button. A pop-up menu appears. Only one Start Trigger on Data can be created at one time. Once a Start Trigger on Data has been added, it can be edited or deleted. Also, you can create a Start Trigger on Data only on Good Scheduled or Good Unscheduled frames. If you choose to add or edit a Start Trigger on Data, the Trigger on data dialog box appears. You must enter a value in the Producer MAC ID and/or Consumer MAC ID, and link data (if an offset is defined) field(s). Three examples follow showing the different options you can choose in this dialog box.

40 4-6 Triggers and Filters Example 1: Fixed LPacket When you want to add a Start Trigger on Data with a fixed Tag, you see the following dialog box. Enter the Producer MAC ID you want to trigger. Define the frame type. Enter the destination MAC ID you want to trigger. Choose the type of LPacket you want to trigger. When Fixed Tag is chosen, enter the Service byte in hexadecimal. Enter the size of the LPacket you want to trigger (enter in hexadecimal). Enter the control bits of the LPacket you want to trigger (enter in hexadecimal). The fields reflect the value entered in the Control Bits field above. See Interpreting Control Bits, page Enter the LPacket Link Data Offset in hexadecimal. The LPacket Link Data Offset 0 starts after the LPacket Header. Enter the Link Data you want to check. Enter in hexadecimal, limited to eight characters. Select a predefined UCMM service. This value will automatically set the Offset and Link Data. Use this as a quick way to find a service without entering it. This option is disabled if Generic Tag is selected.

41 Triggers and Filters 4-7 Example 2: Generic LPacket When you choose Generic Tag, two new fields appear to define the Connection ID. They replace the Service and Consumer MAC ID fields. Define the Producer/Consumer MAC ID you want to trigger. Set the Connection ID Number in hexadecimal. The Predefined UCMM Service is disable when Generic Tag is chosen.

42 4-8 Triggers and Filters Example 3: Fixed LPacket Using the UCMM Service List When you want to use a predefined UCMM Service, you see the following dialog box. The UCMM Service number is 0x83. The LPacket Data Offset and Link Data values are forced to match the selected UCMM Service. A predefined UCMM Service is selected. Filters Filtering refers to a selection used to allow frames that meet a specified condition to pass from the network to the buffer, or from the buffer to the display. For example, you may set up an input filter that will only let frames with a source MAC ID of 10 to pass from the network to the collection buffer. There are two filtering levels: Pre-filter: determine which frames you will put into the buffer. This is a sorting procedure used mainly for adding filters on the destination of a frame. Post-filter: determine which frames are going to be in the buffer, i.e., which ones you want to see on the screen. This is the second level of sorting, more precise and elaborate than the pre-filter sort.

43 Triggers and Filters 4-9 Pre-Filter View You see this view when you have selected the Pre-Filter icon in the Control Panel. TIP You can also access the Pre-Filter view from the Actions menu: Control Panel>Define Pre-Filter. The Pre-filter view is shown below. Click on this radio button to get all frames from the network except the null. Click on this radio button to filter on conditions. Check this box to Disable the time stamping (the time will not be included in the data capture). Enable/disable filter condition. Pre-Filter condition. Disable Time Stamp ASIC provides time indication for each frame. If the network traffic conditions are extremely heavy and/or the data capture is missing traffic, then you may need to lighten the task of the ASIC. You can do this by disabling the Time Stamp. See Chapter 8, Troubleshooting. How to Configure a Pre-Filter When you choose to filter on conditions, a filter condition list area appears. You can add, edit, or delete a pre-filter condition in this list area by clicking the right mouse button. A pop-up menu appears. TIP Another way you can add, edit, or delete a filter condition is by pressing the Insert, Enter, or Delete key, respectively.

44 4-10 Triggers and Filters When you add or edit a pre-filter, you see the following dialog box: Define the Producer MAC ID(s) you want to filter. You can define: a single Producer MAC ID (in a range 0-255). a group of IDs. Separate the range by a hyphen (2-88). The range can extended from 0 to 255. multiple IDs. Separate the IDs by a semi-colon (2;9;27). a group and multiple IDs (2-7;3;8). If you do not enter a value in this field, the full range (0-255) becomes the default value. Define the Producer MAC ID(s) you want to filter in each LPacket. For a Generic LPacket, it is the Producer/Consumer ID. For a Fixed LPacket, it is the Destination ID. For a Broadcast ID, it is 255. You can define: a single Producer/Consumer MAC ID (in a range 0-255). a group of IDs. Separate the range by a hypen (2-88). The range can extended from 0 to 255. multiple IDs. Separate the IDs by a semi-colon (2;9;27). a group and multiple IDs (2-7;3;8). TIP For a definition of Status, see page 4-4. For a definition of Type, see page 1-2.

45 Triggers and Filters 4-11 Post-Filter View You see this view when you have selected the Post-Filter icon in the Control Panel. TIP You can also access the Post-Filter view from the Actions menu: Control Panel>Define Pre-Filter. Click on this radio button to get all stored frames from the Data Buffer. Click on this radio button to filter on conditions. Click this button to enable any changes in post-filtering. This will update the MAC Frame Data view. Enable/disable filter condition. First Post-Filter condition. The Yes means LPacket filter is enabled. Second Post-Filter condition. LPacket filter is enabled. How to Configure a Post-Filter Defining a post-filter is a little bit more complex than defining a pre-filter. Post-filtering provides a more precise way of filtering. When you choose to post-filter on conditions, two filter condition list areas appear. These two lists have been designed to show all the information needed by the post-filter. the first list looks like the Pre-Filter list and performs almost the same function; it will be referred to as the top list. the second list is used to filter on some LPacket data and will be referred to as the bottom list.

46 4-12 Triggers and Filters You can add, edit, or delete a post-filter condition in these two list areas by clicking the right mouse button. A pop-up menu appears. TIP Another way you can add, edit, or delete a post-filter condition is by pressing the Insert, Enter, or Delete key, respectively. When you add or edit a post-filter in the top list, you see the following dialog box: Define the Producer MAC ID(s) you want to filter. You can define: a single Producer MAC ID (in a range 0-255). a group of IDs. Separate the range by a hyphen (2-88). The range can extended from 0 to 255. multiple IDs. Separate the IDs by a semi-colon (2;9;27). a group and multiple IDs (2-7;3;8). If you do not enter a value in this field, the full range (0-255) becomes the default value. Enable filter on an LPacket. This enables the bottom post-filter list. You will see a Yes in the Filter LPacket column in the Filter/Trigger view. Disable filter on an LPacket. This disables the bottom post-filter list. You will see a No in the Filter LPacket column in the Filter/Trigger view. TIP For a definition of Status, see page 4-4. For a definition of Type, see page 1-2.

47 Triggers and Filters 4-13 When you enable LPacket filtering and you want to add or edit frame conditions in the bottom list, you see the following dialog box: Define the Producer/Consumer MAC ID(s) you want to filter in each LPacket. for a Generic LPacket, it is the Producer/Consumer ID. for a Fixed LPacket, it is the Destination ID. for a Broadcast ID, it is 255. You can define: a single Producer/Consumer MAC ID (in a range 0-255). a group of IDs. Separate the range by a hypen (2-88). The range can extended from 0 to 255. multiple IDs. Separate the IDs by a semi-colon (2;9;27). a group and multiple IDs (2-7;3;8). If you do not enter a value in this field, the full range (0-255) becomes the default value. When Any Tag is selected, you cannot base your selection on Tag values. Enter the size of the LPacket header (in hexadecimal). Enter the control bits of the LPacket header (in hexadecimal). The fields reflect the value entered in the Control Bits field above. See Interpreting Control Bits, page Enter the LPacket Link Data Offset (in hexadecimal). Enter the LPacket Link Data you want to check (in hexadecimal). IMPORTANT In the preceding example, all the fields have been filled in for illustration purposes but not all of them are required fields. When Any Tag is checked, only one of the following fields must be filled in: Size Ctrl Bits Prod/Cons MAC ID Link Data and an Offset

48 4-14 Triggers and Filters When you choose the Fixed Tag option, the Service field appears and you see the following dialog box: When Fixed Tag is chosen, the Service field appears. The UCMM Service number is forced at 0x83 when a predefined UCMM Service is selected. The values in the Offset and Link Data fields are forced when a predefined UCMM Service is selected. Select a predefined UCMM Service. IMPORTANT When Fixed Tag is chosen, it is not necessary to fill any fields because the Fixed Tag option is automatically entered on several bits in the Control Bits field (see the Acc. Always, Tag Pad, and Fixed Screen fields above). If you don t enter a value in the Ctrl Bits field, Fixed appears in the Control Bits column in the bottom list area of Post-Filter view. If the Ctrl Bits field is filled in, the interface checks the consistency with the Fixed Tag option; in the Post-Filter view, Control Bits field, a hexadecimal value will replace the Fixed string. See Interpreting Control Bits, page 4-16.