Industrial IoT / SCADA · SDK / protocol

NodeOPCUA

NodeOPCUA Project

Integrate OPC UA with Node.js and TypeScript.

Official documentation Download development spec

Use documented public APIs and pin the package release. Current docs describe an ESM transition at 2.184.0; internal secure-channel symbols may change outside the public API guarantee.

NODEOPCUA / DEVELOPER FIELD GUIDE

Choose an interface. Define a verifiable result.

Company or project context, ten technical entry points and a practical analysis of every reference.

2026-10-08 · Integration not tested

Company / project overview

Original summary of official company or project statements; use the source for the full original page.

NodeOPCUA · About
Project	NodeOPCUA is a modular TypeScript OPC UA stack for creating industrial clients, servers and information models. Sterfive provides professional support alongside the community project.
Developer fit	Suitable for Node.js teams that need typed industrial data exchange and application-controlled OPC UA sessions. The current repository requires Node.js 22.13 or later.

Complete official About page ↗

About reference — TA analysis
Audience	Buyers, partners and product owners shortlisting an AI provider.
Our assessment	Use positioning and company history for initial fit. Obtain project-specific deployment, support and commercial terms separately.

Official sources reviewed; no live API, inference or benchmark was run. Expected results are proposed internal contracts.

Top 10 technical entry points

Ten documented technical entry points selected by developer task; not ten separate SDKs or an official ranking.

Choose by the work you need to complete
Interface	Purpose and audience
01 · OPCUAClientAPI / SDK / developer guide	Create clients, connect and manage sessions.TypeScript client developers
02 · OPCUAServerAPI / SDK / developer guide	Host OPC UA services and custom models.Industrial gateway authors
03 · AddressSpaceAPI / SDK / developer guide	Manage server namespaces and information models.Information-model engineers
04 · ClientSessionAPI / SDK / developer guide	Read, write, browse and call methods.Data acquisition developers
05 · NodeIdAPI / SDK / developer guide	Represent node identifiers.Adapter and schema developers
06 · VariantAPI / SDK / developer guide	Carry scalar or array OPC UA values.Typed telemetry implementers
07 · DataValueAPI / SDK / developer guide	Preserve value, status and timestamps together.Quality-aware telemetry consumers
08 · Role-based security guideAPI / SDK / developer guide	Map users and roles to permitted operations.Server authorization designers
09 · Reverse Connect guideAPI / SDK / developer guide	Implement OPC UA reverse connection setup.Network-constrained integration teams
10 · ESM migration guideAPI / SDK / developer guide	Adapt TypeScript/module configuration for the ESM transition.Teams upgrading dependencies

Reference analysis

Capabilities summarize official documentation. Constraints and proposed tests are our engineering assessment.

API / SDK / developer guide

OPCUAClient

OPCUAClient · TA
Target audience	TypeScript client developers
Documented capability	Create clients, connect and manage sessions.
Input → output	Endpoint/security options → client and session lifecycle.
Execution environment	Node.js TypeScript/JavaScript.
Our decision constraint	Configure security through public client options.
Our suggested validation	Verify disconnect cleanup and reconnect state.

Official reference · OPCUAClient ↗

API / SDK / developer guide

OPCUAServer

OPCUAServer · TA
Target audience	Industrial gateway authors
Documented capability	Host OPC UA services and custom models.
Input → output	Server options and model → endpoint lifecycle.
Execution environment	Node.js server.
Our decision constraint	Initialization and startup are separate lifecycle steps.
Our suggested validation	Check initialized model, endpoint and shutdown resources.

Official reference · OPCUAServer ↗

API / SDK / developer guide

AddressSpace

AddressSpace · TA
Target audience	Information-model engineers
Documented capability	Manage server namespaces and information models.
Input → output	Nodeset/model definitions → address-space objects.
Execution environment	Server-side model API.
Our decision constraint	Namespace identity is part of node interpretation.
Our suggested validation	Verify browse paths, types and model version.

Official reference · AddressSpace ↗

API / SDK / developer guide

ClientSession

ClientSession · TA
Target audience	Data acquisition developers
Documented capability	Read, write, browse and call methods.
Input → output	Service requests → typed results/status codes.
Execution environment	Active OPC UA session.
Our decision constraint	Session success does not make every operation successful.
Our suggested validation	Inspect per-operation status and pagination/continuation needs.

Official reference · ClientSession ↗

API / SDK / developer guide

NodeId

NodeId · TA
Target audience	Adapter and schema developers
Documented capability	Represent node identifiers.
Input → output	Identifier type, namespace and value → NodeId.
Execution environment	Shared TypeScript data object.
Our decision constraint	A display name is not a unique node identifier.
Our suggested validation	Round-trip the full identifier and namespace.

Official reference · NodeId ↗

API / SDK / developer guide

Variant

Variant · TA
Target audience	Typed telemetry implementers
Documented capability	Carry scalar or array OPC UA values.
Input → output	Data type, value and array metadata → Variant.
Execution environment	TypeScript protocol value object.
Our decision constraint	JavaScript numbers alone do not specify OPC UA numeric type.
Our suggested validation	Check ranges, array shape and explicit data type.

Official reference · Variant ↗

API / SDK / developer guide

DataValue

DataValue · TA
Target audience	Quality-aware telemetry consumers
Documented capability	Preserve value, status and timestamps together.
Input → output	Variant plus quality/time fields → DataValue.
Execution environment	Client/server data exchange.
Our decision constraint	Missing timestamps do not prove fresh data.
Our suggested validation	Keep bad/uncertain status distinct from valid zero values.

Official reference · DataValue ↗

API / SDK / developer guide

Role-based security guide

Role-based security guide · TA
Target audience	Server authorization designers
Documented capability	Map users and roles to permitted operations.
Input → output	User/role policy → access decisions.
Execution environment	NodeOPCUA server configuration.
Our decision constraint	Authentication and node authorization need separate validation.
Our suggested validation	Exercise allowed reads and denied writes for each role.

Official reference · Role-based security guide ↗

API / SDK / developer guide

Reverse Connect guide

Reverse Connect guide · TA
Target audience	Network-constrained integration teams
Documented capability	Implement OPC UA reverse connection setup.
Input → output	Server/client reverse-connect configuration → transport establishment.
Execution environment	Participating NodeOPCUA endpoints.
Our decision constraint	Reverse transport does not remove certificate or session checks.
Our suggested validation	Validate reconnect behavior and peer identity.

Official reference · Reverse Connect guide ↗

API / SDK / developer guide

ESM migration guide

ESM migration guide · TA
Target audience	Teams upgrading dependencies
Documented capability	Adapt TypeScript/module configuration for the ESM transition.
Input → output	Existing build configuration → compatible imports/build.
Execution environment	Node.js and TypeScript toolchain.
Our decision constraint	Guide identifies the 2.184.0 package transition; pin installed versions.
Our suggested validation	Build the actual application and inspect module-resolution errors.

Official reference · ESM migration guide ↗

Generated public API

Generated public API · Supporting reference analysis
TA	Maintainers upgrading NodeOPCUA
Our validation advice	Use documented public API; internal re-exported symbols are not semver-protected public contracts.

Official reference · Generated public API ↗

04 / INPUT · EXPECTED OUTPUT · ACCEPTANCE

Expected results before implementation

Illustrative NodeOPCUA adapter contract; no connection, server deployment or equipment operation was executed.

Illustrative contract · no API call or model execution · not measured provider output

Good typed read

Expected behavior — illustrative, not executed
Input	Read a sample temperature Value attribute.
Expected result	Internal Double value=23.0 with status_code=Good and timestamps when supplied.
Acceptance	Keep DataValue quality separate from numeric content.

Empty browse page

Expected behavior — illustrative, not executed
Input	Successful browse returns no references and no continuation point.
Expected result	Internal status=empty and references=[].
Acceptance	Do not infer a complete empty result while continuation remains.

Authorization failure

Expected behavior — illustrative, not executed
Input	A read-only user requests a protected write.
Expected result	Internal error preserves server operation status; applied=false.
Acceptance	Do not claim the variable or machine state changed.

Session lost

Expected behavior — illustrative, not executed
Input	Connection ends during collection.
Expected result	Internal status=disconnected; last reading marked stale.
Acceptance	Resume only after session recovery is confirmed; expose observation gaps.

Map the expected result to your application

Map the actual SDK or service response into this proposed internal contract after integration. All IDs and values below are invented examples; no credentials or live requests are included.

Expected output JSON — illustrative, not measured · NodeOPCUA-expected-results.json

{
  "schema_version": "1.0.0",
  "example": true,
  "provider": "NodeOPCUA",
  "status": "ok",
  "input_id": "sample-001",
  "data": {
    "node_id": "ns=2;s=Example.Temperature",
    "data_type": "Double",
    "value": 23.0,
    "status_code": "Good",
    "source_timestamp": null,
    "server_timestamp": null
  },
  "error": null,
  "verification": "illustrative-only;not-provider-response"
}

Download specification, example and acceptance plan

Engineering handoff — our proposed contract and gates
Result interpretation	Successful transport or execution does not establish model accuracy. Preserve valid empty results separately from operational failure.
Reproducibility	Record model, runtime, configuration and input identifiers; agree quality and latency criteria before representative tests. No measured performance is claimed.
Operation boundary	Illustrative NodeOPCUA adapter contract; no connection, server deployment or equipment operation was executed.

Development assessment

Node.js factory gateway

Development concept · integration not tested

Provider capabilities above are based on official documentation or repositories. The proposed product, inputs, deliverable and acceptance criteria below are our development assessment.

Integration pilot

Validate runtime, schemas or hardware together before estimating a deployable product.

Proposed inputs: A test device or simulator, a tag map and documented units.
Proposed deliverable: Timestamped device values with freshness, unit and connection state.
Acceptance criterion: Verify scaling and timestamps against the source; a disconnected device must not appear healthy.
Dependencies: A gateway or service account, an equipment schema and access to a test environment.

Integration condition

Use documented public APIs and pin the package release. Current docs describe an ESM transition at 2.184.0; internal secure-channel symbols may change outside the public API guarantee.

Development sequence

Confirm access to NodeOPCUA, license and the exact supported version.
Prepare the sample above and implement one documented operation for “Node.js factory gateway”.
Normalize the result with source, time and explicit error state; keep the provider response for review.
Run the acceptance criterion before estimating rollout effort or committing a customer deliverable.

How to validate demand

Record product views, documentation clicks, specification downloads and contextual hub clicks. These are event counts, not unique people or completed integrations.

This feasibility assessment uses implementation conditions. No traffic-based rank or delivery-time promise is assigned.

NodeOPCUA

Choose an interface. Define a verifiable result.

Company / project overview

Top 10 technical entry points

Reference analysis

Generated public API

Expected results before implementation

Good typed read

Empty browse page

Authorization failure

Session lost

Map the expected result to your application

Node.js factory gateway

Integration condition

Development sequence

How to validate demand

Related products