@machinemetrics/io-adapter-lib 2.32.2 → 2.32.3

package/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## [2.32.3]
+- Added opcua-conditions options for code format and allow/deny nodes
+
 ## [2.32.2]
 - Add support to reclassify conditions to NORMAL
 

package/lib/config/device/opcuaConfig.js

@@ -2,6 +2,9 @@
 
 const _ = require('lodash');
 const ConfigError = require('../configError');
+const AllowDenyList = require('../common/allowDenyList');
+
+const allowDenyList = new AllowDenyList();
 
 // Pattern to match valid OPC-UA node ID paths, as supported by node-opcua
 // Our validation may be slightly stricter on some value validation.
@@ -144,6 +147,28 @@ class OpcuaConfig {
         result.warningThreshold = warningThreshold;
       }
 
+      result.codeFormat = '{conditionName}_{conditionIdHash}';
+      if (_.has(conditions, 'code-format')) {
+        const codeFormat = conditions['code-format'];
+        if (_.isEmpty(codeFormat) || !_.isString(codeFormat)) {
+          throw new ConfigError('code-format cannot be empty').atAttribute('code-format');
+        }
+        result.codeFormat = codeFormat;
+      }
+
+      if (_.has(conditions, 'allow-condition-nodes')) {
+        result.allowConditionNodes = allowDenyList.parseWildcardKeyList(conditions['allow-condition-nodes'], 'allow-condition-nodes');
+      }
+      if (_.has(conditions, 'deny-condition-nodes')) {
+        result.denyConditionNodes = allowDenyList.parseWildcardKeyList(conditions['deny-condition-nodes'], 'deny-condition-nodes');
+      }
+      if (_.has(conditions, 'allow-source-nodes')) {
+        result.allowSourceNodes = allowDenyList.parseWildcardKeyList(conditions['allow-source-nodes'], 'allow-source-nodes');
+      }
+      if (_.has(conditions, 'deny-source-nodes')) {
+        result.denySourceNodes = allowDenyList.parseWildcardKeyList(conditions['deny-source-nodes'], 'deny-source-nodes');
+      }
+
       return result;
     } catch (error) {
       if (error instanceof ConfigError) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@machinemetrics/io-adapter-lib",
-  "version": "2.32.2",
+  "version": "2.32.3",
   "description": "Configuration and engine implementation for MachineMetrics AdapterScripts and adapters",
   "main": "index.js",
   "license": "UNLICENSED",

package/test/config/opcua.test.js

@@ -8,11 +8,13 @@ describe('OPC-UA config tests', function () {
   let config;
   let defaultConfig;
   let conditionsConfig;
+  let conditionsDefaultConfig;
 
   before(async () => {
     defaultConfig = await testUtils.loadConfig('device/opcua-default.yml');
     config = await testUtils.loadConfig('device/opcua-std.yml');
     conditionsConfig = await testUtils.loadConfig('device/opcua-conditions.yml');
+    conditionsDefaultConfig = await testUtils.loadConfig('device/opcua-conditions-default.yml');
   });
 
   it('loads minimal config with defaults', async function () {
@@ -104,12 +106,27 @@ describe('OPC-UA config tests', function () {
     testPath('nsu=http://test.org/UA/Data/;i=10853');
   });
 
+  it('loads opcua-conditions with default properties', async function () {
+    expect(conditionsDefaultConfig.device.opcuaConditions.key).to.eq('system');
+    expect(conditionsDefaultConfig.device.opcuaConditions.faultThreshold).to.eq(undefined);
+    expect(conditionsDefaultConfig.device.opcuaConditions.warningThreshold).to.eq(undefined);
+    expect(conditionsDefaultConfig.device.opcuaConditions.codeFormat).to.eq('{conditionName}_{conditionIdHash}');
+    expect(conditionsDefaultConfig.device.opcuaConditions.allowConditionNodes).to.eq(undefined);
+    expect(conditionsDefaultConfig.device.opcuaConditions.denyConditionNodes).to.eq(undefined);
+    expect(conditionsDefaultConfig.device.opcuaConditions.allowSourceNodes).to.eq(undefined);
+    expect(conditionsDefaultConfig.device.opcuaConditions.denySourceNodes).to.eq(undefined);
+    expect(conditionsDefaultConfig.device.conditionKey).to.eq('system');
+  });
+
   it('loads opcua-conditions with all properties', async function () {
-    expect(conditionsConfig.device.opcuaConditions).to.deep.eq({
-      key: 'system',
-      faultThreshold: 100,
-      warningThreshold: 50,
-    });
+    expect(conditionsConfig.device.opcuaConditions.key).to.eq('system');
+    expect(conditionsConfig.device.opcuaConditions.faultThreshold).to.eq(100);
+    expect(conditionsConfig.device.opcuaConditions.warningThreshold).to.eq(50);
+    expect(conditionsConfig.device.opcuaConditions.codeFormat).to.eq('{conditionName}');
+    expect(conditionsConfig.device.opcuaConditions.allowConditionNodes).to.have.lengthOf(1);
+    expect(conditionsConfig.device.opcuaConditions.denyConditionNodes).to.have.lengthOf(1);
+    expect(conditionsConfig.device.opcuaConditions.allowSourceNodes).to.have.lengthOf(1);
+    expect(conditionsConfig.device.opcuaConditions.denySourceNodes).to.have.lengthOf(1);
     expect(conditionsConfig.device.conditionKey).to.eq('system');
   });
 });

package/test/configFiles/device/opcua-conditions-default.yml

@@ -0,0 +1,5 @@
+version: 2
+device: opc-ua
+endpoint: opc.tcp://localhost:4840
+opcua-conditions:
+  key: system

package/test/configFiles/device/opcua-conditions.yml

@@ -5,3 +5,12 @@ opcua-conditions:
   key: system
   fault-threshold: 100
   warning-threshold: 50
+  code-format: "{conditionName}"
+  allow-condition-nodes:
+    - ns=2;s=Flames/*
+  deny-condition-nodes:
+    - ns=2;s=Flames/ControlledFacilityComponents/*
+  allow-source-nodes:
+    - ns=2;s=Flames/*
+  deny-source-nodes:
+    - ns=2;s=Flames/ControlledFacilityComponents/*