@halsystems/red-bacnet 1.2.0 → 1.4.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [1.4.0]
+### Changed
+- `read_point` readMethod removed `Read Multiple Fallback Single` option
+
+### Fixed
+- Fixed dummy event emitter not catching output and error
+- Fixed read point event emitter not catching error
+
+## [1.3.0]
+### Added
+- WritePoint added concurrentTaskDelay config to control delay between concurrent tasks
+
+### Changed
+- Default maxConcurrentDeviceRead to 1 for discover_point, read_point and write_point
+
 ## [1.2.0]
 ### Added
 - DiscoverPoint and ReadPoint added concurrentTaskDelay config to control delay between concurrent tasks

package/common/bacnet.js

@@ -6,7 +6,7 @@ const EventEmitter = require('events');
 const bacnet = require('@root/ext/node-bacstack/dist/index.js')
 const baEnum = bacnet.enum;
 
-const { EVENT_ERROR } = require('@root/common/core/constant.js')
+const { EVENT_ERROR, EVENT_OUTPUT } = require('@root/common/core/constant.js')
 const { concurrentTasks } = require('@root/common/core/concurrent.js')
 const { getErrMsg } = require('@root/common/func.js')
 
@@ -266,6 +266,9 @@ module.exports = {
             let failedCount = 0
             let result_single = []
             const dummyEventEmitter = new EventEmitter();
+            dummyEventEmitter.on(EVENT_OUTPUT, () => { });
+            dummyEventEmitter.on(EVENT_ERROR, () => { });
+
             const tasks = reqArr.slice(reqArrIndexNext).flatMap((req, x) =>
                 req.properties.map((prop, y) => ({
                     id: `${x}-${y}`,

package/common/job/read_point.js

@@ -223,6 +223,10 @@ module.exports = {
                 count++;
             });
 
+            smartReadEvent.on(EVENT_ERROR, (data) => {
+                this.eventEmitter.emit(EVENT_ERROR, data)
+            });
+
             const tasks = entries
                 .filter(([_, v]) => Array.isArray(v.points) && v.points.length > 0)  // eslint-disable-line
                 .map(([k, v]) => ({

package/package.json

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

package/red-bacnet/discover_point.html

@@ -8,9 +8,9 @@
             discoverMode: { value: 0, required: true, validate: RED.validators.number() },
             readMethod: { value: 2, required: true, validate: RED.validators.number() },
             groupExportDeviceCount: { value: 30000, required: true, validate: RED.validators.number() },
-            maxConcurrentDeviceRead: { value: 3, required: true, validate: RED.validators.number() },
+            maxConcurrentDeviceRead: { value: 1, required: true, validate: RED.validators.number() },
             maxConcurrentSinglePointRead: { value: 10, required: true, validate: RED.validators.number() },
-            concurrentTaskDelay: { value: 10, required: true, validate: RED.validators.number() },
+            concurrentTaskDelay: { value: 0, required: true, validate: RED.validators.number() },
         },
         inputs: 1,
         outputs: 1,
@@ -52,7 +52,7 @@
     </div>
     <div class="form-row">
         <label for="node-input-maxConcurrentDeviceRead"><i class="fa fa-tag"></i> Max Concurrent Device Read</label>
-        <input type="number" id="node-input-maxConcurrentDeviceRead" placeholder="3" , min="1" , max="1000">
+        <input type="number" id="node-input-maxConcurrentDeviceRead" placeholder="1" , min="1" , max="1000">
     </div>
     <div class="form-row">
         <label for="node-input-maxConcurrentSinglePointRead"><i class="fa fa-tag"></i> Max Concurrent Single Point Read</label>
@@ -60,7 +60,7 @@
     </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">
+        <input type="number" id="node-input-concurrentTaskDelay" placeholder="0" min="0" max="10000">
     </div>
 </script>
 

package/red-bacnet/read_point.html

@@ -6,9 +6,9 @@
             name: { value: "" },
             client: { type: "bacnet client", required: true },
             readMethod: { value: 1, required: true, validate: RED.validators.number() },
-            maxConcurrentDeviceRead: { value: 3, required: true, validate: RED.validators.number() },
+            maxConcurrentDeviceRead: { value: 1, required: true, validate: RED.validators.number() },
             maxConcurrentSinglePointRead: { value: 10, required: true, validate: RED.validators.number() },
-            concurrentTaskDelay: { value: 10, required: true, validate: RED.validators.number() },
+            concurrentTaskDelay: { value: 0, required: true, validate: RED.validators.number() },
         },
         inputs: 1,
         outputs: 1,
@@ -33,13 +33,12 @@
         <label for="node-input-readMethod"><i class="fa fa-list"></i> Read Method</label>
         <select id="node-input-readMethod">
             <option value="0">Read Single Only</option>
-            <option value="1">Read Multiple Fallback Single</option>
-            <option value="2">Comprehensive Read</option>
+            <option value="1">Comprehensive Read</option>
         </select>
     </div>
     <div class="form-row">
         <label for="node-input-maxConcurrentDeviceRead"><i class="fa fa-tag"></i> Max Concurrent Device Read</label>
-        <input type="number" id="node-input-maxConcurrentDeviceRead" placeholder="3" , min="1" , max="1000">
+        <input type="number" id="node-input-maxConcurrentDeviceRead" placeholder="1" , min="1" , max="1000">
     </div>
     <div class="form-row">
         <label for="node-input-maxConcurrentSinglePointRead"><i class="fa fa-tag"></i> Max Concurrent Single Point
@@ -48,7 +47,7 @@
     </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">
+        <input type="number" id="node-input-concurrentTaskDelay" placeholder="0" , min="0" , max="10000">
     </div>
 </script>
 
@@ -62,8 +61,7 @@
 
             <dt>readMethod<span class="property-type">number</span></dt>
             <dd> <b>Read Single Only</b>: use <code>readProperty</code></dd>
-            <dd> <b>Read Multiple Fallback Single</b>: try <code>readPropertyMultiple</code> with consevative query size, fallback to <code>readProperty</code> if failed</dd>
-            <dd> <b>Comprehensive Read</b>: try <code>readPropertyMultiple</code> twice with high and conservative query size,fallback to <code>readProperty</code> if failed</dd>
+            <dd> <b>Comprehensive Read</b>: try <code>readPropertyMultiple</code>, reduce query size if failed, and fallback to <code>readProperty</code> if query size reduced to 1</dd>
 
             <dt>maxConcurrentDeviceRead<span class="property-type">number</span></dt>
             <dd> Devices count to discover simultaneously.</dd>

package/red-bacnet/write_point.html

@@ -5,8 +5,9 @@
         defaults: {
             name: { value: "" },
             client: { type: "bacnet client", required: true },
-            maxConcurrentDeviceWrite: { value: 3, required: true, validate: RED.validators.number() },
+            maxConcurrentDeviceWrite: { value: 1, required: true, validate: RED.validators.number() },
             maxConcurrentPointWrite: { value: 5, required: true, validate: RED.validators.number() },
+            concurrentTaskDelay: { value: 0, required: true, validate: RED.validators.number() },
         },
         inputs: 1,
         outputs: 1,
@@ -29,12 +30,16 @@
     </div>
     <div class="form-row">
         <label for="node-input-maxConcurrentDeviceWrite"><i class="fa fa-tag"></i> Max Concurrent Device Write</label>
-        <input type="number" id="node-input-maxConcurrentDeviceWrite" placeholder="3" , min="1" , max="1000">
+        <input type="number" id="node-input-maxConcurrentDeviceWrite" placeholder="1" , min="1" , max="1000">
     </div>
     <div class="form-row">
         <label for="node-input-maxConcurrentPointWrite"><i class="fa fa-tag"></i> Max Concurrent Point Write</label>
         <input type="number" id="node-input-maxConcurrentPointWrite" placeholder="5" , min="1" , max="1000">
     </div>
+    <div class="form-row">
+        <label for="node-input-concurrentTaskDelay"><i class="fa fa-tag"></i> Concurrent Task Delay</label>
+        <input type="number" id="node-input-concurrentTaskDelay" placeholder="0" , min="0" , max="10000">
+    </div>
 </script>
 
 <script type="text/html" data-help-name="write point">
@@ -52,6 +57,9 @@
             <dt>maxConcurrentPointWrite<span class="property-type">number</span></dt>
             <dd> Number of points to write simultaneously</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 delay writing</dd>
         </dl>
 
     <h3>Inputs</h3>
@@ -73,4 +81,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/write_point.js

@@ -23,6 +23,7 @@ module.exports = function (RED) {
             this.client = RED.nodes.getNode(config.client).instance;
             this.maxConcurrentDeviceWrite = +config.maxConcurrentDeviceWrite
             this.maxConcurrentPointWrite = +config.maxConcurrentPointWrite
+            this.concurrentTaskDelay = +config.concurrentTaskDelay
 
             // events
             this.#subscribeListeners();
@@ -45,7 +46,8 @@ module.exports = function (RED) {
                     msg.points,
                     msg.writePoints,
                     this.maxConcurrentDeviceWrite,
-                    this.maxConcurrentPointWrite
+                    this.maxConcurrentPointWrite,
+                    this.concurrentTaskDelay
                 );
 
                 this.job.addJob({
@@ -81,4 +83,3 @@ module.exports = function (RED) {
     // ----- register node -----
     RED.nodes.registerType('write point', WritePoint);
 }
-