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.
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.
Contents Driver Manual S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Contents Important Installation Instructions ....................................................................................................... 2 Your Feedback Please........................................................................................................................ 3 ProSoft Technology® Product Documentation ...................................................................................
S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Index Page 6 of 64 Start Here Driver Manual 63 ProSoft Technology, Inc.
Start Here Driver Manual S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Guide to the ProLinx-S3964R User Manual Function Introduction Section to Read Details → Start Here (page 9) This Section introduces the customer to the module. Included are: package contents, system requirements, hardware installation, and basic configuration. → Verifying Communication (page 36) This section describes how to verify communications with the network. Diagnostic and Troubleshooting procedures.
S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Page 8 of 64 Start Here Driver Manual ProSoft Technology, Inc.
Start Here Driver Manual 1 S3964R ♦ ProLinx Gateway Siemens 3964R Protocol 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.
S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Start Here Driver Manual To install ProSoft Configuration Builder from the Product CD 1 2 3 4 Insert the ProSoft Solutions Product CD into the CD drive of your PC. Wait for the startup screen to appear. On the startup screen, click PRODUCT DOCUMENTATION. This action opens an explorer window. Click to open the UTILITIES folder. This folder contains all of the applications and files you will need to set up and configure your S3964R.
Start Here Driver Manual S3964R ♦ ProLinx Gateway Siemens 3964R Protocol 1.2.2 Adding a Gateway To add a gateway 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 gateway type. Or 1 2 Open the PROJECT menu and choose LOCATION. On the LOCATION menu, choose ADD MODULE. To add a gateway to a different location: 1 Right-click the LOCATION folder and choose ADD MODULE. A new gateway icon appears.
S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Start Here Driver Manual 1.2.3 Gateway Entries To configure gateway parameters 1 2 3 4 to expand gateway Click on the plus sign next to the icon information. Double-click the icon to open the EDIT dialog box. To edit a parameter, select the parameter in the left pane and make your changes in the right pane. Click OK to save your changes. 1.2.
Start Here Driver Manual S3964R ♦ ProLinx Gateway Siemens 3964R Protocol 1.2.5 Printing a Configuration File To print a configuration file: 1 2 3 4 Select the MODULE icon, and then click the right mouse button to open a shortcut menu. On the shortcut menu, choose VIEW CONFIGURATION. This action opens the VIEW CONFIGURATION window. On the VIEW CONFIGURATION window, open the FILE menu, and choose PRINT. This action opens the PRINT dialog box.
S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Page 14 of 64 Start Here Driver Manual ProSoft Technology, Inc.
Configure the Gateway Driver Manual 2 S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Configure the Gateway In This Chapter 2.1 S3964R Protocol Configuration ............................................................. 15 Common Configuration.......................................................................... 19 Downloading a File from PC to the Gateway......................................... 22 S3964R Protocol Configuration 2.1.
S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Configure the Gateway 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.
Configure the Gateway Driver Manual S3964R ♦ ProLinx Gateway 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.
S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Configure the Gateway 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).
Configure the Gateway Driver Manual 2.2 S3964R ♦ ProLinx Gateway Siemens 3964R Protocol 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.
S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Configure the Gateway 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.
Configure the Gateway Driver Manual S3964R ♦ ProLinx Gateway Siemens 3964R Protocol The following table defines the values and their associated operations: Swap Code Description 0 None: No Change is made in the byte ordering (1234 = 1234) 1 Words: The words are swapped (1234=3412) 2 Words & Bytes: The words are swapped then the bytes in each word are swapped (1234=4321) 3 Bytes: The bytes in each word are swapped (1234=2143) Delay Preset 0 to 65535 milliseconds This parameter controls how often
S3964R ♦ ProLinx Gateway Siemens 3964R Protocol 2.3 Configure the Gateway Driver Manual Downloading a File from PC to the Gateway To download a file from the Configuration Builder to the gateway: 1 2 3 4 5 Verify that your PC is connected to the gateway with a null-modem serial cable connected to the serial port on your PC and the serial port on the gateway Open the PROJECT menu, and then choose MODULE. On the MODULE menu, choose DOWNLOAD.
Application Ports Driver Manual 3 S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Application Ports In This Chapter 3.1 Serial Port Cable Connections: Config/Debug and Port 0 ..................... 23 Cable Connections ................................................................................
S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Application Ports Driver Manual 3.2.1 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: RS-232: Modem Connection This type of connection is required between the module and a modem or other communication device.
Application Ports Driver Manual S3964R ♦ ProLinx Gateway Siemens 3964R Protocol RS-232: Null Modem Connection (Hardware Handshaking) This type of connection is used when the device connected to the module requires hardware handshaking (control and monitoring of modem signal lines). RS-232: Null Modem Connection (No Hardware Handshaking) This type of connection can be used to connect the module to a computer or field device communication port.
S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Application Ports Driver Manual 3.2.2 RS-232 Configuration/Debug Port This port is physically a Mini-DIN connection. A Mini-DIN 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: 3.2.
Application Ports Driver Manual S3964R ♦ ProLinx Gateway Siemens 3964R Protocol 3.2.4 RS-422 RS-485 and RS-422 Tip If communication in the RS-422/RS-485 mode does not work at first, despite all attempts, try switching termination polarities. Some manufacturers interpret +/and A/B polarities differently. 3.2.5 DB9 to Mini-DIN Adaptor (Cable 09) ProSoft Technology, Inc.
S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Page 28 of 64 Application Ports Driver Manual ProSoft Technology, Inc.
Diagnostics and Troubleshooting Driver Manual 4 S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Diagnostics and Troubleshooting In This Chapter Requirements ........................................................................................ 29 There are two ways to troubleshoot ProLinx gateways: LEDs located on the front of the gateway, and a Debug port that provides a view into the gateway's internal database. 4.
S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Diagnostics and Troubleshooting Driver Manual 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.
Diagnostics and Troubleshooting Driver Manual 3 S3964R ♦ ProLinx Gateway Siemens 3964R Protocol This action opens the DIAGNOSTICS dialog box. Press [?] to open 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.
S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Diagnostics and Troubleshooting Driver Manual 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.
Diagnostics and Troubleshooting Driver Manual S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Opening the Data Analyzer Menu Press [A] to open the Data Analyzer Menu. Use this command to view all bytes of data transferred on each port. Both the transmitted and received data bytes are displayed. Refer to Data Analyzer for more information about this menu. Important: When in analyzer mode, program execution will slow down. Only use this tool during a troubleshooting session.
S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Diagnostics and Troubleshooting Driver Manual 4.1.3 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.
Diagnostics and Troubleshooting Driver Manual S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Moving Back Through 5 Pages of Registers Press [-] from the Database View menu to skip five pages back in the database to see the previous 100 registers of data. Moving Forward Through 5 Pages of Registers Press [+] from the Database View menu to skip five pages ahead in the database to see the next 100 registers of data.
S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Diagnostics and Troubleshooting Driver Manual 4.1.4 LED Indicators LEDs provide visual indications of potential problems. The following LEDs are fundamental to all ProLinx modules. Base gateway LEDs LED State Description Power Off Power is not connected to the power terminals. This LED is hardware driven, so it only requires power to operate. Green Solid Power is connected to the power terminals.
Functional Overview Driver Manual 5 S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Functional Overview In This Chapter 5.1 Product Compatibility ............................................................................ 37 3964R Protocol Overview...................................................................... 37 Communications.................................................................................... 38 Example Messages ..................................................
S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Functional Overview Driver Manual 5.2.2 ProLinx-S3964R Operation The protocol realized on the S3964R has the following special features: 5.3 Immediately after power-up and completion of the internal/external initialization procedures the S3964R with installed 3964R protocol is ready to serve as an interface between a controlling device and one or more communication partners using 3964R protocol.
Functional Overview Driver Manual S3964R ♦ ProLinx Gateway Siemens 3964R Protocol 5.3.2 Port Transmit Data The Port Transmit data consists of header information and parameter data. The Port Transmit Data in general: Word 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 … n+15 Description Transmit Sequence number. The Modbus TCP/IP device must change this value to transmit a message to the 3964R Communication Partner. This value should not be changed until all other data in the message is ready to be sent.
S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Functional Overview Driver Manual 5.3.3 Port Receive Data The Port Receive data consists of header information and parameter data. For each ProLinx serial port connected to a 3964R device, you need to continually monitor Word 0, Sequence Number, in the Receive Buffer for a change in value. When it changes, check the Job Code so you can act upon it. The 3964R telegram can arrive at any time, asynchronously.
Functional Overview Driver Manual 5.4 S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Word Description 13 Always 0. 14 Always 0. 15 Always 0. 16 First word of data. 11 Second word of data. … … n+15 n-th word of data. Example Messages Here are some examples of sending and receiving data through the module.
S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Functional Overview Driver Manual Transmit Buffer Item Address Receive Buffer Transmit Value Item Address Receive Value D (( * 600) + 300) + 3 Reserved J ( * 600) + 3 Error Code E (( * 600) + 300) + 4 Data Count K ( * 600) + 4 Data Count F (( * 600) + 300) + 5 through (( * 600) + 300) + 299 Data L ( * 600) + 5 through ( * 600) + 299 Data Now the ProLinx is writing the new data to
Functional Overview Driver Manual S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Port 0 Receive Database (Results of DB-Send) Word Value Description: 0 X No change in Receive Sequence Number because no data is returned from a DB-SEND. 1 7 Transmit Sequence number. This number will update to the Transmit Sequence Number that triggered the DB-SEND. When this value updates to the transmit sequence number it does not mean that the data has been sent out of the 3864R port.
S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Functional Overview Driver Manual Transmit Buffer Item Address Receive Buffer Transmit Value Item Address Receive Value D (( * 600) + 300) + 3 Reserved J ( * 600) + 3 Error Code E (( * 600) + 300) + 4 Data Count K ( * 600) + 4 Data Count F (( * 600) + 300) + 5 through (( * 600) + 300) + 299 Data L ( * 600) + 5 through ( * 600) + 299 Data Port 0 Transmit Database Here is an exampl
Functional Overview Driver Manual S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Port 0 Receive Database (Results of DB-Fetch) Word 0 Value 4 1 8 2 3 0 0 4 16 5 6 7 8 9 10 0 0x0045 0 0 5 5 11 12 13 14 15 16 17 18 19 20 0 0 0 0 0 111 222 333 444 555 Description: In this example, the Receive Sequence Number will increment from 3 to 4 when the fetched data has arrived. When this location changes values, then the fetched data has returned and it is ready to be read. Transmit Sequence number.
S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Functional Overview Driver Manual 5.4.3 Example 3964R DB-SEND of data to Modbus TCP/IP device Now let's say the 3964R device needs to send data to the Modbus TCP/IP device. The 3964R device issues a DB-SEND. The Modbus TCP/IP device needs to continually poll the ProLinx for an indication of new data. Use a Modbus Function Code 3 to read header data from the ProLinx RECEIVE The 3964R device issues a DB-SEND telegram to the ProLinx.
Functional Overview Driver Manual S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Word Value Description: 3 0 Error Code. This error code should be monitored continuously because sometimes it might take awhile for a communication error to occur depending on timeout values and the type of error. 4 16 Number of data words in this message block. Modbus TCP/IP multiblock Block Number (1 word) plus RK512 Header (10 words) plus the 5 words of fetched data. 5 0 Multi-block number should always be 0.
S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Functional Overview Driver Manual 5.4.4 Example RK512 DB-FETCH initiated by 3964R Now let's say the 3964R device needs to fetch data from the Modbus TCP/IP device. The 3964R device issues a DB-FETCH. The Modbus TCP/IP device needs to continually poll the ProLinx for an indication of a new telegram requesting new data. Use a Modbus Function Code 3 to read header data from the ProLinx RECEIVE The 3964R device issues a DB-FETCH telegram to the ProLinx.
Functional Overview Driver Manual S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Word Value Description: 0 4 In this example, the Receive Sequence Number will increment from 3 to 4 when the DB-FETCH message data has arrived. When this location changes values, then it signals that new message data has been received from the 3964R Communication Partner. 1 X Transmit Sequence number. This number will not change when a DBFETCH message has been received from the 3964R Communication Partner.
S3964R ♦ ProLinx Gateway Siemens 3964R Protocol 5.5 Functional Overview Driver Manual Word Value Description: 305 0x1145 0x1145 = Response to DB-FETCH that was initiated by 3964R Communication Partner. 306 0 Returned Data Block. 307 0 Returned Data Word. 308 5 Number of data words total. Sending 5 data words. 309 5 Number of data words block. Should be equal to Number of data words total. 310 0 Reserved. 311 0 Reserved. 312 0 Reserved. 313 0 Reserved. 314 0 Reserved.
Reference Driver Manual 6 S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Reference In This Chapter 6.1 Product Specifications ........................................................................... 51 S3964R Error and Status Data.............................................................. 52 Product Specifications ProLinx Communication Gateways are the ideal solution for bridging communication between networks that use differing protocols.
S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Reference Driver Manual When using S3964R without RK512 communications mode, Port 0, Port 1, Port 2, and Port 3 can send or receive standard communication telegrams (messages).
Reference Driver Manual S3964R ♦ ProLinx Gateway Siemens 3964R Protocol 6.2.2 Error Codes Error Code Description -1 0xFFFF Multi-block timeout error.
S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Page 54 of 64 Reference Driver Manual ProSoft Technology, Inc.
Support, Service & Warranty Driver Manual 7 S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Support, Service & Warranty In This Chapter How to Contact Us: Technical Support.................................................. 55 Return Material Authorization (RMA) Policies and Conditions............... 56 LIMITED WARRANTY........................................................................... 57 ProSoft Technology, Inc.
S3964R ♦ ProLinx Gateway Siemens 3964R Protocol 7.2 Support, Service & Warranty Driver Manual 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. 7.2.
Support, Service & Warranty Driver Manual S3964R ♦ ProLinx Gateway Siemens 3964R Protocol 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.
S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Support, Service & Warranty Driver Manual 7.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.
Support, Service & Warranty Driver Manual S3964R ♦ ProLinx Gateway Siemens 3964R Protocol 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.
S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Support, Service & Warranty Driver Manual 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
Support, Service & Warranty Driver Manual S3964R ♦ ProLinx Gateway Siemens 3964R Protocol 7.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.
S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Page 62 of 64 Support, Service & Warranty Driver Manual ProSoft Technology, Inc.
Index Driver Manual S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Example Modbus TCP/IP DB-SEND of data to 3964R device • 41 Example RK512 DB-FETCH initiated by 3964R • 48 Index F [ [3964R Port x] • 16 [Module] • 15 From Address • 20 Functional Overview • 7, 37 Functional Specifications - S3964R • 52 G 3 Gateway Entries • 12 Guide to the ProLinx-S3964R User Manual • 7 3964R Protocol Overview • 37 A ACK Delay • 18 Adding a Gateway • 11 All Product Returns: • 56 All ProLinx® Products • 2 Allocation
S3964R ♦ ProLinx Gateway Siemens 3964R Protocol Index Driver Manual Port 0 Receive Database (Results of DB-Fetch) • 45, 46 Port 0 Receive Database (Results of DB-Send) • 43 Port 0 Transmit Database • 42, 44 Port 0 Transmit Database (After Reading DB-Send Data) • 47 Port 0 Transmit Database (After Reading Fetched Data) • 45 Port 0 Transmit Database (Response to DB-fetch) • 49 Port Receive Data • 40 Port Transmit Data • 39 Printing a Configuration File • 13 Priority • 18 Procedures for Return of Units Out o
