Moore ICI
Interface Documentation
Version 1.6 and greater
How to Contact Us
Phone / (510) 297-5800 (main number)(510) 297-5828 (technical support)
Fax / (510) 357-8136
Internet /
World Wide Web /
Bulletin Board / (510) 895-9423
Telebit WorldBlazer modem (Hayes, MNP, or PEP compatible)
8 data bits, 1 stop bit, no parity, up to 14400 bps download
protocols: Xmodem, Ymodem, Zmodem, Kermit
Mail / OSI Software, Inc.
P.O. Box 727
San Leandro, CA 94577-0427
USA
OSI Software GmbH
Hauptstrae 30
D-63674 Altenstadt 1
Deutschland /
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.
mooreici.doc
1997 OSI Software, Inc. All rights reserved
777 Davis Street, Suite 250, San Leandro, CA 94577
7/16/2002 8:57 AM1
Table of Contents
Introduction......
PI Point Definition......
Point Source......
Point Type......
Location1......
Location2......
Location3......
Location4......
Location5......
UserInt1......
UserInt2......
Square Root Code......
Exception Specs......
Additional Tag Configuration Descriptors......
Point Attributes Not Used by Interface......
Model 320 ICI Hardware Configuration......
Configuring the ICI......
RS-232C Cable Setup......
Terminal Server Setup......
I/O Port Configuration......
Hardware Configuration......
Configuring the ICI......
DR11-W Data......
DR11-W and MV-DR11-W Cabling......
Hardware Configuration......
Configuring the ICI......
RS-232C Cable Setup......
Terminal Server Setup......
I/O Port Configuration......
Software Configuration......
PI Software......
Point Source......
Rate Counter......
Interface Files......
Moore#.Com......
MooreDetach.Com......
MooreLink.Com......
Moore Products Company Supplied Software......
HLL Communication Files......
LIL Communication Files......
VAX SYSGEN Parameters......
Interface Operation......
Startup......
Shutdown......
Information and Error Messages......
ICCSTS or ICISTS Timeouts......
Using the Moore Products Interactive Utility......
Installation......
Interface......
Interface Point List......
Output Data......
Input Data......
Scanning Principles......
Time Stamp......
Local Instrument Link (LIL)......
High Level Link (HLL)......
LIL Address Selection (Minus 1)......
Data Format Selection (Switch 2)......
Switch Legend......
BAUD Rate Table, SW 2 Switch Settings......
List of Figures
Figure 1. ICI 320 Serial Port Board......
Figure 2. Data Set/Data Terminal Connections......
Figure 3. ICI 320 MPU Board Dip Switch......
Figure 4. Blowup of ICC Piggyback Board......
Figure 5. Setting of Jumpers W8 and W9......
Figure 6. Front Panel, ICI 2.0 or 2.5......
February 19981
Introduction
The Moore ICI Interface provides bi-directional transfer of data between the Moore Products Company's Local Instrument Link (LIL) and Hi-Level Link (HLL) global databases, and the Plant Information (PI) System.
Communication between the DEC VAX or ALPHA computer and the HLL global data base is accomplished using either:
- Moore Products Company's Mycro Model 3932 Independent Computer Interface (ICI) or
- Mycro Model 3934 ICI.
The Mycro Model 3932 ICI (commonly referred to as an ICI-2.5) uses an RS-232C serial link to the VAX or ALPHA computer.
The Mycro Model 3934 (commonly referred to as an ICI-2.0) uses a high-speed 16 bit parallel interface that allows direct memory access (DMA) data transfer. Communication to an ICI-2.0 is only supported on VAX computers.
The ICI-2.0 and the ICI-2.5 provide identical functionality.
Communication between the VAX or ALPHA 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 VAX or ALPHA computer. The interface can run on a VAX or ALPHA containing either the PI Home Node or a PINet node.
The Moore ICI Interface consists of:
- A single executable program and
- A number of associated utility programs for configuring, starting, and stopping the interface.
There may be one or more ICI's connected to the PI System. However, there may only be one ICI-2.0 connected per VAX. The PI system can communicate with ICI-2.0's, ICI-2.5's, and Model 320 ICI's concurrently. Every ICI requires its own copy of the interface program.
If either an ICI-2.5 or a Model 320 ICI is to be shared by other processes residing on the VAX or ALPHA, then each process must have the VMS SHARE privilege. Multiple processes that communicate with an ICI-2.0 do not need the VMS SHARE privilege. Outputs require the VMS SYSLCK privilege.
The interface uses Moore Products Company's HLL ICI Communications Software Package to communicate with the ICI-2.0 and the ICI-2.5. Use of an ICI-2.0 also requires a Moore parallel I/O driver. Moore Products Company's LIL ICI Communications Software Package is used to communicate with the Model 320 ICI. The ICI's are respond only devices and are dependent upon the VAX for issuing commands.
OSI Software, Inc. now distributes both the Moore Products Company’s HLL and LIL Communications Software 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.
Sign up for Updates / Yes
Exception Reporting / Yes
PINet / Yes
Outputs / Yes
Vendor Software Required / Yes
PI Point Definition
The 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; 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 Source
All 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. The point source must be defined in the point source library before interface operation (see Software Configuration).
Point Type
The interface supports all three PI point types, real R, integer I, and discrete D. Multiple discrete alarm and status bits are processed to form individual PI digital points.
Location1
The first location is the number of the ICI that either the HLL or LIL is connected to. There can be up to 99 ICI's interfaced to the PI system.
Location2
The second location is the HLL or LIL global data base address. More than one tag can share a single PI address. This applies to both inputs and outputs. The HLL address must be specified if:
- the value of the tag is either an input from, or an output to a HLL device, such as a MMLC or MDAS.
- the value of the tag is an input or an output from a LIL device, such as a Mycro 352, but it has been added into the HLL global database.
The HLL address specifies the High Level Link #, Satellite #, Slot #, and Channel #. The HLL address is in the form of:
LSSTTCCC
where
L = HLL number
SS = Satellite number
TT = Slot number
CCC = Channel number
Therefore, the address of a point that is located on HLL #1, Satellite #9, Slot #16, Channel #138 is:
address = 10916138
An ICI 2.5 can contain a Multi-Loop controller. 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 ICI
1 - 15 Satellite Stations on an HLL
1 - 16 Slots on a Satellite Station
1 - 256 Channels on a Slot
If the value of the tag is an input from or an output to an LIL device, such as a Mycro 352, then its LIL global database address must be specified. The address specifies the Station # and Channel#. The address is in the form of:
SSCCC
where
SS = Station number
CCC = Channel number
Therefore, the address of a point that is located on Station #13, Channel #22, and Parameter #1 is:
address = 13022
Note, there can be:
1 - LIL per ICI
2 - 64 Stations on a LIL
1 - 256 Channels on a Station
1 - 256 Parameters on a Channel
Only parameter 1 will be read from or output to.
Location3
The 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 value
1 - combine two values together
2 - combine two values together, divide total by 100
3 - tag is an output value
Location4
The fourth location is used for digital points only. It is used to specify how the interface will convert an integer value into a digital state. It is used when reading or outputting controller, alarm, or status information. Location4 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 4 > 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 08050706. 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 0708.
In this example, the PI tag is a digital state tag according to the following truth table:
0 / 0 / 0
0 / 1 / 1
1 / 0 / 2
1 / 1 / 3
Specify a 3-bit value as b1b2b3 (e.g. 080706). A 3-bit value has 8 possible states. A 4-bit value would be specified as b1b2b3b4 (e.g. 05060708) and has 16 possible states.
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 4 = -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:
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 0
1 = Logic 1
X = 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.
Location5
The 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 acting
1 = reverse acting
Extended Descriptor
The extended descriptor is used to identify input points whose input values have a range other than the standard 128-3840 counts. If the instrument zero is NOT 0 counts or the instrument span is NOT 4095 counts, the string %RAW must be contained somewhere within the Extended Descriptor. In addition, the instrument zero must be specified in the UserInt1 field and the instrument span must be specified in the UserInt2 field. For example, a non-standard controller might send a 16-bit signed integer to the interface. In this case, the %RAW string, along with the corresponding values in UserInt1 and UserInt2 string, allows an input range of -32768 – 32767 counts from the instrument. Note that the instrument zero and instrument span are unrelated to the tag attributes zero and span, which are in engineering units.
UserInt1
This field must contain the instrument zero of the point if the Extended Descriptor contains the string %RAW.
UserInt2
This field must contain the instrument span of the point if the Extended Descriptor contains the string %RAW.
Square Root Code
The square root code is used by the interface to take the square root of, or squaring 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.
0 / raw value
1 / square root of value
2 / value squared
Exception Specs.
The Moore ICI interface employs exception reporting. The exception deviation, minimum time, and maximum time should be specified to control system loading. It is recommended that both the exception and compression times be set equal to 0 to make sure that all scanned values go through exception reporting, and that all exceptions go through compression reporting.
Additional Tag Configuration Descriptors
There 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 Configuration
Configuring 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 which 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 adaptor 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. RS-232C must be selected to be compatible with the VAX. RS-232C is selected by pins 2 and 3 for jumpers W5 and W6. Refer to Figure 1 which is a schematic of the serial port board.
- Two possible cable pinouts are possible as determined by the connector used on the cable adaptor board which 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. Set the jumpers; the setting must match that in the terminal server. 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 VAX. 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.
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 Setup
The computer is connected to the ICI using the appropriate connector located on terminal strip C. The desired RS-232C signal from the computer which 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. If the connection between the VAX and the ICI is directly to a serial port on the VAX then only the TRANSMIT DATA, RECEIVE DATA, AND SIGNAL GROUND are required. If the connection between the VAX and the ICI is through a terminal server the communication cable must be configured to use CTS or DSR flow control.