ProSoft Technology MVI69-S3964R User Manual

Download

MVI69-S3964R

CompactLogix or MicroLogix Platform

Siemens 3964R Protocol

10/31/2008

USER MANUAL

Please Read This Notice

Successful application of this module requires a reasonable working knowledge of the Ro ckwell Automation CompactLogix or MicroLogix hardware, the MVI69-S3964R Module and the application in which the combination is to be used. For this reason, it is important that those responsible for implementation satisfy themselves that the combination will meet the needs of the application without exposing personnel or equipment to unsafe or inappropriate working conditions.

This manual is provided to assist the user. Every attempt has been made to ensure that the information provided is accurate and a true reflection of the product's installation requirements. In order to ensure a complete understanding of the operation of the product, the user should read all applicable Rockwell Automation documentation on the operation of the Rockwell Automation hardware.

Under no conditions will ProSoft Technology be responsible or liable for indirect or consequential damages resulting from the use or application of the product.

Reproduction of the contents of this manual, in whole or in part, without written permission from ProSoft Technology is prohibited.

Information in this manual is subject to change without notice and does not represent a commitment on the part of ProSoft Technology Improvements and/or changes in this manual or the product may be made at any time. These changes will be made periodically to correct technical inaccuracies or typograp hica l errors.

Battery Life Advisory

All modules in the MVI series use a rechargeable Lithium Vanadium Pentoxide battery to backup the 512K SRAM memory, real-time clock, and CMOS. The battery should last for the life of the module. The module must be powered for approximately twenty hours before it becomes fully charged. After it is fully charged, the battery provides backup power for the CMOS setup and configuration data, the real-time clock, and the 512K SRAM memory for approximately 21 days. Before you remove a module from its power source, ensure that the battery within the module is fully charged. A fully charged battery will hold the BIOS settings (after being removed from its power source) for a limited number of days. When the battery is fully discharged, the module will revert to the default BIOS settings.

Note: The battery is not user replaceable.

Your Feedback Please

We always want you to feel that you made the right decision to use our products. If you have suggestions, comments, compliments or complaints about the product, documentation or support, please write or call us.

ProSoft Technology 1675 Chester Avenue, Fourth Floor Bakersfield, CA 93301 +1 (661) 716-5100 +1 (661) 716-5101 (Fax) http://www.prosoft-technology.com

10/31/2008 ProSoft Technology ®, ProLinx ®, inRAx ®, ProTalk® and RadioLinx ® are Registered Trademarks of ProSoft

Technology, Inc.

ProSoft® Product Documentation

In an effort to conserve paper, ProSoft Technology no longer includes printed manuals with our product shipments. User Manuals, Datasheets, Sample Ladder Files, and Configuration Files are provide d on the enclosed CD and are available at no charge from our web site: http://www.prosoft-technology.com Printed documentation is available for purchase. Contact ProSoft Technology for pricing and availability. Asia Pacific: +603.7724.2080 Europe, Middle East, Africa: +33.5.34.36.87.20 Latin America: +1.281.298.9109 North America: +1.661.716.5100

Contents MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

Contents

Please Read This Notice 2

Battery Life Advisory...........................................................................................................................2

Your Feedback Please........................................................................................................................2

ProSoft® Product Documentation.......................................................................................................3

Guide to the MVI69-S3964R User Manual 7

1 Start Here 9

1.1 System Requirements...............................................................................................9

1.2 Package Contents...................................................................................................10

1.3 Install ProSoft Configuration Builder Software........................................................11

1.4 Setting Jumpers ......................................................................................................12

1.5 Install the Module in the Rack.................................................................................13

1.6 Connect your PC to the Processor..........................................................................16

1.7 Download the Sample Program to the Processor...................................................17

1.8 Connect your PC to the Module..............................................................................20

2 Configuring the MVI69-S3964R Module 21

2.1 ProSoft Configuration Builder..................................................................................21

2.2 [Module]...................................................................................................................26

2.3 [Backplane 69].........................................................................................................26

2.4 [3964R Port x] .........................................................................................................26

2.5 Download the Project to the Module.......................................................................29

3 Ladder Logic 31

3.1 Introduction..............................................................................................................31

3.2 Module Data Object.................................................................................................33

3.3 Commands..............................................................................................................36

3.4 Adding the Module to an Existing CompactLogix Project.......................................37

3.5 Adding the Module to an Existing MicroLogix Project.............................................40

4 Diagnostics and Troubleshooting 43

4.1 Reading Status Data from the Module....................................................................43

4.2 LED Status Indicators..............................................................................................53

5 Reference 55

5.1 Product Specifications.............................................................................................55

5.2 Functional Overview................................................................................................57

5.3 Cable Connections..................................................................................................65

5.4 Reference Documents.............................................................................................69

ProSoft Technology, Inc. Page 5 of 80 October 31, 2008

Contents MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

5.5 Status Data............................................................................................................. 69

5.6 Error Codes............................................................................................................. 70

6 Support, Service & Warranty 71

6.1 How to Contact Us: Technical Support................................................................... 71

6.2 Return Material Authorization (RMA) Policies and Conditions............................... 72

6.3 LIMITED WARRANTY............................................................................................ 74

Index 79

Page 6 of 80 ProSoft Technology, Inc. October 31, 2008

Start Here MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

Guide to the MVI69-S3964R User Manual

Function Section to Read Details

Introduction (Must Do)

Verify Communication, Diagnostic and Troubleshooting

Reference Product Specifications Functional Overview Glossary

Support, Service, and Warranty

Index

→

Start Here (page 9)

Verifying Communication (page 53)

Diagnostics and Troubleshooting (page 43)

Reference (page 55) Functional Overview

(page 57) Product

Specifications (page

55)

Support, Service and Warranty (page

71)

This Section introduces the customer to the module. Included are: package contents, system requirements, hardware installation, and basic configuration.

This section describes how to verify communications with the network. Diagnostic and Troubleshooting procedures.

These sections contain general references associated with this product, Specifications, and the Functional Overview.

This section contains Support, Service and Warranty information.

Index of chapters.

ProSoft Technology, Inc. Page 7 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Start Here Siemens 3964R Protocol

Page 8 of 80 ProSoft Technology, Inc.

October 31, 2008

Start Here MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

1 Start Here

In This Chapter

 System Requirements.............................................................................9

 Package Contents.................................................................................10

 Install ProSoft Configuration Builder Software.......................................11

 Setting Jumpers ....................................................................................12

 Install the Module in the Rack ...............................................................13

 Connect your PC to the Processor........................................................16

 Download the Sample Program to the Processor..................................17

 Connect your PC to the Module ............................................................20

Installing the MVI69-S3964R module requires a reasonable working knowledge of the Rockwell Automation hardware, the MVI69-S3964R Module and the application in which they will be used.

Caution: It is important that those responsible for implementation can complete the

application without exposing personnel, or equipment, to unsafe or inappropriate working conditions. Safety, quality and experience are key factors in a successful installation.

1.1 System Requirements

The MVI69-S3964R module requires the following minimum hardware and software components:

 Rockwell Automation CompactLogix or MicroLogix processor, with

compatible power supply and one free slot in the rack, for the MVI69-S3964R module. The module requires 800mA of available power.

Important: The MVI69-S3964R module has a power supply distance rating of 2 (L43 and L45

installations on first 2 slots of 1769 bus).

Important: For 1769-L23x processors, please make note of the following limitations.  1769-L23-QBFC1B = 800mA at 5Vdc (1 MVI69-S3964R will use all 800mA of available power.

No other modules can be used with an MVI69 module connected to this processor).

 1769-L23E-QB1B = 1000mA at 5Vdc (1 MVI69-S3964R will use 800mA of available power.

One other module can be used on this rack provided it consumes less than 200mA at 5Vdc.

 1769-L23E-QBFC1B = 450mA at 5Vdc (no MVI69 module can be used with this processor)  Rockwell Automation RSLogix 5000 (CompactLogix) or RSLogix 500

(MicroLogix) programming software

 Rockwell Automation RSLinx communication software

ProSoft Technology, Inc. Page 9 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Start Here Siemens 3964R Protocol

 Pentium® II 450 MHz minimum. Pentium III 733 MHz (or better)

recommended

 Supported operating systems:

o Microsoft Windows XP Professional with Service Pack 1 or 2 o Microsoft Windows 2000 Professional with Service Pack 1, 2, or 3 o Microsoft Windows Server 2003

 128 Mbytes of RAM minimum, 256 Mbytes of RAM recommended  100 Mbytes of free hard disk space (or more based on application

requirements)

 256-color VGA graphics adapter, 800 x 600 minimum resolution (True Color

1024 × 768 recommended)

 CD-ROM drive  HyperTerminal or other terminal emulator program capable of file transfers

using Ymodem protocol.

1.2 Package Contents

The following components are included with your MVI69-S3964R module, and are all required for installation and configuration.

Important: Before beginning the installation, please verify that all of the following items are

present.

Qty. Part Name Part Number Part Description

1 Cable

3 Cable

2 Adapter 1454-9F

MVI69S3964R Module

ProSoft Solutions CD

MVI69-S3964R Siemens 3964R Protocol

Cable #15, RS232 Null Modem

Cable #14, RJ45 to DB9 Male Adapter cable

For RS232 Connection to the CFG Port

For DB9 Connection to Module's Port

Two Adapters, DB9 Female to Screw Terminal. For RS422 or RS485 Connections to Port 1 and 2 of the Module

Contains sample programs, utilities and documentation for the MVI69-S3964R module.

If any of these components are missing, please contact ProSoft Technology Support for replacement parts.

Page 10 of 80 ProSoft Technology, Inc.

October 31, 2008

Start Here MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

1.3 Install ProSoft Configuration Builder Software

You must install the ProSoft Configuration Builder (PCB) software in order to configure the MVI69-S3964R module. You can always get the newest version of ProSoft Configuration Builder from the ProSoft Technology web site.

To install ProSoft Configuration Builder from the ProSoft Web Site

1 Open your web browser and navigate to http://www.prosoft-

technology.com/pcb

2 Click the Download Here link to download the latest version of ProSoft

Configuration Builder.

3 Choose "Save" or "Save File" when prompted. The following illustrations

show the file download prompt for two of the most common web browsers.

4 Make a note of the location where you saved the file, for example "Desktop",

or "My Documents", so you can start the installation program.

5 When the download is complete, locate and open the file, and then follow the

instructions on your screen to install the program.

If you do not have access to the Internet, you can install ProSoft Configuration Builder from the ProSoft Solutions CD-ROM, included in the package with your MVI69-S3964R module.

To install ProSoft Configuration Builder from the CD-ROM

1 Insert the ProSoft Solutions CD-ROM into the CD drive of your PC. Wait for

the startup screen to appear.

2 On the startup screen, click Product Documentation. This action opens an

explorer window.

ProSoft Technology, Inc. Page 11 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Start Here Siemens 3964R Protocol

3 Click to open the Utilities folder. This folder contains all of the applications

and files you will need to set up and configure your module.

4 Double-click the ProSoft Configuration Builder Setup program and follow the

instructions on your screen to install the software on your PC.

Note: Many of the configuration and maintenance procedures use files and other utilities on the

CD-ROM. You may wish to copy the files from the Utilities folder on the CD-ROM to a convenient location on your hard drive.

1.4 Setting Jumpers

When the module is manufactured, the port selection jumpers are set to RS-232. To use RS-422 or RS-485, you must set the jumpers to the correct position. The following diagram describes the jumper settings.

The Setup Jumper acts as "write protection" for the module's flash memory. In "write protected" mode, the Setup pins are not connected, and the module's firmware cannot be overwritten. Do not jumper the Setup pins together unless you are directed to do so by ProSoft Technical Support.

Page 12 of 80 ProSoft Technology, Inc.

October 31, 2008

Start Here MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

1.5 Install the Module in the Rack

This section describes how to install the module into a CompactLogix or MicroLogix rack

Before you attempt to install the module, make sure that the bus lever of the adjacent module is in the unlocked (fully right) position.

Warning: This module is not hot-swappable! Always remove power from the rack before

inserting or removing this module, or damage may result to the module, the processor, or other connected devices.

1 Align the module using the upper and lower tongue-and-groove slots with the

adjacent module and slide forward in the direction of the arrow.

2 Move the module back along the tongue-and-groove slots until the bus

connectors on the MVI69 module and the adjacent module line up with each other.

ProSoft Technology, Inc. Page 13 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Start Here Siemens 3964R Protocol

3 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.

4 Close all DIN rail latches.

Page 14 of 80 ProSoft Technology, Inc.

October 31, 2008

Start Here MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

5 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 15 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Start Here Siemens 3964R Protocol

1.6 Connect your PC to the Processor

1 Connect the right-angle connector end of the cable to your controller at the

communications port.

2 Connect the straight connector end of the cable to the serial port on your

computer.

Page 16 of 80 ProSoft Technology, Inc.

October 31, 2008

Start Here MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

1.7 Download the Sample Program to the Processor

Important: For most applications, the sample program will work without modification. Note: The key switch on the front of the CompactLogix processor must be in the REM position.

1 If you are not already online to the processor, open the Communications

menu, and then choose Download. RSLogix will establish communication with the processor.

2 When communication is established, RSLogix will open a confirmation dialog

box. Click the Download button to transfer the sample program to the processor.

3 RSLogix will compile the program and transfer it to the processor. This

process may take a few minutes.

4 When the download is complete, RSLogix will open another confirmation

dialog box. Click OK to switch the processor from Program mode to Run mode.

Note: If you receive an error message during these steps, refer to your RSLogix documentation to

interpret and correct the error.

ProSoft Technology, Inc. Page 17 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Start Here Siemens 3964R Protocol

1.7.1 Configuring RSLinx

If RSLogix is unable to establish communication with the processor, follow these steps:

1 Open RSLinx. 2 Open the Communications menu, and choose Configure Drivers.

This action opens the Configure Drivers dialog box.

Note: If the list of configured drivers is blank, you must first choose and configure a driver from the

Available Driver Types list. The recommended driver type to choose for serial communication with the processor is "RS-232 DF1 Devices".

Page 18 of 80 ProSoft Technology, Inc.

October 31, 2008

Start Here MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

3 Click to select the driver, and then click Configure. This action opens the

Configure Allen-Bradley DF1 Communications Device dialog box.

4 Click the Auto-Configure button. RSLinx will attempt to configure your serial

port to work with the selected driver.

5 When you see the message "Auto Configuration Successful", click the OK

button to dismiss the dialog box.

Note: If the auto-configuration procedure fails, verify that the cables are connected correctly

between the processor and the serial port on your computer, and then try again. If you are still unable to auto-configure the port, refer to your RSLinx documentation for further troubleshooting steps.

ProSoft Technology, Inc. Page 19 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Start Here Siemens 3964R Protocol

1.8 Connect your PC to the Module

With the module securely mounted, connect your PC to the Configuration/Debug port using an RJ45-DB-9 Serial Adapter Cable and a Null Modem Cable.

1 Attach both cables as shown. 2 Insert the RJ45 cable connector into the Configuration/Debug port of the

module.

3 Attach the other end to the serial port on your PC or laptop.

Page 20 of 80 ProSoft Technology, Inc.

October 31, 2008

Configuring the MVI69-S3964R Module MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

2 Configuring the MVI69-S3964R Module

In This Chapter

 ProSoft Configuration Builder................................................................21

 [Module].................................................................................................26

 [Backplane 69].......................................................................................26

 [3964R Port x] .......................................................................................26

 Download the Project to the Module......................................................29

2.1 ProSoft Configuration Builder

ProSoft Configuration Builder (PCB) provides a quick and easy way to manage module configuration files customized to meet your application needs. PCB is not only a powerful solution for new configuration files, but also allows you to import information from previously installed (known working) configurations to new projects.

ProSoft Technology, Inc. Page 21 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Configuring the MVI69-S3964R Module Siemens 3964R Protocol

2.1.1 Set Up the Project

To begin, start ProSoft Configuration Builder. If you have used other Windows configuration tools before, you will find the screen layout familiar. ProSoft Configuration Builder's window consists of a tree view on the left, an information pane and a configuration pane on the right side of the window. When you first start ProSoft Configuration Builder, the tree view consists of folders for Default Project and Default Location, with a Default Module in the Default Location folder. The following illustration shows the ProSoft Configuration Builder window with a new project.

Your first task is to add the MVI69-S3964R module to the project. 1 Use the mouse to select "Default Module" in the tree view, and then click the

right mouse button to open a shortcut menu.

Page 22 of 80 ProSoft Technology, Inc.

October 31, 2008

Configuring the MVI69-S3964R Module MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

2 On the shortcut menu, choose "Choose Module Type". This action opens the

Choose Module Type dialog box.

3 In the Product Line Filter area of the dialog box, select MVI69. In the Select

Module Type dropdown list, select MVI69-S3964R, and then click OK to save your settings and return to the ProSoft Configuration Builder window.

Adding a Project

To add a project to an existing project file:

1 Select the Default Project icon. 2 Choose Project from the Project menu, then choose Add Project. A new

project folder appears.

Adding a Module

To add a module to your project:

1 Double-click the Default Module icon to open the Choose Module Type dialog

box.

2 On the Choose Module Type dialog box, select the module type. Or

1 Open the Project menu and choose Location. 2 On the Location menu, choose Add Module.

ProSoft Technology, Inc. Page 23 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Configuring the MVI69-S3964R Module Siemens 3964R Protocol

To add a module to a different location:

1 Right-click the Location folder and choose Add Module. A new module icon

appears.

1 Select the Location icon. 2 From the Project menu, select Location, then select Add Module.

2.1.2 Set Module Parameters

Notice that the contents of the information pane and the configuration pane changed when you added the MVI69-S3964R module to the project.

At this time, you may wish to rename the "Default Project" and "Default Location" folders in the tree view.

To rename an object:

1 Select the object, and then click the right mouse button to open a shortcut

menu. From the shortcut menu, choose Rename.

2 Type the name to assign to the object. 3 Click away from the object to save the new name.

Page 24 of 80 ProSoft Technology, Inc.

October 31, 2008

Configuring the MVI69-S3964R Module MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

Module Entries

To configure module parameters

1 Click on the plus sign next to the icon

to expand module

information.

2 Double-click the

icon to open the Edit dialog box.

3 To edit a parameter, select the parameter in the left pane and make your

changes in the right pane.

4 Click OK to save your changes.

Comment Entries

To add comments to your configuration file:

1 Click the plus sign to the left of the

icon to expand the Module

Comments.

2 Double-click the

icon. The Edit - Module Comment dialog

appears.

3 Enter your comment and click OK to save your changes.

Printing a Configuration File

To print a configuration file:

1 Select the Module icon, and then click the right mouse button to open a

shortcut menu.

2 On the shortcut menu, choose View Configuration. This action opens the

View Configuration window.

3 On the View Configuration window, open the File menu, and choose Print.

This action opens the Print dialog box.

4 On the Print dialog box, choose the printer to use from the dropdown list,

select printing options, and then click OK.

ProSoft Technology, Inc. Page 25 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Configuring the MVI69-S3964R Module Siemens 3964R Protocol

2.2 [Module]

This section defines the configuration for the Module level data.

2.2.1 Module Name

0 to 80 characters This parameter assigns a name to the module that can be viewed using the

configuration/debug port. Use this parameter to identify the module and the configuration file.

2.3 [Backplane 69]

[Backplane 69] Block Transfer Size : 60 #Number of words in block (must be set to 60) Status Interval : 0 #Minimum interval (ms) between status blocks #(0 = disable)

2.3.1 Block Transfer Size

60 This read-only parameter specifies the number of words in each block transferred

between the module and processor. This value is fixed at 60 words.

2.3.2 Status Interval

Minimum interval (ms) between status blocks (0 = disable)

2.4 [3964R Port x]

This section is used to define the port 1 configuration for the 3964R device

[3964R Port 1] Enable : Yes #No=Port Disabled,Yes=Port Enabled Baud Rate : 9600 #Baud rate for port (300, 600, 1200, 2400, 4800, #9600, 19200, 38400, 57600, 115) Parity : Even #N=None,O=Odd,E=Even Data Bits : 8 #7 or 8 data bits for messages Stop Bits : 1 #1 or 2 stop bits for messages RTS On : 0 #Delay after RTS set before message sent (mSec) RTS Off : 0 #Delay after message before RTS dropped (mSec) Use CTS Line : No #Monitor CTS modem line (Y/N) Swap : 0 #0=No Data Byte Swapping, 1=Data Byte Swapping Priority : 1 #0=High Priority, 1=Low Priority Protocol : 0 #0=3964 RK512, 1=3964 ACK Delay : 1000 #Number of mSec to wait for ACK (Default 1000ms) Setup Attempts : 1 #Number of times to try to connect to CP (Default 6) Transmit Attempts : 1 #Number of times to try to transmit to CP (Default 6)

Page 26 of 80 ProSoft Technology, Inc.

October 31, 2008

Configuring the MVI69-S3964R Module MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

2.4.1 Enable

Yes or No This parameter specifies whether to enable or disable the port. No = Port

Disabled, Yes = Port Enabled.

2.4.2 Baud Rate

300 to 115200 This parameter specifies the baud rate to be used on the port. Valid values are

300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, and 115200.

2.4.3 Parity

None, Odd, Even Parity is a simple error checking algorithm used in serial communication. This

parameter specifies the type of parity checking to use. All devices communicating through this port must use the same parity setting.

2.4.4 Data Bits

7 or 8 This parameter sets the number of data bits for each word used by the protocol.

All devices communicating through this port must use the same number of data bits.

2.4.5 Stop Bits

1 or 2 Stop bits signal the end of a character in the data stream. For most applications,

use one stop bit. For slower devices that require more time to resynchronize, use two stop bits.

All devices communicating through this port must use the same number of stop bits.

2.4.6 RTS On

0 to 65535 milliseconds This parameter sets the number of milliseconds to delay after RTS is asserted

before the data will be transmitted.

2.4.7 RTS Off

0 to 65535 milliseconds This parameter sets the number of milliseconds to delay after the last byte of

data is sent before the RTS modem signal will be set low.

ProSoft Technology, Inc. Page 27 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Configuring the MVI69-S3964R Module Siemens 3964R Protocol

2.4.8 Use CTS Line

Yes or No This parameter specifies if the CTS modem control line is to be used. If the

parameter is set to No, the CTS line will not be monitored. If the parameter is set to Yes, the CTS line will be monitored and must be high before the module will send data. Normally, this parameter is required when half-duplex modems are used for communication (2-wire).

2.4.9 Swap

0 or 1 This parameter specifies whether bytes should be swapped. 0 = No data byte

swapping, 1 = Data byte swapping.

2.4.10 Priority

0 or 1 This parameter specifies whether the data is high priority or low priority. 0 = High

priority, 1 = Low Priority.

2.4.11 Protocol

0 or 1 0=3964 RK512, 1=3964

2.4.12 ACK Delay

Number of milliseconds to wait for ACK. The default is 1000 ms.

2.4.13 Setup Attempts

Number of times to try to connect to CP (Default 6)

2.4.14 Transmit Attempts

Number of times to try to transmit to CP (Default 6)

Page 28 of 80 ProSoft Technology, Inc.

October 31, 2008

Configuring the MVI69-S3964R Module MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

2.5 Download 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.

To Download the Project File

1 In the tree view in ProSoft Configuration Builder, click once to select the

MVI69-S3964R module.

2 Open the Project menu, and then choose Module / Download. The program

will scan your PC for a valid com port (this may take a few seconds). When PCB has found a valid com port, the following dialog box will open.

3 Choose the com port to use from the dropdown list, and then click the

Download button. The module will perform a platform check to read and load its new settings.

When the platform check is complete, the status bar in ProSoft Configuration Builder will be updated with the message "Module Running".

ProSoft Technology, Inc. Page 29 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Configuring the MVI69-S3964R Module Siemens 3964R Protocol

Page 30 of 80 ProSoft Technology, Inc.

October 31, 2008

Ladder Logic MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

3 Ladder Logic

In This Chapter

 Introduction............................................................................................31

 Module Data Object...............................................................................33

 Commands............................................................................................36

 Adding the Module to an Existing CompactLogix Project......................37

 Adding the Module to an Existing MicroLogix Project............................40

Ladder logic is required for application of the MVI69-S3964R module. Tasks that must be handled by the ladder logic are module data transfer, special block handling and status data receipt. Additionally, a power-up handler may be needed to handle the initialization of the module's data and to clear any processor fault conditions.

The sample ladder logic, on the ProSoft Solutions CD-ROM, is extensively commented, to provide information on the purpose and function of each rung. For most applications, the sample ladder will work without modification.

3.1 Introduction

The example programs mentioned in the following paragraphs illustrate the principle of how to communicate between an MVI69-S3964R and a CompactLogix or MicroLogix processor. All programs mentioned were tested with appropriate communication partners.

It is up to the programmer to examine the programs in detail and integrate them into the CompactLogix or MicroLogix processor application.

The following setups/limitations are to be observed in the example programs:

Changes according to the requirements of your CompactLogix or MicroLogix system are recommended for setups only. Limitations must not be changed.

 Setup: The MVI69-S3964R resides in slot 1 of the CompactLogix chassis.  Setup: The 1769-L series controller resides in slot 0 of the CompactLogix

chassis.

ATTENTION: You must be trained in programming and operating Rockwell

Automation 1769-L series controllers and CompactLogix or MicroLogix environment. Otherwise, incorrect use may lead to personal injury or death, property damages or economic loss.

ProSoft Technology, Inc. Page 31 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Ladder Logic Siemens 3964R Protocol

3.1.1 Explanations About the Example Programs

MVI693964R_v13.ACD is the general S3964R communication program used for the following types of 3964R jobs:

3.1.2 The 3964R Communication Program

The general functionality of the program MVI693964R_v13.ACD is as follows: Send jobs to a CP:

 Transfer the job data to the MVI69-S3964R.  Acknowledgement from the MVI69-S3964R regarding validity of the job data.  Depending on the type of send job the transfer of the user data from/to the

MVI69-S3964R/CompactLogix or MicroLogix processor takes place.

 Acknowledgement from the MVI69-S3964R regarding

successful/unsuccessful completion of the send job. Receive jobs from a CP:  Depending on the type of receive job the transfer of the user data from/to the

MVI69-S3964R/CompactLogix or MicroLogix processor takes place. The

header data generated from the MVI69-S3964R will be added automatically.

The MVI69-S3964R needs no extra job data from the CompactLogix or

MicroLogix processor for receive jobs, it will be triggered through the STX

character sent from the CP to establish the communication.  Acknowledgement from the MVI69-S3964R regarding

successful/unsuccessful completion of the receive job. During the processes described above additional status/error messages may be

transferred from the MVI69-S3964R to the CompactLogix or MicroLogix processor (refer to Module Status Data Table (page 69)). Refer to Error Processing for more information.

Page 32 of 80 ProSoft Technology, Inc.

October 31, 2008

Ladder Logic MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

3.2 Module Data Object

All data related to the MVI69-S3964R module is stored in a user defined data type. An instance of the data type is required before the module can be used. This is done by declaring a variable of the data type in the Controller Tags Edit Tags dialog box.

The object has the following structure.

This object contains objects that define user and status data related to the module. Each of these object types is discussed in the following topics of the document.

ProSoft Technology, Inc. Page 33 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Ladder Logic Siemens 3964R Protocol

3.2.1 Status Object (S3964RInStat Data Structure)

This object views the status of the module. The S3964RInstat object shown below is updated each time a read block is received by the processor. Use this data to monitor the state of the module at a "real-time rate".

Refer to Module Status Data Table (page 69) for a complete listing of the data stored in this object.

3.2.2 Backplane Object

Page 34 of 80 ProSoft Technology, Inc.

October 31, 2008

Ladder Logic MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

3.2.3 Block Control Data

This data object stores the variables required for the data transfer between the processor and the MVI69-S3964R module. The structure of the object is shown in the following illustration.

3.2.4 Port Errors

ProSoft Technology, Inc. Page 35 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Ladder Logic Siemens 3964R Protocol

3.2.5 User Data Objects

These objects hold data to be transferred between the processor and the MVI69S3964R module. The user data is the read and write data transferred between the processor and the module as "pages" of data up to 200 words long.

The read data (ReadData) is an array set to match the value entered in the Read Register Count parameter of the S3964R.CFG file. For ease of use, this array should be dimensioned as an even increment of 240 words. This data is paged up to 200 words at a time from the module to the processor. The ReadData task places the data received into the proper position in the read data array. Use this data for status and control in the ladder logic of the processor.

The write data (WriteData) is an array set to match the value entered in the Write Register Count parameter of the S3964R.CFG file. For ease of use, this array should be dimensioned as even increments of 60 words. This data is paged up to 240 words at a time from the processor to the module. The WriteData task places the write data into the output image for transfer to the module. This data is passed from the processor to the module for status and control information for use in other nodes on the network.

3.3 Commands

The CMDS sub-routine is used to handle special block processing. Special blocks include:

 9998 - Warm Boot  9999 - Cold Boot

3.3.1 9998 Warm Boot

The SLC processor can request a warm boot operation of the module by placing a value of 9998 is the M1 register 6800 (Command Control Register).

3.3.2 9999 Cold Boot

The SLC processor can request a cold boot operation by the module by placing a value of 9999 in the M1 register 6800 (Command Control Register).

Page 36 of 80 ProSoft Technology, Inc.

October 31, 2008

Ladder Logic MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

3.4 Adding the Module to an Existing CompactLogix Project

Important: The following steps describe how to install and configure the MVI69-S3964R module

with RSLogix 5000 version 15 or older. If you are using RSLogix 5000 version 16, please refer to Sample Add-On Instruction Import Procedure.

Important: The MVI69-S3964R module has a power supply distance rating of 2 (L43 and L45

installations on first 2 slots of 1769 bus)

If you are installing and configuring the module with a CompactLogix processor, follow these steps. If you are using a MicroLogix processor, refer to the next section.

1 Add the MVI69-S3964R module to the project. Right-click the mouse

button on the I/O Configuration option in the Controller Organization window to display a pop-up menu. Select the New Module option from the I/O Configuration menu.

ProSoft Technology, Inc. Page 37 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Ladder Logic Siemens 3964R Protocol

This action opens the following dialog box:

2 Select the 1769-Module (Generic 1769 Module) from the list and click OK.

3 Enter the Name, Description and Slot options for your application, using the

values in the illustration above. You must select the Comm Format as Data -

INT in the dialog box, otherwise the module will not communicate over the

backplane of the CompactLogix rack.

Page 38 of 80 ProSoft Technology, Inc.

October 31, 2008

Ladder Logic MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

Click OK to continue.

4 Select the Request Packet Interval value for scanning the I/O on the module.

This value represents the minimum frequency the module will handle scheduled events. This value should not be set to less than 1 millisecond. Values between 1 and 10 milliseconds should work with most applications.

5 Save the module. Click OK to dismiss the dialog box. The Controller

Organization window now displays the module's presence. The following illustration shows the Controller Organization window:

6 Copy the Controller Tags from the sample program. 7 Copy the User Defined Data Types from the sample program. 8 Copy the Ladder Rungs from the sample program. 9 Save and Download the new application to the controller and place the

processor in run mode.

ProSoft Technology, Inc. Page 39 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Ladder Logic Siemens 3964R Protocol

3.5 Adding the Module to an Existing MicroLogix Project

If you are installing and configuring the module with a MicroLogix processor, follow these steps. If you are using a CompactLogix processor, refer to the previous section.

This chapter describes how to install and configure the module to work with your application. The configuration process consists of the following steps.

1 Use RSLogix to identify the module to the processor and add the module to a

project.

Note: The RSLogix software must be in "offline" mode to add the module to a project.

2 Modify the example ladder logic to meet the needs of your application, and

copy the ladder logic to the processor. Example ladder logic files are provided

on the CD-ROM.

Note: If you are installing this module in an existing application, you can copy the necessary

elements from the example ladder logic into your application.

The rest of this chapter describes these steps in more detail. The first step in setting up the processor ladder file is to define the I/O type

module to the system. Start RSLogix 500, and follow these steps: 1 In RSLogix, open your existing application, or start a new application,

depending on your requirements. 2 Double-click the I/O Configuration icon located in the Controller folder in the

project tree. This action opens the I/O Configuration dialog box.

3 On the I/O Configuration dialog box, select "Other - Requires I/O Card Type

ID" at the bottom of the list in the right pane, and then double-click to open

the Module dialog box.

Page 40 of 80 ProSoft Technology, Inc.

October 31, 2008

Ladder Logic MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

4 Enter the values shown in the following illustration to define the module

correctly for the MicroLogix processor, and then click OK to save your configuration.

The input words and output words parameter will depend on the Block Transfer Size parameter you specify in the configuration file. Use the values from the following table.

Block Transfer Size Input Words Output Words

60 63 63

5 Click Next to continue. 6 After completing the module setup, the I/O configuration dialog box will

display the module's presence.

The last step is to add the ladder logic. If you are using the example ladder logic, adjust the ladder to fit your application. Refer to the example Ladder Logic section in this manual.

Download the new application to the controller and place the processor in run mode. If you encounter errors, refer to Diagnostics and Troubleshooting (page

43) for information on how to connect to the module's Config/Debug port to use its troubleshooting features.

ProSoft Technology, Inc. Page 41 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Ladder Logic Siemens 3964R Protocol

Page 42 of 80 ProSoft Technology, Inc.

October 31, 2008

Diagnostics and Troubleshooting MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

4 Diagnostics and Troubleshooting

In This Chapter

 Reading Status Data from the Module ..................................................43

 LED Status Indicators............................................................................53

The module provides information on diagnostics and troubleshooting in the following forms:

 Status data values are transferred from the module to the processor.  Data contained in the module can be viewed through the

Configuration/Debug port attached to a terminal emulator.

 LED status indicators on the front of the module provide information on the

module's status.

4.1 Reading Status Data from the Module

The MVI69-3964R module returns a 31-word Status Data Block (page 69) that may be used to determine the module's operating status.

This data is transferred to the CompactLogix or MicroLogix processor every time the module does not have 3964R communication data to send to the processor.

The Configuration/Debug port provides the following functionality:

 Full view of the module's configuration data  View of the module's status data  Version Information  Control over the module (warm boot, cold boot, transfer configuration)

4.1.1 Required Hardware

You can connect directly from your computer's serial port to the serial port on the module to view configuration information, perform maintenance, and send (upload) or receive (download) configuration files.

ProSoft Technology recommends the following minimum hardware to connect your computer to the module:

 80486 based processor (Pentium preferred)  1 megabyte of memory  At least one UART hardware-based serial communications port available.

USB-based virtual UART systems (USB to serial port adapters) often do not function reliably, especially during binary file transfers, such as when uploading/downloading configuration files or module firmware upgrades.

 A null modem serial cable.

ProSoft Technology, Inc. Page 43 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Diagnostics and Troubleshooting Siemens 3964R Protocol

4.1.2 The Configuration/Debug Menu

The Configuration and Debug menu for this module is arranged as a tree structure, with the Main Menu at the top of the tree, and one or more sub-menus for each menu command. The first menu you see when you connect to the module is the Main menu.

Because this is a text-based menu system, you enter commands by typing the command letter from your computer keyboard in the diagnostic window in ProSoft Configuration Builder (PCB). The module does not respond to mouse movements or clicks. The command executes as soon as you press the command letter — you do not need to press [Enter]. When you type a command letter, a new screen will be displayed in your terminal application.

Using the Diagnostic Window in ProSoft Configuration Builder

To connect to the module's Configuration/Debug serial port: 1 Start PCB program with the application file to be tested. Right click over the

module icon.

2 On the shortcut menu, choose Diagnostics.

Page 44 of 80 ProSoft Technology, Inc.

October 31, 2008

Diagnostics and Troubleshooting MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

3 This action opens the Diagnostics dialog box. Press "?" to display the Main

Menu.

Important: The illustrations of configuration/debug menus in this section are intended as a general

guide, and may not exactly match the configuration/debug menus in your own module.

If there is no response from the module, follow these steps: 1 Verify that the null modem cable is connected properly between your

computer's serial port and the module. A regular serial cable will not work.

2 On computers with more than one serial port, verify that your communication

program is connected to the same port that is connected to the module.

If you are still not able to establish a connection, contact ProSoft Technology for assistance.

Navigation

All of the sub-menus for this module contain commands to redisplay the menu or return to the previous menu. You can always return from a sub-menu to the next higher menu by pressing [M] on your keyboard.

The organization of the menu structure is represented in simplified form in the following illustration:

ProSoft Technology, Inc. Page 45 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Diagnostics and Troubleshooting Siemens 3964R Protocol

The remainder of this section shows you the menus available for this module, and briefly discusses the commands available to you.

Keystrokes

The keyboard commands on these menus are almost always non-case sensitive. You can enter most commands in lower case or capital letters.

The menus use a few special characters ([?], [-], [+], [@]) that must be entered exactly as shown. Some of these characters will require you to use the [Shift], [Ctrl] or [Alt] keys to enter them correctly. For example, on US English keyboards, enter the [?] command as [Shift][/].

Also, take care to distinguish capital letter [I] from lower case letter [l] (L) and number [1]; likewise for capital letter [O] and number [0]. Although these characters look nearly the same on the screen, they perform different actions on the module.

4.1.3 Main Menu

When you first connect to the module from your computer, your terminal screen will be blank. To activate the main menu, press the [?] key on your computer's keyboard. If the module is connected properly, the following menu will appear on your terminal screen:

Caution: Some of the commands available to you from this menu are designed for advanced

debugging and system testing only, and can cause the module to stop communicating with the processor or with other devices, resulting in potential data loss or other failures. Only use these commands if you are specifically directed to do so by ProSoft Technology Technical Support staff. Some of these command keys are not listed on the menu, but are active nevertheless. Please be careful when pressing keys so that you do not accidentally execute an unwanted command.

Redisplaying the Menu

Press [?] to display the current menu. Use this command when you are looking at a screen of data, and want to view the menu choices available to you.

Page 46 of 80 ProSoft Technology, Inc.

October 31, 2008

Diagnostics and Troubleshooting MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

Viewing Version Information

Press [V] to view Version information for the module. Use this command to view the current version of the software for the module, as

well as other important values. You may be asked to provide this information when calling for technical support on the product.

Values at the bottom of the display are important in determining module operation. The Program Scan Counter value is incremented each time a module's program cycle is complete.

Tip: Repeat this command at one-second intervals to determine the frequency of program

execution.

Opening the Database Menu

Press [D] to open the Database View menu. Use this menu command to view the current contents of the module's database.

Clearing Diagnostic Data

Press [C] to clear diagnostic data from the module's memory.

Opening the Backplane Menu

Press [B] from the Main Menu to view the Backplane Data Exchange List. Use this command to display the configuration and statistics of the backplane data transfer operations.

Tip: Repeat this command at one-second intervals to determine the number of blocks transferred

each second.

Opening the Protocol_Serial_S3964R Menu

Press [0] or [1] from the Main Menu to open the Protocol_Serial_S3964R menu for S3964R Ports 1 and 2.

Use this command to view communication status and statistics for the selected port. This information can be useful for trouble-shooting communication problems.

Transferring the Configuration File from MVI69 module to PC

Press [S] to receive (download) the configuration file from the module to your PC.

Press [Y] to confirm the file transfer, and then follow the instructions on the terminal screen to complete the file transfer process.

After the file has been successfully downloaded, you can open and edit the file to change the module's configuration.

ProSoft Technology, Inc. Page 47 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Diagnostics and Troubleshooting Siemens 3964R Protocol

Transferring the Configuration File from PC to MVI69 module

Press [R] to send (upload) the configuration file from your PC to the module and store the file on the module's Compact Flash Disk.

Press [Y] to confirm the file transfer, and then follow the instructions on the terminal screen to complete the file transfer process.

After the file has been successfully downloaded, the module will restart the program and load the new configuration information. Review the new configuration using menu commands [0] and [1] to verify that the module is configured correctly.

Warm Booting the Module

Caution: Some of the commands available to you from this menu are designed for advanced

Press [W] from the Main Menu to warm boot (restart) the module. This command will cause the program to exit and reload, refreshing configuration parameters that must be set on program initialization. Only use this command if you must force the module to re-boot.

Exiting the Program

Caution: Some of the commands available to you from this menu are designed for advanced

Press [Esc] to restart the module and force all drivers to be loaded. The module will use the configuration stored in the module's Flash ROM to configure the module.

Page 48 of 80 ProSoft Technology, Inc.

October 31, 2008

Diagnostics and Troubleshooting MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

4.1.4 Database View Menu

Press [D] from the Main Menu to open the Database View menu. Use this menu command to view the current contents of the module's database. Press [?] to view a list of commands available on this menu.

Viewing Register Pages

To view sets of register pages, use the keys described below:

Command Description [0] [1] [2]

Display registers 0 to 99 Display registers 1000 to 1099 Display registers 2000 to 2099

And so on. The total number of register pages available to view depends on your module's configuration.

Displaying the Current Page of Registers Again

This screen displays the current page of 100 registers in the database.

ProSoft Technology, Inc. Page 49 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Diagnostics and Troubleshooting Siemens 3964R Protocol

Moving Back Through 5 Pages of Registers

Press [-] from the Database View menu to skip back to the previous 500 registers of data.

Viewing the Previous 100 Registers of Data

Press [P] from the Database View menu to display the previous 100 registers of data.

Skipping 500 Registers of Data

Hold down [Shift] and press [=] to skip forward to the next 500 registers of data.

Viewing the Next 100 Registers of Data

Press [N] from the Database View menu to select and display the next 100 registers of data.

Viewing Data in Decimal Format

Press [D] to display the data on the current page in decimal format.

Viewing Data in Hexadecimal Format

Press [H] to display the data on the current page in hexadecimal format.

Viewing Data in Floating Point Format

Press [F] from the Database View menu. Use this command to display the data on the current page in floating point format. The program assumes that the values are aligned on even register boundaries. If floating-point values are not aligned as such, they are not displayed properly.

Viewing Data in ASCII (Text) Format

Press [A] to display the data on the current page in ASCII format. This is useful for regions of the database that contain ASCII data.

Returning to the Main Menu

Press [M] to return to the Main Menu.

Page 50 of 80 ProSoft Technology, Inc.

October 31, 2008

Diagnostics and Troubleshooting MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

4.1.5 Backplane Menu

Press [B] from the Main Menu to view the Backplane Data Exchange List. Use this command to display the configuration and statistics of the backplane data transfer operations. Press [?] to view a list of commands available on this menu.

Redisplaying the Menu

Press [?] to display the current menu. Use this command when you are looking at a screen of data, and want to view the menu choices available to you.

Viewing Version Information

Press [V] to view Version information for the module. Use this command to view the current version of the software for the module, as

well as other important values. You may be asked to provide this information when calling for technical support on the product.

Values at the bottom of the display are important in determining module operation. The Program Scan Counter value is incremented each time a module's program cycle is complete.

Tip: Repeat this command at one-second intervals to determine the frequency of program

execution.

Returning to the Main Menu

Press [M] to return to the Main Menu.

Viewing Configuration Information

Press [C] to view configuration information for the selected port, protocol, driver or device.

Viewing Backplane Diagnostic Information

Press [D] to view Backplane Diagnostic information. Use this command to display the configuration and statistics of the backplane

data transfer operations between the module and the processor. The information on this screen can help determine if there are communication problems between the processor and the module.

ProSoft Technology, Inc. Page 51 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Diagnostics and Troubleshooting Siemens 3964R Protocol

Tip: Repeat this command at one-second intervals to determine the number of blocks transferred

each second

4.1.6 Protocol Serial 3964R Menu

Press [0] or [1] to view protocol serial information for ports 1 and 2, respectively. Use this command to view a variety of error and status screens for the port. Press [?] to view a list of commands available on this menu.

Redisplaying the Menu

Press [?] to display the current menu. Use this command when you are looking at a screen of data, and want to view the menu choices available to you.

Viewing Version Information

Press [V] to view Version information for the module. Use this command to view the current version of the software for the module, as

well as other important values. You may be asked to provide this information when calling for technical support on the product.

Values at the bottom of the display are important in determining module operation. The Program Scan Counter value is incremented each time a module's program cycle is complete.

Tip: Repeat this command at one-second intervals to determine the frequency of program

execution.

Returning to the Main Menu

Press [M] to return to the Main Menu.

Viewing Configuration Information

Press [C] to view configuration information for the selected port, protocol, driver or device.

Page 52 of 80 ProSoft Technology, Inc.

October 31, 2008

Diagnostics and Troubleshooting MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

Opening the Serial Port Menu

Press [S] to open the Serial Port menu. Use this command to view and change additional serial port driver settings.

Viewing Error and Status Data

Press [E] to display the error/status data for the module.

4.2 LED Status Indicators

The LEDs indicate the module's operating status as follows:

Module Color Status Indication

CFG Green

APP Status Amber

BP ACT Amber

OK Red/

Green

Off

On Data being transferred between master and port 1. P1 Green Off No data On Data being transferred between master and port 2. P2 Green Off No data Off

On The MVI69-3964R is working normally. On

Off

Green The module is operating normally. Red

Off The battery voltage is OK and functioning. BAT Red On

Data is being transferred between the module and a remote terminal using the Configuration/Debug port.

No data is being transferred on the Configuration/Debug port.

The MVI69-3964R module program has recognized a communication error.

The LED is on when the module is performing a write operation on the backplane.

The LED is off when the module is performing a read operation on the backplane. Under normal operation, the LED should blink rapidly on and off.

The card is not receiving any power and is not securely plugged into the rack.

The program has detected an error or is being configured. If the LED remains red for over 10 seconds, the program has probably halted. Remove the card from the rack and re-insert the card to restart the module's program.

The battery voltage is low or battery is not present. Allow battery to charge by keeping module plugged into rack for 24 hours. If BAT LED still does not go off, contact ProSoft Technology, as this is not a user serviceable item.

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.

4.2.1 Clearing a Fault Condition

Typically, if the OK LED on the front of the module turns red for more than ten seconds, a hardware problem has been detected in the module, or the program has exited.

ProSoft Technology, Inc. Page 53 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Diagnostics and Troubleshooting Siemens 3964R Protocol

To clear the condition, follow these steps:

1 Turn off power to the rack 2 Remove the card from the rack 3 Verify that all jumpers are set correctly 4 If the module requires a Compact Flash card, verify that the card is installed

correctly

5 Re-insert the card in the rack and turn the power back on 6 Verify the configuration data being transferred to the module from the

CompactLogix or MicroLogix processor. 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 Support.

4.2.2 Troubleshooting

Use the following troubleshooting steps if you encounter problems when the module is powered up. If these steps do not resolve your problem, please contact ProSoft Technology Technical Support.

Processor Errors

Problem Description Steps to take

Processor Fault

Processor I/O LED flashes

Verify that the module is plugged into the slot that has been configured for the module.

Verify that the slot in the rack configuration has been set up correctly in the ladder logic.

This indicates a problem with backplane communications. Verify that all modules in the rack are configured in the ladder logic.

Module has a power supply distance rating of 2 on Compact Logix. The module must be within 2 slots of the power supply on Compact Logix, or that the MicroLogix backplane can supply the 800ma required for the modul e.

Module Errors

Problem Description Steps to take

BP ACT LED remains off or blinks slowly

OK LED remains red

This indicates that backplane transfer operations are failing. Connect to the module's Configuration/Debug port to check this.

To establish backplane communications, verify the following items:

 The processor is in Run mode.  The backplane driver is loaded in the module.  The module is configured for read and write block data transfer.  The ladder logic handles all read and write block situations.  The module is configured in the processor.

The program has halted or a critical error has occurred. Connect to the Configuration/Debug port to see if the module is running. If the program has halted, turn off power to the rack, remove the card from the rack and reinsert the card in the rack, and then restore power to the rack.

Page 54 of 80 ProSoft Technology, Inc.

October 31, 2008

Reference MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

5 Reference

In This Chapter

 Product Specifications...........................................................................55

 Functional Overview..............................................................................57

 Cable Connections................................................................................65

 Reference Documents...........................................................................69

 Status Data............................................................................................69

 Error Codes...........................................................................................70

5.1 Product Specifications

The MVI69 S3964R module from ProSoft Technology allows point-to-point communication between a CompactLogix processor and a partner with 3964R (with or without RK512) communication capability.

The 3964R protocol was designed by Siemens for bi-directional data communication through a point-to-point connection. It is a peer to peer protocol with read and write access. A BCC checksum ensures the integrity of the transfer.

5.1.1 General Specifications

 Single Slot - 1769 backplane compatible  The module is recognized as an Input/Output module and has access to

processor memory for data transfer between processor and module

 Ladder Logic is used for data transfer between module and processor.

Sample ladder file included.

 Configuration data obtained from configuration text file downloaded to

module. Sample configuration file included.

 Supports all CompactLogix processors: L20/L23/L30/L31/L32/L35, L43 and

L45 (L43 and L45 supported with RSLogix 5000 v16.03 or later)

 Also supports MicroLogix 1500 LRP

ProSoft Technology, Inc. Page 55 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Reference Siemens 3964R Protocol

5.1.2 Hardware Specifications

Specification Description

Dimensions Standard 1769 Single-slot module Current Load 800 mA max@ 5 VDC

Power supply distance rating of 2 (L43 and L45

installations on first 2 slots of 1769 bus) Operating Temp. 0 to 60°C (32 to 140°F) Storage Temp. -40 to 85°C (-40 to 185°F) Relative Humidity 5% to 95% (non-condensing) LED Indicators Battery and Module Status

Application Status

Serial Port Activity

CFG Port Activity CFG Port (CFG) RJ45 (DB-9F with supplied cable)

RS-232 only

No hardware handshaking App Ports (P1,P2) (Serial modules) RS-232 or RS-422 (jumper selectable)

RJ45 (DB-9F with supplied cable)

RS-232 handshaking configurable

500V Optical isolation from backplane Shipped with Unit RJ45 to DB-9M cables for each port

6-foot RS-232 configuration Cable

5.1.3 Functional Specifications

 Single-slot, CompactLogix I/O compatible  Multiple modules can be placed in a rack up to the chassis power supply limit  While in 3964R with RK512 mode on PRT1 and PRT2, DB-SEND and DB-

FETCH instructions can be initiated from the CompactLogix processor or received by the communications partner

 While in 3964R without RK512 mode on PRT1 and PRT2, data can be sent

from the CompactLogix processor or be received from the communications partner

 The maximum transfer size is 512 bytes in any mode  Data byte swapping can be configured to adjust to a different word format  While in 3964R with RK512 mode on PRT1 and PRT2, evaluation of the

header information DB (data block), DW (data word) and coordination bytes 9 and 10 is possible

 Communication activity and diagnostics are available through LEDs and

acknowledgment telegrams

Page 56 of 80 ProSoft Technology, Inc.

October 31, 2008

Reference MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

5.2 Functional Overview

5.2.1 Products in the Environment

The 3964R protocol can be installed in all local CompactLogix or MicroLogix chassis with at least one controller.

You can obtain more information about CompactLogix or MicroLogix and the CompactLogix or MicroLogix environment through your Rockwell Automation branch office.

Product Compatibility

The communication between the MVI69 and the CompactLogix or MicroLogix processor is realized through the module's Input/Output Images.

5.2.2 3964R Protocol Overview

The 3964R Protocol in General

The 3964R protocol defined by Siemens is used for bi-directional data exchange between two peers through a bit-serial point-to-point connection. This protocol may be additionally embedded in the RK512 telegram level. If 3964R is used with RK512, each participant can send jobs to its partner and has read (DB-FETCH) and write access (DB-SEND) to the partner's data. The data exchange is realized in the form of messages and response messages. The maximum user data volume is 512 byte per job and 128 byte per message.

3964R without RK512 allows only block wise sending and receiving of data. The detailed handshake procedure through messages and response messages is not applicable in this case.

If both partners want to send a job (3964R with RK512) or data (3964R without RK512) at the same time, the resulting initialization conflict will be solved through the high/low priority setup. In such a case one partner will be allocated high priority and the other one low priority. Thus, in case of an initialization conflict the device with low priority will defer its job whereas the device with the high priority will be able to send a job.

The safety of data transmission on the line is guaranteed by a BCC checksum. You should have sufficient knowledge about the 3964R protocol in order to

understand the operation of the driver for the MVI69-S3964R and to make efficient use of the example programs.

ProSoft Technology, Inc. Page 57 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Reference Siemens 3964R Protocol

MVI69-S3964R Operation

The protocol realized on the MVI69-S3964R has the following special features:  Immediately after power-up and completion of the internal/external

initialization procedures the MVI69-S3964R with installed 3964R protocol is ready to serve as an interface between a CompactLogix or MicroLogix processor and one or two communication partners using 3964R protocol. The parameterization of the module is realized through a configuration file. This is where a differentiation between the communication modes 3964R with RK512 and 3964R without RK512 takes place.

 The communication mode 3964R without RK512 supports processing of up to

512 bytes.

 The serial transmission parameters are optional and can be allocated

independently to each interface. Possible baud rates are 300 to 115200. The following parity setups are possible: Even, Odd and None.

5.2.3 General Concepts

Module Power Up

On power up the module begins performing the following logical functions:  Initialize hardware components

o Initialize CompactLogix or MicroLogix backplane driver o Test and Clear all RAM o Initialize the serial communication ports

 Read module configuration from the Compact Flash  Initialize Module Register space  Set up the communication interface for the debug/configuration port

When this initialization procedure is complete, the module will begin communicating with other nodes on the network, depending on the configuration.

Page 58 of 80 ProSoft Technology, Inc.

October 31, 2008

Reference MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

Main Logic Loop

Upon completing the power up configuration process, the module enters an infinite loop that performs the functions shown in the following diagram.

Backplane Data Transfer

Receive from CP

ProSoft Technology, Inc. Page 59 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Reference Siemens 3964R Protocol

Send to CP

Request from CP

Block ID for the transfer of data from the processor to the module to be sent out the serial port

9 X X X

9 Always 9 0 Not Last Block 1 Block 1 1 Port 1 9 Last block 2 Block 2 2 Port 2 3 Block 3 4 Block 4 5 Block 5 9011 First block for port 1

9921 Second and last block for port 1 9912 First and last block for port 2

Page 60 of 80 ProSoft Technology, Inc.

October 31, 2008

Reference MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

Send Block for Module to send to CP (Block 1)

Offset Data Length

0 9X1X 1 1 Header 10 11 Data 50

Send Block for Module to send to CP (Blocks 2 to 4)

Offset Data Length

0 9X2X, 9X3X, 9X4X 1 1 Data 60

Request for data Block from Module to respond to CP

Offset Data Length

0 910X 1 1 Reserved 2 3 1145h 1 4 Data Block (DB) 1 5 Data Word (DW) 1 6 Number of Data Words 1 7 Coordination Bytes 1 8 Data Type (4Dh/44h) 1 9 to 12 Reserved 4

Receive Data from CP (First Block)

Offset Data Length

0 910X 1 1 Reserved 1 2 Data Block 1 1 3 1141h/11FFh 1 4 Data Block (DB) 1 5 Data Word (DW) 1 6 Number of Data Words 1 7 Coordination Bytes 1 8 Data Type (4Dh/44h) 1 9 to 12 Reserved 4 13 Data 49

Receive Data from CP (Blocks 2 to 4)

Offset Data Length

0 910X 1 1 Reserved 1 2 Data Block (2 to 4) 1 3 Data 59

ProSoft Technology, Inc. Page 61 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Reference Siemens 3964R Protocol

Receive Data from CP (Block 5)

Offset Data Length

0 910X 1 1 Reserved 1 2 Data Block (5) 1 3 Data 30

5.2.4 Communications

Job Allocation by the CompactLogix or MicroLogix Controller

This section describes the different types of jobs and the relevant parameters to be entered. For a better understanding a printout of the sample ladder file is recommended.

Every job that is transferred to or from the MVI69-S3964R consists of defined header data and user data.

The Job structure in general:

Word: High Byte: Low Byte:

0 Header data

.. ..

9 Header data 10 User data

.. ..

137 User data

Header Data

The header data consists of 10 words with a job identifier and parameter data. The header data is to be entered either in the file HEADER_P1 to send to port 1

or the file HEADER_P2 to send to port 2. The header in general:

Word: High Byte: Low Byte:

0 Job identifier (hex) 1 00 Data Block (DB) 2 00 Data Word (DW) 3 Number of data words/data bytes 4 Coordination byte 9 Coordination byte 10 5 00 Data Type 6 00 00 7 00 00 8 00 00 9 00 00

Page 62 of 80 ProSoft Technology, Inc.

October 31, 2008

Reference MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

The meaning of the entries and possible values are described below.

Job Identifier

The job identifiers are defined as follows:

Send jobs to a CP:

Job: Identifier:

3964R with RK512: DB-SEND to CP 0041hex 3964R with RK512: DB-FETCH to CP 0045hex

The MVI69-S3964R receives jobs from a CP automatically without extra parameterization. To differentiate the header data the MVI69-S3964R adds a header to the user data received and transfers it to the CompactLogix or MicroLogix processor.

Receive jobs from a CP

Job: Identifier:

3964R with RK512: DB-SEND from CP 1141hex 3964R with RK512: DB-FETCH from CP 1145hex

Data Block (DB)

Number of the data block. This data block must exist in the communication partner (3964R with RK512 only, otherwise to be set to "0").

Data Word (DW)

Number of the data word in the selected data block. The selected data block must contain this number (3964R with RK512 only, otherwise to be set to "0").

Number of Data Words/Data Bytes

Dependent on the type of communication mode used on port 1/2 of the module, this value will be interpreted as number of data words. This value defines whether a job will be carried out with or without subsequent telegram. For jobs without subsequent telegram the value will be 1 ... 64 words (1 … 128 bytes), and for jobs with subsequent telegram(s) it will be 65 ... 256 words (129 … 512 bytes).

Coordination Byte 9/10

3964R with RK512 send jobs offer the possibility of entering so called coordination bytes (byte 9 and 10 in the RK512 telegram header). Otherwise to be set to "0".

Data Type

The send message can request a data type of Data Words (44h) or Marker (4Dh). If the value is 0 (zero), then data words is used.

ProSoft Technology, Inc. Page 63 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Reference Siemens 3964R Protocol

Receive Jobs

To receive jobs from a CP only, no additional parameterization is necessary. The user data received is stored in a file in the CompactLogix or MicroLogix processor.

The following table shows an example of the data stored in HeaderCom1 in case of a DB-Send from a CP. The CP is connected to port 1.

Word: High Byte: Low Byte:

0 1141hex 1 00 Data Block (DB) 2 00 Data Word (DW) 3 Number of data words (total number) 1 4 Number of data words (actual block) 2 5 00 00 6 00 00 7 00 00 8 00 00 9 00 00

= This is the total number of data words for the whole job.

= This is the number of data words stored in RecvDataCom1.

The user data is copied to RecvDataCom1. This is the file you should operate with.

For port 2, which is similar to port 1, the file for storing the user data received is called RecvDataCom2.

Send Jobs

To send a job to a CP, Next, define the appropriate header for the job. The following table shows an example of the header data for a DB-Send job to a CP with the following parameters:

DB = 10, DW = 0, 128 words, coordination byte 9 = FFhex, coordination byte 10 = FFhex, Data Type = 44hex.

Word: High Byte: Low Byte:

0 0041hex 1 00 10 2 00 0 3 80hex (= 128dec) 4 FFhex FFhex 5 00 44hex 6 00 00 7 00 00 8 00 00 9 00 00

A DB-Fetch job will be parameterized similar to the example above. To send with 3964R without RK512 to a CP (identifier 00FFhex), the values for

DB, DW and the coordination bytes will be ignored and can be set to "0".

Page 64 of 80 ProSoft Technology, Inc.

October 31, 2008

Reference MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

5.2.5 Job Processing

Both ports can be used independently from each other (multi tasking). A possible initialization conflict will be solved as follows: MVI69-S3964R has "High Priority": The MVI69-S3964R retries the sending of the 3964R start character (STX) 3

times and waits for the CP to send the 3964R acknowledge (DLE). If the CP does not send the acknowledge as expected the communication will fail and has to be restarted.

MVI69-S3964R has "Low Priority": The MVI69-S3964R rejects its send job and sends the 3964R acknowledge

(DLE) to the CP.

Important: If the MVI69-S3964R has rejected its send job due to "Low Priority", you must restart its

send job completely (starting with the copying of the job data).

5.3 Cable Connections

The application ports on the MVI69-S3964R module support RS-232 and RS-422 interfaces. Please look at the module to ensure that the jumpers are set correctly to correspond with the type of interface you are using.

Note: When using RS-232 with radio modem applications, some radios or modems require

hardware handshaking (control and monitoring of modem signal lines). Enable this in the configuration of the module by setting the UseCTS parameter to 1.

5.3.1 RS-232 Configuration/Debug Port

This port is physically an RJ45 connection. An RJ45 to DB-9 adapter cable is included with the module. This port permits a PC based terminal emulation program to view configuration and status data in the module and to control the module. The cable for communications on this port is shown in the following diagram:

ProSoft Technology, Inc. Page 65 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Reference Siemens 3964R Protocol

Disabling the RSLinx Driver for the Com Port on the PC

The communication port driver in RSLinx can occasionally prevent other applications from using the PC's COM port. If you are not able to connect to the module's configuration/debug port using ProSoft Configuration Builder (PCB), HyperTerminal or another terminal emulator, follow these steps to disable the RSLinx Driver.

1 Open RSLinx and go to Communications>RSWho 2 Make sure that you are not actively browsing using the driver that you wish to

stop. The following shows an actively browsed network:

3 Notice how the DF1 driver is opened, and the driver is looking for a processor

on node 1. If the network is being browsed, then you will not be able to stop this driver. To stop the driver your RSWho screen should look like this:

Branches are displayed or hidden by clicking on the

4 When you have verified that the driver is not being browsed, go to

Communications>Configure Drivers

or the icons.

Page 66 of 80 ProSoft Technology, Inc.

October 31, 2008

Reference MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

You may see something like this:

If you see the status as running, you will not be able to use this com port for anything other than communication to the processor. To stop the driver press the "Stop" on the side of the window:

5 After you have stopped the driver you will see the following:

6 Upon seeing this, you may now use that com port to connect to the debug

port of the module.

Note: You may need to shut down and restart your PC before it will allow you to stop the driver

(usually only on Windows NT machines). If you have followed all of the above steps, and it will not stop the driver, then make sure you do not have RSLogix open. If RSLogix is not open, and you still cannot stop the driver, then reboot your PC.

ProSoft Technology, Inc. Page 67 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Reference Siemens 3964R Protocol

5.3.2 RS-232

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, the cable to connect to the port is as shown below:

5.3.3 RS-232 Cable

The assignment of the RS-232 connection cable between PRT1/2 (9 pole) and CP-544 (25 pole) is as follows:

PRT1/2 Pin Description CP 544 Pin Description

2 RxD 2 TxD 3 TxD 3 RxD 5 Gnd 7 Gnd

Important: The other pins of the RS-232 must not be used.

5.3.4 RS-422

RS-422 Tip

If communication in the RS-422 mode does not work at first, despite all attempts, try switching termination polarities. Some manufacturers interpret +/- and A/B polarities differently.

Page 68 of 80 ProSoft Technology, Inc.

October 31, 2008

Reference MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

5.3.5 DB9 to RJ45 Adaptor (Cable 14)

5.4 Reference Documents

Siemens

Simatic CP544 Handbuch zum Kommunikationspartner CP544 Ausgabe 01 Bestell-Nr. 6ES5 998-2DB11

5.5 Status Data

Value Description

0 Pass Count 1 Product 3 Code 5 Revision 7 Operating System 9 Run Number 11 Port 1 Requests 12 Port 1 Responses 13 Port 1 Errors Sent 14 Port 1 Errors Received 15 Port 1 DLE Not Received

ProSoft Technology, Inc. Page 69 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Reference Siemens 3964R Protocol

Value Description

16 Port 1 STX Not Received 17 Port 2 Requests 18 Port 2 Responses 19 Port 2 Errors Sent 20 Port 2 Errors Received 21 Port 2 DLE Not Received 22 Port 2 STX Not Received 23 Backplane Writes 24 Backplane Reads 25 Backplane blocks parsed 26 Backplane Errors 27 Port 1 Current Error 28 Port 1 Last Error 29 Port 2 Current Error 30 Port 2 Last Error

5.6 Error Codes

Error Code Description

-2 0xFFFE DLE could not be sent

-10 0xFFF6 DLE not received in time

-11 0xFFF5 Communication Timeout occurred

-20 0xFFEC Invalid character or acknowledge received

-30 0xFFE2 Amount of user data is 0 or greater than 256 words

-31 0xFFE1 Reject pending job from the processor due to low priority

-32 0xFFE0 No reaction (STX) from Communication Partner

-33 0xFFDF Communication Partner error occurred

-34 0xFFDE Job code not defined

-35 0xFFDD High/High (priority) initialization conflict occurred

-36 0xFFDC First Header Byte does not match telegram type

-37 0xFFDB Character received was not an STX

-38 0xFFDA

-39 0xFFD9 S3964R communication could not be established/finished

S3964R problem occurred after connection to Communication Partner was established

Page 70 of 80 ProSoft Technology, Inc.

October 31, 2008

Support, Service & Warranty MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

6 Support, Service & W arranty

In This Chapter

 How to Contact Us: Technical Support..................................................71

 Return Material Authorization (RMA) Policies and Conditions...............72

 LIMITED WARRANTY...........................................................................74

ProSoft Technology, Inc. (ProSoft) is committed to providing the most efficient and effective support possible. Before calling, please gather the following information to assist in expediting this process:

1 Product Version Number 2 System architecture 3 Network details

If the issue is hardware related, we will also need information regarding: 1 Module configuration and contents of file

o Module Operation o Configuration/Debug status information o LED patterns

2 Information about the processor and user data files as viewed through and

LED patterns on the processor.

3 Details about the serial devices interfaced, if any.

6.1 How to Contact Us: Technical Support

Internet Web Site: http://www.prosoft-technology.com/support

(http://www.prosoft-technology.com/support) E-mail address: support@prosoft-technology.com

(mailto:support@prosoft-technology.com)

Asia Pacific

+603.7724.2080, support.asia@prosoft-technology.com (mailto:support.asia@prosoft-technology.com)

Languages spoken include: Chinese, English

Europe (location in Toulouse, France)

+33 (0) 5.34.36.87.20, support.EMEA@prosoft-technology.com (mailto:support.emea@prosoft-technology.com)

Languages spoken include: French, English

ProSoft Technology, Inc. Page 71 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Support, Service & Warranty Siemens 3964R Protocol

North America/Latin America (excluding Brasil) (location in California)

+1.661.716.5100, support@prosoft-technology.com (mailto:support@prosofttechnology.com)

Languages spoken include: English, Spanish

For technical support calls within the United States, an after-hours answering system allows pager access to one of our qualified technical and/or application support engineers at any time to answer your questions.

Brasil (location in Sao Paulo)

+55-11-5084-5178 , eduardo@prosoft-technology.com (mailto:eduardo@prosofttechnology.com)

Languages spoken include: Portuguese, English

6.2 Return Material Authorization (RMA) Policies and Conditions

The following RMA Policies and Conditions (collectively, "RMA Policies") apply to any returned Product. These RMA Policies are subject to change by ProSoft without notice. For warranty information, see "Limited Warranty". In the event of any inconsistency between the RMA Policies and the Warranty, the Warranty shall govern.

6.2.1 All Product Returns:

a) In order to return a Product for repair, exchange or otherwise, the

Customer must obtain a Returned Material Authorization (RMA) number from ProSoft and comply with ProSoft shipping instructions.

b) In the event that the Customer experiences a problem with the Product for

any reason, Customer should contact ProSoft Technical Support at one of the telephone numbers listed above (page 71). A Technical Support Engineer will request that you perform several tests in an attempt to isolate the problem. If after completing these tests, the Product is found to be the source of the problem, we will issue an RMA.

c) All returned Products must be shipped freight prepaid, in the original

shipping container or equivalent, to the location specified by ProSoft, and be accompanied by proof of purchase and receipt date. The RMA number is to be prominently marked on the outside of the shipping box. Customer agrees to insure the Product or assume the risk of loss or damage in transit. Products shipped to ProSoft using a shipment method other than that specified by ProSoft or shipped without an RMA number will be returned to the Customer, freight collect. Contact ProSoft Technical Support for further information.

d) A 10% restocking fee applies to all warranty credit returns whereby a

Customer has an application change, ordered too many, does not need, etc.

Page 72 of 80 ProSoft Technology, Inc.

October 31, 2008

Support, Service & Warranty MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

6.2.2 Procedures for Return of Units Under Warranty:

A Technical Support Engineer must approve the return of Product under ProSoft's Warranty:

a) A replacement module will be shipped and invoiced. A purchase order will

be required.

b) Credit for a product under warranty will be issued upon receipt of

authorized product by ProSoft at designated location referenced on the Return Material Authorization.

6.2.3 Procedures for Return of Units Out of Warranty:

a) Customer sends unit in for evaluation b) If no defect is found, Customer will be charged the equivalent of $100

USD, plus freight charges, duties and taxes as applicable. A new purchase order will be required.

c) If unit is repaired, charge to Customer will be 30% of current list price

(USD) plus freight charges, duties and taxes as applicable. A new purchase order will be required or authorization to use the purchase order submitted for evaluation fee.

The following is a list of non-repairable units:

o 3150 - All o 3750 o 3600 - All o 3700 o 3170 - All o 3250 o 1560 - Can be repaired, only if defect is the power supply o 1550 - Can be repaired, only if defect is the power supply o 3350 o 3300 o 1500 - All

6.2.4 Purchasing Warranty Extension:

a) ProSoft's standard warranty period is three (3) years from the date of

shipment as detailed in "Limited Warranty (page 74)". The Warranty Period may be extended at the time of equipment purchase for an additional charge, as follows:

• Additional 1 year = 10% of list price

• Additional 2 years = 20% of list price

• Additional 3 years = 30% of list price

ProSoft Technology, Inc. Page 73 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Support, Service & Warranty Siemens 3964R Protocol

6.3 LIMITED WARRANTY

This Limited Warranty ("Warranty") governs all sales of hardware, software and other products (collectively, "Product") manufactured and/or offered for sale by ProSoft, and all related services provided by ProSoft, including maintenance, repair, warranty exchange, and service programs (collectively, "Services"). By purchasing or using the Product or Services, the individual or entity purchasing or using the Product or Services ("Customer") agrees to all of the terms and provisions (collectively, the "Terms") of this Limited Warranty. All sales of software or other intellectual property are, in addition, subject to any license agreement accompanying such software or other intellectual property.

6.3.1 What Is Covered By This Warranty

a) Warranty On New Products: ProSoft warrants, to the original purchaser,

that the Product that is the subject of the sale will (1) conform to and perform in accordance with published specifications prepared, approved and issued by ProSoft, and (2) will be free from defects in material or workmanship; provided these warranties only cover Product that is sold as new. This Warranty expires three years from the date of shipment (the "Warranty Period"). If the Customer discovers within the Warranty Period a failure of the Product to conform to specifications, or a defect in material or workmanship of the Product, the Customer must promptly notify ProSoft by fax, email or telephone. In no event may that notification be received by ProSoft later than 39 months. Within a reasonable time after notification, ProSoft will correct any failure of the Product to conform to specifications or any defect in material or workmanship of the Product, with either new or used replacement parts. Such repair, including both parts and labor, will be performed at ProSoft's expense. All warranty service will be performed at service centers designated by ProSoft.

b) Warranty On Services: Materials and labor performed by ProSoft to repair

a verified malfunction or defect are warranteed in the terms specified above for new Product, provided said warranty will be for the period remaining on the original new equipment warranty or, if the original warranty is no longer in effect, for a period of 90 days from the date of repair.

6.3.2 What Is Not Covered By This Warranty

a) ProSoft makes no representation or warranty, expressed or implied, that

the operation of software purchased from ProSoft will be uninterrupted or error free or that the functions contained in the software will meet or satisfy the purchaser's intended use or requirements; the Customer assumes complete responsibility for decisions made or actions taken based on information obtained using ProSoft software.

Page 74 of 80 ProSoft Technology, Inc.

October 31, 2008

Support, Service & Warranty MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

b) This Warranty does not cover the failure of the Product to perform

specified functions, or any other non-conformance, defects, losses or damages caused by or attributable to any of the following: (i) shipping; (ii) improper installation or other failure of Customer to adhere to ProSoft's specifications or instructions; (iii) unauthorized repair or maintenance; (iv) attachments, equipment, options, parts, software, or user-created programming (including, but not limited to, programs developed with any IEC 61131-3, "C" or any variant of "C" programming languages) not furnished by ProSoft; (v) use of the Product for purposes other than those for which it was designed; (vi) any other abuse, misapplication, neglect or misuse by the Customer; (vii) accident, improper testing or causes external to the Product such as, but not limited to, exposure to extremes of temperature or humidity, power failure or power surges; or (viii) disasters such as fire, flood, earthquake, wind and lightning.

c) The information in this Agreement is subject to change without notice.

ProSoft shall not be liable for technical or editorial errors or omissions made herein; nor for incidental or consequential damages resulting from the furnishing, performance or use of this material. The user guide included with your original product purchase from ProSoft contains information protected by copyright. No part of the guide may be duplicated or reproduced in any form without prior written consent from ProSoft.

6.3.3 Disclaimer Regarding High Risk Activities

Product manufactured or supplied by ProSoft is not fault tolerant and is not designed, manufactured or intended for use in hazardous environments requiring fail-safe performance including and without limitation: the operation of nuclear facilities, aircraft navigation of communication systems, air traffic control, direct life support machines or weapons systems in which the failure of the product could lead directly or indirectly to death, personal injury or severe physical or environmental damage (collectively, "high risk activities"). ProSoft specifically disclaims any express or implied warranty of fitness for high risk activities.

6.3.4 Intellectual Property Indemnity

Buyer shall indemnify and hold harmless ProSoft and its employees from and against all liabilities, losses, claims, costs and expenses (including attorney's fees and expenses) related to any claim, investigation, litigation or proceeding (whether or not ProSoft is a party) which arises or is alleged to arise from Buyer's acts or omissions under these Terms or in any way with respect to the Products. Without limiting the foregoing, Buyer (at its own expense) shall indemnify and hold harmless ProSoft and defend or settle any action brought against such Companies to the extent based on a claim that any Product made to Buyer specifications infringed intellectual property rights of another party. ProSoft makes no warranty that the product is or will be delivered free of any person's claiming of patent, trademark, or similar infringement. The Buyer assumes all risks (including the risk of suit) that the product or any use of the product will infringe existing or subsequently issued patents, trademarks, or copyrights.

ProSoft Technology, Inc. Page 75 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Support, Service & Warranty Siemens 3964R Protocol

a) Any documentation included with Product purchased from ProSoft is

protected by copyright and may not be duplicated or reproduced in any form without prior written consent from ProSoft.

b) ProSoft's technical specifications and documentation that are included

with the Product are subject to editing and modification without notice.

c) Transfer of title shall not operate to convey to Customer any right to make,

or have made, any Product supplied by ProSoft.

d) Customer is granted no right or license to use any software or other

intellectual property in any manner or for any purpose not expressly permitted by any license agreement accompanying such software or other intellectual property.

e) Customer agrees that it shall not, and shall not authorize others to, copy

software provided by ProSoft (except as expressly permitted in any license agreement accompanying such software); transfer software to a third party separately from the Product; modify, alter, translate, decode, decompile, disassemble, reverse-engineer or otherwise attempt to derive the source code of the software or create derivative works based on the software; export the software or underlying technology in contravention of applicable US and international export laws and regulations; or use the software other than as authorized in connection with use of Product.

f) Additional Restrictions Relating To Software And Other Intellectual

Property In addition to compliance with the Terms of this Warranty, Customers

purchasing software or other intellectual property shall comply with any license agreement accompanying such software or other intellectual property. Failure to do so may void this Warranty with respect to such software and/or other intellectual property.

6.3.5 Disclaimer of all Other Warranties

The Warranty set forth in What Is Covered By This Warranty (page 74) are in lieu of all other warranties, express or implied, including but not limited to the implied warranties of merchantability and fitness for a particular purpose.

6.3.6 Limitation of Remedies **

In no event will ProSoft or its Dealer be liable for any special, incidental or consequential damages based on breach of warranty, breach of contract, negligence, strict tort or any other legal theory. Damages that ProSoft or its Dealer will not be responsible for included, but are not limited to: Loss of profits; loss of savings or revenue; loss of use of the product or any associated equipment; loss of data; cost of capital; cost of any substitute equipment, facilities, or services; downtime; the claims of third parties including, customers of the Purchaser; and, injury to property.

** Some areas do not allow time limitations on an implied warranty, or allow the exclusion or limitation of incidental or consequential damages. In such areas, the above limitations may not apply. This Warranty gives you specific legal rights, and you may also have other rights which vary from place to place.

Page 76 of 80 ProSoft Technology, Inc.

October 31, 2008

Support, Service & Warranty MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

6.3.7 Time Limit for Bringing Suit

Any action for breach of warranty must be commenced within 39 months following shipment of the Product.

6.3.8 No Other Warranties

Unless modified in writing and signed by both parties, this Warranty is understood to be the complete and exclusive agreement between the parties, suspending all oral or written prior agreements and all other communications between the parties relating to the subject matter of this Warranty, including statements made by salesperson. No employee of ProSoft or any other party is authorized to make any warranty in addition to those made in this Warranty. The Customer is warned, therefore, to check this Warranty carefully to see that it correctly reflects those terms that are important to the Customer.

6.3.9 Allocation of Risks

This Warranty allocates the risk of product failure between ProSoft and the Customer. This allocation is recognized by both parties and is reflected in the price of the goods. The Customer acknowledges that it has read this Warranty, understands it, and is bound by its Terms.

6.3.10 Controlling Law and Severability

This Warranty shall be governed by and construed in accordance with the laws of the United States and the domestic laws of the State of California, without reference to its conflicts of law provisions. If for any reason a court of competent jurisdiction finds any provisions of this Warranty, or a portion thereof, to be unenforceable, that provision shall be enforced to the maximum extent permissible and the remainder of this Warranty shall remain in full force and effect. Any cause of action with respect to the Product or Services must be instituted in a court of competent jurisdiction in the State of California.

ProSoft Technology, Inc. Page 77 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Support, Service & Warranty Siemens 3964R Protocol

Page 78 of 80 ProSoft Technology, Inc.

October 31, 2008

Index MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Siemens 3964R Protocol

Database View Menu • 49 DB9 to RJ45 Adaptor (Cable 14) • 69 Diagnostics and Troubleshooting • 7, 41, 43

Index

[

[3964R Port x] • 26 [Backplane 69] • 26 [Module] • 26

3964R Protocol Overview • 57

Disabling the RSLinx Driver for the Com Port on the

PC • 66 Disclaimer of all Other Warranties • 76 Disclaimer Regarding High Risk Activities • 75 Displaying the Current Page of Registers Again • 49 Download the Project to the Module • 29 Download the Sample Program to the Processor • 17

Enable • 27 Error Codes • 70 Exiting the Program • 48 Explanations About the Example Programs • 32

9998 Warm Boot • 36 9999 Cold Boot • 36

Functional Overview • 7, 57 Functional Specifications • 56

ACK Delay • 28 Adding a Module • 23 Adding a Project • 23 Adding the Module to an Existing CompactLogix

Project • 37

Adding the Module to an Existing MicroLogix Project •

40 All Product Returns: • 72 Allocation of Risks • 77

Backplane Data Transfer • 59 Backplane Menu • 51 Backplane Object • 34 Battery Life Advisory • 2 Baud Rate • 27 Block Control Data • 35 Block Transfer Size • 26

Cable Connections • 65 Clearing a Fault Condition • 53 Clearing Diagnostic Data • 47 Commands • 36 Comment Entries • 25 Communications • 62 Configuring RSLinx • 18 Configuring the MVI69-S3964R Module • 21 Connect your PC to the Module • 20 Connect your PC to the Processor • 16 Controlling Law and Severability • 77 Coordination Byte 9/10 • 63

General Concepts • 58 General Specifications • 55 Guide to the MVI69-S3964R User Manual • 7

Hardware Specifications • 56 Header Data • 62 How to Contact Us

Technical Support • 71, 72

Install ProSoft Configuration Builder Software • 11 Install the Module in the Rack • 13 Intellectual Property Indemnity • 75 Introduction • 31

Job Allocation by the CompactLogix or MicroLogix

Controller • 62 Job Identifier • 63 Job Processing • 65

Keystrokes • 46

Ladder Logic • 31 LED Status Indicators • 7, 53 Limitation of Remedies ** • 76 LIMITED WARRANTY • 73, 74

Data Bits • 27 Data Block (DB) • 63 Data Type • 63 Data Word (DW) • 63

Main Logic Loop • 59 Main Menu • 46 Module Data Object • 33 Module Entries • 25

ProSoft Technology, Inc. Page 79 of 80 October 31, 2008

MVI69-S3964R ♦ CompactLogix or MicroLogix Platform Index Siemens 3964R Protocol

Module Name • 26 Module Power Up • 58 Moving Back Through 5 Pages of Registers • 50 MVI69-S3964R Operation • 58

Navigation • 45 No Other Warranties • 77 Number of Data Words/Data Bytes • 63

Opening the Backplane Menu • 47 Opening the Database Menu • 47 Opening the Protocol_Serial_S3964R Menu • 47 Opening the Serial Port Menu • 53

Package Contents • 10 Parity • 27 Pinouts • 65, 69 Please Read This Notice • 2 Port Errors • 35 Printing a Configuration File • 25 Priority • 28 Procedures for Return of Units Out of Warranty: • 73 Procedures for Return of Units Under Warranty: • 73 Product Compatibility • 57 Product Specifications • 7, 55 Products in the Environment • 57 ProSoft Configuration Builder • 21 ProSoft® Product Documentation • 3 Protocol • 28 Protocol Serial 3964R Menu • 52 Purchasing Warranty Extension: • 73

Reading Status Data from the Module • 43 Receive Jobs • 64 Receive jobs from a CP • 63 Redisplaying the Menu • 46, 51, 52 Reference • 7, 55 Reference Documents • 69 Required Hardware • 43 Return Material Authorization (RMA) Policies and

Conditions • 72 Returning to the Main Menu • 50, 51, 52 RS-232 • 68 RS-232 Cable • 68 RS-232 Configuration/Debug Port • 65 RS-422 • 68 RS-422 Tip • 68 RTS Off • 27 RTS On • 27

Setup Attempts • 28 Skipping 500 Registers of Data • 50 Start Here • 7, 9 Status Data • 32, 34, 43, 69 Status Interval • 26 Status Object (S3964RInStat Data Structure) • 34 Stop Bits • 27 Support, Service & Warranty • 7, 71 Swap • 28 System Requirements • 9

The 3964R Communication Program • 32 The 3964R Protocol in General • 57 The Configuration/Debug Menu • 44 Time Limit for Bringing Suit • 77 Transferring the Configuration File from MVI69 module

to PC • 47

Transferring the Configuration File from PC to MVI69

module • 48 Transmit Attempts • 28 Troubleshooting • 54

Use CTS Line • 28 User Data Objects • 36 Using the Diagnostic Window in ProSoft Configuration

Builder • 44

Viewing Backplane Diagnostic Information • 51 Viewing Configuration Information • 51, 52 Viewing Data in ASCII (Text) Format • 50 Viewing Data in Decimal Format • 50 Viewing Data in Floating Point Format • 50 Viewing Data in Hexadecimal Format • 50 Viewing Error and Status Data • 53 Viewing Register Pages • 49 Viewing the Next 100 Registers of Data • 50 Viewing the Previous 100 Registers of Data • 50 Viewing Version Information • 47, 51, 52

Warm Booting the Module • 48 What Is Covered By This Warranty • 74, 76 What Is Not Covered By This Warranty • 74

Your Feedback Please • 2

Send Jobs • 64 Set Module Parameters • 24 Set Up the Project • 22 Setting Jumpers • 12

Page 80 of 80 ProSoft Technology, Inc.

October 31, 2008

ProSoft Technology MVI69-S3964R User Manual

Specifications and Main Features

Frequently Asked Questions

User Manual