Siemens SIMATIC NET Interface to the PI System

mustardpruneΔίκτυα και Επικοινωνίες

23 Οκτ 2013 (πριν από 3 χρόνια και 10 μήνες)

327 εμφανίσεις


Siemens SIMATIC NET

Interface to the PI System


For S5, TI
-
505 Series PLCs and PCS



Version 1.4.2

Document Revision A





ii

How to Contact Us

Phone

(510) 297
-
5800 (main number)

(510) 297
-
5828 (technical support)

Fax

(510) 357
-
8136

E
-
mail

techsupport@osisoft.com

World Wide Web

http://www.osisoft.com

Mail

OSIsoft

P.O. Box 727

San Leandro, CA 94577
-
0427

USA


OSI Software GmbH

Hauptstra

e 30

D
-
63674 Altenstadt 1

Deutsch
land

OSI Software, Ltd

P O Box 8256

Symonds Street

Auckland 1035 New Zealand


OSI Software, Asia Pte Ltd

152 Beach Road

#09
-
06 Gateway East

Singapore, 189721

Unpublished
--

rights reserved under the copyright laws of the United States.

RESTRICTED RIGHTS

LEGEND

Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph (c)(1)(ii)

of the Rights in Technical Data and Computer Software clause at DFARS 252.227
-
7013

Trademark statement

PI is a registered trademar
k of OSI Software, Inc. Microsoft Windows, Microsoft Windows for
Workgroups, and Microsoft NT are registered trademarks of Microsoft Corporation. Solaris is a registered trademark of Sun
Microsystems. HP
-
UX is a registered trademark of Hewlett Packard Corp
.. IBM AIX RS/6000 is a registered trademark of the IBM
Corporation. DUX, DEC VAX and DEC Alpha are registered trademarks of the Digital Equipment Corporation.

PI_ssimaticnet.doc



1997
-

2002 OSI Software, Inc. All rights reserved

777 Davis Street, Suite
250, San Leandro, CA 94577



Siemens SIMATIC NET In
terface to the PI System

iii

iii

Table of Contents

Introduction

................................
................................
................................
........................
1

Reference Manuals
................................
................................
................................
...........
2

Supported Features

................................
................................
................................
..........
2

Diagram of Hardware Connection

................................
................................
....................
6

Principles of Operation
................................
................................
................................
.....
7

Installation Checklist

................................
................................
................................
.........
9

Pre
-
installation Procedures

................................
................................
...........................
11

Install Siemens Library Software

................................
................................
....................
11

Configuration Files

................................
................................
................................
..........
11

The Windows NT Control Panel

................................
................................
.....................
12

The COML1413 Setup Program
................................
................................
.....................
12

S5 vs. TI
-
505 Connections

................................
................................
.............................
13

Interface Installation
................................
................................
................................
........
15

Naming Conventions and Req
uirements

................................
................................
.......
15

Microsoft DLLs
................................
................................
................................
................
16

Interface Directories

................................
................................
................................
.......
16

Interface Inst
allation Procedure

................................
................................
......................
17

Installing the Interface as an NT Service

................................
................................
........
17

Digital States

................................
................................
................................
....................
21

PointSource
................................
................................
................................
......................
23

PI Point Configuration
................................
................................
................................
.....
25

Point Attributes
................................
................................
................................
................
25

Output Points

................................
................................
................................
..................
33

Tag Configuration for PCS Systems

................................
................................
.............
35

Performance

................................
................................
................................
.....................
39

Interface Performance

................................
................................
................................
....
39

Multiple Copies of the Interface
................................
................................
.......................
39

Table of Contents

iv


iv

Performance Point Configuration

................................
................................
...................
40

I/O Rate Tag Configuration

................................
................................
............................
43

Monitoring I/O Rates on the Interface Node
................................
................................
....
43

Configuring I/O Rate Tags

with PI
-
ICU (NT
-
Intel)

................................
...........................
43

Configuring I/O Rate Tags Manually

................................
................................
...............
44

Startup Command File
................................
................................
................................
.....
47

Command
-
Line Parameters
................................
................................
...........................
50

Sample Sinet5.bat File
................................
................................
................................
....
56

Interface Node Clock

................................
................................
................................
......
59

Security

................................
................................
................................
.............................
61

Starting / Stopping the Interface

................................
................................
...................
63

Starting Interface as a Service

................................
................................
.......................
63

Stopping Interface Running as a Service

................................
................................
.......
63

Buffering

................................
................................
................................
...........................
65

Configuring Buffering with PI
-
ICU (N
T
-
Intel)

................................
................................
...
65

Configuring Buffering Manually

................................
................................
.......................
68

Example piclient.ini File

................................
................................
................................
..
69

Appendix A Error and Informational Messages

................................
...........................
71

General

................................
................................
................................
...........................
71

PIPC.log File

................................
................................
................................
...................
71

Interface
-
specific Log File
................................
................................
...............................
71

Troubleshooting

................................
................................
................................
..............
72

System Errors and PI Errors

................................
................................
..........................
73

Appendix B: Hints for the System Manager

................................
................................
.
75

Appendix C Test Environment
................................
................................
.......................
79

Appendix D Native TCP/IP, RFC1006 TC
P/IP, and H1

................................
................
81

TI505 PLCs

................................
................................
................................
.....................
81

S5 and S7 PLCs

................................
................................
................................
.............
81

Appendix E Supported D
ata Types for Simatic TI
-
505 PLCs

................................
.....
83

Appendix F Output Tag Configuration Examples
................................
........................
87

Individual Writes
................................
................................
................................
..............
87

Block Write Example

................................
................................
................................
......
88


Siemens SIMATIC NET Interface to the PI System

v

v

Appendix G Tracing Send/Receive Messages
................................
............................
91

Appendix H ISO/OSI Reference
Model
................................
................................
.........
95

Appendix I Configuring a Second Ethernet Card
................................
........................
97

Revision History

................................
................................
................................
............
127




Siemens SIMATIC NET Interface to the PI System

1

1

Introduction

The SIE
MENS SIMATIC NET TI
-
505 Interface to the PI System runs under
Windows NT Server or Workstation, Intel Platform.

The interface transfers data between the Plant Information (PI) System and



TI
-
505 Series PLC



S5 Series PLC

Although the interface manual refe
rs to Softnet
-
S7 software libraries, the interface
does not support S7 PLCs. The “7” in the Softnet
-
S7 library name refers to the 7
layers in the ISO/OSI reference model (see Appendix D). However, the SIEMENS
SIMATIC NET TI
-
505 Interface to the PI System

only utilizes the first 4 layers in the
ISO/OSI reference model. That is, the interface is said to communicate via the so
-
called read/write protocol, which utilizes only the first 4 layers of the ISO/OSI
reference model.

The read/write protocol allows th
e interface to read from and write to specific memory

locations in S5 and TI
-
505 PLCs. Since the read/write protocol only utilizes the first 4
layers of the ISO/OSI model, report by exception is not supported by the interface. In
other words, the interfa
ce must poll the TI
-
505 or S5 PLCs to get data. One
advantage of using only the first 4 layers of the ISO/OSI model is that a wide range of
PLCs support the 4
-
layer model. Even those PLCs that support the 7
-
layer model
require programming before they sup
port report by exception. The read/write protocol
was chosen for its portability.

There are several references to the Siemens PCS in this manual. To clarify, this
interface does not communicate to the Siemens PCS. The interface can merely read
an
instal
l.tag

file that can be downloaded from the Siemens PCS. The interface
communicates directly to S5 PLCs or TI
-
505 PLCs.

Note:

The current version of the interface went through limited tests of data types for the
S5 Series PLC. See section "PI Point Config
uration" later in this manual for supported
data types. A customer who requires additional data type support must be prepared for
onsite tests.


SINEC AP and SINEC TF are not supported.

TI
-
505 Series PLCs (Supported)

TI
-
505 PLCs have either TI
-
545 or TI
-
555 communications processor units (CPUs)
associated with them. Both 545 and 555 CPUs are supported by this interface. Any
PLC or CPU with a name of the form TI
-
5X5 is part of the TI
-
505 series PLCs and
should be supported by this interface.

TI
-
500 Se
ries PLCs (Not Supported)

The TI
-
505 series PLCs are distinctly different from the TI
-
500 series PLCs, which
are not supported by this interface. The TI
-
500 series PLCs have names of the form
Introduction


2


2

TI
-
5X0. For example, TI
-
520 and TI
-
530 PLCs are part of the TI
-
500 series and are
not supported. The communications processors associated with TI
-
500 series PLCs
have names of the form TI
-
5X0c, such as TI
-
520c and TI
-
530c (also not supported).

Even though TI
-
500 series PLCs are not supported by this interface, it is

worthwhile to
discuss them a bit further, owing to the large amount of confusion surrounding this
product
-
line. TI
-
500 series PLCs communicate via NITP (non
-
intelligent terminal
protocol) or TBP (transparent byte protocol). One method of communicating t
o these
PLCs is with a Task Code Driver that can communicate via NITP or TBP. OSI does
not have such a task code driver. However, TI
-
500 series PLCs also can
communicate to a TIWAY driver, and OSI does have a TIWAY interface. If a
TIWAY NIM (network int
erface module) is set up, OSI’s TIWAY interface should
be able to communicate to TI
-
500 series PLCs.

TI
-
305 and TI
-
405 Series PLCs (Not Supported)

TI
-
305 and TI
-
405 PLCs are also a source of confusion. The Siemens Simatic Net
Interface does not communicat
e to TI
-
305 or TI
-
405 PLCs, but they are still worth
discussing. Siemens no longer supports these PLCs. TI
-
305 PLCs use either TI
-
330
or TI
-
335 communication processor units (CPUs). TI
-
405 PLCs use TI
-
435 CPUs.
(There are probably other 400 series CPUs.
) Both TI
-
305 and TI
-
405 PLCs
communicate via the Hostlink protocol across a serial line. Hostlink is a publicly
published protocol. OSI does not have an interface that communicates via Hostlink.
More information can be obtained about the Hostlink prot
ocol from Siemens manual
number 305
-
8102.

Reference Manuals

OSIsoft



UniInt End User Document



PI Data Archive Manual



PI
-
API Installation Instructions

Siemens

These manual describe the protocols in detail:



SINEC CP 143 mit COM 143 Bestell
-
Nr. 6GK1970
-
1AB43
-
0AA0



SIMATIC NET SEND/RECEIVE
-
Programmierschnittstelle

Supported Features

Feature

Support

Part Number

PI
-
IN
-
SI
-
SIMAT
-
NTI

Platforms

NTI

PI Point Types

Int16, Int32, float16, float32, string, digital


Siemens SIMATIC NET Interface to the PI System

3

3

Feature

Support

Sub
-
Second Timestamps

No

Sub
-
Second Scan Classes

No

Automatically Incorporates PI

Point
Attribute Changes

Yes

Exception Reporting

Yes

* Outputs from PI

Yes (See below for S5)

Inputs to PI: Scan
-
Based / Unsolicited /
Event Tags

Scan
-
based / Event Tags

Maximum Point Count

Unlimited

Uses PI
-
SDK

Yes

Strin
g Support

Only for S5

* Source of Timestamps

PI
-
Server/API

History Recovery

Yes / No

Failover

No

* UniInt
-
Based

Yes

* Vendor Software Required on PI
-
API /
PINet Node

Yes

* Vendor Software Required on Foreign
Device

Yes

* Vendor Hardware Required

Y
es

Additional PI Software Included with
Interface

No

* Device Point Types

TI
-
505
-

Int16, Int32, Float32, Boolean

S5


Dword (32 bit), Byte (8 bit) and, Word
(16 bit)

Configuration Data

Half automatic for TI
-
505 Systems

Multiple Links

Yes

* See pa
ragraphs below for further explanation.

Source of Timestamps

The source of timestamps is configurable by setting the /time command
-
line parameter
in the .bat file /time=SERVER (recommended) or the API node local time
/time=LOCAL.

Outputs

Outputs are not te
sted for S5 yet and not implemented for Siemens S5 floating
-
point
numbers. Please contact OSI SOFTWARE GmbH for further information.

Introduction


4


4

UniInt
-
Based

UniInt stands for Universal Interface. UniInt is not a separate product or file; it is an
OSIsoft
-
developed te
mplate used by our developers, and is integrated into many
interfaces, such as the SIEMENS SIMATIC NET TI
-
505 interface. The purpose of
UniInt is to keep a consistent feature set and behavior across as many of our
interfaces as possible. It also allows for

the very rapid development of new interfaces.
In any UniInt
-
based interface, the interface uses some of the UniInt
-
supplied
configuration parameters and some interface
-
specific parameters. UniInt is constantly
being upgraded with new options and features.

The
UniInt End User Document

is a supplement to this manual.

Vendor Hardware and Software Required

The Communications Processors (CP) and the library are not part of this PI interface.
They can be purchased from SIEMENS.

Supported Scenarios

System

Networ
k

Remote CP


Host CP

(Hardware on
interface node)

Library

(Software on
interface node)

TI
-
505
Series

H1

CP 1434 TF

PPX:505
-
CP1434TF

CP 1413 (ISA)

6GK1 141
-
3RB01

TF
-
1413

6GK1701
-
1TBxx
-
3AA0

CP 1613 (PCI)

6GK1161
-
3AA00

TF
-
1613

6GK1716
-
1TBxx
-
3AA0

Wind
ows NT
compatible
Ethernet Card

SOFTNET
-
S7 Basic

6GK1704
-
1CWxx
-
3AA0

SOFTNET
-
S7
Extended

6GK1704
-
1CXxx
-
3AA0

S5

H1

CP 1430 TF

6GK1 143
-
0TA01

CP 1413 (ISA)

6GK1 141
-
3RB01

TF
-
1413

6GK1701
-
1TBxx
-
3AA0

CP 1613 (PCI)

6GK1161
-
3AA00

TF
-
1613

6GK1716
-
1TBxx
-
3
AA0

Windows NT
compatible
Ethernet Card

SOFTNET
-
S7 Basic

6GK1704
-
1CWxx
-
3AA0


Siemens SIMATIC NET Interface to the PI System

5

5

SOFTNET
-
S7
Extended

6GK1704
-
1CXxx
-
3AA0

PCS

H1

TI
-
505/H1

TI
-
505/H1

TI
-
505/H1


The currently recommended hardware on the interface node is a CP
-
1613
communications process
or. The CP
-
1613 is the replacement of the CP
-
1413, which is
being phased out by Siemens. The throughput of the new CP
-
1613 is about 10 times
faster than the old CP
-
1413 because the CP
-
1613 uses a PCI bus instead of an ISA
bus. The TF
-
1613 software libra
ries come pre
-
installed on the CP
-
1613. This means
that the TF
-
1613 software libraries do not need to be separately installed on the
interface node if the CP
-
1613 processor is used.

While the CP
-
1413 was being phased out and before the CP
-
1613 was release
d, OSI
was recommending that the SOFTNET
-
S7 (basic or extended) software be installed
on the interface node in conjunction with a standard Windows NT
-
compatible Ethernet
card. Although the difference in speed is not as great as between the CP
-
1413 and
CP
-
1613, the CP
-
1613 processor is faster than the SOFTNET
-
S7/Ethernet Card
combination. This is because the CP
-
1613 card, unlike the Ethernet card, has a built
-
in
processor that can be used to process incoming transactions. With SOFTNET
-
S7, the
CPU of the p
ersonal computer must process the incoming transactions.

Using a CP
-
1413 or CP
-
1613 is referred to as using “Hardnet.” Using SOFTNET
-
S7
in conjunction with a standard Windows NT
-
compatible Ethernet card is referred to as
using “Softnet.”

Device Point Type
s

For the S5 PLC, see the description of the PLCSIG keyword under the description of
the Extended Descriptor attribute above.

For the TI
-
505 PLC, the following applies to input points (Location5=0). When an
input point has a PI point type of R, the interf
ace assumes that the PLC stores its
values according to standard TF Encodings (see Appendix A). For example, the
interface will assume that variables in V memory are stored in Integer16 format.
Likewise, the interface assumes that variables in V. or VF m
emory are stored in
floating
-
point format. Hence if all of the memory types that are being read from the
PLC are stored according to the standard TF Encodings given in Appendix A, then one

can safely use a point type of R for all PI Points and all values s
hould be read
correctly into PI.

However, not all variables are stored according to their standard TF Encoding.
Namely, variables stored in V. or VF memory are sometimes stored in Integer32
format instead of in floating point format. For this reason, whe
n an input point has a PI

point type of I or D, the interface always assumes that the target variable is stored as
an integer. Hence, one can define a PI point of type I or D and read an Integer32
from V. or VF memory.

Introduction


6


6

Diagram of Hardware Connection





Siemens SIMATIC NET Interface to the PI System

7

7

Principles of Operation

For each group of tags (Location 1 parameter) a separate interface process must be
started (
/id=Location1
).

At startup, the Interface checks all command
-
line parameters. If one of them is out of
range,
the interface generates an error
-
message and stops. If the parameters are all
correct, the interface runs through initialization. The first step is to open a connection to
the PI Server in order to be able to retrieve necessary tag information. The inte
rface has
to make a login for security reasons. The interface supports 3 methods of logging into the
PI Server:

1.

If the interface runs on the PI Server, it can be started using
/hosts=localhost

and will not need an additional password. It uses the standar
d proxy account on the
server.

2.

The administrator sets up a proxy account for the interface computer and
/host=hostname

will lead to read/write privileges for the interface.

3.

The interface attempts a logon under the “piadmin” account and will ask for the
pas
sword when it is started the first time, ie: no SINET01.PWD file is found. The
user enters the correct password and the interface stores this password into an
encrypted file in the startup directory, where it will make use of it on future startups.
Whenev
er the password for “piadmin” changes, the user must type in the correct
password again on a new startup of the interface.

Note
: It may occur that the administrator changes the “piadmin” password and forgets to
restart the interface in order to type in the

new password. In this case, the interface will not
be able to connect to the PI Server when an automatic restart of the interface occurs (e.g.
reboot of the interface computer caused by a power failure). If you want to avoid such a
situation, use method

2, the proxy account.

After successful connection to the PI Server, the interface opens a connection to the
related SIEMENS library. If the library is not present, the interface will stop with an error

message. Once connection is made, a list of all the
tags with the interface point source
and configured for this special interface number is collected.

Input

After successful startup, the interface generates a list of PI tags assigned to this
interface. Whenever the first tag for a new PLC channel (TSAP) i
s found, the interface
tries to open the channel. The interface is configured to transfer up to 480 bytes in one
block. This guarantees the best performance, although the maximum number of bytes can
be 4096. Therefore, the interface groups all tags toget
her which are defined for the same
PLC memory area. A DB range, for example, can have the following blocks: 0
-

479, 480

-

959, etc.

The user can help optimize the performance of the interface by grouping tags for the
same memory block in the same scan cl
ass. In the above example all possible 240 tags
for the range 0
-

480 would generate one READ every cycle period.

Inputs are scan
-
based and different scan classes can be defined. The smallest scan
period is 1 second. But this scan performance can only b
e achieved if all connected
Principles of Operation

8


8

PLCs are in normal operation. If some channels are not working properly, the interface
must wait a minimum of 5 seconds before attempting to read again.

Inputs can also be event
-
based. Any PI tag can serve as a trigger tag. W
henever this
tag changes value, the interface tag will perform a block read. “Collect Call” mechanism
for event
-
triggered input is not recommended.

The source of data for a point is defined by evaluating the symbolic address in the
InstrumentTag attribute

of that point. The interface will calculate the physical address of
the value from the symbolic address and request the according memory block from the
PLC.

For PCS Systems there are two options. If you have used the option to configure tags via
symboli
c address (see chapter “Tag configuration for PCS Systems”), then the interface
treats the tags in the same way as if the system were a plain TI
-
505 PLC. If the tags are
configured to contain the PCS Tagname in the InstrumentTag attribute, then the interf
ace
looks in the copy of the engineering file (
install.tag
) to figure out the physical address.
This, of course, requires that the engineering file
install.tag

be copied to the interface
startup directory first.

A connection break to a single communicatio
n channel will mark all concerned tags for
I/O

Timeout,

but the interface will continue to read blocks, depending on the
/rr1
parameter in the startup command line of the interface. The
/rr2

parameter defines the
periods where the interface tries to close
and reopen the channel.

If an error
-
marked value is transferred by the interface, this value will be marked as
BAD
INPUT

in the PI System.

Output

Output of data to the PLCs is internally handled by exception. If it is necessary to update
values with 5
-
sec
ond accuracy, define a PI tag that gets updated every five seconds.

Note:

Outputs are not tested for S5 and not yet implemented for Siemens S5 floating point
number. Please contact OSI Software GmbH for further information.




Siemens SIMATIC NET Interface to the PI System

9

9

Installation Checklist

For th
ose users who are familiar with running PI data collection interface programs,
this checklist helps you get the SIEMENS SIMATIC NET TI
-
505 interface running. If
you are not familiar with PI interfaces, you should return to this section after reading
the re
st of the manual in detail.

1.

Install the Siemens library software.

2.

Install the PI
-
Interface Configuration Utility (which installs PI
-
SDK and PI
-
API)

3.

Verify that PI
-
API has been installed.

4.

Install the interface.

5.

Test the connection between the interface node

and the foreign device using the

6.

Choose a point source. If PI 2 home node, create the point source.

7.

Configure PI points.

Location1 is the interface instance.

Location2 is the logical PLC number

Location3 (Not used for S5)is the output block specificatio
n for TI
-
505 writes.

Location4 is the scan class.

Location5 specifies direction of data transfer.

exdesc is used for keywords as BCD, InstZero etc.

instrumenttag is used to specify the PLC memory to be read/written.

8.

Configure performance points.

9.

Configure

I/O Rate tag.

10.

Edit startup command file and configuration files (Sinet5.Bat, sinet.cfg, sinet.ini).

11.

Start the interface without buffering.

12.

Verify data.

13.

Stop interface, start buffering, start interface.



Siemens SIMATIC NET Interface to the PI System

11

11

Pre
-
installation Procedures

The interface requires t
hat these steps be followed before installing the interface.

Install Siemens Library Software

Before installing the Interface, the SIEMENS Library software needs to be installed and
the appropriate connections have to be configured on the PLC side:

TI
-
505

Configure the CP MAC address.

Set up a read passive job and configure the TSAPs. Set up a write passive job
and configure a new TSAP. You may re
-
use the PC TSAP.

S5

Configure t he CP MAC addres s.

Configure t he TSAP.

Set up a fet ch pas s ive job on t he PLC w
it h read/writ e enabled.


Configuration Files

Sample SINET.CFG File

Each interface process needs a SINET.CFG file. This configuration file associates a
"logical PLC number" with a local TSAP address, remote TSAP address, and Ethernet
(MAC) address. Sever
al logical PLC numbers can be associated with a single physical
PLC. The logical PLC number that appears in the SINET.CFG file corresponds to the
value of the LOCATION2 PI point attribute.

"Local" and "remote" are defined from the viewpoint of the interfa
ce. That is, the local
TSAP addresses are the TSAP addresses on the interface side, and the remote TSAP
addresses are the TSAP addresses of the PLC.

An example SINET.CFG file is shipped with the interface. This file must be edited
manually.

The contents
of the SINET.CFG file should look similar to the following.

; LogPLC EthernetPLC LTSAP RTSAP

;


1 48
-
49
-
50
-
51
-
52
-
54 TSAP005 RTSAP005


2 48
-
49
-
50
-
51
-
52
-
55 TSAP006 RTSAP006


3 48
-
49
-
50
-
51
-
52
-
56 TSAP007 RTSAP007


4 48
-
49
-
50
-
51
-
52
-
56 TSAP008 RTSAP008

Sample SINET.INI File

Each interface process needs a configuration file, where the ACCESSPOINT is defined.

Example:

Pre
-
installation Procedures

12


12

[INIT]

; A corresponding ACCESSPOINT must be configured in the control

; panel application called "Setti
ng the PG/PC interface".

;

; Example for hardnet (CP1413). Uncomment next line if

; using hardnet.

; ACCESSPOINT=CP_H1_1:

;

; Example for softnet. Comment out next line if

; using hardnet.

ACCESSPOINT=S7ONLINE

An ACCESSPOINT is simply an arbitrary name,
such as S7ONLINE, that is associated
with an Ethernet card. An ACCESSPOINT can be defined in the control panel called
“Setting the PG/PC Interface.”

The Windows NT Control Panel

Communication on the PC side is configured from “Setting the PG/PC Interface
” in the
Windows NT control panel.

Softnet


S7

If the Softnet
-
S7 drivers are used on the interface node, perform the following in the
control panel.

1.

Click on the “install” button to install the ISO Ind. Ethernet module. One may need to
reboot after this
is done. If the module has already been installed, its name will
appear in the white box that begins with <None>.

2.

From the same control panel add an ACCESSPOINT. Clicking on the down arrow
underneath “Access Point of Application” will reveal an option to

add or delete an
Access Point.

3.

To associate this ACCESSPOINT with an Ethernet Module, highlight the appropriate
Ethernet Module name (which will appear somewhere beneath <None>).

4.

Click the “Diagnostics” button and test the configuration. If this test
does not pass,
the interface will not be able to establish a connection to the PLC.

Hardnet
-

CP1413

If the CP1413 drivers are used on the interface node and the PLC has a TF connection
configured for the PC, enable the TF in “setting the PG
-
PC interface”.

The COML1413 Setup Program

Additional configuration outside of the Windows NT control panel needs to be performed
on the interface node if the CP1413 drivers are used. The configuration is done using the
COML1413 program. The node name, application name

and server ID can be given any
name that the user desires. “Connection” should be set to active, static. Note that the
connection on the PLC itself should be configured as passive. The active connection type
is configured on the PC side.


Siemens SIMATIC NET Int
erface to the PI System

13

13

S5 vs. TI
-
505 C
onnections

An S5 FETCH job is the same as a 505 READ job.

The S5 does not support the WRITE job type. Use RECEIVE/passive type instead.

S5 Configuration


505 Configuration





Siemens SIMATIC NET Interface to the PI System

15

15

Interface Installation

OSIsoft recommends that interfaces be installed on PI
-
A
PI nodes instead of directly on
the PI

Server node
.
A PI
-
API node is any node other than the PI Server node where the
PI

Application Programming Interface (PI
-
API) has been installed (see the
PI
-
API

Installation Instructions

manual)
.
With this approach, th
e PI Server need not
compete with interfaces for the machine’s resources
.
The primary function of the
PI

Server is to archive data and to service clients that request data.

After the interface has been installed and tested, Bufserv should be enabled on th
e
PI
-
API

node (once again, see the
PI
-
API Installation Instructions

manual)
.
Bufserv is
distributed with the PI
-
API
.
It is a utility program that provides the capability to store and
forward events to a PI Server, allowing continuous data collection when c
ommunication to

the PI Server is lost
.
Communication will be lost when there are network problems or
when the PI Server is shut down for maintenance, upgrades, backups, or unexpected
failures.

In most cases, interfaces on PI
-
API nodes should be installed
as automatic services
.
Services keep running after the user logs off
.
Automatic services automatically restart
when the computer is restarted, which is useful in the event of a power failure.

The guidelines are different if an interface is installed on the

PI Server node
.
In this case,
the typical procedure is to install the PI Server as an automatic service and interfaces as
manual services that are launched by site
-
specific command files when the PI Server is
started
.
Interfaces that are started as manual

services are also stopped in conjunction with
the PI Server by site
-
specific command files
.
This typical scenario assumes that Bufserv
is not enabled on the PI Server node
.
Bufserv can be enabled on the PI Server node so
that interfaces on the PI Server n
ode do not need to be started and stopped in conjunction
with PI, but it is not standard practice to enable buffering on the PI Server node
.
See the
UniInt End User Document

for special procedural information.

Naming Conventions and Requirements

In the ins
tallation procedure below, it is assumed that the name of the interface executable

is
sinet5.exe

and that the startup command file is called
sinet5.bat
.

It is customary for the user to rename the executable and the startup command file when
multiple copie
s of the interface are run
.
For example, one would typically use

sinet51.exe

and

sinet51.bat
for interface number 1,
sinet52.exe

and
sinet52.bat

for interface number 2, and so on
.
When an interface is run as a service,
the executable and the command file m
ust have the same root name because the service
looks for its command
-
line arguments in a file that has the same root name.

Interface Installation

16


16

Microsoft DLLs

The following Microsoft DLLs are distributed on the installation CD
-
ROM
.
Copy these
files to the
winnt
\
system32

direc
tory only if the files in the
winnt
\
system32

directory are older than the files on the CD
-
ROM.

MSVCIRT.DLL

MSVCRT.DLL

MSVCRT40.DLL

MSVCP50.DLL

MSVCP60.DLL


The following additional Microsoft DLLs are also distributed on the CD
-
ROM
.
These
DLLs are only

used by a debug version of the interface. Copy these files to the
Winnt
\
system32

directory only if the files in the
winnt
\
system32

directory are older
than the files on the CD
-
ROM.


MSVCIRTD.DLL

MSVCRTD.DLL

MSVCP50D.DLL

MSVCP60D.DLL


Interface Directo
ries

The PIHOME Directory Tree

The
PIHOME

directory tree is defined by the
PIHOME

entry in the
pipc.ini

configuration

file
.
This
pipc.ini

file is an ASCII text file, which is located in the
WinNT
directory
.
A
typical
pipc.ini

file contains the following li
nes:

[PIPC]

PIHOME=c:
\
pipc


The above lines define the
\
pipc

directory as the root of the
PIHOME

directory tree on
the C: drive
.
OSIsoft recommends using
\
pipc

as the root directory name
.
The
PIHOME

directory does not need to be on the C: drive.

Interface
Installation Directory

Place all copies of the interface into a single directory
.
The suggested directory is:

PIHOME
\
interfaces
\
sinet5
\


Replace
PIHOME

with the corresponding entry in the
pipc.ini

file.


Siemens SIMATIC NET Int
erface to the PI System

17

17

Interface Installation Procedure

In the installation
procedure below, assume that interface number 1 is being installed and
that all copies of the interface will be installed in the same directory.

1.

Copy the interface files from the installation media to

PIHOME
\
interfaces
\
sinet5
\
.

Create the directory if ne
cessary.

2.

If necessary, rename the command file so that it has the same root name of the
executable.

3.

Alter the command
-
line arguments in the
.bat
file as discussed in this manual.

4.

Try to start the interface interactively with the command:

sinet5.bat


If the

interface cannot be started interactively, one will not be able to run the interface

as a service
.
It is easier to debug interactively started processes because error
messages are echoed directly to the screen
.
Once the interface is successfully running

i
nteractively, one can try to run it as a service by following the instructions below.

Installing the Interface as an NT Service


Service Configuration

Service Name

The
Service to Add

box shows the name of the current interface servi
ce. This service
name is obtained from the interface executable.

Display Name

The
Display Name

text box shows the current Display Name of the interface service. If
there is currently no service for the selected interface, the default Display Name is the
s
ervice name with a “PI
-
” prefix. Users may specify a different Display Name. OSIsoft
Interface Installation

18


18

suggests that the prefix “PI
-
” be appended to the beginning of the interface to indicate
that the service is part of the OSI suite of products.

Service Startup Type

The
Se
rvice Startup Type

indicates whether the interface service will start automatically
or need to be started manually on reboot.



If the
Auto
option is selected, the service will be installed to start automatically
when the machine reboots.



If the
Manual
o
ption is selected, the interface service will not start on reboot, but
will require someone to manually start the service.



If the
Disabled

option is selected, the service will not start at all.

Generally, interface services are set to start automatical
ly.

Interface Dependencies

The
Installed Services

list is a list of the services currently installed on this machine.
Services upon which this Interface is dependant should be moved into the
Interface
Dependencies

list using the “Add>>” button. For example
, if API Buffering is running,
then “bufserv” should be selected from the list at the right and added to the list on the left.

When the PI Interface is started (as a service), the services listed in the dependency list
will be verified as running (or an at
tempt will be made to start them). If the dependent
service(s) cannot be started for any reason, then the PI interface service will not run.

Note:

Please see the PI Log and Operating System Event Logger for messages that may
indicate the cause for any ser
ver not running as expected.

Add>>

To add a dependency from the list of
Installed Services
, select the dependency name,
and click the
Add
button.

<<Remove

To remove a selected dependency, highlight the service name in the
Installed
Dependencies

list, an
d click the Remove button.

The full name of the service selected in the
Installed Services

list is displayed below the
Installed Services

list box.

Create or Remove Interface Service

Create

The
Create
button adds the displayed service with the specified
Dependencies

and with
the specified
Startup Type
.

Remove

The
Remove

button removes the displayed service. If the service is not currently installed,
or if the service is currently running, this button will be grayed out.


Siemens SIMATIC NET Int
erface to the PI System

19

19

Start or Stop Service

The
Star
t / Stop

section contains a
Start

button

and a
Stop

button
. If this
interface service is not currently installed, these buttons will remain grayed out until the
service is added. If this interface service is running, the
Stop

button is available. If th
is
service is not running, the
Start

button is available.

The status of the Interface service is indicated in the lower portion of the PI
-
ICU dialog.







Installing the Interface Service Manually

One can get help for installing the interface as a servi
ce at any time with the command:

sinet5.exe

help


Change to the directory where the

sinet51.exe

executable is located
.
Then, consult
the following table to determine the appropriate service installation command
.

NT Service I nstallation Commands on a PI
-
AP
I node or a PI Server node

with Bufserv implemented

Manual service

sinet5.exe

install

depend “tcpip bufserv”

Automatic service

sinet5.exe

install

auto

depend “tcpip bufserv”

NT Service Installation Commands on a PI
-
API node or a PI Server node

with
out Bufserv implemented

Manual service

sinet5.exe

install

depend tcpip

Automatic service

sinet5.exe

install

auto

depend tcpip


When the interface is installed as a service on the PI Server node and when Bufserv is
not implemented, a dependency on t
he PI network manager is not necessary because the
interface will repeatedly attempt to connect to the PI Server until it is successful
.

Note:

Interfaces are typically not installed as automatic services when the interface is
installed on the PI Server no
de.

Check the Microsoft Windows NT services control panel to verify that the service was
added successfully
.
One can use the services control panel at any time to change the
interface from an automatic service to a manual service or vice versa
.

Status of the
Interface
Service






Siemens SIMATIC NET Interface to the PI System

21

21

Digital
States

There are no Digital States required by this interface, although system states may be used
when appropriate.

For more information regarding Digital States, refer to the Data Archive Manuals.

PI 2 Home Node

Digital states are defined by running the
D
igtl Stat

display from the PI menu. The
states must be contiguous for each status type and may be anywhere within the
Digital

State

Table outside of the range 193
-

320, which is reserved for OSIsoft. The
digital states need to be defined prior to point co
nfiguration. The digital state sets
described in the PI

3 sections below should be entered into the PI 2 Digital State Table.

For more information, see the DA manual.

PI 3 Home Node

Digital State Sets

PI digital states are discrete values represented by

strings. These strings are organized in
PI as digital state sets. Each digital state set is a user
-
defined list of strings, enumerated
from 0 to n to represent different values of discrete data. For more information about
PI

digital tags and editing digit
al state sets, see the
PI Data Archive Manual for
Windows NT and Unix

manual.

An interface point that contains discrete data can be stored in PI as a digital tag. A
Digital

tag associates discrete data with a digital state set, as specified by the user.

Sy
stem Digital State Set

Similar to digital state sets is the system digital state set. This set is used for all tags,
regardless of type to indicate the state of a tag at a particular time. For example, if the
interface receives bad data from an interface p
oint, it writes the system digital state
bad

input

to PI instead of a value. The system digital state set has many unused states
that can be used by the interface and other PI clients.




Siemens SIMATIC NET Interface to the PI System

23

23

PointSource

The PointSource is a single, unique character that is use
d to identify the PI point as a point

that belongs to a particular interface
.
For example, one may choose the letter
S

to identify
points that belong to the interface
.
To implement this, one would set the PointSource
attribute to
S

for every PI Point that
is configured for the interface
.
Then, if one uses
/ps=S

on the startup
-
command line of the interface, the Random interface will search the
PI Point Database upon startup for every PI point that is configured with a PointSource of

S.

Before an interface lo
ads a point, the interface usually performs further checks by
examining additional PI point attributes to determine whether a particular point is valid for
the interface
.
For additional information, see the
/ps

argument.

Case
-
sensitivity for PointSource At
tributes

If the interface is running on a PINet node and the Server node is a PI 3 system, use a
capital letter (or a case
-
insensitive character such as a number, a question mark, etc.) for
the PointSource attribute when defining points
.
For all other scen
arios, one does not need
to be careful with the case of the PointSource
.

In all cases, the point source character that is supplied with the
/ps

command
-
line
argument is not case sensitive
.
That is,
/ps=S

and
/ps=s

are equivalent
.
One only needs
to be care
ful with the case of the PointSource during point definition, and only if the
interface will be running on a PINet node communicating to a PI

3 Server.

PI 2 Server Nodes

The following point source characters are reserved on PI 2 systems and cannot be used
as the point source character for an interface:
C
,
?
,
@
,
Q
,
T
.
Also, if one does not specify a
point source character when creating a PI

point, the point is assigned a default point
source character of
L
. Therefore, it would be confusing to use
L

as the po
int source
character for an interface.

Before a PI point with a given point source can be created, the point source character
must be added to the PI 2 point source table
.
For example, if point source
S

is not defined
in the PI 2 point source table, a poin
t with a point source of
S

cannot be created
.
This
prevents the user from accidentally creating a point with an incorrect point source
character
.

Defining a Point Source Character in the PI 2 Point Source Table

1.

Enter PI by typing the following command from

a VMS command prompt:

@pisysexe:pi

2.

Select the PointSrc option from the menu.

3.

Select New from the menu.

PointSource

24


24

4.

Assign a point source next to the
Code
: field
.
Also, assign minimum and maximum
values for the Location1 to Location5 attributes.


Location1

Location2

Location3

Location4

Location5

Minimum

1

1

0

0

0

Maximum

10

1000

0

10

1

To disable outputs, set the maximum Location5 to zero.

5.

Select “Save” from the menu.

PI 3 Server Nodes

No point source table exists on a PI 3 Server, which means that points can be i
mmediately

created on PI 3 with any point source character. Several subsystems and applications that
ship with PI 3 are associated with default point source characters. The Totalizer
Subsystem uses the point source character
T
, the Alarm Subsystem uses
G

a
nd
@
,
Random uses
R
, RampSoak uses
9
, and the Performance Equations Subsystem uses
C
.
Either do not use these point source characters or change the default point source
characters for these applications. Also, if one does not specify a point source charact
er
when creating a PI

point, the point is assigned a default point source character of
L
.
Therefore, it would be confusing to use
L

as the point source character for an interface.



Siemens SIMATIC NET Interface to the PI Syste
m

25

25

PI Point Configuration

The PI point is the basic building block for control
ling data flow to and from the
PI

Data

Archive. A single point is configured for each measurement value that needs to
be archived. Use the point attributes below to define what data to transfer.

Point Attributes

Tag

A tag is a label or name for a point
.
An
y tag name can be used in accordance to the
normal PI point naming conventions.

PointSource

The PointSource is a single, unique character that is used to identify the PI point as a point

that belongs to a particular interface
.
For additional information, s
ee the
/ps

command
-
line argument and the “Point Source” section.

PointType

Typically, device point types do not need to correspond to PI point types. For example,
integer values from a device can be sent to floating point or digital PI tags. Similarly, a
f
loating
-
point value from the device can be sent to integer or digital PI tags, although the
values will be truncated.

PI 2 Server Nodes

Scaled real, full
-
precision real, integer, and digital point types are supported on
PI

2

Servers. For more information
on the individual point types, refer to the Data

Archive

(DA) section of
PI System Manual I
.

PI 3 Server Nodes

Float16, float32, int16, int32, digital, and string point types are supported on PI

3

Servers.
For more information on the individual point types
, see
PI

Data

Archive

for

NT and
UNIX
.


S5 PLC

For S5 PLCs, the interface supports reading memory block and treating the bytes as
characters. This requires string tags on the PI 3 home node.

See the description of the
PLCSIG

keyword under the description
of the Extended
Descriptor attribute.

5x5 PLC

For 5x5 PLCs, when reading memory as PI string types, any non
-
printable character will
be converted to a space within the length specified in the instrument tag.

PI Point Configuration

26


26

The following applies to input points (Location
5=0). When an input point has a PI point
type of R, the interface assumes that the PLC stores its values according to standard TF
Encodings (see Appendix). For example, the interface will assume that variables in V
memory are stored in Integer16 format.

Likewise, the interface assumes that variables in
V or VF memory are stored in floating
-
point format. Hence, if all of the memory types
that are being read from the PLC are stored according to the standard TF Encodings
given in the Appendix, then one can

safely use a point type of R for all PI Points and all
values should be read correctly into PI.

However, not all variables are stored according to their standard TF Encoding. Namely,
variables stored in V or VF memory are sometimes stored in Integer32 fo
rmat instead of
in floating point format. For this reason, when an input point has a PI point type of I or D,
the interface always assumes that the target variable is stored as an integer. Hence, one
can define a PI point of type I or D and read an Integ
er32 from V or VF memory.

Location1

Location1 indicates to which copy of the interface the point belongs.

Location2

The Location2 attribute assigns a "logical PLC number" to the PI point. The logical PLC
number that is assigned in Location2 must correspon
d to a logical PLC number in the
SINET.CFG file, which is described in detail under the section called "Configuration
Files." In the SINET.CFG file the logical PLC number is associated with a TSAP
address / Ethernet (MAC) address pair that must be unique.

One connection can be established to a PCL for every logical PLC number that is
assigned to the PLC. The same logical PLC number cannot be used to both read data
from and write data to a PLC.

Location3

For S5 Series PLC

Location3 is not used for reading
data from S5 series PLCs.

For TI505 Series PLC

Location3 is ignored for input tags.

Set location3 to 0 for individual writes, or set location3 to a non
-
zero integer to associated
the tag with a given output block. Each tag in a given output block, inclu
ding the output
master tag, should have the same value for location3. See “Output Tag Configuration” for
more information.

Location4

Scan
-
Based Inputs

For interfaces that support scan
-
based collection of data, Location4 defines the scan class
for the PI po
int. The scan class determines the frequency at which input points are
scanned for new values. For more information, see the description of the
/f

flag in the
section called “The Startup Command File”.


Siemens SIMATIC NET Interface to the PI System

27

27

Trigger
-
Based Inputs and Output Points

Location 4 shou
ld be set to zero for these points.

Location5

Location5 specifies the direction of data transfer. The interface is able to handle READ
and WRITE Telegrams. As the interface must open different connections for READ and
WRITE, you must configure a logical co
nnection to the PLC (Location2 and configuration
file) for each job (READ and WRITE) and PLC.



0
--

Input



1
--

Output


InstrumentTag

For a PI 2 Server, the instrument tag attribute is limited to 32 characters. For a
PI

3

Server, the instrument tag is limite
d to 32 characters.

S5 Series PLC

The memory location in the S5 that is targeted for reads or writes is defined in the
InstrumentTag field. The syntax is

Range[index],(type)[index](.bitnumber).

The

(type)
is optional. If not used, the interface will use
the default type from the table
below. In the current version, the interface only supports DW for DWORD and W for
WORD.

S5 Range

Description

Data type

DB

Common Data

Dword, 32 bit

MB

Merker Bereich

Byte, 8 bit

EB

Process Input

Byte, 8 bit

AB

Process O
utput

Byte, 8 bit

PB

Peripheral Device

Byte, 8 bit

ZB

Counter

Word, 16 bit

TB

Timer

Word, 16 bit

BS

System Data

Word, 16 bit

AS

Absolute Memory

Word, 16 bit

DX

Extended DB

Dword, 32 bit

DE

External DB

Dword, 32 bit

QB

Extended Peripheral Device

Byt
e, 8 bit

Note:

The Interface has only been tested with S5 Range DB, Data type Word, Dword

Examples of symbolic addresses that can be specified in the InstrumentTag field are given

in the following table.

Symbolic
Description

PI Point Configuration

28


28

Address

DB16,1

DB modul 16, D
word 1

DB16,W1

DB modul 16, word 1

DB16,1.1

DB modul 16, Dword 1, bit 1

DB16,DW1

DB modul 16, Dword 1


TI505 Series PLC

For output master tags, this field should be set to the memory type that is associated with
the output block (V for V memory, K for
K memory, etc.) A complete list of supported
memory types is given in the Appendix. For all other tags, the InstrumentTag field should
be defined as described below.

There are two options for designating the memory location in the PLC for reads or writes
.
For the first option, one directly specifies the symbolic address (e.g. V11 for memory type
V, word number 11) that is targeted for reads or writes in the InstrumentTag field. As
mentioned above, a complete list of supported memory types is given in th
e Appendix.
Examples of symbolic addresses that can be specified in the InstrumentTag field are given

in the following table.

Symbolic Address

Description

V3

Variable Memory, Word number 3

C17

Control Register number 17


If the memory location to be ac
cessed is to be treated as a PI string type, the symbolic
address must be specified along with the number of characters to be accessed whether
reads or writes. The maximum number of characters that can be read or written is 80.

Symbolic Address

Descriptio
n

V100, 6

Variable Memory, Word number 100,


6 characters


The second option is available for PCS systems. In PCS systems, PCS tags are mapped
to memory locations in the PLC. This mapping is done in an ASCII file called the
install.tag

file. An exampl
e of an
install.tag

file is given below:

Example install.tag file:

Record,ControlNode,TagType,Tag,Description,ProcessGroup,ManualSet,Parent,At
tribute,Memory,Locations,Upload,Twenty%,Autolog,InitValue

T,STATA,IVAR,78CMAPRODUCT,R78 CMA PRODUCT SELECTION,0xff
ffffff,N

A,,,,,,,,H_RANGE,,,,,,5000

A,,,,,,,,L_RANGE,,,,,,0

A,,,,,,,,VALUE,V2010,1,N, ,N,0

A,,,,,,,,STATUS,V2010,1,N, ,N,0

T,STATA,IVAR,77CMAPRODUCT,R77 CMA PRODUCT SELECTION,0xffffffff,N

A,,,,,,,,H_RANGE,,,,,,5000

A,,,,,,,,L_RANGE,,,,,,0

A,,,,,,,,VALUE,V2
011,1,N, ,N,0


Siemens SIMATIC NET Interface to the PI System

29

29

A,,,,,,,,STATUS,V2011,1,N, ,N,0

T,STATA,VLV2,CV647,BD SLOW CLOSE VALVE @ 1603,0xffffffff,N

A,,,,,,,,SETPOINT,C39,1,Y, ,N,0

A,,,,,,,,STATUS,C32,12,N, ,N,0

The PCS tag names are the fourth fields on the lines that begin with T. There are three

PCS tags names that are listed in the above files: 78CMAPRODUCT,
77CMAPRODUCT, and CV647. Attributes for each of these tags are listed on the lines
that begin with A. These attributes are mapped to memory locations in the PLC. For
example, the VALUE an
d STATUS attributes for tag 78CMAPRODUCT are both
mapped to memory location V2010. Similarly, the SETPOINT and STATUS attributes
for tag CV647 are mapped to memory location C39 and C32, respectively.

A particular memory location is designated for the inte
rface by assigning the
InstrumentTag field a name of the form
PCSTagname.Attribute
. For example, if one
assigns CV647.STATUS to the InstrumentTag field, memory location C32 will be read by
the interface. The InstrumentTag field is limited to 32 character
s.

Note:

For C memory locations, it is possible to read up to 32 bytes and combine these to
one 32
-
Bit value. To read, for example, C1234 and the next 11 bytes you have to use
C1234,12 as the memory location. The Interface will take care of this if you us
e the
INSTALL.TAG file. You may apply a Bit mask to the result to filter out necessary
information. See the description of the BITMASK keyword under the description of the
Extended Descriptor attribute for more information.


IMPORTANT:

If the array of up
to 32 values will exceed the internal block size of 480
bytes, the array will be truncated to the available bytes. When this happens, a message to
this effect will be written to the log file.

ExDesc

This is the extended descriptor attribute. For a PI

2

Ser
ver, the extended descriptor is
limited to 80 characters. For a PI 3 Server, the extended descriptor is limited to
80

characters.

Z=
InstZero

The Z keyword is used to specify the instrument zero (
InstZero)
. The instrument zero is
used in the conversions th
at are described under the SquareRoot PI Point attribute. If the
Z keyword is not found, then
InstZero

is assumed to be zero.

Performance Points

For UniInt
-
based interfaces, the extended descriptor is checked for the string
“PERFORMANCE_POINT”. If this ch
aracter string is found, UniInt treats this point as
a performance point. See the section called “Performance Points.”

Trigger
-
Based Inputs

For trigger
-
based input points, a separate trigger point must be configured. An input point
is associated with a tr
igger point by entering a case
-
insensitive string in the extended
descriptor (ExDesc) PI point attribute of the input point of the form:

keyword
=
trigger_tag_name

where
keyword

is replaced by “event” or “trig” and
trigger_tag_name

is replaced
by the name of

the trigger point. There should be no spaces in the string. UniInt
PI Point Configuration

30


30

automatically assumes that an input point is trigger
-
based instead of scan
-
based when the
keyword=trigger_tag_name

string is found in the extended descriptor attribute.

An input is trigger
ed when a new value is sent to the Snapshot of the trigger point. The
new value does not need to be different than the previous Snapshot value to trigger an
input, but the timestamp of the new value must be greater than (more recent than) or
equal to the t
imestamp of the previous value. This is different than the trigger mechanism
for output points. For output points, the timestamp of the trigger value must be greater
than (not greater than or equal to) the timestamp of the previous value.

Keywords Supporte
d Only for S5 Series PLC

BCD=
#

The BCD keyword is used to specify that the current memory word inside a DB is of
BCD type. The number in a range of 1 to 8 defines the number of BCD digits stored in
one word. It is only possible to use up to 8 BCD digits
in one PI tag. The PI tag should
be of type float to avoid overflows.

Note:

Floating point numbers only have 6 significant digits. If you need all BCD digits
significant, you should limit BCD to 4.

PLCSIG=<BYTE,RBYTE,LBYTE,INT16,INT32,FLT>

By default the

interface will read the memory from the PLC in the following standard C
data types:

PLCSI G

PI Data Type

I nteger

PI Data Type

Digital

PI Data Type

Float

<none>

Unsigned short

Short

Integer

BYTE, LBYTE

Char

-

Char

RBYTE

Char

-

Char

INT16

Unsigned short

-

Short

INT32

Unsigned integer

-

Integer

FLT

Float

-

Float

STRG

-

-

-

This may be changed by using the parameter PLCSIG in the extended descriptor.

Example:

Exdesc:
PLCSIG=FLT,
Instrumenttag:
DB50,DW83

Read the DWORD 83 from DB 50 as a Siemens S5 float
ing point number

Exdesc:
PLCSIG=INT32,
Instrumenttag:
DB50,DW83

Read the DWORD 83 from DB 50 as an integer

Exdesc:
PLCSIG=STRG,
Instrumenttag:
Read the WORD 83 from DB 50 and the following 8 Byte (4 WORDS) as
string.


Siemens SIMATIC NET Interface to the PI System

31

31

DB50,W83,8


Note:

If the string is d
efined of length <x> (
DB20,W1,<x>
), the maximum string length to
be read is <x>, while the maximum string length to be written is <x
-
1>. That is because the

interface writes a trailing NULL to the S5 memory. Additionally, the length of the string will
be
extended to fit the S5 memory (DB20,W1,3 will be extended to a 4 character string, as
S5 word memory is 2
-
byte oriented).


MASK=
0xh

The MASK keyword is used to specify the Mask which is applied via logical AND to the
PLC value. If the MASK keyword is not f
ound, then the bit mask is assumed to be
0xffffffff.

The result will be shifted to the first non
-
zero bit in the bitmask, zero bits within the bit
mask will not be compacted.

Keywords Supported Only for TI505 Series PLC

OUTPUT_MASTER

The interface can be c
onfigured to write data to individual memory locations or a block of
memory locations. When a block of memory locations is written, the write is triggered
with an output master tag. The output master tag must have the keyword
“OUTPUT_MASTER” in the exten
ded descriptor. See “Output Tag Configuration” for
more information.

MASK=
0xh

The MASK keyword is used to specify the Mask which is applied via logical AND to
multi
-
byte C memory locations. If the MASK keyword is not found, then the bit mask is
assumed to

be 0xffffffff.

The result will be shifted to the first non
-
zero bit in the bit mask, zero bits within the bit
mask will not be compacted.

MAP=map

The MAP keyword is used to specify a bitmap. The bits from an integer word that is
read from the PLC are re
arranged according to the bitmap, and the result is sent to PI.
Bit mapping is supported only for input tags. Moreover, the input tags must be integer or
digital PI Points otherwise the bit map will not be applied.

The format of the bit map is:






MAP=
uuvvwwxxyyzz

where uu, vv, ww, yy, and zz each refer to a single bit. A leading zero is required if the
referenced bit is less than 10. The lowest possible bit is 01 and the highest possible bit is
32. Up to 32 bits can be mapped.

A bitmap of 0307120
802 will map the second bit of the original word to the first bit of the
new word, the eighth bit to the second bit, the twelfth bit to the third bit, etc. The high
-
order bits of the new word are padded with zeros if the bits are not specified.

PI Point Configuration

32


32

For instan
ce, a single 16
-
bit PLC register holds the state of four different thermocouples.
The first 4 bits correspond to the first thermocouple; the second 4 bits correspond to the
second thermocouple, etc. Four different input tags with four different bitmaps c
ould be
used to read thermocouple states. The first input tag would use a bitmap of 04030201 to
read the state of the first thermocouple; the second input tag would use a bitmap of
08070605 to read the state of the second thermocouple, and so on. If the
16
-
bit word
from the PLC was 0000 0000 0101 0111 or decimal 87, then the first thermocouple state
would be interpreted as binary 0111 or decimal 7, the second thermocouple state would be
interpreted as 0101 or decimal 5, etc.

OFFS=offset

The OFFS keyword i
s used to specify an offset to the memory location. If the OFFS
keyword is not found, then
offset

is assumed to be zero.

Example:

If the memory address is V.1234 and offset is specified as 4, the interface will read from
memory location V.1238

Scan

By def
ault, the Scan attribute has a value of 1, which means that scanning is turned on for
the point. Setting the scan attribute to 0 turns scanning off. If the scan attribute is 0 when
the interface starts, SCAN OFF will be written to the PI point. If the scan

attribute is
changed from 1 to 0 while the interface is running, SCAN

OFF will also be written to the
PI point after the point edit is detected by the interface.

There is one other situation, which is independent of the Scan attribute, where UniInt will
w
rite SCAN OFF to a PI point. If a point that is currently loaded by the interface is edited
so that the point is no longer valid for the interface, the point will be removed from the
interface, and SCAN OFF will be written to the point. For example, if the

PointSource of
a PI point that is currently loaded by the interface is changed, the point will be removed
from the interface and SCAN OFF will be written to the point.

Shutdown

PI 2 Server Nodes

The Shutdown attribute is not used if the server node is a P
I

2 system. For information on
configuring shutdown events for PI 2, see Data Archive (DA) section 4.2.3 of
PI

System

Manual I
.

PI 3 Server Nodes

The shutdown attribute is used only if the server node is a PI 3 system.

The Shutdown attribute is 1 (true) by

default. The default behavior of the PI Shutdown
subsystem is to write the
SHUTDOWN

digital state to all PI points when PI is started. The
timestamp that is used for the
SHUTDOWN

events is retrieved from a file that is updated by
the Snapshot Subsystem. T
he timestamp is usually updated every 15 minutes, which
means that the timestamp for the
SHUTDOWN

events will be accurate to within 15

minutes
in the event of a power failure. For additional information on shutdown events, refer to
PI
Data Archive for NT a
nd UNIX
.


Siemens SIMATIC NET Interface to the PI System

33

33

Note:

The
SHUTDOWN

events that are written by the PI Shutdown subsystem are
independent of the
SHUTDOWN

events that are written by the interface when the
/stopstat=Shutdown

command
-
line argument is specified.

One can disable
SHUTDOWN

events from
being written to PI when PI is restarted by
setting the Shutdown attribute to 0 for each point. Alternatively, one can change the
default behavior of the PI Shutdown Subsystem to write
SHUTDOWN

events only for
PI

points that have their Shutdown attribute s
et to 0. To change the default behavior, edit
the
\
PI
\
dat
\
Shutdown.dat

file, as discussed in
PI Data Archive for NT and UNIX
.

Bufserv

It is undesirable to write shutdown events when Bufserv is being used. Bufserv is a utility
program that provides the cap
ability to store and forward events to a PI Server, allowing
continuous data collection when the Server is down for maintenance, upgrades, backups,
and unexpected failures. That is, when PI is shut down, Bufserv will continue to collect
data for the interf
ace, making it undesirable to write SHUTDOWN events to the PI points

for this interface.

SquareRoot

Conversions can be applied to input and output values for tags of type integer or real. The

conversion that is applied depends upon the value of the Square
Root PI Point attribute as
described in the following table.

Conditions

Operation

SquareRoot = 0

No operation. Raw input values are sent to PI for Input Tags and
raw values are output to the PLC for output tags.

SquareRoot = 1

Input tags:


Value = [ (
Value
-

InstZero)/ Convers ] * Span + Zero

Output tags:


Value = [ (Value
-

Zero)/Span] *Convers + InstZero

Zero, Span, and Convers are standard PI Point attributes. InstZero must be specified in
the extended descriptor. See the description of the ext
ended descriptor for more
information.

Output Points

Output points control the flow of data from the PI Data Archive to any destination that is
external to the PI Data Archive, such as a PLC or a third
-
party database. For example, to
write a value to a reg
ister in a PLC, one would use an output point. Each interface has its
own rules for determining whether a given point is an input point or an output point. There
is no
de facto

PI point attribute that distinguishes a point as an input point or an output
po
int.

Outputs are triggered for UniInt
-
based interfaces. That is, outputs are typically not
scheduled to occur on a periodic basis. There are two mechanisms for triggering an
output.

Output tags are used to write values to memory locations in a PLC. A tag
is an output
tag if the value of location5 is set to 1.

Note
: Block writes are not supported for S5 series PLCs.

PI Point Configuration

34


34

Output tags can be configured for individual writes or block writes. Individual writes are
assumed when location3 is set to 0 and block writes

are assumed when location3 is non
-
zero. Both individual writes and block writes are triggered. That is, outputs are written
only when a value is sent to a given trigger tag. For individual writes, trigger tags are
defined in the SourceTag attribute of
each output tag. For block writes, trigger tags are
defined in the SourceTag attribute of each output master tag. A tag is an output master
tag if the key word “OUTPUT_MASTER” appears in the extended descriptor of the
point.

There is one output master ta
g for each output block. Each tag in a given output block,
including the output master tag, should have the same value for location3. Only
contiguous registers can be written in an output block. There can be no gaps in the block.
That is, one cannot, f
or example, write only to V11, V12, and V14 in a block. The block
must also include V13. A total of 5 tags would need to be configured to write to V11 to
V14. One output tag is required for each V memory location and one output master tag is
needed.

E
xamples for configuring output tags for individual writes and block writes are given in the

Appendix. The appendix also explains how particular values are written to particular PLC

memory locations.

Ordinarily individual writes are sufficient for most tas
ks. One case where block writes
should be used for downloading programs to a PLC. For downloading programs, the
entire memory block must be written at once. One cannot take the chance that only part
of the program will be downloaded.

Trigger Method 1 (
Recommended)

For trigger method 1, a separate trigger point must be configured. The output point must
have the same point source as the interface. The trigger point can be associated with any
point source, including the point source of the interface. Also,

the point type of the trigger
point does not need to be the same as the point type of the output point.

The output point is associated with the trigger point by setting the SourceTag attribute of
the output point equal to the tag name of the trigger point
. An output is triggered when a
new value is sent to the Snapshot of the trigger point. The new value does not need to be
different than the previous value that was sent to the Snapshot to trigger an output, but the
timestamp of the new value must be more
recent than the previous value. If no error is
indicated, then the value that was sent to the trigger point is also written to the output
point. If the output is unsuccessful, then an appropriate digital state that is indicative of the
failure is usually w
ritten to the output point. If an error is not indicated, the output still may
not have succeeded because the interface may not be able to tell with certainty that an
output has failed.

Trigger Method 2

For trigger method 2, a separate trigger point is not

configured. To trigger an output, write
a new value to the Snapshot of the output point itself. The new value does not need to be
different than the previous value to trigger an output, but the timestamp of the new value
must be more recent than the previ
ous value.

Trigger method 2 may be easier to configure than trigger method 1, but trigger method 2
has a significant disadvantage. If the output is unsuccessful, there is no tag to receive a
digital state that is indicative of the failure, which is very i
mportant for troubleshooting


Siemens SIMATIC NET Interface to the PI System

35

35

Tag Configuration for PCS Systems

The SIEMENS PCS System consists of TI 505 Series PLC and Engineering Stations. The

PCS System knows Tagnames similar to PI Tagnames. The Tagnames are created in the

Engineering Station and are

mapped to physical addresses within a certain PLC. In order
to have maximum performance with our interface, we did not develop a separate PI
interface running on the Engineering Station. Instead, the interface PC is a member of
the H1 network and gets t
he data from the PLC directly. This concept guarantees
maximum speed. Since Tag handling and address mapping are done in the Engineering
Station we of course need to make sure that we have the same information available for
the interface configured for t
he PCS System. Therefore, we provide 2 scenarios for the
interface:

Option 1

The end user is able to retrieve the physical address for a specific value in the PLC from
the Engineering Station and configures this physical address in the form of symbolic
ad
dress strings as shown under “PI Point Configuration
-

Instrument Tag”.

Note
: Whenever a PCS Tag changes its location, the end user needs to track the change
in the PI System as well. The PI Tag needs to be edited and the interface will be notified of