Neither ProSoft Technology nor any of its affiliates or subsidiaries shall be responsible or liable for misuse of the information contained herein. Information in this document including illustrations, specifications and dimensions may contain technical inaccuracies or typographical errors.
Important Safety Information North America Warnings This Equipment is Suitable For Use in Class I, Division 2, Groups A, B, C, D or Non-Hazardous Locations Only. Warning – Explosion Hazard – Substitution of Any Components May Impair Suitability for Class I, Division 2. Warning –...
Downloading the Configuration File to the Processor ..........57 Uploading the Configuration File from the Processor ..........60 MVI69E-MBTCP Backplane Data Exchange General Concepts of the MVI69E-MBTCP Data Transfer ........63 Backplane Data Transfer..................64 ProSoft Technology, Inc. Page 5 of 150...
Page 6
Module Communication Error Codes ..............104 6.5.3 Command List Entry Errors .................. 104 6.5.4 MBTCP Client-Specific Errors ................105 Connecting to the MVI69E-MBTCP Webpage ............. 105 Reference Product Specifications ..................107 7.1.1 General Specifications - Modbus Client/Server ............ 108 7.1.2 Hardware Specifications ..................
Page 7
MVI69E-MBTCP ♦ CompactLogix Platform Contents Modbus TCP/IP Enhanced Communication Module User Manual 7.2.5 Read Input Status (Function Code 02) ..............112 7.2.6 Read Holding Registers (Function Code 03) ............113 7.2.7 Read Input Registers (Function Code 04) ............. 114 7.2.8 Force Single Coil (Function Code 05) ..............
Page 8
MVI69E-MBTCP ♦ CompactLogix Platform Modbus TCP/IP Enhanced Communication Module User Manual ProSoft Technology, Inc. Page 8 of 150 June 28, 2017...
MVI69E-MBTCP ♦ CompactLogix Platform Start Here Modbus TCP/IP Enhanced Communication Module User Manual Start Here In This Chapter System Requirements ................10 Deployment Checklist ................10 Setting Jumpers ..................11 Installing the Module in the Rack ............12 ...
MVI69E-MBTCP module. Important: The MVI69E-MBTCP module has a power supply distance rating of 4 (L43 and L45 installations on first 2 slots of 1769 bus). It consumes 500 mA at 5 Vdc.
Most applications can use the Sample Add-On Instruction or Sample Ladder Logic without any modification. Which slot number in the chassis does the MVI69E-MBTCP module occupy? For communication to occur, you must enter the correct slot number in the sample program.
Refer to the documentation for each device to be connected to verify that suitable safety procedures are in place before installing or servicing the device. After you verify the jumper placements, insert the MVI69E-MBTCP into the rack. Use the same technique recommended by Rockwell Automation to remove and install CompactLogix modules.
Page 13
MVI69E-MBTCP ♦ CompactLogix Platform Start Here Modbus TCP/IP Enhanced Communication Module User Manual Move the module back along the tongue-and-groove slots until the bus connectors on the MVI69 module and the adjacent module line up with each other. Push the module’s bus lever back slightly to clear the positioning tab and move it firmly to the left until it clicks.
Page 14
Start Here MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module Press the DIN-rail mounting area of the controller against the DIN-rail. The latches momentarily open and lock into place. Page 14 of 150 ProSoft Technology, Inc. June 28, 2017...
Modbus TCP/IP Enhanced Communication Module User Manual Package Contents The following components are included with your MVI69E-MBTCP module, and are all required for installation and configuration. Important: Before beginning the installation, please verify that all of the following items are present.
Page 16
MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module Page 16 of 150 ProSoft Technology, Inc. June 28, 2017...
Create a new project in RSLogix 5000. Add the module to the RSLogix 5000 project. There are two ways to do this: You can use the Add-On Profile from ProSoft Technology. This is the preferred way, but requires RSLogix version 15 or later.
Adding the Module to RSLogix MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module 2.1.1 Creating a Module in the Project Using an Add-On Profile Installing an Add-On Profile Download the AOP file (MVI69x_RevX.X_AOP.zip) from the product webpage (www.prosoft-technology.com) onto your local hard drive and then extract the...
Page 19
MVI69E-MBTCP ♦ CompactLogix Platform Adding the Module to RSLogix Modbus TCP/IP Enhanced Communication Module User Manual Click F when complete. The AOP is now installed in RSLogix 5000. You INISH do not need to reboot the PC. Using an Add-On Profile In RSLogix 5000, expand the I/O C folder in the Project tree.
Page 20
In the Module Type Vendor Filters area, uncheck all boxes except the box. A list of ProSoft Technology modules appears. ECHNOLOGY Select the MVI69E-MBTCP module in the list and click C REATE In the New Module dialog box, edit the N and S .
Adding the Module to RSLogix Modbus TCP/IP Enhanced Communication Module User Manual The MVI69E-MBTCP module is now visible in the I/O Configuration tree. 2.1.2 Creating a Module in the Project Using a Generic 1769 Module Profile Expand the I/O C folder in the Project tree.
Page 22
Enter a description for the module. Example: ProSoft communication module for Serial Modbus communications. Comm Format Select D -INT Slot Enter the slot number in the rack where the MVI69E-MBTCP module is installed. Input Assembly Instance Input Size 62 / 122 / 242 Output Assembly Instance...
Page 23
MVI69E-MBTCP ♦ CompactLogix Platform Adding the Module to RSLogix Modbus TCP/IP Enhanced Communication Module User Manual The following illustration shows an example where the module was configured for a block transfer size of 60 words (input block size = 62 words,...
UN AS . Follow the instructions that appear on the screen. DMINISTRATOR If you want to find additional software specific to your MVI69E-MBTCP, enter the model number into the ProSoft website search box and press the Enter key. Page 24 of 150 ProSoft Technology, Inc.
MVI69E-MBTCP ♦ CompactLogix Platform Adding the Module to RSLogix Modbus TCP/IP Enhanced Communication Module User Manual Generating the AOI (.L5X File) in ProSoft Configuration Builder The following sections describe the steps required to set up a new configuration project in ProSoft Configuration Builder (PCB), and to export the .L5X file for the project.
Page 26
Adding the Module to RSLogix MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module Your first task is to add the MVI69E-MBTCP module to the project. In the Tree view, right-click D , and then choose C EFAULT...
There are two parameters in the PCB configuration that affect the format of the .L5X file that is exported. Before exporting the .L5X file to the PC/Laptop, check the Block Transfer Size and Slot Number parameters. Expand the MVI69E-MBTCP icon by clicking the [+] symbol beside it. Similarly, expand the icon.
Edit the Slot Number indicating where the module is located in the 1769 bus. Click OK to close the Edit – Module dialog box. The .L5X file is now ready to export to the PC/Laptop. Right-click the MVI69E-MBTCP icon in the project tree and choose E XPORT AOI F Page 28 of 150 ProSoft Technology, Inc.
MVI69E-MBTCP ♦ CompactLogix Platform Adding the Module to RSLogix Modbus TCP/IP Enhanced Communication Module User Manual Save the .L5X file to the PC/Laptop in an easily found location, such as the Windows Desktop. ProSoft Technology, Inc. Page 29 of 150...
Adding the Module to RSLogix MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module Creating a New RSLogix 5000 Project Click the F menu and then choose N Select your CompactLogix controller model. Select R 16 or newer.
MVI69E-MBTCP ♦ CompactLogix Platform Adding the Module to RSLogix Modbus TCP/IP Enhanced Communication Module User Manual Importing the Add-On Instruction Open the application in RSLogix 5000. Expand the T folder, and expand the M folder. ASKS Expand the M folder and then double-click the M...
Page 32
Adding the Module to RSLogix MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module Select the .L5X file that you exported from ProSoft Configuration Builder. See Creating and Exporting the .L5X File (page 27). This opens the Import Configuration dialog box. Click T under to display the controller tags in the Add-On Instruction.
Page 33
When the import is completed, the new rung with the Add-On Instruction is visible as shown in the following image. The procedure has also imported new user-defined data types, data objects and the Add-On instruction to be used in the project with the MVI69E-MBTCP module. ProSoft Technology, Inc.
User Manual Modbus TCP/IP Enhanced Communication Module Adding Multiple Modules in the Rack (Optional) Important: This procedure is for multiple MVI69E-MBTCP modules running in the same CompactLogix rack You can add additional modules of the same type to the rack.
Page 35
Select the MVI69E-MBTCP module in the tree and repeat the above steps to add a second (or more) module in the PCB project. Note: You must give each MVI69E-MBTCP module a unique name. The default name on a duplicate module appends a number to the end such as MVI69E-MBTCP_000, MVI69E- MBTCP_001, etc.
Modbus TCP/IP Enhanced Communication Module 2.6.2 Adding an Additional Module in RSLogix 5000 You can place multiple MVI69E-MBTCP modules in the same rack provided it does not exceed the power distance rating of the CompactLogix rack (see System Requirements (page 10)). Adding an additional module is similar to installing a new module;...
Page 37
MVI69E-MBTCP ♦ CompactLogix Platform Adding the Module to RSLogix Modbus TCP/IP Enhanced Communication Module User Manual Click OK. The new module is now visible. You must also import the Add-On Instruction(AOI) for the new module (see Adding another module in PCB). In the Controller Organizer pane, double- click M to open the ladder for the routine.
Page 38
Adding the Module to RSLogix MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module … Right-click an empty rung in the routine and then choose I MPORT UNGS Select the .L5X file you created and exported for the new module, and click .
Page 39
MVI69E-MBTCP ♦ CompactLogix Platform Adding the Module to RSLogix Modbus TCP/IP Enhanced Communication Module User Manual This opens the Import Configuration dialog box. Click T to show the controller tags in the AddOn Instruction. You must edit the F INAL column of the tags for the second module to make them unique.
Page 40
Adding the Module to RSLogix MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module 10 Associate the I/O connection variables to the correct module in the corresponding slot number. The default values are Local:1:I and Local:1:O. You must edit these values if the card is placed in a slot location other than slot 1 (Local:1:x means the card is located in slot 1).
Page 41
MVI69E-MBTCP ♦ CompactLogix Platform Adding the Module to RSLogix Modbus TCP/IP Enhanced Communication Module User Manual 11 Click OK. The setup procedure is now complete. Save the project. It is ready to download to the CompactLogix processor. ProSoft Technology, Inc.
Page 42
MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module Page 42 of 150 ProSoft Technology, Inc. June 28, 2017...
MBTCP.CONFIG controller tag generated by the previously exported AOI. See Creating and Exporting the .L5X File (page 27). When the MVI69E-MBTCP module boots up, it requests the processor to send the configuration over the backplane in special Configuration Blocks.
ENAME Type the new name for the object and press Enter. 3.1.3 Editing Configuraiton Parameters Click the [+] sign next to the MVI69E-MBTCP icon to expand module information. Click the [+] sign next to any icon to view module information and configuration options.
Page 45
MVI69E-MBTCP ♦ CompactLogix Platform Configuring the MVI69E-MBTCP Using PCB Modbus TCP/IP Enhanced Communication Module User Manual Double-click any icon to open an Edit dialog box with a table. Use this dialog box to build and edit Modbus Client commands. To add a row to the table, click A ProSoft Technology, Inc.
To edit the row, click E . This opens an Edit dialog box. 3.1.4 Printing a Configuration File In the main PCB window, right-click the MVI69E-MBTCP icon and then choose V ONFIGURATION In the View Configuration dialog box, click the F...
Modbus TCP/IP Enhanced Communication Module User Manual Module Configuration Parameters 3.2.1 Module This section contains general module configuration parameters. In the ProSoft Configuration Builder (PCB) tree view, expand the MVI69E-MBTCP icon, then expand , and then double-click the icon. ODULE...
Configuring the MVI69E-MBTCP Using PCB MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module 3.2.2 MBTCP Servers This section applies to configuring the MVI69E-MBTCP Server (Slave) Driver. In the ProSoft Configuration Builder tree view, double-click the MBTCP S ERVERS icon. Parameter...
Page 49
MVI69E-MBTCP ♦ CompactLogix Platform Configuring the MVI69E-MBTCP Using PCB Modbus TCP/IP Enhanced Communication Module User Manual Output Offset 0 to 9998 Specifies the offset address into the internal Modbus database for network requests for Modbus function 1, 5 or 15 commands.
Configuring the MVI69E-MBTCP Using PCB MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module 3.2.3 MBTCP Client x This section defines the general configuration for MBTCP Client x. You can configure up to 20 MBTCP clients, each using the parameters below. In the ProSoft Configuration Builder tree view, double-click the MBTCP C icon.
RTU via TCP is not used. 3.2.4 MBTCP Client x Commands In order to interface the MVI69E-MBTCP module with Modbus server devices, you must create a command list. The commands in the list specify the server device to be addressed, the function to be performed (read or write), the data area in the device to interface with, and the registers in the internal database to be associated with the device data.
Page 52
Configuring the MVI69E-MBTCP Using PCB MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module In the ProSoft Configuration Builder tree view, double-click the MBTCP C LIENT X icon. OMMANDS Parameter Value Description Enable Disable, Enable, Specifies whether the command is executed and under what Conditional, conditions.
Page 53
MVI69E-MBTCP ♦ CompactLogix Platform Configuring the MVI69E-MBTCP Using PCB Modbus TCP/IP Enhanced Communication Module User Manual Register Count 1 to 125 (words) Specifies the number of registers or digital points to be associated with the command. Modbus Function Codes 5 and 6 ignore this 1 to 800 (coils) field as they only apply to a single data point.
Page 54
Configuring the MVI69E-MBTCP Using PCB MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module register and digital point address assignments. Note: The value you enter here does not need to include the "Modbus Prefix" addressing scheme. Also, this value is an offset of the zero-based Modbus addressing scheme.
MVI69E-MBTCP ♦ CompactLogix Platform Configuring the MVI69E-MBTCP Using PCB Modbus TCP/IP Enhanced Communication Module User Manual 3.2.5 Ethernet 1 This section defines the permanent IP address, Subnet Mask, and Gateway of the module. In the ProSoft Configuration Builder tree view, double-click the E 1 icon.
Configuring the MVI69E-MBTCP Using PCB MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module 3.2.6 Static ARP Table This section defines a list of static IP addresses that the module uses when an ARP (Address Resolution Protocol) is required. The module accepts up to 40 static IP/MAC Address data sets.
MVI69E-MBTCP ♦ CompactLogix Platform Configuring the MVI69E-MBTCP Using PCB Modbus TCP/IP Enhanced Communication Module User Manual Downloading the Configuration File to the Processor In the ProSoft Configuration Builder tree view, right-click the module icon and then click D OWNLOAD FROM...
Page 58
Configuring the MVI69E-MBTCP Using PCB MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module Browse to, and then click the CompactLogix processor and click OK. Notice the CIPConnect path has been updated in the Download Configuration File dialog box. Click T...
Page 59
MVI69E-MBTCP ♦ CompactLogix Platform Configuring the MVI69E-MBTCP Using PCB Modbus TCP/IP Enhanced Communication Module User Manual When ready, click D to download the configuration file to the OWNLOAD processor. Following the download process, the module is automatically rebooted. After rebooting, the ladder logic sends the configuration data from the processor to the module.
MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module Uploading the Configuration File from the Processor In the ProSoft Configuration Builder tree view, right-click the MVI69E-MBTCP icon and choose U PLOAD FROM EVICE TO Page 60 of 150 ProSoft Technology, Inc.
Page 61
MVI69E-MBTCP ♦ CompactLogix Platform Configuring the MVI69E-MBTCP Using PCB Modbus TCP/IP Enhanced Communication Module User Manual In the Upload Configuration File dialog box, the CIPConnect path should already be constructed if you have previously downloaded the configuration file from the same PC. If not, click RSW , browse to, and then select the CompactLogix Processor, and click OK.
Page 62
Configuring the MVI69E-MBTCP Using PCB MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module Click T to verify the path is active and can successfully ONNECTION connect to the processor. When ready, click U . When upload is complete, click C...
The following topics describe several concepts that are important for understanding the operation of the MVI69E-MBTCP module. This is the order of operations on power-up: The module begins the following logical functions:...
The following illustration shows the data transfer method used to move data between the CompactLogix processor, the MVI69E-MBTCP module and the Modbus Network. All data transferred between the module and the processor over the backplane is through the input and output images.
MVI69E-MBTCP ♦ CompactLogix Platform MVI69E-MBTCP Backplane Data Exchange Modbus TCP/IP Enhanced Communication Module User Manual Normal Data Transfer Normal data transfer includes the paging of the user data found in the module’s internal database (Registers 0 to 9999) and the status data. These data are transferred through read (input image) and write (output image) blocks.
MVI69E-MBTCP Backplane Data Exchange MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module 4.3.3 Read and Write Block Transfer Sequences The Read Block ID is an index value that determines the location where the data is placed in the processor controller tag array of module read data. The number of data words per transfer depends on the configured Block Transfer Size parameter in the configuration file (possible values are 60, 120, or 240).
Page 67
MVI69E-MBTCP ♦ CompactLogix Platform MVI69E-MBTCP Backplane Data Exchange Modbus TCP/IP Enhanced Communication Module User Manual If Block Transfer Size = 60 ProSoft Technology, Inc. Page 67 of 150 June 28, 2017...
Page 68
MVI69E-MBTCP Backplane Data Exchange MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module If Block Transfer Size = 120 Page 68 of 150 ProSoft Technology, Inc. June 28, 2017...
Page 69
MVI69E-MBTCP ♦ CompactLogix Platform MVI69E-MBTCP Backplane Data Exchange Modbus TCP/IP Enhanced Communication Module User Manual If Block Transfer Size = 240 ProSoft Technology, Inc. Page 69 of 150 June 28, 2017...
(master), server (slave), or both simultaneously. 4.4.1 Server Mode In Server driver mode, the MVI69E-MBTCP module responds to read and write commands issued by a client on the Modbus network. The following diagram shows the data flow for normal Server mode.
Page 71
MVI69E-MBTCP ♦ CompactLogix Platform MVI69E-MBTCP Backplane Data Exchange Modbus TCP/IP Enhanced Communication Module User Manual In Server Pass-Through mode, write commands from the client are handled differently than they are in Normal mode. In Server Pass-Through mode, all write requests are passed directly to the processor and data is not written directly into the module’s database.
Modbus TCP/IP Enhanced Communication Module 4.4.2 Master Mode In Client mode, the MVI69E-MBTCP module issues read or write commands to server devices on the Modbus network. You configure these commands in ProSoft Configuration Builder in the Client Command List. This list is transferred to the module when the module receives its configuration from the processor.
Page 73
MVI69E-MBTCP ♦ CompactLogix Platform MVI69E-MBTCP Backplane Data Exchange Modbus TCP/IP Enhanced Communication Module User Manual Important: Take care when constructing each command in the list to ensure predictable operation of the module. If two commands write to the same internal database address of the module, the results are invalid.
Page 74
MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module Page 74 of 150 ProSoft Technology, Inc. June 28, 2017...
Instruction works without needing any modification. Controller Tags Data related to the MVI69E-MBTCP is stored in the ladder logic in variables called controller tags. Individual controller tags can be grouped into collections of controller tags called controller tag structures. A controller tag structure can contain any combination of: ...
Using Controller Tags MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module 5.1.1 MVI69E-MBTCP Controller Tags The main controller tag structure, MBTCP, is broken down into five lower-level controller tag structures. The five lower-level controller tag structures contain other controller tags and controller tag structures.
Modbus TCP/IP Enhanced Communication Module User Manual 5.2.1 MVI69E-MBTCP User-Defined Data Types Twenty-two different UDTs are defined for the MVI69E-MBTCP Add-On Instruction. The main UDT, MBTCPMODULEDEF, contains all the data types for the module and was used to create the main controller tag structure, MBTCP. There are five UDTs one level below MBTCPMODULEDEF.
Page 78
Using Controller Tags MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module For example, if you expand MBTCP.DATA, you see that it contains two UDTs, ReadData and WriteData. Both of these are 600-element integer arrays by default. Notice that these UDTs are the data types used to declare the MBTCP.DATA.ReadData and MBTCP.DATA.WriteData controller tag arrays.
MVI69E-MBTCP ♦ CompactLogix Platform Using Controller Tags Modbus TCP/IP Enhanced Communication Module User Manual MBTCP Controller Tag Overview You use controller tags to: View the read and write being transferred between the module and the processor. View status data for the module.
Using Controller Tags MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module 5.3.2 MBTCP.DATA This array contains the Read Data and Write Data arrays for processor-to- module communication. Tag Name Description MBTCP.DATA.ReadData Data area copied from the module to the processor. This array stores the Modbus data coming into the module from the Modbus network.
Page 81
MVI69E-MBTCP ♦ CompactLogix Platform Using Controller Tags Modbus TCP/IP Enhanced Communication Module User Manual MBTCP.CONTROL.EventCommand_DBData This array allows the processor to dynamically build Modbus commands with data associated to the module’s database. This feature is meant for periodic execution such as resetting clock and zeroing-out counters.
Page 82
Using Controller Tags MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module MBTCP.CONTROL.EventCommand_PLCData This array allows the processor to dynamically build Modbus commands with PLC processor data. This feature is meant for periodic execution such as resetting the clock and zeroing-out counters.
Page 83
MVI69E-MBTCP ♦ CompactLogix Platform Using Controller Tags Modbus TCP/IP Enhanced Communication Module User Manual MBTCP.CONTROL.EventSequenceCommand This tag array contains the values needed to build one Modbus TCP/IP command, have it sent to a specific client on the module, and control the processing of the returned response block.
Page 84
Using Controller Tags MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module MBTCP.CONTROL.Time This array allows the processor to get or set module time. Tag Name Range Description MBTCP.CONTROL.Time.SetTime 0 or 1 Sends the PLC time to the module 0 = Disable, 1 = Enable MBTCP.CONTROL.Time.GetTime...
Page 85
MVI69E-MBTCP ♦ CompactLogix Platform Using Controller Tags Modbus TCP/IP Enhanced Communication Module User Manual MBTCP.CONTROL.ResetStatus This array resets the module along with client and server status tags. Tag Name Range Description MBTCP.CONTROL.ResetStatus. 0 or 1 Toggle reset control Trigger 0 = Disable, 1 = Enable MBTCP.CONTROL.ResetStatus.
Using Controller Tags MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module MBTCP.CONTROL.GetEventDataStatus This tag triggers the request of the event status. Tag Name Range Description MBTCP.CONTROL. 0 or 1 Triggers event status read GetEventDataStatus 0 = Disable, 1 = Enable MBTCP.CONTROL.
Page 87
MVI69E-MBTCP ♦ CompactLogix Platform Using Controller Tags Modbus TCP/IP Enhanced Communication Module User Manual MBTCP.STATUS.ClientStatus This array contains the status of a specific MBTCP client (0 to 19). Tag Name Description MBTCP.STATUS.ClientStatus. Initiates request for Client Status block from module when set to 1 Request MBTCP.STATUS.ClientStatus.
Page 88
Using Controller Tags MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module MBTCP.STATUS.EventSeqCounts This array indicates the number of commands waiting in the command queue. Tag Name Description MBTCP.STATUS.EventSeqCounts. Event command quantity waiting in queue. There are two ClientCmdCount_EventSeqMessage bytes of status data per client.
Page 89
MVI69E-MBTCP ♦ CompactLogix Platform Using Controller Tags Modbus TCP/IP Enhanced Communication Module User Manual 0 = Disable, 1 = Enable MBTCP.STATUS.GeneralStatus. Each bit in each of the 19 words is used to enable/disable the Client1to19CmdExecutionWord commands for clients 1 to 19.
Using Controller Tags MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module 5.3.5 MBTCP.UTIL The array is used for internal ladder processing. It should not be modified. Tag Name Description MBTCP.UTIL.ReadDataSizeGet Holds Read Data array size MBTCP.UTIL.WriteDataSizeGet Holds Write Data array size Number of Read Data blocks –...
Page 91
MVI69E-MBTCP ♦ CompactLogix Platform Using Controller Tags Modbus TCP/IP Enhanced Communication Module User Manual MBTCP.UTIL. Event Sequence Command Block ID EventSeqCmdBlockID MBTCP.UTIL. Event Sequence Command Write Event Block ID EventSeqCmdWriteEventBlockID MBTCP.UTIL.PassThrough. Holds variables used for processing Pass-Through messages MBControlx [ ] Array MBTCP.UTIL.
Page 92
MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module Page 92 of 150 ProSoft Technology, Inc. June 28, 2017...
MVI69E-MBTCP ♦ CompactLogix Platform Diagnostics and Troubleshooting Modbus TCP/IP Enhanced Communication Module User Manual Diagnostics and Troubleshooting In This Chapter Ethernet LED Indicators ................ 93 LED Status Indicators ................94 Connecting the PC to the Module's Ethernet Port ......... 96 ...
During module configuration, the OK LED is red and the BP LED is on. If the BP ACT and OK LEDs blink at a rate of every one-second, this indicates a serious problem with the module. Call ProSoft Technology Technical Support to arrange for repairs.
Processor I/O LED This indicates a problem with backplane communications. A problem flashes could exist between the processor and any installed I/O module, not just the MVI69E-MBTCP. Verify that all modules in the rack are correctly configured. Module Errors Problem description...
In the tree view in ProSoft Configuration Builder (PCB), select the MVI69E- MBTCP module. (For instructions on opening and using a project in PCB, please refer to the chapter Configuring the MVI69E-MBTCP Using PCB (page 42). Page 96 of 150 ProSoft Technology, Inc.
Page 97
MVI69E-MBTCP ♦ CompactLogix Platform Diagnostics and Troubleshooting Modbus TCP/IP Enhanced Communication Module User Manual Right-click the module icon in the tree and choose D IAGNOSTICS In the Diagnostics window, click the S button. ONNECTION In the Connection Setup dialog box, click B...
In the tree view in ProSoft Configuration Builder (PCB), select the MVI69E- MBTCP module. For instructions on opening and using a project in PCB, please refer to the chapter Configuring the MVI69E-MBTCP Using PCB (page 42). Page 98 of 150 ProSoft Technology, Inc.
Page 99
MVI69E-MBTCP ♦ CompactLogix Platform Diagnostics and Troubleshooting Modbus TCP/IP Enhanced Communication Module User Manual Right-click the module and choose D IAGNOSTICS After the Diagnostics window opens, click the S button to ETUP ONNECTION browse for the module’s IP address. In the Ethernet field of the Connection Setup dialog box, enter the current IP address, whether it is temporary or permanent.
Diagnostics and Troubleshooting MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module If the T is successful, click C . The Diagnostics ONNECTION ONNECT Window is now accessible. 6.4.1 Diagnostics Menu The D menu in the Diagnostics window in ProSoft Configuration IAGNOSTICS Builder is available through the Ethernet configuration port.
MVI69E-MBTCP ♦ CompactLogix Platform Diagnostics and Troubleshooting Modbus TCP/IP Enhanced Communication Module User Manual 6.4.2 Monitoring General Information In the Diagnostics window in ProSoft Configuration Builder, click MODULE and then click V to view module version information. ERSION 6.4.3 Monitoring Backplane Information...
Diagnostics and Troubleshooting MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module 6.4.4 Modbus Server Driver Information In the Diagnostics window in ProSoft Configuration Builder, click S ERVERS view the server information. The menu has two sub-menus: ...
6.4.5 Monitoring Data Values in the Module’s Database In the Diagnostics window in ProSoft Configuration Builder, click DATABASE and then click D to view the contents of the MVI69E-MBTCP internal ECIMAL database. You can view data values in ASCII, Hexadecimal, and Float format.
Diagnostics and Troubleshooting MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module Communication Error Codes Note: If an error code is reported that is not listed below, check with the documentation of the Modbus device(s) on the module's application ports. Modbus devices can produce device-specific error codes.
Note: If an error code is reported that is not listed above, check with the documentation of the end device. Device-specific error codes can be produced by the end device. Connecting to the MVI69E-MBTCP Webpage The module’s internal web server provides access to module version and status information, as well as the ability to set the date and time, reboot the module, and download firmware upgrade to the module.
Page 106
Diagnostics and Troubleshooting MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module ’ Right-click the module icon and choose V to launch ODULE EBPAGE your default browser and display the module’s webpage. Page 106 of 150 ProSoft Technology, Inc.
Ethernet Port Connection ..............145 Product Specifications ® ® The MVI69E-MBTCP allows Rockwell Automation CompactLogix processors to interface easily with other Modbus TCP/IP compatible devices. The module acts as an input/output communications module between the Modbus TCP/IP network and the CompactLogix backplane. The data transfer from the CompactLogix processor is asynchronous from the actions on the Modbus TCP/IP network.
Reference MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module 7.1.1 General Specifications - Modbus Client/Server Communication Supports Modbus MBAP and encapsulated (Server) messaging Parameters 10/100 Base-T Ethernet-compatible interface Modbus Modes Client driver supports up to twenty connections for active reading...
Nevertheless, the efficiency, scalability, and low cost of a Modbus TCP/IP network make this an ideal solution for industrial applications. The MVI69E-MBTCP module acts as an input/output module between devices on a Modbus TCP/IP network and the Rockwell Automation backplane and processor.
Modbus TCP/IP Enhanced Communication Module 7.2.2 Modbus Server The MVI69E-MBTCP Modbus Server driver permits a remote client to interact with all data contained in the module. This data can be derived from other Modbus server devices on the network, through a client port, or from the CompactLogix processor.
MVI69E-MBTCP ♦ CompactLogix Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual 7.2.4 Read Coil Status (Function Code 01) Query This function allows you to obtain the ON/OFF status of logic coils (Modbus 0x range) used to control discrete outputs from the addressed server only.
Reference MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module The status of coils 20 to 27 is shown as CD(HEX) = 1100 1101 (Binary). Reading from left to right, this shows that coils 27, 26, 23, 22, and 20 are all on. The other Data Coil Status bytes are decoded similarly.
MVI69E-MBTCP ♦ CompactLogix Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual Because the server interface device is serviced at the end of a controller's scan, the data reflect input status at the end of the scan. Some servers limit the quantity of inputs provided each scan;...
Reference MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module Response The addressed server responds with its address and the function code, followed by the information field. The information field contains 1 byte describing the quantity of data bytes to be returned. The contents of the registers requested (DATA) are two bytes each, with the binary content right justified within each pair of characters.
MVI69E-MBTCP ♦ CompactLogix Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual Response The addressed server responds with its address and the function code followed by the information field. The information field contains 1 byte describing the quantity of data bytes to be returned. The contents of the registers requested (DATA) are 2 bytes each, with the binary content right justified within each pair of characters.
Reference MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module Response The normal response to the Command Request is to re-transmit the message as received after the coil state has been altered. Node Function Data Coil Bit Data Coil Bit...
Sub-function Codes Supported Only Sub-function 00 is supported by the MVI69E-MBTCP module. 00 Return Query Data The data passed in the request data field is to be returned (looped back) in the response.
Page 118
Reference MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module Example and State Diagram Here is an example of a request to remote device to Return Query Data. This uses a sub-function code of zero (00 00 hex in the two-byte field). The data to be returned is sent in the two-byte data field (A5 37 hex).
MVI69E-MBTCP ♦ CompactLogix Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual 7.2.11 Force Multiple Coils (Function Code 15) Query This function forces each coil (Modbus 0x range) in a consecutive block of coils to a desired ON or OFF state. Any coil that exists within the controller can be forced to either state (ON or OFF).
Reference MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module Writing to coils with Modbus function 15 is accomplished regardless of whether the addressed coils are disabled or not. Coils that are not programmed in the controller logic program are not automatically cleared upon power up.
MVI69E-MBTCP ♦ CompactLogix Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual Floating-Point Support You can easily move floating point data between the MBTCP module and other devices as long as the device supports IEEE 754 Floating Point format. This IEEE format is a 32-bit single-precision floating-point format.
Reference MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module 7.3.1 ENRON Floating Point Support Many manufacturers have implemented special support in their drivers for what is commonly called the Enron version of the Modbus protocol. In this implementation, addresses greater than 7000 are presumed to contain floating- point values.
Page 123
MVI69E-MBTCP ♦ CompactLogix Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual Example #1: Client is issuing Modbus command with FC 16 (with Float Flag: Yes) to transfer Float data to server. (Float specific module parameters) Float Flag: "Y" tells the client to consider the data values that need to be sent to the server as floating point data where each data value is composed of 2 words (4 bytes or 32 bits).
Page 124
Reference MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module In the above example, the client's Modbus command to transmit inside the Modbus packet is as follows. Server Function Address in Reg Count Byte Count Data Address Code...
Page 125
MVI69E-MBTCP ♦ CompactLogix Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual In the above example, the client's Modbus command to transmit inside the Modbus packet is as follows. Server Function Address in Byte Data Address Code Device Count Count 7100 85.37...
Page 126
Reference MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module In the above example, the client's Modbus command to transmit inside the Modbus packet is as follows. Server Function Code Address in Device Reg Count Address 6100 17 D4...
Function Blocks Data contained in this database is paged through the input and output images by coordination of the CompactLogix ladder logic and the MVI69E-MBTCP module's program. Each block transferred from the module to the processor or from the processor to the module contains a block identification code that describes the content of the block.
Reference MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module 7.4.1 Event Command Blocks (2000 to 2019) Event Command blocks send Modbus commands directly from the ladder logic to the specified MBTCP Client x. The Event Command is added to the high-priority queue and interrupts normal polling so this special command can be sent as soon as possible.
Block 3000 or 3019: Request from Processor to Module Offset Description Block ID 3000 to 3019 identification code indicates this block requests the status from a specific MVI69E-MBTCP client. The last two digits indicate which client to use. Example: 3015 uses client 15 1 to (n-1) Spare Where n = 60, 120, or 240 depending on the Block Transfer Size parameter.
Offset Description Block ID 4000 to 4019 indicates this block triggers the event sequence of the MVI69E-MBTCP client. The last two digits indicate which client to use. Example: 4015 uses client 15 1 to 4 IP address for the intended server for the message. Each digit (0 to 255) of the IP...
Offset Description Block ID 4100 to 4119 indicates this block triggers the event sequence command error status request of a specific MVI69E-MBTCP client. The last two digits indicate which Client client to use. Example: 4115 uses client 15 1 to (n-1) Spare Where n = 60, 120, or 240 depending on the Block Transfer Size parameter.
Reference MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module 7.4.5 Get Queue and Event Sequence Block Counts Block (4200) This block requests the command queue count and the number of pending event sequence commands for all module clients.
MVI69E-MBTCP ♦ CompactLogix Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual Where n = 60, 120, or 240 depending on the Block Transfer Size parameter. Block 5001 to 5016: Response from Module to Processor Offset Description Command queue block identification code of 5001 to 5016...
Reference MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module Block 8000: Response from Module to Processor Offset Description Block ID 8000 for event command with data request The next read request block identification code Error Code for request:...
MVI69E-MBTCP ♦ CompactLogix Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual 7.4.9 Get General Module Status Data Block (9250) This block requests general module status. Block 9250: Request from Processor to Module Offset Description Block ID 9250 to request the general module status response block...
Reference MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module Offset Description Encapsulated Modbus TCP/IP error sent: this counter increments each time the server sends an error to the remote Modbus TCP/IP client. Encapsulated Modbus TCP/IP error received: this counter increments each time an error is received from a remote Modbus TCP/IP client.
MVI69E-MBTCP ♦ CompactLogix Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual 7.4.11 Get Driver and Command Active Bits Block (9501) This block requests the active state of MBTCP Driver and Client commands. Block 9501: Request from Processor to Module...
Reference MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module 7.4.12 Pass-Through Formatted Block for Functions 6 and 16 with Word Data Block (9956) If the server port on the module is configured for formatted Pass-Through mode, the module sends input image blocks with identification codes of 9956, 9957, 9958 or 9959 to the processor for each write command received.
MVI69E-MBTCP ♦ CompactLogix Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual 7.4.13 Pass-Through Formatted Block for Functions 6 and 16 with Float Data Block (9957) Block 9957: Request from Module to Processor Offset Description Read Block ID 9957 Write Block ID 9957...
Reference MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module The ladder logic is responsible for parsing and copying the received message and performing the proper control operation as expected by the client device. The processor must then respond to the Pass-Through control block with an output image write block with the following format.
MVI69E-MBTCP ♦ CompactLogix Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual Block 9959: Response from Processor to Module Offset Description Write Block ID 9959 1 to n Spare 7.4.16 Pass-Through Formatted Block for Function 23 (9961) Block 9961: Request from Module to Processor...
Reference MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module The ladder logic is responsible for parsing and copying the received message and performing the proper control operation as expected by the client device. The processor must then respond to the Pass-Through control block with an output image write block with the following format.
MVI69E-MBTCP ♦ CompactLogix Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual 7.4.19 Pass Module Time to Processor Block (9973) This block uses the time information of the module to set the processor time. Block 9973: Request from Processor to Module...
Reference MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module Block 9997: Response from Module to Processor Offset Description Block ID 9997 Write Block ID Spare 7.4.21 Warm-boot Control Block (9998) If the CompactLogix sends a block number 9998, the module performs a warm- boot operation.
MVI69E-MBTCP ♦ CompactLogix Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual Ethernet Port Connection 7.5.1 Ethernet Cable Specifications The recommended cable is Category 5 or better. A Category 5 cable has four twisted pairs of wires, which are color-coded and cannot be swapped. The module uses only two of the four pairs.
Page 146
MVI69E-MBTCP ♦ CompactLogix Platform User Manual Modbus TCP/IP Enhanced Communication Module Ethernet Performance Ethernet performance in the MVI69E-MBTCP module can be affected in the following way: Accessing the web interface (refreshing the page, downloading files, and so on) may affect performance ...
Contacting Technical Support ............. 147 Warranty Information ................148 Contacting Technical Support ProSoft Technology, Inc. is committed to providing the most efficient and effective support possible. Before calling, please gather the following information to assist in expediting this process: Product Version Number...
(location in Sao Paulo) E-mail: brasil@prosoft-technology.com Languages spoken include: Portuguese, English Warranty Information For complete details regarding ProSoft Technology’s TERMS & CONDITIONS OF SALE, WARRANTY, SUPPORT, SERVICE AND RETURN MATERIAL AUTHORIZATION INSTRUCTIONS please see the documents at: www.prosoft-technology/legal. Documentation is subject to change without notice.
Configuring the Floating Point Data Transfer • 122 Get Event with Data Status Block (8100) • 134 Configuring the MVI69E-MBTCP Using PCB • 43, 96, Get General Module Status Data Block (9250) • 135 Get Queue and Event Sequence Block Counts Block Connecting the PC to the Module's Ethernet Port •...
Page 150
Monitoring Backplane Information • 101 System Requirements • 10, 36 Monitoring Data Values in the Module’s Database • Monitoring General Information • 101 MVI69E-MBTCP Backplane Data Exchange • 63 Troubleshooting • 95 MVI69E-MBTCP Controller Tags • 76 MVI69E-MBTCP User-Defined Data Types • 77 Uploading the Configuration File from the Processor •...
Need help?
Do you have a question about the MVI69E-MBTCP and is the answer not in the manual?
Questions and answers