@halsystems/red-bacnet 1.1.4 → 1.2.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [1.2.0]
+### Added
+- DiscoverPoint and ReadPoint added concurrentTaskDelay config to control delay between concurrent tasks
+
+## [1.1.5]
+### Change
+- ReadPoint to not add device to task queue if no points attached to device
+
 ## [1.1.4]
 ### Added
 - DiscoverPoint added new discover mode: Analog and Binary only

package/common/bacnet.js

@@ -568,19 +568,26 @@ module.exports = {
         }
 
         return new Promise((resolve, reject) => {
+            // Build options only if priority is provided
+            const options = {};
+            if (priority !== null && priority !== undefined) {
+                options.priority = priority;
+            }
+
             client.writeProperty(
                 addressSet,
                 objectId,
                 propertyId,
                 writeValue,
-                { priority: priority },
+                options,  // may be empty if no priority
                 (err) => {
                     if (err) {
                         reject(err);
-                    }
-                    else
+                    } else {
                         resolve(true);
-                });
+                    }
+                }
+            );
         });
     },
 }

package/common/job/read_point.js

@@ -211,7 +211,7 @@ module.exports = {
             smartReadEvent.on(EVENT_OUTPUT, (data) => {
                 this.#updateProgress(
                     Math.round((85 / size) * (count + 1) + 10)
-                )
+                );
 
                 if (Array.isArray(data.result))
                     data.result.forEach(i => {
@@ -223,15 +223,17 @@ module.exports = {
                 count++;
             });
 
-            const tasks = entries.map(([k, v]) => ({
-                id: k,
-                task: async () => {
-                    return await smartReadProperty(
-                        this.client, v.device, v.points, this.readMethod,
-                        this.maxConcurrentSinglePointRead, 10, this.concurrentTaskDelay
-                    );
-                }
-            }));
+            const tasks = entries
+                .filter(([_, v]) => Array.isArray(v.points) && v.points.length > 0)  // eslint-disable-line
+                .map(([k, v]) => ({
+                    id: k,
+                    task: async () => {
+                        return await smartReadProperty(
+                            this.client, v.device, v.points, this.readMethod,
+                            this.maxConcurrentSinglePointRead, 10, this.concurrentTaskDelay
+                        );
+                    }
+                }));
 
             await concurrentTasks(smartReadEvent, tasks, this.maxConcurrentDeviceRead);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@halsystems/red-bacnet",
-  "version": "1.1.4",
+  "version": "1.2.0",
   "description": "NodeRED BACnet IP client",
   "email": "open_source@halsystems.com.au",
   "repository": {

package/red-bacnet/discover_point.html

@@ -10,6 +10,7 @@
             groupExportDeviceCount: { value: 30000, required: true, validate: RED.validators.number() },
             maxConcurrentDeviceRead: { value: 3, required: true, validate: RED.validators.number() },
             maxConcurrentSinglePointRead: { value: 10, required: true, validate: RED.validators.number() },
+            concurrentTaskDelay: { value: 10, required: true, validate: RED.validators.number() },
         },
         inputs: 1,
         outputs: 1,
@@ -57,6 +58,10 @@
         <label for="node-input-maxConcurrentSinglePointRead"><i class="fa fa-tag"></i> Max Concurrent Single Point Read</label>
         <input type="number" id="node-input-maxConcurrentSinglePointRead" placeholder="10" , min="1" , max="1000">
     </div>
+    <div class="form-row">
+        <label for="node-input-concurrentTaskDelay"><i class="fa fa-tag"></i> Concurrent Task Delay (ms)</label>
+        <input type="number" id="node-input-concurrentTaskDelay" placeholder="10" min="0" max="10000">
+    </div>
 </script>
 
 <script type="text/html" data-help-name="discover point">
@@ -86,6 +91,9 @@
         <dt>maxConcurrentSinglePointRead<span class="property-type">number</span></dt>
         <dd> Number of points to read simultaneously when using <code>readProperty</code> mode</dd>
         <dd> <b>USE WITH CAUTION!</b> Reduce to low value if field BACnet device is underpowered</dd>
+
+        <dt>concurrentTaskDelay<span class="property-type">number</span></dt>
+        <dd> Delay in milliseconds between device reading</dd>
         </dl>
 
     <h3>Inputs</h3>
@@ -105,4 +113,4 @@
     <h3>Details</h3>
         <p>If node is triggered while existing job is running, new job will be coalesced if <code>msg.id</code> are identical, else new job will be put in queue until current job is completed.</p>
 
-</script>
+</script>

package/red-bacnet/discover_point.js

@@ -25,6 +25,7 @@ module.exports = function (RED) {
             this.groupExportDeviceCount = +config.groupExportDeviceCount
             this.maxConcurrentDeviceRead = +config.maxConcurrentDeviceRead
             this.maxConcurrentSinglePointRead = +config.maxConcurrentSinglePointRead
+            this.concurrentTaskDelay = +config.concurrentTaskDelay
 
             // events
             this.#subscribeListeners();
@@ -43,7 +44,7 @@ module.exports = function (RED) {
                 const task = new DiscoverPointJob(
                     this.client, this.#eventEmitter, msg?.devices, this.discoverMode, this.readMethod,
                     this.groupExportDeviceCount, this.maxConcurrentDeviceRead,
-                    this.maxConcurrentSinglePointRead
+                    this.maxConcurrentSinglePointRead, this.concurrentTaskDelay
                 );
 
                 this.job.addJob({
@@ -79,4 +80,3 @@ module.exports = function (RED) {
     // ----- register node -----
     RED.nodes.registerType('discover point', DiscoverPoint);
 }
-

package/red-bacnet/read_point.html

@@ -8,6 +8,7 @@
             readMethod: { value: 1, required: true, validate: RED.validators.number() },
             maxConcurrentDeviceRead: { value: 3, required: true, validate: RED.validators.number() },
             maxConcurrentSinglePointRead: { value: 10, required: true, validate: RED.validators.number() },
+            concurrentTaskDelay: { value: 10, required: true, validate: RED.validators.number() },
         },
         inputs: 1,
         outputs: 1,
@@ -45,6 +46,10 @@
             Read</label>
         <input type="number" id="node-input-maxConcurrentSinglePointRead" placeholder="10" , min="1" , max="1000">
     </div>
+    <div class="form-row">
+        <label for="node-input-concurrentTaskDelay"><i class="fa fa-tag"></i> Concurrent Task Delay (ms)</label>
+        <input type="number" id="node-input-concurrentTaskDelay" placeholder="10" , min="0" , max="10000">
+    </div>
 </script>
 
 <script type="text/html" data-help-name="read point">
@@ -68,6 +73,11 @@
             <dt>maxConcurrentSinglePointRead<span class="property-type">number</span></dt>
             <dd> Number of points to read simultaneously when using <code>readProperty</code> mode</dd>
             <dd> <b>USE WITH CAUTION!</b> Reduce to low value if field BACnet device is underpowered</dd>
+            </dd>
+
+            <dt>concurrentTaskDelay<span class="property-type">number</span></dt>
+            <dd> Delay in milliseconds between reading points from different devices</dd>
+            <dd> <b>USE WITH CAUTION!</b> Increase value on slow or congested networks</dd>
             </dl>
         </dl>
 
@@ -91,4 +101,4 @@
 
     <h3>Details</h3>
         <p>If node is triggered while existing job is running, new job will be coalesced if <code>msg.id</code> are identical, else new job will be put in queue until current job is completed.</p>
-</script>
+</script>

package/red-bacnet/read_point.js

@@ -24,6 +24,7 @@ module.exports = function (RED) {
             this.readMethod = +config.readMethod
             this.maxConcurrentDeviceRead = +config.maxConcurrentDeviceRead
             this.maxConcurrentSinglePointRead = +config.maxConcurrentSinglePointRead
+            this.concurrentTaskDelay = +config.concurrentTaskDelay
 
             // events
             this.#subscribeListeners();
@@ -46,7 +47,8 @@ module.exports = function (RED) {
                     msg.points,
                     this.readMethod,
                     this.maxConcurrentDeviceRead,
-                    this.maxConcurrentSinglePointRead
+                    this.maxConcurrentSinglePointRead,
+                    this.concurrentTaskDelay
                 );
 
                 this.job.addJob({
@@ -82,4 +84,3 @@ module.exports = function (RED) {
     // ----- register node -----
     RED.nodes.registerType('read point', ReadPoint);
 }
-