ProSoft Technology MVI69L-MBTCP User Manual
  1. Manuals
  2. Brands
  3. ProSoft Technology Manuals
  4. Control Unit
  5. MVI69L-MBTCP
  6. User manual

ProSoft Technology MVI69L-MBTCP User Manual

Compactlogix platform modbus tcp/ip lite communication module
Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
MVI69L-MBTCP
CompactLogix™ Platform
®
Modbus TCP/IP
Lite
Communication Module
March 11, 2022
USER MANUAL

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the MVI69L-MBTCP and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for ProSoft Technology MVI69L-MBTCP

Summary of Contents for ProSoft Technology MVI69L-MBTCP

  • Page 1 MVI69L-MBTCP CompactLogix™ Platform ® Modbus TCP/IP Lite Communication Module March 11, 2022 USER MANUAL...

  • Page 2: Your Feedback Please

    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.

  • Page 3: Important Safety Information

    MVI69L-MBTCP ♦ CompactLogix™ Platform Contents 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.

  • Page 4: Table Of Contents

    MVI69L-MBTCP ♦ CompactLogix™ Platform Contents Communication Module User Manual Contents Your Feedback Please ........................2 How to Contact Us ..........................2 Important Safety Information ......................3 Start Here System Requirements ....................7 Package Contents ....................8 Setup Jumper......................8 Installing the Module in the Rack ................9 Add-On Instruction Installing ProSoft Configuration Builder ..............
  • Page 5 Client Driver Overview .................... 63 Using Controller Tags Controller Tags ....................... 65 5.1.1 MVI69L-MBTCP Controller Tags ................66 User-Defined Data Types (UDTs)................67 5.2.1 MVI69L-MBTCP User-Defined Data Types ............67 Controller Tag Overview ..................69 5.3.1 MBTCP.CONFIG ....................69 5.3.2 MBTCP.DATA ......................69 5.3.3 MBTCP.CONTROL ....................
  • Page 6 MVI69L-MBTCP ♦ CompactLogix™ Platform Contents Communication Module User Manual 7.2.9 Preset Single Register (Function Code 06) ............103 7.2.10 Diagnostics (Function Code 08) ................104 7.2.11 Force Multiple Coils (Function Code 15) .............. 106 7.2.12 Preset Multiple Registers (Function Code 16) ............107 Floating-Point Support ..................

  • Page 7: Start Here

    MVI69L-MBTCP module. Important: The MVI69L-MBTCP module has a power supply distance rating of 4 (L43 and L45 installations on first 2 slots of 1769 bus). It consumes 450 mA at 5 Vdc.

  • Page 8: Package Contents

    Start Here Communication Module User Manual Package Contents The following components are included with the MVI69L-MBTCP module, and are all required for installation and configuration. Important: Before beginning the installation, please verify all of the following items are present. Qty.

  • Page 9: Installing The Module In The Rack

    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 the jumper placements are verified, insert the MVI69L-MBTCP into the rack. Use the same technique recommended by Rockwell Automation to remove and install CompactLogix modules.
  • Page 10 MVI69L-MBTCP ♦ CompactLogix™ Platform Start Here 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 11 MVI69L-MBTCP ♦ CompactLogix™ Platform Start Here Communication Module User Manual Press the DIN-rail mounting area of the controller against the DIN-rail. The latches will momentarily open and lock into place. ProSoft Technology, Inc. Page 11 of 139...

  • Page 12: Add-On Instruction

    Add-On Instruction The .L5X file contains the Add-On Instruction (AOI), user-defined data types, controller tags and ladder logic required to configure the MVI69L-MBTCP module. This file is generated by ProSoft Configuration Builder software and imported into RSLogix 5000. Installing ProSoft Configuration Builder The ProSoft Configuration Builder installation file can be found on the product at our website: www.prosoft-technology.com.

  • Page 13: Generating The Aoi (.L5X) File In Prosoft Configuration Builder

    MVI69L-MBTCP ♦ CompactLogix™ Platform Add-On Instruction 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 14 This action opens the Choose Module Type dialog box. In the Product Line Filter area of the dialog box, click the MVI69L radio button. In the Select Module Type dropdown list, select MVI69L-MBTCP, and click OK to save the settings and return to the ProSoft Configuration Builder window.

  • Page 15: Exporting The .L5X File From Pcb

    Add-On Instruction Communication Module User Manual 2.2.2 Exporting the .L5X File from PCB Expand the MVI69L-MBTCP icon by clicking the [+] symbol beside it. Similarly, expand the icon. Double-click the Module icon to open the Edit - Module dialog box.
  • Page 16 User Manual Click OK to close the Edit – Module dialog box. The .L5X file is now ready to be exported to the PC/Laptop. Right-click the MVI69L-MBTCP icon in the project tree and select E AOI F XPORT Save the .L5X file to the PC/Laptop in an easily found location, such as Windows Desktop.

  • Page 17: Creating A New Rslogix 5000 Project

    MVI69L-MBTCP ♦ CompactLogix™ Platform Add-On Instruction Communication Module User Manual Creating a New RSLogix 5000 Project Open the F menu, and select N Select the CompactLogix processer model. Select R 16 or newer. EVISION Enter a name for the processor, such as My_Controller.

  • Page 18: Creating The Module In An Rslogix 5000 Project

    In an RSLogix 5000 project, an Add-On Profile (AOP) can be used to specifically identify the MVI69L-MBTCP when selecting the type of module to be installed in slot x. Add-On Profiles are supported in RSLogix 5000 version 15 and newer.
  • Page 19 MVI69L-MBTCP ♦ CompactLogix™ Platform Add-On Instruction Communication Module User Manual Continue to follow the steps in the wizard to complete the installation. Click Finish when complete. The AOP is now installed in RSLogix 5000. There is no need to reboot the PC.

  • Page 20: Creating A Module In The Project Using An Add-On Profile

    ODULE menu. This action opens the Select Module Type dialog box. In the Module Type Vendor Filters area, uncheck all boxes except the ProSoft Technology box. A list of ProSoft Technology modules will appear below. ProSoft Technology, Inc. Page 20 of 139...
  • Page 21 Add-On Instruction Communication Module User Manual Select the MVI69L-MBTCP module in the list and click Create: A New Module dialog box will open. Edit the Name and Slot of the module and click ProSoft Technology, Inc. Page 21 of 139...
  • Page 22 MVI69L-MBTCP ♦ CompactLogix™ Platform Add-On Instruction Communication Module User Manual The MVI69L-MBTCP module will now be visible at the I/O Configuration tree. ProSoft Technology, Inc. Page 22 of 139...

  • Page 23: Creating A Module In The Project Using A Generic 1769 Module Profile

    User Manual 2.4.3 Creating a Module in the Project Using a Generic 1769 Module Profile Note: This procedure is not required if the ProSoft Technology AOP is installed. Expand the I/O C folder in the Project tree. Right-click the appropriate...
  • Page 24 MVI69L-MBTCP ♦ CompactLogix™ Platform Add-On Instruction Communication Module User Manual Set the Module Properties values as follows: Parameter Value Name Enter a module identification string. Example: MVI69L_MBTCP Description Enter a description for the module. Example: ProSoft communication module for Serial Modbus communications.
  • Page 25 MVI69L-MBTCP ♦ CompactLogix™ Platform Add-On Instruction Communication Module User Manual On the Connection tab, set the RPI value for your project. Click OK to confirm. The MVI69L-MBTCP module will be visible at the I/O Configuration tree. ProSoft Technology, Inc. Page 25 of 139...

  • Page 26: Importing The Add-On Instruction

    MVI69L-MBTCP ♦ CompactLogix™ Platform Add-On Instruction 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. The M contains rungs of logic. The...
  • Page 27 MVI69L-MBTCP ♦ CompactLogix™ Platform Add-On Instruction Communication Module User Manual Select the .L5X file that was exported from PCB earlier. This action opens the Import Configuration dialog box. Click T under to display the controller tags that will be created.
  • Page 28 MVI69L-MBTCP ♦ CompactLogix™ Platform Add-On Instruction Communication Module User Manual If the module is not located in the default slot (or is in a remote rack), edit the connection input and output variables that define the path to the module in the F...

  • Page 29: Adding Multiple Modules In The Rack (Optional)

    User Manual Adding Multiple Modules in the Rack (Optional) Important: This procedure is for multiple MVI69L-MBTCP modules running in the same CompactLogix rack. You must export a new Add-On Instruction from PCB for each module. You do this by adding a new module to the PCB project and exporting the module configuration as an L5X file.
  • Page 30 Select the MVI69L-MBTCP module to add a second (or more) module in the PCB project. Note: A duplicate MVI69L-MBTCP module requires a unique name. The default name on a duplicate module appends a number to the end such as MVI69L-MBTCP_000, MVI69L-MBTCP_001, etc.

  • Page 31: Adding A New Module In Rslogix 5000

    MVI69L-MBTCP ♦ CompactLogix™ Platform Add-On Instruction Communication Module User Manual 2.6.2 Adding a new module in RSLogix 5000 Multiple modules can be placed in the same rack provided it does not exceed the power distance rating of the CompactLogix rack (see page 7). Adding an additional module to the rack is similar to installing a new module earlier in this chapter.
  • Page 32 MVI69L-MBTCP ♦ CompactLogix™ Platform Add-On Instruction Communication Module User Manual The N window will appear. Enter a unique name for the new module. ODULE Also confirm the slot number of the new module. Click OK to confirm. The new module is now visible: Importing the AOI for the new module is also required.
  • Page 33 MVI69L-MBTCP ♦ CompactLogix™ Platform Add-On Instruction Communication Module User Manual Select an empty rung in the routine, and then click the right mouse button to open a … shortcut menu. On the shortcut menu, choose I MPORT UNGS ProSoft Technology, Inc.
  • Page 34 MVI69L-MBTCP ♦ CompactLogix™ Platform Add-On Instruction Communication Module User Manual Select the .L5X file of the new module, and click I . The new .L5X file will have MPORT a unique filename. This action opens the I window, showing the tags to be...
  • Page 35 MVI69L-MBTCP ♦ CompactLogix™ Platform Add-On Instruction Communication Module User Manual 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 36 MVI69L-MBTCP ♦ CompactLogix™ Platform Add-On Instruction Communication Module User Manual 10 Click OK to confirm. The setup procedure is now complete. Save the project, it is ready to download to the CompactLogix processor. ProSoft Technology, Inc. Page 36 of 139...

  • Page 37: Mvi69L-Mbtcp Configuration

    PCB is used 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. When the MVI69L-MBTCP module boots up, it requests the processor to send it the configuration over the backplane in special Configuration Blocks.

  • Page 38: Editing Configuration Parameters

    MVI69L-MBTCP ♦ CompactLogix™ Platform MVI69L-MBTCP Configuration Communication Module User Manual 3.1.3 Editing Configuration Parameters Click on the [+] sign next to the M icon to expand module information. ODULE Click on the [+] sign next to any icon to view module information and configuration options.
  • Page 39 MVI69L-MBTCP ♦ CompactLogix™ Platform MVI69L-MBTCP Configuration Communication Module User Manual Double-clicking any icon will open an Edit dialog box with a table. This dialog box is used to build and edit Modbus Client commands. To add a row to the table, click the A button.

  • Page 40: Printing A Configuration File

    MVI69L-MBTCP ♦ CompactLogix™ Platform MVI69L-MBTCP Configuration Communication Module User Manual To edit the row, click the E button. This will open an Edit dialog box. 3.1.4 Printing a Configuration File In the main PCB window, right-click the M icon and select V ODULE from the shortcut menu.

  • Page 41: Module Configuration Parameters

    Modbus communications should be halted. Error/Status -1 to 435 The starting MVI69L-MBTCP database location to store server Pointer error/status data. If a value of -1 is entered, the error/status data will not be placed in the database.

  • Page 42: Mbtcp Servers

    MVI69L-MBTCP ♦ CompactLogix™ Platform MVI69L-MBTCP Configuration Communication Module User Manual 3.2.2 MBTCP Servers This section applies to configuring the MVI69L-MBTCP Server (slave) Driver. Parameter Value Description Start Active Yes or No Specifies whether or not the port and commands will be active upon module boot-up.
  • Page 43 MVI69L-MBTCP ♦ CompactLogix™ Platform MVI69L-MBTCP Configuration Communication Module User Manual register values greater-than or equal to this value is considered floating-point data requests. This parameter is only used if the Float Flag is enabled. For example, if a value of 200 is entered, all requests for registers 200 and above is considered as floating-point data.

  • Page 44: Mbtcp Client X

    Enables this client. Start Active Yes or No Specifies whether to start with commands active on boot up. The starting MVI69L-MBTCP database location to store Client x’s Error/Status -1 to 470 Pointer error/status data. If a value of -1 is entered, the error/status data will not be placed in the database.
  • Page 45 MVI69L-MBTCP ♦ CompactLogix™ Platform MVI69L-MBTCP Configuration Communication Module User Manual Response 1 to 65535 Specifies the command response timeout period in 1 millisecond Timeout milliseconds increments. The Client will wait for a response from the addressed server within the timeout period before re-transmitting the command (Retries) or skipping to the next command in the Command List.

  • Page 46: Mbtcp Client X Commands

    User Manual 3.2.4 MBTCP Client x Commands In order to interface the MVI69L-MBTCP module with Modbus server devices, a command list needs to be created. 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 47 MVI69L-MBTCP ♦ CompactLogix™ Platform MVI69L-MBTCP Configuration Communication Module User Manual If the command is a write function, the data to be written to the server device is sourced beginning from the module’s internal database register specified. This register value must be within the fixed Write Data area of the module’s memory 240 to 479 (3840 to 7679 bit-level).
  • Page 48 MVI69L-MBTCP ♦ CompactLogix™ Platform MVI69L-MBTCP Configuration Communication Module User Manual encapsulated format messages. Slave 0 to 255 Mainly used for Modbus TCP/IP to serial conversion, this Address specifies the Modbus slave node address on the serial network to be considered.

  • Page 49: Ethernet 1

    MVI69L-MBTCP ♦ CompactLogix™ Platform MVI69L-MBTCP Configuration Communication Module User Manual 3.2.5 Ethernet 1 This section defines the permanent IP address, Subnet Mask, and Gateway of the module. Parameter Description IP Address Unique IP address assigned to the module Netmask Subnet mask of module...

  • Page 50: Static Arp Table

    (Address Resolution Protocol) is required. The module will accept up to 40 static IP/MAC Address data sets. Use the Static ARP table to reduce the amount of network traffic by specifying IP addresses and their associated MAC (hardware) addresses that the MVI69L-MBTCP module will be communicating with regularly. Parameter...

  • Page 51: Downloading The Configuration File To The Processor

    MVI69L-MBTCP ♦ CompactLogix™ Platform MVI69L-MBTCP Configuration Communication Module User Manual Downloading the Configuration File to the Processor In PCB’s tree view, right-click the module icon and select D OWNLOAD FROM from the shortcut menu. EVICE In the Download Configuration File window, click the RSW button.
  • Page 52 MVI69L-MBTCP ♦ CompactLogix™ Platform MVI69L-MBTCP Configuration Communication Module User Manual Browse and highlight the CompactLogix processor and click OK. Note: DF1 serial download via CIPConnect is not supported. Only use Ethernet or EtherNet/IP drivers via RSWho. Notice the CIPConnect path has been updated in the Download Configuration File.
  • Page 53 MVI69L-MBTCP ♦ CompactLogix™ Platform MVI69L-MBTCP Configuration Communication Module User Manual When ready, click D to download the configuration file to the processor. OWNLOAD Following the download process, the module will automatically be rebooted. Upon reboot, the ladder logic sends the configuration data from the processor to the module.

  • Page 54: Uploading The Configuration File From The Processor

    MVI69L-MBTCP ♦ CompactLogix™ Platform MVI69L-MBTCP Configuration Communication Module User Manual Uploading the Configuration File from the Processor In PCB’s tree view, right-click the module icon and select U PLOAD FROM EVICE TO PC from the shortcut menu. In the Upload Configuration File window, the CIPConnect path should already be constructed if you have previously downloaded the configuration file from the same PC.
  • Page 55 MVI69L-MBTCP ♦ CompactLogix™ Platform MVI69L-MBTCP Configuration Communication Module User Manual Click T to verify the path is active and can successfully connect to ONNECTION the processor. ProSoft Technology, Inc. Page 55 of 139...
  • Page 56 MVI69L-MBTCP ♦ CompactLogix™ Platform MVI69L-MBTCP Configuration Communication Module User Manual When ready, click U . When complete, click Close. PLOAD PCB will now display the uploaded configuration file. ProSoft Technology, Inc. Page 56 of 139...

  • Page 57: Backplane Data Exchange

    User Manual Backplane Data Exchange Ladder logic is required for the MVI69L-MBTCP module to communicate with the CompactLogix processor across the backplane. The ladder logic handles the module data transfer, configuration data transfer, special block handling, and status data receipt.

  • Page 58: Backplane Data Transfer

    Communication Module User Manual Backplane Data Transfer The MVI69L-MBTCP module communicates directly over the CompactLogix backplane. Data is paged between the module and the CompactLogix processor across the backplane using the module's input and output images. The update frequency of the images is determined by the scheduled scan rate defined by the user for the module and the communication load on the module.

  • Page 59: Normal Data Transfer

    MVI69L-MBTCP ♦ CompactLogix™ Platform Backplane Data Exchange Communication Module User Manual Normal Data Transfer Normal data transfer includes the paging of the user data found in the module’s internal database and the status data. These data are transferred through read (input image) and write (output image) blocks.

  • Page 60: Read And Write Block Transfer Sequences

    MVI69L-MBTCP ♦ CompactLogix™ Platform Backplane Data Exchange Communication Module User Manual 4.2.3 Read and Write Block Transfer Sequences There are 240 words of data transferred per block along the backplane between the module and the processor. The Write Block ID associated with the block requests data from the processor. Under normal program operation, the module sequentially sends read blocks and requests write blocks.

  • Page 61: Data Flow Between The Module And Processor

    The module can act as a Modbus TCP/IP Client (master), Server (slave), or both simultaneously. 4.3.1 Server Driver Overview The Server driver allows the MVI69L-MBTCP module to respond 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 62 MVI69L-MBTCP ♦ CompactLogix™ Platform Backplane Data Exchange Communication Module User Manual This mode is especially useful when both a Modbus Client and the module’s processor logic need to be able to read and write values to the same internal database addresses.

  • Page 63: Client Driver Overview

    User Manual 4.3.2 Client Driver Overview In Client mode, the MVI69L-MBTCP module issues read or write commands to server devices on the Modbus network. These commands are user-configured in ProSoft Configuration Builder Client Command List. This list is transferred to the module when the module receives its configuration from the processor.
  • Page 64 Backplane Data Exchange Communication Module User Manual Client Command List Up to 10 Modbus TCP/IP Client connections can be defined in the MVI69L-MBTCP. Each Client connection can contain up to 16 commands each. A valid command includes the following items: ...

  • Page 65: Using Controller Tags

    Controller Tags Data related to the MVI69L-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: ...

  • Page 66: Mvi69L-Mbtcp Controller Tags

    MVI69L-MBTCP ♦ CompactLogix™ Platform Using Controller Tags Communication Module User Manual 5.1.1 MVI69L-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.

  • Page 67: User-Defined Data Types (Udts)

    UDTs are organized in a multiple-level tree structure. 5.2.1 MVI69L-MBTCP User-Defined Data Types Twenty-two different UDTs are defined for the MVI69L-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 68 MVI69L-MBTCP ♦ CompactLogix™ Platform Using Controller Tags Communication Module User Manual For example, if you expand MBTCP.DATA, you will see that it contains two UDTs, ReadData and WriteData. Both of these are 240-element integer arrays. Notice that these UDTs are the data types used to declare the MBTCP.DATA.ReadData and MBTCP.DATA.WriteData controller tag arrays.

  • Page 69: Controller Tag Overview

    Tag Name Description MBTCP.CONFIG.FileData This parameter contains the MVI69L-MBTCP configuration data after it has been downloaded from PCB. It is displayed in ASCII format. Note: MVI69L-MBTCP configuration changes cannot be made directly in this array; the configuration must be downloaded via PCB.

  • Page 70: Mbtcp.control

    MVI69L-MBTCP ♦ CompactLogix™ Platform Using Controller Tags Communication Module User Manual 5.3.3 MBTCP.CONTROL This array handles special tasks requested by the processor. 5.3.3.1 MBTCP.CONTROL.CommandControl This array allows the processor to dynamically enable configured commands for execution. Tag Name Range Description .Trigger...
  • Page 71 MVI69L-MBTCP ♦ CompactLogix™ Platform Using Controller Tags Communication Module User Manual 1 = Success -1 = Client is not Enabled and Active .CmdInQue Number of Commands in Queue waiting to be executed 5.3.3.3 MBTCP.CONTROL.EventCommand_PLCData This array allows the processor to dynamically build Modbus commands with PLC processor data.
  • Page 72 MVI69L-MBTCP ♦ CompactLogix™ Platform Using Controller Tags Communication Module User Manual 5.3.3.4 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 73 MVI69L-MBTCP ♦ CompactLogix™ Platform Using Controller Tags Communication Module User Manual 5.3.3.5 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 74 MVI69L-MBTCP ♦ CompactLogix™ Platform Using Controller Tags Communication Module User Manual 5.3.3.8 MBTCP.CONTROL.EventSequenceCounts This tag triggers the counting of the event sequence operation. Tag Name Range Description MBTCP.CONTROL.EventSequenceCounts 0 or 1 Triggers the counting of Event Sequence 0 = Disable, 1 = Enable 5.3.3.9 MBTCP.CONTROL.EventSequenceStatus...

  • Page 75: Mbtcp.status

    MVI69L-MBTCP ♦ CompactLogix™ Platform Using Controller Tags Communication Module User Manual 5.3.4 MBTCP.STATUS This array contains the status information of the module. 5.3.4.1 MBTCP.STATUS.Block This array contains the block status. Tag Name Description MBTCP.STATUS.Block.Read Total number of read blocks transferred from the module to the processor.
  • Page 76 MVI69L-MBTCP ♦ CompactLogix™ Platform Using Controller Tags Communication Module User Manual 5.3.4.4 MBTCP.STATUS.EventSeqCounts This array indicates the number of commands waiting in the command queue. Tag Name Description .ClientCmdCount_EventSeqMessage[x] Event command quantity waiting in queue There are two bytes of status data per Client. See below for more details.
  • Page 77 MVI69L-MBTCP ♦ CompactLogix™ Platform Using Controller Tags Communication Module User Manual 5.3.4.5 MBTCP.STATUS.GeneralStatus This array contains the general status of the module including firmware revision and general communication status. Tag Name Description .ExpectedWriteBlock Contains the next write block ID number.

  • Page 78: Mbtcp.util

    MVI69L-MBTCP ♦ CompactLogix™ Platform Using Controller Tags Communication Module User Manual 5.3.4.6 MBTCP.STATUS.GetEventDataStatus This array contains the status of the event command last executed. Tag Name Description .ClientRecordsCount Number of clients contained in block. .Status Two words per Client. Word 1 = Client (0 to 9) Word 2 = Error code for last executed command for corresponding client.
  • Page 79 MVI69L-MBTCP ♦ CompactLogix™ Platform Using Controller Tags Communication Module User Manual .EventSeqStatusWriteBlockID Event Sequence Status Write Block ID. .EventSeqCountsWriteBlockID Event Sequence Counts Write Block ID. .EventSeqCountsPending Event Sequence Counts Pending. Yes (0) or No (1) .TimeWriteBlockID Time Write Block ID.

  • Page 80: Diagnostics And Troubleshooting

    MVI69L-MBTCP ♦ CompactLogix™ Platform Diagnostics and Troubleshooting Communication Module User Manual Diagnostics and Troubleshooting The module provides information on diagnostics and troubleshooting in the following forms:  LED status indicators on the front of the module provide information on the module’s status.

  • Page 81: Led Status Indicators

    During module configuration, the OK LED will be red and the BP LED will be 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.

  • Page 82: Troubleshooting The Leds

    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. 6.2.2 Troubleshooting the LEDs Use the following troubleshooting steps if problems occur when the module is powered up.

  • Page 83: Connecting The Pc To The Module's Ethernet Port

    MVI69L-MBTCP ♦ CompactLogix™ Platform Diagnostics and Troubleshooting 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.

  • Page 84: Setting Up A Temporary Ip Address

    OR reconfigure the router/ layer 3 switch to allow routing of the UDP broadcast messages. In the tree view in ProSoft Configuration Builder (PCB), select the MVI69L-MBTCP module. (For instructions on opening and using a project in PCB, please refer to Chapter 2.)
  • Page 85 MVI69L-MBTCP ♦ CompactLogix™ Platform Diagnostics and Troubleshooting Communication Module User Manual In the Connection Setup dialog box, click the B ) button to open the ROWSE EVICE ProSoft Discovery Service. Select the module, then right-click and choose A SSIGN EMPORARY The module’s default IP address is usually 192.168.0.250.

  • Page 86: Connecting To The Diagnostics Menu In Prosoft Configuration Builder

    MVI69L-MBTCP ♦ CompactLogix™ Platform Diagnostics and Troubleshooting Communication Module User Manual Connecting to the Diagnostics Menu in ProSoft Configuration Builder ProSoft Configuration Builder (PCB) provides diagnostic menus for debugging and troubleshooting. To connect to the module’s Configuration/Debug Ethernet port: In ProSoft Configuration Builder, select the module, and then click the right mouse button to open a shortcut menu.
  • Page 87 MVI69L-MBTCP ♦ CompactLogix™ Platform Diagnostics and Troubleshooting 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 the T button to ONNECTION verify that the module is accessible with the current settings.

  • Page 88: Diagnostics Menu

    MVI69L-MBTCP ♦ CompactLogix™ Platform Diagnostics and Troubleshooting Communication Module User Manual 6.4.1 Diagnostics Menu The Diagnostics menu is available through the Ethernet configuration port. The menu is arranged as a tree structure. 6.4.2 Monitoring General Information Use the MODULE>Version menu to view module version information.

  • Page 89: Monitoring Network Configuration Information

    MVI69L-MBTCP ♦ CompactLogix™ Platform Diagnostics and Troubleshooting Communication Module User Manual 6.4.3 Monitoring Network Configuration Information Use the MODULE>NIC Status menu to view the Ethernet network configuration information. 6.4.4 Monitoring Backplane Status Information Use the BACKPLANE>Status menu to view the backplane information.

  • Page 90: Modbus Server Driver Information

    MVI69L-MBTCP ♦ CompactLogix™ Platform Diagnostics and Troubleshooting Communication Module User Manual 6.4.5 Modbus Server Driver Information The SERVERS menu includes the following submenus:  Module Server Configuration  Module Server Status ProSoft Technology, Inc. Page 90 of 139...

  • Page 91: Monitoring Data Values In The Module's Database

    Communication Module User Manual 6.4.6 Monitoring Data Values in the Module’s Database Use the DATABASE>Decimal menu to view the contents of the MVI69L-MBTCP module’s internal database. Data values can also be viewed in ASCII, Hexadecimal, and Float format. 6.4.7 Modbus Client Driver Information The MBTCP CLIENT X menus include the following submenus: ...

  • Page 92: Communication Error Codes

    MVI69L-MBTCP ♦ CompactLogix™ Platform Diagnostics and Troubleshooting Communication Module User Manual Communication Error Codes 6.5.1 Standard Modbus Protocol Exception Code Errors Code Description Illegal Function Code Illegal Data Address Illegal Data Value Failure in Associated Device Acknowledge Busy, Rejected Message 6.5.2 Module Communication Error Codes...

  • Page 93: Connecting To The Module's Webpage

    MVI69L-MBTCP ♦ CompactLogix™ Platform Diagnostics and Troubleshooting Communication Module User Manual Connecting to the Module’s 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 94: Reference

    Communication Module User Manual Reference Product Specifications The MVI69L-MBTCP (Modbus TCP/IP Communication Module) allows Rockwell Automation CompactLogix I/O compatible processors to interface easily with other Modbus TCP/IP protocol compatible devices. The module acts as an input/output communications module between the Modbus TCP/IP network and the CompactLogix backplane.

  • Page 95: Hardware Specifications

    MVI69L-MBTCP ♦ CompactLogix™ Platform Reference Communication Module User Manual 7.1.2 Hardware Specifications Specification Description Dimensions Standard 1769 Single-slot module Current Load 500 mA max @ 5 VDC Power supply distance rating of 4 (L43 and L45 installations on first 2 slots of 1769 bus) Operating Temp.

  • Page 96: About The Modbus Protocol

    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 commands to the Server. The MVI69L-MBTCP module can work as a Client and as a Server.

  • Page 97: Commands Supported By The Module

    MVI69L-MBTCP ♦ CompactLogix™ Platform Reference Communication Module User Manual 7.2.3 Commands 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 module.

  • Page 98: Read Coil Status (Function Code 01)

    MVI69L-MBTCP ♦ CompactLogix™ Platform Reference Communication Module User Manual 7.2.4 Read Coil Status (Function Code 01) Query This function allows the user to obtain the ON/OFF status of logic coils (Modbus 0x range) used to control discrete outputs from the addressed Server only. Broadcast mode is not supported with this function code.

  • Page 99: Read Input Status (Function Code 02)

    MVI69L-MBTCP ♦ CompactLogix™ Platform Reference Communication Module User Manual 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.

  • Page 100: Read Holding Registers (Function Code 03)

    MVI69L-MBTCP ♦ CompactLogix™ Platform Reference Communication Module User Manual The status of inputs 10197 to 10204 is shown as AC (HEX) = 10101 1100 (binary). Reading left to right, this show that inputs 10204, 10202, and 10199 are all on. The other input data bytes are decoded similar.

  • Page 101: Read Input Registers (Function Code 04)

    MVI69L-MBTCP ♦ CompactLogix™ Platform Reference Communication Module User Manual 7.2.7 Read Input Registers (Function Code 04) Query This Function Code obtains 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 up to 125 registers to be obtained at each request;...

  • Page 102: Force Single Coil (Function Code 05)

    MVI69L-MBTCP ♦ CompactLogix™ Platform Reference Communication Module User Manual 7.2.8 Force Single Coil (Function Code 05) Query This Function Code forces a single coil (Modbus 0x range) either ON or OFF. Any coil that exists within the controller can be forced to either state (ON or OFF). However, because the controller is actively scanning, unless the coil is disabled, the controller can also alter the state of the coil.

  • Page 103: Preset Single Register (Function Code 06)

    MVI69L-MBTCP ♦ CompactLogix™ Platform Reference Communication Module User Manual 7.2.9 Preset Single Register (Function Code 06) Query This Function Code allows the user to modify the contents of a Modbus 4x range in the server. This will write to a single register only. Any holding register that exists within the controller can have its contents changed by this message.

  • Page 104: Diagnostics (Function Code 08)

    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 MVI69L-MBTCP module. 00 Return Query Data The data passed in the request data field is to be returned (looped back) in the response.
  • Page 105 MVI69L-MBTCP ♦ CompactLogix™ Platform Reference Communication Module User Manual 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).

  • Page 106: Force Multiple Coils (Function Code 15)

    MVI69L-MBTCP ♦ CompactLogix™ Platform Reference Communication Module User Manual 7.2.11 Force Multiple Coils (Function Code 15) Query This Function Code 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).

  • Page 107: Preset Multiple Registers (Function Code 16)

    MVI69L-MBTCP ♦ CompactLogix™ Platform Reference Communication Module User Manual 7.2.12 Preset Multiple Registers (Function Code 16) Query This Function Code allows the user to modify the contents of a Modbus 4x range in the server. This will write 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.

  • Page 108: Floating-Point Support

    Communication Module User Manual Floating-Point Support The movement of floating point data between the MVI69L-MBTCP and other devices is easily accomplished as long as the device supports IEEE 754 Floating Point format. This IEEE format is a 32-bit single-precision floating-point format.

  • Page 109: Enron Floating-Point Support

    MVI69L-MBTCP ♦ CompactLogix™ Platform Reference Communication Module User Manual 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. The significance to this is that the count descriptor for a data transfer now denotes the number of floating-point values to transfer, instead of the number of words.
  • Page 110 MVI69L-MBTCP ♦ CompactLogix™ Platform Reference 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. (Float specific module parameters) Float Flag: "Y"...
  • Page 111 MVI69L-MBTCP ♦ CompactLogix™ Platform Reference Communication Module User Manual Addr in Dev - Tells the Client where in the Server's database to locate the data. In the above example, the Client's Modbus command to transmit inside the Modbus packet will be as follows.
  • Page 112 MVI69L-MBTCP ♦ CompactLogix™ Platform Reference Communication Module User Manual Specific 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 113 MVI69L-MBTCP ♦ CompactLogix™ Platform Reference Communication Module User Manual Specific 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.
  • Page 114 MVI69L-MBTCP ♦ CompactLogix™ Platform Reference Communication Module User Manual The (Non-Enron/Daniel supporting) Server's Modbus command that will be transmitted inside the Modbus packet will be as follows: Server address Function Code Byte Count Data 32.75 00 00 42 03 ProSoft Technology, Inc.

  • Page 115: Function Blocks

    Function Blocks Data contained in this database is paged through the input and output images by coordination of the CompactLogix ladder logic and the MVI69L-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.

  • Page 116: Event Command Blocks

    MVI69L-MBTCP ♦ CompactLogix™ Platform Reference Communication Module User Manual 7.4.1 Event Command Blocks Blocks 2000 to 2019: Event Command Event Command blocks send Modbus commands directly from the ladder logic to the specified MBTCP Client x. The Event Command will be added to the high-priority queue and will interrupt normal polling so this special command can be sent as soon as possible.

  • Page 117: Client Status Request/Response Blocks

    Block 3000 or 3019: Request from Processor to Module Offset Description Block ID 3000 to 3019 identification code indicates this block will request the status from a specific MVI69L-MBTCP Client. The last two digits indicate which Client to utilize. Example: ‘3008’ will utilize Client 8 1 to 239...

  • Page 118: Event Sequence Request Blocks

    Offset Description Block ID 4000 to 4019 indicates this block will trigger the event sequence of MVI69L-MBTCP client. The last two digits indicate which Client to utilize. Example: ‘4008’ will utilize Client 8 1 to 4 IP address for the server the message is intended. Each digit (0 to 255) of the IP...

  • Page 119: Event Sequence Command Error Status Blocks

    Offset Description Block ID 4100 to 4119 indicates this block will trigger the event sequence command error status request of a specific MVI69L-MBTCP client. The last two digits indicate which Client to utilize. Example: ‘4108’ will utilize Client 8 1 to 239...

  • Page 120: Get Queue And Event Sequence Block Counts Block

    MVI69L-MBTCP ♦ CompactLogix™ Platform Reference Communication Module User Manual 7.4.5 Get Queue and Event Sequence Block Counts Block Block 4200: Get Queue and Event Sequence Block Counts Request This block requests the command queue count and the number of pending event sequence commands for all module Clients.

  • Page 121: Command Control Blocks

    MVI69L-MBTCP ♦ CompactLogix™ Platform Reference Communication Module User Manual 7.4.6 Command Control Blocks Block 5001 to 5016: Command Control Command Control blocks place commands into the module’s command priority queue. 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 PCB.

  • Page 122: Add Event With Data For Client Blocks

    Offset Description Block ID 8000 indicates this block will add an event with data of a specific MVI69L-MBTCP client. The last two digits indicate which Client to utilize. Example: ‘8008’ will utilize Client 8 1 to 4 IP address for the server the message is intended. Each digit (0 to 255) of the IP...

  • Page 123: Get Event With Data Status Block

    MVI69L-MBTCP ♦ CompactLogix™ Platform Reference Communication Module User Manual 7.4.8 Get Event with Data Status Block Block 8100: Get Event with Data Status This block requests status data for Event with Data Commands. Block 8100: Request from Processor to Module...

  • Page 124: Get General Module Status Data Block

    MVI69L-MBTCP ♦ CompactLogix™ Platform Reference Communication Module User Manual 7.4.9 Get General Module Status Data Block Block 9250: Get General Module Status Data This block is used to request general module status Block 9250: Request from Processor to Module Offset...
  • Page 125 MVI69L-MBTCP ♦ CompactLogix™ Platform Reference Communication Module User Manual Offset Description Encapsulated Modbus TCP/IP response count: This counter increments each time an Encapsulated Modbus TCP/IP (Service Port 2000) response is sent back to a remote Modbus TCP/IP client command Encapsulated Modbus TCP/IP error sent: This counter increments each time an...

  • Page 126: Set Driver And Command Active Bits Block

    MVI69L-MBTCP ♦ CompactLogix™ Platform Reference Communication Module User Manual 7.4.10 Set Driver and Command Active Bits Block Block 9500: Set Driver and command active bits This block enables and disables the Modbus TCP/IP Clients and Servers of the module. Block 9500: Request from Processor to Module...

  • Page 127: Get Driver And Command Active Bits Block

    MVI69L-MBTCP ♦ CompactLogix™ Platform Reference Communication Module User Manual 7.4.11 Get Driver and Command Active Bits Block Block 9501: Get driver and command active bits This block requests the active state of MBTCP Driver and Client commands. Block 9501: Request from Processor to Module...

  • Page 128: Pass-Through Formatted Block For Functions 6 And 16 With Word Data Block

    5, 6, 15 or 16 command will be passed from the port to the processor using a block identification number that identifies the Function Code received in the incoming command. The MVI69L-MBTCP Add-On Instruction will handle the receipt of all Modbus write functions and to respond as expected to commands issued by the remote Modbus Client device.

  • Page 129: Pass-Through Formatted Block For Functions 6 And 16 With Float Data Block

    MVI69L-MBTCP ♦ CompactLogix™ Platform Reference Communication Module User Manual 7.4.13 Pass-through Formatted Block for Functions 6 and 16 with Float Data Block Block 9957: Pass-through Formatted Block for Functions 6 and 16 with Float Data Block Block 9957: Request from Module to Processor...

  • Page 130: Pass-Through Formatted Block For Function 5

    MVI69L-MBTCP ♦ CompactLogix™ Platform Reference Communication Module User Manual 7.4.14 Pass-through Formatted Block for Function 5 Block 9958: Pass-through Formatted Block for Function 5 Block 9958: Request from Module to Processor Offset Description Block ID 9958 Block ID: 9958 Number of word registers in Modbus data set...

  • Page 131: Pass-Through Formatted Block For Function 15

    MVI69L-MBTCP ♦ CompactLogix™ Platform Reference Communication Module User Manual 7.4.15 Pass-through Formatted Block for Function 15 Block 9959: Pass-through Formatted Block for Function 15 When the module receives a function code 15 in pass-through mode, the module will write the data using block ID 9959 for multiple-bit data. First the bit mask clears the bits to be updated.

  • Page 132: Pass-Through Formatted Block For Function 23

    MVI69L-MBTCP ♦ CompactLogix™ Platform Reference Communication Module User Manual 7.4.16 Pass-through Formatted Block for Function 23 Block 9961: Pass-through Formatted Block for Function 23 Block 9961: Request from Module to Processor Offset Description Block ID 9961 Block ID 9961 Number of word registers in Modbus data set...

  • Page 133: Pass-Through Block For Function 99

    MVI69L-MBTCP ♦ CompactLogix™ Platform Reference Communication Module User Manual 7.4.17 Pass-through Block for Function 99 Block 9970: Pass-through Block for Function 99 Block 9970: Request from Module to Processor Offset Description Block ID 9970 Block ID 9970 4 to 239...

  • Page 134: Set Module Time Using Received Time Block

    MVI69L-MBTCP ♦ CompactLogix™ Platform Reference Communication Module User Manual 7.4.18 Set Module Time Using Received Time Block Block 9972: Set Module Time Using Received Time Block This block will use the time information of the processor to set the module time.

  • Page 135: Pass Module Time To Processor Block

    MVI69L-MBTCP ♦ CompactLogix™ Platform Reference Communication Module User Manual 7.4.19 Pass Module Time to Processor Block Block 9973: Pass Module Time to Processor Block This block will use the time information of the module to set the processor time. Block 9973: Request from Processor to Module...

  • Page 136: Reset Status Block

    MVI69L-MBTCP ♦ CompactLogix™ Platform Reference Communication Module User Manual 7.4.20 Reset Status Block Block 9997: Reset Status Block This block will reset the module and client/server status. Block 9997: Request from Processor to Module Offset Description Block ID 9997 Reset Module status (0=no, else yes)

  • Page 137: Cold-Boot Control Block

    If the CompactLogix processor sends a block number 9999, the firmware will perform a cold-boot operation. The firmware will reload the configuration file and reset all MVI69L-MBTCP memory, error and status data. Block 9999: Request from Processor to Module Offset...

  • Page 138: Ethernet Cable Connections

    In this case, ensure the switch position and cable type agree. 7.5.2 Ethernet Performance Ethernet performance can affect the operation of the MVI69L-MBTCP application ports in the following ways:  Accessing the web interface (refreshing the page, downloading files, and so on) may affect performance ...

  • Page 139: Support, Service & Warranty

    Communication Module User Manual Support, Service & Warranty 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...

Table of Contents