@machinemetrics/io-adapter-lib 2.32.1 → 2.32.3

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # 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
+
 ## [2.32.1]
 - Added opcua-conditions block to opcua config
 - Fixed message overrides in conditions

package/lib/config/adapterConfig.js

@@ -350,6 +350,9 @@ class AdapterConfig {
         if (item['reclassify-fault']) {
           source.reclassifyFault = allowDenyList.parseWildcardKeyList(item['reclassify-fault'], `conditions.${key}.reclassify-fault-codes`);
         }
+        if (item['reclassify-normal']) {
+          source.reclassifyNormal = allowDenyList.parseWildcardKeyList(item['reclassify-normal'], `conditions.${key}.reclassify-normal-codes`);
+        }
 
         if (item.overrides) {
           if (!_.isArray(item.overrides)) {

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.1",
+  "version": "2.32.3",
   "description": "Configuration and engine implementation for MachineMetrics AdapterScripts and adapters",
   "main": "index.js",
   "license": "UNLICENSED",

package/test/.eslintrc.json

@@ -4,7 +4,8 @@
   },
   "rules": {
     "import/no-extraneous-dependencies": [ "off" ],
-    "prefer-arrow-callback": "off"
+    "prefer-arrow-callback": "off",
+    "no-unused-expressions": "off"
   },
   "env": {
     "mocha": true

package/test/conditions.test.js

@@ -72,6 +72,37 @@ describe('data items', async function () {
     validateCondition(captured[10], 'cond1', 'FAULT', 5000, 'A2', 'Code A2');
     validateCondition(captured[11], 'cond2', 'FAULT', 6000, 'B33', 'Code B33');
   });
+
+  it('loads reclassification config', async function () {
+    expect(config.adapter.passthroughConditions).to.exist;
+    expect(config.adapter.passthroughConditions.system).to.exist;
+    expect(config.adapter.passthroughConditions.system.length).to.eq(1);
+
+    const source = config.adapter.passthroughConditions.system[0];
+    expect(source.name).to.eq('cond4');
+    expect(source.reclassifyFault).to.exist;
+    expect(source.reclassifyWarning).to.exist;
+    expect(source.reclassifyNormal).to.exist;
+  });
+
+  it('reclassifies codes based on patterns', async function () {
+    const source = config.adapter.passthroughConditions.system[0];
+
+    // Test FAULT reclassification
+    expect(source.reclassifyFault[0].test('HIGH_TEMP')).to.eq(true);
+    expect(source.reclassifyFault[0].test('HIGH_PRESSURE')).to.eq(true);
+    expect(source.reclassifyFault[0].test('MEDIUM_TEMP')).to.eq(false);
+
+    // Test WARNING reclassification
+    expect(source.reclassifyWarning[0].test('MEDIUM_TEMP')).to.eq(true);
+    expect(source.reclassifyWarning[0].test('MEDIUM_PRESSURE')).to.eq(true);
+    expect(source.reclassifyWarning[0].test('LOW_TEMP')).to.eq(false);
+
+    // Test NORMAL reclassification
+    expect(source.reclassifyNormal[0].test('LOW_TEMP')).to.eq(true);
+    expect(source.reclassifyNormal[0].test('LOW_PRESSURE')).to.eq(true);
+    expect(source.reclassifyNormal[0].test('HIGH_TEMP')).to.eq(false);
+  });
 });
 
 function validateCondition(entry, key, value, time, code, message) {

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/conditions.yml

@@ -5,6 +5,8 @@ declare-keys:
   - key2
   - key3
   - key4
+  - system:
+      type: condition
 variables:
   keymod:
     - source: key2
@@ -35,3 +37,11 @@ conditions:
         override-message: ${this} coolant=${key1}
       - override-code: Y
         override-message: Z
+  cond4:
+    source: system
+    reclassify-fault:
+      - HIGH*
+    reclassify-warning:
+      - MEDIUM*
+    reclassify-normal:
+      - LOW*

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/*