feat: implement write-property-multiple

index.js

@@ -157,6 +157,38 @@ module.exports = function(settings) {
     client.readPropertyMultiple(address, propertyIdAndArrayIndex, next);
   };
 
+  /**
+   * The writePropertyMultiple command writes multiple properties in multiple objects to a device.
+   * @function bacstack.writePropertyMultiple
+   * @param {string} address - IP address of the target device.
+   * @param {object[]} valueList - List of object and property specifications to be written.
+   * @param {object} valueList.objectIdentifier - Specifies which object to read.
+   * @param {number} valueList.objectIdentifier.type - The BACNET object type to read.
+   * @param {number} valueList.objectIdentifier.instance - The BACNET object instance to read.
+   * @param {object[]} valueList.values - List of properties to be written.
+   * @param {object} valueList.values.property - Property specifications to be written.
+   * @param {number} valueList.values.property.propertyIdentifier - The BACNET property id in the specified object to write.
+   * @param {number} valueList.values.property.propertyArrayIndex - The array index of the property to be written.
+   * @param {object[]} valueList.values.value - A list of values to be written to the specified property.
+   * @param {number} valueList.values.value.Tag - The data-type of the value to be written. Has to be a BacnetApplicationTags declaration as specified in lib/bacnet-enum.js.
+   * @param {object} valueList.values.value.Value - The actual value to be written.
+   * @param {number} valueList.values.priority - The priority to be used for writing to the property.
+   * @param {function} next - The callback containing an error, in case of a failure and value object in case of success.
+   * @example
+
+   * var valueList = [
+   *   {objectIdentifier: {type: 8, instance: 44301}, values: [
+   *     {property: {propertyIdentifier: 28, propertyArrayIndex: 12}, value: [{Tag: 1, Value: true}], priority: 8}
+   *   ]}
+   * ];
+   * client.readPropertyMultiple('192.168.1.43', valueList, function(err, value) {
+   *   console.log('value: ', value);
+   * });
+   */
+  self.writePropertyMultiple = function(address, valueList, next) {
+    client.writePropertyMultiple(address, valueList, next);
+  };
+
   /**
    * The deviceCommunicationControl command enables or disables network communication of the target device.
    * @function bacstack.deviceCommunicationControl

lib/bacnet-client.js

@@ -337,6 +337,23 @@ module.exports = function(settings) {
     });
   };
 
+  self.writePropertyMultiple = function(address, valueList, next) {
+    var maxSegments = baEnum.BacnetMaxSegments.MAX_SEG65;
+    var buffer = getBuffer();
+    var invokeId = getInvokeId();
+    baNpdu.Encode(buffer, baEnum.BacnetNpduControls.PRIORITY_NORMAL_MESSAGE | baEnum.BacnetNpduControls.EXPECTING_REPLY, address);
+    baAdpu.encodeConfirmedServiceRequest(buffer, baEnum.BacnetPduTypes.PDU_TYPE_CONFIRMED_SERVICE_REQUEST, baEnum.BacnetConfirmedServices.SERVICE_CONFIRMED_WRITE_PROP_MULTIPLE, maxSegments, baEnum.BacnetMaxAdpu.MAX_APDU1476, invokeId);
+    baServices.EncodeWriteObjectMultiple(buffer, valueList);
+    baBvlc.encode(buffer.buffer, baEnum.BacnetBvlcFunctions.BVLC_ORIGINAL_UNICAST_NPDU, buffer.offset);
+    transport.send(buffer.buffer, buffer.offset, address);
+    addCallback(invokeId, function(err, data) {
+      if (err) return next(err);
+      // TODO: Handle simple-ack
+      var result = true;
+      next(null, result);
+    });
+  };
+
   self.deviceCommunicationControl = function(address, timeDuration, enableDisable, password, next) {
     var maxSegments = baEnum.BacnetMaxSegments.MAX_SEG65;
     var buffer = getBuffer();

lib/bacnet-services.js

@@ -692,8 +692,8 @@ module.exports.DecodeWritePropertyMultiple = function(buffer, offset, apduLen) {
 };
 
 module.exports.EncodeWriteObjectMultiple = function(buffer, valueList) {
-  valueList.forEach(function(rValue) {
-    EncodeWritePropertyMultiple(buffer, rValue.objectIdentifier, rValue.values);
+  valueList.forEach(function(object) {
+    EncodeWritePropertyMultiple(buffer, object.objectIdentifier, object.values);
   });
 };
 

test/integration/write-property-multiple.spec.js

@@ -0,0 +1,19 @@
+var expect = require('chai').expect;
+var utils = require('./utils');
+
+describe('bacstack - writePropertyMultiple integration', function() {
+  it('should return a timeout error if no device is available', function(next) {
+    var client = new utils.bacnetClient({adpuTimeout: 200});
+    var valueList = [
+      {objectIdentifier: {type: 8, instance: 44301}, values: [
+        {property: {propertyIdentifier: 28, propertyArrayIndex: 12}, value: [{Tag: 1, Value: true}], priority: 8}
+      ]}
+    ];
+    client.writePropertyMultiple('127.0.0.1', valueList, function(err, value) {
+      expect(err).to.eql(new Error('ERR_TIMEOUT'));
+      expect(value).to.eql(undefined);
+      client.close();
+      next();
+    });
+  });
+});