@halsystems/red-bacnet 1.1.0 → 1.1.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [1.1.2]
+### Change
+- WritePoint to not fail if point not found in points config, only raise error
+
+## [1.1.1]
+### Added
+- Unit test for BACnet string points
+
+### Fixed
+- Reading offline device points run infinitely
+- Unit test failure
+
 ## [1.1.0]
 ### Changed
 - Implemented auto resize batch size when querying using readPropertyMultiple to improve performance

package/common/bacnet.js

@@ -115,7 +115,6 @@ module.exports = {
                     if (item?.type === 105) break
 
                     result.push(item);
-                    console.log(item)
                 } catch (err) {
                     void err
                     break;
@@ -155,13 +154,15 @@ module.exports = {
      *  maximum concurrent point to read in single read mode
      * @param {number} singleReadFailedRetry
      *  retry times for single read failed
+     * @param {number} concurrentTaskDelay
+     *  delay between concurrent tasks
      * @returns array of objects
      *  eg: [{type: 12, value: {type: 8, instance: 123}, ...],
      * @async
      */
     smartReadProperty: async function (
         client, device, reqArr, readMethod = 1, maxConcurrentSinglePointRead = 5,
-        singleReadFailedRetry = 5
+        singleReadFailedRetry = 5, concurrentTaskDelay = 50
     ) {
         /* reqArr example
         [{
@@ -182,8 +183,11 @@ module.exports = {
                 batchSizes.add(20);
             else {
                 const perValueBytes = [30] // typical numeric point is 17 byte
-                for (let x = 0; x < perValueBytes.length; x++)
-                    batchSizes.add(Math.trunc(device.maxApdu / perValueBytes[x]))
+                for (let x = 0; x < perValueBytes.length; x++) {
+                    let batchSize = Math.trunc(device.maxApdu / perValueBytes[x])
+                    if (batchSize > 0)
+                        batchSizes.add(batchSize)
+                }
             }
         }
 
@@ -261,7 +265,6 @@ module.exports = {
         if (!success) {
             let failedCount = 0
             let result_single = []
-
             const dummyEventEmitter = new EventEmitter();
             const tasks = reqArr.slice(reqArrIndexNext).flatMap((req, x) =>
                 req.properties.map((prop, y) => ({
@@ -285,7 +288,8 @@ module.exports = {
                             return value;
                         } catch (err) {
                             failedCount++;
-                            if (readMethod < 1 && failedCount >= singleReadFailedRetry)
+                            // if (readMethod < 1 && failedCount >= singleReadFailedRetry)
+                            if (failedCount >= singleReadFailedRetry)
                                 throw err
                         }
                     }
@@ -293,7 +297,7 @@ module.exports = {
             );
 
             try {
-                await concurrentTasks(dummyEventEmitter, tasks, maxConcurrentSinglePointRead);
+                await concurrentTasks(dummyEventEmitter, tasks, maxConcurrentSinglePointRead, concurrentTaskDelay);
             } catch (err) {
                 void err
             }
@@ -342,9 +346,14 @@ module.exports = {
      * @param {EventEmitter} eventEmitter
      * @param {number} maxConcurrentWrite
      *  maximum concurrent point to write
+     * @param {number} concurrentTaskDelay
+     *  delay between concurrent tasks
      * @async
      */
-    smartWriteProperty: async function (client, device, writePoints, eventEmitter, maxConcurrentWrite) {
+    smartWriteProperty: async function (
+        client, device, writePoints, eventEmitter, maxConcurrentWrite,
+        concurrentTaskDelay = 50
+    ) {
         const entries = Object.entries(writePoints);
 
         // current writePropertyMultiple will throw ERR_TIMEOUT if any of the write fails
@@ -370,7 +379,7 @@ module.exports = {
                 }
             }));
 
-        await concurrentTasks(eventEmitter, tasks, maxConcurrentWrite);
+        await concurrentTasks(eventEmitter, tasks, maxConcurrentWrite, concurrentTaskDelay);
 
         // write properties multiples example
         // const values = [

package/common/core/concurrent.js

@@ -17,10 +17,13 @@ module.exports = {
      * @param {EventEmitter} eventEmitter - The event emitter to emit events to.
      * @param {Array} tasks - The list of tasks to execute.
      * @param {number} maxConcurrent - The maximum number of concurrent tasks.
+     * @param {number} concurrentTaskDelay - The delay between concurrent tasks.
      * @returns {Promise<Array>} - A promise that resolves with an array of results.
      * @async
     */
-    concurrentTasks: async function (eventEmitter, tasks, maxConcurrent) {
+    concurrentTasks: async function (
+        eventEmitter, tasks, maxConcurrent, concurrentTaskDelay = 50
+    ) {
         const executing = new Set();
         const results = [];
 
@@ -44,7 +47,8 @@ module.exports = {
                 await Promise.race(executing);
             }
 
-            await delay(50)
+            if (concurrentTaskDelay > 0)
+                await delay(concurrentTaskDelay)
         }
 
         await Promise.allSettled(executing);

package/common/job/discover_point.js

@@ -53,7 +53,8 @@ module.exports = {
 
         constructor(
             client, eventEmitter, inputDevices, discoverMode, readMethod, groupExportDeviceCount,
-            maxConcurrentDeviceRead, maxConcurrentSinglePointRead, name = 'discover point'
+            maxConcurrentDeviceRead, maxConcurrentSinglePointRead, concurrentTaskDelay = 50,
+            name = 'discover point'
         ) {
             super();
             this.client = client
@@ -64,6 +65,7 @@ module.exports = {
             this.groupExportDeviceCount = groupExportDeviceCount
             this.maxConcurrentDeviceRead = maxConcurrentDeviceRead
             this.maxConcurrentSinglePointRead = maxConcurrentSinglePointRead
+            this.concurrentTaskDelay = concurrentTaskDelay
             this.name = name
         }
 
@@ -194,7 +196,7 @@ module.exports = {
 
                         return await readPoints(
                             d, objectListFinal, discoverPointEvent, this.name, this.client, this.readMethod,
-                            this.maxConcurrentSinglePointRead
+                            this.maxConcurrentSinglePointRead, this.concurrentTaskDelay
                         );
                     } catch (error) {
                         this.eventEmitter.emit(EVENT_ERROR, errMsg(this.name, `Error reading ${d.deviceName} points`, error));
@@ -237,7 +239,8 @@ module.exports = {
 
 // ---------------------------------- functions ----------------------------------
 const readPoints = async (
-    device, objects, eventEmitter, name, client, readMethod, maxConcurrentSinglePointRead
+    device, objects, eventEmitter, name, client, readMethod, maxConcurrentSinglePointRead,
+    concurrentTaskDelay
 ) => {
     const points = [];
 
@@ -258,7 +261,7 @@ const readPoints = async (
     try {
         // First request - get basic properties
         const result = await smartReadProperty(
-            client, device, reqArr, readMethod, maxConcurrentSinglePointRead, 50
+            client, device, reqArr, readMethod, maxConcurrentSinglePointRead, 50, concurrentTaskDelay
         );
 
         // Process basic properties first
@@ -279,7 +282,7 @@ const readPoints = async (
             try {
                 // Force use single read on state text to reduce loss especially long text
                 const stateTextResult = await smartReadProperty(
-                    client, device, stateTextReqArr, 0, 1, 50
+                    client, device, stateTextReqArr, 0, 1, 50, concurrentTaskDelay
                 );
 
                 // Update points with STATE_TEXT
@@ -374,7 +377,7 @@ const setPointValues = (point, i) => {
 
 const processValue = (value, facets) => {
     if (value?.errorClass != null && value?.errorCode != null) return null;
-    const match = facets.match(/precision:(\d+)/);
+    const match = facets?.match(/precision:(\d+)/);
     const precision = match ? +match[1] : null;
 
     if (typeof value === 'number')
@@ -382,4 +385,4 @@ const processValue = (value, facets) => {
     else
         return value
 
-};
+};

package/common/job/read_point.js

@@ -23,7 +23,7 @@ module.exports = {
 
         constructor(
             client, eventEmitter, devices, points, readMethod, maxConcurrentDeviceRead = 2,
-            maxConcurrentSinglePointRead = 5, name = 'read point'
+            maxConcurrentSinglePointRead = 5, concurrentTaskDelay = 50, name = 'read point'
         ) {
             super();
             this.client = client
@@ -33,6 +33,7 @@ module.exports = {
             this.readMethod = readMethod
             this.maxConcurrentDeviceRead = maxConcurrentDeviceRead
             this.maxConcurrentSinglePointRead = maxConcurrentSinglePointRead
+            this.concurrentTaskDelay = concurrentTaskDelay
             this.name = name
         }
 
@@ -219,7 +220,8 @@ module.exports = {
                 id: k,
                 task: async () => {
                     return await smartReadProperty(
-                        this.client, v.device, v.points, this.readMethod, this.maxConcurrentSinglePointRead
+                        this.client, v.device, v.points, this.readMethod,
+                        this.maxConcurrentSinglePointRead, 10, this.concurrentTaskDelay
                     );
                 }
             }));

package/common/job/write_point.js

@@ -25,6 +25,7 @@ module.exports = {
         constructor(
             client, eventEmitter, devices, points, writePoints,
             maxConcurrentDeviceWrite = 2, maxConcurrentPointWrite = 1,
+            concurrentTaskDelay = 50,
             name = 'write point'
         ) {
             super();
@@ -35,6 +36,7 @@ module.exports = {
             this.writePoints = writePoints
             this.maxConcurrentDeviceWrite = maxConcurrentDeviceWrite
             this.maxConcurrentPointWrite = maxConcurrentPointWrite
+            this.concurrentTaskDelay = concurrentTaskDelay
             this.name = name
         }
 
@@ -231,10 +233,14 @@ module.exports = {
             });
 
             if (missingPoints.length > 0) {
+                // do not fail writing, just log the missing points and remove them from writePoints
                 this.eventEmitter.emit(EVENT_ERROR, errMsg(
                     this.name, ERR_WRITE_POINT_NOT_FOUND, missingPoints
                 ))
-                return false
+
+                missingPoints.forEach(point => {
+                    delete this.writePointDetails[point];
+                });
             }
 
             if (priorityErrList.length > 0) {
@@ -277,7 +283,7 @@ module.exports = {
                     task: async () => {
                         return await smartWriteProperty(
                             this.client, v.device, v.writePoints, smartWriteEvent,
-                            this.maxConcurrentPointWrite
+                            this.maxConcurrentPointWrite, this.concurrentTaskDelay
                         );
                     }
                 }));
@@ -302,4 +308,4 @@ module.exports = {
         }
 
     }
-}
+}

package/ext/node-bacstack/dist/lib/bvlc.js

@@ -46,6 +46,7 @@ const decode = (buffer, offset) => {
                 if (isValidIp && isValidPort && !isBroadcast && !isMulticast && !isZero) {
                     const ip = ipParts.join(".");
                     linkAddress = (port === 47808) ? ip : `${ip}:${port}`;
+                    // linkAddress = `${ip}:${port}`;
                 }
             }
             break;

package/ext/node-bacstack/dist/lib/transport.js

@@ -14,6 +14,7 @@ class Transport extends events_1.EventEmitter {
             this._server.on('message', (msg, rinfo) => {
                 // NOTE HAL modified
                 const port = rinfo.port || DEFAULT_BACNET_PORT;
+                // this.emit('message', msg, `${rinfo.address}:${port}`);
                 if (port === DEFAULT_BACNET_PORT)
                     this.emit('message', msg, rinfo.address);
                 else

package/package.json

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