@halsystems/red-bacnet 2.2.0-alpha.0 → 2.2.0-alpha2

package/CHANGELOG.md

@@ -1,6 +1,18 @@
 # Changelog
 
-## [2.2.0]
+## [2.2.0-alpha.2]
+### Changed
+- all `nodes` retained original `msg` properties
+- `writePoint` emit `payload` with failed points after completion
+
+## [2.2.0-alpha.1]
+### Changed
+- `ConcorrentTasksWithNetworkAwareness` added `invoke-id` generator and tracking
+- `writePoint` output `msg.payload` about failed write points after completion, and `msg.result` about written points statistics
+- `discoverPoint` send output on every device discovery completed ([] if failed), removed `groupExportDeviceCount` feature and add `msg.device` to output
+- refactored all nodes to retain original `msg` properties
+
+## [2.2.0-alpha.0]
 ### Changed
 - `ConcurrentTask` changed to `ConcorrentTasksWithNetworkAwareness` round robin distributing task according to IP address to reduce congestion on a particular network
 

package/common/bacnet.js

@@ -10,7 +10,20 @@ 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')
 
+// ---------------------------------- helper functions ----------------------------------
+/**
+ * Apply invoke ID to options if getNextInvokeId function is provided
+ * @param {object} options - The options object to modify
+ * @param {Function} [getNextInvokeId] - Optional function to get the next invoke ID
+ */
+function applyInvokeId(options, getNextInvokeId) {
+    if (getNextInvokeId && typeof getNextInvokeId === 'function') {
+        options.invokeId = getNextInvokeId();
+    }
+}
+
 // ---------------------------------- type def ----------------------------------
+
 /**
  * @typedef {import('@root/ext/node-bacstack/dist/index.js').Client} BacnetClient
  */
@@ -32,17 +45,19 @@ module.exports = {
      *      vendorId: 36,
      *      deviceName: 'BMS'
      *  }
+     * @param {Function} [getNextInvokeId]
+     *  optional function to get the next invoke ID
      * @returns array of objects
      *  eg: [{type: 12, value: {type: 8, instance: 123}, ...],
      * @async
      */
-    readObjectList: async function (client, device) {
+    readObjectList: async function (client, device, getNextInvokeId) {
         const objectId = { type: baEnum.ObjectType.DEVICE, instance: device.deviceId };
         const propertyId = baEnum.PropertyIdentifier.OBJECT_LIST;
 
-        let result = await module.exports.readPropertyMultipleReturnArr(client, device, objectId, propertyId);
+        let result = await module.exports.readPropertyMultipleReturnArr(client, device, objectId, propertyId, getNextInvokeId);
         if (result.length == 0) {
-            result = await module.exports.readPropertyReturnArr(client, device, objectId, propertyId);
+            result = await module.exports.readPropertyReturnArr(client, device, objectId, propertyId, getNextInvokeId);
         }
 
         return result;
@@ -55,10 +70,12 @@ module.exports = {
      * @param {object} device
      * @param {object} objectId
      * @param {number} propertyId
+     * @param {Function} [getNextInvokeId]
+     *  optional function to get the next invoke ID
      * @returns array of objects
      * @async
      */
-    readPropertyMultipleReturnArr: async function (client, device, objectId, propertyId) {
+    readPropertyMultipleReturnArr: async function (client, device, objectId, propertyId, getNextInvokeId) {
         let addressSet = device.ipAddress;
         if (device.macAddress != null && device.network != null) {
             addressSet = {
@@ -82,10 +99,14 @@ module.exports = {
             }];
 
             return new Promise((resolve, reject) => {
+                const options = { maxApdu: device.maxApdu };
+                applyInvokeId(options, getNextInvokeId);
+
                 client.readPropertyMultiple(
+
                     addressSet,
                     reqArr,
-                    { maxApdu: device.maxApdu },
+                    options,
                     (err, value) => {
                         if (err) return reject(err);
                         resolve(value);
@@ -156,13 +177,15 @@ module.exports = {
      *  retry times for single read failed
      * @param {number} concurrentTaskDelay
      *  delay between concurrent tasks
+     * @param {Function} [getNextInvokeId]
+     *  optional function to get the next invoke ID
      * @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, concurrentTaskDelay = 50
+        singleReadFailedRetry = 5, concurrentTaskDelay = 50, getNextInvokeId
     ) {
         /* reqArr example
         [{
@@ -226,7 +249,7 @@ module.exports = {
                 } while (!batchFull)
 
                 // read batch block
-                const value = await module.exports.readPropertyMultple(client, device, reqArrBatch)
+                const value = await module.exports.readPropertyMultple(client, device, reqArrBatch, getNextInvokeId)
                     .catch(() => {
                         // Reduce batch size by half (minimum 1)
                         currBatchSize = Math.max(1, Math.floor(currBatchSize / 2))
@@ -274,7 +297,7 @@ module.exports = {
                     id: `${x}-${y}`,
                     task: async () => {
                         try {
-                            let value = await module.exports.readProperty(client, device, req.objectId, prop.id);
+                            let value = await module.exports.readProperty(client, device, req.objectId, prop.id, getNextInvokeId);
 
                             if (value == null) {
                                 value = {
@@ -351,11 +374,13 @@ module.exports = {
      *  maximum concurrent point to write
      * @param {number} concurrentTaskDelay
      *  delay between concurrent tasks
+     * @param {Function} [getNextInvokeId]
+     *  optional function to get the next invoke ID
      * @async
      */
     smartWriteProperty: async function (
         client, device, writePoints, eventEmitter, maxConcurrentWrite,
-        concurrentTaskDelay = 50
+        concurrentTaskDelay = 50, getNextInvokeId
     ) {
         const entries = Object.entries(writePoints);
 
@@ -373,10 +398,16 @@ module.exports = {
                             { type: point.bacType, instance: point.bacInstance },
                             point.bacProp,
                             [{ type: point.valueType, value: point.value }],
-                            point.priority
+                            point.priority,
+                            getNextInvokeId
                         );
                     } catch (err) {
-                        eventEmitter.emit(EVENT_ERROR, { id: id, error: getErrMsg(err) });
+                        eventEmitter.emit(EVENT_ERROR, {
+                            point: {
+                                [point.id]: point.value
+                            },
+                            error: getErrMsg(err)
+                        });
                     }
                     return
                 }
@@ -416,12 +447,14 @@ module.exports = {
      *  eg:{ type: 2, instance: 1 }
      * @param {number} propertyId
      *  eg: 85
+     * @param {Function} [getNextInvokeId]
+     *  optional function to get the next invoke ID
      * @returns object
      *  eg: { len: 11, objectId: { type: 19, instance: 1 },
      *      property: { id: 85, index: 4294967295 }, values: [ { type: 2, value: 3 }]}
      * @async
      */
-    readProperty: async function (client, device, objectId, propertyId) {
+    readProperty: async function (client, device, objectId, propertyId, getNextInvokeId) {
         let addressSet = device.ipAddress
         if (device.macAddress != null && device.network != null) {
             addressSet = {
@@ -432,17 +465,21 @@ module.exports = {
         }
 
         return new Promise((resolve, reject) => {
+            const options = { maxApdu: device.maxApdu };
+            applyInvokeId(options, getNextInvokeId);
+
             client.readProperty(
                 addressSet,
                 objectId,
                 propertyId,
-                { maxApdu: device.maxApdu },
+                options,
                 (err, value) => {
                     if (err)
                         reject(err);
                     else
                         resolve(value);
-                });
+                }
+            );
         });
     },
 
@@ -456,11 +493,13 @@ module.exports = {
      *  eg:{ type: 2, instance: 1 }
      * @param {number} propertyId
      *  eg: 85
+     * @param {Function} [getNextInvokeId]
+     *  optional function to get the next invoke ID
      * @returns array of objects
      *  eg: [{type: 12, value: {type: 8, instance: 123}, ...],
      * @async
      */
-    readPropertyReturnArr: async function (client, device, objectId, propertyId) {
+    readPropertyReturnArr: async function (client, device, objectId, propertyId, getNextInvokeId) {
         const result = [];
 
         let addressSet = device.ipAddress
@@ -474,10 +513,14 @@ module.exports = {
 
         async function readPropertyPart(index) {
             return new Promise((resolve, reject) => {
-                client.readProperty(addressSet,
+                const options = { maxApdu: device.maxApdu, arrayIndex: index };
+                applyInvokeId(options, getNextInvokeId);
+
+                client.readProperty(
+                    addressSet,
                     objectId,
                     propertyId,
-                    { maxApdu: device.maxApdu, arrayIndex: index },
+                    options,
                     (err, value) => {
                         if (err) {
                             if (index === 1)
@@ -493,7 +536,8 @@ module.exports = {
                                 readPropertyPart(index + 1).then(resolve).catch(reject);
                             }
                         }
-                    });
+                    }
+                );
             });
         }
 
@@ -512,6 +556,8 @@ module.exports = {
      *      properties: [ { id: 85 }, ... ]
      *  },
      *  ...]
+     * @param {Function} [getNextInvokeId]
+     *  optional function to get the next invoke ID
      * @returns object
      *  eg: {"len":1937,"values":[{
      *      "objectId":{"type":3,"instance":0},
@@ -519,7 +565,7 @@ module.exports = {
      * ...}]}
      * @async
      */
-    readPropertyMultple: async function (client, device, reqArr) {
+    readPropertyMultple: async function (client, device, reqArr, getNextInvokeId) {
         let addressSet = device.ipAddress
         if (device.macAddress != null && device.network != null) {
             addressSet = {
@@ -530,16 +576,20 @@ module.exports = {
         }
 
         return new Promise((resolve, reject) => {
+            const options = { maxApdu: device.maxApdu };
+            applyInvokeId(options, getNextInvokeId);
+
             client.readPropertyMultiple(
                 addressSet,
                 reqArr,
-                { maxApdu: device.maxApdu },
+                options,
                 (err, value) => {
                     if (err)
                         reject(err);
                     else
                         resolve(value);
-                });
+                }
+            );
         });
     },
 
@@ -557,10 +607,12 @@ module.exports = {
      *  eg:[{type: 2, value: 3}]
      * @param {number} priority
      *  eg: 8
+     * @param {Function} [getNextInvokeId]
+     *  optional function to get the next invoke ID
      * @returns true / undefined: true if success, else undefined
      * @async
      */
-    writeProperty: async function (client, device, objectId, propertyId, writeValue, priority) {
+    writeProperty: async function (client, device, objectId, propertyId, writeValue, priority, getNextInvokeId) {
         let addressSet = device.ipAddress
         if (device.macAddress != null && device.network != null) {
             addressSet = {
@@ -576,6 +628,7 @@ module.exports = {
             if (priority !== null && priority !== undefined) {
                 options.priority = priority;
             }
+            applyInvokeId(options, getNextInvokeId);
 
             client.writeProperty(
                 addressSet,

package/common/core/concurrent.js

@@ -59,10 +59,11 @@ module.exports = {
      * Executes a list of tasks concurrently with IP address awareness.
      * Tasks targeting the same IP address will execute sequentially.
      * Tasks targeting different IP addresses can execute in parallel.
+     * Invoke IDs are automatically managed per-task to avoid collisions.
      *
      * @param {EventEmitter} eventEmitter - The event emitter to emit events to.
      * @param {Array} tasks - The list of tasks to execute. Each task should have:
-     *                        { id, device: { ipAddress, ... }, task: async () => {...} }
+     *                        { id, device: { ipAddress, ... }, task: async (getNextInvokeId) => {...} }
      * @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.
@@ -75,6 +76,10 @@ module.exports = {
         const results = [];
         const ipAddressInUse = new Set(); // Track which IPs are currently executing
 
+        // Create a sequential invoke ID generator with tracking
+        let invokeIdCounter = 1;
+        const invokeIdsInUse = new Set(); // Track which invoke IDs are currently in use
+
         // Pending tasks that have not been started yet.
         // We keep them in a list and remove them once scheduled so that a
         // task blocked by a busy IP never blocks later tasks with free IPs.
@@ -88,6 +93,7 @@ module.exports = {
         /**
          * Start a single task and wire up its lifecycle. When the task settles
          * it releases its IP so waiting tasks targeting the same IP can run.
+         * Creates a per-task invoke ID generator that tracks and releases IDs.
          *
          * @param {{id: any, task: Function, ipAddress: string|null}} item
          */
@@ -95,7 +101,38 @@ module.exports = {
             const { id, task, ipAddress } = item;
             if (ipAddress) ipAddressInUse.add(ipAddress);
 
-            const promise = task()
+            // Track invoke IDs issued to this specific task
+            const taskInvokeIds = new Set();
+
+            // Create a task-scoped getNextInvokeId function that:
+            // 1. Finds the next available invoke ID (1-255)
+            // 2. Skips IDs already in use
+            // 3. Tracks the ID for later release
+            const taskGetNextInvokeId = () => {
+                let attempts = 0;
+                while (attempts < 255) {
+                    const candidateId = invokeIdCounter++;
+                    if (invokeIdCounter > 255) invokeIdCounter = 1;
+
+                    // If this ID is not in use, claim it
+                    if (!invokeIdsInUse.has(candidateId)) {
+                        invokeIdsInUse.add(candidateId);
+                        taskInvokeIds.add(candidateId);
+                        return candidateId;
+                    }
+                    attempts++;
+                }
+
+                // Fallback: if all 255 IDs are exhausted (shouldn't happen with proper concurrency limits),
+                // just return the next ID anyway
+                const fallbackId = invokeIdCounter++;
+                if (invokeIdCounter > 255) invokeIdCounter = 1;
+                invokeIdsInUse.add(fallbackId);
+                taskInvokeIds.add(fallbackId);
+                return fallbackId;
+            };
+
+            const promise = task(taskGetNextInvokeId)
                 .then(result => {
                     eventEmitter.emit(EVENT_OUTPUT, { id, result });
                     results.push({ id, result });
@@ -108,6 +145,10 @@ module.exports = {
                     executing.delete(promise);
                     // Release the IP address so waiting tasks can run
                     if (ipAddress) ipAddressInUse.delete(ipAddress);
+                    // Release all invoke IDs that were issued to this task
+                    for (const invokeId of taskInvokeIds) {
+                        invokeIdsInUse.delete(invokeId);
+                    }
                 });
 
             executing.add(promise);

package/common/job/discover_device.js

@@ -27,18 +27,20 @@ module.exports = {
          * Construct a DiscoverDeviceJob.
          * @param {BacnetClient} client - Bacnet client to use for the discovery.
          * @param {EventEmitter} eventEmitter - Status and error event emitter.
+         * @param {Object} msg - Original incoming message.
          * @param {number} network - Network to discover devices on, eg: 65535 / 1 / 1001
          * @param {number} lowLimit - Low limit of the network range.
          * @param {number} highLimit - High limit of the network range.
          * @param {number} whoIsTimeout - Who is request timeout in milliseconds.
          */
         constructor(
-            client, eventEmitter, network, lowLimit, highLimit, whoIsTimeout,
+            client, eventEmitter, msg, network, lowLimit, highLimit, whoIsTimeout,
             name = 'discover device'
         ) {
             super();
             this.client = client
             this.eventEmitter = eventEmitter
+            this.msg = msg
             this.network = network
             this.lowLimit = lowLimit
             this.highLimit = highLimit
@@ -86,7 +88,8 @@ module.exports = {
                                 validatedDevices.push(result);
                             }
 
-                            this.eventEmitter.emit(EVENT_OUTPUT, validatedDevices);
+                            this.msg.payload = validatedDevices;
+                            this.eventEmitter.emit(EVENT_OUTPUT, this.msg);
                             this.#updateProgress(100)
                             resolve();
                         }).catch(error => {
@@ -146,8 +149,7 @@ module.exports = {
                 const deviceInfo = await readDeviceName(d, addressSet);
                 this.discoveredDevices.push(deviceInfo);
 
-                // throttle to avoid bursts
-                await delay(75); // tweak between 50–150ms
+                await delay(50);
                 this.#updateProgress(
                     Math.min(90, Math.round((80 / this.discoverList.length) * (i + 1) + 10))
                 );
@@ -188,4 +190,4 @@ module.exports = {
             this.eventEmitter.emit(EVENT_UPDATE_STATUS, progress);
         }
     },
-}
+}

package/common/job/discover_point.js

@@ -53,20 +53,19 @@ const supportedObjectTypes = [
 module.exports = {
     DiscoverPointJob: class DiscoverPointJob extends BaseJob {
         devices = [];
-        pointsList = [];
 
         constructor(
-            client, eventEmitter, inputDevices, discoverMode, readMethod, groupExportDeviceCount,
+            client, eventEmitter, msg, discoverMode, readMethod,
             maxConcurrentDeviceRead, maxConcurrentSinglePointRead, concurrentTaskDelay = 50,
             name = 'discover point'
         ) {
             super();
             this.client = client
             this.eventEmitter = eventEmitter
-            this.inputDevices = inputDevices
+            this.msg = msg
+            this.inputDevices = msg?.devices
             this.discoverMode = discoverMode
             this.readMethod = readMethod
-            this.groupExportDeviceCount = groupExportDeviceCount
             this.maxConcurrentDeviceRead = maxConcurrentDeviceRead
             this.maxConcurrentSinglePointRead = maxConcurrentSinglePointRead
             this.concurrentTaskDelay = concurrentTaskDelay
@@ -74,7 +73,7 @@ module.exports = {
         }
 
         async execute() {
-            this.#updateProgress(0)
+            this.#updateProgress('discovering')
 
             return new Promise((resolve) => {
                 try {
@@ -88,7 +87,7 @@ module.exports = {
                                 example: EG_BACNET_DEVICES
                             })
                         )
-                        this.#updateProgress(100)
+                        this.#updateProgress('completed')
                         resolve();
                         return
                     }
@@ -124,14 +123,16 @@ module.exports = {
                         this.devices.push(result);
                     }
 
-                    this.#updateProgress(10)
+                    // If no valid devices, complete immediately
+                    if (this.devices.length === 0) {
+                        this.#updateProgress('completed')
+                        resolve();
+                        return
+                    }
 
                     // read all device points
                     this.#readAllDevicePoints().then(() => {
-                        if (this.pointsList.length > 0)
-                            this.#exportPoints();
-
-                        this.#updateProgress(100)
+                        this.#updateProgress('completed')
                         resolve();
                     });
                 } catch (err) {
@@ -145,23 +146,17 @@ module.exports = {
             const discoverPointEvent = new EventEmitter();
             const size = this.devices.length;
             let count = 0;
-            let discoveredDevices = 0
 
             discoverPointEvent.on(EVENT_OUTPUT, (data) => {
-                this.#updateProgress(
-                    Math.round((85 / size) * (count + 1) + 10)
-                )
-
-                if (Array.isArray(data.result))
-                    this.pointsList.push(...data.result);
-
                 count++;
-                discoveredDevices++;
-
-                if (discoveredDevices >= this.groupExportDeviceCount) {
-                    this.#exportPoints();
-                    discoveredDevices = 0
+                // Export points immediately after each device is discovered
+                if (Array.isArray(data.result?.points)) {
+                    this.#exportPoints(data.result?.points, data.result?.device);
+                } else {
+                    // Export empty array if no points discovered
+                    this.#exportPoints([], data.result?.device);
                 }
+                this.#updateProgress(count, size);
             });
 
             discoverPointEvent.on(EVENT_ERROR, (data) => {
@@ -171,13 +166,15 @@ module.exports = {
             const tasks = this.devices.map((d, i) => ({
                 id: d.deviceName,
                 device: d,
-                task: async () => {
+                task: async (getNextInvokeId) => {
                     void i
                     try {
-                        const objectList = await readObjectList(this.client, d);
+                        const objectList = await readObjectList(this.client, d, getNextInvokeId);
 
                         // istanbul ignore next
-                        if (objectList == null) return;
+                        if (objectList == null) {
+                            return { device: d, points: [] }
+                        }
 
                         let objectListFinal = objectList
                             .map(obj => {
@@ -206,10 +203,11 @@ module.exports = {
 
                         return await readPoints(
                             d, objectListFinal, discoverPointEvent, this.name, this.client, this.readMethod,
-                            this.maxConcurrentSinglePointRead, this.concurrentTaskDelay
+                            this.maxConcurrentSinglePointRead, this.concurrentTaskDelay, getNextInvokeId
                         );
                     } catch (error) {
                         this.eventEmitter.emit(EVENT_ERROR, errMsg(this.name, `Error reading ${d.deviceName} points`, error));
+                        return { device: d, points: [] }
                     }
                 }
             }));
@@ -217,22 +215,30 @@ module.exports = {
             await concurrentTasksWithNetworkAwareness(discoverPointEvent, tasks, this.maxConcurrentDeviceRead);
         }
 
-        #updateProgress(progress) {
-            this.eventEmitter.emit(EVENT_UPDATE_STATUS, progress);
+        #updateProgress(discovered, total) {
+            let message;
+            if (typeof discovered === 'string') {
+                // discovered is a status message like 'initializing' or 'completed'
+                message = discovered;
+            } else {
+                // discovered and total are numbers
+                message = `discovered: ${discovered}/${total}`;
+            }
+            this.eventEmitter.emit(EVENT_UPDATE_STATUS, message);
         }
 
-        #exportPoints() {
+        #exportPoints(points, device) {
             let exportPointsList = [];
-            for (let i = 0; i < this.pointsList.length; i++) {
+            for (let i = 0; i < points.length; i++) {
                 const { error, value: result } = bacnetPointSchema.validate(
-                    this.pointsList[i], { stripUnknown: true }
+                    points[i], { stripUnknown: true }
                 );
                 // istanbul ignore next
                 {
                     if (error) {
                         this.eventEmitter.emit(EVENT_ERROR, errMsg(
                             this.name, ERR_SCHEMA_VALIDATION, {
-                            bacnetPoint: this.pointsList[i],
+                            bacnetPoint: points[i],
                             error: error,
                         }));
                         continue
@@ -241,8 +247,9 @@ module.exports = {
                 exportPointsList.push(result);
             }
 
-            this.eventEmitter.emit(EVENT_OUTPUT, exportPointsList);
-            this.pointsList = [];
+            this.msg.payload = exportPointsList;
+            this.msg.device = device;
+            this.eventEmitter.emit(EVENT_OUTPUT, this.msg);
         }
     }
 }
@@ -250,7 +257,7 @@ module.exports = {
 // ---------------------------------- functions ----------------------------------
 const readPoints = async (
     device, objects, eventEmitter, name, client, readMethod, maxConcurrentSinglePointRead,
-    concurrentTaskDelay
+    concurrentTaskDelay, getNextInvokeId
 ) => {
     const points = [];
 
@@ -271,7 +278,7 @@ const readPoints = async (
     try {
         // First request - get basic properties
         const result = await smartReadProperty(
-            client, device, reqArr, readMethod, maxConcurrentSinglePointRead, 50, concurrentTaskDelay
+            client, device, reqArr, readMethod, maxConcurrentSinglePointRead, 50, concurrentTaskDelay, getNextInvokeId
         );
 
         // Process basic properties first
@@ -292,7 +299,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, concurrentTaskDelay
+                    client, device, stateTextReqArr, 0, 1, 50, concurrentTaskDelay, getNextInvokeId
                 );
 
                 // Update points with STATE_TEXT
@@ -315,11 +322,10 @@ const readPoints = async (
                 ));
             }
         }
-
-        return points;
     } catch (error) {
         eventEmitter.emit(EVENT_ERROR, errMsg(name, ERR_READING_POINTS, error));
     }
+    return { device: device, points: points }
 };
 
 const updatePointWithStateText = (point, stateTextData) => {

package/common/job/read_point.js

@@ -22,14 +22,15 @@ module.exports = {
         devicePointSeparator = '.';
 
         constructor(
-            client, eventEmitter, devices, points, readMethod, maxConcurrentDeviceRead = 2,
+            client, eventEmitter, msg, readMethod, maxConcurrentDeviceRead = 2,
             maxConcurrentSinglePointRead = 5, concurrentTaskDelay = 50, name = 'read point'
         ) {
             super();
             this.client = client
             this.eventEmitter = eventEmitter
-            this.devices = devices
-            this.points = points
+            this.msg = msg
+            this.devices = msg?.devices
+            this.points = msg?.points
             this.readMethod = readMethod
             this.maxConcurrentDeviceRead = maxConcurrentDeviceRead
             this.maxConcurrentSinglePointRead = maxConcurrentSinglePointRead
@@ -232,10 +233,10 @@ module.exports = {
                 .map(([k, v]) => ({
                     id: k,
                     device: v.device,
-                    task: async () => {
+                    task: async (getNextInvokeId) => {
                         return await smartReadProperty(
                             this.client, v.device, v.points, this.readMethod,
-                            this.maxConcurrentSinglePointRead, 10, this.concurrentTaskDelay
+                            this.maxConcurrentSinglePointRead, 10, this.concurrentTaskDelay, getNextInvokeId
                         );
                     }
                 }));
@@ -311,7 +312,8 @@ module.exports = {
                 exportPoints[k] = result;
             }
 
-            this.eventEmitter.emit(EVENT_OUTPUT, exportPoints);
+            this.msg.payload = exportPoints;
+            this.eventEmitter.emit(EVENT_OUTPUT, this.msg);
         }
     }
-}
+}

package/common/job/write_point.js

@@ -20,10 +20,11 @@ const {
 module.exports = {
     WritePointJob: class WritePointJob extends BaseJob {
         writePointDetails = {}
+        failedPoints = {}
         devicePointSeparator = '.';
 
         constructor(
-            client, eventEmitter, devices, points, writePoints,
+            client, eventEmitter, msg,
             maxConcurrentDeviceWrite = 2, maxConcurrentPointWrite = 1,
             concurrentTaskDelay = 50,
             name = 'write point'
@@ -31,9 +32,10 @@ module.exports = {
             super();
             this.client = client
             this.eventEmitter = eventEmitter
-            this.devices = devices
-            this.points = points
-            this.writePoints = writePoints
+            this.msg = msg
+            this.devices = msg?.devices
+            this.points = msg?.points
+            this.writePoints = msg?.writePoints
             this.maxConcurrentDeviceWrite = maxConcurrentDeviceWrite
             this.maxConcurrentPointWrite = maxConcurrentPointWrite
             this.concurrentTaskDelay = concurrentTaskDelay
@@ -175,14 +177,7 @@ module.exports = {
                 }
 
                 // add point details
-                pointDetails[id] = {
-                    deviceName: p.deviceName,
-                    bacType: p.bacType,
-                    bacInstance: p.bacInstance,
-                    bacProp: p.bacProp,
-                    valueType: p.valueType,
-                    priority: p.priority
-                }
+                pointDetails[id] = { ...p };
             });
 
             if (pointSchemaErrList.length > 0) {
@@ -287,10 +282,10 @@ module.exports = {
                 .map(([k, v]) => ({
                     id: k,
                     device: v.device,
-                    task: async () => {
+                    task: async (getNextInvokeId) => {
                         return await smartWriteProperty(
                             this.client, v.device, v.writePoints, smartWriteEvent,
-                            this.maxConcurrentPointWrite, this.concurrentTaskDelay
+                            this.maxConcurrentPointWrite, this.concurrentTaskDelay, getNextInvokeId
                         );
                     }
                 }));
@@ -306,13 +301,22 @@ module.exports = {
             });
 
             smartWriteEvent.on(EVENT_ERROR, (data) => {
+                Object.assign(this.failedPoints, data.point);
                 this.eventEmitter.emit(EVENT_ERROR, errMsg(
                     this.name, ERR_WRITING_POINT, data
                 ));
             });
 
             await concurrentTasksWithNetworkAwareness(smartWriteEvent, tasks, this.maxConcurrentDeviceWrite);
+
+            // emit output with msg containing failed points and results
+            this.#exportWriteResults();
         }
 
+        #exportWriteResults() {
+            // Update msg with results
+            this.msg.payload = this.failedPoints;
+            this.eventEmitter.emit(EVENT_OUTPUT, this.msg);
+        }
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@halsystems/red-bacnet",
-  "version": "2.2.0-alpha.0",
+  "version": "2.2.0-alpha2",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"

package/red-bacnet/discover_device.js

@@ -42,6 +42,7 @@ module.exports = function (RED) {
             this.task = new DiscoverDeviceJob(
                 this.client,
                 this.#eventEmitter,
+                null,
                 this.network,
                 this.lowLimit,
                 this.highLimit,
@@ -72,12 +73,14 @@ module.exports = function (RED) {
                 this.task.network = (msg.network === undefined) ? this.network : msg.network;
                 this.task.lowLimit = (msg.lowLimit === undefined) ? this.lowLimit : msg.lowLimit;
                 this.task.highLimit = (msg.highLimit === undefined) ? this.highLimit : msg.highLimit;
+                this.task.msg = msg;
 
                 this.job.addJob({
                     id: jobId,
                     task: this.task,
                     priority: Number.isFinite(msg.priority) ? msg.priority : 5,
                 });
+
                 // @ts-ignore
                 this.status({ fill: 'yellow', shape: 'dot', text: `in queue` });
             });
@@ -87,10 +90,7 @@ module.exports = function (RED) {
                 this.task.onStop();
             })
 
-            this.#eventEmitter.on(EVENT_OUTPUT, (data) => {
-                const msg = {
-                    payload: data
-                };
+            this.#eventEmitter.on(EVENT_OUTPUT, (msg) => {
                 // @ts-ignore
                 this.send(msg);
             });
@@ -114,4 +114,3 @@ module.exports = function (RED) {
     // ----- register node -----
     RED.nodes.registerType('discover device', DiscoverDevice);
 }
-

package/red-bacnet/discover_point.html

@@ -7,7 +7,6 @@
             client: { type: "bacnet client", required: true },
             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: 1, required: true, validate: RED.validators.number() },
             maxConcurrentSinglePointRead: { value: 10, required: true, validate: RED.validators.number() },
             concurrentTaskDelay: { value: 0, required: true, validate: RED.validators.number() },
@@ -46,10 +45,6 @@
             <option value="1">Comprehensive Read</option>
         </select>
     </div>
-    <div class="form-row">
-        <label for="node-input-groupExportDeviceCount"><i class="fa fa-tag"></i> Group Export Device Count</label>
-        <input type="number" id="node-input-groupExportDeviceCount" placeholder="50", min="10", max="1000">
-    </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="1" , min="1" , max="1000">
@@ -81,9 +76,6 @@
         <dd> <b>Read Single Only</b>: use <code>readProperty</code></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>groupExportDeviceCount<span class="property-type">number</span></dt>
-        <dd> Emit <code>msg.payload</code> once discovered devices count reaches this limit</dd>
-
         <dt>maxConcurrentDeviceRead<span class="property-type">number</span></dt>
         <dd> Devices count to discover simultaneously.</dd>
         <dd> <b> USE WITH CAUTION!</b> Reduce to low value on a slow network</dd>
@@ -103,7 +95,7 @@
             <dt class="optional">msg.id <span class="property-type">string | number</span></dt>
                 <dd> Job ID. Default to <code>discoverPoints</code> if not provided.</dd>
             <dt class="optional">msg.priority <span class="property-type">number</span></dt>
-                <dd> Job priority in queue. Default to <code>5</code> if not provided.</dd>
+            <dd> Job priority in queue. Default to <code>5</code> if not provided.</dd>
         </dl>
 
     <h3>Outputs</h3>

package/red-bacnet/discover_point.js

@@ -24,7 +24,6 @@ module.exports = function (RED) {
             this.client = RED.nodes.getNode(config.client).instance;
             this.discoverMode = +config.discoverMode
             this.readMethod = +config.readMethod
-            this.groupExportDeviceCount = +config.groupExportDeviceCount
             this.maxConcurrentDeviceRead = +config.maxConcurrentDeviceRead
             this.maxConcurrentSinglePointRead = +config.maxConcurrentSinglePointRead
             this.concurrentTaskDelay = +config.concurrentTaskDelay
@@ -54,8 +53,8 @@ module.exports = function (RED) {
                 }
 
                 const task = new DiscoverPointJob(
-                    this.client, this.#eventEmitter, msg?.devices, this.discoverMode, this.readMethod,
-                    this.groupExportDeviceCount, this.maxConcurrentDeviceRead,
+                    this.client, this.#eventEmitter, msg, this.discoverMode, this.readMethod,
+                    this.maxConcurrentDeviceRead,
                     this.maxConcurrentSinglePointRead, this.concurrentTaskDelay
                 );
 
@@ -68,21 +67,18 @@ module.exports = function (RED) {
                 this.status({ fill: 'yellow', shape: 'dot', text: `in queue` });
             });
 
-            this.#eventEmitter.on(EVENT_OUTPUT, (data) => {
-                const msg = {
-                    payload: data
-                };
+            this.#eventEmitter.on(EVENT_OUTPUT, (msg) => {
                 // @ts-ignore
                 this.send(msg);
             });
 
             this.#eventEmitter.on(EVENT_UPDATE_STATUS, (msg) => {
-                if (msg === 100)
+                if (msg === 'completed')
                     // @ts-ignore
                     this.status({ fill: 'green', shape: 'dot', text: `completed: ${nowFormatted()}` });
                 else
                     // @ts-ignore
-                    this.status({ fill: 'yellow', shape: 'dot', text: `progress: ${msg} %` });
+                    this.status({ fill: 'yellow', shape: 'dot', text: `${msg}` });
             });
 
             this.#eventEmitter.on(EVENT_ERROR, (err) => {

package/red-bacnet/read_point.html

@@ -91,7 +91,7 @@
             <dd> Job ID. Default to <code>readPoints</code> if not provided.</dd>
 
             <dt class="optional">msg.priority <span class="property-type">number</span></dt>
-            <dd> Job priority in queue. Default to <code>2</code> if not provided.</dd>
+            <dd> Job priority in queue. Default to <code>3</code> if not provided.</dd>
         </dl>
 
     <h3>Outputs</h3>

package/red-bacnet/read_point.js

@@ -44,38 +44,34 @@ module.exports = function (RED) {
             */
             // @ts-ignore
             this.on(EVENT_INPUT, async function (msg) {
+                const jobId = (typeof msg.id === 'string' || typeof msg.id === 'number') ? msg.id : this.jobId;
+
+                if (this.job.queue.map(item => item.id).includes(jobId)) {
+                    // @ts-ignore
+                    print(`Coalesced job: ${jobId}`, true)
+                    return;
+                }
+
                 const task = new ReadPointJob(
                     this.client,
                     this.#eventEmitter,
-                    msg.devices,
-                    msg.points,
+                    msg,
                     this.readMethod,
                     this.maxConcurrentDeviceRead,
                     this.maxConcurrentSinglePointRead,
                     this.concurrentTaskDelay
                 );
 
-                const jobId = (typeof msg.id === 'string' || typeof msg.id === 'number') ? msg.id : this.jobId;
-
-                if (this.job.queue.map(item => item.id).includes(jobId)) {
-                    // @ts-ignore
-                    print(`Coalesced job: ${jobId}`, true)
-                    return;
-                }
-
                 this.job.addJob({
                     id: jobId,
                     task: task,
-                    priority: Number.isFinite(msg.priority) ? msg.priority : 2,
+                    priority: Number.isFinite(msg.priority) ? msg.priority : 3,
                 });
                 // @ts-ignore
                 this.status({ fill: 'yellow', shape: 'dot', text: `in queue` });
             });
 
-            this.#eventEmitter.on(EVENT_OUTPUT, (data) => {
-                const msg = {
-                    payload: data
-                };
+            this.#eventEmitter.on(EVENT_OUTPUT, (msg) => {
                 // @ts-ignore
                 this.send(msg);
             });

package/red-bacnet/write_point.html

@@ -37,7 +37,7 @@
         <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>
+        <label for="node-input-concurrentTaskDelay"><i class="fa fa-tag"></i> Concurrent Task Delay (ms)</label>
         <input type="number" id="node-input-concurrentTaskDelay" placeholder="0" , min="0" , max="10000">
     </div>
 </script>
@@ -82,6 +82,12 @@
             <dd> Job priority in queue. Default to <code>2</code> if not provided.</dd>
         </dl>
 
+    <h3>Outputs</h3>
+    <dl class="message-properties">
+        <dt>msg.payload <span class="property-type">object</span></dt>
+        <dd>Failed to write points.</dd>
+    </dl>
+
     <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>

package/red-bacnet/write_point.js

@@ -43,16 +43,6 @@ module.exports = function (RED) {
             */
             // @ts-ignore
             this.on(EVENT_INPUT, async function (msg) {
-                const task = new WritePointJob(
-                    this.client,
-                    this.#eventEmitter,
-                    msg.devices,
-                    msg.points,
-                    msg.writePoints,
-                    this.maxConcurrentDeviceWrite,
-                    this.maxConcurrentPointWrite,
-                    this.concurrentTaskDelay
-                );
                 const jobId = (typeof msg.id === 'string' || typeof msg.id === 'number') ? msg.id : this.jobId;
 
                 if (this.job.queue.map(item => item.id).includes(jobId)) {
@@ -61,6 +51,15 @@ module.exports = function (RED) {
                     return;
                 }
 
+                const task = new WritePointJob(
+                    this.client,
+                    this.#eventEmitter,
+                    msg,
+                    this.maxConcurrentDeviceWrite,
+                    this.maxConcurrentPointWrite,
+                    this.concurrentTaskDelay
+                );
+
                 this.job.addJob({
                     id: jobId,
                     task: task,
@@ -70,10 +69,7 @@ module.exports = function (RED) {
                 this.status({ fill: 'yellow', shape: 'dot', text: `in queue` });
             });
 
-            this.#eventEmitter.on(EVENT_OUTPUT, (data) => {
-                const msg = {
-                    payload: data
-                };
+            this.#eventEmitter.on(EVENT_OUTPUT, (msg) => {
                 // @ts-ignore
                 this.send(msg);
             });