Honeywell PHD Interface to the PI System

Honeywell PHD
Interface to the PI System

Version 2.1.0.0 to 2.2.8.1

Document Revision A

UniInt End-User Interface to the PI System

How to Contact Us

Phone / (510) 297-5800 (main number)
(510) 297-5828 (technical support)
Fax / (510) 357-8136
E-mail /
World Wide Web / http://www.osisoft.com
Mail / OSI Software, Inc.
P.O. Box 727
San Leandro, CA 94577-0427
USA
OSI Software GmbH
Hauptstrabe 30
D-63674 Altenstadt 1
Deutschland / OSI Software, Asia Pte Ltd
152 Beach Road
#09-06 Gateway East
Singapore, 189721
OSI Software, Ltd
P. O. Box 8256
Level One, 6-8 Nugent Street
Auckland 3, New Zealand

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 trademark 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. HPUX 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_HWPHD.doc

Ó 2000 - 2003 OSI Software, Inc. All rights reserved
777 Davis Street, Suite 250, San Leandro, CA 94577

UniInt End-User Interface to the PI System

Table of Contents

Introduction 1

Reference Manuals 1

Supported Features 1

Diagram of Hardware Connection 4

Principles of Operation 5

Installation Checklist 7

Interface Installation 9

Naming Conventions and Requirements 9

Microsoft DLLs 9

Interface Directories 10

The PIHOME Directory Tree 10

Interface Installation Directory 10

Interface Installation Procedure 10

Installing the Interface as an NT Service 11

Digital States 13

PointSource 15

PI Point Configuration 17

Point Attributes 17

Tag 17

PointSource 17

PointType 17

Location1 19

Location2 19

Location3 20

Location4 20

Location5 20

InstrumentTag 20

ExcDesc 21

Scan 21

SourceTag 22

Shutdown 22

UserInt1 23

Output Points 23

Trigger Method 1 (Recommended) 23

Trigger Method 2 23

PIPHDPtBld 24

Performance Point Configuration 25

I/O Rate Tag Configuration 27

Monitoring I/O Rates on the Interface Node 27

Configuring the PI Point on the PI Server 27

Configuration on the Interface Node 27

Startup Command File 29

General 29

History Recovery 30

PHD Debugging 30

Timestamps 30

Additional Arguments 30

Command-line Parameters 30

Example PIphd.bat File 35

PI-PHD Interface System Administration 35

Starting the PI-PHD interface 35

Automatic Service Startup 35

Manual Service Startup 35

Interactive Startup 35

Stopping the PI-PHD Interface 35

Registering the PI-PHD Interface as a Windows NT Service 35

Manual Services 35

Automatic Services 35

Removing the PI-PHD Interface as a Windows NT Service 35

Status, Warning, and Error Messages 35

Interface Node Clock 35

Security 35

Starting / Stopping the Interface 35

Starting Interface as a Service 35

Stopping Interface Running as a Service 35

Buffering 35

Appendix A Error and Informational Messages 35

Message Logs 35

System Errors and PI Errors 35

Appendix B: Troubleshooting 35

Honeywell PHD Interface to the PI System 31

Introduction

The Honeywell PHD Interface (PI-PHD) provides two-way communication with a Honeywell PHD System. The interface program reads the PI point database to determine which points to read from and write to the Honeywell PHD System. This interface may run on a TPS Node, which contains the PHD API from Honeywell or a PHD Client node that connects to the Honeywell PHD System. The customer must be running a Honeywell PHD System.

The PHD System must be at version 100 or higher, and the LCN must be at version 520 or higher. More information can be found in the Totalplant Process History Database Electronic Documentation 100 rev 1 12 AUG 1997.

This version of the interface includes:

· Reads data from and writes data to a Honeywell PHD system.

· Point database utility to build csv files from the PHD system to use with PIConfig to create and edit the PIPoint database.

· History recovery

Reference Manuals

OSI

· UniInt End User Document

· PI Data Archive Manual

· PI-API Installation Instructions

Vendor

A set of manuals in electronic format is available from Honeywell that may be of interest. These manuals are:

· Totalplant Process History Database Electronic Documentation 100 rev 1 12 AUG 1997

· PHD System Manual Document number PIM 030.1 (including a PHD API discussion)

Supported Features

Feature / Support /
Part Number / PI-IN-HW-PHD-NTI
Platforms / NTI
PI Point Types / float64 / float 32 / float16, int16 / int32 / digital / string
Sub-Second Timestamps / No
Sub-Second Scan Classes / No
Automatically Incorporates PI Point Attribute Changes / Yes
Exception Reporting / Yes
Outputs from PI / Yes
Inputs to PI: Scan-Based / Unsolicited / Event Tags / Scan-based
Maximum Point Count / Unlimited
Uses PI-SDK / No
* Source of Timestamps / PHD / Configurable
* History Recovery / Yes
Failover / No
* UniInt-Based / Yes
* Vendor Software Required on PI-API / Yes
Additional PI Software Included with Interface / No

* See paragraphs below for further explanation.

Source of Timestamps

The timestamps for the data comes from the PHD. The interface calculates the time difference between the PHD and the PI server every 1 minute. This offset is applied to the PHD time stamps prior to sending the data to PI.

With version 1.5 of the interface, the timestamp usage is configurable by adding a startup parameter in the pi-phd.bat file.

/ts=x

0 - default. Use PHD Timestamps and apply difference of PHD server time and PI Server time.

1 - Use PHD Timestamps without applying time difference. This is only done if PHD server time is behind PI server time. If PI server time is behind PHD server time, the timestamps will be adjusted to PI server time.

2 - Do not use PHD Timestamps. Send last value in each scan and use the PI server time.

History Recovery

The PI-PHD Interface retrieves data from PHD for points flagged for history recovery during the time when the interface has been down and no data was collected. Set location 3 to 1 for points that you want history recovery done. The history parameter, /hi=MAX, must also be passed in pi-phd.bat where MAX is the maximum time period the interface will go back in time to retrieve history. The time period must specify whether the period is in minutes, hours, or days as well as specify the number of those periods to go back. Some example time ranges are: 2d (two days), 24h (24 hours), 60m (sixty minutes). If no maximum time period is specified or the time period entered is invalid then the default of two days will be used.

History recovery will be started at interface startup or after a communication failure has occurred and is then resumed between PI and PHD. Data will be retrieved from the PHD starting from the last good value in the PI archive up to the current time, or the MAX recovery time specified in PI-PHD.bat. If good data is not found before the MAX recovery time, an I/O Timeout will be written to the point at the MAX time.

If the /hi parameter is not passed then no history recovery is done.

Failover

There is no Failover for this interface.

UniInt-Based

UniInt stands for Universal Interface, and it is an OSI-developed template used to create many of our interfaces. UniInt is not a separate product or file, it is solely a template used by our developers, and is integrated into the 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. UniInt is constantly being upgraded with new options and features. In any UniInt interface, UniInt uses some of the supplied configuration parameters, and some parameters are interface-specific features of the interface.

The UniInt End User Document is a supplement to this manual.

Vendor Software Required

PHD Server and ‘C’ API from Honeywell.

If interface is to be run on a node other than the PHD Server, the Honeywell PHD Client must be installed on this node.

The PI-PHD Interface is connected to a PHD system that must be at version 100 or higher and less than version 200. The PI-PHD Interface runs on the same NT as the PHD system. If an LCN is connected to the PHD system, the version of the LCN must be 520 or higher.

Diagram of Hardware Connection

Honeywell PHD Interface to the PI System 31

Principles of Operation

Each PHD value includes a “confidence level” between 0 and 100. A useable value is always available if the confidence number is between 0 and 100. One hundred indicates high quality, 0 represents an uncertain result. If no value is available at all, the confidence level becomes -1.

Starting with interface version 2.2.6, the UserInt1 point attribute is used to interpret the PHD confidence factor.

The UserInt1 point attribute will be used to specify the minimum confidence. The default setting for this parameter will be zero, that is, the value is returned if the confidence is zero or greater. If the PHD confidence is below the UserInt1 value, the PI-PHD Interface returns “Bad Input.”

Starting with interface version 2.2, virtual tags on the PHD server can be read.

This version of the interface includes:

· Reads data from and writes data to a Honeywell PHD system.

· Point database utility to build csv files from the PHD system to use with PIConfig to create and edit the PIPoint database.

· History recovery

Honeywell PHD Interface to the PI System 31

Installation Checklist

This checklist should help you get the interface up and running. The steps should be followed in the order outlined below.

1. Install the interface.

2. Define digital states.

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

4. Configure PI points.
Location1 is the interface instance.
Location2 is the direction. 1 for inputs, 2 for outputs, 3 output timestamp, 4 output timestamp and value.
Location3 is 1 if History Recovery is to be done on this point.
Location4 is the scan class.
Location5 is not used.
ExDesc is the PHD tag to output a timestamp to. This is for when location2=4 that outputs both a value and a timestamp
InstrumentTag is the PHD tag to read or write to.

5. Configure performance points.

6. Configure I/O rate tag.

7. Edit startup command file.

8. Set interface node clock.

9. Setup security.

10. Start the interface.

11. Verify data.

12. Stop interface, start buffering, start interface.

Honeywell PHD Interface to the PI System 31

Interface Installation

OSI recommends that interfaces be installed on API nodes instead of directly on the PIServer node. An API node is any node other than the PI Server node where the PIApplication Programming Interface (PI-API) has been installed (see the PIAPIInstallation Instructions manual). With this approach, the PI Server need not compete with interfaces for CPU time. 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 the APInode (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 communication 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 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 node 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 installation procedure below, it is assumed that the name of the interface executable is pi-phd.exe and that the startup command file is called pi-phd.bat.

It is customary for the user to rename the executable and the startup command file when multiple copies of the interface are run. For example, one would typically use pi-phd1.exe and pi-phd1.bat for interface number 1, pi-phd2.exe and pi-phd2.bat for interface number 2, and so on. When an interface is run as a service, the executable and the command file must have the same root name because the service looks for its command-line arguments in a file that has the same root name.