@tier0/node-red-contrib-opcda-client 1.0.4 → 1.0.5

package/opcda/opcda-read.html

@@ -32,7 +32,7 @@
 </script>
 
 <script type="text/html" data-help-name="tier0-opcda-read">
-    <p>Opcda Read Node. For more details please visit https://github.com/FREEZONEX/opcda-client</p>
+    <p>Opcda Read Node. For more details please visit https://github.com/emrebekar/node-red-contrib-opcda-client</p>
 </script>
 
 <script type="text/javascript">

package/opcda/opcda-read.js

@@ -1,5 +1,5 @@
 module.exports = function(RED) {
-	const opcda = require('node-opc-da');
+	const opcda = require('@tier0/node-opc-da');
 	const { OPCServer } = opcda;
     const { ComServer, Session, Clsid } = opcda.dcom;
 	
@@ -24,38 +24,6 @@ module.exports = function(RED) {
 		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 (typeof e === "number") {
-			const u = e >>> 0;
-			if (errorCode[e] !== undefined) return errorCode[e];
-			if (errorCode[u] !== undefined) return errorCode[u];
-			return "HRESULT 0x" + u.toString(16).toUpperCase() + " (" + e + ")";
-		}
-		if (e instanceof Error && e.message) {
-			const asNum = Number(e.message);
-			if (!Number.isNaN(asNum) && String(asNum) === String(e.message).trim()) {
-				return resolveError(asNum);
-			}
-			return e.message;
-		}
-		if (errorCode[e]) return errorCode[e];
-		if (typeof e === "string") return e;
-		try {
-			return JSON.stringify(e);
-		} catch (_) {
-			return String(e);
-		}
-	}
-
-	/** IOPCItemMgt::Add per-item result (may be signed negative in JS). */
-	function describeOpcItemResult(code) {
-		if (code === 0) return "OK";
-		const unsigned = code >>> 0;
-		const fromOpc = opcda.constants.opc.errorDesc[String(unsigned)];
-		if (fromOpc) return fromOpc + " (0x" + unsigned.toString(16).toUpperCase() + ")";
-		return "OPC/DCOM result 0x" + unsigned.toString(16).toUpperCase() + " (" + code + ")";
-	}
 	    
 	function OPCDARead(config) {
         RED.nodes.createNode(this,config);
@@ -129,12 +97,9 @@ module.exports = function(RED) {
 					try{
 						node.updateStatus('connecting');
 		
-						var timeout = parseInt(server.config.timeout, 10);
-						if (!Number.isFinite(timeout) || timeout <= 0) {
-							timeout = 15000;
-						}
+						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);
 		
@@ -171,7 +136,7 @@ module.exports = function(RED) {
 							const item = itemsList[i];
 			
 							if (addedItem[0] !== 0) {
-								node.warn("Error adding item '" + item.itemID + "': " + describeOpcItemResult(addedItem[0]));
+								node.warn(`Error adding item '${item.itemID}'`);
 							} 
 							else {
 								serverHandles.push(addedItem[1].serverHandle);
@@ -341,18 +306,24 @@ module.exports = function(RED) {
 			}
 			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();
+				if(errorCode[e]){
+					node.updateStatus('error');
+					switch(e) {
+						case 0x00000005:
+						case 0xC0040010:
+						case 0x80040154:
+						case 0x00000061:
+							node.error(errorCode[e]);
+							return;
+						default:
+							node.error(errorCode[e]);
+							await node.reconnect();
+					}
 				}
+				else{
+					node.error(e);
+					await node.reconnect();
+				}				
 			}
 		}
 		

package/opcda/opcda-server.html

@@ -41,7 +41,7 @@
 </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>
+    <p>Opcda Server Node. For more details please visit https://github.com/emrebekar/node-red-contrib-opcda-client</p>
 </script>
 
 <script type="text/javascript">
@@ -50,7 +50,7 @@
         defaults: {
 			name: {value: ""},
             address: {value: "", required: true},
-			domain: {value: ""},
+			domain: {value: "", required: true},
 			clsid: {value: "", required: true},
 			timeout: {value: 5000},
         },
@@ -63,31 +63,22 @@
         },
 		oneditprepare: function () {
 			let self = this;
-			/**
-			 * Admin route RED.httpAdmin.get('/opcda/browse').
-			 * Tier0 + Kong: public path is /nodered/home/... — must NOT request bare /opcda/browse (hits wrong service → HTML 200).
-			 * Node-RED sets RED.settings.apiRootUrl for proxy subpaths; use it first.
-			 */
 			function browseApiUrl() {
 				var api = RED.settings && RED.settings.apiRootUrl;
 				if (api) {
 					var u = String(api);
-					if (!/\/$/.test(u)) {
-						u += '/';
-					}
-					return u + 'tier0-opcda/browse';
+					if (!/\/$/.test(u)) u += '/';
+					return u + 'opcda/browse';
 				}
 				var s = RED.settings && RED.settings.httpAdminRoot;
 				if (s != null && String(s).trim() !== '' && String(s) !== '/') {
 					var root = String(s).replace(/\/+$/, '');
-					return (root ? root : '') + '/tier0-opcda/browse';
+					return (root ? root : '') + '/opcda/browse';
 				}
 				var p = window.location.pathname || '';
 				p = p.replace(/\/+$/, '');
-				if (p && p !== '/') {
-					return (p + '/tier0-opcda/browse').replace(/\/+/g, '/');
-				}
-				return '/tier0-opcda/browse';
+				if (p && p !== '/') return (p + '/opcda/browse').replace(/\/+/g, '/');
+				return '/opcda/browse';
 			}
 			let browseBtn = $('#node-config-btn-item-browse');
 			let browseBtnIcon = browseBtn.children('i');
@@ -128,7 +119,7 @@
 					data: queryData,
 					dataType: 'json'
 				})
-				.done(function( data /*, status, jqXHR */ ) {
+				.done(function( data ) {
 					var items = data && data.items;
 					if (!Array.isArray(items)) {
 						alertArea.text('Browse returned an invalid response (expected JSON { items: [...] }). See Node-RED log.');
@@ -149,10 +140,10 @@
 				.fail(function( jqXHR, textStatus, errorThrown ) {
 					var errText;
 					if (jqXHR.status === 403) {
-						errText = 'Permission denied. Node-RED 4+: grant role permission "OPC DA: browse address space" (node-opc-da.list), then reload the editor.';
+						errText = 'Permission denied. Grant node-opc-da.list to your role (Node-RED 4+).';
 					} else if (textStatus === 'parsererror') {
-						errText = 'Browse got HTML instead of JSON (wrong path). Tried: ' + browseApiUrl() +
-							'. Open DevTools → Network and confirm this URL returns JSON. Status ' + (jqXHR.status || '?') + '.';
+						errText = 'Browse got HTML instead of JSON. Tried: ' + browseApiUrl() +
+							'. Check Network tab. Status ' + (jqXHR.status || '?') + '.';
 					} else {
 						errText = (jqXHR.responseJSON && jqXHR.responseJSON.error) ||
 							jqXHR.responseText || errorThrown || textStatus || 'Request failed';

package/opcda/opcda-server.js

@@ -1,13 +1,11 @@
 module.exports = function(RED) {
-	const opcda = require('node-opc-da');
+	const opcda = require('@tier0/node-opc-da');
     const { OPCServer } = opcda;
     const { ComServer, Session, Clsid } = opcda.dcom;
-
-	const ACCESS_DENIED_HINT = " Check DOMAIN (Windows PC name for local accounts, e.g. DESKTOP-XXX), password, DCOM rights on the OPC host, and Deploy the server config so Browse uses saved credentials.";
-
+	
 	const errorCode = {
 		0x80040154 : "Clsid is not found.",
-		0x00000005 : "Access denied (DCOM)." + ACCESS_DENIED_HINT,
+		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.",
@@ -25,41 +23,33 @@ module.exports = function(RED) {
 		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",
-		0x80004002 : "No such interface (E_NOINTERFACE)."
+		0x80004002 : "No such interface (E_NOINTERFACE).",
+		2147500034 : "No such interface (E_NOINTERFACE)."
 	};
 
-	function resolveError(e) {
-		if (typeof e === "number") {
-			const u = e >>> 0;
-			if (u === 0x80070005 || e === 5 || e === -2147024891) {
-				return "Access denied (DCOM 0x80070005 / 0x5)." + ACCESS_DENIED_HINT;
-			}
-			if (errorCode[e] !== undefined) return errorCode[e];
+	function formatBrowseError(err) {
+		if (typeof err === "number") {
+			const u = err >>> 0;
+			if (errorCode[err] !== undefined) return errorCode[err];
 			if (errorCode[u] !== undefined) return errorCode[u];
-			return "HRESULT 0x" + u.toString(16).toUpperCase() + " (" + e + ")";
+			return "HRESULT 0x" + u.toString(16) + " (" + err + ")";
 		}
-		if (e instanceof Error && e.message) {
-			const asNum = Number(e.message);
-			if (!Number.isNaN(asNum) && String(asNum) === String(e.message).trim()) {
-				return resolveError(asNum);
+		if (err && err.message) {
+			const asNum = Number(err.message);
+			if (!Number.isNaN(asNum) && String(asNum) === String(err.message).trim()) {
+				return formatBrowseError(asNum);
 			}
-			return e.message;
-		}
-		if (errorCode[e]) return errorCode[e];
-		if (typeof e === "string") return e;
-		try {
-			return JSON.stringify(e);
-		} catch (_) {
-			return String(e);
+			return err.message;
 		}
+		return String(err || "Unknown error.");
 	}
 
 	/**
-	 * Use deployed tier0-opcda-server credentials when the editor password field is empty.
+	 * Merge query params with deployed opcda-server config node so Browse works when
+	 * the password field is empty in the editor (Node-RED never fills stored passwords).
 	 */
 	function resolveBrowseParams(query) {
 		const params = Object.assign({}, query);
-		// Node-RED puts this in the password field when creds exist but user did not re-type the password.
 		if (params.password === "__PWRD__" || params.password === "__PASSWORD__") {
 			delete params.password;
 		}
@@ -67,18 +57,14 @@ module.exports = function(RED) {
 		if (id) {
 			const srv = RED.nodes.getNode(id);
 			if (srv && srv.credentials) {
-				if (srv.address) params.address = srv.address;
-				if (srv.clsid) params.clsid = srv.clsid;
-				if (srv.timeout != null && srv.timeout !== "") params.timeout = srv.timeout;
 				if (srv.domain != null && String(srv.domain).trim() !== "") {
 					params.domain = String(srv.domain).trim();
 				}
-				if (srv.credentials.username) {
-					params.username = srv.credentials.username;
-				}
-				if (srv.credentials.password) {
-					params.password = srv.credentials.password;
-				}
+				if (srv.address) params.address = srv.address;
+				if (srv.clsid) params.clsid = srv.clsid;
+				if (srv.timeout != null && srv.timeout !== "") params.timeout = srv.timeout;
+				if (srv.credentials.username) params.username = srv.credentials.username;
+				if (srv.credentials.password) params.password = srv.credentials.password;
 			} else if (id) {
 				RED.log.warn("OPC DA browse: config node id not in runtime (Deploy flows?) — using form/query fields only.");
 			}
@@ -95,7 +81,7 @@ module.exports = function(RED) {
 		return params;
 	}
 
-	RED.httpAdmin.get("/tier0-opcda/browse", RED.auth.needsPermission("node-opc-da.list"), function (req, res) {
+	RED.httpAdmin.get('/opcda/browse', RED.auth.needsPermission('node-opc-da.list'), function (req, res) {
 		async function browseItems() {
 			const params = resolveBrowseParams(req.query);
 			try {
@@ -105,7 +91,7 @@ module.exports = function(RED) {
 				}
 				if (!params.username || !params.password) {
 					res.status(400).send({
-						error: "Missing username or password. Deploy flows first (Browse uses stored credentials from the tier0-opcda-server node). If the browser showed password=__PWRD__, that is not a real password — Node-RED only sends the real one after Deploy, or re-type the password in the server config and deploy."
+						error: "Missing username or password. Deploy flows first (Browse uses stored credentials from the opcda-server node). If the URL showed password=__PWRD__, that is not a real password — deploy or re-type the password in the server config."
 					});
 					return;
 				}
@@ -128,12 +114,12 @@ module.exports = function(RED) {
 				opcBrowser.end()
 					.then(() => opcServer.end())
 					.then(() => comServer.closeStub())
-					.catch((e) => RED.log.error(`Error closing browse session: ${e}`));
+					.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}`);
+				const msg = formatBrowseError(e);
+				RED.log.error(`OPC DA browse: ${msg}`);
 				if (e && e.stack) RED.log.error(e.stack);
 				res.status(500).send({error: msg});
 			}

package/opcda/opcda-write.html

@@ -10,7 +10,7 @@
 </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>
+    <p>Opcda Write Node. For more details please visit https://github.com/emrebekar/node-red-contrib-opcda-client</p>
 </script>
 
 <script type="text/javascript">

package/opcda/opcda-write.js

@@ -1,5 +1,5 @@
 module.exports = function(RED) {
-	const opcda = require('node-opc-da');
+	const opcda = require('@tier0/node-opc-da');
 	const { OPCServer } = opcda;
     const { ComServer, Session, Clsid, ComString} = opcda.dcom;
 	
@@ -24,14 +24,6 @@ module.exports = function(RED) {
 		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); }
-	}
 	
 	const itemTypes = {
 		"double" : opcda.dcom.Types.DOUBLE,
@@ -255,18 +247,23 @@ module.exports = function(RED) {
 			}
 			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();
+				if(errorCode[e]){
+					switch(e) {
+						case 0x00000005:
+						case 0xC0040010:
+						case 0x80040154:
+						case 0x00000061:
+							node.error(errorCode[e]);
+							return;
+						default:
+							node.error(errorCode[e]);
+							await node.reconnect();
+					}
 				}
+				else{
+					node.error(e);
+					await node.reconnect();
+				}				
 			}
 		}
 		

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tier0/node-red-contrib-opcda-client",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Node-RED OPC DA Reading and Writing Node",
   "node-red": {
     "nodes": {

package/OPCDA_Bridge_Setup_Guide.md

@@ -1,132 +0,0 @@
-# OPC DA to MQTT Bridge - Deployment Guide
-
-## 1. Prerequisites (Offline Package Contents)
-
-Before you begin, ensure you have the following files from the provided offline package:
-
-| # | File | Purpose |
-|---|------|---------|
-| 1 | `python-2.7.amd64.msi` | Python 2.7 runtime |
-| 2 | `pywin32-221.win-amd64-py2.7.exe` | Windows COM/DCOM support for Python |
-| 3 | `OpenOPC-1.3.1.win-amd64-py2.7.exe` | OPC DA client library |
-| 4 | `paho-mqtt-1.6.1.tar.gz` | MQTT client library (offline) |
-| 5 | `opctest.py` | Bridge script |
-
-> **Note:** If the script fails with a DCOM/OPC error on a machine that does NOT have KEPServerEX or any OPC software installed, you may also need to install `OPC Core Components Redistributable (x64).msi` to register `opcdaauto.dll`.
-
-## 2. Installation Steps
-
-### Step 1: Install Python 2.7
-
-1. Run `python-2.7.amd64.msi`
-2. **Important:** In the installation options, check **"Add python.exe to Path"**
-3. Keep the default installation path: `C:\Python27\`
-4. After installation, open CMD and verify:
-   ```
-   C:\Python27\python.exe --version
-   ```
-   Expected output: `Python 2.7.x`
-
-### Step 2: Install pywin32 (DCOM Support)
-
-1. Run `pywin32-221.win-amd64-py2.7.exe`
-2. The installer will automatically detect the Python 2.7 path
-3. Click "Next" through the installation
-
-### Step 3: Install OpenOPC
-
-1. Run `OpenOPC-1.3.1.win-amd64-py2.7.exe`
-2. The installer will automatically detect the Python 2.7 path
-3. Click "Next" through the installation
-
-### Step 4: Install paho-mqtt (Offline)
-
-1. Extract `paho-mqtt-1.6.1.tar.gz` to a folder (e.g. `C:\temp\paho-mqtt-1.6.1\`)
-2. Open **Command Prompt (CMD)** and run:
-   ```
-   cd C:\yourpath\paho-mqtt-1.6.1
-   C:\Python27\python.exe setup.py install
-   ```
-
-## 3. Configuration
-
-Open `opctest.py` in a text editor (e.g. Notepad) and update the following settings at the top of the file:
-
-```
-OPC_SERVER = 'Kepware.KEPServerEX.V6'    # OPC DA server ProgID
-OPC_HOST = '192.168.31.75'               # IP of the OPC DA server machine
-MQTT_BROKER = '192.168.31.45'            # IP of the MQTT broker (Node-RED)
-MQTT_PORT = 1883                         # MQTT port
-POLL_INTERVAL = 1                        # Read interval in seconds
-```
-
-Update the `TAGS` list with the actual OPC DA tag names:
-
-```
-TAGS = [
-    u'TI2022.PV',
-    u'TI2022.SV',
-    u'TI2022.MV',
-    # Add more tags as needed...
-]
-```
-
-## 4. Run the Bridge
-
-1. Open **Command Prompt as Administrator** (right-click CMD > "Run as administrator")
-2. Navigate to the folder containing `opctest.py`:
-   ```
-   cd C:\path\to\opctest
-   ```
-3. Run the script:
-   ```
-   C:\Python27\python.exe opctest.py
-   ```
-4. You should see output like:
-   ```
-   [*] OPC DA -> MQTT Bridge
-       OPC Server: Kepware.KEPServerEX.V6 @ 192.168.31.75
-       MQTT Broker: 192.168.31.45:1883
-       Tags: 3
-
-   [+] UNS import JSON written to uns_import.json
-   [+] MQTT connected
-   [+] OPC DA connected
-   [*] Publishing data every 1s (Ctrl+C to stop)...
-   --------------------------------------------------
-   [18:30:01] Published 3 tags
-   [18:30:02] Published 3 tags
-   ```
-5. Press `Ctrl+C` to stop the bridge gracefully
-
-## 5. Import UNS Structure into Tier 0
-
-1. After the script runs, a file named `uns_import.json` is generated in the same folder
-2. Open the Tier 0 platform
-3. Navigate to the UNS import function
-4. Upload `uns_import.json`
-5. The topic tree will be created automatically (e.g. `opcda/TI2022/Metric/PV`)
-
-## 6. Troubleshooting
-
-| Error | Solution |
-|-------|----------|
-| `'python' is not recognized` | Python was not added to PATH. Use the full path: `C:\Python27\python.exe` |
-| `No module named OpenOPC` | OpenOPC not installed. Re-run Step 4 |
-| `No module named paho` | paho-mqtt not installed. Re-run Step 5 |
-| `Access denied` / DCOM error | Run CMD as **Administrator** |
-| `OPC server not found` | Verify `OPC_SERVER` name and that the OPC server is running on the target machine |
-| `MQTT connection refused` | Verify `MQTT_BROKER` IP and that the MQTT broker is running on port 1883 |
-| Script stops unexpectedly | Check network connectivity to both OPC and MQTT servers |
-
-## 7. Run as a Windows Service (Optional)
-
-To keep the bridge running in the background after logoff, you can use **NSSM** (Non-Sucking Service Manager):
-
-1. Download `nssm.exe` and place it in the script folder
-2. Open CMD as Administrator and run:
-   ```
-   nssm install OPCDABridge "C:\Python27\python.exe" "C:\path\to\opctest.py"
-   nssm start OPCDABridge
-   ```
-3. The bridge will now run automatically on system startup