OPC Client Interface Reference: Enterprise Buildings Integrator
OPC Client Interface Reference: Enterprise Buildings Integrator
Apr 2013
Release 500
Document Release Issue Date
500 18 Apr 2013
Disclaimer
This document contains Honeywell proprietary information. Information contained
herein is to be used solely for the purpose submitted, and no part of this document or its
contents shall be reproduced, published, or disclosed to a third party without the express
permission of Honeywell International Sàrl.
While this information is presented in good faith and believed to be accurate, Honeywell
disclaims the implied warranties of merchantability and fitness for a purpose and makes
no express warranties except as may be stated in its written agreement with and for its
customer.
In no event is Honeywell liable to anyone for any direct, special, or consequential
damages. The information and specifications in this document are subject to change
without notice.
Copyright 2016 - Honeywell International Sàrl
2 [Link]
Contents
3
CONTENTS
4 [Link]
Getting started with OPC controllers
This reference describes how to set up, configure, and test the OPC Client Interface.
Related topics
“OPC configuration checklist” on page 6
“OPC Client support” on page 7
“OPC server documentation” on page 8
“OPC-specific terms” on page 9
5
GETTING STARTED WITH OPC CONTROLLERS
Steps: Go to:
Install and set up the OPC server as specified in the
documentation supplied by the OPC server manufacturer.
Install any OPC server configuration files on the OPC client
computer as specified in the documentation supplied by the
OPC server manufacturer.
Test communications between the OPC client computer and the “Testing OPC communications
OPC server computer. with the server” on page 32
Define channels with Quick Builder. “Defining an OPC Client
channel” on page 18
Define controllers with Quick Builder. “Defining an OPC Client
controller” on page 21
Download channel and controller definitions to the server.
Define points to address OPC server items with Quick Builder. “Defining an OPC Client
address for a point parameter
value” on page 24
6 [Link]
GETTING STARTED WITH OPC CONTROLLERS
7
GETTING STARTED WITH OPC CONTROLLERS
8 [Link]
GETTING STARTED WITH OPC CONTROLLERS
OPC-specific terms
This section contains OPC-specific terms.
Term Description
CLSID CLSID is the class identifier that identifies an object. An object
registers its CLSID in the system registration database so the object can
be loaded and programmed by other applications.
group A number of items with the same update rate and deadband.
item A single data source of the OPC server.
OPC OPC stands for OLE for Process Control. It is a set of standards that
define sets of COM interfaces (based on Microsoft's COM/OLE
technology) to be observed by OPC clients and servers. This set of
standards was established by the OPC Foundation to foster greater
interoperability between automation and control applications, field
systems and devices, and business and office applications. When the
term OPC is used in this Reference, it refers specifically to the OPC
Data Access Standard.
ProgID A programmatic identifier. A registry entry that can be associated with a
class identifier (CLSID). The format of a ProgID is
<Vendor>.<Component>.<Version>, separated by periods and with no
spaces. The ProgID identifies a class, but with less precision. The
ProgID is used to identify the OPC server from other COM/DCOM
components on the same computer. For more details, see any setup and
installation instructions provided by the OPC server manufacturer.
update rate The internal update rate of the items in the OPC server.
9
GETTING STARTED WITH OPC CONTROLLERS
10 [Link]
OPC Client Interface setup
Related topics
“Description of OPC” on page 12
“Interfaces and methods used” on page 14
“Architectures” on page 15
“OPC Client controllers, channels, and points” on page 16
11
OPC CLIENT INTERFACE SETUP
Description of OPC
OPC provides data from a data source and communicates the data to any client
application in a standard way, thereby eliminating the requirement for an application to
have specific knowledge about a particular data source, such as internal structure and
communications protocols.
An OPC server and an OPC client can reside either on the same computer (local server)
or on different computers (remote server).
Tip
There is no concept of hardware in the OPC Data Access Standard; there are just items.
An OPC server may represent a piece of hardware as an item and the item's value may
indicate the state of the hardware. However, whether or not such representation is
available is server-specific.
Although the OPC client can specify any update rate for a group, the OPC server decides
whether the request is honored.
Although the OPC client can specify the deadband for a group, the OPC server decides
whether the deadband request is honored.
Callback
Generally, the OPC server sends data to OPC clients through callbacks. After a group
has been created, the OPC server creates a cache for the group items. The cache is
updated according to the group's update rate. The OPC server sends only updated values
to the OPC client for items in the group if there has been significant change since the last
cache update (based on the group's deadband).
This method of data update significantly reduces traffic between the OPC client and the
OPC server as there is no need for periodic read requests to the OPC server. An OPC
client gets data when there is a significant change. The level of change required to
trigger an update from the OPC server is defined by the OPC client.
12 [Link]
OPC CLIENT INTERFACE SETUP
13
OPC CLIENT INTERFACE SETUP
Interface Methods
IOPCCommon SetClientName
IOPCServer AddGroup
GetStatus
RemoveGroup
IOPCItemMgt AddItems
RemoveItems
ValidateItems
IOPCSyncIO Read
Write
IOPCAsyncIO Read
Refresh
IOPCAsyncIO2 Read (OPC DA 2 only)
Refresh2 (OPC DA 2 only)
14 [Link]
OPC CLIENT INTERFACE SETUP
Architectures
For the OPC Client Interface to communicate with an OPC server, the OPC server must
be installed on an appropriate computer. (The OPC Client Interface and the OPC server
can reside on the same computer or on different computers.)
To install an OPC server, install and set up the OPC server as specified in the
documentation supplied by the OPC server manufacturer.
15
OPC CLIENT INTERFACE SETUP
Related topics
“Defining an OPC Client controller” on page 21
16 [Link]
OPC Client controller configuration and
addressing
This chapter describes how to configure OPC Client controllers using Quick Builder.
Tip
An OPC Client controller is an abstract entity that is used as a container for OPC groups.
An OPC Client controller does not represent a real controller or a real piece of hardware.
Related topics
“Defining an OPC Client channel” on page 18
“Defining an OPC Client controller” on page 21
“Defining an OPC Client address for a point parameter value” on page 24
“Importing OPC items using the import wizard” on page 27
“Optimizing scanning performance” on page 29
17
OPC CLIENT CONTROLLER CONFIGURATION AND ADDRESSING
Tip
If you specify an alternate host name, Quick Builder builds a redundant OPC channel.
Refer to the Configuration Guide for your server for information about monitoring
redundant channels.
Property Description
Name The unique name of the channel. A maximum of 10 alphanumeric
characters (no spaces or double quotes).
Description (Optional) A description of the channel. A maximum of 30
alphanumeric characters, including spaces.
Marginal Alarm Limit The communications alarm marginal limit at which the channel is
declared to be marginal. When this limit is reached, a high priority
alarm is generated. A channel barometer monitors the total number of
requests and the number of times the controller did not respond or
response was incorrect. The barometer increments by 2 or more,
depending on the error and decrements for each good call.
Set the channel marginal alarm limit to 10.
Fail Alarm Limit The communications alarm fail limit at which the channel is declared to
have failed. Set this to 20, that is, double the value specified for the
channel Marginal Alarm Limit.
Connect Timeout Amount of time, in seconds, the server waits to connect to the OPC
server before abandoning the connection. The default is 20 seconds.
18 [Link]
OPC CLIENT CONTROLLER CONFIGURATION AND ADDRESSING
Property Description
Read Timeout Amount of time, in seconds, the server waits for a reply from the OPC
server after a synchronous read request. The default is 2 seconds.
Note: When connecting to legacy third party control networks, it is
recommended that the Read Timeout be set to 5 seconds.
Host Name (preferred) The name of the computer on which the preferred OPC server software
resides.
Note: The OPC Server should not be installed on the Honeywell server.
It should be installed on another machine. The exception to this is the
MatrikonOPC Server for Allen-Bradley PLCs, which may be installed
locally. In this case the name must be LocalHost. This is to support
server redundancy, so that if the Honeywell servers fails over, it always
connects back to the MatrikonOPC server on the local machine.
Note: DCOM configuration is required when connecting to an OPC
server located on another computer. This is required for the MNGR
account to connect properly. For information about configuring DCOM,
see the Configuration and Administration Guide.
Note: When you use Quick Builder to configure non-scanned
parameters that connect to a remote OPC server, your Windows user
account must also reside on the remote OPC server. In addition, the
account must be a member of the Product Administrators group on the
remote OPC server. If your Windows user account does not exist or
does not have sufficient privileges on the remote OPC server, you will
not be able to select parameters from the list of parameters stored on the
server.
Username and passwords must match on both machines.
Host Name (alternate) (Optional) The name of the computer on which the alternate OPC server
software resides. If it is on the same computer as the OPC Client
Interface, the name must be LocalHost.
Note: If you specify an alternate host name, Quick Builder builds a
redundant channel OPC connection. See the Configuration Guide for
the server for information on monitoring the status of redundant
channels.
Diagnostic Scan The amount of time, in seconds, between diagnostic scans. The
period diagnostic rate must be set to one of the valid server scan periods. The
default is 60 seconds.
This value is used as the rate for sending synchronous requests for
checking the OPC server's current status.
19
OPC CLIENT CONTROLLER CONFIGURATION AND ADDRESSING
Property Description
Background Scan The background scanning period (in seconds). This must be set to one
Period of the valid server scan periods (defaults to 60).
This value is used as the rate for sending explicit read requests of all
items configured under a controller if that controller is also configured
with background scanning enabled.
Note: When connecting to legacy third party control networks, it is
recommended that the background scan period be set to 10 minutes.
ProgID The ProgID for the OPC server that is to be connected.
OPC server host time Select this check box when connecting to Matrikon OPC Servers.
can drift
You should also select it if the OPC server computer's clock (UTC time)
is known to drift. This can occur if the clock is synchronized to an
external clock. Moving in or out of daylight savings time is not a time
drift as the UTC time does not change.
Item Type Shows the channel's type.
Last Modified Shows the date of the most recent modification to this channel's
property details.
Last Downloaded This shows the date that the item was last downloaded to the server.
Item Number This field displays the unique item number currently assigned to this
item by Quick Builder. You can change the item number displayed in
this field if you need to match your current server database
configuration. The item number must be between 1 and the maximum
number of channels allowed for your system.
20 [Link]
OPC CLIENT CONTROLLER CONFIGURATION AND ADDRESSING
Related topics
“OPC Client controllers, channels, and points” on page 16
“OPC Client controller Main properties” on page 21
Property Description
Name The unique name of the controller. A maximum of 10 alphanumeric
characters (no spaces or double quotes).
Description (Optional) A description of the controller. A maximum of 30
alphanumeric characters, including spaces.
Channel Name The name of the channel on which the controller communicates. You
need to have defined the channel in order for it's name to appear in the
list.
Marginal Alarm Limit The communications alarm marginal limit at which the controller is
declared to be marginal. When this value is reached, a high priority
alarm is generated. This limit applies to the controller barometer which
monitors the total number of requests to the controller and the number
of times the controller did not respond or response was incorrect. The
barometer increments by 2 or more, depending on the error and
decrements for each good call.
Set the channel marginal alarm limit to 10.
21
OPC CLIENT CONTROLLER CONFIGURATION AND ADDRESSING
Property Description
Fail Alarm Limit The communications alarm fail limit at which the controller is declared
to have failed. When this barometer value is reached, an urgent alarm is
generated.
Set this to 20, that is, double the value specified for the controller
Marginal Alarm Limit.
Background Scan Specify whether background scanning is performed in addition to
normal callback operation. Select Enabled if you do not want the
default (Disabled). The background scan period is configured under the
channel.
Deadband The OPC deadband, which applies to all items referenced by point
parameters belonging to this controller. Note that although the OPC
client can specify the deadband for a group, the OPC server decides
whether the deadband request is honored.
The deadband Indices are defined as:
0 = 0.000%
1 = 0.001%
2 = 0.002%
3 = 0.005%
4 = 0.010%
5 = 0.020%
6 = 0.050%
7 = 0.100%
8 = 0.200%
9 = 0.500%
10 = 1.000%
11 = 2.000%
12 = 5.000%
13 = 10.000%
14 = 20.000%
15 = 50.000%
Item Type Shows the controller's type.
Last Modified Shows the date of the most recent modification to this controller's
property details.
Last Downloaded The date that the item was last downloaded to the server.
22 [Link]
OPC CLIENT CONTROLLER CONFIGURATION AND ADDRESSING
Property Description
Item Number The unique item number currently assigned to this item by Quick
Builder. You can change the item number displayed in this field if you
need to match your current server database configuration. The number
must be between 1 and the maximum number of controllers allowed for
your system.
Related topics
“Defining an OPC Client controller” on page 21
23
OPC CLIENT CONTROLLER CONFIGURATION AND ADDRESSING
Part Description
ControllerName The name of the OPC Client controller.
Address The address in the controller where the value is recorded.
If you would like help when defining an address, click next to Address to display
Address Builder.
Attention
EBI OPC clients do not support Access Path when defining an address of an OPC item. The
OPC standard states that access path is optional for a client to support. If the client does not
specify the access path then the server should choose the access path to use.
Property Description
Address Type Select Controller.
Controller Select the appropriate OPC Client controller. You need to have defined
the controller for the name to appear in this list.
Address The address in the controller where the value is recorded.
24 [Link]
OPC CLIENT CONTROLLER CONFIGURATION AND ADDRESSING
Address syntax
The format for the address is:
[RockwellPath]OPCItemName [DataFormat]
Part Description
[RockwellPath] The Rockwell path is not normally required. However, it is required for
OPC servers developed using the Rockwell OPC Toolkit. You need to
see the vendor's documentation to determine whether a Rockwell path is
required.
The Rockwell path generally represents a device driver or topic (if the
server was previously developed as a DDE server).
Note, if you do specify a Rockwell path:
• You must include the square brackets. (In this particular case, they
do not simply indicate an optional part of the syntax.)
• There is no space between the Rockwell path and the OPCItemName.
OPCItemName The address in the controller where the value is recorded. You need to
see the vendor's documentation for the syntax.
For example, if you are using the system OPC server to access the PV
of a point named sinewave, the address would be [Link].
A maximum of 64 characters. Any printable ASCII character that you
can type, including the space character, is supported.
DataFormat The data format. If you do not specify a data format, the default is
IEEEFP.
Format Counts
IEEEFP IEEE single-precision floating point
U3BCD 0–999 BCD
U4BCD 0–9999 BCD
U4095 0–4095
U999 0–999
U9999 0–9999
U100 0–100
25
OPC CLIENT CONTROLLER CONFIGURATION AND ADDRESSING
Format Counts
U1023 0–1023
U8B 0–255
S16B -32768–32767
S8B -128–127
S9999 -9999–9999
U16B 0–65535
U15B 0–32767
U14B 0–16383
26 [Link]
OPC CLIENT CONTROLLER CONFIGURATION AND ADDRESSING
Prerequisites
• You have configured an OPC channel with the Prog ID of the OPC server that you
are importing from and an OPC controller.
• You have configured a sample point that contains the required parameters for each
type of point you require.
27
OPC CLIENT CONTROLLER CONFIGURATION AND ADDRESSING
18 In Quick Builder, click the Point item in the System Components tree and check the
properties for the OPC points that have been imported.
28 [Link]
OPC CLIENT CONTROLLER CONFIGURATION AND ADDRESSING
29
OPC CLIENT CONTROLLER CONFIGURATION AND ADDRESSING
30 [Link]
Server and Station tasks for OPC Client
This chapter describes tasks for the OPC Client controller that you perform either on the
server or from any Station.
For: Go to:
Testing communications with the server “Testing OPC communications with the server”
on page 32
Troubleshooting scanning errors “Troubleshooting OPC Client communication
errors” on page 32
Related topics
“Testing OPC communications with the server” on page 32
31
SERVER AND STATION TASKS FOR OPC CLIENT
Prerequisites
Before testing:
• Complete any OPC server setup and configuration as required. See the setup and
installation instructions supplied by the OPC server manufacturer.
• Install any OPC server configuration files on the OPC client computer as required.
See the setup and installation instructions supplied by the OPC server manufacturer.
• Ensure you are logged on using the mngr account as this is the account that the OPC
Client Interface uses to communicate with the OPC server.
32 [Link]
Index
33
INDEX
T U
testing communications utilities
OPC controllers 32 opctst 32
34 [Link]