Quick Start (Catalog Number 9220-TG) About this Document Use this document to install and use the ControlNet message/traffic generator tool. This tool was designed for engineers and developers familiar with network installation and troubleshooting. To use this tool efficiently, you should be familiar with ControlNet protocols.
ControlNet Message/Traffic Generator Tool Introducing the Tool Use this tool to: • construct, edit, and send data packets and messages on a ControlNet network Using this tool, you can: – open connections to different objects and send predefined messages, data byte(s), or packet(s) individually or in a sequence. – construct, edit and send data packets and messages. These edited data packets and messages can be saved to and retrieved from files.
ControlNet Message/Traffic Generator Tool 3 System Requirements microprocessor operating system memory hard disk space video adapter and monitor diskette drive ISA/EISA bus communication interface pointing device 486 33 Mhz PC AT or higher MS-DOS 3.3 or higher 4 MB or higher 8 MB VGA or high-resolution super VGA display (800 x 600) minimum: VGA card and a display capable of 640x480 VGA one 3.
ControlNet Message/Traffic Generator Tool Installing the Tool 1. Insert the tool disk into your computer’s 3.5” disk drive. 2. Create a directory on your hard drive for the tool: mkdir tg Enter The tg directory is used in TG.BAT. If you create a different directory for the tool, you need to edit the cnxpath in TG.BAT (set CNXPATH=c:\new_directory). The path sets a DOS environment variable to instruct the tool where to look for CNXOR.CFG.
ControlNet Message/Traffic Generator Tool 5 and the current status of the tool: 6. Click with your right mouse button in the Current Status window to close it. To navigate through the tool, use your left mouse button to access drop-down menus, cascading menus, and dialog boxes, and your right mouse button to close them. drop-down menu cascading menu dialog box Publication 9220-10.
ControlNet Message/Traffic Generator Tool Configuring the Tool From the Setup drop-down menu, you can set these configuration options: This option Simulation Online Offline Port Number Mac ID Target Mac ID CN Parameters Is used to display the tool’s menus and capabilities without actually communicating with a node on the network. While in this mode, the tool does not interface with the 9220-KTCT card.
ControlNet Message/Traffic Generator Tool 7 Using the Tool This figure shows the functional blocks for navigation through the tool, with each block representing a single window.
ControlNet Message/Traffic Generator Tool Changing the Network Update Time From Setup, choose CN Parameters, and choose a time in milliseconds. Changing the Port Number of the 9220-KTCT Card From Setup, choose Port Number, and set the port number equal to the port of 9220-KTCT card you are using (0–3). Publication 9220-10.
ControlNet Message/Traffic Generator Tool 9 Changing the MAC ID of the 9220-KTCT Card From Setup, choose MAC ID, and set the network address of the 9220-KTCT card (0–99). Viewing the Current Status of the Tool To view the current status of the tool, choose Status. This displays a status window showing the current state of the traffic generator with respect to the ControlNet network, the status of any open connections, the Port Number, and the source and target MAC IDs. Publication 9220-10.
ControlNet Message/Traffic Generator Tool Sending a Message to a Target Node 1. Select the node you want to communicate with. From Setup, choose Target MAC ID. Click the arrows to select the network address of the target node. 2. Go online to the ControlNet network. From Setup, choose Online. Resetting KTCT Card.. Enabling Network Events.. Soft Resetting KTCT Card.. Transitioning to Online.. Publication 9220-10.
ControlNet Message/Traffic Generator Tool 11 3. Open a connection. From Connections, choose Open Connection and then choose the type of connection you want to open. " Connections and connection parameters (e.g., Expected Packet Rate and Connection Size) are defined in CNXOR.CFG. The connections are used to open defined objects and instances for the target node. You can edit this file as necessary for your application. A. CBT = cyclic block transfer BT = block transfer B. C. 4.
ControlNet Message/Traffic Generator Tool " The list of connected messages displayed is based on active open connections. displays... then... Important: If you did not open a connection (see step 3), you see: Publication 9220-10.
ControlNet Message/Traffic Generator Tool 13 Sending Unconnected Messages You can send unconnected messages to: • send predefined unconnected messages • get attribute information on an object • reset a device Sending Predefined Unconnected Messages To send an unconnected message, choose Unconnected, Send Message, and choose the message you want to send.
ControlNet Message/Traffic Generator Tool Resetting a Device To reset a device, choose Unconnected, Reset, and choose the object you want to reset. Closing a Connection To close a connection, choose Connections, Close Connection and choose the connection you want to close from the list of open connections. Publication 9220-10.
ControlNet Message/Traffic Generator Tool 15 Using the Traffic Generator The traffic generator provides an editing window for constructing data packets (bytes, patterns and messages). The bottom portion of the editing window lists the main commands to use. 1. To access the traffic generator, choose Build, Traffic Generator. You see: From this window, you can construct your data packets (bytes, patterns, and messages). Important: If you see this error, you need to go online. See step 2, on page 10.
ControlNet Message/Traffic Generator Tool 2. Use the traffic generator to construct and send messages. To view the traffic generator’s options construct and send a message You Type help Type the message enclosed in <>. a. press a function key assign a set of data packets to a function key F1 to F10 Shown in b.
ControlNet Message/Traffic Generator Tool 17 " A file on the traffic generator disk (PLAYSOME) contains predefined messages you can send on your ControlNet link. Using your DOS editor, you can edit these messages as necessary. Publication 9220-10.
ControlNet Message/Traffic Generator Tool Running a Separate DOS Program To run a separate DOS program from You the Modules drop-down menu edit CNXOR.CFG to define your tests. These tests then appear in the cascading menu that lists the tests. See the figure below and page 29. the DOS prompt a. choose File, DOS Shell b. run the program: program.exe Taking the Card Offline From Setup, Choose Offline. Exiting the Tool To Choose exit to a DOS prompt for viewing and editing configuration files (e.
ControlNet Message/Traffic Generator Tool 19 Editing the Tool’s Configuration File This tool’s functionality is defined in its configuration file, CNXOR.CFG. This ASCII file is read, as necessary, as the tool executes. In this file, information is defined through a set of keywords, called Resources, that configure the menus and provide the data to be used. A resource consists of: keyword.name.
ControlNet Message/Traffic Generator Tool The following table lists the parameters specified in CNXOR.CFG. ControlNet Setup Parameters This resource CN.name: CN.___.title: CN.___.originatorPortNum: CN.___.originatorMacId: CN.___.targetMacId: CN.___.pit_time: CN.___.smax: CN.___.umax: CN.___.slot_time: CN.___.blank_time: CN.___.gb_start: CN.___.gb_center: CN.___.redundancy: CN.___.sched_max_frame: CN.___.int_cnt_mod: CN.___.gb_prestart: CN.___.mcycle_start: CN.___.mcycle_length: CN.___.
ControlNet Message/Traffic Generator Tool 21 Object Setup This resource Object.name: Description Provides a list of Object names for use in the Unconnected>Send Message, Get Attr All and Reset cascading menus. These names are displayed unless an Object.___.title is provided for each name. Object.name: Object.___.title: device mr rack Provides a title to be displayed in the Unconnected>Send Message, Get Attr All, and Reset cascading menus. If a title s not provided, the name is displayed. Object.
ControlNet Message/Traffic Generator Tool Connection Setup (continued) This resource Description Connection.___.timeout: The UCMM timeout value used in an Open/Close Connection message to the target Object. This value is in hex. Connection.mr.timeout: 0A Connection.___.epr: The Expected Packet Rate for the Connection being established, expressed in the form of a 16–bit scaled integer as described in the Connections in the ASA Product Developer’s Guide, cat. no. 9250-DOC. This value is in hex.
ControlNet Message/Traffic Generator Tool 23 Connection Setup (continued) This resource Description Message.___.list: Provides a list of message names for the CONNECTED>SEND MESSAGE cascading menu. These message names will be associated with the Connection name specified. Once a Connection has been opened, these messages could be sent across that Connection. These names will be shown in the menu unless a Message.___.title is provided for each name. Connection.
ControlNet Message/Traffic Generator Tool Connection Setup (continued) This resource Description Module.___.title: Provides a title to be displayed in the MODULES drop-down menu. If this resource is not provided, the name will be displayed. Module.1771acn.title: 1771–ACN/ACNR Module.___.tests: Specifies a list of tests for the desired module under the MODULES drop-down menu. These names will be shown in the menu unless a Test.___.title is provided for each name. Module.1771acn.
ControlNet Message/Traffic Generator Tool 25 Example CNXOR.CFG File ########################## ## CN Setup Parameters ## ########################## ################################## # Define the CN Parameter Setups # CN.name: default setup2ms # # Describe the CN Setups # CN.default.title: Default CN.default.originatorPortNum: 0 CN.default.originatorMacId: 0 CN.default.targetMacId: 8 CN.default.pit_time: 200 CN.default.smax: 5 CN.default.umax: 6 CN.default.slot_time: 21 CN.default.blank_time: 6 CN.
ControlNet Message/Traffic Generator Tool Example CNXOR.CFG File (continued) ######################################## # Define the Objects we will be using. # Object.name: device cn mr rack # # Describe the Objects # Object.device.title: Device Object.device.number: 01 Object.device.max_instance: 1 Object.cn.title: CNet Object.cn.number: 65 Object.cn.max_instance: 1 Object.mr.title: Message Router Object.mr.number: 02 Object.mr.max_instance: 1 Object.rack.title: 1771 Rack Object.rack.number: 7c Object.
ControlNet Message/Traffic Generator Tool 27 Example CNXOR.CFG File (continued) ############################################ # Define the Connections we will be using. # Connection.name: mr rackio rackin rackout # # Describe the connections. # # default values for those not specified Connection.default.timeout: 0A Connection.default.epr: 0E71 # 5ms epr Connection.default.net_t_o: 0000 Connection.default.net_o_t: 0000 Connection.default.transport: 01 # Message Router parameters. Connection.mr.
ControlNet Message/Traffic Generator Tool Example CNXOR.CFG File (continued) ############################################################### # Define Object Messages # Note: The message name for the list header must be the # same as that defined in the Connection.name object. # Message.rout1.title: Pattern 1 Message.rout1.data: 01 00 00 00 01 02 03 04 Message.rout2.title: Message.rout2.data: Pattern 2 01 00 00 00 02 03 04 05 Message.rout3.title: Message.rout3.
ControlNet Message/Traffic Generator Tool 29 Example CNXOR.CFG File (continued) ########################################### # Define the modules with specific tests # Module.name: 1771acn Module.1771acn.title: 1771–ACN/ACNR Module.1771acn.tests: ftp1 ftp2 ftp3 ftp4 ftp5 ftp6 ftp7 ftp8\ ftp9 ftp10 Test.ftp1.title: UCMM Test Test.ftp1.file: acn_ucmm Test.ftp2.title: Test.ftp2.file: MR Object Test acn_mr Test.ftp3.title: Test.ftp3.file: CN Object Test acn_cn Test.ftp4.title: Test.ftp4.
ControlNet Message/Traffic Generator Tool Message/Traffic Generator API Functions The following functions can be used to create executable test programs, for testing on a ControlNet network. Once created, these programs can be added to CNXOR.CFG so they can be accessed in the tool from the Modules pull-down menu. Use this function MG_Env ( ) To read the message/traffic generator environment variable and fill in the global configFile string.
ControlNet Message/Traffic Generator Tool 31 /*****************************************************************\ ** ** Name: MG_Env ( ) ** ** Description: ** This function reads the Message/Traffic Generator environment ** variable and fills in the global configFile string.
ControlNet Message/Traffic Generator Tool /*****************************************************************\ ** ** Name: MG_LoadCNSetup ( ) ** ** Description: ** This function loads a CNet setup from the configuration file. ** ** Inputs: USINT *setupName – Name of setup to load.
ControlNet Message/Traffic Generator Tool 33 /*****************************************************************\ ** ** Name: MG_OpenConnection ( ) ** ** Description: ** This function opens an ASA Connection with the target device. ** ** Inputs: UINT *connIndex – Pointer to connection index that ** will be filled in by the function. ** USINT *connName – Name of connection from. ** configuration file to be opened. ** UINT instance – Instance number of object to ** connect to.
ControlNet Message/Traffic Generator Tool /*****************************************************************\ ** ** Name: MG_SendUnconnectedMsg ( ) ** ** Description: ** This function sends an unconnected ASA message from the ** configuration file. ** ** Inputs: USINT *message – Message to be sent.
ControlNet Message/Traffic Generator Tool 35 /*****************************************************************\ ** ** Name: MG_ReceiveConnected ( ) ** ** Description: ** This function receives a message on a Connection ** previously opened with a call to MG_OpenConnection. ** ** Inputs: UINT connIndex – Connection index that was ** returned by the MG_OpenConnection ** function. ** USINT *message – Pointer to buffer for message. ** UINT *dataSize – Size, in bytes, of the message ** received.
ControlNet Message/Traffic Generator Tool /*****************************************************************\ ** ** Name: MG_RegisterClass ( ) ** ** Description: ** This function registers a class with the Message Router ** for receipt of the unsolicited messages. ** ** Inputs: USINT class – ASA class to be registered.