@tier0/node-red-contrib-opcda-client 1.0.0

package/opcda/opcda-read.js

@@ -0,0 +1,350 @@
+module.exports = function(RED) {
+	const opcda = require('node-opc-da');
+	const { OPCServer } = opcda;
+    const { ComServer, Session, Clsid } = opcda.dcom;
+	
+	const errorCode = {
+		0x80040154 : "Clsid is not found.",
+		0x00000005 : "Access denied. Username and/or password might be wrong.",
+		0xC0040006 : "The Items AccessRights do not allow the operation.",
+		0xC0040004 : "The server cannot convert the data between the specified format/ requested data type and the canonical data type.",
+		0xC004000C : "Duplicate name not allowed.",
+		0xC0040010 : "The server's configuration file is an invalid format.",
+		0xC0040009 : "The filter string was not valid",
+		0xC0040001 : "The value of the handle is invalid. Note: a client should never pass an invalid handle to a server. If this error occurs, it is due to a programming error in the client or possibly in the server.",
+		0xC0040008 : "The item ID doesn't conform to the server's syntax.",
+		0xC0040203 : "The passed property ID is not valid for the item.",
+		0xC0040011 : "Requested Object (e.g. a public group) was not found.",
+		0xC0040005 : "The requested operation cannot be done on a public group.",
+		0xC004000B : "The value was out of range.",
+		0xC0040007 : "The item ID is not defined in the server address space (on add or validate) or no longer exists in the server address space (for read or write).",
+		0xC004000A : "The item's access path is not known to the server.",
+		0x0004000E : "A value passed to WRITE was accepted but the output was clamped.",
+		0x0004000F : "The operation cannot be performed because the object is being referenced.",
+		0x0004000D : "The server does not support the requested data rate but will use the closest available rate.",
+		0x00000061 : "Clsid syntax is invalid"
+	};
+
+	function resolveError(e) {
+		if (errorCode[e]) return errorCode[e];
+		if (typeof e === 'number') return `DCOM error code: 0x${(e >>> 0).toString(16).toUpperCase()}`;
+		if (e instanceof Error) return e.message || e.toString();
+		if (typeof e === 'string') return e;
+		try { return JSON.stringify(e); } catch (_) { return String(e); }
+	}
+	    
+	function OPCDARead(config) {
+        RED.nodes.createNode(this,config);
+		let node = this;
+				
+		let server = RED.nodes.getNode(config.server);
+		let serverHandles, clientHandles;
+		
+		node.opcServer = null;
+		node.comServer = null;
+
+		node.opcSyncIO = null;
+		node.opcItemMgr = null;
+
+		node.opcGroup = null;
+
+		node.isConnected = false;
+		node.isReading = false;
+
+		if(!server){
+			node.error("Please select a server.");
+			return;
+		}
+
+		if (!server.credentials) {
+            node.error("Failed to load credentials!");
+			return;
+        }	
+
+		node.updateStatus = function(status){		
+			switch(status){
+				case "disconnected":
+					node.status({fill:"red",shape:"ring",text:"Disconnected"});
+					break;
+				case "timeout":
+					node.status({fill:"red",shape:"ring",text:"Timeout"});
+					break;
+				case "connecting":
+					node.status({fill:"yellow",shape:"ring",text:"Connecting"});
+					break;
+				case "error":
+					node.status({fill:"red",shape:"ring",text:"Error"});
+					break;
+				case "noitem":
+					node.status({fill:"yellow",shape:"ring",text:"No Item"});
+					break;
+				case "badquality":
+					node.status({fill:"red",shape:"ring",text:"Bad Quality"});
+					break;
+				case "goodquality":
+					node.status({fill:"blue",shape:"ring",text:"Good Quality"});
+					break;
+				case "ready":
+					node.status({fill:"green",shape:"ring",text:"Ready"});
+					break;
+				case "reading":
+					node.status({fill:"blue",shape:"ring",text:"Reading"});
+					break;
+				case "mismatch":
+					node.status({fill:"yellow",shape:"ring",text:"Mismatch Data"});
+					break;
+				default:
+					node.status({fill:"grey",shape:"ring",text:"Unknown"});
+					break;
+			}
+		}
+
+		node.init = function(){
+			return new Promise(async function(resolve, reject){
+				if(!node.isConnected){
+					try{
+						node.updateStatus('connecting');
+		
+						var timeout = parseInt(server.config.timeout);
+						var comSession = new Session();
+			
+						comSession = comSession.createSession(server.config.domain, server.credentials.username, server.credentials.password);
+						comSession.setGlobalSocketTimeout(timeout);
+		
+						node.tout = setTimeout(function(){
+							node.updateStatus("timeout");
+							reject("Connection Timeout");
+						}, timeout);
+			
+						node.comServer = new ComServer(new Clsid(server.config.clsid), server.config.address, comSession);	
+						await node.comServer.init();
+			
+						var comObject = await node.comServer.createInstance();
+						node.opcServer = new OPCServer();
+						await node.opcServer.init(comObject);
+	
+						clearTimeout(node.tout);
+
+						serverHandles = [];
+						clientHandles = [];
+						
+						node.opcGroup = await node.opcServer.addGroup(config.id, null);				
+						node.opcItemMgr = await node.opcGroup.getItemManager();
+						node.opcSyncIO = await node.opcGroup.getSyncIO();
+						
+						let clientHandle = 1;
+						var itemsList = config.groupitems.map(e => {
+							return { itemID: e, clientHandle: clientHandle++ };
+						});
+									
+						var addedItems = await node.opcItemMgr.add(itemsList);
+										
+						for(let i=0; i < addedItems.length; i++ ){
+							const addedItem = addedItems[i];
+							const item = itemsList[i];
+			
+							if (addedItem[0] !== 0) {
+								node.warn(`Error adding item '${item.itemID}'`);
+							} 
+							else {
+								serverHandles.push(addedItem[1].serverHandle);
+								clientHandles[item.clientHandle] = item.itemID;
+							}
+						}
+		
+						node.isConnected = true;
+						node.updateStatus('ready');
+	
+						resolve();
+					}
+					catch(e){
+						reject(e);
+					}
+				}
+			});
+		}
+	
+		node.destroy = function(){
+			return new Promise(async function(resolve){
+				try{
+					node.isConnected = false;
+
+					if (node.opcSyncIO) {
+						await node.opcSyncIO.end();
+						node.opcSyncIO = null;
+					}
+					
+					if (node.opcItemMgr) {
+						await node.opcItemMgr.end();
+						node.opcItemMgr = null;
+					}
+					
+					if (node.opcGroup) {
+						await node.opcGroup.end();
+						node.opcGroup = null;
+					}
+		
+					if(node.opcServer){
+						node.opcServer.end();
+						node.opcServer = null;
+					}
+		
+					if(node.comServer){
+						node.comServer.closeStub();
+						node.comServer = null;
+					}
+		
+					resolve();
+				}
+				catch(e){
+					reject(e);
+				}	
+			});
+		}
+
+		let oldValues = [];
+		node.readGroup = function readGroup(cache){
+			var dataSource = cache ? opcda.constants.opc.dataSource.CACHE : opcda.constants.opc.dataSource.DEVICE;
+
+			let valuesTmp = [];
+			node.isReading = true;
+			node.opcSyncIO.read(dataSource, serverHandles).then(valueSets => {
+					
+				var datas = [];
+				
+				let changed = false;
+				let isGood = true;
+
+				for(let i in valueSets){
+					
+					if(config.datachange){
+						if(!changed){
+							if(oldValues.length != valueSets.length || valueSets[i].value != oldValues[i]){
+								changed = true;
+							}
+						}
+						
+						valuesTmp[i] = valueSets[i].value;
+						oldValues[i] = valueSets[i].value;			
+					}
+					
+					var quality;
+					
+					if(valueSets[i].quality >= 0 && valueSets[i].quality < 64){
+						quality = "BAD";
+						isGood = false;
+					}
+					else if(valueSets[i].quality >= 64 && valueSets[i].quality < 192){
+						quality = "UNCERTAIN";
+						isGood = false;
+					}
+					else if(valueSets[i].quality >= 192 && valueSets[i].quality <= 219){
+						quality = "GOOD";
+					}
+					else{
+						quality = "UNKNOWN";
+						isGood = false;
+					}
+					
+					var data = {
+						itemID: clientHandles[valueSets[i].clientHandle],
+						errorCode: valueSets[i].errorCode,
+						quality: quality,
+						timestamp: valueSets[i].timestamp,
+						value: valueSets[i].value,
+					}
+					
+					datas.push(data);
+				}
+				
+				if(isGood){
+					if(config.groupitems.length == datas.length){
+						node.updateStatus('goodquality');
+					}
+
+					if(config.groupitems.length != datas.length){
+						node.updateStatus('mismatch');
+					}
+
+					if(config.groupitems.length < 1){
+						node.updateStatus('noitem');
+					}
+
+					if(config.datachange){
+						oldValues = valuesTmp;
+						if(changed){
+							var msg = { payload: datas };
+							node.send(msg);						
+						}		
+					}
+
+					else{
+						var msg = { payload: datas };
+						node.send(msg);		
+					}	
+				}
+				else{
+					node.updateStatus('badquality');
+				}
+
+				node.isReading = false;
+			}).catch(e => {
+				node.error("opcda-error", e.message);
+				node.updateStatus("error");
+				node.reconnect();
+			});
+		}
+	
+		node.isReconnecting = false;
+		node.reconnect = async function(){
+			try{
+				if(!node.isReconnecting){
+					node.isReconnecting = true;
+					await node.destroy();
+					await new Promise(resolve => setTimeout(resolve, 3000));
+					await node.init();
+					node.isReconnecting = false;
+				}
+
+				node.comServer.on('disconnected',async function(){
+					node.isConnected = false;
+					node.updateStatus('disconnected');
+					await node.reconnect();
+				});
+			}
+			catch(e){
+				node.isReconnecting = false;
+				var msg = resolveError(e);
+				node.updateStatus('error');
+				node.error(`OPC DA connection error: ${msg}`);
+				switch(e) {
+					case 0x00000005:
+					case 0xC0040010:
+					case 0x80040154:
+					case 0x00000061:
+						return;
+					default:
+						await node.reconnect();
+				}
+			}
+		}
+		
+		node.reconnect();
+
+		node.on('input', function(){
+			if(node.isConnected && !node.isReading){
+				node.readGroup(config.cache);
+			}
+        });	
+	
+		node.on('close', function(done){
+			node.status({});
+			node.destroy().then(function(){
+				done();
+			});
+		});
+		
+    }
+	
+    RED.nodes.registerType("tier0-opcda-read",OPCDARead);
+}

package/opcda/opcda-server.html

@@ -0,0 +1,143 @@
+<script type="text/html" data-template-name="tier0-opcda-server">
+	<div class="form-row">
+        <label for="node-config-input-name"><i class="fa fa-tasks"></i> Name</label>
+        <input type="text" id="node-config-input-name" placeholder="Name">
+    </div>
+    <div class="form-row">
+        <label for="node-config-input-address"><i class="fa fa-rss"></i> Address</label>
+        <input type="text" id="node-config-input-address" placeholder="x.x.x.x or Hostname">
+    </div>
+	<div class="form-row">
+        <label for="node-config-input-domain"><i class="fa fa-sitemap"></i> Domain</label>
+        <input type="text" id="node-config-input-domain" placeholder="Domain">
+    </div>
+	<div class="form-row">
+        <label for="node-config-input-username"><i class="fa fa-user"></i> User Name</label>
+        <input type="text" id="node-config-input-username" placeholder="Name">
+    </div>
+	<div class="form-row">
+        <label for="node-config-input-password"><i class="fa fa-key"></i> Password</label>
+        <input type="password" id="node-config-input-password" placeholder="Password">
+    </div>
+	<div class="form-row">
+        <label for="node-config-input-clsid"><i class="fa fa-tasks"></i> ClsId</label>
+        <input type="text" id="node-config-input-clsid" placeholder="ClsId">
+    </div>
+	<div class="form-row">
+		<div style="display:inline">
+			<label for="node-config-input-timeout"><i class="fa fa-refresh"></i> Timeout</label>
+			<input type="text" id="node-config-input-timeout" style="width: 60px;" placeholder="5000"> <span>ms</span>
+		</div>
+	</div>
+
+	<div class="form-row">
+		<button class="editor-button" id="node-config-btn-item-browse"><i class="fa fa-search"></i> Browse</button>
+		<button href="#" class="editor-button" id="node-config-btn-item-export" style="margin: 4px"><i class="fa fa-download"></i> Export</button>
+	</div>
+	<div class="form-row">
+		<p class="form-tips" id="node-config-alert"></p>
+		<ol id="node-config-item-list" style="list-style-position:inside; margin:0; padding: 5px; height: 300px; border:1px solid #cccccc; overflow:scroll"></ol>
+	</div>
+</script>
+
+<script type="text/html" data-help-name="tier0-opcda-server">
+    <p>Opcda Server Node. For more details please visit https://github.com/FREEZONEX/opcda-client</p>
+</script>
+
+<script type="text/javascript">
+    RED.nodes.registerType('tier0-opcda-server',{
+        category: 'config',
+        defaults: {
+			name: {value: ""},
+            address: {value: "", required: true},
+			domain: {value: "", required: true},
+			clsid: {value: "", required: true},
+			timeout: {value: 5000},
+        },
+		credentials: {
+			username: { type: "text", required: true },
+			password: { type: "password", required: true }
+		},
+        label: function() {
+            return this.name||"tier0-opcda-server";
+        },
+		oneditprepare: function () {
+			let browseBtn = $('#node-config-btn-item-browse');
+			let browseBtnIcon = browseBtn.children('i');
+			let exportBtn = $('#node-config-btn-item-export');
+			let exportBtnIcon = exportBtn.children('i');
+			let alertArea = $('#node-config-alert');
+			let itemList = $('#node-config-item-list');
+			
+			console.log(this.credentials);
+			
+			$("#node-config-input-timeout").spinner().val(5000);
+			
+			itemList.hide();
+			alertArea.hide();
+			alertArea.empty();
+			exportBtn.addClass('disabled').attr('disabled', 'disabled');
+
+			browseBtn.click(function(){
+				itemList.hide();
+				alertArea.hide();
+				alertArea.empty();
+								
+				browseBtn.addClass('disabled').attr('disabled', 'disabled');
+				browseBtnIcon.removeClass('fa-search').addClass('fa-spinner fa-spin fa-fw');
+				exportBtn.addClass('disabled').attr('disabled', 'disabled');
+								
+				var queryData = {
+					address: $('#node-config-input-address').val(),
+					domain: $('#node-config-input-domain').val(),
+					username: $('#node-config-input-username').val(),
+					password: $('#node-config-input-password').val(),
+					clsid: $('#node-config-input-clsid').val(),
+					timeout: $('#node-config-input-timeout').val()
+				};
+				
+				console.log(queryData);
+
+				$.get("opcda/browse", queryData)
+				.done(function( data, status, jqXHR ) {
+					alertArea.text(data.items.length + ' items found');
+					itemList.empty();
+					$.each(data.items, function(i, item){
+						$('<li/>').text(item).appendTo(itemList);
+					});
+					
+					itemList.show();
+					exportBtn.removeClass('disabled').removeAttr('disabled');
+
+				})
+				.fail(function( jqXHR, status, errorThrown ) {
+					alertArea.text(jqXHR.responseJSON.error);
+				})
+				.always(function(){
+					browseBtnIcon.removeClass('fa-spinner fa-spin fa-fw').addClass('fa-search');
+					browseBtn.removeClass('disabled').removeAttr('disabled');
+					alertArea.show();
+				});
+			});
+			
+			exportBtn.click(function(){
+				var items = itemList.children('li');
+				var itemData = [];
+				
+				items.each(function (i) {
+					itemData.push($(this).text());
+				});
+
+				var jsonData = "text/json;charset=utf-8," + encodeURIComponent(JSON.stringify(itemData, null, 4));
+				console.log();
+				const a = document.createElement('a');
+				a.href = 'data:' + jsonData;				
+				a.download = 'export.json';
+				a.click();
+			});			
+		},
+		oneditsave: function () {
+
+		}
+    });
+</script>

package/opcda/opcda-server.js

@@ -0,0 +1,91 @@
+module.exports = function(RED) {
+	const opcda = require('node-opc-da');
+    const { OPCServer } = opcda;
+    const { ComServer, Session, Clsid } = opcda.dcom;
+	
+	const errorCode = {
+		0x80040154 : "Clsid is not found.",
+		0x00000005 : "Access denied. Username and/or password might be wrong.",
+		0xC0040006 : "The Items AccessRights do not allow the operation.",
+		0xC0040004 : "The server cannot convert the data between the specified format/ requested data type and the canonical data type.",
+		0xC004000C : "Duplicate name not allowed.",
+		0xC0040010 : "The server's configuration file is an invalid format.",
+		0xC0040009 : "The filter string was not valid",
+		0xC0040001 : "The value of the handle is invalid. Note: a client should never pass an invalid handle to a server. If this error occurs, it is due to a programming error in the client or possibly in the server.",
+		0xC0040008 : "The item ID doesn't conform to the server's syntax.",
+		0xC0040203 : "The passed property ID is not valid for the item.",
+		0xC0040011 : "Requested Object (e.g. a public group) was not found.",
+		0xC0040005 : "The requested operation cannot be done on a public group.",
+		0xC004000B : "The value was out of range.",
+		0xC0040007 : "The item ID is not defined in the server address space (on add or validate) or no longer exists in the server address space (for read or write).",
+		0xC004000A : "The item's access path is not known to the server.",
+		0x0004000E : "A value passed to WRITE was accepted but the output was clamped.",
+		0x0004000F : "The operation cannot be performed because the object is being referenced.",
+		0x0004000D : "The server does not support the requested data rate but will use the closest available rate.",
+		0x00000061 : "Clsid syntax is invalid"
+	};
+
+	function resolveError(e) {
+		if (errorCode[e]) return errorCode[e];
+		if (typeof e === 'number') return `DCOM error code: 0x${(e >>> 0).toString(16).toUpperCase()}`;
+		if (e instanceof Error) return e.message || e.toString();
+		if (typeof e === 'string') return e;
+		try { return JSON.stringify(e); } catch (_) { return String(e); }
+	}
+	
+	RED.httpAdmin.get('/opcda/browse', RED.auth.needsPermission('node-opc-da.list'), function (req, res) {
+        let params = req.query
+        async function browseItems() {
+			try{
+				var session = new Session();
+				session = session.createSession(params.domain, params.username, params.password);
+				session.setGlobalSocketTimeout(params.timeout);
+
+				var comServer = new ComServer(new Clsid(params.clsid), params.address, session);
+				await comServer.init();
+				
+				var comObject = await comServer.createInstance();
+		
+				var opcServer = new opcda.OPCServer();
+				await opcServer.init(comObject);
+
+				var opcBrowser = await opcServer.getBrowser();
+				var itemList = await opcBrowser.browseAllFlat();
+
+				opcBrowser.end()
+					.then(() => opcServer.end())
+					.then(() => comServer.closeStub())
+					.catch(e => RED.log.error(`Error closing browse session: ${e}`));
+
+				res.status(200).send({items : itemList});
+			}
+			catch(e){
+				var msg = resolveError(e);
+				RED.log.error(`OPC DA browse error: ${msg}`);
+				RED.log.error(e);
+				res.status(500).send({error : msg});
+			}
+		}
+		
+		browseItems();
+    });
+
+    function OPCDAServer(config) {
+        RED.nodes.createNode(this,config);
+        const node = this;
+		
+		node.config = config;
+
+		
+		node.on('close', function(done){
+			done();
+		});
+	}
+	
+    RED.nodes.registerType("tier0-opcda-server", OPCDAServer, {
+		credentials: {
+			username: {type:"text"},
+			password: {type:"password"}
+		}
+    });
+}

package/opcda/opcda-write.html

@@ -0,0 +1,32 @@
+<script type="text/html" data-template-name="tier0-opcda-write">
+    <div class="form-row">
+        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+        <input type="text" id="node-input-name" placeholder="Name">
+    </div>
+	<div class="form-row">
+        <label for="node-input-server"><i class="fa fa-server"></i> Server</label>
+        <input id="node-input-server" placeholder="Select OPC DA Server">
+    </div>
+</script>
+
+<script type="text/html" data-help-name="tier0-opcda-write">
+    <p>Opcda Write Node. For more details please visit https://github.com/FREEZONEX/opcda-client</p>
+</script>
+
+<script type="text/javascript">
+    RED.nodes.registerType('tier0-opcda-write',{
+        category: 'opcda',
+        color: '#a6bbcf',
+        defaults: {
+			server: {value: "", type: "tier0-opcda-server", required: true},
+            name: {value: ""},
+        },
+        inputs:1,
+        outputs:1,
+        icon: "serial.png",
+		align: 'right',
+        label: function() {
+            return this.name||this._("tier0-opcda-write");
+        }
+    });
+</script>