@bitpoolos/edge-bacnet 1.5.2 → 1.5.3

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## [1.5.3] - 23-01-2025
+
+New feature: 
+ - import / export buttons added to new tab in gateway node, used to manage the complete data model for backup or restore
+ - associated API end points for programatic backing up or restoring - /bitpool-bacnet-data/getDataModel; /bitpool-bacnet-data/updateDataModel;
+
+Further async / await refactoring
+
+Bug fixes:
+ - incorrect device name in read list export
+ - read command indexing unhandled scenario 
+ - duplicating points in read list after pressing refresh tree button
+ - Multi State Values and other state text based points not being handled correctly in large volume scenarios
+
+NOTE: 
+  New importing and exporting feature handles a .json file instead of the .cfg file used in the back end. This is due to browsers flagging .cfg files as malicious. The contents of the file are unchanged. 
+
 ## [1.5.2] - 10-01-2025
 
 Mismatched network request hot fix

package/bacnet_client.js

@@ -534,7 +534,6 @@ class BacnetClient extends EventEmitter {
               }
             }
             try {
-
               await that.updateDeviceName(device);
 
               if (device.getSegmentation() !== 3) {
@@ -579,23 +578,35 @@ class BacnetClient extends EventEmitter {
     }
   }
 
-  updateDeviceName(device) {
-    let that = this;
-    return new Promise((resolve, reject) => {
-      that
-        ._getDeviceName(device)
-        .then(function (deviceObject) {
-          if (typeof deviceObject.name == "string") {
-            device.setDeviceName(deviceObject.name + " " + device.getDeviceId());
-            device.setPointsList(deviceObject.devicePointEntry);
-          }
-          resolve();
-        })
-        .catch(function (e) {
-          that.logOut("updateDeviceName error: ", e);
-          resolve();
-        });
-    });
+  // updateDeviceName(device) {
+  //   let that = this;
+  //   return new Promise((resolve, reject) => {
+  //     that
+  //       ._getDeviceName(device)
+  //       .then(function (deviceObject) {
+  //         if (typeof deviceObject.name == "string") {
+  //           device.setDeviceName(deviceObject.name + " " + device.getDeviceId());
+  //           device.setPointsList(deviceObject.devicePointEntry);
+  //         }
+  //         resolve();
+  //       })
+  //       .catch(function (e) {
+  //         that.logOut("updateDeviceName error: ", e);
+  //         resolve();
+  //       });
+  //   });
+  // }
+
+  async updateDeviceName(device) {
+    try {
+      const deviceObject = await this._getDeviceName(device);
+      if (typeof deviceObject?.name === "string") {
+        device.setDeviceName(deviceObject.name + " " + device.getDeviceId());
+        device.setPointsList(deviceObject.devicePointEntry);
+      }
+    } catch (e) {
+      this.logOut("updateDeviceName error: ", e);
+    }
   }
 
   reinitializeClient(config) {
@@ -729,15 +740,15 @@ class BacnetClient extends EventEmitter {
         // Process points for the current device
         const pointsToRead = readConfig.pointsToRead[key];
         const pointNames = Object.keys(pointsToRead);
-        let totalPoints = pointNames.length;
+        let totalPoints = pointNames.length - 1;
         let requestArray = [];
         let processedPoints = 0; // Counter for processed points
 
         // Process each point for the device in batches
         for (let i = 0; i < pointNames.length; i++) {
+
           const pointName = pointNames[i];
           if (pointName === "deviceName") {
-            totalPoints = totalPoints - 1;
             continue;
           }
 
@@ -758,8 +769,7 @@ class BacnetClient extends EventEmitter {
           }
 
           // Process the batch when the request array is full or the last point is reached
-          if (requestArray.length === maxObjectCount || i === pointNames.length - 1) {
-
+          if (requestArray.length === maxObjectCount) {
             if (device.getProtocolServiceSupport("ReadPropertyMultiple") == true) {
               await that.processBatch(device, requestArray, deviceName, bacnetResults, that, roundDecimal);
             } else {
@@ -769,6 +779,16 @@ class BacnetClient extends EventEmitter {
             requestArray = [];
             // Increment the processed points counter
             processedPoints += maxObjectCount;
+          } else if (i === pointNames.length - 1) {
+            if (device.getProtocolServiceSupport("ReadPropertyMultiple") == true) {
+              await that.processBatch(device, requestArray, deviceName, bacnetResults, that, roundDecimal);
+            } else {
+              await that.processIndividualPoints(device, requestArray, deviceName, bacnetResults, that, roundDecimal);
+            }
+
+            requestArray = [];
+            // Increment the processed points counter
+            processedPoints += i;
           }
 
           // Check if all points for the device have been processed
@@ -870,17 +890,23 @@ class BacnetClient extends EventEmitter {
       const { objectId, pointRef, pointName } = request;
       try {
 
-
         const result = await that.updatePoint(device, pointRef);
 
-        //const result = await that.updatePointWithRetry(device, pointRef, 1);
-
-
         if (result.objectId.type == objectId.type && result.objectId.instance == objectId.instance) {
           const val = result.values[0].value;
 
           if (isNumber(val)) {
             pointRef.presentValue = roundDecimalPlaces(val, roundDecimal);
+
+            if (pointRef.meta.objectId.type == 19 || pointRef.meta.objectId.type == 13 || pointRef.meta.objectId.type == 14) {
+              if (pointRef.stateTextArray && typeof pointRef.stateTextArray[0].value !== "object") {
+                if (val != 0) {
+                  pointRef.presentValue = pointRef.stateTextArray[val - 1].value;
+                } else {
+                  pointRef.presentValue = pointRef.stateTextArray[val].value;
+                }
+              }
+            }
           } else {
             pointRef.presentValue = val;
           }
@@ -905,24 +931,37 @@ class BacnetClient extends EventEmitter {
     }
   }
 
-  updateManyPoints(device, points) {
-    let that = this;
-    return new Promise((resolve, reject) => {
-
+  // updateManyPoints(device, points) {
+  //   let that = this;
+  //   return new Promise((resolve, reject) => {
+  //     // let readOptions = {
+  //     //   maxSegments: device.getMaxSe,
+  //     //   maxApdu: that.readPropertyMultipleOptions.maxApdu,
+  //     // };
+
+  //     that
+  //       ._readObjectWithRequestArray(device, points, that.readPropertyMultipleOptions)
+  //       .then(function (results) {
+  //         resolve(results);
+  //       })
+  //       .catch(function (err) {
+  //         reject(err);
+  //       });
+  //   });
+  // }
+
+  async updateManyPoints(device, points) {
+    try {
       // let readOptions = {
       //   maxSegments: device.getMaxSe,
       //   maxApdu: that.readPropertyMultipleOptions.maxApdu,
       // };
 
-      that
-        ._readObjectWithRequestArray(device, points, that.readPropertyMultipleOptions)
-        .then(function (results) {
-          resolve(results);
-        })
-        .catch(function (err) {
-          reject(err);
-        });
-    });
+      const results = await this._readObjectWithRequestArray(device, points, this.readPropertyMultipleOptions);
+      return results;
+    } catch (error) {
+      throw error;
+    }
   }
 
   updatePointWithRetry(device, point, retryCount = 1) {
@@ -1552,6 +1591,22 @@ class BacnetClient extends EventEmitter {
     });
   }
 
+  getDataModel() {
+    let that = this;
+    return new Promise(async function (resolve, reject) {
+      try {
+        resolve({
+          renderList: that.renderList,
+          deviceList: that.deviceList,
+          pointList: that.networkTree,
+          renderListCount: that.renderListCount,
+        });
+      } catch (e) {
+        reject(e);
+      }
+    });
+  }
+
   updatePointsList(json) {
     let that = this;
     json.deviceList.forEach(function (updatedDevice) {
@@ -1587,6 +1642,29 @@ class BacnetClient extends EventEmitter {
     });
   }
 
+  updateDataModel(json) {
+    let that = this;
+    return new Promise(async function (resolve, reject) {
+      try {
+        if (json.body.renderList) {
+          that.renderList = json.body.renderList;
+        }
+        if (json.body.deviceList) {
+          await that.updateDeviceList(json);
+        }
+        if (json.body.pointList) {
+          that.networkTree = json.body.pointList;
+        }
+        if (json.body.renderListCount) {
+          that.renderListCount = json.body.renderListCount;
+        }
+        resolve();
+      } catch (e) {
+        reject(e);
+      }
+    });
+  }
+
   sortDevices(a, b) {
     if (a.deviceId < b.deviceId) {
       return -1;

package/bacnet_device.js

@@ -88,7 +88,9 @@ class BacnetDevice {
     }
 
     setDisplayName(displayName) {
-        this.displayName = displayName;
+        if (typeof displayName == "string") {
+            this.displayName = displayName;
+        }
     }
 
     getDisplayName() {

package/bacnet_gateway.html

@@ -203,6 +203,11 @@
         label: "Server",
       });
 
+      tabs.addTab({
+        id: "read-backup-tab",
+        label: "Backup & Restore",
+      });
+
       if (node.networkInterfaces && node.networkInterfaces.length > 0) {
         let nicSelector = document.getElementById("node-input-local_device_address");
         node.networkInterfaces.forEach(function (option) {
@@ -333,6 +338,8 @@
       vueapp.use(primevue.confirmationservice);
       node.vm1 = vueapp.mount("#serverParent");
 
+
+      // Import Device List
       $("#file-upload").on("change", function (event) {
         const input = event.target.files[0];
         const reader = new FileReader();
@@ -356,6 +363,7 @@
         reader.readAsText(input);
       });
 
+      //Export Device List
       $("#file-export").click(function (params) {
         $.ajax({
           url: RED.settings.httpNodeRoot + "bitpool-bacnet-data/getDeviceList",
@@ -370,6 +378,45 @@
         });
       });
 
+      //Import complete Data model
+      $("#file-upload-database").on("change", function (event) {
+        const input = event.target.files[0];
+        const reader = new FileReader();
+
+        reader.onload = function (e) {
+          const text = e.target.result;
+
+          let jsonPayload = JSON.parse(text);
+
+          $.ajax({
+            type: "POST",
+            url: RED.settings.httpNodeRoot + "bitpool-bacnet-data/updateDataModel",
+            dataType: "json",
+            contentType: "application/json",
+            data: JSON.stringify(jsonPayload),
+            success: function (result) { },
+            timeout: 15000,
+          });
+        };
+
+        reader.readAsText(input);
+      });
+
+      // Export complete Data model
+      $("#file-export-database").click(function (params) {
+        $.ajax({
+          url: RED.settings.httpNodeRoot + "bitpool-bacnet-data/getDataModel",
+          success: function (deviceList) {
+            let data = "text/json;charset=utf-8," + encodeURIComponent(JSON.stringify(deviceList));
+            let aEle = document.getElementById("exportJSON");
+            aEle.setAttribute("href", "data:" + data);
+            aEle.setAttribute("download", "edge-bacnet-datastore.json");
+            aEle.click();
+          },
+          timeout: 10000,
+        });
+      });
+
       //start device scan range matrix
 
       $("#node-input-deviceIdRangeMatrix-container")
@@ -739,6 +786,21 @@
     .point_name {
       font-weight: bold;
     }
+    .database-backup {
+      border-top: 1px solid grey;
+      padding-top: 25px;
+      margin-top: 5px !important;
+    }
+    .database-file-label {
+      color: black;
+      font-weight: bold;
+      font-size: 16px;
+      width: auto !important;
+      
+    }
+    .database-file-label-div {
+      padding-top: 15px;
+    }
   </style>
 
   <div class="form-row node-input-read-tabs-row">
@@ -967,6 +1029,26 @@
         </div>
       </div>
     </div>
+    <div id="read-backup-tab" style="display:none">
+      <div class="database-file-label-div">
+        <span class="database-file-label">Database File</span>
+      </div>
+
+      <div class="form-row bp-import-buttons database-backup" id="importDeviceList">
+        <!-- <label> Device List: </label> -->
+        <label for="file-upload-database" class="custom-file-upload">
+          <i class="fa fa-arrow-circle-up" id="fileLabel"></i>
+          <a id="fileLabelText" style="padding-left: 10px;">Import database</a>
+        </label>
+        <input type="file" id="file-upload-database" accept="application/JSON" class="inputStyle" style="width: 258px;" />
+        <label for="file-export-database" class="custom-file-upload" style="margin-left: 5px;">
+          <i class="fa fa-arrow-circle-down" id="fileLabel"></i>
+          <a id="fileLabelText" style="padding-left: 10px;">Export database</a>
+        </label>
+        <input id="file-export-database" class="inputStyle" style="width: 258px; display: none;" />
+        <a id="exportJSON" style="display: none"></a>
+      </div>
+    </div>
   </div>
 </script>
 <script type="text/html" data-help-name="Bacnet-Gateway">

package/bacnet_gateway.js

@@ -371,6 +371,42 @@ module.exports = function (RED) {
       }
     });
 
+    //route handler for getting data model
+    RED.httpAdmin.get("/bitpool-bacnet-data/getDataModel", function (req, res) {
+      if (!node.bacnetClient) {
+        logOut("Issue with the bacnetClient while getting data model: ", node.bacnetClient);
+        res.send(false);
+      } else {
+        node.bacnetClient
+          .getDataModel()
+          .then(function (result) {
+            res.send(result);
+          })
+          .catch(function (error) {
+            res.send(error);
+            logOut("Error getting data model:  ", error);
+          });
+      }
+    });
+
+    //route handler for updating data model
+    RED.httpAdmin.post("/bitpool-bacnet-data/updateDataModel", function (req, res) {
+      if (!node.bacnetClient) {
+        logOut("Issue with the bacnetClient while getting data model: ", node.bacnetClient);
+        res.send(false);
+      } else {
+        node.bacnetClient
+          .updateDataModel(req)
+          .then(function (result) {
+            res.send(result);
+          })
+          .catch(function (error) {
+            res.send(error);
+            logOut("Error getting data model:  ", error);
+          });
+      }
+    });
+
     //route handler for purge device
     RED.httpAdmin.post("/bitpool-bacnet-data/purgeDevice", function (req, res) {
       if (!node.bacnetClient) {

package/bacnet_read.html

@@ -634,14 +634,7 @@
             let app = this;
             const slotProps = app.rightClickedDevice;
             const displayName = app.deviceDisplayNameValue;
-            let device = app.deviceList.find((ele) => {
-              if (ele.address.address) {
-                return ele.address.address == slotProps.node.ipAddr && ele.deviceId == slotProps.node.deviceId;
-              } else {
-                return ele.address == slotProps.node.ipAddr && ele.deviceId == slotProps.node.deviceId;
-              }
-            });
-
+            let device = app.getDeviceFromDeviceList(slotProps.node.ipAddr, slotProps.node.deviceId);
             if (device) {
               app.nodeService.setDeviceDisplayName(device, displayName).then(function (result) {
                 if (result) {
@@ -660,7 +653,7 @@
             const pointName = slotProps.node.pointName;
 
             let device = app.deviceList.find((ele) => {
-              return ele.deviceName == slotProps.node.parentDevice;
+              return ele.displayName == slotProps.node.parentDevice;
             });
 
             if (device) {
@@ -676,6 +669,18 @@
 
             app.showPointNameDialog = false;
           },
+          getDeviceFromDeviceList(ip, id) {
+            let app = this;
+            let device = app.deviceList.find((ele) => {
+              if (ele.address.address) {
+                return ele.address.address == ip && ele.deviceId == id;
+              } else {
+                return ele.address == ip && ele.deviceId == id;
+              }
+            });
+
+            return device;
+          },
           settingDeviceName(slotProps) {
             let app = this;
             if (slotProps.node.settingDisplayName) {
@@ -709,11 +714,9 @@
                 (ele) => ele.ipAddr == key.split("-")[0] && ele.deviceId == key.split("-")[1]
               );
               let deviceName;
-
               if (readDevice) {
                 deviceName = readDevice.label;
               }
-
               exportJson[key] = {};
               if (deviceName) {
                 exportJson[key]["deviceName"] = deviceName;
@@ -725,9 +728,8 @@
                 let pointName = devicePoints[pointIndex];
                 let pointObject = device[pointName];
 
-                //formatting json payload, still in progress
-
-                if (pointObject) {
+                //formatting json payload
+                if (pointObject && pointName !== "deviceName") {
                   exportJson[key][pointName] = {
                     meta: pointObject.meta,
                     objectName: pointObject.objectName,
@@ -765,6 +767,7 @@
               let ip = key.split("-")[0];
               let id = key.split("-")[1];
               const importedDevice = pointsToRead[key];
+              //match only by IP, to handle case of mstp device
               let foundIndex = app.devices.findIndex((ele) => ele.ipAddr == ip);
 
               if (foundIndex !== -1) {
@@ -772,17 +775,11 @@
                 if (app.devices[foundIndex].deviceId == id) {
                   //found device
                   let treeDevice = app.devices[foundIndex];
-                  let device = app.deviceList.find((ele) => {
-                    if (ele.address.address) {
-                      return ele.address.address == ip && ele.deviceId == id;
-                    } else {
-                      return ele.address == ip && ele.deviceId == id;
-                    }
-                  });
+                  let device = app.getDeviceFromDeviceList(ip, id);
 
                   for (let pointName in importedDevice) {
                     let point = importedDevice[pointName];
-                    if (pointName == "deviceName") {
+                    if (pointName == "deviceName" && typeof point == "string") {
                       app.nodeService.setDeviceDisplayName(device, point);
                       treeDevice.label = point;
                     } else {
@@ -849,7 +846,7 @@
 
                     for (let pointName in importedDevice) {
                       let point = importedDevice[pointName];
-                      if (pointName == "deviceName") {
+                      if (pointName == "deviceName" && typeof point == "string") {
                         app.nodeService.setDeviceDisplayName(device, point);
                         mstpDevice.label = point;
                       } else {
@@ -878,7 +875,7 @@
                           } else {
                             // read device found, add point to existing
                             let pointIndex = app.readDevices[isDeviceInReadList].children[0].children.findIndex(
-                              (ele) => ele.data == point.objectName
+                              (ele) => parseInt(ele.bacnetInstance) == parseInt(point.meta.objectId.instance) && parseInt(ele.bacnetType) == parseInt(point.meta.objectId.type)
                             );
                             if (pointIndex == -1) {
                               app.readDevices[isDeviceInReadList].children[0].children.push(pointInTree);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bitpoolos/edge-bacnet",
-  "version": "1.5.2",
+  "version": "1.5.3",
   "description": "A bacnet gateway for node-red",
   "dependencies": {
     "@plus4nodered/ts-node-bacnet": "^1.0.0-beta.2",

package/resources/node-bacstack-ts/dist/lib/client.js

@@ -237,9 +237,13 @@ class Client extends events_1.EventEmitter {
             if (!result) return debug('Received invalid deleteObject message');
             this.emit('deleteObject', { address: address, invokeId: invokeId, request: result, srcAddress: srcAddress });
         } else if (service === baEnum.ConfirmedServiceChoice.ACKNOWLEDGE_ALARM) {
-            result = baServices.alarmAcknowledge.decode(buffer, offset, length);
-            if (!result) return debug('Received invalid alarmAcknowledge message');
-            this.emit('alarmAcknowledge', { address: address, invokeId: invokeId, request: result, srcAddress: srcAddress });
+            try {
+                result = baServices.alarmAcknowledge.decode(buffer, offset, length);
+                if (!result) return debug('Received invalid alarmAcknowledge message');
+                this.emit('alarmAcknowledge', { address: address, invokeId: invokeId, request: result, srcAddress: srcAddress });
+            } catch (e) {
+                //console.log("Error in alarmAcknowledge: ", e);
+            }
         } else if (service === baEnum.ConfirmedServiceChoice.GET_ALARM_SUMMARY) {
             this.emit('getAlarmSummary', { address: address, invokeId: invokeId });
         } else if (service === baEnum.ConfirmedServiceChoice.GET_ENROLLMENT_SUMMARY) {