@bitpoolos/edge-bacnet 1.4.3 → 1.4.4

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## [1.4.4] - 08-08-2024
+### Summary 
+
+Minor updates.
+
+Added device details to meta property when full object property type is selected. 
+
+Implemented applyDisplayName feature. Triggered via:
+```javascript 
+applyDisplayNames = true 
+```
+property in an inject node, directly linked to a read node. Function flow: inject applyDisplayNames = true to read node -> read node passes msg to gateway node -> gateway node updates bacnet model for device and point display names. 
+
+This feature is for use in scenarios where the flows.json or node json structure is programattically generated with a prefilled pointsToRead property. Some devices and points may need displayNames updating.
+
+
 ## [1.4.3] - 01-08-2024
 ### Summary 
 

package/bacnet_client.js

@@ -375,16 +375,39 @@ class BacnetClient extends EventEmitter {
     });
   }
 
+  applyDisplayNames(pointsToRead) {
+    let that = this;
+    return new Promise((resolve, reject) => {
+      try {
+        for (let key in pointsToRead) {
+          let deviceModel = that.findDeviceByKey(key);
+          let device = pointsToRead[key];
+          for (let pointName in device) {
+            let pointObject = device[pointName];
+            if (pointName == "deviceName") {
+              deviceModel.setDisplayName(pointObject);
+            }
+            if (that.networkTree[key][pointName]) {
+              that.networkTree[key][pointName] = pointObject;
+            }
+          }
+        }
+
+        resolve(true);
+      } catch (e) {
+        that.logOut("applyDisplayNames error: ", e);
+        reject(e);
+      }
+    });
+  }
+
   setDeviceDisplayName(deviceObject, displayName) {
     let that = this;
     return new Promise((resolve, reject) => {
       try {
         let device = that.deviceList.find((ele) => ele.getDeviceId() == deviceObject.deviceId);
-
         device.setDisplayName(displayName);
-
         that.buildTreeException = true;
-
         resolve(true);
       } catch (e) {
         that.logOut("setDeviceDisplayName error: ", e);
@@ -401,9 +424,7 @@ class BacnetClient extends EventEmitter {
         if (that.networkTree[deviceKey][pointName]) {
           that.networkTree[deviceKey][pointName].displayName = pointDisplayName;
         }
-
         that.buildTreeException = true;
-
         resolve(true);
       } catch (e) {
         that.logOut("setPointDisplayName error: ", e);
@@ -414,11 +435,9 @@ class BacnetClient extends EventEmitter {
 
   importReadList(payload) {
     let that = this;
-
     return new Promise((resolve, reject) => {
       try {
         that.buildTreeException = true;
-
         for (let key in payload) {
           let device = payload[key];
           for (let pointName in device) {
@@ -617,8 +636,9 @@ class BacnetClient extends EventEmitter {
     return newProps;
   }
 
-  findDeviceByKey(key, deviceList, that) {
-    return deviceList.find(ele => `${that.getDeviceAddress(ele)}-${ele.getDeviceId()}` === key);
+  findDeviceByKey(key) {
+    let that = this;
+    return that.deviceList.find(ele => `${that.getDeviceAddress(ele)}-${ele.getDeviceId()}` === key);
   }
 
   getObjectId(pointName, pointConfig, that) {
@@ -652,7 +672,7 @@ class BacnetClient extends EventEmitter {
       // Process all devices in sequence
       for (let deviceIndex = 0; deviceIndex < devicesToRead.length; deviceIndex++) {
         const key = devicesToRead[deviceIndex];
-        const device = that.findDeviceByKey(key, that.deviceList, that);
+        const device = that.findDeviceByKey(key);
         if (!device) continue;
 
         const deviceName = that.computeDeviceName(device);
@@ -730,6 +750,14 @@ class BacnetClient extends EventEmitter {
         throw results.error;
       }
 
+      let deviceMetaInfo = {
+        "address": device.getAddress(),
+        "isMstp": device.getIsMstpDevice(),
+        "deviceId": device.getDeviceId(),
+        "vendorId": device.getVendorId(),
+        "deviceName": deviceName
+      };
+
       // Process the results of the batch
       results.value.values.forEach(pointResult => {
         const cacheRef = requestArray.find(ele =>
@@ -759,6 +787,7 @@ class BacnetClient extends EventEmitter {
             }
           }
 
+          pointRef.meta["device"] = deviceMetaInfo;
           pointRef.timestamp = Date.now();
           pointRef.status = "online";
 
@@ -769,9 +798,18 @@ class BacnetClient extends EventEmitter {
     } catch (err) {
       that.logOut("Error processing batch:", err);
 
+      let deviceMetaInfo = {
+        "address": device.getAddress(),
+        "isMstp": device.getIsMstpDevice(),
+        "deviceId": device.getDeviceId(),
+        "vendorId": device.getVendorId(),
+        "deviceName": deviceName
+      };
+
       requestArray.forEach(request => {
         let pointRef = request.pointRef;
         pointRef.status = "offline";
+        pointRef.meta["device"] = deviceMetaInfo;
 
         bacnetResults[deviceName][request.pointName] = pointRef;
       });
@@ -780,6 +818,14 @@ class BacnetClient extends EventEmitter {
   }
 
   async processIndividualPoints(device, requestArray, deviceName, bacnetResults, that, roundDecimal) {
+    let deviceMetaInfo = {
+      "address": device.getAddress(),
+      "isMstp": device.getIsMstpDevice(),
+      "deviceId": device.getDeviceId(),
+      "vendorId": device.getVendorId(),
+      "deviceName": deviceName
+    };
+
     for (const request of requestArray) {
       const { objectId, pointRef, pointName } = request;
       try {
@@ -792,11 +838,15 @@ class BacnetClient extends EventEmitter {
           pointRef.presentValue = val;
         }
 
+        pointRef.meta["device"] = deviceMetaInfo;
+
         // Store the point data in results
         bacnetResults[deviceName][pointName] = pointRef;
       } catch (err) {
         that.logOut(`Error updating point ${pointName}:`, err);
 
+        pointRef.meta["device"] = deviceMetaInfo;
+
         pointRef.status = "offline";
         bacnetResults[deviceName][pointName] = pointRef;
       }

package/bacnet_gateway.js

@@ -226,6 +226,21 @@ module.exports = function (RED) {
           });
       } else if (msg.testFunc == true) {
         node.bacnetClient.testFunction(msg.address, msg.type, msg.instance, msg.property);
+      } else if (msg.applyDisplayNames) {
+
+        node.status({ fill: "blue", shape: "dot", text: "Updating display names" });
+
+        setTimeout(() => {
+          node.status({});
+        }, 2000);
+
+        node.bacnetClient
+          .applyDisplayNames(msg.pointsToRead)
+          .then(function (result) {
+          }).catch(function (error) {
+            logOut("Error in applyDisplayNames: ", error);
+          });
+
       }
     });
 

package/bacnet_read.js

@@ -5,7 +5,6 @@
 
 
 module.exports = function (RED) {
-  const http = require("http");
   const { ReadCommandConfig } = require('./common');
   const baEnum = require('./resources/node-bacstack-ts/dist/index.js').enum;
 
@@ -54,72 +53,82 @@ module.exports = function (RED) {
     };
 
     node.on('input', function (msg) {
-      node.status({ fill: "blue", shape: "dot", text: "Reading values" });
-
-      let object_property_simplePayload = false;
-      let object_property_simpleWithStatus = false;
-      let object_property_fullObject = false;
-
-      let jsonType = false;
-      let mqttType = false;
-      let pointJsonType = false;
-      let useDeviceName = false;
-
-      if (msg.simplePayload) {
-        object_property_simplePayload = msg.simplePayload;
-      } else if (msg.simpleWithStatus) {
-        object_property_simpleWithStatus = msg.simpleWithStatus;
-      } else if (msg.fullObject) {
-        object_property_fullObject = msg.fullObject;
-      } else {
-        object_property_simplePayload = node.object_property_simplePayload;
-        object_property_simpleWithStatus = node.object_property_simpleWithStatus;
-        object_property_fullObject = node.object_property_fullObject;
-      }
 
-      if (msg.json) {
-        jsonType = msg.json;
-      } else if (msg.mqtt) {
-        mqttType = msg.mqtt;
-      } else if (msg.pointJson) {
-        pointJsonType = msg.pointJson;
-      } else {
-        jsonType = node.json;
-        mqttType = node.mqtt;
-        pointJsonType = node.pointJson
-      }
+      if (msg.applyDisplayNames) {
+
+        msg.pointsToRead = node.pointsToRead;
+        node.send(msg);
 
-      if (msg.useDeviceName) {
-        useDeviceName = msg.useDeviceName;
       } else {
-        useDeviceName = node.useDeviceName;
-      }
 
-      let readConfig = new ReadCommandConfig(node.pointsToRead, node.object_props, node.roundDecimal);
-
-      let output = {
-        type: "Read",
-        id: node.id,
-        readNodeName: node.nodeName,
-        options: readConfig,
-        objectPropertyType: {
-          simplePayload: object_property_simplePayload,
-          simpleWithStatus: object_property_simpleWithStatus,
-          fullObject: object_property_fullObject
-        },
-        outputType: {
-          json: jsonType,
-          mqtt: mqttType,
-          pointJson: pointJsonType,
-          useDeviceName: useDeviceName
+        node.status({ fill: "blue", shape: "dot", text: "Reading values" });
+
+        let object_property_simplePayload = false;
+        let object_property_simpleWithStatus = false;
+        let object_property_fullObject = false;
+
+        let jsonType = false;
+        let mqttType = false;
+        let pointJsonType = false;
+        let useDeviceName = false;
+
+        if (msg.simplePayload) {
+          object_property_simplePayload = msg.simplePayload;
+        } else if (msg.simpleWithStatus) {
+          object_property_simpleWithStatus = msg.simpleWithStatus;
+        } else if (msg.fullObject) {
+          object_property_fullObject = msg.fullObject;
+        } else {
+          object_property_simplePayload = node.object_property_simplePayload;
+          object_property_simpleWithStatus = node.object_property_simpleWithStatus;
+          object_property_fullObject = node.object_property_fullObject;
         }
-      };
 
-      node.send(output);
+        if (msg.json) {
+          jsonType = msg.json;
+        } else if (msg.mqtt) {
+          mqttType = msg.mqtt;
+        } else if (msg.pointJson) {
+          pointJsonType = msg.pointJson;
+        } else {
+          jsonType = node.json;
+          mqttType = node.mqtt;
+          pointJsonType = node.pointJson
+        }
+
+        if (msg.useDeviceName) {
+          useDeviceName = msg.useDeviceName;
+        } else {
+          useDeviceName = node.useDeviceName;
+        }
 
-      setTimeout(() => {
-        node.status({});
-      }, 3000);
+        let readConfig = new ReadCommandConfig(node.pointsToRead, node.object_props, node.roundDecimal);
+
+        let output = {
+          type: "Read",
+          id: node.id,
+          readNodeName: node.nodeName,
+          options: readConfig,
+          objectPropertyType: {
+            simplePayload: object_property_simplePayload,
+            simpleWithStatus: object_property_simpleWithStatus,
+            fullObject: object_property_fullObject
+          },
+          outputType: {
+            json: jsonType,
+            mqtt: mqttType,
+            pointJson: pointJsonType,
+            useDeviceName: useDeviceName
+          }
+        };
+
+        node.send(output);
+
+        setTimeout(() => {
+          node.status({});
+        }, 3000);
+
+      }
 
     });
 

package/package.json

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

package/treeBuilder.js

@@ -63,7 +63,6 @@ class treeBuilder {
         // Check if the device object exists and the device name is valid
         if (deviceObject) {
             await this.processDevicePoints(device, deviceObject, deviceName, ipAddress, deviceId, index);
-
         } else {
             //console.log("Unable to find device object");
         }