S3964R
ProLinx Gateway
Siemens 3964R Protocol
April 14, 2009
DRIVER MANUAL
Important Installation Instructions
Power, Input and Output (I/O) wiring must be in accordance with Class I, Division 2 wiring methods, Article 501-4 (b)
of the National Electrical Code, NFPA 70 for installation in the U.S., or as specified in Section 18-1J2 of the Canadian
Electrical Code for installations in Canada, and in accordance with the authority having jurisdiction. The following
warnings must be heeded:
A WARNING - EXPLOSION HAZARD - SUBSTITUTION OF COMPONENTS MAY IMPAIR SUITABILITY FOR
CLASS I, DIV. 2;
B WARNING - EXPLOSION HAZARD - WHEN IN HAZARDOUS LOCATIONS, TURN OFF POWER BEFORE
REPLACING OR WIRING MODULES, and
C WARNING - EXPLOSION HAZARD - DO NOT DISCONNECT EQUIPMENT UNLESS POWER HAS BEEN
SWITCHED OFF OR THE AREA IS KNOWN TO BE NONHAZARDOUS.
D "THIS DEVICE SHALL BE POWERED BY CLASS 2 OUTPUTS ONLY.
All ProLinx® Products
WARNING – EXPLOSION HAZARD – DO NOT DISCONNECT EQUIPMENT UNLESS POWER HAS BEEN
SWITCHED OFF OR THE AREA IS KNOWN TO BE NON-HAZARDOUS.
AVERTISSEMENT – RISQUE D'EXPLOSION – AVANT DE DÉCONNECTER L'EQUIPMENT, COUPER LE
COURANT OU S'ASSURER QUE L'EMPLACEMENT EST DÉSIGNÉ NON DANGEREUX.
Markings
ISA ISA 12.12.01 Class 1 Div 2
CSA/cUL C22.2 No. 213-1987
243333
CL I Div 2 GP A, B, C, D
Temp Code T5
II 3 G
Ex nA nL IIC T4 X
0° C <= Ta <= 60° C
II – Equipment intended for above ground use (not for use in mines).
3 – Category 3 equipment, investigated for normal operation only.
G – Equipment protected against explosive gasses.
ProLinx gateways with Ethernet Ports
Series C ProLinx™ gateways with Ethernet ports do NOT include the HTML Web Server. The HTML Web Server
must be ordered as an option. This option requires a factory-installed hardware addition. The HTML Web Server now
supports:
8 MB file storage for HTML files and associated graphics files (previously limited to 384K)
32K maximum HTML page size (previously limited to 16K)
To upgrade a previously purchased Series C model:
Contact your ProSoft Technology distributor to order the upgrade and obtain a Returned Mercha ndise Authorization
(RMA) to return the unit to ProSoft Technology.
To Order a Series C mode with the -WEB option:
Add -WEB to the standard ProLinx part number. For example, 5201-MNET-MCM-WEB.
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
Copyright © ProSoft Technology, Inc. 2009. All Rights Reserved.
S3964R Driver Manual
April 14, 2009
ProSoft Technology ®, ProLinx ®, inRAx ®, ProTalk®, and RadioLinx ® are Registered Trademarks of ProSoft
Technology, Inc. All other brand or product names are or may be trademarks of, and are used to identify products
and services of, their respective owners.
ProSoft Technology® 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 provided 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 (0) 5.3436.87.20
Latin America: +1.281.298.9109
North America: +1.661.716.5100
Contents S3964R ♦ ProLinx Gateway
Driver Manual Siemens 3964R Protocol
Contents
Important Installation Instructions.......................................................................................................2
Your Feedback Please........................................................................................................................3
ProSoft Technology® Product Documentation...................................................................................3
Guide to the ProLinx-S3964R User Manual 7
1 Start Here 9
1.1 ProLinx Reference Guide..........................................................................................9
1.2 Install ProSoft Configuration Builder Software..........................................................9
2 Configure the Gateway 15
2.1 S3964R Protocol Configuration...............................................................................15
2.2 Common Configuration ...........................................................................................19
2.3 Downloading a File from PC to the Gateway..........................................................22
3 Application Ports 23
3.1 Serial Port Cable Connections: Config/Debug and Port 0......................................23
3.2 Cable Connections..................................................................................................23
4 Diagnostics and Troubleshooting 29
4.1 Requirements..........................................................................................................29
5 Functional Overview 37
5.1 Product Compatibility ..............................................................................................37
5.2 3964R Protocol Overview........................................................................................37
5.3 Communications......................................................................................................38
5.4 Example Messages.................................................................................................41
5.5 Job Processing........................................................................................................50
5.6 Reference Documents.............................................................................................50
6 Reference 51
6.1 Product Specifications.............................................................................................51
6.2 S3964R Error and Status Data ...............................................................................52
7 Support, Service & Warranty 55
7.1 How to Contact Us: Technical Support...................................................................55
7.2 Return Material Authorization (RMA) Policies and Conditions................................56
7.3 LIMITED WARRANTY.............................................................................................57
ProSoft Technology, Inc. Page 5 of 64
April 14, 2009
S3964R ♦ ProLinx Gateway Start Here
Siemens 3964R Protocol Driver Manual
Index
63
Page 6 of 64 ProSoft Technology, Inc.
April 14, 2009
Start Here S3964R ♦ ProLinx Gateway
Driver Manual Siemens 3964R Protocol
Guide to the ProLinx-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 36)
Diagnostics and
Troubleshooting
(page
29)
Reference (page 51)
Functional Overview
(page 37)
Product
Specifications (page
51)
Support, Service
and Warranty (page
55)
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 64
April 14, 2009
S3964R ♦ ProLinx Gateway Start Here
Siemens 3964R Protocol Driver Manual
Page 8 of 64 ProSoft Technology, Inc.
April 14, 2009
Start Here S3964R ♦ ProLinx Gateway
Driver Manual Siemens 3964R Protocol
1 Start Here
In This Chapter
ProLinx Reference Guide........................................................................9
Install ProSoft Configuration Builder Software.........................................9
For most applications, the installation and configuration steps described in this
section will work without additional programming. ProSoft Technology strongly
recommends that you complete the steps in this chapter before developing a
custom application.
1.1 ProLinx Reference Guide
The ProLinx Reference Guide on the ProSoft Solutions CD-ROM provides
detailed information on the entire range of ProLinx modules. If you have any
questions that are not answered in the S3964R Driver Manual, please refer to the
ProLinx Reference Guide.
1.2 Install ProSoft Configuration Builder Software
You must install the ProSoft Configuration Builder (PCB) software in order to
configure the S3964R. 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 D
Configuration Builder.
3 Choose "S
4 Save the file to your Desktop, so that you can find it easily when you have
finished downloading.
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
S3964R.
OWNLOAD HERE link to download the latest version of ProSoft
AVE" or "SAVE FILE" when prompted.
ProSoft Technology, Inc. Page 9 of 64
April 14, 2009
S3964R ♦ ProLinx Gateway Start Here
Siemens 3964R Protocol Driver Manual
To install ProSoft Configuration Builder from the Product CD
1 Insert the ProSoft Solutions Product CD into the CD drive of your PC. Wait for
the startup screen to appear.
2 On the startup screen, click P
RODUCT DOCUMENTATION. This action opens an
explorer window.
3 Click to open the U
TILITIES folder. This folder contains all of the applications
and files you will need to set up and configure your S3964R.
4 Double-click the P
ROSOFT 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.2.1 Using the Help System
Most of the information needed to help you use ProSoft Configuration Builder is
provided in a Help System that is always available whenever you are running
ProSoft Configuration Builder. The Help System does not require an Internet
connection.
To view the help pages, start ProSoft Configuration Builder, open the H
menu, and then choose CONTENTS.
ELP
Page 10 of 64 ProSoft Technology, Inc.
April 14, 2009
Start Here S3964R ♦ ProLinx Gateway
Driver Manual Siemens 3964R Protocol
1.2.2 Adding a Gateway
To add a gateway to your project:
1 Double-click the D
dialog box.
EFAULT MODULE icon to open the CHOOSE MODULE TYPE
2 On the C
HOOSE MODULE TYPE dialog box, select the gateway type.
Or
1 Open the P
2 On the L
To add a gateway to a different location:
1 Right-click the L
ROJECT menu and choose LOCATION.
OCATION menu, choose ADD MODULE.
OCATION folder and choose ADD MODULE. A new gateway
icon appears.
Or
1 Select the L
2 From the P
OCATION icon.
ROJECT menu, select LOCATION, then select ADD MODULE.
ProSoft Technology, Inc. Page 11 of 64
April 14, 2009
S3964R ♦ ProLinx Gateway Start Here
Siemens 3964R Protocol Driver Manual
1.2.3 Gateway Entries
To configure gateway parameters
1 Click on the plus sign next to the icon
to expand gateway
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.
1.2.4 Comment Entries
To add comments to your configuration file:
1 Click the plus sign to the left of the
Comments.
2 Double-click the
icon. The EDIT - MODULE COMMENT dialog
appears.
icon to expand the gateway
3 Enter your comment and click OK to save your changes.
Page 12 of 64 ProSoft Technology, Inc.
April 14, 2009
Start Here S3964R ♦ ProLinx Gateway
Driver Manual Siemens 3964R Protocol
1.2.5 Printing a Configuration File
To print a configuration file:
1 Select the M
shortcut menu.
2 On the shortcut menu, choose V
V
IEW CONFIGURATION window.
3 On the V
P
RINT. This action opens the PRINT dialog box.
4 On the P
select printing options, and then click OK.
ODULE icon, and then click the right mouse button to open a
IEW CONFIGURATION. This action opens the
IEW CONFIGURATION window, open the FILE menu, and choose
RINT dialog box, choose the printer to use from the dropdown list,
ProSoft Technology, Inc. Page 13 of 64
April 14, 2009
S3964R ♦ ProLinx Gateway Start Here
Siemens 3964R Protocol Driver Manual
Page 14 of 64 ProSoft Technology, Inc.
April 14, 2009
Configure the Gateway S3964R ♦ ProLinx Gateway
Driver Manual Siemens 3964R Protocol
2 Configure the Gateway
In This Chapter
S3964R Protocol Configuration.............................................................15
Common Configuration..........................................................................19
Downloading a File from PC to the Gateway.........................................22
2.1 S3964R Protocol Configuration
2.1.1 [Module]
This section defines the configuration for the Module level data.
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.
ProSoft Technology, Inc. Page 15 of 64
April 14, 2009
S3964R ♦ ProLinx Gateway Configure the Gateway
Siemens 3964R Protocol Driver Manual
2.1.2 [3964R Port x]
This section defines the port configuration for the 3964R device.
Enable
Yes or No
This parameter specifies whether to enable or disable the port. No = Port
Disabled, Yes = Port Enabled.
RS Interface
0 = RS-232
1 = RS-422
2 = RS-485
This parameter is only used for Ports 1, 2, or 3 to configure the electrical
interface for the individual ports.
Important: This parameter should not be used for port 0. Use the jumper on the back of the
module to select the RS interface for Port 0.
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.
Page 16 of 64 ProSoft Technology, Inc.
April 14, 2009
Configure the Gateway S3964R ♦ ProLinx Gateway
Driver Manual Siemens 3964R Protocol
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.
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.
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 re-synchronize,
use two stop bits.
All devices communicating through this port must use the same number of stop
bits.
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.
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.
Minimum Response Delay
0 to 65535
This parameter sets the number of milliseconds to wait to respond to a request
on the port. This is required for slow reacting devices.
ProSoft Technology, Inc. Page 17 of 64
April 14, 2009
S3964R ♦ ProLinx Gateway Configure the Gateway
Siemens 3964R Protocol Driver Manual
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).
Swap
0 or 1
This parameter specifies whether bytes should be swapped. 0 = No data byte
swapping, 1 = Data byte swapping.
Priority
0 or 1
This parameter specifies whether the module is high priority or low priority with
respect to the CP. 0 = High priority, 1 = Low Priority.
Protocol
0 or 1
0=3964 RK512, 1=3964
ACK Delay
Number of milliseconds to wait for ACK. The default is 1000 ms.
Setup Attempts
Number of times to try to connect to CP (Default 6)
Transmit Attempts
Number of times to try to transmit to CP (Default 6)
DB Block Size
16 to 300 words
Size of message block to use for multi-block message transfers through the
database.
DB Block Timeout
1 to 65535 milliseconds
Timeout value to use while waiting to send/receive next message block during
multi-block message transfers through the database.
Page 18 of 64 ProSoft Technology, Inc.
April 14, 2009
Configure the Gateway S3964R ♦ ProLinx Gateway
Driver Manual Siemens 3964R Protocol
2.2 Common Configuration
2.2.1 Data Map
The [DATA MAP] section allows you to copy data between areas in the module's
internal database. .
You can copy to 100 registers at a time, and you can configure up to 200
separate copy commands.
For example, you can copy data from the error or status tables in upper memory
to internal database registers in the User Data memory area. You can also
rearrange the byte or word order during the copy process so that data such as
floating point values can be converted to the correct format for a specific
protocol.
You can also use the Data Map to build a specific block of data to be used by
any of the protocols that reside in the S3964R gateway.
ProSoft Technology, Inc. Page 19 of 64
April 14, 2009
S3964R ♦ ProLinx Gateway Configure the Gateway
Siemens 3964R Protocol Driver Manual
From Address
0 to highest Status Data address
This field specifies the internal database register to copy from. This address can
range from the Data area as well as the Status Data Area of the product. Refer to
the ProLinx Reference Guide for the data and status registers for each protocol.
To Address
0 to 3999
The destination for the copy is always within the Register Data area. Take care to
specify a destination address that will not overwrite data that may be required for
other purposes.
Register Count
1 to 100
This parameter specifies the number of registers to copy.
Swap Code
0 = No Change
1 = Word Swap
2 = Word and Byte Swap
3 = Byte Swap
You may need to swap the order of the bytes in the registers during the copy
process in order to change the alignment of bytes between dissimilar protocols.
This parameter is helpful when dealing with floating-point or other multi-register
values, as there is no standard method of storage of these data types in slave
devices.
Page 20 of 64 ProSoft Technology, Inc.
April 14, 2009
Loading...