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 at: www.prosoft-technology.com...
MVI69E-MBTCP ♦ CompactLogix™ Platform Contents Modbus TCP/IP Enhanced Communication Module User Manual 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.
Creating a Module in the Project Using a Generic 1769 Module Profile ..18 Installing ProSoft Configuration Builder ............21 Generating the AOI (.L5X File) in ProSoft Configuration Builder ....22 2.3.1 Setting Up the Project in PCB ................22 2.3.2...
Page 5
Optional Add-On Instruction ................98 6.4.1 Setting Up the Optional AOI ................100 6.4.2 Synchronizing the IP Settings from the MVI69E-MBTCP to the Processor .. 102 6.4.3 Synchronizing the IP Settings from the Processor to the MVI69E-MBTCP .. 103 6.4.4 Reading the Date/Time from the MVI69E-MBTCP to the Processor ....
Page 6
Module Communication Error Codes ............118 7.7.3 Command List Entry Errors ................118 7.7.4 MBTCP Client-Specific Errors ............... 118 Connecting to the MVI69E-MBTCP Webpage ..........119 Reference Product Specifications ................... 120 8.1.1 General Specifications - Modbus Client/Server ..........120 8.1.2 Hardware Specifications ................
Page 7
MVI69E-MBTCP ♦ CompactLogix™ Platform Contents Modbus TCP/IP Enhanced Communication Module User Manual Support, Service & Warranty Contacting Technical Support ................ 160 Warranty Information ..................160 ProSoft Technology, Inc. Page 7 of 160...
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.
Setup pins are not connected, and the module’s firmware cannot be overwritten. The module is shipped with the Setup jumper OFF. Do not jumper the Setup pins together unless you are directed to do so by ProSoft Technical Support (or you want to update the module firmware).
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 11
MVI69E-MBTCP ♦ CompactLogix™ Platform Start Here Modbus TCP/IP Enhanced Communication Module User Manual Push the module’s bus lever back slightly to clear the positioning tab and move it firmly to the left until it clicks. Ensure that it is locked firmly in place.
Page 12
MVI69E-MBTCP ♦ CompactLogix™ Platform Start Here Modbus TCP/IP Enhanced Communication Module User Manual Press the DIN-rail mounting area of the controller against the DIN-rail. The latches momentarily open and lock into place. ProSoft Technology, Inc. Page 12 of 160...
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.
The .L5X file contains the Add-On Instruction, user-defined data types, controller tags and ladder logic required to configure the MVI69E-MBTCP module. Creating the Module in an Studio 5000 Project In an Studio 5000 project, there are two ways you can add the MVI69E-MBTCP module to the project. ...
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 files from the zip archive. Make sure you have shut down Studio 5000 and RSLinx before you install the Add-On Profile (AOP).
Page 16
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 Studio 5000. You do not INISH need to reboot the PC. Using an Add-On Profile In Studio 5000, expand the I/O C folder in the Project tree.
Page 17
In the Module Type Vendor Filters area, uncheck all boxes except the P 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 19
Enter a description for the module. Example: ProSoft Description communication module for Serial Modbus communications. Select D -INT Comm Format Enter the slot number in the rack where the MVI69E-MBTCP Slot module is installed. Input Assembly Instance 62 / 122 / 242 Input Size...
Page 20
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, output block size = 61...
For example, PCB_4.3.4.5.0238. Open a browser window and navigate to www.prosoft-technology.com. Perform a search for 'pcb' in the Search bar. Click on the ProSoft Configuration Builder search result. On the PCB page, click the download link for ProSoft Configuration Builder, and save the file to your Windows desktop.
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. 2.3.1 Setting Up the Project in PCB Start P (PCB).
In the Product Line Filter area of the dialog box, click MVI69. In the Select Module Type dropdown list, click MVI69E-MBTCP, and then click OK to save your settings and return to the ProSoft Configuration Builder window. The MVI69E-MBTCP icon is now visible in the tree view.
Page 24
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 ProSoft Technology, Inc.
Page 25
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 25 of 160...
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 Studio 5000. Expand the T folder, and expand the M folder. ASKS Expand the M folder and then double-click the M...
Page 27
Adding the Module to RSLogix Modbus TCP/IP Enhanced Communication Module User Manual Select the .L5X file that you exported from ProSoft Configuration Builder. See Creating and Exporting the .L5X File (page 23). This opens the Import Configuration dialog box. Click T...
Page 28
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. Page 28 of 160...
User Manual 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. Add a new MVI69E-MBTCP module to the ProSoft Configuration Builder (PCB) project.
Page 30
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.
User Manual 2.5.2 Adding an Additional Module in Studio 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 8)). Adding an additional module is similar to installing a new module; however, the name of the module must be unique.
Page 32
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 to open the ladder for the routine.
Page 33
MVI69E-MBTCP ♦ CompactLogix™ Platform Adding the Module to RSLogix Modbus TCP/IP Enhanced Communication Module User Manual Select the .L5X file you created and exported for the new module, and click I MPORT Recall that the new .L5X file has a unique filename that is specific to the new module.
Page 34
MVI69E-MBTCP ♦ CompactLogix™ Platform Adding the Module to RSLogix Modbus TCP/IP Enhanced Communication Module User Manual 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).
User Manual Configuring the MVI69E-MBTCP Using PCB ProSoft Configuration Builder (PCB) provides a quick and easy way to manage module configuration files customized to meet your application needs. You build and edit the module’s configuration in ProSoft Configuration Builder. You use PCB to download the configuration file to the CompactLogix processor, where it is stored in the MBTCP.CONFIG controller tag generated by the previously exported AOI.
Configuring the MVI69E-MBTCP Using PCB Modbus TCP/IP Enhanced Communication Module User Manual 3.1.3 Editing Configuration 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 37
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 ODULE...
MVI69E-MBTCP ♦ CompactLogix™ Platform Configuring the MVI69E-MBTCP Using PCB Modbus TCP/IP Enhanced Communication Module User Manual 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 icon. ERVERS Value...
Page 41
MVI69E-MBTCP ♦ CompactLogix™ Platform Configuring the MVI69E-MBTCP Using PCB Modbus TCP/IP Enhanced Communication Module User Manual 0 to 9999 Specifies the offset address into the internal Modbus database Bit Input Offset for network requests for Modbus function 2 commands. For example, if you set the value to 150, an address request of 0 returns the value at register 150 in the database.
User Manual 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.
Page 43
MVI69E-MBTCP ♦ CompactLogix™ Platform Configuring the MVI69E-MBTCP Using PCB Modbus TCP/IP Enhanced Communication Module User Manual 0 to 9998 Specifies the first register of floating-point data. All requests with Float Start register values greater-than or equal to this value are considered floating-point data requests.
User Manual 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 45
(bit-level) For Modbus Function Codes 1, 2, 5, or 15, the allowable range is 0 to 159,999. Note: This bit address range is available with ProSoft Configuration Builder (PCB) v4.6 or later. Previous versions have a range of 0 to 65535.
Page 46
MVI69E-MBTCP ♦ CompactLogix™ Platform Configuring the MVI69E-MBTCP Using PCB Modbus TCP/IP Enhanced Communication Module User Manual If a server implementation supports another service port, enter the value here. Service Port 2000 is common for encapsulated format messages. 0 to 255 Mainly used for Modbus TCP/IP to serial conversion.
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. THERNET Description Parameter Unique IP address assigned to the module...
Use the Static ARP table to reduce the amount of network traffic by specifying IP addresses and their associated MAC (hardware) addresses that the MVI69E-MBTCP module communicates with regularly. In ProSoft Configuration Builder tree view, double-click the STATIC ARP TABLE icon. Description Value Parameter xxx.xxx.xxx.xxx...
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 EVICE In the Download Configuration File dialog box, click RSW ProSoft Technology, Inc.
Page 50
MVI69E-MBTCP ♦ CompactLogix™ Platform Configuring the MVI69E-MBTCP Using PCB Modbus TCP/IP Enhanced Communication Module User Manual Browse to, and then click the CompactLogix processor and click OK. Note: DF1 serial download via CIPConnect is not supported. Only use Ethernet or EtherNet/IP drivers via RSWho.
Page 51
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 processor. OWNLOAD Following the download process, the module is automatically rebooted. After rebooting, the ladder logic sends the configuration data from the processor to the module.
Configuring the MVI69E-MBTCP Using PCB Modbus TCP/IP Enhanced Communication Module User Manual 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 ProSoft Technology, Inc.
Page 53
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.
Page 54
MVI69E-MBTCP ♦ CompactLogix™ Platform Configuring the MVI69E-MBTCP Using PCB Modbus TCP/IP Enhanced Communication Module User Manual Click T to verify the path is active and can successfully connect to ONNECTION the processor. When ready, click U . When upload is complete, click C...
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: ...
MVI69E-MBTCP ♦ CompactLogix™ Platform Using Controller Tags Modbus TCP/IP Enhanced Communication Module User Manual 4.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.
UDTs are organized in a multiple-level tree structure. 4.2.1 MVI69E-MBTCP User-Defined Data Types Multiple 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 58
MVI69E-MBTCP ♦ CompactLogix™ Platform Using Controller Tags Modbus TCP/IP Enhanced Communication Module User Manual 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.
The following sections describe each of these controller tag structures in more detail. 4.3.1 MBTCP.CONFIG When ProSoft Configuration Builder (PCB) downloads the configuration file from the PC to the processor, the processor stores the configuration file data in the MBTCP.CONFIG.FileData array. Its CRC is also included in this array.
MVI69E-MBTCP ♦ CompactLogix™ Platform Using Controller Tags Modbus TCP/IP Enhanced Communication Module User Manual 4.3.2 MBTCP.DATA This array contains the Read Data and Write Data arrays for processor-to-module communication. Description Tag Name Data area copied from the module to the processor. This array MBTCP.DATA.ReadData...
Page 61
For Modbus Function Codes 1, 2, 5, or 15, the allowable range is 0 to 159,999. Note: This bit (bit-level) address range is available with ProSoft Configuration Builder (PCB) v4.6.0.0 or later. Previous versions have a range of 0 to 65535.
Page 62
MVI69E-MBTCP ♦ CompactLogix™ Platform Using Controller Tags Modbus TCP/IP Enhanced Communication Module User Manual 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 63
For Modbus Function Codes 1, 2, 5, or 15, the (bit-level) allowable range is 0 to 159,999. Note: This bit address range is available with ProSoft Configuration Builder (PCB) v4.6.0.0 or later. Previous versions have a range of 0 to 65535.
Page 64
MVI69E-MBTCP ♦ CompactLogix™ Platform Using Controller Tags Modbus TCP/IP Enhanced Communication Module User Manual MBTCP.CONTROL.Time This array allows the processor to get or set module time. Description Tag Name Range 0 or 1 Sends the PLC time to the module MBTCP.CONTROL.Time.SetTime...
Page 65
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. Description Tag Name Range 0 or 1 Toggle reset control MBTCP.CONTROL.ResetStatus. 0 = Disable, 1 = Enable...
Page 66
MVI69E-MBTCP ♦ CompactLogix™ Platform Using Controller Tags Modbus TCP/IP Enhanced Communication Module User Manual MBTCP.CONTROL.GetEventDataStatus This tag triggers the request of the event status. Description Tag Name Range 0 or 1 Triggers event status read MBTCP.CONTROL. 0 = Disable, 1 = Enable GetEventDataStatus MBTCP.CONTROL.
MVI69E-MBTCP ♦ CompactLogix™ Platform Using Controller Tags Modbus TCP/IP Enhanced Communication Module User Manual 4.3.4 MBTCP.STATUS This array contains the status information of the module. MBTCP.STATUS.Block This array contains block status. Description Tag Name Total number of read blocks transferred from the module to the MBTCP.STATUS.Block.Read...
Page 68
MVI69E-MBTCP ♦ CompactLogix™ Platform Using Controller Tags Modbus TCP/IP Enhanced Communication Module User Manual MBTCP.STATUS.EventSeqStatus This array contains the status of the event command queue. Description Tag Name Specifies Client (0 to19) to request event status data from MBTCP.STATUS.EventSeqStatus. ClientID Number of event sequence messages in block (0 to 15) MBTCP.STATUS.EventSeqStatus.
Page 69
MVI69E-MBTCP ♦ CompactLogix™ Platform Using Controller Tags Modbus TCP/IP Enhanced Communication Module User Manual MBTCP.STATUS.GeneralStatus This array contains the general status of the module including firmware revision and general communication status. Description Tag Name Contains the next write block ID number MBTCP.STATUS.GeneralStatus.
Page 70
MVI69E-MBTCP ♦ CompactLogix™ Platform Using Controller Tags Modbus TCP/IP Enhanced Communication Module User Manual MBTCP.STATUS.GetEventDataStatus This array contains the status of the event command last executed. Description Tag Name Number of clients contained in block (0 to 19) MBTCP.STATUS.GetEventData Status.ClientRecordsCount Two words per client.
MVI69E-MBTCP ♦ CompactLogix™ Platform Using Controller Tags Modbus TCP/IP Enhanced Communication Module User Manual 4.3.5 MBTCP.UTIL The array is used for internal ladder processing. It should not be modified. Description Tag Name Holds Read Data array size MBTCP.UTIL.ReadDataSizeGet Holds Write Data array size MBTCP.UTIL.WriteDataSizeGet...
Page 72
MVI69E-MBTCP ♦ CompactLogix™ Platform Using Controller Tags Modbus TCP/IP Enhanced Communication Module User Manual Client and Server Control Block ID MBTCP.UTIL. ClientServerControlBlockID Client Status Pending – Yes (0) or No (1) MBTCP.UTIL.ClientStatusPending Client Status Write Block ID MBTCP.UTIL. ClientStatusWriteBlockID Event Sequence Status Pending – Yes (0) or No (1) MBTCP.UTIL.
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:...
Page 74
User Manual 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. Ladder logic in the CompactLogix processor interfaces the input and output image data with data defined in the Controller Tags.
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 ♦ CompactLogix™ Platform MVI69E-MBTCP Backplane Data Exchange Modbus TCP/IP Enhanced Communication Module User Manual 5.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 77
MVI69E-MBTCP ♦ CompactLogix™ Platform MVI69E-MBTCP Backplane Data Exchange Modbus TCP/IP Enhanced Communication Module User Manual If Block Transfer Size = 60 If Block Transfer Size = 120 ProSoft Technology, Inc. Page 77 of 160...
Page 78
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 78 of 160...
Modbus network. The module can act as a Modbus TCP/IP client (master), server (slave), or both simultaneously. 5.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 80
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...
User Manual 5.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 82
All commands containing invalid data are ignored by the module. Client Command List You can define up to 10 Modbus TCP/IP client connections in the MVI69E-MBTCP. Each client connection can contain up to 16 commands each. A valid command includes the following items: ...
MBTCP. This feature is only supported with MVI69E-MBTCP firmware version 1.11.001 or later. The MVI69E-MBTCP module in Legacy Mode is backward compatible with the legacy MVI69-MNET. This means that you may replace the MVI69-MNET with the MVI69E- MBTCP module in LEGACY mode without any changes to the existing CompactLogix ladder logic application.
Page 84
MVI69E-MBTCP ♦ CompactLogix™ Platform Legacy Mode Modbus TCP/IP Enhanced Communication Module User Manual field to ‘Yes’, In the Advanced Settings page, change the L EGACY then click on the U button. PDATE EGACY Confirm the update by clicking OK. ProSoft Technology, Inc.
Page 85
MVI69E-MBTCP ♦ CompactLogix™ Platform Legacy Mode Modbus TCP/IP Enhanced Communication Module User Manual The module will reboot during the update process. Once complete, the homepage displays Legacy Mode – Yes. ProSoft Technology, Inc. Page 85 of 160...
Legacy Mode Modbus TCP/IP Enhanced Communication Module User Manual PCB Configuration You will need to convert the existing ‘MVI69-MNET’ PCB project to an ‘MVI69E-MBTCP LEGACY’ project. Open the existing MVI69-MNET project in PCB. Right-click on the MVI69-MNET icon and select C...
Modbus TCP/IP Enhanced Communication Module User Manual 6.2.1 Module This section contains general module configuration parameters, including database allocation and backplane transfer options. In the ProSoft Configuration Builder (PCB) tree view, double-click on the M ODULE icon. Description Value Parameter...
Page 88
MVI69E-MBTCP ♦ CompactLogix™ Platform Legacy Mode Modbus TCP/IP Enhanced Communication Module User Manual 1 = Store received message in unformatted block for processor. 2 = Store received data in formatted block for processor after swapping bytes. 3 = Store received data in formatted block for processor.
MVI69E-MBTCP ♦ CompactLogix™ Platform Legacy Mode Modbus TCP/IP Enhanced Communication Module User Manual 6.2.2 Client 0 This section defines the Modbus TCP/IP Client driver. In the ProSoft Configuration Builder tree view, double-click the MNET Client 0 icon. Value Description Parameter...
For Modbus Function Codes 1, 2, 5, or 15, the allowable range is 0 to 159,999. Note: This bit address range is available with ProSoft Configuration Builder (PCB) v4.6.0.0 or later. Previous versions have a range of 0 to 65535.
Page 91
MVI69E-MBTCP ♦ CompactLogix™ Platform Legacy Mode Modbus TCP/IP Enhanced Communication Module User Manual Note: When using a bit level command, you must define this field at the bit level. For example, when using function codes 1 or 2 for a Read command, you must have a enter of 160 to place the data in the MBTCP.DATA.ReadData[10] controller tag in Studio...
Page 92
MVI69E-MBTCP ♦ CompactLogix™ Platform Legacy Mode Modbus TCP/IP Enhanced Communication Module User Manual 1 to 255 Specifies the Modbus server IP address on the network Node IP (0 = Broadcast) to be considered. Most Modbus devices only accept an Address address in the range of 1 to 247.
MVI69E-MBTCP ♦ CompactLogix™ Platform Legacy Mode Modbus TCP/IP Enhanced Communication Module User Manual 6.2.4 Servers This parameter is defined in MBTCP Servers on page 40. Value Description Parameter Yes or No Use Floating point data offset. Enron-Daniels 0 to 9999...
MVI69E-MBTCP ♦ CompactLogix™ Platform Legacy Mode Modbus TCP/IP Enhanced Communication Module User Manual 6.2.5 STATIC ARP TABLE This table contains a list of static IP/MAC addresses that the module will utilized when an ARP is required. The module will accept up to 40 static IP/MAC address data sets.
MVI69E-MBTCP ♦ CompactLogix™ Platform Legacy Mode Modbus TCP/IP Enhanced Communication Module User Manual 6.2.6 Ethernet 1 1 option allows you to configure the module’s IP Address, Subnet The E THERNET Mask, and Gateway. 6.2.7 Comment Parameter Under the M option, you can make a note that this configuration...
Right-click on the MVI69E-MBTCP icon and select D OWNLOAD FROM EVICE In the Download files from PC to module dialog, click on the B ROWSE EVICE button. The ProSoft Discovery Service Utility searches for ProSoft devices on the network. ProSoft Technology, Inc. Page 96 of 160...
Page 97
Modbus TCP/IP Enhanced Communication Module User Manual Double-click on the module icon. . When complete, the ‘Module Running’ message is displayed. Click D OWNLOAD Once complete, the MVI69E-MBTCP in Legacy Mode will operate similarly to the MVI69-MNET. ProSoft Technology, Inc. Page 97 of 160...
These optional features are not supported by the MVI69E- MNET legacy module. Note: The Optional AOI may be added to an existing legacy MVI69E-MBTCP application to add the new functionality during a module replacement. Add a new rung to the existing processor ladder logic. Right-click on the new rung and select Import Rungs…...
Page 99
MVI69E-MBTCP ♦ CompactLogix™ Platform Legacy Mode Modbus TCP/IP Enhanced Communication Module User Manual At the Import Configuration window, select the Operation parameter to C . Then REATE click OK. The imported AOI rung is now in place. ProSoft Technology, Inc.
In the Message Configuration dialog, under the Communication tab, select the button. ROWSE In the Message Path Browser dialog, select the MVI69E-MBTCP module under the 1769 Bus and click at OK. ProSoft Technology, Inc. Page 100 of 160...
Page 101
MVI69E-MBTCP ♦ CompactLogix™ Platform Legacy Mode Modbus TCP/IP Enhanced Communication Module User Manual The module name is displayed in the Path field. Click OK to confirm the route configuration. Repeat the same procedure to set the route for the remaining messages: ...
6.4.2 Synchronizing the IP Settings from the MVI69E-MBTCP to the Processor This section covers the process to read the IP settings from the MVI69E-MBTCP, and implement them in the processor. To trigger the IP settings read operation, set the MVI69EMBTCPEthernet.Read bit to ‘1’.
MVI69E-MBTCP ♦ CompactLogix™ Platform Legacy Mode Modbus TCP/IP Enhanced Communication Module User Manual 6.4.3 Synchronizing the IP Settings from the Processor to the MVI69E- MBTCP This section covers the process to send the IP settings from the processor to the MVI69E-MBTCP.
Toggle the MVI69EMBTCPClock.Read bit to ‘1’ to toggle the date/time read operation. The MVI69EMBTCPClock.Read bit will automatically reset to ‘0’ once the operation is concluded. The date and time read from the MVI69E-MBTCP is stored at the MVI69EMBTCPClock.Config tag. ProSoft Technology, Inc. Page 104 of 160...
Legacy Mode Modbus TCP/IP Enhanced Communication Module User Manual 6.4.5 Writing the Date/Time from the Processor to the MVI69E-MBTCP Populate date and time values in the MVI69EMBTCPClock.Config tag. Toggle the MVI69EMBTCPClock.Write bit to ‘1’ to trigger the write date/time operation.
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. ProSoft Technology, Inc.
Verify correct configuration data is being transferred to the module from the CompactLogix controller. If the module's OK LED does not turn GREEN, verify that the module is inserted completely into the rack. If this does not cure the problem, contact ProSoft Technology Technical Support. ProSoft Technology, Inc.
Modbus TCP/IP Enhanced Communication Module User Manual 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. 7.4.1 Processor Errors Steps to take...
MVI69E-MBTCP ♦ CompactLogix™ Platform Diagnostics and Troubleshooting Modbus TCP/IP Enhanced Communication Module User Manual Connecting the PC to the Module's Ethernet Port With the module securely mounted, connect one end of the Ethernet cable to the ETH1 Port, and the other end to an Ethernet hub or switch accessible from the same network as the PC.
7.5.1 Setting Up a Temporary IP Address Important: ProSoft Configuration Builder locates MVI69E-MBTCP modules through UDP broadcast messages. These messages may be blocked by routers or layer 3 switches. In that case, the ProSoft Discovery Service is unable to locate the modules.
Page 111
IP address, see Ethernet 1 (page 47) . Close the ProSoft Discovery Service window. Enter the temporary IP address in the Ethernet address field of the Connection Setup dialog box, then click T to verify that the module is accessible with the current settings.
ProSoft Configuration Builder (PCB) provides diagnostic menus for debugging and troubleshooting. 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 35).
Page 113
MVI69E-MBTCP ♦ CompactLogix™ Platform Diagnostics and Troubleshooting Modbus TCP/IP Enhanced Communication Module User Manual In the Ethernet field of the Connection Setup dialog box, enter the current IP address, whether it is temporary or permanent. Click T to verify that ONNECTION the module is accessible with the current settings.
IAGNOSTICS available through the Ethernet configuration port. The menu is arranged as a tree structure. 7.6.2 Monitoring General Information In the Diagnostics window in ProSoft Configuration Builder, click MODULE and then click V to view module version information. ERSION ProSoft Technology, Inc.
MVI69E-MBTCP ♦ CompactLogix™ Platform Diagnostics and Troubleshooting Modbus TCP/IP Enhanced Communication Module User Manual 7.6.3 Monitoring Backplane Information In the Diagnostics window in ProSoft Configuration Builder, click BACKPLANE to view the backplane information: TATUS ProSoft Technology, Inc. Page 115 of 160...
MVI69E-MBTCP ♦ CompactLogix™ Platform Diagnostics and Troubleshooting Modbus TCP/IP Enhanced Communication Module User Manual 7.6.4 Modbus Server Driver Information In the Diagnostics window in ProSoft Configuration Builder, click S to view the ERVERS server information. The menu has two sub-menus: ...
ASCII, Hexadecimal, and Float format. 7.6.6 Modbus Client Driver Information In the Diagnostics window in ProSoft Configuration Builder, click MBTCP CLIENT X to view Modbus Client driver information, where X is the number of the Modbus Client. The Modbus Client Driver menus have four submenus: ...
MVI69E-MBTCP ♦ CompactLogix™ Platform Diagnostics and Troubleshooting Modbus TCP/IP Enhanced Communication Module User Manual 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.
Enter the assigned IP address of the module into a web browser or use the following steps in PCB. In the Diagnostics window in ProSoft Configuration Builder, click the S button. ONNECTION...
User Manual Reference 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.
Modbus TCP/IP is a client/server protocol. The client establishes a connection to the remote server. When the connection is established, the client sends the Modbus TCP/IP commands to the server. The MVI69E-MBTCP module simulates up to 30 clients, and works both as a client and a server.
Modbus client. 8.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 8.2.3 Function Codes Supported by the Module The format of each command in the list depends on the Modbus Function Code being executed. The following table lists the Function Codes supported by the MVI69E- MBTCP module.
Page 124
MVI69E-MBTCP ♦ CompactLogix™ Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual Response An example response to Read Coil Status is as shown in the table below. The data is packed one bit for each coil. The response includes the server address, function code, quantity of data characters, the data characters, and error checking.
MVI69E-MBTCP ♦ CompactLogix™ Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual 8.2.5 Read Input Status (Function Code 02) Query This function allows you to obtain the ON/OFF status of discrete inputs (Modbus 1x range) in the addressed server. PC Broadcast mode is not supported with this function code.
MVI69E-MBTCP ♦ CompactLogix™ Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual 8.2.6 Read Holding Registers (Function Code 03) Query This function allows you to retrieve the contents of holding registers 4xxxx (Modbus 4x range) in the addressed server. The registers can store the numerical values of associated timers and counters which can be driven to external devices.
MVI69E-MBTCP ♦ CompactLogix™ Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual 8.2.7 Read Input Registers (Function Code 04) Query This function retrieves the contents of the controller's input registers from the Modbus 3x range. These locations receive their values from devices connected to the I/O structure and can only be referenced, not altered from within the controller, The addressing allows retrieving up to 125 registers at each request;...
Address The forcing of a coil via Modbus function 5 happens regardless of whether the addressed coil is disabled or not (In ProSoft products, the coil is only affected if you implement the necessary ladder logic). Note: The Modbus protocol does not include standard functions for testing or changing the DISABLE state of discrete inputs or outputs.
MVI69E-MBTCP ♦ CompactLogix™ Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual 8.2.9 Preset Single Register (Function Code 06) Query This Function Code allows you to modify the contents of a Modbus 4x range in the server. This writes to a single register only. Any holding register that exists within the controller can have its contents changed by this message.
Generally, the mode is forced to remove a malfunctioning remote device from the communications system. 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 131
MVI69E-MBTCP ♦ CompactLogix™ Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual The data fields in responses to other kinds of queries could contain error counts or other data requested by the sub-function code. ProSoft Technology, Inc. Page 131 of 160...
MVI69E-MBTCP ♦ CompactLogix™ Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual 8.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).
MVI69E-MBTCP ♦ CompactLogix™ Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual 8.2.12 Preset Multiple Registers (Function Code 16) Query This Function Code allows you to modify the contents of a Modbus 4x range in the slave. This writes up to 125 registers at time. Since the controller is actively scanning, it also can alter the content of any holding register at any time.
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.
MVI69E-MBTCP ♦ CompactLogix™ Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual 8.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 136
MVI69E-MBTCP ♦ CompactLogix™ Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual The next few pages show three specific examples: Example #1: Client is issuing Modbus command with FC 16 (with Float Flag: Yes) to transfer Float data to server.
Page 137
MVI69E-MBTCP ♦ CompactLogix™ Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual In the example above, 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 Device 85.37...
Page 138
MVI69E-MBTCP ♦ CompactLogix™ Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual Example #2: Client is issuing Modbus command with FC 16 (with Float Flag: No) to transfer Float data. Float Flag: "N" tells the client to ignore the floating values and treat each register data as a data point composed of 1 word, 2 bytes or 16 bits.
Page 139
MVI69E-MBTCP ♦ CompactLogix™ Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual Example #3: Client is issuing Modbus command with FC 3 to transfer Float data from server. Float Flag: Not applicable with Modbus Function Code 3. Float Start: Not applicable with Modbus Function Code 3.
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.
MVI69E-MBTCP ♦ CompactLogix™ Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual 8.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 Description Offset 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 Spare 1 to (n-1) Where n = 60, 120, or 240 depending on the Block Transfer Size parameter.
Offset 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 IP address for the intended server for the message. Each digit (0 to 255) of the IP...
Block 4100 to 4119: Request from Processor to Module Description Offset 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 Spare 1 to (n-1) Where n = 60, 120, or 240 depending on the Block Transfer Size parameter.
MVI69E-MBTCP ♦ CompactLogix™ Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual 8.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.
Unlike Event Command blocks, which contain all the values needed for one command, Command Control is used with commands already defined in the MNET Client x Command List in ProSoft Configuration Builder. Block 5001 to 5016: Request from Processor to Module...
MVI69E-MBTCP ♦ CompactLogix™ Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual 8.4.7 Add Event with Data for Client Blocks (8000) The 8000-series blocks are similar to the 2000-series Event Command blocks. The 8000-series blocks get the command data from the processor, instead of from the module’s database.
MVI69E-MBTCP ♦ CompactLogix™ Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual 8.4.8 Get Event with Data Status Block (8100) This block requests status data for Event with Data Commands. Block 8100: Request from Processor to Module Description Offset Block ID 8100 status data request for Event with Data Commands.
MVI69E-MBTCP ♦ CompactLogix™ Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual 8.4.9 Get General Module Status Data Block (9250) This block requests general module status. Block 9250: Request from Processor to Module Description Offset Block ID 9250 to request the general module status response block...
MVI69E-MBTCP ♦ CompactLogix™ Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual Description Offset Modbus MBAP request count: this counter increments each time an MBAP (Service Port 502) request is received from a remote Modbus TCP/IP client. Modbus MBAP response count: this counter increments each time an MBAP (Service Port 502) response is sent back to a remote Modbus TCP/IP client command.
MVI69E-MBTCP ♦ CompactLogix™ Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual 8.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...
MVI69E-MBTCP ♦ CompactLogix™ Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual 8.4.12 Pass-Through Formatted Word Data Block for Functions 6 & 16 (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 8.4.15 Pass-Through Formatted Block for Function 15 (9959) When the module receives a function code 15 in Pass-Through mode, the module writes the data using block ID 9959 for multiple-bit data. First the bit mask clears the bits to be updated.
MVI69E-MBTCP ♦ CompactLogix™ Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual 8.4.16 Pass-Through Formatted Block for Function 23 (9961) Block 9961: Request from Module to Processor Description Offset Read Block ID 9961 Write Block ID 9961 Number of word registers in Modbus data set...
MVI69E-MBTCP ♦ CompactLogix™ Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual 8.4.18 Set Module Time Using Received Time Block (9972) This block uses the time information of the processor to set the module time. Block 9972: Request from Processor to Module...
MVI69E-MBTCP ♦ CompactLogix™ Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual 8.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...
MVI69E-MBTCP ♦ CompactLogix™ Platform Reference Modbus TCP/IP Enhanced Communication Module User Manual 8.4.21 Warm-boot Control Block (9998) If the CompactLogix sends a block number 9998, the module performs a warm-boot operation. The module reconfigures the communication ports and reset the error and status counters.
2 Rx- 6 Rx- 6 Tx- 6 Tx- 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 ...
Page 160
Configuration/Debug status information LED patterns Details about the interfaced serial, Ethernet or Fieldbus devices Note: For technical support calls within the United States, ProSoft’s 24/7 after-hours phone support is available for urgent plant-down issues. Europe / Middle East / Africa Regional Office North America (Corporate Location) Phone: +1.661.716.5100...
Need help?
Do you have a question about the MVI69E-MBTCP and is the answer not in the manual?
Questions and answers