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

ProSoft Technology MVI56E-MCM User Manual

Controllogix platform modbus communication module
Hide thumbs Also See for MVI56E-MCM:
Table of Contents

Advertisement

Quick Links

Download this manual See also: Installation Manual
MVI56E-MCM
ControlLogix Platform
Modbus Communication Module
July 12, 2019
USER MANUAL

Advertisement

Table of Contents
loading
Need help?

Need help?

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

Questions and answers

Related Manuals for ProSoft Technology MVI56E-MCM

Summary of Contents for ProSoft Technology MVI56E-MCM

  • Page 1 MVI56E-MCM ControlLogix Platform Modbus Communication Module July 12, 2019 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

    Important Safety Information North America Warnings Warning - Explosion Hazard - Substitution of components may impair suitability for Class I, Division 2. Warning - Explosion Hazard - When in Hazardous Locations, turn off power before replacing or rewiring modules. Warning - Explosion Hazard - Do not disconnect equipment unless power has been switched off or the area is known to be nonhazardous.

  • Page 5: Table Of Contents

    MVI56E-MCM ♦ ControlLogix Platform Contents Modbus Communication Module User Manual Contents Your Feedback Please ........................2 Content Disclaimer ..........................2 Important Safety Information ....................... 3 Battery Life Advisory ........................... 3 Start Here System Requirements ....................9 Deployment Checklist ....................10 Package Contents ....................
  • Page 6 Enron/Daniel Float Configuration................66 Read and Write Same Modbus Address (Pass Through) ........68 Verify Communication Verifying Master Communications ................69 4.1.1 MVI56E-MCM Status Data Definition as a Master ..........70 4.1.2 Command Error Codes ................... 71 4.1.3 MCM Status Data ....................75 Verify Slave Communications .................
  • Page 7 Backplane Data Transfer..................124 6.2.3 Normal Data Transfer .................... 126 6.2.4 Special Function Blocks ..................128 6.2.5 Data Flow Between MVI56E-MCM Module and ControlLogix Processor ..... 141 Cable Connections ....................144 6.3.1 Ethernet Cable Specifications ................144 6.3.2 Ethernet Cable Configuration ................145 6.3.3...
  • Page 8 Contents MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Support, Service & Warranty Contacting Technical Support ................203 Warranty Information .................... 205 Index Page 8 of 209 ProSoft Technology, Inc.

  • Page 9: Start Here

    (firmware version 10 or higher) with compatible limited voltage power supply and one free slot in the rack for the MVI56E-MCM module. The module requires 800mA of available 5 VDC and 3 mA of available 24 VDC power. ...

  • Page 10: Deployment Checklist

    Most applications can use the Sample Add-On Instruction or Sample Ladder Logic without any edits to the Sample Program. ____________ Which slot number in the chassis will the MVI56E-MCM module occupy? For communication to occur, you must enter the correct slot number in the sample program.
  • Page 11 ____________ For a Modbus Slave, how many words or bits of data do you need to send to the Master device? The MVI56E-MCM module can send data to a Modbus Master as 0x coil data, 1x input coil data, 3x input registers, and 4x holding registers. The...

  • Page 12: Package Contents

    MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Package Contents The following components are included with your MVI56E-MCM module, and are all required for installation and configuration. Important: Before beginning the installation, please verify that all of the following items are present.

  • Page 13: Installing The Module In The Rack

    After you have checked the placement of the jumpers, insert the MVI56E-MCM into the ControlLogix chassis. Use the same technique recommended by Rockwell Automation to remove and install ControlLogix modules.
  • Page 14 Start Here MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Align the module with the top and bottom guides, and then slide it into the rack until the module is firmly against the backplane connector. With a firm, steady push, snap the module into place.

  • Page 15: Creating A New Rslogix 5000 Project

    MVI56E-MCM ♦ ControlLogix Platform Start Here Modbus Communication Module User Manual Creating a New RSLogix 5000 Project Open the F menu, and then choose N Select your ControlLogix controller model. Select the R of your controller. Depending on the revision, there may...

  • Page 16: Before You Import The Add-On Instruction

    Note: You can also set the date and time from the module's Connect to the Module’s Web Page (page 118). Important: The Optional Add-On Instruction supports only the two features listed above. You must use the regular MVI56E-MCM Add-On Instruction for all other features including backplane transfer and Modbus data communication. Page 16 of 209...

  • Page 17: Creating The Module

    MVI56E-MCM ♦ ControlLogix Platform Start Here Modbus Communication Module User Manual 1.6.2 Creating the Module Add the MVI56E-MCM module to the project. In the C window, select I/O C ONTROLLER RGANIZATION ONFIGURATION click the right mouse button to open a shortcut menu. On the shortcut menu,...
  • Page 18 ODULE Parameter Value Enter a description for the module. Example: Modbus ESCRIPTION Communication Module Select D -INT ORMAT Enter the slot number in the rack where the MVI56E-MCM module is located NPUT SSEMBLY NSTANCE NPUT UTPUT SSEMBLY NSTANCE UTPUT...
  • Page 19 MVI56E-MCM ♦ ControlLogix Platform Start Here Modbus Communication Module User Manual Select the R l value for scanning the I/O on the EQUESTED ACKET NTERVA module. This value represents the minimum frequency at which the module will handle scheduled events. This value should not be set to less than 1 millisecond.

  • Page 20: Import The Ladder Rung

    Start Here MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module 1.6.3 Import the Ladder Rung In the C window, expand the T folder and ONTROLLER RGANIZATION ASKS subfolders until you reach the M folder. ROGRAM In the M folder, double-click to open the M ladder.
  • Page 21 MVI56E-MCM ♦ ControlLogix Platform Start Here Modbus Communication Module User Manual This action opens the I dialog box. Click T under MPORT ONFIGURATION to show the controller tags that will be created. Note that if you OUTINE are using a controller revision number of 16 or less, the I...
  • Page 22 Start Here MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module When the import is completed, the new rung with the Add-On Instruction will be visible as shown in the following illustration. The procedure has also imported new User Defined Data Types, Controller Tags, and the Add-On Instruction for your project.

  • Page 23: Adding Multiple Modules (Optional)

    Modbus Communication Module User Manual 1.6.4 Adding Multiple Modules (Optional) Important: If your application requires more than one MVI56E-MCM module in the same project, follow the steps below. In the I/O C folder, click the right mouse button to open a...
  • Page 24 Enter a module identification string. Example: MCM_2. Enter a description for the module. Example: ProSoft Modbus ESCRIPTION Communication Module. Select D -INT. ORMAT Enter the slot number in the rack where the MVI56E-MCM module is located. NPUT SSEMBLY NSTANCE NPUT UTPUT...
  • Page 25 MVI56E-MCM ♦ ControlLogix Platform Start Here Modbus 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 Select the MVI56EMCM_A 2_8.L5X file, and then click...
  • Page 26 Start Here MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module This action opens the I window. Click T under MPORT ONFIGURATION to show the tags that will be imported. OUTINE 10 Associate the I/O connection variables to the correct module. The default...
  • Page 27 MVI56E-MCM ♦ ControlLogix Platform Start Here Modbus Communication Module User Manual 11 Change the default tags MCM and AOI56MCM to avoid conflict with existing tags. In this step, append the string "_2", as shown in the following illustration. 12 Click OK to confirm.

  • Page 28: Adjust The Input And Output Array Sizes (Optional)

    The size of each area you configure must match the Add-On Instruction controller tag array sizes for the R arrays. RITE The MVI56E-MCM sample program is configured for 600 registers of R and 600 registers of W , which is sufficient for most application. This RITE topic describes how to configure user data for applications requiring more than 600 registers of ReadData and WriteData.
  • Page 29 Note: Any changes made to the MCM.CONFIG or WriteData arrays must be downloaded to the MVI56E-MCM module. The use of the MCM.CONTROL.WarmBoot or MCM.CONTROL.ColdBoot bit will cause the MVI56E-MCM module to re- read the configuration from the ControlLogix processor. To modify the W...

  • Page 30: Connecting Your Pc To The Controllogix Processor

    Start Here MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Connecting Your PC to the ControlLogix Processor There are several ways to establish communication between your PC and the ControlLogix processor. The following steps show how to establish communication through the serial interface.

  • Page 31: Downloading The Sample Program To The Processor

    MVI56E-MCM ♦ ControlLogix Platform Start Here Modbus Communication Module User Manual Downloading the Sample Program to the Processor Note: The key switch on the front of the ControlLogix processor must be in the REM or PROG position. If you are not already online with the processor, in RSLogix 5000 open the Communications menu, and then choose D .

  • Page 32: Configuring The Rslinx Driver For The Pc Com Port

    Start Here MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module 1.8.1 Configuring the RSLinx Driver for the PC COM Port When trying to connect serially, if RSLogix is unable to establish communication with the processor, follow these steps. Open RSLinx.
  • Page 33 MVI56E-MCM ♦ ControlLogix Platform Start Here Modbus Communication Module User Manual Click to select the driver, and then click C . This action opens the ONFIGURE Configure RS-232 DF1 Devices dialog box. Click the A button. RSLinx will attempt to configure your ONFIGURE serial port to work with the selected driver.
  • Page 34 MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Page 34 of 209 ProSoft Technology, Inc.

  • Page 35: Configuration As A Modbus Master

    The M controller tags set up the backplane communication between the MVI56E-MCM module and the ControlLogix processor. These settings include register addresses for ReadData and WriteData. You can configure up to 10,000 data registers in the module to exchange data with the ControlLogix processor.

  • Page 36: Moddef Settings

    The MCM.CONFIG.M tag defines the 10,000 data registers to use for read and write data within the MVI56E-MCM module. You will use these data read and write locations in the IntAddress tag within each Master Command Configuration (page 39). The following illustration shows the values from the sample program.

  • Page 37: Port Configuration

    MVI56E-MCM ♦ ControlLogix Platform Configuration as a Modbus Master Modbus Communication Module User Manual The sample configuration values configure the module database to store [0 to 599] in registers 0 to 599, and R 599] in registers RITE 1000 to 1599, as shown in the following illustration.
  • Page 38 Configuration as a Modbus Master MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Parameter Description Enabled , 0 = ENABLE PORT DISABLE PORT Type , 1=S , 2=S ASTER LAVE LAVE WITH NFORMATTED THROUGH , 4= S LAVE FORMATTED...

  • Page 39: Master Command Configuration

    Number of times to retry a failed command request before moving to the next command on the list. Note: To use up to 325 commands, your MVI56E-MCM module needs to have firmware version 3.01 or higher, and your MVI56E-MCM Add-On Instruction needs to be version 2.8 or higher.
  • Page 40 Configuration as a Modbus Master MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Label Description Enable 0 = Disabled Command will not be executed, but can be enabled using command control option in ladder logic. 1 = Enabled Command is enabled and will be sent out to the target device.
  • Page 41 MVI56E-MCM ♦ ControlLogix Platform Configuration as a Modbus Master Modbus Communication Module User Manual Label Description Func Determines the Modbus function code that to issue in the command to the Slave device. Valid values for this field are as follows: 1 = Read Coil Status This will read Modbus addresses 0001 to 9999.

  • Page 42: Other Modbus Addressing Schemes

    Configuration as a Modbus Master MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Label Description DevAddress Specifies the Modbus Slave address for the registers associated with that command. This is the offset address for the Modbus Slave device. With Modbus, to read an address of 40001, what will actually be transmitted out port is Function Code 03 (one byte) with an address of 00 00 (two bytes).
  • Page 43 MVI56E-MCM ♦ ControlLogix Platform Configuration as a Modbus Master Modbus Communication Module User Manual Why does my Slave show addressing such as 400,001 or 301,345? For the 6 digit addressing, use the same function codes and configuration as configured above, just the starting address has changed.

  • Page 44: Master Command Examples

    Configuration as a Modbus Master MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Master Command Examples 2.3.1 Read Holding Registers 4x (Modbus Function Code 3) The 4x holding registers are used for Analog Values such as Pressure, Temperature, Current, and so on. These are 16-bit register values, but they can also store Floating-Point Data Handling (Modbus Master) (page 49).

  • Page 45: Read Coil Status 0X (Modbus Function Code 1)

    16320. IntAddress 16320 of the module memory will be copied into the tag MCM.DATA.R [20] because 16320 represents a bit address within the memory of the MVI56E-MCM module (16320 / 16 = register 1020). Count = 160 Reads 160 consecutive bits from the Slave device.

  • Page 46: Read Input Status 1X (Modbus Function Code 2)

    Configuration as a Modbus Master MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module 2.3.4 Read Input Status 1x (Modbus Function Code 2) Use this command to read Input Coils from a Slave device. These are single bit addresses within a Modbus Slave device. Unlike Coils 0xxx, the Input Coils are Read Only values and cannot be written to by a Modbus Master device.

  • Page 47: Force (Write) Multiple Coils 0X (Modbus Function Code 15)

    Description Enable = 2 The module will send the command to the Slave device only when the data associated within the IntAddress of the MVI56E-MCM module memory has changed. IntAddress = 320 Writes the data in bit 320 of the module memory to the Slave device.

  • Page 48: Preset (Write) Single Register 4X (Modbus Function Code 6)

    Configuration as a Modbus Master MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module 2.3.7 Preset (Write) Single Register 4x (Modbus Function Code 6) Used to write to Modbus Holding Registers 4xxxx, this function code will write a single register to the Slave device. The Enable code can be set to a value of 1 for a continuous write, or a value of 2 to write the data to the Slave device only when the data associated with the IntAddress field has changed.

  • Page 49: Floating-Point Data Handling (Modbus Master)

    MVI56E-MCM ♦ ControlLogix Platform Configuration as a Modbus Master Modbus Communication Module User Manual Label Description IntAddress =30 Writes the data from Internal Address 30 of the module memory to the Slave device. Based on the MCM.CONFIG.M configuration, this will write the data from MCM.DATA.W...
  • Page 50 Configuration as a Modbus Master MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Parameter Value Description Swap Swap Code Description None - No Change is made in the byte ordering (1234 = 1234) Words - The words are swapped (1234=3412) Words &...

  • Page 51: Read Multiple Floating-Point Registers

    MVI56E-MCM ♦ ControlLogix Platform Configuration as a Modbus Master Modbus Communication Module User Manual 2.4.2 Read Multiple Floating-Point Registers The following table is an example to read Multiple Floating-Point values and device addresses. The table shows 7 consecutive floating-point values (14 Modbus addresses).

  • Page 52: Write Floats To Slave Device

    ControlLogix processor, into the MCM.DATA.W array used RITE by the MVI56E-MCM module. Below is an example. The length of this COP statement must now be 14. This will COP as many of the MCM_F values required to occupy the MCM.D...

  • Page 53: Read Floats With Single Modbus Register Address (Enron/Daniel Float)

    MVI56E-MCM ♦ ControlLogix Platform Configuration as a Modbus Master Modbus Communication Module User Manual 2.4.4 Read Floats with Single Modbus Register Address (Enron/Daniel Float) Some Modbus Slave devices use a single Modbus address to store 32 bits of data. This type of data is typically referred to as Enron or Daniel Floating-Point.

  • Page 54: Write To Enron/Daniel Floats

    2 bytes of data to a non Enron/Daniel floating-point register. First, copy the floating-point data from the ControlLogix processor into the MCM.DATA.W array used by the MVI56E-MCM module. Below is RITE an example. The length of this COP statement must now be 14. This will COP as many of...

  • Page 55: Command Control And Event Command

    MVI56E-MCM ♦ ControlLogix Platform Configuration as a Modbus Master Modbus Communication Module User Manual Based on the IntAddress and the configuration within the MCM.CONFIG.M section for WriteStartReg and WriteRegCount, the data from the tag MCM.DATA.W [6] will be written to Modbus RITE addresses 47001 to 47007 of the Slave device node #1.

  • Page 56: Command Control

    Configuration as a Modbus Master MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module 2.5.1 Command Control Command Control allows you to issue a command already defined in the Master command list (but disabled) and enable that command for a single pass.

  • Page 57: Event Command

    You do not need to define Event Commands in the regular command list. Event Command adds a command to the top of the MVI56E-MCM module’s command queue that is not defined within the command list. Within an Event Command block, you define a Modbus command to add to the queue.
  • Page 58 Configuration as a Modbus Master MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Note: For RSLogix version 15 and lower, the ladder logic used for the Event Command blocks is contained in _WriteControl rung 5 and _ReadControl rung 4 within the sample ladder file.

  • Page 59: Configuration As A Modbus Slave

    RITE the Master. Because the data transfer of the MVI56E-MCM module cannot be bidirectional, when the Master issues a Modbus Write command in Pass-Through mode, the MVI56E-MCM module builds a special block of information. This block is then parsed by the ladder logic, and the value written from the Modbus Master is then updated in the MCM.DATA.W...

  • Page 60: Moddef Settings

    This section specifies which of the MVI56E-MCM module’s 10,000 registers of memory to send from the ControlLogix processor to the MVI56E-MCM module (WriteData) and which registers to send from the MVI56E-MCM module to the ControlLogix processor (ReadData). The W...

  • Page 61: Modbus Memory Map

    MVI56E-MCM ♦ ControlLogix Platform Configuration as a Modbus Slave Modbus Communication Module User Manual With the sample configuration, the following is the layout of the tags and addressing. The sample configuration values configure the module database for 599] to be stored in the module memory at register 0 to 599,...
  • Page 62 Configuration as a Modbus Slave MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module MVI Address 0xxx 1xxxx 3xxxx 4xxxx Tag Address 0801 to 0816 10801 to 10816 30051 40051 WriteData[50] 1601 to 1616 11601 to 11616 30101 40101 WriteData[100]...

  • Page 63: Customizing The Memory Map

    Description BitInOffset Defines the starting address within the module for 1xxxx Modbus addressing. A value of 0 sets 10001 to 10016 as address 0 in the MVI56E-MCM module. WordInOffset Defines the starting address within the module memory for 3xxxx registers.
  • Page 64 Configuration as a Modbus Slave MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module MVI Address 0xxx 1xxxx 3xxxx 4xxxx Tag Address 1200 3201 to 3216 40191 ReadData[200] 1500 8001 to 8016 40491 ReadData[500] 1598 9569 to 9584 40589 ReadData[598]...

  • Page 65: Slave Configuration

    Floating-Point Data Handling (Modbus Slave) In most applications, the use of floating-point data requires no special handling. Copy the data to and from the MVI56E-MCM module with a tag configured as a data type REAL in the ControlLogix processor. Each floating-point value will occupy 2 registers on the Modbus network.

  • Page 66: Enron/Daniel Float Configuration

    RITE the length of the COP statement must be set to a value of 20. To copy data from the MVI56E-MCM module to a floating-point tag within the ControlLogix processor Configure a tag within the ControlLogix processor as shown.
  • Page 67 MVI56E-MCM ♦ ControlLogix Platform Configuration as a Modbus Slave Modbus Communication Module User Manual Here is a sample configuration for the module. With the above configuration, this would be the addressing for the module. Module Address Modbus Address Tag Address 47001 MCM.DATA.WriteData[100]...

  • Page 68: Read And Write Same Modbus Address (Pass Through)

    WriteData array. The basic theory of pass through is that the ladder logic will constantly be updating values in the MVI56E-MCM module memory using the WriteData array. When the Master issues a Write command, the module will build a special block of data.

  • Page 69: Verify Communication

    The Modbus Master commands are configured, now it is time to verify that these commands are working correctly. Within the MVI56E-MCM module, there are a couple of ways of checking to see if the commands that have been configured in the previous location are working correctly.

  • Page 70: Mvi56E-Mcm Status Data Definition As A Master

    User Manual Modbus Communication Module 4.1.1 MVI56E-MCM Status Data Definition as a Master This section contains a description of the members present in the MCM.STATUS object. This data is transferred from the module to the processor as part of each read block using the module's input image.

  • Page 71: Command Error Codes

    (325), then 325 registers will be placed into the module memory. Note: To use up to 325 commands, your MVI56E-MCM module needs to have firmware version 3.01 or higher, and your MVI56E-MCM Add-On Instruction needs to be version 2.8 or higher.
  • Page 72 Verify Communication MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module To be useful in the application, these error codes must be placed within the MCM.DATA.R array. Once again, the configuration in the MCM.CONFIG.M section for , and R determine which of the 10,000 registers...
  • Page 73 Timeout waiting for response after request Incorrect Slave address in response Incorrect function code in response Invalid CRC/LRC value in response "Module Communication Errors" are generated by the MVI56E-MCM module, and indicate communication errors with the Slave device. ProSoft Technology, Inc. Page 73 of 209...
  • Page 74 Verify Communication MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Error Code -11 indicates that the module is transmitting a message on the communications wire. However, it is not receiving a response from the addressed Slave. This error is typically caused by one or more of the following conditions.

  • Page 75: Mcm Status Data

    Read Data (MCM.M and MCM.M TART 4.1.3 MCM Status Data Status information can also be obtained from the MVI56E-MCM module by checking the MCM.STATUS.P location. Below is a sample. If your system is working correctly, you will see C EQUESTS and R all incrementing together.

  • Page 76: Verify Slave Communications

    ESPONSES responded to a request message from the Modbus Master. 4.2.1 MVI56E-MCM Status Data Definition as a Slave This section contains a description of the members present in the MCM.STATUS object. This data is transferred from the module to the processor as part of each read block using the module's input image.
  • Page 77 MVI56E-MCM ♦ ControlLogix Platform Verify Communication Modbus Communication Module User Manual Offset Content Description Parse Block Count This field contains the total number of blocks successfully parsed that were received from the processor. Command Event This field contains the total number of command event Block Count blocks received from the processor.
  • Page 78 MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Page 78 of 209 ProSoft Technology, Inc.

  • Page 79: Diagnostics And Troubleshooting

    MVI56E-MCM ♦ ControlLogix Platform Diagnostics and Troubleshooting Modbus Communication Module User Manual Diagnostics and Troubleshooting In This Chapter  Ethernet LED Indicators ................ 79  Clearing a Fault Condition ..............81  Troubleshooting the LEDs ..............82  Setting Up ProSoft Configuration Builder ..........83 ...

  • Page 80: Scrolling Led Status Indicators

    Diagnostics and Troubleshooting MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module 5.1.1 Scrolling LED Status Indicators The scrolling LED display indicates the module’s operating status as follows: Initialization Messages Code Message Boot / DDOK Module is initializing Ladd Module is waiting for required module configuration data from...

  • Page 81: Non-Scrolling Led Status Indicators

    May also be OFF during configuration download. GREEN The MVI56E-MCM is working normally. The most common cause is that the module has detected a communication error during operation of an application port. The following conditions may also cause a RED LED: ...

  • Page 82: Troubleshooting The Leds

    Diagnostics and Troubleshooting MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Troubleshooting the LEDs Use the following troubleshooting steps if problems occur when the module is powered up. If these steps do not resolve the problem, please contact ProSoft Technology Technical Support.

  • Page 83: Setting Up Prosoft Configuration Builder

    UN AS . Follow the instructions that appear on the screen. DMINISTRATOR If you want to find additional software specific to your MVI56E-MCM, enter the model number into the website search box and press the Enter key. ProSoft Technology, Inc.

  • Page 84: Setting Up The Project

    Diagnostics and Troubleshooting MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module 5.4.2 Setting Up the Project To begin, start P (PCB). ONFIGURATION UILDER If you have used other Windows configuration tools before, you will find the screen layout familiar. PCB’s window consists of a tree view on the left, and an information pane and a configuration pane on the right side of the window.

  • Page 85: Assigning An Ip Address In The Project

    ProSoft Configuration Builder window. 5.4.3 Assigning an IP Address in the Project In this step, you assign an IP address for the MVI56E-MCM module using ProSoft Configuration Builder. This becomes the permanent IP address for the module after you download the configuration to the module (refer to Downloading the Project to the Module (page 103)).
  • Page 86 User Manual Modbus Communication Module Start ProSoft Configuration Builder. Select the MVI56E-MCM icon, and then click the [+] symbol to expand the MVI56E-MCM tree. Right-click ETHERNET CONFIGURATION to open the shortcut menu. On the shortcut menu, select CONFIGURE. This opens the EDIT-WATTCP dialog box.

  • Page 87: Connecting Your Pc To The Module

    The IP addresses and slot numbers of any 1756-ENBT modules in the path  The slot number of the MVI56E-MCM in the destination ControlLogix chassis (the last ENBTx and chassis in the path). If you do not have this information, you can still assign the IP address to the module (refer to Assigning a Temporary IP Address (page 99)).
  • Page 88 ENBT (Ethernet/IP) module. Each row corresponds to a physical rack in the CIP path.  If the MVI56E-MCM module is located in the same rack as the first 1756- ENBT module, select R . 1 and configure the associated parameters.
  • Page 89 MVI56E-MCM ♦ ControlLogix Platform Diagnostics and Troubleshooting Modbus Communication Module User Manual  If the MVI56E-MCM is available in a remote rack (accessible through ControlNet or Ethernet/IP), include all racks (by using the A button). Parameter Description Source Module Source module type. This field is automatically selected depending on the destination module of the last rack (1756-CNB or 1756-ENBT).
  • Page 90 MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Example 1: Local Rack Application For this example, the MVI56E-MCM module is located in the same rack as the 1756-ENBT that is connected to the PC. MVI56E Module 1756-ENBT Rack 1...
  • Page 91 MVI56E-MCM ♦ ControlLogix Platform Diagnostics and Troubleshooting Modbus Communication Module User Manual In the Diagnostics window, click the S button. ONNECTION In the Select Connection Type dropdown list, choose 1756-ENBT. The default path appears in the text box, as shown in the following illustration.
  • Page 92 Diagnostics and Troubleshooting MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Configure the path as shown in the following illustration, and click CIP P to build the path in text format. ONSTRUCT Click OK to close the CIPconnect Path Editor and return to the Connection Setup dialog box.
  • Page 93 Connection Set up dialog box. The Diagnostics menu is now connected through CIPconnect. Example 2: Remote Rack Application For this example, the MVI56E-MCM module is located in a remote rack accessible through ControlNet, as shown in the following illustration. 1756-CNB...
  • Page 94 1756-ENBT IP=192.168.0.100 Rack 2 Slot Module Network Address 1756-CNB Node = 2 MVI56E-MCM In ProSoft Configuration Builder, right-click the MVI56E-MCM icon to open a shortcut menu. On the shortcut menu, choose D IAGNOSTICS Page 94 of 209 ProSoft Technology, Inc.
  • Page 95 MVI56E-MCM ♦ ControlLogix Platform Diagnostics and Troubleshooting Modbus Communication Module User Manual In the Diagnostics window, click the S button. ONNECTION In the Select Connection Type dropdown list, choose 1756-ENBT. The default path appears in the text box, as shown in the following illustration.
  • Page 96 Diagnostics and Troubleshooting MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Configure the path as shown in the following illustration, and click CIP P to build the path in text format. ONSTRUCT Click OK to close the CIPconnect Path Editor and return to the Connection Setup dialog box.
  • Page 97 MVI56E-MCM ♦ ControlLogix Platform Diagnostics and Troubleshooting Modbus Communication Module User Manual Click T to verify that the physical path is available. The ONNECTION following message should be displayed upon success. Click OK to close the Test Connection pop-up and then click C ONNECT close the Connection Set up dialog box.

  • Page 98: Using Rswho To Connect To The Module

    You need to have RSLinx installed on your PC to use this feature. You also need an ENBT module set up in the rack. For information on setting up the ENBT module, see Using CIPconnect to Connect to the Module. In the tree view in ProSoft Configuration Builder, right-click the MVI56E-MCM module. From the shortcut menu, choose D...

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

    To use ProSoft Configuration Builder, arrange the Ethernet connection so that there is no router/ layer 3 switch between the computer and the module OR reconfigure the router/ layer 3 switch to allow routing of the UDP broadcast messages. In the tree view in ProSoft Configuration Builder, select the MVI56E-MCM module. ProSoft Technology, Inc.
  • Page 100 Diagnostics and Troubleshooting MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Click the right mouse button to open a shortcut menu. On the shortcut menu, choose D IAGNOSTICS In the Diagnostics window, click the S button. ONNECTION Page 100 of 209...
  • Page 101 MVI56E-MCM ♦ ControlLogix Platform Diagnostics and Troubleshooting Modbus Communication Module User Manual In the Connection Setup dialog box, click the B ) button to ROWSE EVICE open the ProSoft Discovery Service. Right-click the module icon, and then choose A SSIGN EMPORARY The module’s default IP address is usually 192.168.0.250.
  • Page 102 Diagnostics and Troubleshooting MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Close the ProSoft Discovery Service window. Enter the temporary IP in the Ethernet address field of the Connection Setup dialog box, then click the button to verify that the module is accessible with the ONNECTION current settings.

  • Page 103: Downloading The Project To The Module

    In order for the module to use the settings you configured, you must download (copy) the updated Project file from your PC to the module. In the tree view in ProSoft Configuration Builder, right-click the MVI56E-MCM icon to open a shortcut menu.

  • Page 104: Using The Diagnostics Menu In Prosoft Configuration Builder

    Diagnostics and Troubleshooting MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module If the Test Connection procedure fails, you will see an error message. To correct the error, follow these steps. Click OK to dismiss the error message. In the Download dialog box, click B...
  • Page 105 MVI56E-MCM ♦ ControlLogix Platform Diagnostics and Troubleshooting Modbus Communication Module User Manual On the shortcut menu, choose D IAGNOSTICS In the Diagnostics window, click the S button. ONNECTION In the Connection Setup dialog box, click the T button to ONNECTION verify that the module is accessible with the current settings.
  • Page 106 Diagnostics and Troubleshooting MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module ® You can also use CIPconnect to connect to the module through a 1756- ENBT card by choosing 1756-ENBT in the S list ELECT ONNECTION Refer to Using CIPconnect to Connect to the Module for information on how to construct a CIP path.
  • Page 107 (using the grey cable) or directly between your computer and the module (using the red cable). If you are still not able to establish a connection, contact ProSoft Technology for assistance. ProSoft Technology, Inc.

  • Page 108: The Diagnostics Menu

    Diagnostics and Troubleshooting MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module 5.7.1 The Diagnostics Menu The Diagnostics menu, available through the Ethernet configuration port for this module, is arranged as a tree structure, with the Main menu at the top of the tree, and one or more submenus for each menu command.

  • Page 109: Monitoring Database Information

    During normal operation, the read, write, and parsing values should increment continuously, while the error value should not increment. The status values on this menu correspond with members of the MVI56E-MCM Status Data Definition (page 160). 5.7.3 Monitoring Database Information Use the Database menu to view the contents of the MVI56E-MCM module’s...

  • Page 110: Monitoring General Information

    Diagnostics and Troubleshooting MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Float Hexadecimal Use the scroll bar on the right edge of the window to view each page (100 words) of data. 5.7.4 Monitoring General Information Use the General Menu to view module version information.

  • Page 111: Monitoring Modbus Port Information

    5.7.5 Monitoring Modbus Port Information Use the Modbus Port 1 and Modbus Port 2 menus to view the information for each of the MVI56E-MCM module’s Modbus application ports. Port Configuration Use the Port Configuration menu to view configuration settings for Modbus Port 1 and Modbus Port 2.

  • Page 112: Data Analyzer

    Diagnostics and Troubleshooting MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Port Status Use the Port Status menu to view status for Modbus Port 1 and Modbus Port 2. During normal operation, the number of requests and responses should increment, while the number of errors should not change.
  • Page 113 MVI56E-MCM ♦ ControlLogix Platform Diagnostics and Troubleshooting Modbus Communication Module User Manual The following illustration shows an example of the Data Analyzer output. The Data Analyzer can display the following special characters. Character Definition Data enclosed in these characters represent data received on the port.
  • Page 114 Diagnostics and Troubleshooting MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Data Analyzer Tips For most applications, HEX is the best format to view the data, and this does include ASCII based messages (because some characters will not display in the Diagnostics window, and by capturing the data in HEX, we can figure out what the corresponding ASCII characters are supposed to be).
  • Page 115 MVI56E-MCM ♦ ControlLogix Platform Diagnostics and Troubleshooting Modbus Communication Module User Manual To begin the display of the communications data, start the Data Analyzer. When the Data Analyzer is running, you should see something like this. The <R+> means that the module is transitioning the communications line to a transmit state.

  • Page 116: Reading Status Data From The Module

    Modbus Communication Module Reading Status Data from the Module The MVI56E-MCM module returns a 33-word Status Data block that can be used to determine the module’s operating status. This data is located in the module’s database at registers 15270 to 15302 and at the location specified in the configuration.

  • Page 117: Configuration Error Codes

    MVI56E-MCM ♦ ControlLogix Platform Diagnostics and Troubleshooting Modbus Communication Module User Manual Configuration Error Codes During module configuration download, the OK and APP LEDs will cycle through various states. If the OK LED remains RED and the APP LED remains OFF or RED for a long period of time, look at the configuration error words in the configuration request block.
  • Page 118 Note: If the APP, BP ACT and OK LEDs blink at a rate of every one-second, this indicates a serious problem with the module. Call ProSoft Technology Support to arrange for repairs. Page 118 of 209 ProSoft Technology, Inc.

  • Page 119: Connect To The Module's Web Page

    MVI56E-MCM ♦ ControlLogix Platform Diagnostics and Troubleshooting Modbus Communication Module User Manual 5.10 Connect to the Module’s Web Page The module's internal web server provides access to module status, diagnostics, and firmware updates. In ProSoft Discovery Service, select the module to configure, and then click the right mouse button to open a shortcut menu.
  • Page 120 MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Page 120 of 209 ProSoft Technology, Inc.

  • Page 121: Reference

    Modbus Master or Slave, sharing the same user-controlled, 10,000-word database. The two modules are functionally the same. The MVI56E-MCM is designed for standard process applications. The MVI56E-MCMXT is designed for the Logix- XT™ control platform, allowing it to operate in extreme environments. It can tolerate higher operating temperatures, and it also has a conformal coating to protect it from harsh or caustic conditions.

  • Page 122: General Specifications

    8: Diagnostics (Slave Only, Registers (Slave Only) Responds to Subfunction 00) 6.1.3 Functional Specifications The MVI56E-MCM will operate on a Local or Remote rack (For remote rack applications with smaller data packet size please refer to the MVI56E-MCMR product)  ®...

  • Page 123: Hardware Specifications

    Note: To use up to 325 commands, your MVI56E-MCM module needs to have firmware version 3.01 or higher, and your MVI56E-MCM Add-On Instruction needs to be version 2.8 or higher.

  • Page 124: Functional Overview

    Modbus is a Master/Slave protocol. The Master establishes a connection to the remote Slave. When the connection is established, the Master sends the Modbus commands to the Slave. The MVI56E-MCM module can work as a Master and as a Slave.
  • Page 125 Modbus Communication Module User Manual The following illustration shows the data transfer method used to move data between the ControlLogix processor, the MVI56E-MCM module and the Modbus Network. As shown in the illustration above, all data transferred between the module and the processor over the backplane is through the input and output images.

  • Page 126: Normal Data Transfer

    15999 Data contained in this database is paged through the input and output images by coordination of the ControlLogix ladder logic and the MVI56E-MCM module's program. Up to 248 words of data can be transferred from the module to the processor at a time.
  • Page 127 MVI56E-MCM ♦ ControlLogix Platform Reference Modbus Communication Module User Manual Word Offset Description Length 209 to 210 Run Number 211 to 217 Port 1 Error Status 218 to 224 Port 2 Error Status 225 to 230 Data Transfer Status Port 1 Current Error/Index...

  • Page 128: Special Function Blocks

    Reference MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module 6.2.4 Special Function Blocks Special function blocks are optional blocks used to control the module or request special data from the module. The current version of the software supports the following special function blocks: ...
  • Page 129 MVI56E-MCM ♦ ControlLogix Platform Reference Modbus Communication Module User Manual When the command receives the block, it will process it and place it in the command queue. The module will respond to each command block with a read block. The following table describes the format of this block.
  • Page 130 Reference MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Block Request from Processor to Module Word Offset Description Length 3002 to 3003 or 3102 to 3103 1 to 247 Spare The module will recognize the request by receiving the special write block code...
  • Page 131 MVI56E-MCM ♦ ControlLogix Platform Reference Modbus Communication Module User Manual Block Request from Processor to Module Word Offset Description Length 3001 or 3101 Number of Slaves in Block 2 to 201 Slave indexes 202 to 247 Spare The module will respond with a block with the same identification code received and indicate the number of Slaves acted on with the block.
  • Page 132 Reference MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Block Request from Processor to Module Word Offset Description Length 5001 to 5006 or 5101 to 5106 Command index (MCM.CONFIG.P [command ASTER index value]) Command index (MCM.CONFIG.P [command ASTER index value]) Command index (MCM.CONFIG.P...
  • Page 133 MVI56E-MCM ♦ ControlLogix Platform Reference Modbus Communication Module User Manual Configuration Data Transfer When the module performs a restart operation, it will request configuration information from the ControlLogix processor. This data is transferred to the module in specially formatted write blocks (output image). The module will poll for each block by setting the required write block number in a read block (input image).
  • Page 134 Reference MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Word Offset Description Length Port 1 Configuration Error Code Port 2 Configuration Error Code 5 to 248 Spare -2 or -3 Any errors must be corrected before the module will start operating.
  • Page 135 MVI56E-MCM ♦ ControlLogix Platform Reference Modbus Communication Module User Manual Word Offset Description Length 185 to 192 Command Definition 193 to 200 Command Definition Pass-Through Blocks The Pass-through Mode allows a Modbus Slave port to pass write commands received from a host directly across the backplane to the ControlLogix processor for handling by ladder logic.
  • Page 136 Reference MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Formatted Pass-Through Blocks (9956 to 9959) If one or more of the Slave Ports on the module are configured for the Formatted Pass-through mode, the module will pass blocks with identification codes of 9956 to 9959 to the processor for each received write command.
  • Page 137 MVI56E-MCM ♦ ControlLogix Platform Reference Modbus Communication Module User Manual The ladder logic will be responsible for parsing and copying the received message and performing the proper control operation as expected by the Master device. The processor must then respond to the Pass-through block with a write block with the following format.
  • Page 138 Spare MVI56E-MCM Remote Master Control The MVI56E-MCM can receive special function block codes from a remote Master on the network to control the module, using specific values written to regions of this block. The module can respond to the following requests: ...
  • Page 139 MVI56E-MCM ♦ ControlLogix Platform Reference Modbus Communication Module User Manual Error Code Description No error, transfer successful Error transferring general configuration information. Error transferring Modbus Port 1 Master command list Error transferring Modbus Port 2 Master command list Ladder logic must handle the 9997 command. No ladder logic is required for the warm or cold boot commands.
  • Page 140 Reference MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Word Offset Description Length 58 to 65 Command Definition 66 to 73 Command Definition 74 to 81 Command Definition 82 to 89 Command Definition 90 to 97 Command Definition 98 to 105...

  • Page 141: Data Flow Between Mvi56E-Mcm Module And Controllogix Processor

    Processor The following topics describe the flow of data between the ControlLogix processor, MVI56E-MCM module, and nodes on the Modbus network. Each port on the module can be configured to emulate a Modbus Master device or a Modbus Slave device, independently from the configuration of the other port.
  • Page 142 The following illustration shows the data flow for a Slave Port with pass-through enabled: Master Driver In the Master mode, the MVI56E-MCM module issues read or write commands to Slave devices on the Modbus network. These commands are user configured in the module via the Master Command List received from the ControlLogix processor or issued directly from the ControlLogix processor (event command control).
  • Page 143 MVI56E-MCM ♦ ControlLogix Platform Reference Modbus Communication Module User Manual The following illustration describes the flow of data to and from the module. The Master driver obtains configuration data from the ControlLogix processor. The configuration data obtained includes the number of commands and the Master Command List.

  • Page 144: Cable Connections

    Cable Connections The application ports on the MVI56E-MCM module support RS-232, RS-422, and RS-485 interfaces. Please inspect the module to ensure that the jumpers are set correctly to correspond with the type of interface you are using.

  • Page 145: Ethernet Cable Configuration

    MVI56E-MCM ♦ ControlLogix Platform Reference Modbus Communication Module User Manual Ethernet cabling is like U.S. telephone cables, except that it has eight conductors. Some hubs have one input that can accept either a straight-through or crossover cable, depending on a switch position. In this case, you must ensure that the switch position and cable type agree.

  • Page 146: Application Port(S)

    Reference MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module 6.3.4 RS-232 Application Port(s) When the RS-232 interface is selected, the use of hardware handshaking (control and monitoring of modem signal lines) is user definable. If no hardware handshaking will be used, here are the cable pinouts to connect to the port.
  • Page 147 MVI56E-MCM ♦ ControlLogix Platform Reference Modbus Communication Module User Manual RS-232: Null Modem Connection (Hardware Handshaking) This type of connection is used when the device connected to the module requires hardware handshaking (control and monitoring of modem signal lines). RS-232: Null Modem Connection (No Hardware Handshaking) This type of connection can be used to connect the module to a computer or field device communication port.

  • Page 148: Application Port(S)

    Reference MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module 6.3.5 RS-422 The RS-422 interface requires a single four or five wire cable. The Common connection is optional, depending on the RS-422 network devices used. The cable required for this interface is shown below: 6.3.6 RS-485 Application Port(s)

  • Page 149: Db9 To Rj45 Adaptor (Cable 14)

    MVI56E-MCM ♦ ControlLogix Platform Reference Modbus Communication Module User Manual Note: Terminating resistors are generally not required on the RS-485 network, unless you are experiencing communication problems that can be attributed to signal echoes or reflections. In these cases, installing a 120-ohm terminating resistor between pins 1 and 8 on the module connector end of the RS-485 line may improve communication quality.

  • Page 150: Mvi56E-Mcm Database Definition

    MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module MVI56E-MCM Database Definition This section contains a listing of the internal database of the MVI56E-MCM module. This information can be used to interface other devices to the data contained in the module. Register Range...

  • Page 151: Mvi56E-Mcm Configuration Data

    User Manual MVI56E-MCM Configuration Data This section contains listings of the MVI56E-MCM module's database related to the module's configuration. This data is available to any node on the network and is read from the ControlLogix processor when the module first initializes.

  • Page 152: Port 1 Setup

    Reference MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module 6.5.2 Port 1 Setup Register Content Description 10,010 Enable This parameter defines if this Modbus Port will be used. If the parameter is set to 0, the port is disabled. A value of 1 enables the port.
  • Page 153 MVI56E-MCM ♦ ControlLogix Platform Reference Modbus Communication Module User Manual Register Content Description 10,023 Use CTS Line This parameter specifies if the CTS modem control line is to be used. If the parameter is set to 0, the CTS line will not be monitored. If the parameter is set to 1, the CTS line will be monitored and must be high before the module will send data.
  • Page 154 Reference MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Register Content Description 10,032 Response Timeout This parameter represents the message response timeout period in 1-millisecond increments. This is the time that a port configured as a Master will wait before re-transmitting a command if no response is received from the addressed Slave.

  • Page 155: Port 2 Setup

    MVI56E-MCM ♦ ControlLogix Platform Reference Modbus Communication Module User Manual 6.5.3 Port 2 Setup Register Content Description 10,040 Enable This parameter defines if this Modbus Port will be used. If the parameter is set to 0, the port is disabled. A value of 1 enables the port.
  • Page 156 Reference MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Register Content Description 10,052 Minimum Response This parameter specifies the minimum number of Time milliseconds to delay before responding to a request message. This pre-send delay is applied before the RTS on time. This may be required when communicating with slow devices.

  • Page 157: Port 1 Commands

    Command #325 Command #325 data set Note: To use up to 325 commands, your MVI56E-MCM module needs to have firmware version 3.01 or higher, and your MVI56E-MCM Add-On Instruction needs to be version 2.8 or higher. Earlier versions support up to 100 commands.

  • Page 158: Port 2 Commands

    Reference MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module 6.5.5 Port 2 Commands Register Content Description 12,670 to 12,677 Command #1 This set of registers contains the parameters for the first command in the Master command list. Refer to Master Command Configuration (page 39).
  • Page 159 MVI56E-MCM ♦ ControlLogix Platform Reference Modbus Communication Module User Manual Register Content Description 15,290 Port 2 Responses This field contains the total number of messages received on the port. 15,291 Port 2 Errors Sent This field contains the total number of message errors sent out the port.

  • Page 160: Command Control

    Reference MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module 6.5.7 Command Control Register Content Description 15,400 Command Code Enter one of the valid control command codes in this register to control the module (9997, 9998, or 9999). MVI56E-MCM Status Data Definition This section contains a description of the members present in the MCM.STATUS...

  • Page 161: Mvi56E-Mcm User Defined Data Types

    For a Master Port, this field contains the index number of the previous most recently executed command that failed. MVI56E-MCM User Defined Data Types 6.7.1 MCMModuleDef This object contains the data types that apply to the operation of the module.

  • Page 162: Mcmconfig

    Master commands for Port 2 (ignore if port is configured for slave mode) Note: To use up to 325 commands, your MVI56E-MCM module needs to have firmware version 3.01 or higher, and your MVI56E-MCM Add-On Instruction needs to be version 2.8 or higher.
  • Page 163 MVI56E-MCM ♦ ControlLogix Platform Reference Modbus Communication Module User Manual Name Data Type Description FloatStart Register offset in message for floating-point data FloatOffset Internal DB offset to start of floating-point data Protocol 0 = Modbus RTU, 1 = Modbus ASCII Baudrate Baudrate for port (110 to 115.2K)

  • Page 164: Mcmdata

    Reference MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Name Data Type Description PollInt Minimum number of seconds between issuance of command (0-65535 Sec) Count Number of registers associated with the command Swap Swap code used with command Node...
  • Page 165 MVI56E-MCM ♦ ControlLogix Platform Reference Modbus Communication Module User Manual MCMPortErrors This object stores the port statistics for an MVI56E-MCM port. Name Data Type Description CmdReq Total number of command list requests sent CmdResp Total number of command list responses...

  • Page 166: Mcmcontrol

    Reference MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module 6.7.5 MCMCONTROL This object contains the attributes to define a Master command. An array of these objects is used for each port. Name Data Type Description WarmBoot BOOL Warm Boot...
  • Page 167 MVI56E-MCM ♦ ControlLogix Platform Reference Modbus Communication Module User Manual EventCmd Name Data Type Description EventCmdTrigger BOOL Trigger for event command. User ladder must set this bit to initiate event command EventCmdPending BOOL Set after the ladder has sent an event cmd to...

  • Page 168: Mcmutil

    Modbus Protocol Specification The following pages give additional reference information regarding the Modbus protocol commands supported by the MVI56E-MCM. 6.8.1 Commands Supported by the Module The format of each command in the list depends on the Modbus Function Code being executed.

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

    MVI56E-MCM ♦ ControlLogix Platform Reference Modbus Communication Module User Manual 6.8.2 Read Coil Status (Function Code 01) Query This function allows the user to obtain the ON/OFF status of logic coils used to control discrete outputs from the addressed Slave only. Broadcast mode is not supported with this function code.

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

    Reference MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module The status of coils 20 to 27 is shown as CD(HEX) = 1100 1101 (Binary). Reading left to right, this shows that coils 27, 26, 23, 22, and 20 are all on. The other coil data bytes are decoded similarly.

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

    MVI56E-MCM ♦ ControlLogix Platform Reference Modbus Communication Module User Manual Func Byte Data Discrete Input Data Discrete Input Data Discrete Input Error Check Field Count 10197 to 10204 10205 to 10212 10213 to 10218 The status of inputs 10197 to 10204 is shown as AC (HEX) = 10101 1100 (binary).

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

    Reference MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Because the Slave interface device is normally serviced at the end of the controller's scan, the data reflects the register content at the end of the scan. Some Slaves limit the quantity of register content provided each scan; thus for large register quantities, multiple transmissions are made using register content from sequential scans.

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

    MVI56E-MCM ♦ ControlLogix Platform Reference Modbus Communication Module User Manual 6.8.6 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).

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

    Reference MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module 6.8.7 Preset Single Register (Function Code 06) Query This Function Code allows you to modify the contents of a Modbus 4x range in the Slave. This writes to a single register only. Any holding register that exists within the controller can have its contents changed by this message.
  • Page 175 Sub-function Codes Supported Only Sub-function 00 is supported by the MVI56E-MCM module. 00 Return Query Data The data passed in the request data field is to be returned (looped back) in the response.

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

    Reference MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module The data fields in responses to other kinds of queries could contain error counts or other data requested by the sub-function code. 6.8.9 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.

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

    MVI56E-MCM ♦ ControlLogix Platform Reference Modbus Communication Module User Manual Note: This is the structure of the message being sent out to the Modbus network. The byte values below are in hexadecimal display. Func Hi Add Quantity Byte Data Coil Status...

  • Page 178: Modbus Exception Responses

    Reference MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Response The normal response to a function 16 query is to echo the address, function code, starting address and number of registers to be loaded. Func Hi Addr Lo Addr...
  • Page 179 MVI56E-MCM ♦ ControlLogix Platform Reference Modbus Communication Module User Manual The following table shows an example of a Master request and server exception response. Request Response Field Name (Hex) Field Name (Hex) Function Function Starting Address Hi Exception Code Starting Address Lo...

  • Page 180: Using The Optional Add-On Instruction

    Reference MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Code Name Meaning Acknowledge Specialized use in conjunction with programming commands. The Slave has accepted the request and is processing it, but a long duration of time will be required to do so.

  • Page 181: Importing The Utility Add-On Instruction

    MVI56E-MCM ♦ ControlLogix Platform Reference Modbus Communication Module User Manual 6.9.3 Importing the Utility Add-On Instruction Right-click on an empty rung in the main routine of your existing ladder logic … and choose I MPORT UNGS ProSoft Technology, Inc. Page 181 of 209...
  • Page 182 Reference MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Navigate to the folder where you saved MVI56(E)MCM_Optional_AddOn_Rung_v1_2.L5X and select the file. In the I window, click OK. MPORT ONFIGURATION The Add-On Instruction is now visible in the ladder logic. Observe that the procedure has also imported data types and controller tags associated to the Add-On Instruction.
  • Page 183 MVI56E-MCM ♦ ControlLogix Platform Reference Modbus Communication Module User Manual You will notice that new tags have been imported: four MESSAGE tags, MVI56MCMC and MVI56MCME tags. LOCK THERNET In the Add-On Instruction click the [...] button next to each MSG tag to open...

  • Page 184: Reading The Ethernet Settings From The Module

    Reference MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Select the module to configure the message path. 6.9.4 Reading the Ethernet Settings from the Module Expand the MVI56MCME controller tag and move a value of 1 to THERNET MVI56MCME...
  • Page 185 MVI56E-MCM ♦ ControlLogix Platform Reference Modbus Communication Module User Manual The bit will be automatically reset and the current Ethernet settings will be copied to MVI56MCME controller tag as follows. THERNET To check the status of the message, refer to the R MSG tag.

  • Page 186: Writing The Ethernet Settings To The Module

    Reference MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module 6.9.5 Writing the Ethernet Settings to the Module Expand the MVI56MCME controller tag. THERNET Set the new Ethernet configuration in MVI56MCME THERNET ONFIG Move a value of 1 to MVI56MCME...

  • Page 187: Reading The Clock Value From The Module

    MVI56E-MCM ♦ ControlLogix Platform Reference Modbus Communication Module User Manual To check the status of the message, refer to the W MSG tag. RITE THERNET 6.9.6 Reading the Clock Value from the Module Expand the MVI56MCMC controller tag and move a value of 1 to...

  • Page 188: Writing The Clock Value To The Module

    Reference MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module To check the status of the message, refer to the R MSG tag. LOCK 6.9.7 Writing the Clock Value to the Module Expand the MVI56MCMC controller tag. LOCK Set the new Clock value in MVI56MCMC...

  • Page 189: Using The Sample Program - Rslogix 5000 Version 15 And Earlier

    6.10.1 Using the Sample Program in a New Application Opening the Sample Program in RSLogix The sample program for your MVI56E-MCM module includes custom tags, data types and ladder logic for data I/O, status and command control. For most applications, you can run the sample program without modification, or, for advanced applications, you can incorporate the sample program into your existing application.
  • Page 190 Reference MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module To determine the firmware version of your processor Important: The RSLinx service must be installed and running on your computer in order for RSLogix to communicate with the processor. Refer to your RSLinx and RSLogix documentation for help configuring and troubleshooting these applications.
  • Page 191 MVI56E-MCM ♦ ControlLogix Platform Reference Modbus Communication Module User Manual On the Connected To Go Online dialog box, click the General tab. This tab shows information about the processor, including the Revision (firmware) version. In the following illustration, the firmware version is 11.32...
  • Page 192 Reference MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Choosing the Controller Type The sample application is for a 1756-L63 ControlLogix 5563 Controller. If you are using a different model of the ControlLogix processor, you must configure the sample program to use the correct processor model.
  • Page 193 RSLogix will automatically apply the slot number change to all tags, variables and ladder logic rungs that use the MVI56E-MCM slot number for computation. Adjust the Input and Output Array Sizes Note: The following steps are only required if you are using the sample ladder logic (RSLogix version 15 or older) rather than the Add-On Instruction (RSLogix version 16 or newer).
  • Page 194 Reference MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module (1000 registers / 200 registers per block = 5 blocks of data) Verify the change to this rung. Toggle the object within RSLogix 5000. Save and download ladder to the processor.

  • Page 195: Using The Sample Program In An Existing Application

    Start another instance of RSLogix 5000, and then open your existing application. You will be adding the MVI56E-MCM module definition, and then copying controller tags, ladder logic, and user defined data types from the sample application into your existing application.
  • Page 196 Reference MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module In the S dialog box, select 1756-M 1756 ELECT ODULE ODULE ENERIC ) from the list and, and then click OK. This action opens the M ODULE ODULE dialog box.
  • Page 197 Note: Data types prefixed with an underscore [_] are used in optional routines, and need not be copied unless your application requires them. Refer to MVI56E-MCM MVI56E-MCM User Defined Data Types (page 161) for a description of the usage for each data type.
  • Page 198 Reference MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Copying the Sample Ladder Logic Next, copy the Sample Ladder Logic from the sample program to your existing program. In the C pane in the Sample Program, expand the ONTROLLER RGANIZATION folder until the list of program routines is visible.
  • Page 199 PortX.Type = 2 to 4, then this rung and ladder routine is required. WriteData The WriteData task sends data from the processor to the MVI56E-MCM module. Data is transferred from the processor to the module using the module’s output...
  • Page 200 _ReadControl Use this optional task to get status and event data from the Modbus devices connected to the MVI56E-MCM module. Special command blocks requested from the module in the _WriteControl routine are processed and handled in this routine. If command control, event command, or Slave status blocks are not going to be used in the application, then this rung and the _ReadControl and _WriteControl ladder files may be removed.
  • Page 201 Drag the MCM tag structure to the blank line at the bottom of the list in the tab in your existing program. Editing the Controller Tags The MVI56E-MCM module configuration is stored in the MCM.CONFIG structure in the C dialog box. The sample program configures the module ONTROLLER as a Modbus Master on Port 1, and a Modbus Slave on Port 2.
  • Page 202 Reference MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Page 202 of 209 ProSoft Technology, Inc.
  • Page 203 Contacting Technical Support ............. 203  Warranty Information ................205 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...
  • Page 204 Support, Service & Warranty MVI56E-MCM ♦ ControlLogix Platform User Manual Modbus Communication Module Asia Pacific Europe / Middle East / Africa Regional Office Regional Office Phone: +60.3.2247.1898 Phone: +33.(0)5.34.36.87.20 asiapc@prosoft-technology.com europe@prosoft-technology.com Languages spoken: Bahasa, Chinese, English, Languages spoken: French, English...
  • Page 205 Languages spoken: Spanish, English REGIONAL TECH SUPPORT support.la@prosoft-technology.com Warranty Information For complete details regarding ProSoft Technology’s TERMS & CONDITIONS OF SALE, WARRANTY, SUPPORT, SERVICE AND RETURN MATERIAL AUTHORIZATION INSTRUCTIONS, go to www.prosoft-technology/legal Documentation is subject to change without notice.
  • Page 206 MVI56E-MCM ♦ ControlLogix Platform Support, Service & Warranty Modbus Communication Module User Manual ProSoft Technology, Inc. Page 206 of 209...
  • Page 207 _WriteControl • 200 Data Analyzer • 112 00 Return Query Data • 175 Data Analyzer Tips • 114 Data Flow Between MVI56E-MCM Module and ControlLogix Processor • 141 DB9 to RJ45 Adaptor (Cable 14) • 149 About the Modbus Protocol • 124 Defining Module in I/O Configuration •...
  • Page 208 MVI56E-MCM Status Data Definition • 69, 109, 116, • 147 150, 160 Null Modem Connection (No Hardware MVI56E-MCM Status Data Definition as a Master • 70 Handshaking) • 147 MVI56E-MCM Status Data Definition as a Slave • 76 RS-232 Application Port(s) • 146 MVI56E-MCM User Defined Data Types •...
  • Page 209 MVI56E-MCM ♦ ControlLogix Platform Support, Service & Warranty Modbus Communication Module User Manual Scrolling LED Status Indicators • 80 Your Feedback Please • 2 Selecting the Slot Number for the Module • 193 Setting Jumpers • 12 Setting Up ProSoft Configuration Builder • 83 Setting Up the Project •...

Table of Contents

Save PDF