opcua

Since v8.0.73

opcua 모듈은 JSH 애플리케이션에서 OPC UA 서버에 읽기/쓰기를 수행하는 클라이언트 API를 제공합니다.

Client

OPC UA 클라이언트 객체입니다.

생성

new Client(options)

반환값: Client
options를 생략하면 예외(missing arguments)가 발생합니다.

옵션

옵션	타입	기본값	설명
endpoint	`string`	`""`	OPC UA 서버 엔드포인트 (`opc.tcp://host:port`)
readRetryInterval	`number`	`100` (100ms 미만이면 100으로 보정)	`read()` 재시도 간격(밀리초)
messageSecurityMode	`number`	`MessageSecurityMode.None`	보안 모드. MessageSecurityMode 참고

사용 예시

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

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

close()

클라이언트 연결을 종료합니다.

사용 형식

close()

반환값: 없음 (undefined)

read()

지정한 노드 목록을 읽습니다.

사용 형식

read(readRequest)

매개변수

readRequest (object): ReadRequest

반환값

object[]: ReadResult 배열

오류 동작:

인자가 없거나 1개가 아니면 예외(missing argument)
nodes가 비어 있으면 예외(missing nodes)

write()

하나 이상의 노드 값을 기록합니다.

사용 형식

write(...writeRequest)

매개변수

writeRequest (object, 가변 인자): WriteRequest

반환값

object: WriteResult

오류 동작:

인자가 없으면 예외(missing argument)

사용 예시

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
const ua = require("opcua");

let client;
try {
    client = new ua.Client({ endpoint: "opc.tcp://localhost:4840" });

    let rsp = client.read({ nodes: ["ns=1;s=rw_bool", "ns=1;s=rw_int32"] });
    console.println("read response:", rsp[0].value, rsp[1].value);

    rsp = client.write(
        { node: "ns=1;s=rw_bool", value: false },
        { node: "ns=1;s=rw_int32", value: 1234 },
    );
    console.println("write response error:", rsp.error, ", results:", rsp.results);

    rsp = client.read({ nodes: ["ns=1;s=rw_bool", "ns=1;s=rw_int32"] });
    console.println("read response:", rsp[0].value, rsp[1].value);
} catch (e) {
    console.println("Error:", e);
} finally {
    if (client !== undefined) client.close();
}

ReadRequest

프로퍼티	타입	기본값	설명
nodes	`string[]`		읽을 OPC UA 노드 ID 목록
maxAge	`number`	`0`	허용 가능한 캐시 연령(밀리초)
timestampsToReturn	`number`	`TimestampsToReturn.Neither`	타임스탬프 반환 정책

ReadResult

프로퍼티	타입	설명
status	`number`	OPC UA 상태 코드(`uint32`)
statusText	`string`	상태 텍스트
statusCode	`string`	상태 코드 이름(예: `StatusGood`)
value	`any`	읽은 값
type	`string`	값 타입 이름(예: `Boolean`, `Int32`, `Double`)
sourceTimestamp	`number`	소스 타임스탬프(Unix epoch milliseconds)
serverTimestamp	`number`	서버 타임스탬프(Unix epoch milliseconds)

WriteRequest

프로퍼티	타입	설명
node	`string`	기록 대상 노드 ID
value	`any`	기록할 값

WriteResult

프로퍼티	타입	설명
error	`Error\|null`	요청 처리 오류
timestamp	`number`	응답 타임스탬프(Unix epoch milliseconds)
requestHandle	`number`	OPC UA 요청 핸들
serviceResult	`number`	OPC UA 서비스 결과 코드
stringTable	`string[]`	OPC UA 문자열 테이블
results	`number[]`	노드별 상태 코드 배열

MessageSecurityMode

MessageSecurityMode.None
MessageSecurityMode.Sign
MessageSecurityMode.SignAndEncrypt
MessageSecurityMode.Invalid

TimestampsToReturn

TimestampsToReturn.Source
TimestampsToReturn.Server
TimestampsToReturn.Both
TimestampsToReturn.Neither
TimestampsToReturn.Invalid

OPCUA 클라이언트

이 예제는 OPC UA 서버에 연결해 시스템 지표를 읽고 데이터베이스에 저장하는 수집기를 구현합니다.

동작 흐름

OPC UA 연동: opcua 모듈을 사용해 opc.tcp://localhost:4840 서버에 연결하고 sys_cpu, sys_mem, load1 등 노드 값을 조회합니다.
주기 수집: setInterval()을 활용해 10초마다 데이터를 읽습니다.
데이터 적재: 수집한 값은 EXAMPLE 테이블에 name, time, value 컬럼으로 저장합니다.

데이터 수집기

스크립트를 opcua-client.js로 저장한 뒤 JSH 터미널에서 백그라운드로 실행하십시오.

jsh / > opcua-client
jsh / > ps
┌──────┬──────┬──────┬──────────────────┬────────┐ 
│  PID │ PPID │ USER │ NAME             │ UPTIME │ 
├──────┼──────┼──────┼──────────────────┼────────┤ 
│ 1044 │ 1    │ sys  │ /opcua-client.js │ 13s    │ 
│ 1045 │ 1025 │ sys  │ ps               │ 0s     │ 
└──────┴──────┴──────┴──────────────────┴────────┘

opcua-client.js

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
opcua = require("opcua");
process = require("process");
machcli = require("machcli");

const nodes = [
    "ns=1;s=sys_cpu",
    "ns=1;s=sys_mem",
    "ns=1;s=load1",
    "ns=1;s=load5",
    "ns=1;s=load15",
];
const tags = [
    "sys_cpu", "sys_mem", "sys_load1", "sys_load5", "sys_load15"
];
const dbConf = { host: '127.0.0.1', port: 5656, user: 'sys', password: 'manager' };
const sqlText = `INSERT INTO EXAMPLE (name,time,value) values(?,?,?)`;
const uaClient = new opcua.Client({ endpoint: "opc.tcp://localhost:4840" });
process.addShutdownHook(()=>{
    uaClient.close();
});
setInterval(()=>{
    const ts = process.now();
    const vs = uaClient.read({
        nodes: nodes,
        timestampsToReturn: opcua.TimestampsToReturn.Both
    });
    var dbClient, conn;
    try {
        dbClient = new machcli.Client(dbConf);
        conn = dbClient.connect();
        vs.forEach((v, idx) => {
            if( v.value !== null ) {
                conn.exec(sqlText, tags[idx], ts, v.value);
            }
        })
    } catch (e) {
        console.println("Error:", e.message);
    } finally {
        conn && conn.close();
        dbClient && dbClient.close();
    }
}, 10*1000);

시뮬레이터 서버

opcua-client.js를 시험하려면 필요한 시스템 지표 노드를 제공하는 OPC UA 서버가 필요합니다. 실환경이 없다면 아래 저장소에서 제공하는 시뮬레이터를 사용해 주십시오. sys_cpu, sys_mem, load1, load5, load15 등의 샘플 데이터를 제공하여 수집기 및 시각화 흐름을 검증하실 수 있습니다.

설정 방법은 저장소의 안내를 따르시면 됩니다.

https://github.com/machbase/neo-server/tree/main/jsh/native/opcua/test_server

시뮬레이터를 실행한 뒤 opcua-client.js를 가동하면 OPC UA 클라이언트가 정상적으로 연결되어 데이터를 수집합니다.

최근 업데이트 Mar 5, 2026

net os