@jsh/opcua

@jsh/opcua

Since v8.0.52

Client

The OPCUA client.

Usage example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
opcua = require("@jsh/opcua");
nodes = [
        "ns=1;s=NoPermVariable",
        "ns=1;s=ReadWriteVariable",
        "ns=1;s=ReadOnlyVariable",
        "ns=1;s=NoAccessVariable",
];

try {
    client = new opcua.Client({ endpoint: "opc.tcp://localhost:4840" });
    vs = client.read({
        nodes: nodes,
        timestampsToReturn: opcua.TimestampsToReturn.Both
    });
    vs.forEach((v, idx) => {
        console.log(nodes[idx], v.status, v.statusCode, v.value, v.type);
    })
} catch (e) {
    console.log("Error:", e.message);
} finally {
    if (client !== undefined) client.close();
}

Creation

ConstructorDescription
new Client(options)Instantiates a opcua client object with an options

Options

OptionTypeDefaultDescription
endpointString""server address
readRetryIntervalNumber100read retry interval in ms.
messageSecurityModeMessageSecurityModeMessageSecurityMode.None

Methods

MethodReturnsDescription
close()disconnect
read(ReadOptions option)ReadResult[]

ReadOptions

OptionTypeDefaultDescription
nodes[]Stringserver address
maxAgeNumber100read retry interval in ms.
timestampsToReturnTimestampToReturnTimestampToReturn.Neither

ReadResult

Properties

PropertyTypeDescription
statusNumber
statusTextString
statusCodeString
valueany
sourceTimestampTime
sourceTimestampTime

MessageSecurityMode

PropertyTypeDescription
None
Sign
SignAndEncrypt

TimestampToReturn

PropertyTypeDescription
Source
Server
Both
Neither
Last updated on