node-opcua

an implementation of a OPC UA stack fully written in javascript and nodejs

Node-opcua is an full OPC-UA stack written in NodeJS.

Why NodeJS ?

Because nodeJs is a great framework to design asynchronous application.

Getting started

installing node-opcua as a node package

$ mkdir mytest
$ cd mytest
$ npm init 
$ npm install node-opcua --unsafe-perms
$ # create your first app.js file !

installing node-opcua samples as a node package

    $ mkdir myserver
    $ cd myserver
    $ npm init
    $ npm install node-opcua-samples --unsafe-perms
    $ ./node_modules/.bin/simple_server

or

    $ ./node_modules/.bin/simple_client  -e "opc.tcp://opcserver.mAutomation.net:4841" -n="ns=1;s=EVR2.system.RTC_SEC"

installing node-opcua from source

running the demo server from source

 $ git clone https://github.com/node-opcua/node-opcua.git
 $ cd node-opcua
 $ npm install
 $ node packages/node-opcua-samples/bin/simple_server

running the demo client from source

 $ git clone https://github.com/node-opcua/node-opcua.git
 $ cd node-opcua
 $ npm install
 $ node packages/node-opcua-samples/bin/simple_client.js -e "opc.tcp://opcserver.mAutomation.net:4841" -n="ns=1;s=EVR2.system.RTC_SEC"

Tutorials

• create a server

• create a client in typescript

API Documentation

• check out the API documentation

Minimum nodejs requirement

• nodejs version 8.16 or above

Contributing

$ git clone git://github.com/node-opcua/node-opcua.git
$ cd node-opcua
$ npm install
$ npm test

Supporting the project

If you like the project, please consider sponsoring the author 🍺 🎉 ,

This will give us full of motivation to carry on and keep working on the roadmap.

Getting commercial support

To get commercial support, please contact sterfive

Supported Features

Service
Discovery Service Set
	FindServers()	✅
	GetEndpoints()	✅
	RegisterServer()	✅
	RegisterServer2()	✅
	FindServersOnNetwork()	✅
Secure Channel Service Set
	OpenSecureChannel()	✅
	CloseSecureChannel()	✅
Session Service Set
	CreateSession()	✅
	CloseSession()	✅
	ActivateSession()	✅
	Cancel()
View Service Set
	Browse()	✅
	BrowseNext()	✅
	TranslateBrowsePathsToNodeIds()	✅
	RegisterNodes()	✅
	UnregisterNodes()	✅
Attribute Service Set
	Read()	✅
	Write()	✅
	HistoryRead()	🌒
	HistoryUpdate()	🌒
MonitoredItems Service Set
	CreateMonitoredItems()	✅
	ModifyMonitoredItems()	✅
	SetMonitoringMode()	✅
	SetTriggering()	🌑
	DeleteMonitoredItems()	✅
Subscription Service Set
	CreateSubscription()	✅
	ModifySubscription()	✅
	DeleteSubscriptions()	✅
	Publish()	✅
	Republish()	✅
	TransferSubscriptions()	✅
Node Management Service Set
	AddNodes()	🌑
	AddReferences()	🌑
	DeleteNodes()	🌑
	DeleteReferences()	🌑
Query Service Set
	QueryFirst()	🌑
	QueryNext()	🌑

Transport Protocol
Transport	Status	Comment
UA-TCP UA-SC UA Binary	✅	OPC.TCP - Binary
SOAP-HTTP WS-SC UA Binary	🌑	HTTP/HTTPS - Binary
SOAP-HTTP WS-SC UA XML	🌑
SOAP-HTTP WS-SC UA XML-UA Binary	🌑
Security Policies
Policy	Status	Comment
None	✅
Basic128Rsa15	✅
Basic256	✅
Basic256Sha256	✅
Authentication	Status	Comment
Anonymous	✅
User Name Password	✅
X509 Certificate	✅	in version 2.0.x (sponsored)
client facets
Base Client Behaviour	✅
AddressSpace Lookup	✅
Attribute Read	✅
DataChange Subscription	✅
DataAccess	✅
Discovery	✅
Event Subscription	✅
Method call	✅
Historical Access	🌓
Advanced Type	✅
Programming	🌑
Auditing	🌓
Redundancy	🌑	Sponsors wanted
server profiles
Core Server	✅
Data Access Server	✅
Embedded Server	✅
Nano Embedded Device Server	✅
Micro Embedded Device Server	✅
Standard DataChange Subscription Server	✅
Standard Event Subscription Server	✅
Standard UA Server	✅
Redundancy Transparent Server	🌑	Sponsors wanted
Redundancy Visible Server	🌑	Sponsors wanted
Node Management Server	🌑	Sponsors wanted
Auditing Server	🌓
Complex Type Server	🌓	Sponsors wanted
Session Diagnostics	✅	(sponsored)
Subscription Diagnostics	✅	(sponsored)
Alarms & Conditions	✅	(sponsored)
Pub & Sub	🌑	Sponsors wanted

Road-map

This are the item we would like to achieve in the next version of the API.

• improved documentation
• Compliance testing and certification (CTT)
• more tutorials

Feedback

• if you're using node-opcua in one of your project, please feel free to leave a comment and a quick description in the wiki

• if you have a particular wish or found a issue, let us known and create an issue