ProSoft Technology ControlLogix inRAx MVI56E-MNETR User Manual

ProSoft Technology ControlLogix inRAx MVI56E-MNETR User Manual

Modbus tcp/ip interface module with reduced data block
Table of Contents

Advertisement

Quick Links

MVI56E-MNETR
ControlLogix Platform
Modbus TCP/IP Interface Module with
Reduced Data Block
June 14, 2011
USER MANUAL

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the ControlLogix inRAx MVI56E-MNETR and is the answer not in the manual?

Questions and answers

Summary of Contents for ProSoft Technology ControlLogix inRAx MVI56E-MNETR

  • Page 1 MVI56E-MNETR ControlLogix Platform Modbus TCP/IP Interface Module with Reduced Data Block June 14, 2011 USER MANUAL...
  • Page 2: Your Feedback Please

    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...
  • Page 3: Battery Life Advisory

    Battery Life Advisory Note: Modules manufactured after April 1 , 2011 do not contain a battery. For modules manufactured before that date the following applies: The module uses a rechargeable Lithium Vanadium Pentoxide battery to back up the real-time clock and CMOS settings.
  • Page 4 Markings Agency Applicable Standards RoHS ATEX EN60079-0 July 2006 EN60079-15 October 2005 IEC61010 EMC-EN61326-1:2006 EN61000-6-4:2007 CSA CB Safety CA/10533/CSA IEC 61010-1 Ed. 2 CB 243333-2056722 (2090408) cULus GOST-R Test 2.4 243333 E183151 ME06 <Ex> II 3 G Ex nA IIC T4 Gc 0°C <= Ta <= 60°C -25°C <= Ta <= 70°C (XT models only) II –...
  • Page 5: Table Of Contents

    Downloading the Project to the Module ..............69 ® Using CIPconnect to Connect to the Module ............71 2.3.1 Example 1: Local Rack Application ................. 73 2.3.2 Example 2: Remote Rack Application ..............76 ProSoft Technology, Inc. Page 5 of 175 June 14, 2011...
  • Page 6 Data Flow between MVI56E-MNETR Module and ControlLogix Processor..125 Ethernet Cable Specifications ................130 5.3.1 Ethernet Cable Configuration ................130 5.3.2 Ethernet Performance ................... 130 Status Data Definition ................... 131 Page 6 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 7 Limitation of Remedies ** ..................170 6.2.7 Time Limit for Bringing Suit ................... 170 6.2.8 No Other Warranties ..................... 170 6.2.9 Allocation of Risks ....................170 6.2.10 Controlling Law and Severability ................171 Index ProSoft Technology, Inc. Page 7 of 175 June 14, 2011...
  • Page 8 Contents MVI56E-MNETR ♦ ControlLogix Platform User Manual Modbus TCP/IP Interface Module with Reduced Data Block Page 8 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 9: Guide To The Mvi56E-Mnetr User Manual

    Functional Overview Functional Overview (page 112) Support, Service, and Support, Service This section contains Support, Service and → Warranty and Warranty (page Warranty information. 163) Index Index of chapters. Index ProSoft Technology, Inc. Page 9 of 175 June 14, 2011...
  • Page 10 Guide to the MVI56E-MNETR User Manual MVI56E-MNETR ♦ ControlLogix Platform User Manual Modbus TCP/IP Interface Module with Reduced Data Block Page 10 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 11: Start Here

    Hardware installation and wiring: install the module, and safely connect Modbus TCP/IP and ControlLogix devices to a power source and to the MVI56E-MNETR module’s application port(s) ProSoft Technology, Inc. Page 11 of 175 June 14, 2011...
  • Page 12: What's New

    Ethernet settings, allowing quick and easy replacement. LED Scrolling Diagnostic Display: 4-character, alphanumeric display, providing standard English messages for status and alarm data, and for processor and network communication status. Page 12 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 13: System Requirements

    1024 × 768 recommended) CD-ROM drive Note: The Hardware and Operating System requirements in this list are the minimum recommended to install and run software provided by ProSoft Technology ® . Other third party applications may have different minimum requirements. Refer to the documentation for any third party applications for system requirements.
  • Page 14: Package Contents

    ProSoft Solutions CD CD-013 Contains configuration tools for the MVI56E-MNETR module Insert MVI56E-MNETR Quick Start Guide If any of these components are missing, please contact ProSoft Technology Support for replacement parts. Page 14 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 15: Setting Jumpers

    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 175 June 14, 2011...
  • Page 16: Installing The Module In The Rack

    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 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 17: Installing The Configuration Tools

    ONFIGURATION UILDER action starts the installation wizard for ProSoft Configuration Builder. Click N on each page of the installation wizard. Click F on the last INISH page of the wizard. ProSoft Technology, Inc. Page 17 of 175 June 14, 2011...
  • Page 18: Connecting Your Pc To The Module

    PC. You can also connect directly from the Ethernet Port on your PC to the Config (E1) Port on the module by using an Ethernet crossover cable (not included). Page 18 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 19: Setting Temporary Ip Address

    The following illustration shows the PCB window with a new project. Use the mouse to select D in the tree view, and then click the EFAULT ODULE right mouse button to open a shortcut menu. ProSoft Technology, Inc. Page 19 of 175 June 14, 2011...
  • Page 20 In the Product Line Filter area of the dialog box, select MVI56E. In the dropdown list, select MVI56E-MNETR, and then click ELECT ODULE OK to save your settings and return to the ProSoft Configuration Builder window. Right-click the module icon. Page 20 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 21 MVI56E-MNETR ♦ ControlLogix Platform Start Here Modbus TCP/IP Interface Module with Reduced Data Block User Manual On the shortcut menu, choose D IAGNOSTICS This action opens the Diagnostics dialog box. ProSoft Technology, Inc. Page 21 of 175 June 14, 2011...
  • Page 22 If PCB is still unable to connect to the module, click the B ROWSE EVICE button to open the ProSoft Discovery Service. Page 22 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 23 User Manual Select the module, then right-click and choose A SSIGN EMPORARY The module’s default IP address is 192.168.0.250. Choose an unused IP within your subnet, and then click OK. ProSoft Technology, Inc. Page 23 of 175 June 14, 2011...
  • Page 24: Using Cipconnect To Connect To The Module

    (the last ENBT/CNBx and chassis in the path). To use CIPconnect, follow these steps. In the Select Connection Type dropdown list, choose 1756-ENBT. The default path appears in the text box, as shown in the following illustration. Page 24 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 25 The path can only contain ControlNet or Ethernet/IP networks. The maximum number of supported racks is six. Click C to build the path in text format CIP P ONSTRUCT Click OK to confirm the configured path. ProSoft Technology, Inc. Page 25 of 175 June 14, 2011...
  • Page 26: Connecting To The Module's Web Page

    Important: The temporary IP address is only valid until the next time the module is initialized. Please refer to Setting Temporary IP Address (page 19) in the MVI56E-MNETR User Manual for information on how to set the module’s permanent IP address. Page 26 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 27: Uploading The Add-On Instruction From The Module

    If your processor uses an earlier version of RSLogix 5000, see Using the Sample Program (page 158). 1.11 Creating a New RSLogix 5000 Project Open the F menu, and then choose N ProSoft Technology, Inc. Page 27 of 175 June 14, 2011...
  • Page 28: Create The Remote Network

    If you are installing the module in a local rack, follow the steps in Create the Module - Local Rack (page 33). 1.11.1 Create the Remote Network Right-click I/O C and choose N … ONFIGURATION ODULE Page 28 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 29 Note: If you are prompted to "Select Major Revision", choose the lower of the available revision numbers. Name the ENBT/A module, then set the IP Address and slot location in the local rack with the ControlLogix processor. Click OK. ProSoft Technology, Inc. Page 29 of 175 June 14, 2011...
  • Page 30: Create The Module - Remote Rack

    Controller Organization ACKPLANE pane underneath the remote rack EtherNet/IP module you just created and click the right mouse button to open a shortcut menu. On the shortcut menu, choose N ODULE Page 30 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 31 This action opens the S dialog box. ELECT ODULE Select the 1756-M 1756 M ) from the list and click OK. ODULE ENERIC ODULE This action opens the N dialog box. ODULE ProSoft Technology, Inc. Page 31 of 175 June 14, 2011...
  • Page 32 Output Assembly Instance Output Size Configuration Assembly Instance 4 Configuration Size On the C tab, set the RPI value for your project. Fifty (50) ONNECTION milliseconds is usually a good starting value. Page 32 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 33: Create The Module - Local Rack

    I/O C ONTROLLER RGANIZATION ONFIGURATION click the right mouse button to open a shortcut menu. On the shortcut menu, choose N ODULE This action opens the S dialog box. ELECT ODULE ProSoft Technology, Inc. Page 33 of 175 June 14, 2011...
  • Page 34 Enter the slot number in the rack where the MVI56E-MNETR module is to be installed. Input Assembly Instance Input Size Output Assembly Instance Output Size Configuration Assembly Instance 4 Configuration Size Page 34 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 35 RPI value for your project. Five (5) ONNECTION milliseconds is usually a good starting value. Click OK to confirm. The MVI56E-MNETR module is now visible in the I/O C section ONFIGURATION ProSoft Technology, Inc. Page 35 of 175 June 14, 2011...
  • Page 36: Import Add-On Instruction

    On the shortcut menu, choose I MPORT … Navigate to the location on your PC where you saved (page 27) the Add-On Instruction (for example, "My Documents" or "Desktop"). Select the MVI56EMNETR_A 1_3.L5X file Page 36 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 37 Input and Output tags, and select the MNETR module in the remote rack. Click OK to confirm the import. RSLogix will indicate that the import is in progress: ProSoft Technology, Inc. Page 37 of 175 June 14, 2011...
  • Page 38 The procedure has also imported new User Defined Data Types, data objects and the Add-On instruction for your project. Save the application and then download the sample ladder logic into the processor. Page 38 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 39 In the I/O Configuration folder, click the right mouse button to open a shortcut menu, and then choose N ODULE Select 1756-MODULE This action opens the New Module dialog box. ProSoft Technology, Inc. Page 39 of 175 June 14, 2011...
  • Page 40 On the MainProgram folder, click the right mouse button to open a shortcut menu. On the shortcut menu, choose N OUTINE In the New Routine dialog box, enter the name and description of your routine, and then click OK. Page 40 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 41 Select an empty rung in the new routine, and then click the right mouse button to open a shortcut menu. On the shortcut menu, choose "I MPORT …". Select the file MVI56(E)MNETR_AddOn_Rung_<Version#>.L5X ProSoft Technology, Inc. Page 41 of 175 June 14, 2011...
  • Page 42 MPORT ONFIGURATION controller tags that will be created. 10 Associate the I/O connection variables to the correct module. The default values are Local:1:I and Local:1:O so these require change. Page 42 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 43 User Manual Change the default tags MNETR and AOI56MNETR to avoid conflict with existing tags. This procedure will append the string "_2" as follows: Or, in a Remote Rack application… ProSoft Technology, Inc. Page 43 of 175 June 14, 2011...
  • Page 44 Start Here MVI56E-MNETR ♦ ControlLogix Platform User Manual Modbus TCP/IP Interface Module with Reduced Data Block 11 Click OK to confirm. Page 44 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 45 MVI56E-MNETR ♦ ControlLogix Platform Start Here Modbus TCP/IP Interface Module with Reduced Data Block User Manual Or, in a Remote Rack application… ProSoft Technology, Inc. Page 45 of 175 June 14, 2011...
  • Page 46 It is unnecessary to manually edit the ReadData and WriteData user-defined data types in the ladder logic, as these are automatically updated to match the changed array sizes in ProSoft Configuration Builder. Page 46 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 47: Connecting Your Pc To The Controllogix Processor

    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 47 of 175 June 14, 2011...
  • Page 48: Downloading The Sample Program To The Processor

    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 48 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 49: Configuring The Mvi56E-Mnetr Module

    Configuring the MVI56E-MNETR Module In This Chapter Using ProSoft Configuration Builder Software ........50 Downloading the Project to the Module ..........69 ® Using CIPconnect to Connect to the Module ........71 ProSoft Technology, Inc. Page 49 of 175 June 14, 2011...
  • Page 50: Using Prosoft Configuration Builder Software

    Note: During startup and initialization, the MVI56E-MNETR module receives its protocol and backplane configuration information from the installed Personality Module (Compact Flash). Use ProSoft Configuration Builder to configure module settings and to download changes to the Personality Module. Page 50 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 51: Setting Up The Project

    Your first task is to add the MVI56E-MNETR module to the project. Use the mouse to select D in the tree view, and then click the EFAULT ODULE right mouse button to open a shortcut menu. ProSoft Technology, Inc. Page 51 of 175 June 14, 2011...
  • Page 52 In the Product Line Filter area of the dialog box, select MVI56E. In the dropdown list, select MVI56E-MNETR, and then click ELECT ODULE OK to save your settings and return to the ProSoft Configuration Builder window. Page 52 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 53: Renaming Pcb Objects

    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 53 of 175 June 14, 2011...
  • Page 54: Module

    Note: Total Read Register Count and Write Register Count cannot exceed 5000 total registers. Read Data and Write Data Areas must be configured to occupy separate address ranges in module memory and should not be allowed to overlap. Page 54 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 55 0. If the value is set to 1, the data will be initialized with data from the processor. Use of this option requires associated ladder logic to pass the data from the processor to the module. ProSoft Technology, Inc. Page 55 of 175 June 14, 2011...
  • Page 56: Mnet Client X

    Read Data area. If the value is set to -1, the Command Error List data will not be stored in the module's internal database and will not be transferred to the processor's ReadData array. Page 56 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 57 This parameter is only used if the Float Flag is enabled. For example, if a value of 7000 is entered, all requests for registers 7000 and above will be considered as floating-point data. ProSoft Technology, Inc. Page 57 of 175 June 14, 2011...
  • Page 58: Mnet Client X Commands

    Each command list record has the same format. The first part of the record contains the information relating to the MVI56E-MNETR communication module, and the second part contains information required to interface to the Modbus TCP/IP server device. Page 58 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 59 If the data in the command has changed since the command was last issued, the command will be executed. Use of this feature can lighten the load on the network. To implement this feature, set the enable code for the command to (2). ONDITIONAL ProSoft Technology, Inc. Page 59 of 175 June 14, 2011...
  • Page 60 The first part of the record is the module information, which relates to the MVI56E module and the second part contains information required to interface to the server device. Command list example: Page 60 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 61 (Enable code of 1). The parameter is entered in tenths of a second. Therefore, if a value of 100 is entered for a command, the command executes no more frequently than every 10 seconds. ProSoft Technology, Inc. Page 61 of 175 June 14, 2011...
  • Page 62 Swap Codes should be done only when using an even number of words, such as when 32-bit integer or floating-point data is involved. Node IP Address xxx.xxx.xxx.xxx The IP address of the device being addressed by the command. Page 62 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 63 Modbus Function Code Description Read Coil Status Read Input Status Read Holding Registers Read Input Registers Force (Write) Single Coil Preset (Write) Single Register Force Multiple Coils Preset Multiple Registers ProSoft Technology, Inc. Page 63 of 175 June 14, 2011...
  • Page 64 In such cases, it is not usually necessary to subtract 1 from the converted decimal number, as this addressing scheme typically uses the exact offset address expressed as a hexadecimal number. Comment 0 to 35 alphanumeric characters Page 64 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 65: Mnet Servers

    , which is the default setting. You will also need to set the Float Start and Float Offset parameters to appropriate values whenever the Float Flag parameter is set to Y ProSoft Technology, Inc. Page 65 of 175 June 14, 2011...
  • Page 66 For example, if the Holding Register Offset value is set to 4000, data requests for Modbus Word register 40001 will use the internal database register 4000. Function codes affected are 3, 6, 16, & 23. Page 66 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 67: Static Arp Table

    Important: If the device in the field is changed, this table must be updated to contain the new MAC address for the device and downloaded to the module. If the MAC is not changed, no communications with the module will occur. ProSoft Technology, Inc. Page 67 of 175 June 14, 2011...
  • Page 68: Ethernet Configuration

    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. Page 68 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 69: Downloading The Project To The Module

    If the Test Connection procedure fails, you will see an error message. To correct the error, follow these steps. Click OK to dismiss the error message. ProSoft Technology, Inc. Page 69 of 175 June 14, 2011...
  • Page 70 Select the module, and then click the right mouse button to open a shortcut menu. On the shortcut menu, choose S PCB. ELECT FOR Close ProSoft Discovery Service. Click D to transfer the configuration to the module. OWNLOAD Page 70 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 71: Using Cipconnect ® To Connect To The Module

    Using CIPconnect to Connect to the Module ® You can use CIPconnect to connect a PC to the ProSoft Technology MVI56E- MNETR module over Ethernet using Rockwell Automation’s 1756-ENBT ® EtherNet/IP module. This allows you to configure the MVI56E-MNETR network settings and view module diagnostics from a PC.
  • Page 72 ONSTRUCT Click OK to confirm the configured path. The following examples should provide a better understanding on how to set up the path for your network. Page 72 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 73: Example 1: Local Rack Application

    For this example, the MVI56E-MNETR module is located in the same rack as the 1756-ENBT that is connected to the PC. Rack 1 Slot Module Network Address ControlLogix Processor MVI56E-MNETR 1756-ENBT IP=192.168.0.100 In the Download dialog box, click CIP P ProSoft Technology, Inc. Page 73 of 175 June 14, 2011...
  • Page 74 CIP P ONSTRUCT Click OK to close the CIPconnect Path Editor and return to the Download dialog box. Check the new path in the Download dialog box. Page 74 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 75 Click OK to close the Test Connection pop-up and then click D OWNLOAD download the configuration files to the module through the path. ProSoft Technology, Inc. Page 75 of 175 June 14, 2011...
  • Page 76: Example 2: Remote Rack Application

    ControlNet, as shown in the following illustration. Rack 1 Slot Module Network Address ControlLogix Processor 1756-CNB Node = 1 1756-ENBT IP=192.168.0.100 Rack 2 Slot Module Network Address 1756-CNB Node = 2 MVI56E-MNETR Page 76 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 77 Configure the path as shown in the following illustration and click C ONSTRUCT to build the path in text format. CIP P Click OK to close the CIPconnect Path Editor and return to the Download dialog box. ProSoft Technology, Inc. Page 77 of 175 June 14, 2011...
  • Page 78 The ONNECTION following message should be displayed upon success. Click D to download the configuration files to the module through OWNLOAD the path. Page 78 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 79: Ladder Logic

    The sample Import Rung with Add-On Instruction is extensively commented to provide information on the purpose and function of each user-defined data type and controller tag. For most applications, the Import Rung with Add-On Instruction will work without modification. ProSoft Technology, Inc. Page 79 of 175 June 14, 2011...
  • Page 80: Mnetrmoduledef

    This object contains objects that define the configuration, user data, status and command control data related to the module. Each of these object types is discussed in the following topics of the document. Page 80 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 81: Mnetrdata

    This data is passed from the processor to the module for status and control information for use in other nodes on the network. ProSoft Technology, Inc. Page 81 of 175 June 14, 2011...
  • Page 82: Mnetrstatus

    Total number of write block transfers Parse Total number of blocks parsed Event Total number of event blocks received Total number of command blocks received Total number of block transfer errors Page 82 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 83 Configuration Error Word CurErr Current Error code LastErr Last recorded error code Refer to MVI56E-MNETR Status Data Definition for a complete listing of the data stored in the status object. ProSoft Technology, Inc. Page 83 of 175 June 14, 2011...
  • Page 84: Mnetrcontrol

    Swap code for functions 3 and 4 Function Modbus function code for message Address Address to interface with in device Result Shows the result of the event that was sent Page 84 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 85 NumberOfCommands The number of commands to execute from the Client command list CommandsAddedtoQueue Number of commands added to queue CmdControlTrigger BOOL Trigger Command Control. User application will activate this trigger. ProSoft Technology, Inc. Page 85 of 175 June 14, 2011...
  • Page 86 Data structure to get and set the IP address of the module. Name Data Type Description IPGetTrigger BOOL Gets IP address IPReceived INT[4] IP address received IPSetTrigger BOOL Sets IP address IPRequested INT[4] IP address set Page 86 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 87: Mnetrutil

    The LastRead tag stores the latest Read Block ID received from the module. The LastWrite tag stores the latest Write Block ID to be sent to the module. The Block Index tag is an intermediate variable used during the block calculation. ProSoft Technology, Inc. Page 87 of 175 June 14, 2011...
  • Page 88 RetInitOutDataBlkID Returned Block ID for Returned Initialize Output Data command. InitOutBlkIDLim Block Index Limit for ReadData size of the array Page 88 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 89: Modbus Message Data

    (codes 2 or 3 in the MNET.CFG file). These blocks require less decoding than the unformatted blocks. Refer to Pass-Through Control Blocks (page 122) for a full discussion on utilizing the pass-through option in an application. ProSoft Technology, Inc. Page 89 of 175 June 14, 2011...
  • Page 90 Ladder Logic MVI56E-MNETR ♦ ControlLogix Platform User Manual Modbus TCP/IP Interface Module with Reduced Data Block Page 90 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 91: Diagnostics And Troubleshooting

    Status data contained in the module can be viewed in ProSoft Configuration Builder through the Ethernet port. Status data values are transferred from the module to the processor. ProSoft Technology, Inc. Page 91 of 175 June 14, 2011...
  • Page 92: Reading Status Data From The Module

    Complete display of the module’s internal database (registers 0 to 4999) Version Information Control over the module (warm boot, cold boot, transfer configuration) Facility to upload and download the module’s configuration file Page 92 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 93: The Diagnostics Menu

    4.2.1 Using the Diagnostics Menu in ProSoft Configuration Builder To connect to the module’s Configuration/Debug Ethernet port: In ProSoft Configuration Builder, select the module, and then click the right mouse button to open a shortcut menu. ProSoft Technology, Inc. Page 93 of 175 June 14, 2011...
  • Page 94 On the shortcut menu, choose D IAGNOSTICS This action opens the Diagnostics dialog box. If there is no response from the module, Click the S button to browse for the module’s IP address. ONNECTION Page 94 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 95 1756- ENBT card. Refer to Using CIPconnect to Connect to the Module (page 71, page 24) for information on how to construct a CIP path. ProSoft Technology, Inc. Page 95 of 175 June 14, 2011...
  • Page 96 (using the grey cable) or directly between your computer and the module (using the red cable). If you are still not able to establish a connection, contact ProSoft Technology for assistance. Page 96 of 175 ProSoft Technology, Inc.
  • Page 97: Monitoring Module Information

    The Static ARP Table (page 67) defines a list of static IP addresses that the module will use when an ARP is required. Monitoring Backplane Information Use the BACKPLANE menu to view the backplane status information for the MVI56E-MNETR module. ProSoft Technology, Inc. Page 97 of 175 June 14, 2011...
  • Page 98: Backplane Status

    During normal operation, the read, write, and parsing values should increment continuously, while the error value should not increment. The status values on this menu correspond with the members of the MVI56E- MNETR Status object (page 131). Page 98 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 99: Monitoring Database Information

    You can view data in the following formats: ASCII Decimal Float Hexadecimal Use the scroll bar on the right edge of the window to view each page (100 words) of data. ProSoft Technology, Inc. Page 99 of 175 June 14, 2011...
  • Page 100: Monitoring Mnet Client Information

    Use the Status menu to view status for MNET Client x. During normal operation, the number of requests and responses should increment, while the number of errors should not change. Page 100 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 101: Monitoring Mnet Server Information

    Use the Status menu to view the status of each MNET server connected to the MNET Client 0. During normal operation, the number of requests and responses should increment, while the number of errors should not change. ProSoft Technology, Inc. Page 101 of 175 June 14, 2011...
  • Page 102: Led Status Indicators

    WIOffs : Word Input Offset parameter OutOffs : Output offset parameter HoldOffs : Holding Register offset parameter FltFlag: Float Flag parameter FltSt : Float Start parameter FltOffs : Float Offset parameter Page 102 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 103: Ethernet Led Indicators

    No physical network connection is detected. No Ethernet communication is possible. Check wiring and cables. GREEN Solid Physical network connection detected. This LED must be ON solid or Blinking for Ethernet communication to be possible. ProSoft Technology, Inc. Page 103 of 175 June 14, 2011...
  • Page 104: Non-Scrolling Led Status Indicators

    If the LED remains RED for over 10 seconds, the module is not working. Remove it from the rack and re-insert it to restart its internal program. Not Used Page 104 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 105: Client Configuration Error Word

    This does not indicate that the configuration is valid for the user application. Make sure each parameter is set correctly for the specific application. ProSoft Technology, Inc. Page 105 of 175 June 14, 2011...
  • Page 106: Clearing A Fault Condition

    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. Page 106 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 107: Troubleshooting

    User Manual 4.11 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...
  • Page 108 Diagnostics and Troubleshooting MVI56E-MNETR ♦ ControlLogix Platform User Manual Modbus TCP/IP Interface Module with Reduced Data Block Page 108 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 109: Reference

    Status Data Definition ................131 Modbus Protocol Specification ............132 Using the Optional Add-On Instruction Rung Import ......146 Adding the Module to an Existing Project ..........155 Using the Sample Program ..............158 ProSoft Technology, Inc. Page 109 of 175 June 14, 2011...
  • Page 110: Product Specifications

    IP address Personality Module - a non-volatile, industrial-grade Compact Flash (CF) card used to store network and module configuration, allowing quick in-the-field product replacement by transferring the CF card Page 110 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 111: Functional Specifications

    Setting, Port Status, and Error Information Debug/Configuration/Application Ethernet port (E1) Ethernet Port 10/100 Base-T, RJ45 Connector, for CAT5 cable Link and Activity LED indicators Auto-crossover cable detection Shipped with Unit 5-foot Ethernet straight-through cable ProSoft Technology, Inc. Page 111 of 175 June 14, 2011...
  • Page 112: Functional Overview

    Initialize Module Register space Enable Server Drivers Enable Client Driver When the module has received the configuration, the module will begin communicating with other nodes on the network, depending on the configuration. Page 112 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 113: Backplane Data Transfer

    This database is defined as a virtual Modbus data table with addresses from 0 (40001 Modbus) to 4999 (45000 Modbus). The following illustration shows the layout of the database: ProSoft Technology, Inc. Page 113 of 175 June 14, 2011...
  • Page 114 (registers 0 to 4999), as well as paging of status data. These data are transferred through read (input image) and write (output image) blocks. The following topics describe the function and structure of each block. Page 114 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 115 The Write Block ID is an index value used to determine the location in the module’s database where the data will be placed. Each transfer can move up to 40 words (block offsets 1 to 40) of data. ProSoft Technology, Inc. Page 115 of 175 June 14, 2011...
  • Page 116 The following table describes the structure of the request block. Offset Description Length 1000 to 1124 1 to 40 Spare 1000 to 1124 Page 116 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 117 Important: Each command defined in the command list is controlled by the ladder logic. The Write Command Bits parameter must be set in ladder logic to allow the command to be sent out on the Modbus TCP/IP network. ProSoft Technology, Inc. Page 117 of 175 June 14, 2011...
  • Page 118 1 to 4 →192, 168, 0 and 100. The module will construct the normal dotted IP address from the values entered. The values entered will be anded with the mask 0x00ff to insure the values are in the range of 0 to 255. Page 118 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 119 Word two of the block can be used by the ladder logic to determine if the command was added to the command queue of the module. The command will only fail if the command queue for the port is full (100 commands for each queue). ProSoft Technology, Inc. Page 119 of 175 June 14, 2011...
  • Page 120 The following table describes the format for this block. Offset Description Length Write Block ID Number of commands added to command queue 2 to 40 Spare 5001 to 5006 Page 120 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 121 First digit of dotted IP address Second digit of dotted IP address Third digit of dotted IP address Last digit of dotted IP address 6 to 41 Spare data area ProSoft Technology, Inc. Page 121 of 175 June 14, 2011...
  • Page 122 The following table describes the format of the read block. Unformatted Unformatted Pass-Through Command (Read Block) Offset Description Length 9996 Number of bytes in Modbus msg Reserved (always 0) 3 to 40 Modbus message received 9996 Page 122 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 123 9956, 9957, 9958, 9960 or 9961 Number of word registers in Modbus data set Starting address for Modbus data set 3 to 40 Modbus data set 9956, 9957, 9958, 9960 or 9961 ProSoft Technology, Inc. Page 123 of 175 June 14, 2011...
  • Page 124 Formatted Pass-Through Response (Write Block) Offset Description Length 9959 1 to 41 Spare data area Formatted Pass-Through Response (Write Block) Offset Description Length 9970 1 to 41 Spare data area Page 124 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 125: Data Flow Between Mvi56E-Mnetr Module And Controllogix Processor

    The Server Driver allows the MVI56E-MNETR module to respond to data read and write commands issued by clients on the Modbus TCP/IP network. The following illustration and associated table describe the flow of data into and out of the module. ProSoft Technology, Inc. Page 125 of 175 June 14, 2011...
  • Page 126 The SCADA system expects the local logic to reset the control bit. Pass-through must be used to simulate this mode. The following illustration describes the data flow for a slave port with pass-through enabled: Page 126 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 127 When configured, the Client driver begins transmitting read and/or write commands to the other nodes on the network. The data for write commands is obtained from the module's internal database. ProSoft Technology, Inc. Page 127 of 175 June 14, 2011...
  • Page 128 This error list can be transferred to the processor. The errors generated by the module are displayed in the following table. Page 128 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 129 This feature allows the Client to continue sending commands and polling other existing servers, while waiting for the non-existent server to appear on the network. ProSoft Technology, Inc. Page 129 of 175 June 14, 2011...
  • Page 130: Ethernet Cable Specifications

    MNETR performance High Ethernet traffic may impact MNETR performance (consider CIPconnect (page 71, page 24) for these applications and disconnect the module Ethernet port from the network). Page 130 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 131: Status Data Definition

    Client Current Error Code This value corresponds to the current error code for the client. Client Last Error Code This value corresponds to the last error code recorded for the client. ProSoft Technology, Inc. Page 131 of 175 June 14, 2011...
  • Page 132: Modbus Protocol Specification

    Each command list record has the same general format. The first part of the record contains the information relating to the communication module and the second part contains information required to interface to the Modbus TCP/IP server device. Page 132 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 133: Read Coil Status (Function Code 01)

    Byte Data Coil Data Coil Data Coil Data Coil Data Coil Error Count Status 20 to Status 28 to Status 36 to Status 44 to Status 52 to Check Field ProSoft Technology, Inc. Page 133 of 175 June 14, 2011...
  • Page 134: Read Input Status (Function Code 02)

    Func Byte Data Discrete Input Data Discrete Input Data Discrete Input Error Check Field Count 10197 to 10204 10205 to 10212 10213 to 10218 Page 134 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 135: Read Holding Registers (Function Code 03)

    In the example below, the registers 40108 to 40110 have the decimal contents 555, 0, and 100 respectively. Func ByteCnt Hi Data Lo Data Hi Data Lo Data Hi Data Lo Data Error Check Field ProSoft Technology, Inc. Page 135 of 175 June 14, 2011...
  • Page 136: Read Input Registers (Function Code 04)

    PC scans will be required, and the data provided will be form sequential scans. In the example below the register 3009 contains the decimal value 0. Func Byte Count Data Input Reg Hi Data Input Reg Lo Error Check Field Page 136 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 137: Force Single Coil (Function Code 05)

    Thus, if such a coil is set ON by function Code 5 and (even months later), an output is connected to that coil, the output will be "hot". ProSoft Technology, Inc. Page 137 of 175 June 14, 2011...
  • Page 138: Preset Single Register (Function Code 06)

    The response to a preset single register request is to re-transmit the query message after the register has been altered. Func Data Reg Hi Data Reg Lo Data Input Reg Hi Data Input Reg Lo Error Check Field Page 138 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 139: Diagnostics (Function Code 08)

    (A5 37 hex). Request Response Field Name (Hex) Field Name (Hex) Function Function Sub-function Hi Sub-function Hi Sub-function Lo Sub-function Lo Data Hi Data Hi Data Lo Data Lo ProSoft Technology, Inc. Page 139 of 175 June 14, 2011...
  • Page 140 Modbus TCP/IP Interface Module with Reduced Data Block The data fields in responses to other kinds of queries could contain error counts or other data requested by the sub-function code. Page 140 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 141: Force Multiple Coils (Function Code 15)

    Thus, if such a coil is set ON by function code 15 and (even months later) an output is connected to that coil, the output will be hot. ProSoft Technology, Inc. Page 141 of 175 June 14, 2011...
  • Page 142: Preset Multiple Registers (Function Code 16)

    The normal response to a function 16 query is to echo the address, function code, starting address and number of registers to be loaded. Func Hi Addr Lo Addr Quantity Error Check Field Page 142 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 143: Modbus Exception Responses

    (01) is for a Read Output Status operation. It requests the status of the output at address 1245 (04A1 hex). Note that only that one output is to be read, as specified by the number of outputs field (0001). ProSoft Technology, Inc. Page 143 of 175 June 14, 2011...
  • Page 144 Usually means that the gateway is misconfigured or overloaded. Page 144 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 145 Specialized use in conjunction with gateways, indicates Failed To Respond that no response was obtained from the target device. Usually means that the device is not present on the network. ProSoft Technology, Inc. Page 145 of 175 June 14, 2011...
  • Page 146: Using The Optional Add-On Instruction Rung Import

    Important: The Optional Add-On Instruction only supports the two features listed above. You must use the sample ladder logic for all other features including backplane transfer of Modbus TCP/IP data. Page 146 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 147: Installing The Rung Import With Optional Add-On Instruction

    Right-click on an empty rung in the main routine of your existing ladder logic and choose I … MPORT Navigate to the folder where you saved MVI56(E)MNETR_Optional_AddOn_Rung_<version #>.L5X and select the file. ProSoft Technology, Inc. Page 147 of 175 June 14, 2011...
  • Page 148 MPORT ONFIGURATION The Add-On Instruction will be now visible in the ladder logic. Observe that the procedure has also imported data types and controller tags associated to the Add-On Instruction. Page 148 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 149 In the Add-On Instruction, click the [...] button next to each MSG tag to open the M ESSAGE ONFIGURATION Click the C tab and click the B button as follows. OMMUNICATION ROWSE ProSoft Technology, Inc. Page 149 of 175 June 14, 2011...
  • Page 150: Reading The Ethernet Settings From The Module

    Select the module to configure the message path. 5.6.4 Reading the Ethernet Settings from the Module Expand the MVI56MNETRE controller tag and move a value of 1 to THERNET MVI56MNETRE THERNET Page 150 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 151 The bit will be automatically reset and the current Ethernet settings will be copied to MVI56MNETRE controller tag as follows. THERNET To check the status of the message, refer to the R MSG tag. THERNET ProSoft Technology, Inc. Page 151 of 175 June 14, 2011...
  • Page 152: Writing The Ethernet Settings To The Module

    Move a value of 1 to MVI56MNETRE THERNET RITE After the message is executed, the MVI56MNETRE bit resets to THERNET RITE To check the status of the message, refer to the W MSG tag. RITE THERNET Page 152 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 153: Reading The Clock Value From The Module

    The bit will be automatically reset and the current clock value will be copied to controller tag as follows. MVI56MNETRC LOCK ONFIG To check the status of the message, refer to the R MSG tag. LOCK ProSoft Technology, Inc. Page 153 of 175 June 14, 2011...
  • Page 154: Writing The Clock Value To The Module

    Move a value of 1 to MVI56MNETRC LOCK RITE The bit will be automatically reset to 0. To check the status of the message, refer to the W MSG tag. RITE LOCK Page 154 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 155: Adding The Module To An Existing Project

    ONFIGURATION ONTROLLER RGANIZATION click the right mouse button to open a shortcut menu. On the shortcut menu, choose N ODULE This action opens the S dialog box: ELECT ODULE ProSoft Technology, Inc. Page 155 of 175 June 14, 2011...
  • Page 156 Enter the Name, Description and Slot options for your application. You must select the C - INT in the dialog box, otherwise the ORMAT AS module will not communicate over the backplane of the ControlLogix rack. Click OK to continue. Page 156 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 157 Copy the User Defined Data Types from the sample program. Copy the Ladder Rungs from the sample program. Save and Download (page 48, page 162) the new application to the controller and place the processor in run mode. ProSoft Technology, Inc. Page 157 of 175 June 14, 2011...
  • Page 158: Using The Sample Program

    Download the manuals and sample program from the ProSoft Technology web site You can always download the latest version of the sample ladder logic and user manuals for the MVI56E-MNETR module from the ProSoft Technology website, at www.prosoft-technology.com/support/downloads (http://www.prosoft-...
  • Page 159 Choose the sample program file that matches your firmware version, and then click the S button. ELECT RSLogix will load the sample program. The next step is to configure the correct controller type and slot number for your application. ProSoft Technology, Inc. Page 159 of 175 June 14, 2011...
  • Page 160: Choosing The Controller Type

    ControlLogix controller. Select the correct firmware revision for your controller, if necessary. Click OK to save your changes and return to the previous window. Page 160 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 161: Selecting The Slot Number For The Module

    RSLogix will automatically apply the slot number change to all tags, variables and ladder logic rungs that use the MVI56E-MNETR slot number for computation. ProSoft Technology, Inc. Page 161 of 175 June 14, 2011...
  • Page 162: Downloading The Sample Program To The Processor

    Click OK to switch the processor from 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 162 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 163: Support, Service & Warranty

    Return Material Authorization (RMA) Policies and Conditions ..... 165 LIMITED WARRANTY ................. 166 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 164 (location in Sao Paulo) E-mail: brasil@prosoft-technology.com Languages spoken include: Portuguese, English For complete details regarding ProSoft Technology’s TERMS & CONDITIONS OF SALE, WARRANTY, SUPPORT, SERVICE AND RETURN MATERIAL AUTHORIZATION INSTRUCTIONS please see the documents on the Product DVD or go to www.prosoft-technology/legal...
  • Page 165: Return Material Authorization (Rma) Policies And Conditions

    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 166). In the event of any inconsistency between the RMA Policies and the Warranty, the Warranty shall govern.
  • Page 166: Returning Units Out Of Warranty

    Modbus TCP/IP Interface Module with Reduced Data Block ii. If defect is customer generated and is repairable, customer can authorize ProSoft Technology to repair the unit by providing a purchase order for 30% of the current list price plus freight charges, duties and taxes as applicable.
  • Page 167: What Is Covered By This Warranty

    Customer assumes complete responsibility for decisions made or actions taken based on information obtained using ProSoft software. ProSoft Technology, Inc. Page 167 of 175 June 14, 2011...
  • Page 168: Disclaimer Regarding High Risk Activities

    The Buyer assumes all risks (including the risk of suit) that the product or any use of the product will infringe existing or subsequently issued patents, trademarks, or copyrights. Page 168 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 169: Disclaimer Of All Other Warranties

    The Warranty set forth in What Is Covered By This Warranty (page 167) 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 169 of 175 June 14, 2011...
  • Page 170: Limitation Of Remedies

    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 170 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 171: Controlling Law And Severability

    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 171 of 175 June 14, 2011...
  • Page 172 Support, Service & Warranty MVI56E-MNETR ♦ ControlLogix Platform User Manual Modbus TCP/IP Interface Module with Reduced Data Block Page 172 of 175 ProSoft Technology, Inc. June 14, 2011...
  • Page 173 How to Contact Us • 2 Connecting to the Module's Web Page • 26 Connecting Your PC to the ControlLogix Processor • Import Add-On Instruction • 36 Connecting Your PC to the Module • 18 ProSoft Technology, Inc. Page 173 of 175 June 14, 2011...
  • Page 174 Limitation of Remedies ** • 170 Product Specifications • 9, 110 LIMITED WARRANTY • 165, 166 ProSoft Technology® Product Documentation • 2 MB Address in Device • 64 Read Coil Status (Function Code 01) • 133 Minimum Command Delay • 57 Read Holding Registers (Function Code 03) •...
  • Page 175 Write Register Count • 55 Write Register Start • 55 Writing the Clock Value to the Module • 154 Writing the Ethernet Settings to the Module • 152 Your Feedback Please • 2 ProSoft Technology, Inc. Page 175 of 175 June 14, 2011...

Table of Contents