ProSoft Technology Product Documentation In an effort to conserve paper, ProSoft Technology no longer includes printed manuals with our product shipments. User Manuals, Datasheets, Sample Ladder Files, and Configuration Files are provided on the enclosed CD-ROM, and are available at no charge from our web site: www.prosoft-technology.com Printed documentation is available for purchase.
Important Installation Instructions Power, Input, and Output (I/O) wiring must be in accordance with Class I, Division 2 wiring methods, Article 501-4 (b) of the National Electrical Code, NFPA 70 for installation in the U.S., or as specified in Section 18-1J2 of the Canadian Electrical Code for installations in Canada, and in accordance with the authority having jurisdiction.
Markings Electrical Ratings Backplane Current Load: 800 mA @ 5.1 Vdc; 3 mA @ 24 Vdc Operating Temperature: 0° C to 60° C (32° F to 140° F) Storage Temperature: -40° C to 85° C (-40° F to 185° F) Shock: 30 g, operational;...
Downloading the Project to the Module Using a Serial COM port ......34 Ladder Logic Module Data ......................36 3.1.1 GECBackplane (Backplane Object) ................ 40 3.1.2 GECBlkStat (Block Error Status Object) ..............40 ProSoft Technology, Inc. Page 5 of 108 October 8, 2010...
Page 6
Returning Any Product .................... 99 6.1.2 Returning Units Under Warranty ................100 6.1.3 Returning Units Out of Warranty ................100 LIMITED WARRANTY ..................101 6.2.1 What Is Covered By This Warranty ..............101 Page 6 of 108 ProSoft Technology, Inc. October 8, 2010...
Page 7
Limitation of Remedies ** ..................104 6.2.7 Time Limit for Bringing Suit ................... 104 6.2.8 No Other Warranties ..................... 104 6.2.9 Allocation of Risks ....................104 6.2.10 Controlling Law and Severability ................105 Index ProSoft Technology, Inc. Page 7 of 108 October 8, 2010...
Page 8
Contents MVI56-GEC ♦ ControlLogix Platform User Manual Generic ASCII Ethernet Communication Module Page 8 of 108 ProSoft Technology, Inc. October 8, 2010...
Specifications (page Functional Overview Functional Overview (page 71) Support, Service, and Support, Service This section contains Support, Service and → Warranty and Warranty (page Warranty information. Index Index of chapters. Index ProSoft Technology, Inc. Page 9 of 108 October 8, 2010...
Page 10
Guide to the MVI56-GEC User Manual MVI56-GEC ♦ ControlLogix Platform User Manual Generic ASCII Ethernet Communication Module Page 10 of 108 ProSoft Technology, Inc. October 8, 2010...
Hardware installation and wiring: install the module, and safely connect Generic Ethernet ASCII and ControlLogix devices to a power source and to the MVI56-GEC module’s application port(s) ProSoft Technology, Inc. Page 11 of 108 October 8, 2010...
ProSoft Configuration Builder, HyperTerminal or other terminal emulator program. Note: You can install the module in a local or remote rack. For remote rack installation, the module requires EtherNet/IP or ControlNet communication with the processor. Page 12 of 108 ProSoft Technology, Inc. October 8, 2010...
#15 for RS-232 connections Adapter inRAx Solutions CD Contains sample programs, utilities and documentation for the MVI56-GEC module. If any of these components are missing, please contact ProSoft Technology Support for replacement parts. ProSoft Technology, Inc. Page 13 of 108 October 8, 2010...
You must install the ProSoft Configuration Builder (PCB) software to configure the module. You can always get the newest version of ProSoft Configuration Builder from the ProSoft Technology website. Installing ProSoft Configuration Builder from the ProSoft website Open your web browser and navigate to http://www.prosoft- technology.com/pcb...
Note: If you are installing the module in a remote rack, you may prefer to leave the Setup pins jumpered. That way, you can update the module’s firmware without requiring physical access to the module. ProSoft Technology, Inc. Page 15 of 108 October 8, 2010...
Make a note of the slot location. You must identify the slot in which the module is installed in order for the sample program to work correctly. Slot numbers are identified on the green circuit board (backplane) of the ControlLogix rack. Turn power ON. Page 16 of 108 ProSoft Technology, Inc. October 8, 2010...
Connect the right-angle connector end of the cable to your controller at the communications port. Connect the straight connector end of the cable to the serial port on your computer. ProSoft Technology, Inc. Page 17 of 108 October 8, 2010...
OMMUNICATIONS NLINE establish communication with the processor. This may take a few moments. When RSLogix has established communication with the processor, the Connected To Go Online dialog box will open. Page 18 of 108 ProSoft Technology, Inc. October 8, 2010...
OK. RSLogix will automatically apply the slot number change to all tags, variables and ladder logic rungs that use the MVI56-GEC slot number for computation. ProSoft Technology, Inc. Page 19 of 108 October 8, 2010...
Note: If the list of configured drivers is blank, you must first choose and configure a driver from the Available Driver Types list. The recommended driver type to choose for serial communication with the processor is RS-232 DF1 Devices. Page 20 of 108 ProSoft Technology, Inc. October 8, 2010...
Page 21
If you are still unable to auto-configure the port, refer to your RSLinx documentation for further troubleshooting steps. ProSoft Technology, Inc. Page 21 of 108 October 8, 2010...
PROGRAM mode to RUN mode. Note: If you receive an error message during these steps, refer to your RSLogix documentation to interpret and correct the error. Page 22 of 108 ProSoft Technology, Inc. October 8, 2010...
RJ45-DB-9 Serial Adapter Cable and a Null Modem Cable. Attach both cables as shown. Insert the RJ45 cable connector into the Configuration/Debug port of the module. Attach the other end to the serial port on your PC. ProSoft Technology, Inc. Page 23 of 108 October 8, 2010...
Page 24
Start Here MVI56-GEC ♦ ControlLogix Platform User Manual Generic ASCII Ethernet Communication Module Page 24 of 108 ProSoft Technology, Inc. October 8, 2010...
In This Chapter Using ProSoft Configuration Builder ............26 [Module]....................30 [Server x] ....................31 Ethernet Configuration ................33 Downloading the Project to the Module Using a Serial COM port ..34 ProSoft Technology, Inc. Page 25 of 108 October 8, 2010...
PCB, the tree view consists of folders for Default Project and Default Location, with a Default Module in the Default Location folder. The following illustration shows the PCB window with a new project. Page 26 of 108 ProSoft Technology, Inc. October 8, 2010...
Page 27
In the Product Line Filter area of the dialog box, select MVI56. In the Select Module Type dropdown list, select MVI56-GEC, and then click OK to save your settings and return to the ProSoft Configuration Builder window. ProSoft Technology, Inc. Page 27 of 108 October 8, 2010...
Edit dialog box. To edit a parameter, select the parameter in the left pane and make your changes in the right pane. Click OK to save your changes. Page 28 of 108 ProSoft Technology, Inc. October 8, 2010...
Page 29
P RINT This action opens the Print dialog box. In the Print dialog box, choose the printer to use from the drop-down list, select printing options, and then click OK. ProSoft Technology, Inc. Page 29 of 108 October 8, 2010...
0 to 80 characters This parameter assigns a name to the module that can be viewed using the configuration/debug port. Use this parameter to identify the module and the configuration file. Page 30 of 108 ProSoft Technology, Inc. October 8, 2010...
If the parameter is set to No, no byte swapping will occur. If the parameter is set to Yes, the odd byte will be swapped with the even byte in each word of data received. ProSoft Technology, Inc. Page 31 of 108 October 8, 2010...
If the parameter is set to No, no byte swapping will occur. If the parameter is set to Yes, the odd byte will be swapped with the even byte in each word of data received. Page 32 of 108 ProSoft Technology, Inc. October 8, 2010...
Edit the values for my_ip, netmask (subnet mask) and gateway (default gateway). When you are finished editing, click OK to save your changes and return to the ProSoft Configuration Builder window. ProSoft Technology, Inc. Page 33 of 108 October 8, 2010...
The module will perform a platform check to read and load its new settings. When the platform check is complete, the status bar in the Download dialog box will display the message Module Running. Page 34 of 108 ProSoft Technology, Inc. October 8, 2010...
The sample ladder logic, on the ProSoft Solutions CD-ROM, is extensively commented, to provide information on the purpose and function of each rung. For most applications, the sample ladder will work without modification. ProSoft Technology, Inc. Page 35 of 108 October 8, 2010...
Page 39
This object contains objects that define variables for the module and status data related to the module. Each of these object types is discussed in the following topics of the document. ProSoft Technology, Inc. Page 39 of 108 October 8, 2010...
Description Read Number of blocks read by the module Write Number of blocks written by the module Parse Number of blocks parsed by the module Number of block transfer errors Page 40 of 108 ProSoft Technology, Inc. October 8, 2010...
Write Data Buffer from GEC Client to Remote Server WriteDataCount Number of Bytes to be transferred to Remote Server WriteTotalCount Total number of bytes in write msg Flags GECClientFlags Util GECClientUtil ProSoft Technology, Inc. Page 41 of 108 October 8, 2010...
Swap Rx bytes (0=No and not 0=Yes) SwapTx Swap Tx bytes (0=No and not 0=Yes) The parameters in this data area are the same as that described in module configuration. Page 42 of 108 ProSoft Technology, Inc. October 8, 2010...
RxCount Number of receive messages RxOverflow Number of times receive buffer overflowed TxCount Number of transmit messages TxOverflow Number of times the transmit buffer overflowed Spare reserved for future use ProSoft Technology, Inc. Page 43 of 108 October 8, 2010...
Page 44
This member reports the current state of the client socket state machine in the module. It is preferred to use the Connected member of the object in the ladder logic instead of this member for control. Page 44 of 108 ProSoft Technology, Inc. October 8, 2010...
Within the GECInStat objects are objects containing the status information for each server and the block transfer process. Refer to Status Data Area (page 88) for a complete listing of the data stored in this object. ProSoft Technology, Inc. Page 45 of 108 October 8, 2010...
ReadTotalCount Total number of characters in read message WriteData SINT[4000] WriteDataCount Number of characters in each write block WriteTotalCount Total number of characters in write message Flags GECServerFlags Util GECServerUtil Page 46 of 108 ProSoft Technology, Inc. October 8, 2010...
Flags the current msg as a multi-block msg (>400 bytes) WriteIndex Word Offset for Write Blocks WriteData BOOL Writing the Data WriteCount WriteCount (used by logic) LastWriteCount Last Block Write Count (bytes) ProSoft Technology, Inc. Page 47 of 108 October 8, 2010...
A value less than 5000 but not 0 is entered for the timeout parameter. Bit 3 0x08 An invalid value is entered for the Connection Close Type parameter. The program only accepts a value of 0 to 2. Page 48 of 108 ProSoft Technology, Inc. October 8, 2010...
This action opens the Select Module dialog box: Select the 1756-M ) from the list and click OK. 1756 M ODULE ENERIC ODULE This action opens the New Module dialog box. ProSoft Technology, Inc. Page 49 of 108 October 8, 2010...
Page 50
This value should not be set to less than 1 millisecond. The default value is 5 milliseconds. Values between 1 and 10 milliseconds should work with most applications. Page 50 of 108 ProSoft Technology, Inc. October 8, 2010...
Page 51
Copy the User-Defined Data Types from the sample program into your existing RSLogix 5000 project. Copy the Controller Tags from the sample program into your project. Copy the Ladder Rungs from the sample program into your project. ProSoft Technology, Inc. Page 51 of 108 October 8, 2010...
Page 52
Ladder Logic MVI56-GEC ♦ ControlLogix Platform User Manual Generic ASCII Ethernet Communication Module Page 52 of 108 ProSoft Technology, Inc. October 8, 2010...
Configuration/Debug port, using the troubleshooting and diagnostic capabilities of ProSoft Configuration Builder (PCB). Status data values can be transferred from the module to processor memory and can be monitored there manually or by customer-created logic. ProSoft Technology, Inc. Page 53 of 108 October 8, 2010...
The battery voltage is low or battery is not present. Allow battery to charge by keeping module plugged into rack for 24 hours. If BAT LED still does not go off, contact ProSoft Technology, as this is not a user serviceable item.
If the module's OK LED does not turn GREEN, verify that the module is inserted completely into the rack. If this does not cure the problem, contact ProSoft Technology Technical Support. ProSoft Technology, Inc. Page 55 of 108 October 8, 2010...
Generic ASCII Ethernet Communication Module 4.1.3 Troubleshooting Use the following troubleshooting steps if you encounter problems when the module is powered up. If these steps do not resolve your problem, please contact ProSoft Technology Technical Support. Processor Errors Problem description Steps to take...
Start PCB, and then select the module to test. Click the right mouse button to open a shortcut menu. On the shortcut menu, choose D IAGNOSTICS This action opens the Diagnostics dialog box. ProSoft Technology, Inc. Page 57 of 108 October 8, 2010...
Page 58
On computers with more than one serial port, verify that your communication program is connected to the same port that is connected to the module. If you are still not able to establish a connection, contact ProSoft Technology for assistance.
(O) and the number zero (0) are not interchangeable. Although these characters look alike on the screen, they perform different actions on the module and may not be used interchangeably. ProSoft Technology, Inc. Page 59 of 108 October 8, 2010...
Only use these commands if you are specifically directed to do so by ProSoft Technology Technical Support staff. Some of these command keys are not listed on the menu, but are active nevertheless. Please be careful when pressing keys so that you do not accidentally execute an unwanted command.
Page 61
This command will cause the program to exit and reload, refreshing configuration parameters that must be set on program initialization. Only use this command if you must force the module to reboot. ProSoft Technology, Inc. Page 61 of 108 October 8, 2010...
Page 62
Exiting the Program Press [ESC] to restart the module and force all drivers to be loaded. The module will use the configuration stored in the module's Flash memory to configure the module. Page 62 of 108 ProSoft Technology, Inc. October 8, 2010...
Press [Y] to confirm the file transfer, and then follow the instructions on the terminal screen to complete the file transfer process. After the file has been successfully transferred, you can open and edit the file to change the module’s network configuration. ProSoft Technology, Inc. Page 63 of 108 October 8, 2010...
Page 64
Press [V] to view the module’s WATTCP.CFG file. Use this command to confirm the module’s current network settings. Returning to the Main Menu Press [M] to return to the Main menu. Page 64 of 108 ProSoft Technology, Inc. October 8, 2010...
Full view of the module’s configuration data View of the module’s status data Version Information Control over the module (warm boot and cold boot) Facility to upload and download the module’s configuration file ProSoft Technology, Inc. Page 65 of 108 October 8, 2010...
Page 66
Diagnostics and Troubleshooting MVI56-GEC ♦ ControlLogix Platform User Manual Generic ASCII Ethernet Communication Module Page 66 of 108 ProSoft Technology, Inc. October 8, 2010...
Generic ASCII Ethernet Communication Module User Manual Reference In This Chapter Product Specifications ................68 Functional Overview ................71 Cable Connections ................85 MVI56-GEC Status Data Area ............... 88 Configuration Data ................94 ProSoft Technology, Inc. Page 67 of 108 October 8, 2010...
Ladder Logic is used for data transfer between module and processor. Sample ladder file included. Configuration data obtained from configuration text file downloaded to module. Sample configuration file included Local or remote rack Page 68 of 108 ProSoft Technology, Inc. October 8, 2010...
App Ports (P1, P2) (Serial RJ45 (DB-9M with supplied cable) modules) RS-232 handshaking configurable 500V Optical isolation from backplane Shipped with Unit RJ45 to DB-9M cables for each port 6-foot RS-232 configuration cable ProSoft Technology, Inc. Page 69 of 108 October 8, 2010...
Module configuration and communication configuration data is transferred to the MVI56-GEC via a pre-defined user data type in the processor Page 70 of 108 ProSoft Technology, Inc. October 8, 2010...
Ethernet network. Main Logic Loop Upon completing the power up configuration process, the module enters an infinite loop that performs the functions shown in the following diagram. ProSoft Technology, Inc. Page 71 of 108 October 8, 2010...
Page 72
Use the sample ladder logic program on the CD-ROM to establish data transfer between the module and the processor. Page 72 of 108 ProSoft Technology, Inc. October 8, 2010...
Page 73
Value for designated Server or Client number during writing process (0- Clients 4) for Servers (10-14) for clients. Number of characters processed from last write block (0 to 400). Message Block Sequence Number (Bumped each scan by module) Blocks ProSoft Technology, Inc. Page 73 of 108 October 8, 2010...
Page 74
This word only has significance if word 0 of the block is set to a valid server index value (0 to 4), or client index value (10 to 14). Page 74 of 108 ProSoft Technology, Inc. October 8, 2010...
Page 75
(write block sequence number). Both the processor and the module can easily recognize the arrival of new data by the sequence number. ProSoft Technology, Inc. Page 75 of 108 October 8, 2010...
Page 76
Client[0] Control Word Client[1] Control Word Client[2] Control Word Client[3] Control Word Client[4] Control Word Server Control Word Module Control Word contains a value of 0, -1, -2 or -3. Page 76 of 108 ProSoft Technology, Inc. October 8, 2010...
Page 77
10 to 14 will cause the enclosed message to be sent to the client if a message length is set to a value other than zero. Word 2 of the block defines the length of data in the block. ProSoft Technology, Inc. Page 77 of 108 October 8, 2010...
Page 78
Ladder logic is required to transfer this data to the block when a connection is required. The ladder logic should also clear the area after the connection is requested. The example ladder logic present in this document presents code to accomplish these tasks. Page 78 of 108 ProSoft Technology, Inc. October 8, 2010...
Page 79
Code Definition No operation to perform Warm boot module Cold boot module Build configuration files. The module will perform the action specified in the command control word. ProSoft Technology, Inc. Page 79 of 108 October 8, 2010...
Page 80
Swap Tx Data Bytes (0 = No, not 0 = Yes) My_IP 81 to 84 The IP address for the module. Each word contains one of the four values that comprise the IP address. For example, 192.168.0.100. Page 80 of 108 ProSoft Technology, Inc. October 8, 2010...
Page 81
This could be accomplished either by using a specific character at the end of each message or by using a fixed length for each message. ProSoft Technology, Inc. Page 81 of 108 October 8, 2010...
Page 82
After the connection is established, the ladder logic should verify that the client had not been communicating for some time and close the connection. Page 82 of 108 ProSoft Technology, Inc. October 8, 2010...
Page 83
Ladder logic can send messages to the clients connected to servers 0 to 3. Messages sent to server 4 will not be sent from the module because there is no connection active on that server. ProSoft Technology, Inc. Page 83 of 108 October 8, 2010...
Page 84
(send a message with the Reset Flag set to the client). Most applications will have the client close the socket. Page 84 of 108 ProSoft Technology, Inc. October 8, 2010...
ASCII terminal program (like Windows HyperTerminal) by selecting [@] (Network Menu) and [V] (View) options when connected to the Debug port. For more information on serial port access, see the chapter on Diagnostics and Troubleshooting (page 53). ProSoft Technology, Inc. Page 85 of 108 October 8, 2010...
To stop the driver your RSWho screen should look like this: Branches are displayed or hidden by clicking on the or the icons. When you have verified that the driver is not being browsed, go to Page 86 of 108 ProSoft Technology, Inc. October 8, 2010...
RSLogix open. If RSLogix is not open, and you still cannot stop the driver, then reboot your PC. 5.3.3 DB9 to RJ45 Adaptor (Cable 14) ProSoft Technology, Inc. Page 87 of 108 October 8, 2010...
This bit mapped word defines the configuration errors for the server. Server[1].Enabled This flag defines if the server is utilized. A value of 0 indicates the server is not used. Any other value indicates the server is used. Page 88 of 108 ProSoft Technology, Inc. October 8, 2010...
Page 89
This status value contains the total number of messages received that exceed the user specified buffer size for the server. Server[2].TxCount This status value contains the total number of messages transmitted by the server. ProSoft Technology, Inc. Page 89 of 108 October 8, 2010...
Page 90
Server[4].IP This double-word value contains the IP address of the client connected to the server. Server[4].Port This word value contains the port address for the client connected to the server. Page 90 of 108 ProSoft Technology, Inc. October 8, 2010...
Page 91
A value of 0 indicates the client is not connected and can be utilized for a connection. Any other value indicates the client is connected and being used. ProSoft Technology, Inc. Page 91 of 108 October 8, 2010...
Page 92
Client[3].IP This double-word value contains the IP address of the server connected to the client. Client[3].Port This word value contains the port address for the server connected to the client. Page 92 of 108 ProSoft Technology, Inc. October 8, 2010...
Page 93
A value less than 5000 is entered for the Connection Timeout parameter other than 0. Bit 3 0x08 An invalid value is entered for the Connection Close Type parameter. The program only accepts value of 0 to 2. ProSoft Technology, Inc. Page 93 of 108 October 8, 2010...
Note: Add other [Server n] sections for each server to be utilized. [Section]/Item Range Description [Server n] Server definitions Page 94 of 108 ProSoft Technology, Inc. October 8, 2010...
Page 95
If the parameter is set to N, no byte swapping will occur. If the parameter is set to Y, the odd byte will be swapped with the even byte in each word of data received. ProSoft Technology, Inc. Page 95 of 108 October 8, 2010...
Page 96
Reference MVI56-GEC ♦ ControlLogix Platform User Manual Generic ASCII Ethernet Communication Module Page 96 of 108 ProSoft Technology, Inc. October 8, 2010...
Return Material Authorization (RMA) Policies and Conditions ....99 LIMITED WARRANTY ................. 101 Contacting Technical Support ProSoft Technology, Inc. (ProSoft) is committed to providing the most efficient and effective support possible. Before calling, please gather the following information to assist in expediting this process:...
Page 98
Languages spoken include: Spanish, English Tel: +52-222-3-99-6565, Latin America (location in Puebla, Mexico) E-mail: soporte@prosoft-technology.com Languages spoken include: Spanish Tel: +55-11-5083-3776, Brasil (location in Sao Paulo) E-mail: brasil@prosoft-technology.com Languages spoken include: Portuguese, English Page 98 of 108 ProSoft Technology, Inc. October 8, 2010...
The following Return Material Authorization (RMA) Policies and Conditions (collectively, "RMA Policies") apply to any returned product. These RMA Policies are subject to change by ProSoft Technology, Inc., without notice. For warranty information, see Limited Warranty (page 101). In the event of any inconsistency between the RMA Policies and the Warranty, the Warranty shall govern.
Return Material Authorization i. If a defect is found and is determined to be customer generated, or if the defect is otherwise not covered by ProSoft Technology s warranty, there will be no credit given. Customer will be contacted and can request module be returned at their expense;...
This Limited Warranty ("Warranty") governs all sales of hardware, software, and other products (collectively, "Product") manufactured and/or offered for sale by ProSoft Technology, Incorporated (ProSoft), and all related services provided by ProSoft, including maintenance, repair, warranty exchange, and service programs (collectively, "Services"). By purchasing or using the Product or Services, the individual or entity purchasing or using the Product or Services ("Customer") agrees to all of the terms and provisions (collectively, the "Terms")
(collectively, "high risk activities"). ProSoft specifically disclaims any express or implied warranty of fitness for high risk activities. Page 102 of 108 ProSoft Technology, Inc. October 8, 2010...
The Warranty set forth in What Is Covered By This Warranty (page 101) are in lieu of all other warranties, express or implied, including but not limited to the implied warranties of merchantability and fitness for a particular purpose. ProSoft Technology, Inc. Page 103 of 108 October 8, 2010...
Customer. This allocation is recognized by both parties and is reflected in the price of the goods. The Customer acknowledges that it has read this Warranty, understands it, and is bound by its Terms. Page 104 of 108 ProSoft Technology, Inc. October 8, 2010...
Warranty shall remain in full force and effect. Any cause of action with respect to the Product or Services must be instituted in a court of competent jurisdiction in the State of California. ProSoft Technology, Inc. Page 105 of 108 October 8, 2010...
Page 106
Support, Service & Warranty MVI56-GEC ♦ ControlLogix Platform User Manual Generic ASCII Ethernet Communication Module Page 106 of 108 ProSoft Technology, Inc. October 8, 2010...
Page 107
Module Power Up • 71 Ethernet Configuration • 33 MVI (Multi Vendor Interface) Modules • 3 Ethernet Connection • 85 MVI56-GEC Status Data Area • 45, 88 Ethernet LED Indicators • 55 ProSoft Technology, Inc. Page 107 of 108 October 8, 2010...
Pinouts • 3, 85, 87 Printing a Configuration File • 29 Product Specifications • 9, 68 ProSoft Technology® Product Documentation • 2 Warm Booting the Module • 61 Warnings • 3 What Is Covered By This Warranty • 101, 103 What Is Not Covered By This Warranty •...
Need help?
Do you have a question about the inRAx MVI56-GEC and is the answer not in the manual?
Questions and answers