Added CIPAttribute.Get(), fixed CIPMultiServiceRequest, CIPRequest data handler can be another CIPRequest, updated Changelog

jmmoser · jmmoser · commit d6e6d3931e03 · 2020-01-23T06:23:46.000-06:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,48 @@
 # Changelog
 
+## 2.0.0-beta.8 (2020-01-23)
+- Added CIPAttribute.Get() as a helper method for creating a GetAttributeSingle service CIPRequest
+  ```javascript
+  /**
+   * Creates a GetAttributeSingle service CIPRequest for retrieving the device
+   * type of Identity object instance 1
+   */
+  const request = CIP.Core.Objects.Identity.InstanceAttribute.DeviceType.Get(1);
+  ```
+- Improved CIPRequest and CIPMultiServiceRequest
+  - A CIPRequest can be specified as the data handler for another CIPRequest (see ConnectionManager's UnconnectedSend method)
+  - CIPMultiServiceRequest (CIPRequest.Multi) now works
+  - Here is an example of two requests inside of a multi service request inside of an unconnected send
+  ```javascript
+  const { TCP, CIP } = require('../../src');
+
+  const tcpLayer = new TCP('1.2.3.4');
+  const cipLayer = new CIP(tcpLayer);
+
+  /** Create an Unconnected Send request */
+  const request = CIP.Core.Objects.ConnectionManager.UnconnectedSend(
+    /** multi service request */
+    new CIP.Core.Request.Multi([
+      /** two different GetAttributeSingle requests */
+      CIP.Core.Objects.MessageRouter.InstanceAttribute.ObjectList.Get(1),
+      CIP.Core.Objects.Port.InstanceAttribute.Name.Get(1)
+    ]),
+    /** routing out of port 1 to address 0 */
+    CIP.Core.EPath.Encode(true, [
+      new CIP.Core.EPath.Segments.Port(1, 0)
+    ])
+  );
+  
+  /** Use the CIP layer to send the unconnected message */
+  const res = await cipLayer.sendRequest(false, request);
+
+  /** res.value is an array of response objects (2 responses in this case) */
+  console.log(res.value);
+
+  await tcpLayer.close();
+  ```
+- Fixed CIP Layer sendRequest not propagating errors
+
 ## 2.0.0-beta.7 (2020-01-22)
 - The Layers object exported by the package has been removed.
   ```javascript
@@ -77,9 +120,13 @@
   ```javascript
   let i = 0;
   logix.listTags(function(tag) {
-    i++;
-    console.log(i, tag);
-    return i < 10; // return true to continue listing tags
+    if (tag != null) {
+      i++;
+      console.log(i, tag);
+      return i < 10; // return true to continue listing tags
+    } else {
+      // tag is null so listing is finished
+    }
   });
   ```
 - Improved EIP Layer listIdentities timeout handling, it should be much faster to resolve
diff --git a/src/layers/cip/core/attribute.js b/src/layers/cip/core/attribute.js
@@ -1,5 +1,11 @@
 'use strict';
 
+const { Decode } = require('./datatypes/decoding');
+const { CommonServiceCodes } = require('./constants/services');
+const EPath = require('./epath');
+const LogicalSegment = EPath.Segments.Logical;
+
+const CIPRequest = require('./request');
 const CIPFeature = require('./feature');
 
 class CIPAttribute extends CIPFeature {
@@ -9,9 +15,49 @@ class CIPAttribute extends CIPFeature {
     this.getable = getable;
     this.setable = setable;
   }
+
+  Get(instance) {
+    return new CIPRequest(
+      CommonServiceCodes.GetAttributeSingle,
+      EPath.Encode(true, [
+        new LogicalSegment.ClassID(this.classCode),
+        new LogicalSegment.InstanceID(instance),
+        new LogicalSegment.AttributeID(this.code)
+      ]),
+      null,
+      (buffer, offset, cb) => {
+        Decode(this.dataType, buffer, offset, cb);
+      }
+    );
+  }
 }
 
-CIPAttribute.Class = class CIPClassAttribute extends CIPAttribute {}
-CIPAttribute.Instance = class CIPInstanceAttribute extends CIPAttribute {}
+CIPAttribute.Class = class CIPClassAttribute extends CIPAttribute { }
+CIPAttribute.Instance = class CIPInstanceAttribute extends CIPAttribute { }
+
+module.exports = CIPAttribute;
+
+
+
+// 'use strict';
+
+// const CIPRequest
+// const CIPFeature = require('./feature');
+
+// class CIPAttribute extends CIPFeature {
+//   constructor(code, name, dataType, getable = true, setable = false) {
+//     super(code, name);
+//     this.dataType = dataType;
+//     this.getable = getable;
+//     this.setable = setable;
+//   }
+
+//   request() {
+
+//   }
+// }
+
+// CIPAttribute.Class = class CIPClassAttribute extends CIPAttribute {}
+// CIPAttribute.Instance = class CIPInstanceAttribute extends CIPAttribute {}
 
-module.exports = CIPAttribute;
+// module.exports = CIPAttribute;
diff --git a/src/layers/cip/core/feature.js b/src/layers/cip/core/feature.js
@@ -1,9 +1,10 @@
 'use strict';
 
 class CIPFeature {
-  constructor(code, name) {
+  constructor(code, name, classCode) {
     this.code = code;
     this.name = name;
+    this.classCode = classCode;
   }
 }
 
diff --git a/src/layers/cip/core/object.js b/src/layers/cip/core/object.js
@@ -69,8 +69,17 @@ const CommonServices = Object.freeze({
 
 function CIPMetaObject(classCode, options) {
   options = options || {};
-  const ClassAttributeGroup = options.ClassAttributeGroup || new CIPFeatureGroup([]);
-  const InstanceAttributeGroup = options.InstanceAttributeGroup || new CIPFeatureGroup([]);
+  // const ClassAttributeGroup = options.ClassAttributeGroup || new CIPFeatureGroup([]);
+  // const InstanceAttributeGroup = options.InstanceAttributeGroup || new CIPFeatureGroup([]);
+
+  const ClassAttributes = Array.isArray(options.ClassAttributes) ? options.ClassAttributes : Object.values(options.ClassAttributes || {});
+  const InstanceAttributes = Array.isArray(options.InstanceAttributes) ? options.InstanceAttributes : Object.values(options.InstanceAttributes || {});
+  
+  ClassAttributes.forEach(attribute => attribute.classCode = classCode);
+  InstanceAttributes.forEach(attribute => attribute.classCode = classCode);
+
+  const ClassAttributeGroup = new CIPFeatureGroup(ClassAttributes);
+  const InstanceAttributeGroup = new CIPFeatureGroup(InstanceAttributes);
   const GetAttributesAllInstanceAttributes = options.GetAttributesAllInstanceAttributes || [];
 
   class CIPObject {
diff --git a/src/layers/cip/core/objects/ConnectionManager.js b/src/layers/cip/core/objects/ConnectionManager.js
@@ -54,7 +54,7 @@ class ConnectionManager {
       ServiceCodes.UnconnectedSend,
       ConnectionManager_EPath,
       buffer,
-      request.handler,
+      request,
       {
         acceptedServiceCodes: [ServiceCodes.UnconnectedSend, request.service],
         statusHandler: function(statusCode, extendedBuffer, cb) {
diff --git a/src/layers/cip/core/objects/EthernetLink.js b/src/layers/cip/core/objects/EthernetLink.js
@@ -2,7 +2,6 @@
 
 const CIPMetaObject = require('../object');
 const CIPAttribute = require('../attribute');
-const CIPFeatureGroup = require('../featuregroup');
 const { ClassCodes } = require('../constants');
 const { DataType } = require('../datatypes');
 const { getBits } = require('../../../../utils');
@@ -169,9 +168,6 @@ const InstanceAttribute = Object.freeze({
   // PortTrafficOverloadAlarm: new CIPAttribute.Instance(107, 'Port Traffic Overload Alarm', DataType.USINT)
 });
 
-const ClassAttributeGroup = new CIPFeatureGroup(Object.values(ClassAttribute));
-const InstanceAttributeGroup = new CIPFeatureGroup(Object.values(InstanceAttribute));
-
 
 const GetAttributesAllInstanceAttributes = Object.freeze([
   InstanceAttribute.InterfaceSpeed,
@@ -184,8 +180,8 @@ const GetAttributesAllInstanceAttributes = Object.freeze([
 
 
 const CIPObject = CIPMetaObject(ClassCodes.EthernetLink, {
-  ClassAttributeGroup,
-  InstanceAttributeGroup,
+  ClassAttributes: ClassAttribute,
+  InstanceAttributes: InstanceAttribute,
   GetAttributesAllInstanceAttributes
 });
 
diff --git a/src/layers/cip/core/objects/Identity.js b/src/layers/cip/core/objects/Identity.js
@@ -2,7 +2,6 @@
 
 const CIPMetaObject = require('../object');
 const CIPAttribute = require('../attribute');
-const CIPFeatureGroup = require('../featuregroup');
 
 const {
   ClassCodes,
@@ -83,12 +82,10 @@ const GetAttributesAllInstanceAttributes = [
   InstanceAttribute.ProductName
 ];
 
-const ClassAttributeGroup = new CIPFeatureGroup(Object.values(ClassAttribute))
-const InstanceAttributeGroup = new CIPFeatureGroup(Object.values(InstanceAttribute));
 
 const CIPObject = CIPMetaObject(ClassCodes.Identity, {
-  ClassAttributeGroup,
-  InstanceAttributeGroup,
+  ClassAttributes: ClassAttribute,
+  InstanceAttributes: InstanceAttribute,
   GetAttributesAllInstanceAttributes
 });
 
diff --git a/src/layers/cip/core/objects/MessageRouter.js b/src/layers/cip/core/objects/MessageRouter.js
@@ -2,7 +2,6 @@
 
 const CIPMetaObject = require('../object');
 const CIPAttribute = require('../attribute');
-const CIPFeatureGroup = require('../featuregroup');
 
 const {
   ClassCodes,
@@ -43,12 +42,9 @@ const InstanceAttribute = Object.freeze({
 });
 
 
-const ClassAttributeGroup = new CIPFeatureGroup(Object.values(ClassAttribute))
-const InstanceAttributeGroup = new CIPFeatureGroup(Object.values(InstanceAttribute));
-
 const CIPObject = CIPMetaObject(ClassCodes.MessageRouter, {
-  ClassAttributeGroup,
-  InstanceAttributeGroup
+  ClassAttributes: ClassAttribute,
+  InstanceAttributes: InstanceAttribute
 });
 
 class MessageRouter extends CIPObject {}
diff --git a/src/layers/cip/core/objects/Port.js b/src/layers/cip/core/objects/Port.js
@@ -24,7 +24,6 @@
 
 const CIPMetaObject = require('../object');
 const CIPAttribute = require('../attribute');
-const CIPFeatureGroup = require('../featuregroup');
 const { ClassCodes } = require('../constants');
 const { DataType } = require('../datatypes');
 
@@ -101,10 +100,6 @@ const InstanceAttribute = Object.freeze({
 });
 
 
-const ClassAttributeGroup = new CIPFeatureGroup(Object.values(ClassAttribute))
-const InstanceAttributeGroup = new CIPFeatureGroup(Object.values(InstanceAttribute));
-
-
 const GetAttributesAllInstanceAttributes = Object.freeze([
   InstanceAttribute.Type,
   InstanceAttribute.Number,
@@ -115,8 +110,8 @@ const GetAttributesAllInstanceAttributes = Object.freeze([
 
 
 const CIPObject = CIPMetaObject(ClassCodes.Port, {
-  ClassAttributeGroup,
-  InstanceAttributeGroup,
+  ClassAttributes: ClassAttribute,
+  InstanceAttributes: InstanceAttribute,
   GetAttributesAllInstanceAttributes
 });
 
diff --git a/src/layers/cip/core/objects/TCPIPInterface.js b/src/layers/cip/core/objects/TCPIPInterface.js
@@ -2,10 +2,10 @@
 
 const CIPMetaObject = require('../object');
 const CIPAttribute = require('../attribute');
-const CIPFeatureGroup = require('../featuregroup');
 const { ClassCodes } = require('../constants');
 const { DataType } = require('../datatypes');
 
+
 const ClassAttribute = Object.freeze({});
 
 
@@ -69,10 +69,6 @@ const InstanceAttribute = Object.freeze({
 });
 
 
-const ClassAttributeGroup = new CIPFeatureGroup(Object.values(ClassAttribute))
-const InstanceAttributeGroup = new CIPFeatureGroup(Object.values(InstanceAttribute));
-
-
 const GetAttributesAllInstanceAttributes = Object.freeze([
   InstanceAttribute.Status,
   InstanceAttribute.ConfigurationCapability,
@@ -84,8 +80,8 @@ const GetAttributesAllInstanceAttributes = Object.freeze([
 
 
 const CIPObject = CIPMetaObject(ClassCodes.TCPIPInterface, {
-  ClassAttributeGroup,
-  InstanceAttributeGroup,
+  ClassAttributes: ClassAttribute,
+  InstanceAttributes: InstanceAttribute,
   GetAttributesAllInstanceAttributes
 });
 
diff --git a/src/layers/cip/core/request.js b/src/layers/cip/core/request.js
@@ -1,12 +1,17 @@
 'use strict';
 
 const {
+  ClassCodes,
   CommonServiceCodes,
   CommonServiceNames,
   GeneralStatusNames,
   GeneralStatusDescriptions
 } = require('./constants');
 
+const EPath = require('./epath');
+
+// const { deferred } = require('../../../utils');
+
 const EncodeSizeSymbol = Symbol('encodeSize');
 const RequestMessageSymbol = Symbol('requestMessage');
 const ResponseDataHandlerSymbol = Symbol('responseDataHandler');
@@ -17,6 +22,12 @@ class CIPRequest {
     this.service = service,
     this.path = path;
     this.data = data;
+    
+    /** responseHandler can be a function(buffer, offset, cb) or a CIPRequest
+     * ConnectionManager's UnconnectedSend specifies the inner request as the handler */
+    if (responseHandler instanceof CIPRequest) {
+      responseHandler = responseHandler[ResponseDataHandlerSymbol];
+    }
     this[ResponseDataHandlerSymbol] = responseHandler;
     this.options = Object.assign({
       acceptedServiceCodes: [service]
@@ -165,9 +176,15 @@ function DecodeResponse(buffer, offset, options, request, handler) {
 }
 
 
+const MessageRouterPath = EPath.Encode(true, [
+  new EPath.Segments.Logical.ClassID(ClassCodes.MessageRouter),
+  new EPath.Segments.Logical.InstanceID(1)
+]);
+
+
 class CIPMultiServiceRequest extends CIPRequest {
-  constructor(path, requests) {
-    super(CommonServiceCodes.MultipleServicePacket, path);
+  constructor(requests, path) {
+    super(CommonServiceCodes.MultipleServicePacket, path ? path : MessageRouterPath, null, MultiCreateDataHandler(requests));
     this.requests = requests;
   }
 
@@ -211,22 +228,26 @@ class CIPMultiServiceRequest extends CIPRequest {
 
     return offset;
   }
+}
 
-  response(buffer, offset = 0) {
-    const res = super.response(buffer, offset);
-
-    const numberOfReplies = res.data.readUInt16LE(offset, 0);
+function MultiCreateDataHandler(requests) {
+  return function (buffer, offset, cb) {
+    const numberOfReplies = buffer.readUInt16LE(offset, 0); //offset += 2;
 
-    if (numberOfReplies !== this.requests.length) {
-      throw new Error(`CIP Multiple Service response expected ${this.requests.length} replies but only received ${numberOfReplies}`);
+    if (numberOfReplies !== requests.length) {
+      throw new Error(`CIP Multiple Service response expected ${requests.length} replies but only received ${numberOfReplies}`);
     }
 
+    const responses = [];
+
     for (let i = 0; i < numberOfReplies; i++) {
-      const request = this.requests[i];
-      request.response(res.data, res.data.readUInt16LE(2 + 2 * i));
+      // console.log(offset, i, buffer.readUInt16LE(offset + 2 + 2 * i), buffer);
+      responses.push(requests[i].response(buffer, buffer.readUInt16LE(offset + 2 + 2 * i) + offset));
     }
 
-    return res;
+    cb(responses);
+
+    return offset;
   }
 }
 
diff --git a/src/layers/cip/layers/internal/CIPInternalLayer.js b/src/layers/cip/layers/internal/CIPInternalLayer.js
diff --git a/src/utils.js b/src/utils.js
diff --git a/tests/cip.requests.test.js b/tests/cip.requests.test.js

Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,10 @@`
`1`	`1`	`'use strict';`
`2`	`2`
`3`	`3`	`class CIPFeature {`
`4`		`- constructor(code, name) {`
	`4`	`+ constructor(code, name, classCode) {`
`5`	`5`	`this.code = code;`
`6`	`6`	`this.name = name;`
	`7`	`+ this.classCode = classCode;`
`7`	`8`	`}`
`8`	`9`	`}`
`9`	`10`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ class ConnectionManager {`
`54`	`54`	`ServiceCodes.UnconnectedSend,`
`55`	`55`	`ConnectionManager_EPath,`
`56`	`56`	`buffer,`
`57`		`- request.handler,`
	`57`	`+ request,`
`58`	`58`	`{`
`59`	`59`	`acceptedServiceCodes: [ServiceCodes.UnconnectedSend, request.service],`
`60`	`60`	`statusHandler: function(statusCode, extendedBuffer, cb) {`