moore ici - osisoftcdn.osisoft.com/interfaces/1366/pi_mricint_1.3.4.1b.doc · web viewremove the...

Moore ICI on NTInterface to the PI System

version 1.0.0Document Revision B

PI-IN-MR-ICI-NT OSI Software, Inc.

How to Contact UsPhone (510) 297-5800 (main number)

(510) 297-5828 (technical support)

Fax (510) 357-8136

Internet [email protected]

World Wide Web

http://www.osisoft.com

Bulletin Board

(510) 895-9423Telebit WorldBlazer modem (Hayes, MNP, or PEP compatible)8 data bits, 1 stop bit, no parity, up to 14400 bps downloadprotocols: Xmodem, Ymodem, Zmodem, Kermit

Mail OSI Software, Inc.P.O. Box 727San Leandro, CA 94577-0427USA

OSI Software GmbH Hauptstrae 30 D-63674 Altenstadt 1Deutschland

OSI Software, LtdP. O. Box 8256Level One, 6-8 Nugent StreetAuckland 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.

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.

document.doc

1997 OSI Software, Inc. All rights reserved777 Davis Street, Suite 250, San Leandro, CA 94577

Table of ContentsIntroduction.............................................................................................................................1

PI Point Definition...................................................................................................................2

Additional Tag Configuration Descriptors............................................................................6

Point Attributes Not Used by Interface................................................................................6

Model 320 ICI Hardware Configuration...................................................................................7

Configuring the ICI..............................................................................................................7

RS-232C Cable Setup.........................................................................................................8

Hardware Configuration..........................................................................................................9

Configuring the ICI..............................................................................................................9

RS-232C Cable Setup.........................................................................................................9

Installing the Interface...........................................................................................................10

Setting up the Interface........................................................................................................11

Moore Products Company Supplied Software..................................................................13

Running the Interface...........................................................................................................14

Running Moore ICI Interface as an NT Service.................................................................14

Running PI Moore ICI Interface Interactively.....................................................................14

Information and Error Messages.......................................................................................14

Troubleshooting.................................................................................................................15

Interface Operating Information............................................................................................16

Interface Point List.............................................................................................................16

Output Data.......................................................................................................................16

Input Data..........................................................................................................................16

Scanning Principles...........................................................................................................16

Local Instrument Link (LIL)................................................................................................17

High Level Link (HLL)........................................................................................................17

Appendix A: TestICI Utility Introduction................................................................................23

TestICI Device Independent Functions.................................................................................25

Btest..................................................................................................................................25

05/09/23 4:50 AM iii

Ibits....................................................................................................................................26

Vbit....................................................................................................................................26

TestICI Device Functions......................................................................................................28

Display text for an ICI error number..................................................................................28

Asgn..................................................................................................................................29

LIL Functions.....................................................................................................................30

HLL Functions...................................................................................................................34

Appendix B: Interface Distributions as Self-Extracting Executables.....................................43

Documentation Updates....................................................................................................43

iv OSI Software, Inc.

List of FiguresFIGURE 1. ICI 320 SERIAL PORT BOARD 18

FIGURE 2. DATA SET/DATA TERMINAL CONNECTIONS 19

FIGURE 3. ICI 320 MPU BOARD DIP SWITCH 19

FIGURE 4. BLOWUP OF ICC PIGGYBACK BOARD 21

FIGURE 5. SETTING OF JUMPERS W8 AND W9 21

FIGURE 6. FRONT PANEL, ICI 2.0 OR 2.5 22

05/09/23 4:50 AM v

IntroductionThe Moore ICI Interface provides for the bi-directional transfer of data between the Moore Products Company's Local Instrument Link (LIL) and Hi-Level Link (HLL) global data bases, and the Plant Information (PI) System. Communication between the Microsoft Windows NT computer and the HLL global database is accomplished using either Moore Products Company's Mycro Model 3932 Independent Computer Interface (ICI). The Mycro Model 3932 ICI (more commonly referred to as an ICI-2.5) uses an RS-232C serial link to the Windows NT computer. Communication between the Windows NT computer and the LIL global database is accomplished via Moore Products Company's Model 320 ICI. The Model 320 ICI uses an RS-232C serial link to the Windows NT computer. The interface can run on a Windows NT machine containing either the PI Home Node or a PI API node.

The Moore ICI Interface consists of a single executable program, a utility program for testing the connection to the HLL or LIL, and a batch file for starting the interface. There may be one or more ICI's connected to the PI System. The PI system can communicate with ICI-2.5's, and Model 320 ICI's concurrently. Every ICI requires its own copy of the interface program.

The interface uses the Moore Products Company's Moore ICI Communications Software Package Library to communicate with the ICI-2.5 or the Model 320 ICI. OSI Software, Inc. now distributes the Moore Products Company’s ICI Communications Software Library with the PI-Moore ICI interface. Inputs from an ICI are scanned on a periodic basis. Outputs are sent out to an ICI whenever an output value changes.

Supported Features

Sign up for Updates Yes

Exception Reporting Yes

Outputs Yes

Vendor Software Required Yes

Uniint Based Yes

05/09/23 4:50 AM 1

Moore ICI Interface Documentation

PI Point DefinitionThe following information is necessary for defining a PI point to be read from or written to either the Moore LIL or HLL global databases. There may be one or more PI points associated with each global data base channel. A channel can hold up to 16 bits of data, and one or more bits combined can be used to hold separate pieces of data. Conversely, a single PI point can be the resultant of two global data base channels.

Point SourceAll points defined in the PI Database to be used by the Moore ICI Interface must share a common point source. The point source is any one-character value, for example M.

Point TypeThe interface supports all three PI 2 point types, real R, integer I, and discrete D, and the following five PI 3 point types float16, float32, int16, int32, digital. Multiple discrete alarm and status bits are processed to form individual PI digital points.

Location1The first location is mainly used for digital points, but can also be used for integer points. For digital points, it is used to specify how the interface will convert an integer value into a digital state For integer points, it is used to specify a bit mask to be applied to a value. It is used when reading or outputting controller, alarm, or status information. Location1 may take on the following values:

> 0 bits are specified as decimal digits 0 word is a discrete digital -1 controller source/mode

The controller source/mode is determined for MMLC, Mycro 351, and Mycro 352 loops.

Location 1 > 0:

Up to 5 bits can be specified. The bits can be specified in any order; i.e. bits 5,6,7, and 8 could be specified as 8050706. To specify a single bit (2-state tag), enter the bit number. To specify 2 bits, enter 100 times the first bit plus the second bit. For example, bits 7 and 8 can be specified as 708. In this example, the PI tag is a digital state tag according to the following truth table:

Bit 7 Bit 8 PI value

0 0 0

0 1 1

1 0 2

1 1 3

Specify a 3-bit value as b1b2b3 (e.g. 80706). For digital tags, a 3-bit value has 8 possible states, and a 4-bit value would be specified as b1b2b3b4 (e.g. 5060708) and has 16 possible states.

2 OSI Software, Inc.

It is up to the user to set up the appropriate truth table for a digital state tag. The states for all possible combinations must also be entered into the digital state table.

Location 1 = -1:

The controller source/mode tag uses bits 1,2,3,5,6,7,8,9, and 10 contained within the Loop Status Word for each loop. A simplified truth table is:

H E/M O R Cmp Con I/E S L A/M Pi

Bit 10 Bit 9 Bit 8 Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Val Mode

0 0 0 0 0 X X 0 1 0 0 Local/Man

0 0 0 0 X 0 X 0 1 0 0 Local/Man

0 0 0 0 0 X X 0 1 1 1 Loc/Auto

0 0 0 0 X 0 X 0 1 1 1 Loc/Auto

0 0 0 0 0 1 X 0 0 0 2 Cons/Man

0 0 0 0 0 1 X 0 0 1 3 Cons/Auto

0 0 0 0 1 0 X 0 0 0 4 Comp/Man

0 0 0 0 1 0 X 0 0 1 5 Comp/Auto

X X X X X X X 1 X X 6 Sync

X 1 X X X X X 0 X X 7 Eman

X 0 1 X X X X 0 X X 8 Override

1 0 0 X X X X 0 X 1 9 Hold

0 0 0 1 X X 0 0 X 1 10 Ramp

All Other Bit Combinations 11 Offline

Where

0 = Logic 01 = Logic 1X = either state, does not affect logic

The twelve digital states listed above must be entered into the digital state table if you are storing the mode in a digital tag.

For integer tags, the integer value

Location2

HLL (slots 1 – 15)

The HLL address specifies the High Level Link #, Satellite #, Slot #, and Channel #. The HLL address is in the form of:

LSSTTCCC

where

L = HLL numberSS = Satellite numberTT = Slot numberCCC = Channel number

05/09/23 4:50 AM 3


Therefore, the address of a point that is located on HLL #1, Satellite #9, Slot #15, Channel #138 is:address = 10915138

HLL Loops

Loops are always on slot 16 (Multi-Loop controller), and a Multi-Loop controller can have 64 loops per slot. Each loop consists of 4 channels, a PV, SP, output, and status/mode tag: 1 - process value 2 - set point 3 - controller output 4 - controller status/mode

To calculate the channel for a PV:channel = loop_number * 4 - 3

Therefore, the address of a loop PV that is located on HLL #1, Satellite #9, Loop #23 is:address = 10916089 (channel = 23 * 4 – 3 = 89)

Likewise, to calculate the channel for the SP on the same loop:channel = loop_number * 4 – 2, or simply add 1 to the PV channel number

And the address for the SP on the same HLL, Satellite, and Loop is:address = 10916090 (channel = 23 * 4 – 2 = 90) or (channel = PV for same loop + 1)

Note There can be:1 - 4 HLL's on an ICI1 - 15 Satellite Stations on an HLL1 - 16 Slots on a Satellite Station1 - 256 Channels on a Slot

LIL

If the value of the tag is an output to a LIL device, such as a Mycro 352, then its LIL global data base address must be specified. The address specifies the Station # and Channel#. The address is in the form of:

SSCCC

where

SS = Station numberCCC = Channel number

Therefore, the address of a point that is located on Station #13, Channel #22, and Parameter #1 is:address = 13022

The address of a point that is located on Station #3, Channel #9 is:address = 3009Note that the leading 0 is neither required, nor is it possible to have a location code with a leading 0.

Note, there can be:1 - LIL per ICI2 - 64 Stations on a LIL1 - 256 Channels on a Station1 - 256 Parameters on a Channel

Only parameter 1 will be read from or output to.


Location3The third location indicates whether the PI tag will be the result of adding two input values together or if the tag is an output. If the PI tag is the resultant of two values, Location3 should be 1. If the PI tag is to be the resultant of two values, and if the resultant is to be divided by 100, Location3 should be 2. This applies to various data obtained from Mycro 382's. Both integer and real tags can be the resultant of two input values. The maximum allowable value for an integer is 32767. If the PI tag is to be an output, Location3 should be 3. If the PI tag is none of the above, Location3 should be 0.

0 - single value1 - combine two values together2 - combine two values together, divide total by 1003 - tag is an output value

Location4This parameter determines the scan class of the tag. Currently, the interface only supports one scan class, and all Moore ICI tags must a 1 in location4. The scan frequency is specified in the interface startup command file.

Location5The fifth location is used to indicate whether an input or output point is specified to be reverse acting. For inputs, the value in engineering units will be equal to: value = 100. - value. For outputs, value = 100. - value, and the value is then converted back to counts (128 - 3840). The requirements for specifying a point to be reverse acting are: the square root field must be 0, the point must be Real, and the Zero and Span must be 0. and 100. respectively. The most likely case for specifying a point to be reverse acting is for reverse acting controller outputs (the signal from the controller which is an input).

0 = not reverse acting1 = reverse actingExtended Descriptor

The extended descriptor is now used to identify input points whose value is contained in a 16 bit signed integer. If the instrument zero is NOT 0 counts and/or the instrument span is NOT 4095 counts, the string %RAW must be contained somewhere within the Extended Descriptor. In addition, the instrument zero and instrument span must be specified in the Extended Descriptor. This now provides for an allowable range of -65535 - 65535 for the instrument. See Extended Descriptor section below for more information.

Extended DescriptorICI number;%RAW;raw zero;raw span

Example: 1;%RAW;-10000;10000

Meaning that -10000 is the zero and 10000 is the high range.

The first element is the number of the ICI that the interface is connected to. There can be up to 99 ICI's interfaced to the PI system.

05/09/23 4:50 AM 5


Square Root CodeThe square root code is used by the interface to take the square root of, or square output and input data. The requirements for specifying square root extraction or squaring are: the point must be Real and Location5 must be set equal to 0.

Square Root Code Result

0 raw value

1 square root of value

2 value squared

Additional Tag Configuration DescriptorsThere are additional tag configuration parameters that are not unique to the Moore ICI interface but are required for proper operation. These parameters are listed below:

Tag Name

Descriptor

Typical Value

Engineering Units

Starting Digital State Code

Number of Digital States

Filter Code

Archiving Flag

Compression Flag

Resolution Code

Compression Deviation

Compression Minimum Time

Compression Maximum Time

Zero

Span

Point Attributes Not Used by Interface Totalization Code

Scan Flag

Conversion Factor

UserReal1

UserReal2


Model 320 ICI Hardware ConfigurationConfiguring the ICI

Before you can configure the ICI you must remove the three-card assembly from the casing. Remove the front panel by flipping the door down on the front panel and removing the screw. The card assembly can then be removed. The MPU is the bottom board, the middle board is the link board, and the top board is the serial port board. Remove the screws that attach the boards to one another so that you can get at the jumpers and switches located on the MPU and the serial port boards. The cable adapter board (otherwise known as the data set/data terminal board) is connected to terminal C, which is located on the back of the casing.

The selection of RS-232C or RS-422 is determined by the jumper positions of W5 and W6 on the serial port board. Refer to Figure 1 that is a schematic of the serial port board.

Two possible cable pinouts are possible, as determined by the connector used on the cable adapter board that mounts on terminal strip C. Figure 2 shows the wiring of that board and the required pinouts for the ICI to appear as either a data set (DS or DCE) or a data terminal (DT). If the ICI is configured as a DS then the DB25 female connector is used. If the ICI is configured as a DT then the DB25 male connector is used. Configure the ICI as a DS if the cable used is a straight cable. Configure the ICI as a DT if the cable used is a null modem.

Figure 2 shows the required placement of the jumpers W1 and W2 for setting flow control to either DSR or CTS. Remove both jumpers if no flow control is to be used.

Set the baud rate of the ICI to match the baud rate of the PC. A baud rate of 19200 is recommended. This is done by setting the W7 jumper to the proper setting. Refer to Figure 1.

Enable the null data response function. This is done by setting Switch 3 on the MPU board to the open position. Refer to Figure 3.

Enable the response delay function. This is done by setting Switch 4 on the MPU board to the open position. Refer to Figure 3.

Set the operational mode to BINARY by setting Switch 5 on the MPU board to the closed position. Refer to Figure 3.

The Model 320 ICI provides send command security. Depending upon what security level is chosen, information contributed by the computer to the ICI is restricted. The security level is set from Switches 1 and 2 on the MPU board. See Figure 3. If the computer is going to both read and output data, the recommended security level is RECORD. If the computer is to read data only, the recommended security level is PARAMETER.

05/09/23 4:50 AM 7


The data format of the computer port should be set to odd parity and 8 data bits. This is done by setting Bit 8 of Switch 2 (SW2-8) to the open position and Bit 4 of Switch 2 (SW2-4) to the open position. Switch 2 is located on the serial port board. Refer to Figure 1.

Note Closed is synonymous with on, open is synonymous with off.

RS-232C Cable SetupThe computer is connected to the ICI using the appropriate connector located on terminal strip C. The desired RS-232C signal from the computer that is to drive the ICI CTS input line is jumper selectable by W1 when using the data set connector and by W2 when using the data terminal connector. The jumper may be removed completely to always enable the signal. Refer to Figure 2 for a schematic of the cable pinouts. Only the TRANSMIT DATA, RECEIVE DATA, AND SIGNAL GROUND are required.


Hardware ConfigurationConfiguring the ICI

The ICI-2.5 must be configured as listed below. Before the configurations can be set however, the ICI front panel cover must first be removed.

Set the ICI-2.5 as a Data Set (DS) device if the cable used is a straight cable. Set the ICI-2.5 as a Data Terminal (DT) device if the cable used is a null modem. See Figure 4, which contains a blowup of the piggyback board of the ICI's Interface Computer Assembly (it is the top board but is labeled as board 5). Before pulling the piggyback board and the ICI Interface Computer Assembly board, turn the power off to the ICI and unplug the ribbon cable from the piggyback board. Use a wrist strap grounded to the ICI unit before sliding the card assembly most of the way out. Set the W8 jumper either to the DS or DT position and remove the W9 jumper. A jumper is set to the DS position if the line dividing the two sections of the jumper is parallel to the front edge of the card. It is set to the DT position if the line is perpendicular to the front edge of the card.

The following settings are made on the front panel of the Interface Communication Computer, see Figure 5.

Set the baud rate of the ICI-2.5 to match the baud rate of the PC. A baud rate of 19200 is recommended. This is done setting bit 3 to ON and bit 4 to OFF of switch 2.

Enable the null data response function. This is done by setting bit 2 of switch 2 to ON.

Enable the response delay function. This is done by setting bit 1 of switch 2 to ON.

Set the operational mode to BINARY with switch 5.

Note: ON corresponds to the 1 state and OFF corresponds to the 0 state.

RS-232C Cable SetupThe RS-232C cable plugs into a DB25 female connector located in the rear of the ICI-2.5.

The connection between the PC and the ICI-2.5 is directly to a serial port on the PC, so only the TRANSMIT DATA, RECEIVE DATA, AND SIGNAL GROUND are required.

05/09/23 4:50 AM 9


Installing the Interface Prior to the installation of the Moore ICI interface, if the PI Server is not running on the same computer as the interface will be, you need to install the PI-API.

Then, create the directory in which to put the interface program. If the PI Server is running on the same computer, the convention is to put the interface in a sub-directory under the interface directory, e.g. \pi\interfaces\moore. If the interface is running on an API Node, put the interface in a sub-directory under the pipc directory, e.g. \pipc\interfaces\moore. Copy the interface files from the distribution disk (see example directory structure below). The file moore.bat contains startup parameters described in the next section. You should modify that file to suit your system’s need.

The Moore ICI Interface installation diskette contains the following files:MOORE.EXE : MOORE ICI Interface executable fileMOORE.DBG : Interface debug symbols fileMOORE.BAT : Startup command fileMSVCRT.DLL : Microsoft Visual C++ Run Time libraryMSVCIRT.DLL : Microsoft Visual C++ Run Time library TestICI.EXE : Test Program that allows users to test the

connection to the LIL and HLL

Example interface directory structureThe following files should be installed:PI HOME DIRECTORY\

INTERFACES\

MOORE\MOORE.EXEMOORE.BATTestICI.EXE

The moore.dbg debug symbols file needs to be placed in the \winnt\symbols\exe directory. If this directory does not exist, it needs to be created for the moore.dbg file.


Setting up the Interface There are eight option parameters in Moore#.bat which control the operation of the interface program. The parameters are described in the table below:

Parameter Description

/ps= Specifies the point source

/host= Specifies the name of the PI Server Node.

/id= or (/in=)

Specifies the interface ID number. Valid values are between 1 and 99. See discussion in extended descriptor.

/f= Specifies the scan period and phase. The period is the amount of time between scan. The phase is the time to start the first scan specified as offset from midnight.

The period and phase are supplied in the format of hh:mm:ss. A comma should separate the period and the phase. If the phase is not defined, the interface will start the scan cycle for this class as soon as possible.

You can define only one scan class.

/ec= Specifies the event counter number. The event counter is used for pi 2.x system. Current version of pi 3.x system does not support event counter.

The /ec flag is used to specify an IORate tag from the iorates.dat file. Example entries from an iorates.dat file are given below:

Tagname1, 1

Tagname2, 2

where tagname1 and tagname2 can be any legal tag name. The number after the tag name can be between 1 and 33 or between 51 and 200, inclusive. Numbers 34 to 50 are reserved for future use. If /ec=2 is used on the command line for the above iorates.dat file, then the rate (events per minute) at which data is sent to the snapshot will be stored in Tagname2. The rate that is sent to Tagname2 is a 10-minute average (i.e. the total number of events collected by the interface divided by 10 minutes). Therefore the IORate will appear to be zero for the first 10 minutes of interface operation. IORates for individual tags cannot be measured at this time.

The iorates.dat file must be created by hand. The file should be placed in the dat\ directory. The dat\ directory is located in the directory designated by the PIHOME entry in the pipc.ini file. Normally the PIHOME entry points to the c:\PIPC\ directory so that the iorates.dat file will reside in the c:\PIPC\dat\ directory.

Once the iorates.dat file is created, the interface must be stopped and restarted before the interface begins measuring the IORate.

Although the interface will allow multiple instances of the /ec flag to be specified on the command line, the rate will only be nonzero for the first rate tag that is referenced.

/mode The baud, bits, parity, and stop bits of the serial connection. For example: /mode=9600,8,2,0

05/09/23 4:50 AM 11


Parameter Description

/type ICI type, must be either 2.5 or 320

/port Device port name, for example: COM1

Optional Parameters retrieved by Uniint and Interface

/q Tells the interface to queue up events before putting the data into the PI system. The q version is more efficient if the interface is on a separate computer from the PI Server. However, it will slightly delay the update of the snapshot value if the data rate is low. The buffer size of the event queue for the interface is 128 events.

/stopstat If the /stopstat command line parameter is specified, the interface writes I/O timeout to all INPUT points (not OUTPUT), zeros the event counters, and disconnects from the PI server.

/sio When the /sio flag is specified, the outputs are no longer written at startup or when points are edited.

/db Turns on debug messaging from Uniint and Interface

/noou Tells the interface to suppress writing OVERRANGE and UNDERRANGE digital states for values that are under or over zero or span, respectively

/mr= Maximum number of communications retries, default is 3, valid range is 0 to 10 retries

/rst= Retry sleep time between retries, default is 200 milliseconds, valid range is 0 to 1000 milliseconds

/perf=x Turns on performance summaries at the rate of once per x hours.

The following is a sample interface startup command file, Moore#.bat.@echo offREM moore.batREMREM revised:REM 17-Jun-98 HAO> added /noou and uniint 2.2.9 parametersREM 13-May-97 hao> writtenREMREM this command procedure passes required -default parameters toREM process moore.REMREM if multiple copies of the interface are to be run, copy moore.bat to moore#.batREM where # is the same number passed by /id=# in the command string.REMREM command line arguments:REM /ps= point sourceREM /ec= rate counter numberREM /f= requires a single frequencyREM /host= name of receiving nodeREM /id= (or /in= ) ICI number to associate with particular interfaceREM /mode= baud, bits, parity, stop bitsREM 2 = no parityREM 0 = 1 stop bitREM Example: /mode=9600 8 2 0REM /port= device port name, e.g., COM1REM /type= ICI type, must be either 2.5 or 320REMREM optional param retrieved by uniint and interfaceREM /db= turns on additional debug messagesREM /sio When the /sio flag is specified, outputs are no longer written at REM startup


REM or when points are edited.REM /q= queue up data before sending to PI.REM /stopstat Write I/O timeout to all INPUT points (not OUTPUT), zeros the eventREM counters, and disconnects from the PI server when interface is REM stoppedREM /noou When the /noou flag is specified, OVERRANGE and UNDERRANGE digital REM statesREM will not replace the over or under range values sent to PI.REM /mr= Maximum number of communications retries, default is 3, max is 10, REM min is 0REM /rst= Retry sleep time between retries, default is 200 milliseconds, max is REM 1000 milliseconds, min is 0 millisecondsREMREM run string needs a space between arguments, no spaces within argument.REMmoore /ps=M /ec=1 /f=00:00:10 /host=localhost:5450 /id=45 /mode=19200,8,2,0 /port=com1 /type=320 /noou

Moore Products Company Supplied SoftwareOSI Software, Inc. now supplies the Moore Products Company ICI Communications Software Library, which are written in C++. Use of the files contained in the packages simplifies the communication programming that needs to be written into the interface.

05/09/23 4:50 AM 13


Running the Interface Running Moore ICI Interface as an NT Service

To configure the PI Moore ICI interface to run as a service, from the interface directory, execute:Moore -install

To change the Services from Manual mode to Automatic mode, follow this procedure:

1. Go to Control Panel.

2. Select Services

3. Select the Moore service

4. Click the Startup button.

5. Change the Startup Type from Manual to Automatic.

6. Click OK and return to Control Panel.

To remove the PI Moore Service:Moore -remove

Running PI Moore ICI Interface InteractivelyIf you do not configure the software to run as a service, you can startup the system manually by typing:moore#.bat

at the command prompt. If you are not currently in the same directory where the interface program resides, you need to specify the full path name of the command file. Also, you may want to specify the full path name for the interface program in the command file.

Information and Error MessagesThe interface writes to the pipc.log file. All operational information, warnings, and errors are written here. This file is generally in \pipc\log (the pipc installation directory), although it will alternately be written in the TEMP directory. Refer to the section below if the interface gets an iccsts or an icists I/O Timeout.

The error message:Moore ICI 1>>AddPT>>Invalid params for Reverse Act Tag ABCD

indicates that one of the following requirements was not met for a tag that was configured as reverse acting: the square root field must be 0, the point must be Real, Zero must equal 0., and the Span must equal 100..


TroubleshootingIf the interface suddenly stops collecting data, or can't start collecting data due to the ICI timing out, it is almost always due to a hardware failure or hardware change. This will be indicated by an error message indicating that an ICI timeout has occurred. Conditions that cause the ICI to time out are hardware related. Typically timeouts will occur when the interface is first installed as well as when an ICI has been sent out for repairs and then returned to service.

If the interface was collecting data and it suddenly gets an ICI timeout, if nothing in the communication loop was changed, the most probable cause is the ICI itself. Contact Moore Products for technical assistance. If the ICI times out after it has just been returned to service, verify ALL the current hardware settings with the initial hardware settings you recorded when you first installed the interface. More than likely something was changed while the ICI was out for repair. Don't forget to recheck the settings on the ICI.

The easiest way to check that the communication from the NT-based Interface to the ICI is working is to use the interactive TestICI utility provided on the Interface installation diskette. It allows the user to send out the same calls to the ICI that the interface does but in an interactive mode. See the section below for information on how to run the Moore interactive utility.

05/09/23 4:50 AM 15


Interface Operating InformationThis section provides further information on how the interface works but is not critical for installing the interface on a PI system. Additional information is also presented on the Local Instrument Link and the High Level Link.

Interface Point ListAt startup, the interface scans the PI point database for all points with the source code from Moore.bat and the ICI number associated with the interface. It performs range checking on all point attribute data. During runtime the interface continues to check the PI Point Database for point updates and modifies its point list accordingly.

Output DataTwo separate PI tags are required to be configured for the same address if that address will be written to and read back by the interface. If the tag will just be written to, only one tag is required. The number of outputs is limited to one fourth the number of the system tags. The maximum integer value that can be output is 4095. The highest bit that can be output to is bit 12. If a digital tag is to be output to via a user written program, the value may be sent out as the PI value or the negative of the digital state code.

Only the following controller status/modes can be output for control loops on a MMLC. They are: LOCAL/MAN, LOC/AUTO, CONS/MAN, CONS/AUTO, COMP/MAN, and COMP/AUTO. All devices residing on a LIL must be set to INTERNAL rather than EXTERNAL to be able to receive output commands from the interface. An LIL device will not be able to accept output commands from the interface when it is in LOCAL. This applies for commands sent through the HLL via an LES or through the LIL. When outputting to devices via an LES on the HLL, the devices must be in CONSOLE mode. The LES does not recognize COMPUTER mode.

It is important to note there are some cases where a controller may overwrite a channel that was previously written to by the interface. Consult the Moore manual for the specific controller for the requirements on outputting data to various channels.

Input DataThe interface optimizes data transfer by collecting data on a slot by slot basis for each HLL Satellite and on a station by station basis for each LIL Station. The maximum number of input tags is 5000. If a digital tag is going to be read from PI with a user written program, the value returned will be the negative of the digital state code.

Scanning PrinciplesAll input data is scanned at a fixed scan rate. The scan rate (in seconds) is specified in the Moore.bat file. Multiple interfaces can be used to collect data at varying scan rates. However, each interface requires its own ICI and COM port. All input data is brought over from the ICI as an integer value between 0 and 4095. Since only the integer value for a tag is obtained from either the LIL or the HLL, it is imperative that the high and low limits that are used in the configuration of the instrument are used to calculate the zero and span that are


input into the PI database. For integer point types, the value is equal to the integer value obtained directly from the ICI. For float point types, the zero is equal to the low DCS limit and the span is equal to the DCS high limit minus the DCS low limit. The interface then converts the integer value to the real value from the zero and span of the tag in its engineering units. An integer value of 128 is 0% of scale and an integer value of 3968 is 100% of scale. Analog values less than 128 are considered to be under range and analog values greater than 3968 are considered to be over range. For digital point types, single discrete data will be equal to a value of 128 to indicate the zero (0) state and 3968 to indicate the one (1) state. Multiple discrete data, where one or more bits of the word indicate a particular status, is converted from an integer value to binary form. Multiple discrete data is typically used to indicate alarms and the status of various devices.

If input data fails with an extended communication failure, the digital state I/O TIMEOUT is written to the PI Snapshot for the affected tags. The interface will continue to attempt to communicate with the ICI. Once communication has been reestablished, new values will be written to the PI Snapshot.

Time StampThe Moore interface will write all values to the snapshot using the scan list timestamp received from Uniint as the time stamp.

Local Instrument Link (LIL)Information which is located in the LIL global database comes from the following Station types: Mycro 324's, Mycro 351's, Mycro 352's, Mycro 382's, and the Mycro 383's. When reading data from Stations on the LIL, the interface sends out an LIL global database read command. The data is read on a station by station basis. When outputting data, the interface sends out a parameter send command that is done for a single parameter.

High Level Link (HLL)Information which is located in the HLL global data base comes from Satellites connected directly to the HLL such as a Moore Multi-loop Controller (MMLC), or a Local Expansion Satellite (LES). The LES provides a means for data communication between Stations that reside on the Local Instrument Link (LIL) and the HLL global database. The types of devices that reside on the LIL include the following: Mycro 324's, Mycro 351's, Mycro 352's, Mycro 382's, and the Mycro 383's.

When reading data from Stations on the LIL, the interface sends out an HLL global database read command. Up to 732 channels of LIL global data can be transferred into the HLL global database. Only LIL global data (Parameter 1 data) can be transferred into the HLL global database. The configuration information for the data to be transferred resides within the LES in a table called the High Level Link Data Transfer Table (HLL DTT). The LES can contain 1 to 16 slots with a maximum of 256 channels per slot. To maximize scanning efficiency, a slot in the LES should be configured to contain as much data as possible since scanning is done on a slot by slot bases. The HLL DTT is the table in which the user assigns HLL global data base addresses (Satellite # which is the number for the LES, Slot #, and Channel #) to the LIL global data to be transferred. It is imperative that all data that is to be transferred from the LIL to the HLL global data base must be configured in this table.

The interface retrieves data from a Satellite (this includes LIL global data in the LES) on the HLL on a slot by slot basis. Data configured in a slot of a Satellite on the HLL is contiguous. The interface uses the fact that the data from a slot is contiguous to pair the retrieved channels of data with the appropriate PI point. A table resides within the interface that pairs each PI point with the data from its location in the HLL global database. It is important to note that if a channel or loop is removed from a slot then the slot will automatically

05/09/23 4:50 AM 17


reconfigure itself and make itself contiguous once again. To prevent this from occurring, dummy information can be substituted in for the removed channels in a slot.

The addition of a new point to a slot will not disrupt the relationship between PI points and their location in the HLL global database. When a point is configured in the first empty channel of a slot, the data residing in that slot will be ignored until the point is configured in the PI database. Once the point has been configured into the PI database, Sign up for Updates will automatically add the point to the point list be scanned by the interface.

If points are rearranged and are configured into different channels, the data for those points will be incorrect until the new configurations have been entered into the PI database. Once the new channel assignments for the points have been configured into the PI database, Sign up for Updates will detect these changes and the interface will be notified.

Figure 1. ICI 320 Serial Port Board

LIL Address Selection (Minus 1)Switch Bit Value

2 2 32

2 1 16

1 8 8

1 4 4

1 2 2

1 1 1


Data Format Selection (Switch 2)Bit 8 Bit 4 Start Bits Data Bits Parity Stop Bits

Closed Closed 1 Even 1

Closed Open 1 Odd 1

Figure 2. Data Set/Data Terminal Connections

1 2 3 4 5

Figure 3. ICI 320 MPU Board Dip Switch

Switch5 Position

Transmission Method

Switch4 Position

Link ACK Delay

Switch3 Position

Null-Filled Data

Closed Binary Closed Disabled Closed Disabled

Open ASCII Open Enabled Open Enabled

05/09/23 4:50 AM 19


Switch 1 Position

Switch 2 Position

Security Level

Closed Closed None

Closed Open Record

Open Closed Parameter

Open Open Local


Figure 4. Blowup of ICC Piggyback Board

Figure 5. Setting of Jumpers W8 and W9

05/09/23 4:50 AM 21

Data Set Position Data Terminal Position

DS DT


Figure 6. Front Panel, ICI 2.0 or 2.5

Switch Legend

SW 1 Hardware Reset

SW 2 Communications Setup

BIT 1 Command Response Delay 1 Enabled

BIT 2 Null Data Response 0 Disabled

BIT 3 Baud Rate

BIT 4 Baud Rate

SW 3 LED Test Button

SW 4 Security Access (Future)

SW 5 Data Transmission Mode Select

BAUD Rate Table, SW 2 Switch Settings

BIT 3 BIT 4 BAUD Rate == 0

0 0 38400

1 0 19200

0 1 9600

1 1 1200 == 1


Appendix A: TestICI Utility IntroductionTestICI is a diagnostic routine to test the layers of software between the OSI PI ICI driver and the Moore HLL or LIL hardware. This routine includes:

Device independent functions (Display error text, Vbit, Btest, Ibits)

Low-level device dependent (LIL or HLL) interface functions for each Moore ICI command used by the OSI PI driver.

This documentation describes the operation of TestICI, but the user must reference the following Moore interface manuals for detailed information about the individual ICI commands:

Mycro Models 3932 and 3934 Independent Computer Interfaces (ICI-2.5 and ICI-2.0) Configuration Guide FD3932/4 Issue 1, 12/90

Model 320 Local Instrument Link Independent Computer Interface User’s Manual AD320-10 Issue 5, 2/90

TestICI is a self-contained console routine, thus it does not require any other software besides the Windows or DOS operating system to operate. Verify the hardware is setup as follows:

1. Windows computer running DOS, Win 3.1, Win95, Win98, or WinNT

2. Moore ICI connected to COM1 with appropriate RS232 cable

3. Establish ICI dipswitch settings (baud rate, stop bits, and parity) by referencing the device specific Moore documentation listed above

Open a DOS window, move to the directory where TESTICI.EXE is located, and run TESTICI.EXE.

After starting the routine, one must first assign a channel to the Moore hardware, which will also automatically initialize the device if it is an HLL. Following a channel assignment, any test option can be executed. Device independent functions, such as Vbit, Btest, and Ibits, don’t require the assign channel command.

List of Options

-1 : Help 0 : Exit 1 : Display text for an ICI error number 2 : Assign a channel to the ICI

05/09/23 4:50 AM 23


3 : Vbit 4 : Btest 5 : Ibits 6 : Test LIL functions 7 : Test HLL Functions

Enter an option:

Note: “dec” stands for decimal and “oct” stands for octal.

The device specific function name mnemonics (ex. Initialize) have a corresponding command code (ex. $02) found in the Moore documentation . The $ designates hexadecimal numbering in the Moore documentation. The following table maps the mnemonics to its command code

Table 1 Mnemonic to Command Code Conversion Table

Mnemonic Name

Command Code

Device Description

ASGN Not Applicable

Device Independent

Assign an OS port id

ICISTS $02 LIL Get ICI status

GDSCR $05 LIL Global Data Sequential Channel Request (LIL)

PARRQ $07 LIL Parameter Request

PARSND $09 LIL Parameter Send

INITLZ $02 HLL Initialize HLL

CHNCMD $F0 HLL Channel Command

LPCMD $80 HLL Loop Command

GDBSCR $10 HLL Global Data Sequential Channel Request (HLL)

STASTS $04 HLL Station Status

STAINF $05 HLL Station Information

HLLINF $06 HLL High Level Link Information

ICCSTS $07 HLL ICC Status


TestICI Device Independent FunctionsBtest

Purpose: Test if one bit is set within a data value.

Usage: Parse raw data returned from the ICI to determine individual ICI states.

The test routine displays a set of sample data to demonstrate the functionality, then prompts the user to enter data. The user enters a decimal data value, then a decimal bit position to test (Note: Bit position numbers between 1 and 15). The information is displayed in both decimal and octal.

Test the Btest function

0 = Btest(1, 0)1 = Btest(1, 1)

Bit 1 Data 1 = Result 1Bit 2 Data 2 = Result 1Bit 3 Data 4 = Result 1Bit 4 Data 8 = Result 1Bit 5 Data 16 = Result 1Bit 6 Data 32 = Result 1Bit 7 Data 64 = Result 1Bit 8 Data 128 = Result 1Bit 9 Data 256 = Result 1Bit 10 Data 512 = Result 1Bit 11 Data 1024 = Result 1Bit 12 Data 2048 = Result 1Bit 13 Data 4096 = Result 1Bit 14 Data 8192 = Result 1Bit 15 Data 16384 = Result 1

Enter the dec data (0 to exit): 128Enter the dec bit position (0 to exit): 8

result = 1 oct or 1dec from 200 128 at bit 8

05/09/23 4:50 AM 25


The 8th bit position is a 1 and decimal data 128 is equivalent to an octal value of 200.

IbitsPurpose: Extract a contiguous set of bits from a longword.

The test routine starts by displaying a sample set of tests, then prompts the user to carry out their own tests. Given some integer value, the starting bit number, and the number of bits to extract, the routine displays the bits extracted from the integer value. The user enters values in decimal, but displays the result in octal, the data in octal and decimal, the offset in decimal, and the bit count in decimal. The offset is between 1 and 15.

The sample set shows the function call and the expected answer, then the actual computed answer, thus if the function is operating correctly, the expected answer matches the computed answer.

ibits(15,0,1) = 1 = 1ibits(15,0,2) = 3 = 3ibits(15,0,3) = 7 = 7ibits(15,1,1) = 1 = 1ibits(5,0,3) = 5 = 5ibits(5,1,1) = 0 = 0ibits(5,2,1) = 1 = 1ibits(5,0,2) = 1 = 1

Enter the dec data (-1 to exit): 7Enter the dec offset (-1 to exit): 1Enter the dec bit count (-1 to exit): 2

result is 3 for data 7 oct = 7 dec 1 2

From the data value of 7 with the first 2 bits extracted yields an octal value of 3. It also echoes the decimal offset and bit count after the decimal data value.

To exit the Ibits test, enter a negative value for any of the user prompts.

VbitPurpose: Provides a convenient means for testing the value of flag bits returned by the ICI 320 LIL.

Usage: An array of flag bits is returned for global data base random and sequential channel requests. A bit is returned for each channel requested and provides an indication of whether or not the channel is valid. If the bit is set, then the requested channel is not valid (eg., not on line). The bits are ordered left to right starting with the first word in the array. That is bit 15 of word 1 corresponds to the first channel requested. Use Vbit to decode this raw ICI data.


Given the flag array and the number of a requested channel, VBIT will test the appropriate bit and return the status of the bit. TRUE indicates set (eg. invalid channel) or FALSE indicates reset (eg. a valid channel).

The user must enter 2 hexadecimal data values that describe the validity of 32 channels, then the user can repeatedly request Vbit to describe the validity of a specific channel number by entering a decimal channel number until the user enters -1 as a channel number.

Enter flag word (0 of 2): 1 Enter flag word (1 of 2): 2F

Enter a channel number [0-31]: 3Channel: 3 has result 1Enter a channel number [0-31]: 8Channel: 8 has result 0Enter a channel number [0-31]: -1

In this example, channel 3 is invalid and channel 8 is valid. Entering -1 exits the Ibit test function.

05/09/23 4:50 AM 27


TestICI Device FunctionsDisplay text for an ICI error number

Purpose: Interpret a return status code and display its corresponding error message.

The function will test the error bit within the return status code (15 relative to 1) to determine whether to report an error or not. If it is an error, the routine will extract bits 8 through 13 for the error code and determine if there is a known text description. For example, 16384 decimal or 40000 octal is error code 0 and 16640 decimal is error code 1, because the 15th bit is set and the lower 8 bits are insignificant. Given an error number of 16, the return code must be 16384 + (256*error number) .

There are 3 independent types of status codes based on the type of function being called. These types represent a different layer in the ICI application interface architecture. The user enters a category or asks the routine to interpret the same error code as if it came from each category or layer.

Test the ErrTxt Function

Error Text Categories

1. Exit

2. ICI Device Error (ICI device level)

3. I/O Error (Driver level )

4. ICI Function Error (Application level)

5. Try the error code on all levels

Enter an error category [0-4]: 4

Enter an error code (0 for a new category): 20480

Response message: LILC FAILURE, LINK NOT PRESENT

I/O message: Unknown I/O status

Return message: Unknown return status code

The error code entered has a corresponding ICI Device Layer error description, but the OS and the application layer don’t have an associated error.


Application Layer (OSI PI driver)

I/O Layer

(Operating System Device I/O)

ICI Device Layer

(HLL or LIL)

AsgnPurpose: Open a port id on a COM port to a Moore interface device.

The Moore High Level Link interface device is a ICI 2.5 and the Moore Local Instrument Link is a ICI 320. Both devices provide an RS232 interface to the Moore highways. The HLL is a data highway that connects local instrument links and a local instrument link is a low level data highway between such devices as Moore single loop and multi-loop controllers.

In the case of the HLL, the HLL device is also initialized within the assign function.

This test routine asks the user to configure the communications port with the baud rate, parity, stop bits and identify the type of Moore interface on the other end of the communications cable. These configuration settings are pre-defined by the Moore hardware; see the Moore documentation for details.

Note: The Assign function for the LIL doesn’t communicate with the ICI 320, it simply gets a port id from the Operating System. The Assign function for the HLL does request the HLL to initialize, but the HLL goes offline for about 15 seconds while it initializes, but the ICI never responds with a success or failure of the initialization. If there is a communications error, then an error will be returned in the response code.

Test the ICI_Asgn Function

Enter a device name (ex. COM1): COM2

1) HLL ICI 2.52) LIL ICI 3203) LIL ICI 320 multidrop

NOTE: ICI_Asgn will initialize the HLL, but the LIL doesn't require it.

Enter the ICI type: 1

Valid baud rates: 75, 110, 134, 150, 300, 600, 1200, 1800,2000,2400,3600,4800,7200,9600,19200,38400Enter the baud rate: 9600Enter the bits/byte [7 or 8]: 8

Valid parity codes:0 = even parity1 = odd parity2 = no parity

05/09/23 4:50 AM 29


Enter the parity code[0-2]: 2

Valid stop bit codes:0 = 1 stop bit1 = 2 stop bitsEnter the number of stop bits [0,1]: 1

ICI type entered:

Mode string format: Baud, bits, parity, stop bitsMode string entered = ‘9600, 8, 2, 1’

Successful!

Or when an error occurs:

COM2 Return status=5 Device status=-7

Assign Return: ICI response errorAssign I/O: I/O Initialization error

ICI: ICI 2.5 type = HLL

If the user forgets to execute the Asgn function before other device specific functions, the TestICI routine will ask user if Asgn function should be called prior to running the device specific function. It is possible that the user is intentionally skipping the Asgn function to see how the software will respond.

LIL FunctionsWhen diagnosing an LIL connection, the user might execute the following operations:

1. Assign function to connect to the ICI

2. ICI status function to determine if the computer can communicate with the LIL device and that the LIL is configured as expected.

3. Following a successful ICI status check, execute the global database sequential channel request to verify that the LIL can deliver data within the LIL

4. Parameter request function to verify that the LIL can go out on the network and request data from a station.

5. Completing this set of tests will verify the computer can read information from the LIL.

6. Following the read tests, the parameter send function should be executed to verify the LIL can write parameter information to a station on the Moore network

ICI StatusPurpose: Request the current status of the ICI 320


Note: This function should be called for detailed information following a class 0 error or a timeout.

If the function successfully communicates with the ICI, it will display the contents of the ICC status word. It will decompose the status word and describe each component.

The ICC status word format:

Bits 0-5 Station address

Bits 6-7 Data format (start bits, # of data bits, parity, stop bits)

Bits 8-9 Security command (none, record, parameter, local)

Bit 10 Link acknowledge delay (disabled, enabled)

Bit 11 Null filled data (disabled, enabled)

Bit 12 Transmission method (binary, ascii)

Test the ICISts function

Press return:

Analysis of ICCWRD: is:

LIL station address is

Data format: 1 start, 8 data, no, 1 stop

Send Security: None

Acknowledge delay = Disabled

Null filled data = Disabled

Transmission method = Binary

In this example the ICI communications are operational with 1 start and stop bit, 8 bit data, no parity.

Global Database Sequential Channel Request (LIL) Purpose: Get LIL Global database channel data using a sequential request.

Given a station address, the starting channel number within the station, and the number of contiguous channels to get the data for, this routine will request the ICI to return the data for this sequential channel set and display the channel information. The information includes the channel number, the quality of the data (good or bad) and the data value in decimal and hexadecimal.

A request for data from the Global database will only require requesting the ICI to return data within the ICI’s memory, it does not have to go out on the Moore highway, because

05/09/23 4:50 AM 31


each station emits global data for the ICI to keep fresh. Thus this is NOT a test of the ICI’s ability to request data from a station.

Global data is the first parameter of every channel. Other parameters require an explicit request to the station (see Parameter Request below).

The user enters decimal values for the satellite, starting channel number, and channel count.

Test the LCI_GDSCR function

Enter the satellite # (1-128): 4

Enter the channel # (1-256): 2

Enter the channel count [1-256]: 2

Global Sequential Channel Request Data:

2 (Good)= 1dec 1 hex

3 (Good)= 9 dec A hex

Press space bar and Enter:

In this example, the user requested data for channels 2 and 3 within LIL satellite 4. Both channels have good quality.

Parameter RequestPurpose: Get parameter data from a remote station.

Unlike the global database sequential read function, which gets data from the ICI’s memory, the parameter request function causes the ICI to send a command to the remote station on the Moore network to get the value of a parameter within the station. The global database is updated every 0.5 seconds and contains dynamic information (ex. a process value), but there are parameter values that are not in the global database (ex. PID coefficients), thus this function is used.

This function can be called to get LIL information from an ICI 320 (direct to an LIL) or from an ICI 2.5 (indirect to an LIL through an HLL). If the computer is connected to an HLL via an ICI 2.5, the user must specify which HLL link and HLL gateway address to get to the LIL. If the computer is connected directly to an LIL via an ICI 320, then enter 0 for the link and the gateway address.

Test the ICI_ParRq function

Enter the remote link # (0 = local link): 0Enter gateway or station HLL Address (0-31; 0 = on same LIL): 0


Enter LIL address of station (1-128): 3

Enter the number of parameters: 2

Will all parameters use the same channel [y/n]: y

Enter the station channel # (1-256): 4Enter the station parameter # (1-256): 2Enter the station parameter # (1-256): 5

ICI: successSuccessful Function call!

Parameter Data:Channel 4 Parameter 2 = 7Channel 4 Parameter 5 = 6

In this example, the computer is directly connected to an LIL via an ICI 320. Parameters 2 and 5 were requested from Channel 4 of LIL station 3. The function was successful and displayed 7 in parameter 2 and a value of 6 in parameter 5 of channel 4.

Parameter SendPurpose: Send parameter data to a remote station.

This function will write parameter data out over the Moore network to the requested station (Ex. change PID tuning coefficients.

This function can be called to set parameter values on the LIL from an ICI 320 (direct to an LIL) or from an ICI 2.5 (indirect to an LIL through an HLL). If the computer is connected to an HLL via an ICI 2.5, the user must specify which HLL link and HLL gateway address to get to the LIL. If the computer is connected directly to an LIL via an ICI 320, then enter 0 for the link and the gateway address.

Warning: This function writes to a station (ex. setpoint value) that could cause an unexpected action (ex. start a pump or switch a valve) when process control devices (ex. pumps and valves) are actively connected to a station.

To appropriately package the data for communications to the LIL, a data type and command type must be specified by the user.

Test the ICI_ParSnd function

Enter the remote link # (0 = local link): 0Enter the HLL Address of gateway or station to receive data (0-31; 0 = on same LIL): 0

05/09/23 4:50 AM 33


Enter the LIL address of station to receive parameter data (1-128): 4

Enter the station channel # (1-256): 3Enter the station parameter # (1-256): 2

List of Data Types:

0 - Record send acknowledge 1 - 16-bit integer, absolute change 2 - 16-bit integer, relative change 3 - 16-bit multi-discrete mask on 4 - 16-bit multi-discrete mask off 5 - 16-bit multi-discrete mask pulse 6 - 32-bit floating point, absolute change 7 - 32-bit floating point, relative change 8 - Multibyte data (message) 9 - 32-bit integer, absolute change10 - 12-bit integer plus range bits, absolute change

Enter the data type (0-10): 1

List of command types:

0 thru 3 - Not applicable 4 - Parameter send from local source 5 - Parameter send from a console source 6 - Parameter send from a computer source 7 - Parameter send from any source 8 - Command is in Hi-Level Link formatEnter the command type: 6

Enter the data length in words: 2

Enter data value 1: 4Enter data value 2: 0

In this example, the computer is connected via an ICI 320, so the HLL addresses are zero. The user sets parameter 2 of channel 3 from LIL station 4. A 16 bit unsigned integer as if it came from a local source was sent with a value of 4.

HLL FunctionsInitialize ICI device

Purpose: Request that the ICI 2.5 get reset.


When the HLL is reset (initialized), the HLL goes offline for about 15 seconds, but the ICI never responds with a success or failure of the initialization. If there is a communications error, then an error will be returned in the response code.

Device status: 0 Return status: 0Return: SuccessI/O: Success

In this example there were no errors requesting the HLL to reset.

Channel commandPurpose: Issue HLL type Channel Commands to a specified station.

CHNCMD may be used to send up to seven channel commands to a single station on a Hi-Level link. Note that if the station is an LES, the LES will translate the HLL channel commands into the corresponding LIL commands and will relay the LIL commands to the appropriate stations on the LIL as dictated by the current LES configuration.

The function checks the address values, command count, and command type code A for validity, but the value(s) for command type code B and the new data values are not checked. If the arguments are valid, then it builds the appropriate ICI command and issues it to the ICI. CHNCMD then returns either the reply from the ICI or in the event of a communication failure an error status.

Note that the action of the ICI upon receipt of a channel command is dependent on the setting of the RESPONSE DELAY switch (Refer to the ICI User's Guide). If the RESPONSE DELAY feature is disabled, the ICI will return a response to the host immediately, prior to the actual sending of the command out to the destination station. If the delay feature is enabled the ICI will not return a response to the host until after it has attempted to send the command to the destination station and either received an acknowledgment from the destination station or incurred an error in the attempt to send the command.

The latter behavior is desirable as it provides the host computer with an indication as to whether or not the command was successfully sent. It is recommended that the ICI be used with the RESPONSE DELAY feature enabled.

Note that although the and may have been successfully sent to the destination station, this does not mean that the station acted on the channel command. In order to verify that the command was acted upon, it is necessary to read the channel back through use of HLL global data base reads (GDBSCR or GDBRCR) .

Command A describes the type of process I/O (ex. Analog Output, Multiple Momentary Discrete) the command will affect. Command B is a bit mask for bitwise commands

05/09/23 4:50 AM 35


otherwise it is zero. See the ICI 2.5 documentation for command details. The user enters both command code A and B as decimal.

Table 2 Channel Command Table

Command A

(decimal)

Command A

(hexadecimal)

Description Command B

8 8 Analog Output 0

9 A Single Sustained Discrete Channel 0

10 B Single Sustained Discrete Word 0

11 C Single Sustained Discrete Bit {bit mask }

12 D Single Momentary Discrete Channel 0

13 E Single Momentary Discrete Bit {bit mask }

Because some HLL configurations can have a high error rate (ex. excessive length or by heavy equipment that induces errors on the line, the test routine provides for retry count with a user specified delay between attempts. If a repeat count is specified, then the user is prompted to enter the delay. After completing the number of repeats, the % of bad attempts is displayed.

Test the ICI_ChnCmd function

Enter the link # (1-4) 3Enter the satellite # (1-128) 5Enter the command count [0-5]: 1

Command # 1

Enter the slot # (1-16): 2Enter the channel # (1-256): 8Enter the command type code A # (8-14): 5Enter the command type code B # (0-15): 0Enter a data value (0-4095): 1024

# of times to repeat the set of commands: 2# of milliseconds between attempts(ex. 1000 for 1 sec): 3000

Successful channel command:


Response status for each command:

Item 1 status = 0

0 / 2 = 0 %Press ENTER to continue:

In this example, one channel command is directed towards Link 3, Satellite 5, slot 2, and channel 8.

It is a single momentary discrete command; since it is not bit command, command B is 0. In this example both attempts were successful, thus the percent bad is zero.

Loop commandPurpose: Send loop commands to multi-loop controllers.

This is a specialized command function to modify non-global control loop parameters within a multi-loop controller. This function is used to change control loop setpoints, tuning coefficients, controller setpoint ramping, control loop modes, etc.

Warning: This function writes to a station (ex. setpoint value) that could cause an unexpected action (ex. start/stop a pump or switch a valve position) when process control devices (ex. pumps and valves) are actively connected to a station.

Command codes A and B are entered as hexadecimal.

Table 3 Loop Command Table

Command Description Command A

(Hexadecimal)

Command B

(Hexadecimal)

Ramp On 10 0

Ramp Off 11 0

Enter Manual Mode 12 0

Enter Auto Mode 13 0

Enter External Mode 14 0

Exit External Mode 15 0

Kp Absolute 1B 0

Ki Absolute 1B 1

Kd Absolute 1C 0

05/09/23 4:50 AM 37


Kg Absolute 1C 1

Target SP Absolute 1D 0

Ramp Time Absolute 1D 1

SP High Limit Absolute 1E 0

SP Low Limit Absolute 1E 1

Output Absolute 1F 0

Setpoint Absolute 1F 1

Output Relative 1F 2

Setpoint Relative 1F 3

Console Mode 44 0

Computer Mode 45 0

Test the ICI_LpCmd function

Enter the link # (1-4); 2Enter the station # (0-31); 6Enter the command count [0-5]: 1

Command # 1

Enter the loop # (1-64 dec): Enter the command type code A # (10-46 hex): 1DEnter the command type code B # (0-10 hex): 0Enter a data value (0-4095 dec): 512

1: Loop=2 (Cmd A=10 X = 10 D), (Cmd B 0 X = 0 D), Data 512 D

# of times to repeat the set of commands: 1

Successful, loop command sent.Command 1 status = 0Press ENTER to continue:

In this example an absolute target setpoint at link 2 and station 6 is set to 512 without repeating the command.

Global Database Sequential Channel Request (HLL) Purpose: Get a sequential set of channel data from an HLL


Given the HLL link, satellite, and slot address information, display the current channel process value in decimal and floating point formats.

Test the GDBSCR function

Enter the link # (1-4): 1Enter the satellite # (0-15): 4 Enter the slot # (1-16): 2Enter the block offset or page # (0-16): 0Enter the channel count [0-5]: 1

Successful!1 = 1024 0.23

0 /1 = 0 %Press ENTER to continue:

In this example the channel value is 0.23 with no bad reads. Before converting from the raw digital representation to floating point, the value is 1024 decimal.

Station StatusPurpose: Get the status of each station within a HLL link

STASTS may be used to obtain the current Hi-Level Link station status for the specified link on an ICI. STASTS first checks the argument LINK. If the argument is valid it then builds the appropriate command and issues it to the ICI. STASTS then returns either the reply from the ICI or in the event

of a communication failure an error status.

Test the ICI_StaSts function

Enter a link # (1-4): 3

stasts Return status: 0 ICI response: 0 I/O status 0stasts Return: Successstasts I/O: SuccessICI: Success

Station Status for 2 satellites:

Satellite: 1 = 1Satellite: 2 = 1

Press enter to continue:

05/09/23 4:50 AM 39


Master Status:Master: 1 = 1


In this example the HLL link 3 was queried for the status of 2 stations and a masters. The call was successful and the 2 stations are on-line (see Moore HLL documentation for detailed bit descriptions).

Note: the status data is displayed in octal for easier bit decoding.

Station InformationPurpose: Get status and error information for a specific HLL station.

STAINF may be used to obtain current station status, configuration and error information for a station on a Hi-Level Link.

See the Moore documentation of a detailed description of the status bits

Test the ICI_StaInf function

Enter a link # (1-4): 1Enter a station # (0-31): 2

stainf Return status: 0 ICI response: 0 I/O status: 0stainf Return: Successstainf I/O: SuccessICI: Success

Station Info:

Link A Good: 1Link B Good: 1Framing Error Count (A & B): 0 decCRC Error Count (A & B): 3 decError Log 1/Error Log 2: 0 decError Log 3/Error Log 4: 0 decError Log 5/Error Log 6: 0 decError Log 7/Error Log 8: 0 decTimeout Error Count: 4 decStation State/Type: 2 octStation Status Byte: 0 octStatus word 1 = 0 oct; 2 = 0 oct# of Global database bytes: 215



Slot 1 offset = 10Slot 2 offset = 31Slot 3 offset = 40

:Slot 16 offset = 73

HLL InformationPurpose: Get Hi-Level Link information table for specified link.

See the Moore documentation of a detailed description of the status bits

Test the ICI_HLLInf function

Enter the link # (1-4): 1

Satellite Global Database Size Table

208 = 0 dec 0 hex:

222 = 0 dec 0 hexPress enter to continue:

Station Status Bytes224 = 0 :238 = 0


State Type Bytes280 = 0 :286 = 0Press enter to continue:

Satellite Status Words (2/satellite)

288 = 0 0 :318 = 0 0

05/09/23 4:50 AM 41



ICC StatusPurpose: Get the current ICI Interface Communication Computer status word.

This function is useful as the first command following initialization of the HLL to see the overall status of the ICI 2.5, how it is configured and the active (updating) links connected to the ICI 2.5.

Test the ICCSts function

ICC Status Word:

Bit: 0 = 0 ICI Input buffer 1 fullBit: 1 = 0 ICI Input buffer 2 fullBit: 2 = 0 ICI Input buffer 3 fullBit: 3 = 0 ICI Input buffer 4 fullBit: 4 = 1 Link 1 UpdatingBit: 5 = 1 Link 2 UpdatingBit: 6 = 1 Link 3 UpdatingBit: 7 = 0 Link 4 UpdatingBit: 8 = 1 Link 1 PresentBit: 9 = 1 Link 2 PresentBit:10 = 1 Link 3 PresentBit:11 = 0 Link 4 PresentBit:12 = 1 Switch2-1 Response Delay (1=enabled)Bit:13 = 0 Switch2-2 Null Data (1=enabled)Bit:14 = 1 Switch2-3 Baud Rate comm portBit:15 = 0 Switch2-4 Baud Rate comm port

Press ENTER to continue:

In this example there are 3 links configured in the ICI 2.5, which are all updating and none of the input buffers are full. In addition, the response delay option is enabled but not the Null data option.


Appendix B: Interface Distributions as Self-Extracting Executables

PI Interfaces are now being shipped on CD or floppy diskette, or are available for download via the OSI FTP server. VMS and NT distributions provide a Windows NT/9x self-extracting executable zip file that contains files for the platform on which your interface is intended to run. UNIX distributions files are distributed as .tar.Z or .tar.gz files.

NT Installation1. Unpack the .exe file on the CD or diskette by clicking on it from Windows Explorer, or

from running the executable from the command prompt. You will be prompted for where to unzip the files. Be sure to unzip to a safe directory, so as not to over-write any existing configuration files.

2. Move the distribution files to the correct directory, and follow the setup instructions in the corresponding interface manual.

Documentation UpdatesInterface manuals should now be, or will soon be included in the interface distribution. For interface manual updates, you can view or download the latest documentation from our Support Web:

http://support.osisoft.com

After registering the first time, go to the PI Interfaces link and then view the spreadsheet from the Documentation link

05/09/23 4:50 AM 43

http://support.osisoft.com/


Appendix C: TroubleshootingMissing DLLS

The Moore ICI Interface distribution diskette also contains the dynamic linked libraries MSVCIRT.DLL and MSVCRT.DLL. If these files are not on your system, install them to the windows directory (\winnt\system32). Windows Explorer or a Command Window may be used for the copy, if your system needs any of these files.

Crashing

If the interface is crashing, the debug symbol file (moore.dbg) that is distributed with the interface needs to be installed in the \winnt\symbols\exe directory.


Appendix D: PerformanceThe interface throughput is mostly dependent on the baud rate of the ICI. At 9,600 baud, the interface can scan 140 points/second. This rate is linear, so to scan 100 points/second, you would need to run at least a baud rate of 68,000.

To monitor the Scan Performance of the interface, enable the /perf=x option in the interface startup file. The Scan Performance summary interval can be set to any integer including 1 to 24, indicate the interval in hours between summaries.

05/09/23 4:50 AM 45


Appendix L: PI-Interface Configuration Utility MRICINT Control

Or


The MRICINT control for PI-ICU has five to six sections. A blue text box indicates that an invalid value has been entered, or that a required value has not been entered.

Port & Connection SettingsThe Port & Connection Settings section aids in configuring the serial connection to the HLL or LIL.

Com Port

Select the Com Port from the drop down of common Com Ports, or enter the correct Com Port to be used to communicate to the Moore.

Baud

Select the Baud rate from the drop down of commonly used baud rates, or enter the correct Baud rate to be used to communicate to the Moore.

Data bits

Select the Data bits from the drop down of Data bits, or enter the correct Data bits to be used to communicate to the Moore.

Parity

Select the Parity from the drop down.

05/09/23 4:50 AM 47


Stop bits

Select the Stop bits from the drop down.

Data Handling FlagsThere are four Data Handling Flags available

Communication read retries

If specified, the number in the text box indicates the number of read retries that will be used by the interface if a read fails. The default value is 3. The range is 1 to 10.

Pause between read retries

If specified, the number of milliseconds paused between read retries. The default value is 200 milliseconds (2 seconds). The range is 0 to 1000 milliseconds.

Do not write Overrange ro Underrange for values over span or under zero

Normal operation of the interface causes data that is over the span or under the zero to be replaced by an “Overrange” or “Underrange” event in PI. If this option is checked, only float16 tags will continue to have “Overrange” or “Underrange” replace the scanned value.

ICI TypeThe ICI Type must be either HLL or LIL.

Debug

Debug On

The Debug On is used to turn on debug messaging. The command line equivalent is /db.

Simulation Mode

If Simulation Mode is checked, then no real data will be collected from the Moore. Simulation data will be generated by the interface. It is important not to use this option during normal scanning.

Additional ArgumentsThe Additional Arguments section is provided for any flags that may have been required in the future.

Additional MessagesIf there are any additional messages for the user, an Additional Messages box will be displayed.


Revision HistoryDate Author Comments

5-Nov-97 HAO Document written, taken from VMS based i/f document

15-Apr-98 HAO Removed references to VAX and terminal server

8-Jun-98 HAO Added description/examples on defining Loc2 for Loops

9-Jun-98 HAO Corrected number of Slots on a MLC

17-Jun-98 HAO Added /noou startup parameter

1-Jul-98 HAO Added /mr and /rst startup parameter

8-Jul-98 HAO Added TestICI sections

3-Dec-98 HAO Added Appendix B on .exe distribtions

4-Feb-99 HAO Added or greater onto version at top of doc; added section on troubleshooting; removed section about updating MS dlls

13-May-99 HAO Added info on moore.dbg debug symbols

13-Aug-99 HAO Added info on running multiple copies of the interface, and doc version

06-Sep-99 HAO Added info on throughput and performance summaries. (1.3.0)

11-Nov-99 HAO Modified location1 documentation, remove leading 0.

19-May-00 HAO RAW can now be RAW, Raw, or raw in Extended Descriptor. (1.3.3.0)

25-May-00 HAO Support for integer tags to allow a bit mask to be applied (location1). (1.3.4.0)

12-Oct-00 HAB Provided better example of %RAW feature (1.3.4.0, doc rev A)

27-Jul-01 HAB Added another example of LIL location2 (1.3.4.0, doc rev B)

05/09/23 4:50 AM 49

moore ici - osisoftcdn.osisoft.com/interfaces/1366/pi_mricint_1.3.4.1b.doc · web viewremove the...

Documents