@machinemetrics/io-adapter-lib 2.36.0 → 2.37.0

package/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## [2.37.0]
+- Brother config changes in support of d00 (c00<->d00 may not be the exact cutoff)
+
 ## [2.36.0]
 - Added if / else-if / else branch transform
 

package/lib/config/device/brotherHTTPConfig.js

@@ -16,7 +16,10 @@ class BrotherHTTPConfig {
     };
 
     const mode = expressionService.config['collection-mode'];
-    const defaultMode = this.DataCollectionModes.MIXED;
+    const deviceName = expressionService.config.device;
+    const defaultMode = deviceName === 'brother-ftp'
+      ? this.DataCollectionModes.FTP
+      : this.DataCollectionModes.MIXED;
     if (mode === undefined) this.dataCollectionMode = defaultMode;
     else if (mode.toLowerCase() === 'http') this.dataCollectionMode = this.DataCollectionModes.HTTP;
     else if (mode.toLowerCase() === 'ftp') this.dataCollectionMode = this.DataCollectionModes.FTP;
@@ -141,15 +144,23 @@ class BrotherHTTPConfig {
 
     /** Configuration indicates how to collect data:
     *  HTTP only,
-    *  FTP only (default),
+    *  FTP only (default for device brother-ftp),
     *  HTTP + FTP for program headers
     */
-    let mode = config['collection-mode'] ?? '';
-    if (_.isString(mode)) {
-      mode = mode.toLowerCase();
+    const isBrotherFtp = config.device === 'brother-ftp';
+    let mode = config['collection-mode'];
+    if (mode === undefined || mode === null || mode === '') {
+      mode = isBrotherFtp ? 'ftp' : '';
+    }
+    if (!_.isString(mode)) {
+      throw new ConfigError('collection-mode must be a string').atAttribute('collection-mode');
+    }
+    mode = mode.toLowerCase();
+    if (isBrotherFtp && mode !== 'ftp') {
+      throw new ConfigError('device brother-ftp requires collection-mode ftp').atAttribute('collection-mode');
     }
     if (!_.includes(['http', 'ftp', 'mixed'], mode)) {
-      throw new ConfigError('collection-mode must be one of: {http, ftp, mixed}').atAttribute('macros');
+      throw new ConfigError('collection-mode must be one of: {http, ftp, mixed}').atAttribute('collection-mode');
     }
 
     let keysThatAlreadyExist = '';
@@ -191,6 +202,36 @@ class BrotherHTTPConfig {
         throw new ConfigError(`The value of macros key ${key} must be a valid integer`).atAttribute(key);
       }
     });
+
+    this.assignOptionalRelativePath(config, 'memory-path', 'memoryPath');
+    this.assignOptionalRelativePath(config, 'production-path', 'productionPath');
+    this.assignOptionalRelativePath(config, 'panel-path', 'panelPath');
+    this.assignOptionalRelativePath(config, 'position-path', 'positionPath');
+    this.assignOptionalRelativePath(config, 'work-counter-path', 'workCounterPath');
+    this.assignOptionalRelativePath(config, 'alarm-path', 'alarmPath');
+    this.assignOptionalRelativePath(config, 'macro-path', 'macroPath');
+
+    if (_.has(config, 'cnc-version')) {
+      const cncVersion = config['cnc-version'];
+      if (cncVersion !== 'legacy' && cncVersion !== 'd00') {
+        throw new ConfigError('cnc-version must be one of: legacy, d00').atAttribute('cnc-version');
+      }
+      this.cncVersion = cncVersion;
+    }
+  }
+
+  assignOptionalRelativePath(config, yamlKey, propertyName) {
+    if (!_.has(config, yamlKey)) {
+      return;
+    }
+    const value = config[yamlKey];
+    if (!_.isString(value) || value.trim() === '') {
+      throw new ConfigError(`${yamlKey} must be a non-empty string`).atAttribute(yamlKey);
+    }
+    if (value.includes('..')) {
+      throw new ConfigError(`${yamlKey} must not contain '..'`).atAttribute(yamlKey);
+    }
+    this[propertyName] = value;
   }
 
   checkScanInterval(config) {

package/lib/config/index.js

@@ -204,6 +204,7 @@ class Config {
         return new OPCUAConfig(expressionService);
       case 'brother':
       case 'brother-http':
+      case 'brother-ftp':
         return new BrotherHTTPConfig(expressionService);
       case 'adam-6052':
         return new AdamConfig(expressionService);
@@ -315,6 +316,7 @@ class Config {
       'opc-ua',
       'brother',
       'brother-http',
+      'brother-ftp',
       'adam-6052',
       'mtconnect',
       'mtconnect-haas',

package/package.json

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

package/test/config/brother-ftp.test.js

@@ -0,0 +1,63 @@
+'use strict';
+
+const expect = require('chai').expect;
+const ConfigError = require('../../lib/config/configError');
+const testUtils = require('../util/testUtils');
+
+describe('Brother FTP device config', function () {
+  it('accepts brother-ftp without collection-mode (defaults to ftp)', async function () {
+    const cfg = await testUtils.loadConfig('device/brother-ftp-minimal.yml');
+    expect(cfg.deviceName).to.eq('brother-ftp');
+    expect(cfg.device.dataCollectionMode).to.eq(cfg.device.DataCollectionModes.FTP);
+  });
+
+  it('passes through optional FTP paths and cnc-version', async function () {
+    const cfg = await testUtils.loadConfig('device/brother-ftp-paths.yml');
+    expect(cfg.device.cncVersion).to.eq('d00');
+    expect(cfg.device.memoryPath).to.eq('_DAT/MEM.NC');
+    expect(cfg.device.productionPath).to.eq('_PRD/PRDD2.NC');
+    expect(cfg.device.panelPath).to.eq('_DAT/PANEL.NC');
+    expect(cfg.device.positionPath).to.eq('_DAT/PDSP.NC');
+    expect(cfg.device.workCounterPath).to.eq('_DAT/WKCNTR.NC');
+    expect(cfg.device.alarmPath).to.eq('_DAT/ALARM.NC');
+    expect(cfg.device.macroPath).to.eq('_DAT/MCRNI1.NC');
+  });
+
+  it('does not set path properties when keys are omitted', async function () {
+    const cfg = await testUtils.loadConfig('device/brother-ftp-minimal.yml');
+    expect(cfg.device.memoryPath).to.eq(undefined);
+    expect(cfg.device.cncVersion).to.eq(undefined);
+  });
+
+  it('accepts cnc-version legacy', async function () {
+    const cfg = await testUtils.loadConfig('device/brother-ftp-cnc-legacy.yml');
+    expect(cfg.device.cncVersion).to.eq('legacy');
+  });
+
+  it('rejects invalid cnc-version', async function () {
+    try {
+      await testUtils.loadConfig('device/brother-ftp-bad-cnc.yml');
+      expect.fail('Expected ConfigError');
+    } catch (err) {
+      expect(err).to.be.instanceof(ConfigError);
+    }
+  });
+
+  it('rejects paths containing ..', async function () {
+    try {
+      await testUtils.loadConfig('device/brother-ftp-bad-path.yml');
+      expect.fail('Expected ConfigError');
+    } catch (err) {
+      expect(err).to.be.instanceof(ConfigError);
+    }
+  });
+
+  it('rejects brother-ftp with non-ftp collection-mode', async function () {
+    try {
+      await testUtils.loadConfig('device/brother-ftp-bad-mode.yml');
+      expect.fail('Expected ConfigError');
+    } catch (err) {
+      expect(err).to.be.instanceof(ConfigError);
+    }
+  });
+});

package/test/config/brother-http.test.js

@@ -15,5 +15,7 @@ describe('Brother HTTP config tests', function () {
     expect(defaultConfig.device.port).to.eq(21);
     expect(defaultConfig.device.scanInterval).to.eq(1000);
     expect(defaultConfig.device.httpInterval).to.eq(50);
+    expect(defaultConfig.device.memoryPath).to.eq(undefined);
+    expect(defaultConfig.device.cncVersion).to.eq(undefined);
   });
 });

package/test/configFiles/device/brother-ftp-bad-cnc.yml

@@ -0,0 +1,3 @@
+device: brother-ftp
+endpoint: 192.168.1.50
+cnc-version: bogus

package/test/configFiles/device/brother-ftp-bad-mode.yml

@@ -0,0 +1,3 @@
+device: brother-ftp
+endpoint: 192.168.1.50
+collection-mode: http

package/test/configFiles/device/brother-ftp-bad-path.yml

@@ -0,0 +1,3 @@
+device: brother-ftp
+endpoint: 192.168.1.50
+memory-path: _DAT/../MEM.NC

package/test/configFiles/device/brother-ftp-cnc-legacy.yml

@@ -0,0 +1,3 @@
+device: brother-ftp
+endpoint: 192.168.1.50
+cnc-version: legacy

package/test/configFiles/device/brother-ftp-minimal.yml

@@ -0,0 +1,2 @@
+device: brother-ftp
+endpoint: 192.168.1.50

package/test/configFiles/device/brother-ftp-paths.yml

@@ -0,0 +1,11 @@
+device: brother-ftp
+endpoint: 192.168.1.50
+collection-mode: ftp
+cnc-version: d00
+memory-path: _DAT/MEM.NC
+production-path: _PRD/PRDD2.NC
+panel-path: _DAT/PANEL.NC
+position-path: _DAT/PDSP.NC
+work-counter-path: _DAT/WKCNTR.NC
+alarm-path: _DAT/ALARM.NC
+macro-path: _DAT/MCRNI1.NC