Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OpcuaRemoteOperationOptions

Configuration options for the OpcuaRemoteOperationController to be defined on the opcuaRemoteOperationOptions property.

Defines remote operation calls to be observed and mapped onto OPC UA method calls by the OpcuaRemoteOperationController as defined by the OpcuaOptions.dataSources property of this interface.

Example:

const producerNamespaceUri = "urn:NodeOPCUA-Server-default";
const opcuaRemoteOperationOptions: OpcuaRemoteOperationOptions = {
    endpointUrl: "opc.tcp://139.23.56.3:4334/UA/Producer",
    connectionOptions: { ... },
    dataSources: {
        // Object node providing the AlertTemperature method.
        "PLC2": {
            browsePath: {
                rootNode: "RootFolder",
                relativePath: `/Objects/[${producerNamespaceUri}]:S7-1500 PLC 2`,
            },
        },
        // Method node for AlertTemperature method.
        "PLC2.AlertTemperature": {
            browsePath: {
                rootNode: "RootFolder",
                relativePath: `/Objects/[${producerNamespaceUri}]:S7-1500 PLC 2.[${producerNamespaceUri}]:AlertTemperature`,
            },
        },
    },
    calls: {
         "PLC2": {
             "PLC2.AlertTemperature": {
                 operation: "alertTemperature",
                 inputArguments: [
                     {
                         parameter: "temp",
                         dataType: "Double",
                     },
                     {
                         parameter: "isTooLow",
                         dataType: "Boolean",
                     },
                     {
                         parameter: "isTooHigh",
                         dataType: "Boolean",
                     },
                 ],
             },
         },
    },
};

Hierarchy

Index

Properties

calls

calls: {}

An object hash of Call-Return mappings to be associated with OPC UA object node data sources that provide method node data sources to be called. Object and method node data sources are defined by the OpcuaOptions.dataSources property of this interface.

Type declaration

Optional clientSubscriptionOptions

clientSubscriptionOptions: ClientSubscriptionOptions

Options to set up a common subscription for monitoring items in an OPC UA client (optional). See interface ClientSubscriptionOptions of node-opcua-client package.

If a subscription option is not specified, its default value is defined as follows:

{
   requestedPublishingInterval: 100,
   requestedLifetimeCount: 60,
   requestedMaxKeepAliveCount: 10,
   maxNotificationsPerPublish: 0,
   publishingEnabled: true,
   priority: 1
}
remarks

As all monitored OPC UA data item sources share the same client subscription, subscription options are applied to all of them. If you need different options for different monitored items, define them in separate OpcuaConnector instances.

Optional connectionOptions

connectionOptions: OPCUAClientOptions

Options to set up an OPC UA client (optional). See interface OPCUAClientOptions of node-opcua-client package.

Optional connectionUserIdentity

connectionUserIdentity: UserIdentityInfo

The user identity for a connection session (optional). If not specified, defaults to an unauthenticated anonymous user, i.e. UserTokenType.Anonymous.

See type UserIdentityInfo of node-opcua-client package.

dataSources

dataSources: {}

An object hash that defines a set of OPC UA data sources to be monitored. The key of each data source is used as a unique identifier for mapping the data source onto a Coaty-specific publishing item.

Type declaration

endpointUrl

endpointUrl: string

The specific endpoint URL of the OPC UA server, e.g. "opc.tcp://localhost:4334/UA/TestServer".

Generated using TypeDoc