MVI56E-GEC
ControlLogix Platform
Generic ASCII Ethernet Communication Module
February 24, 2020
USER MANUAL
Page 1: ...MVI56E GEC ControlLogix Platform Generic ASCII Ethernet Communication Module February 24 2020 USER MANUAL...
Page 2: ...s document including illustrations specifications and dimensions may contain technical inaccuracies or typographical errors ProSoft Technology makes no warranty or representation as to its accuracy an...
Page 3: ...he following warnings must be heeded A Warning Explosion Hazard Substitution of components may impair suitability for Class I Division 2 B Warning Explosion Hazard When in hazardous locations turn off...
Page 4: ...figuration Builder 12 2 1 ProSoft Configuration Builder 12 2 1 1 Adding the MVI56E GEC Module to the Project 12 2 1 2 Renaming PCB Objects 13 2 2 Server x 15 2 2 1 Enabled 15 2 2 2 Service Port Number...
Page 5: ...ration Builder Diagnostics Menu 42 5 2 1 Diagnostics Menu Navigation 44 5 2 2 Viewing Module Information 44 5 2 3 Monitoring Backplane Information 45 5 2 4 Monitoring MVI56E GEC Server X Information 4...
Page 6: ...5000 Logix Designer programming software o Version 16 or higher required for Add On Instruction o Version 15 or lower must use Sample Ladder available from www prosoft technology com Rockwell Automati...
Page 7: ...download the latest version of ProSoft Configuration Builder 3 Choose SAVE or SAVE FILE when prompted 4 Save the file to your Windows Desktop so that you can find it easily when you have finished dow...
Page 8: ...he same technique recommended by Rockwell Automation to remove and install ControlLogix modules Warning When you insert or remove the module while backplane power is on an electrical arc can occur Thi...
Page 9: ...from www prosoft technology com 1 6 1 Determining the Firmware Version of Your Processor Important The RSLinx service must be installed and running on your computer in order for Studio 5000 Logix Des...
Page 10: ...ses the slot number to identify the module If you are installing the module in a different slot you must update the ladder logic so that program tags and variables are correct and do not conflict with...
Page 11: ...processor 2 When communication is established Studio 5000 Logix Designer will open a confirmation dialog box Click the DOWNLOAD button to transfer the sample program to the processor 3 Studio 5000 Lo...
Page 12: ...mized to meet your application needs PCB also allows you to import information from previously installed known working configurations to new projects 2 1 1 Adding the MVI56E GEC Module to the Project...
Page 13: ...use button to open a shortcut menu From the shortcut menu choose RENAME 2 Type the name to assign to the object 3 Click away from the object to save the new name Configuring Module Parameters 1 Click...
Page 14: ...log box appears 3 Enter your comment and click OK to save your changes Printing a Configuration File 1 Select the module icon and then click the right mouse button to open a shortcut menu 2 On the sho...
Page 15: ...35 This parameter specifies the number of milliseconds the server will permit the server to be inactive after a connection is made before closing the socket This timeout period is reset on each read o...
Page 16: ...ProSoft Technology Inc 2 2 6 Swap Tx Data Bytes Yes or No This parameter determines if the data to be transmitted by the module will have the byte order of the data swapped If the parameter is set to...
Page 17: ...an Ethernet cable 1 Determine the network settings for your module with the help of your network administrator if necessary You will need the following information IP address fixed IP required Subnet...
Page 18: ...dress You can assign a temporary IP address to the module using the ProSoft Discovery Service utility This utility is installed within ProSoft Configuration Builder PCB 1 In PCB click on the Diagnosti...
Page 19: ...hernet Communication Module User Manual ProSoft Technology Inc Page 19 of 80 3 In the Connection Setup dialog box click BROWSE DEVICE S to start ProSoft Discovery Service 4 ProSoft Discovery Service s...
Page 20: ...ic ASCII Ethernet Communication Module Page 20 of 80 ProSoft Technology Inc 5 Right click the module icon and select ASSIGN TEMPORARY IP 6 Enter the Temporary IP and Network Mask 7 To view the current...
Page 21: ...ion Module User Manual ProSoft Technology Inc Page 21 of 80 2 5 Downloading the Configuration File to the Module 1 In the ProSoft Configuration Builder tree view right click the module icon and choose...
Page 22: ...ation Module Page 22 of 80 ProSoft Technology Inc 3 In the ProSoft Discovery Service dialog double click on the MVI56E GEC icon 4 The IP address field is populated with the module s IP address Click D...
Page 23: ...ionally a power up handler may be needed to handle the initialization of the module s data and to clear any processor fault conditions The sample ladder logic is extensively commented to provide infor...
Page 24: ...t options for your application then click on the Connection tab Parameter Value NAME MVI56E_GEC DESCRIPTION Enter a description for the module Example Generic ASCII Ethernet Communication Module COMM...
Page 25: ...4 In the Connection tab select the Request Packet Interval value for scanning the I O on the module This value represents the minimum frequency the module will handle scheduled events This value shoul...
Page 26: ...to add the MVI56E GEC ladder logic to an existing ControlLogix application you can export the sample ladder logic components to a L5X file This allows you to import the L5X file into the existing app...
Page 27: ...o 5000 Logix Designer Generic ASCII Ethernet Communication Module User Manual ProSoft Technology Inc Page 27 of 80 4 Select a storage location to save the MainProgram L5X file Click the EXPORT button...
Page 28: ...2 Importing the MVI56E GEC L5X file Into an Studio 5000 Project 1 Within the existing Studio 5000 Logix Designer Project add the MVI56E GEC module to the I O Configuration For further instructions se...
Page 29: ...t Communication Module User Manual ProSoft Technology Inc Page 29 of 80 3 Select the previously exported MVI56E GEC MainProgram L5X file and click the IMPORT button 4 In the Import Configuration dialo...
Page 30: ...E GEC ControlLogix Platform User Manual Generic ASCII Ethernet Communication Module Page 30 of 80 ProSoft Technology Inc 5 Upon successful import the MVI56E GEC ladder logic Controller Tags and UDT s...
Page 31: ...ags the Optional AOI allows you to request and set the module s IP address date and time These optional features are not supported by the MVI56 GEC legacy module Note The Optional AOI may be added to...
Page 32: ...I56E GEC ControlLogix Platform User Manual Generic ASCII Ethernet Communication Module Page 32 of 80 ProSoft Technology Inc 3 At the Import Configuration window select the Operation parameter to CREAT...
Page 33: ...dule User Manual ProSoft Technology Inc Page 33 of 80 3 3 1 Setting Up the Optional AOI 1 Click on the ReadEthernetMSG icon to configure the message route 2 In the Message Configuration dialog under t...
Page 34: ...l Generic ASCII Ethernet Communication Module Page 34 of 80 ProSoft Technology Inc 4 The module name is now displayed in the Path field Click OK to confirm the route configuration 5 Repeat the same pr...
Page 35: ...56E GEC can simultaneously connect and send data to up to five servers 1 Enter the IP address of the server at GEC CLIENTS X CONNECTIONSETUP SERVERIP 2 Enter the service port of the server at GEC CLIE...
Page 36: ...e a socket connection before the Server can transmit data to the Client 1 Enter the data to be sent at GEC SERVERS X WRITEDATA 2 Enter the number of characters to be sent at GEC SERVERS X WRITEDATACOU...
Page 37: ...IENTS X READDATA array 1 When the MVI56E GEC receives an ASCII string from a server the GEC STAT CLIENT X RXCOUNT controller tag increments by 1 You will need to monitor this tag to determine a new me...
Page 38: ...ag increments by 1 You will need to monitor this tag to determine a new message was received 2 The GEC SERVERS X READDATA array contains the ASCII text of the new message This array is overwritten eve...
Page 39: ...ll remain Red in case all connections Client or Server previously established have been terminated In case a single connection is established the LED will be Green This LED will also be temporarily se...
Page 40: ...lted Processor in program mode PLC is in program mode Processor faulted or is in program mode IP Address MVI56E GEC s IP Address 5 1 3 Clearing a Fault Condition Typically if the OK LED on the front o...
Page 41: ...ny installed I O module not just the MVI56E GEC Verify that all modules in the rack are correctly configured in the ladder logic Module Errors Problem description Steps to take Scrolling LED display B...
Page 42: ...dule Page 42 of 80 ProSoft Technology Inc 5 2 ProSoft Configuration Builder Diagnostics Menu 1 In the tree view in ProSoft Configuration Builder right click the MVI56E GEC module and then choose DIAGN...
Page 43: ...chnology Inc Page 43 of 80 3 In the Ethernet field of the Connection Setup dialog box enter the current IP address whether it is temporary or permanent Click TEST CONNECTION to verify that the module...
Page 44: ...Module Page 44 of 80 ProSoft Technology Inc 5 2 1 Diagnostics Menu Navigation In the Diagnostics window in ProSoft Configuration Builder the Diagnostics menu is available through the Ethernet configur...
Page 45: ...olLogix Platform Diagnostics and Troubleshooting Generic ASCII Ethernet Communication Module User Manual ProSoft Technology Inc Page 45 of 80 MODULE NIC Status 5 2 3 Monitoring Backplane Information B...
Page 46: ...shooting MVI56E GEC ControlLogix Platform User Manual Generic ASCII Ethernet Communication Module Page 46 of 80 ProSoft Technology Inc 5 2 4 Monitoring MVI56E GEC Server X Information GEC SERVER X Con...
Page 47: ...ntrolLogix Platform Diagnostics and Troubleshooting Generic ASCII Ethernet Communication Module User Manual ProSoft Technology Inc Page 47 of 80 5 2 5 Monitoring MVI56E GEC Client X Information GEC CL...
Page 48: ...atus Controller Tags The MVI56E GEC module returns status data to the ControlLogix processor in each read block This data is transferred to the ControlLogix processor continuously with each read block...
Page 49: ...MVI56E GEC ControlLogix Platform Diagnostics and Troubleshooting Generic ASCII Ethernet Communication Module User Manual ProSoft Technology Inc Page 49 of 80 Client Status...
Page 50: ...Diagnostics and Troubleshooting MVI56E GEC ControlLogix Platform User Manual Generic ASCII Ethernet Communication Module Page 50 of 80 ProSoft Technology Inc Server Status...
Page 51: ...ell as the ability to set the date and time reboot the module and download firmware upgrade to the module Enter the assigned IP address of the module into a web browser or use the following steps in P...
Page 52: ...tion the module incorporates proprietary backplane technology that enables powerful data access between the module and the ControlLogix processor Five servers and clients are present on the module per...
Page 53: ...40 C to 85 C 40 F to 185 F Shock 30 g operational 50 g non operational Vibration 5 g from 10 Hz to 150 Hz Relative Humidity 5 to 95 without condensation LED Indicators Battery Status ERR Application S...
Page 54: ...nnected Client o Error codes Each Client monitors o State o IP and port number of connected Server o Message related parameters ASCII character strings up to 4096 characters in length supported Module...
Page 55: ...ross the backplane using the module s input and output images The update frequency of the data is determined by the user defined scan rate for the module and the communication load on the module Typic...
Page 56: ...he controller tags You must configure the module properly for accurate reception of data through its ports and you must program the ladder logic to interpret the data from the module and send the corr...
Page 57: ...e status data block Each block transferred to the processor contains this set of information IDs for Servers Clients and Message Blocks 235 to 246 Reserved for future use 247 Value for designated Serv...
Page 58: ...h server or client enabled in the module The module status data begins at word offset 102 Refer to Installing and Configuring the Module for a full discussion of this data set The ladder logic should...
Page 59: ...dule received the last block containing a positive value representing the number of bytes in the block the server or client will transmit the data to the end device 3 to 202 Data to transmit on specif...
Page 60: ...ue of 0 to 4 will cause the enclosed message to be sent to the server if the message length is set to a value other than zero and the server has an open connection A value of 10 to 14 will cause the e...
Page 61: ...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 docu...
Page 62: ...chnology Inc Module Control Word Codes Word 247 is used to control the module The following table lists the commands recognized by the module Code Definition 0 No operation to perform 1 Warm boot modu...
Page 63: ...Rx Data Bytes 0 No not 0 Yes 62 Swap Tx Data Bytes 0 No not 0 Yes Server 2 63 Enabled 0 No not 0 Yes 64 Service port 65 Connection Timeout 66 Connection Close Type 0 1 or 2 67 Swap Rx Data Bytes 0 No...
Page 64: ...lient Important Messages are usually broken down into smaller frames by the IP layer in a specific LAN or WAN according to the Maximum Transmit Unit MTU of the network For example a message that conta...
Page 65: ...ermine the amount of time a connection can remain idle before the server will close the connection If the parameter is set to 0 the server will not perform the timeout logic and the socket will never...
Page 66: ...ress Therefore each connection is specified to the processor by the server index The following illustration shows a snapshot of the modules status data Server Status Data Description of Server Server...
Page 67: ...r the close on the connection to complete 1002 The client is issuing an abort reset on the connection The socket is forced closed Client Connection States State Value Definition 4 The Client is idle a...
Page 68: ...Established 121 This status value contains the total number of times a connection was established on the socket Server 0 Closed 122 This status value contains the total number of times a close operat...
Page 69: ...3 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 Server 2 State 144 This flag defines the current state of the s...
Page 70: ...ntains the total number of transmit messages that exceeded the user specified maximum buffer size for the server Server 3 Timeout 169 This status value contains the total number of times a connection...
Page 71: ...191 This status value contains the total number of messages received that exceed the user specified buffer size for the client Client 0 TxCount 192 This status value contains the total number of mess...
Page 72: ...ed and connected to a server 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 Client 3 State 216...
Page 73: ...f messages transmitted by the client Client 4 TxOverflow 233 This status value contains the total number of transmit messages that exceeded the user specified maximum buffer size for the client Client...
Page 74: ...ill permit the server to be inactive after a connection is made before closing the socket This timeout period is reset on each read or write packet If the parameter is set to 0 the connection will not...
Page 75: ...t timeout Connection Close Type 0 1 or 2 This coded parameter defines the personality of the server after a connection is made If the parameter is set to 0 the socket will only be closed when a reques...
Page 76: ...Version Number 2 System architecture 3 Network details If the issue is hardware related we will also need information regarding 1 Module configuration and associated ladder files if any 2 Module oper...
Page 77: ...3 7941 2888 neasia prosoft technology com Languages spoken English Chinese Japanese Korea Phone 60 3 7941 2888 korea prosoft technology com Languages spoken English Korean Regional Office Phone 33 0...
Page 78: ...TECH SUPPORT support la prosoft technology com Andean Countries Central America Caribbean Chile Bolivia Paraguay Phone 507 6427 48 38 andean prosoft technology com Languages spoken Spanish English REG...
Page 79: ...Specifications 54 G General Concepts 55 General Specifications 52 H Handling Multiple Blocks 64 Hardware Specifications 53 I Important Installation Instructions 3 Installing ProSoft Configuration Bui...
Page 80: ...x MVI56E GEC ControlLogix Platform User Manual Generic ASCII Ethernet Communication Module Page 80 of 80 ProSoft Technology Inc W Warnings 3 Warranty Information 78 Write Block 59 Y Your Feedback Plea...
