@bitpoolos/edge-bacnet 1.3.2 → 1.4.1

package/CHANGELOG.md

@@ -1,4 +1,45 @@
 # Changelog
+## [1.4.1] - 09-07-2024
+
+### Summary
+
+Bug fixes
+ - incorrect variable used in doRead try catch
+ - setmaxlisteners on bacnet server event parent class
+
+
+## [1.4.0] - 05-07-2024
+
+### Summary
+
+Fixed read list export for sites with large point counts. 
+
+Removed auto tree reload on read node UI. UI tree must be manually reloaded now. 
+
+Fixed export to CSV bug. 
+
+Fixed state array text not found bug
+
+Removed unecessary debug. 
+
+Updated required json saved to node JSON file. 
+
+Added github pull requests
+    - Added create object and delete object to bacnet server 
+    - Added write property to bacnet server 
+
+Added Simple With Status read property type.
+    - This type sends a msg.payload that consists of {presentValue, timestamp, status}
+    - Status is currently online and offline
+
+Changed inject node to only 1 selectable type of inject (Discover or Poll)
+
+
+## [1.3.2] - 18-06-2024
+
+### Summary 
+
+Bug fix for API request URL paths. Updated for using node-red host setting.
 
 ## [1.3.1] - 06-06-2024
 

package/bacnet_client.js

@@ -322,31 +322,13 @@ class BacnetClient extends EventEmitter {
 
   updatePointsForDevice(deviceObject) {
     let that = this;
-    return new Promise((resolve, reject) => {
+    return new Promise(async (resolve, reject) => {
       try {
         let device = that.deviceList.find((ele) => ele.getDeviceId() == deviceObject.deviceId);
-        that.updateDeviceName(device);
-
-
-        //test
-
-        that.getProtocolSupported(device).then(function (result) {
-          console.log("updatePointsForDevice getProtocolSupported ", result.values[0].originalBitString);
-          console.log(result.values[0]);
-          console.log(result);
-          console.log(result.values[0]);
-          let decodedValues = decodeBitArray(8, result.values[0].originalBitString.value);
-          device.setProtocolServicesSupported(decodedValues);
-        }).catch(function (error) {
-          that.logOut("getProtocolSupported error: ", error);
-        });
-
-        //test
-
+        await that.updateDeviceName(device);
 
         if (device.getIsProtocolServicesSet() == false) {
           that.getProtocolSupported(device).then(function (result) {
-            console.log("updatePointsForDevice getProtocolSupported ", result.values[0].originalBitString);
             let decodedValues = decodeBitArray(8, result.values[0].originalBitString.value);
             device.setProtocolServicesSupported(decodedValues);
           }).catch(function (error) {
@@ -685,14 +667,17 @@ class BacnetClient extends EventEmitter {
         // Process points for the current device
         const pointsToRead = readConfig.pointsToRead[key];
         const pointNames = Object.keys(pointsToRead);
-        const totalPoints = pointNames.length;
+        let totalPoints = pointNames.length;
         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") continue;
+          if (pointName === "deviceName") {
+            totalPoints = totalPoints - 1;
+            continue;
+          }
 
           const pointConfig = pointsToRead[pointName];
           const objectId = that.getObjectId(pointName, pointConfig, that);
@@ -760,10 +745,12 @@ class BacnetClient extends EventEmitter {
           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 (val != 0) {
-                pointRef.presentValue = pointRef.stateTextArray[val - 1].value;
-              } else {
-                pointRef.presentValue = pointRef.stateTextArray[val].value;
+              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 {
@@ -772,12 +759,23 @@ class BacnetClient extends EventEmitter {
             }
           }
 
+          pointRef.timestamp = Date.now();
+          pointRef.status = "online";
+
           // Store the point data in results
           bacnetResults[deviceName][pointNameRef] = pointRef;
         }
       });
     } catch (err) {
       that.logOut("Error processing batch:", err);
+
+      requestArray.forEach(request => {
+        let pointRef = request.pointRef;
+        pointRef.status = "offline";
+
+        bacnetResults[deviceName][request.pointName] = pointRef;
+      });
+
     }
   }
 
@@ -798,6 +796,9 @@ class BacnetClient extends EventEmitter {
         bacnetResults[deviceName][pointName] = pointRef;
       } catch (err) {
         that.logOut(`Error updating point ${pointName}:`, err);
+
+        pointRef.status = "offline";
+        bacnetResults[deviceName][pointName] = pointRef;
       }
     }
   }
@@ -1501,8 +1502,6 @@ class BacnetClient extends EventEmitter {
 
     treeWorker.cacheData();
 
-    //const missingDevices = await that.getDevicesNotRenderedYet();
-
     for (let i = 0; i < that.deviceList.length; i++) {
       let device = that.deviceList[i];
       await treeWorker.processDevice(device, i);
@@ -1736,9 +1735,6 @@ class BacnetClient extends EventEmitter {
                       case baEnum.PropertyIdentifier.OBJECT_TYPE:
                         if (object.value[0] && object.value[0].value) values[objectId].objectType = object.value[0].value;
                         break;
-                      case baEnum.PropertyIdentifier.OBJECT_IDENTIFIER:
-                        if (object.value[0] && object.value[0].value) values[objectId].objectID = object.value[0].value;
-                        break;
                       case baEnum.PropertyIdentifier.PROPERTY_LIST:
                         if (object.value) values[objectId].propertyList = that.mapPropsToArray(object.value);
                         break;
@@ -1752,13 +1748,11 @@ class BacnetClient extends EventEmitter {
                           values[objectId].modificationDate = object.value[0].value;
                         }
                         break;
-
                       case baEnum.PropertyIdentifier.PROGRAM_STATE:
                         if (object.value[0]) {
                           values[objectId].programState = that.getPROP_PROGRAM_STATE(object.value[0].value);
                         }
                         break;
-
                       case baEnum.PropertyIdentifier.RECORD_COUNT:
                         if (object.value[0]) {
                           values[objectId].recordCount = object.value[0].value;

package/bacnet_gateway.js

@@ -5,7 +5,6 @@
 module.exports = function (RED) {
   const { BacnetClient } = require("./bacnet_client");
   const { BacnetClientConfig, getIpAddress } = require("./common");
-  const { exec } = require("child_process");
   const { BacnetServer } = require("./bacnet_server.js");
 
   function BitpoolBacnetGatewayDevice(config) {
@@ -109,21 +108,27 @@ module.exports = function (RED) {
           }, 3000);
         }
         if (outputType.json && !outputType.mqtt) {
-          if (objectPropertyType.fullObject && objectPropertyType.simplePayload) {
-            sendSimpleJson(values, readNodeName);
-            sendJsonAsMqtt(values, readNodeName);
-          } else if (objectPropertyType.fullObject && !objectPropertyType.simplePayload) {
+          //json
+          if (objectPropertyType.simpleWithStatus && !objectPropertyType.fullObject && !objectPropertyType.simplePayload) {
+            //simpleWithStatus
+            sendSimpleWithStatus(values, readNodeName, true);
+          } else if (objectPropertyType.fullObject && !objectPropertyType.simplePayload && !objectPropertyType.simpleWithStatus) {
+            //fullObject
             sendJsonAsMqtt(values, readNodeName);
-          } else if (!objectPropertyType.fullObject && objectPropertyType.simplePayload) {
+          } else if (objectPropertyType.simplePayload && !objectPropertyType.fullObject && !objectPropertyType.simpleWithStatus) {
+            //simplePayload
             sendSimpleJson(values, readNodeName);
           }
         } else if (!outputType.json && outputType.mqtt) {
-          if (objectPropertyType.fullObject && objectPropertyType.simplePayload) {
+          //mqtt
+          if (objectPropertyType.simpleWithStatus && !objectPropertyType.fullObject && !objectPropertyType.simplePayload) {
+            //simpleWithStatus
+            sendSimpleWithStatus(values, readNodeName, false);
+          } else if (objectPropertyType.fullObject && !objectPropertyType.simplePayload && !objectPropertyType.simpleWithStatus) {
+            //fullObject
             sendAsMqtt(values, readNodeName);
-            sendSimpleMqtt(values, readNodeName);
-          } else if (objectPropertyType.fullObject && !objectPropertyType.simplePayload) {
-            sendAsMqtt(values, readNodeName);
-          } else if (!objectPropertyType.fullObject && objectPropertyType.simplePayload) {
+          } else if (objectPropertyType.simplePayload && !objectPropertyType.fullObject && !objectPropertyType.simpleWithStatus) {
+            //simplePayload
             sendSimpleMqtt(values, readNodeName);
           }
         }
@@ -159,6 +164,23 @@ module.exports = function (RED) {
       }
     }
 
+    node.bacnetServer.on("writeProperty", (topic, newValue) => {
+      let formattedTopic = topic;
+      if (
+        node.nodeName !== "gateway" &&
+        node.nodeName !== "" &&
+        node.nodeName !== "null" &&
+        node.nodeName !== "undefined" &&
+        typeof node.nodeName == "string"
+      ) {
+        formattedTopic = `${node.nodeName}/BITPOOL_EDGE_BACNET_GATEWAY/BACNET_SERVER/${topic}`;
+      } else {
+        formattedTopic = `BITPOOL_EDGE_BACNET_GATEWAY/BACNET_SERVER/${topic}`;
+      }
+
+      node.send({ payload: newValue, topic: formattedTopic });
+    });
+
     node.on("input", function (msg) {
       if (msg.topic && msg.payload !== null) {
         if (node.bacnetServer) {
@@ -420,21 +442,27 @@ module.exports = function (RED) {
             }, 3000);
           }
           if (outputType.json && !outputType.mqtt) {
-            if (objectPropertyType.fullObject && objectPropertyType.simplePayload) {
-              sendSimpleJson(values, readNodeName);
-              sendJsonAsMqtt(values, readNodeName);
-            } else if (objectPropertyType.fullObject && !objectPropertyType.simplePayload) {
+            //json
+            if (objectPropertyType.simpleWithStatus && !objectPropertyType.fullObject && !objectPropertyType.simplePayload) {
+              //simpleWithStatus
+              sendSimpleWithStatus(values, readNodeName, true);
+            } else if (objectPropertyType.fullObject && !objectPropertyType.simplePayload && !objectPropertyType.simpleWithStatus) {
+              //fullObject
               sendJsonAsMqtt(values, readNodeName);
-            } else if (!objectPropertyType.fullObject && objectPropertyType.simplePayload) {
+            } else if (objectPropertyType.simplePayload && !objectPropertyType.fullObject && !objectPropertyType.simpleWithStatus) {
+              //simplePayload
               sendSimpleJson(values, readNodeName);
             }
           } else if (!outputType.json && outputType.mqtt) {
-            if (objectPropertyType.fullObject && objectPropertyType.simplePayload) {
-              sendAsMqtt(values, readNodeName);
-              sendSimpleMqtt(values, readNodeName);
-            } else if (objectPropertyType.fullObject && !objectPropertyType.simplePayload) {
+            //mqtt
+            if (objectPropertyType.simpleWithStatus && !objectPropertyType.fullObject && !objectPropertyType.simplePayload) {
+              //simpleWithStatus
+              sendSimpleWithStatus(values, readNodeName, false);
+            } else if (objectPropertyType.fullObject && !objectPropertyType.simplePayload && !objectPropertyType.simpleWithStatus) {
+              //fullObject
               sendAsMqtt(values, readNodeName);
-            } else if (!objectPropertyType.fullObject && objectPropertyType.simplePayload) {
+            } else if (objectPropertyType.simplePayload && !objectPropertyType.fullObject && !objectPropertyType.simpleWithStatus) {
+              //simplePayload
               sendSimpleMqtt(values, readNodeName);
             }
           }
@@ -466,6 +494,97 @@ module.exports = function (RED) {
       return pointName;
     }
 
+    sendSimpleWithStatus = function (values, readNodeName, isJson) {
+      let devices = Object.keys(values);
+      devices.forEach(function (device) {
+        if (device !== "_msgid") {
+          let points = values[device];
+          let structuredObject = {};
+          let msgg = {};
+          for (let point in points) {
+            if (points[point] && "presentValue" in points[point]) {
+              let pointName = getPointName(points[point], point);
+              if (
+                node.nodeName !== "gateway" &&
+                node.nodeName !== "" &&
+                node.nodeName !== "null" &&
+                node.nodeName !== "undefined" &&
+                typeof node.nodeName == "string"
+              ) {
+                if (readNodeName !== '' &&
+                  readNodeName !== null &&
+                  readNodeName !== undefined
+                ) {
+                  msgg.topic = `${node.nodeName}/${readNodeName}/${device}/${pointName}`;
+                } else {
+                  msgg.topic = `${node.nodeName}/${device}/${pointName}`;
+                }
+              } else {
+                if (readNodeName !== '' &&
+                  readNodeName !== null &&
+                  readNodeName !== undefined
+                ) {
+                  msgg.topic = `BITPOOL_BACNET_GATEWAY/${readNodeName}/${device}/${pointName}`;
+                } else {
+                  msgg.topic = `BITPOOL_BACNET_GATEWAY/${device}/${pointName}`;
+                }
+              }
+              let payload = {
+                presentValue: points[point]["presentValue"],
+                timestamp: points[point]["timestamp"],
+                status: points[point]["status"]
+              };
+
+              if (isJson) {
+                //json payload
+                structuredObject[point] = payload;
+              } else {
+                //mqtt payload
+                msgg.payload = payload;
+                node.send(msgg);
+                msgg = {};
+              }
+            }
+          }
+
+          if (isJson) {
+            //json payload
+            let topic = "";
+            if (
+              node.nodeName !== "gateway" &&
+              node.nodeName !== "" &&
+              node.nodeName !== "null" &&
+              node.nodeName !== "undefined" &&
+              typeof node.nodeName == "string"
+            ) {
+              if (readNodeName !== '' &&
+                readNodeName !== null &&
+                readNodeName !== undefined
+              ) {
+                topic = `${node.nodeName}/${readNodeName}/${device}`;
+              } else {
+                topic = `${node.nodeName}/${device}`;
+              }
+            } else {
+              if (readNodeName !== '' &&
+                readNodeName !== null &&
+                readNodeName !== undefined
+              ) {
+                topic = `BITPOOL_BACNET_GATEWAY/${readNodeName}/${device}`;
+              } else {
+                topic = `BITPOOL_BACNET_GATEWAY/${device}`;
+              }
+            }
+
+            msgg.topic = topic;
+            msgg.payload = structuredObject;
+            node.send(msgg);
+            msgg = {};
+          }
+        }
+      });
+    }
+
     sendSimpleMqtt = function (values, readNodeName) {
       let devices = Object.keys(values);
       devices.forEach(function (device) {

package/bacnet_read.html

@@ -18,8 +18,8 @@
             pointList: [],
             pointsToRead: { value: {} },
             readDevices: { value: [] },
-            devicesToRead: [],
             object_property_simplePayload: { value: false },
+            object_property_simpleWithStatus: { value: false },
             object_property_fullObject: { value: true },
         },
         inputs: 1,
@@ -96,9 +96,6 @@
                 mounted() {
                     let app = this;
                     this.getData(true);
-                    if (!node.reloadTimer) {
-                        node.reloadTimer = setInterval(() => app.getData(false), 7000);
-                    }
 
                     $("#readlist-file-upload").on("change", function (event) {
                         const input = event.target.files[0];
@@ -408,29 +405,31 @@
                                     return ele.address == ipAddress && ele.deviceId == deviceId;
                                 }
                             });
-                            const deviceName = device.deviceName;
-                            const points = Object.keys(deviceObject);
-                            for (point in points) {
-                                csvContent +=
-                                    ipAddress +
-                                    "," +
-                                    deviceId +
-                                    "," +
-                                    deviceName +
-                                    "," +
-                                    points[point] +
-                                    "," +
-                                    deviceObject[points[point]].meta.objectId.type +
-                                    "\r\n";
-
-                                if (parseInt(point) == points.length - 1 && parseInt(key) == keys.length - 1) {
-                                    // last iteration
-                                    var encodedUri = encodeURI(csvContent);
-                                    var link = document.createElement("a");
-                                    link.setAttribute("href", encodedUri);
-                                    link.setAttribute("download", "pointslist.csv");
-                                    document.body.appendChild(link);
-                                    link.click();
+                            if (device) {
+                                const deviceName = device.deviceName;
+                                const points = Object.keys(deviceObject);
+                                for (point in points) {
+                                    csvContent +=
+                                        ipAddress +
+                                        "," +
+                                        deviceId +
+                                        "," +
+                                        deviceName +
+                                        "," +
+                                        points[point] +
+                                        "," +
+                                        deviceObject[points[point]].meta.objectId.type +
+                                        "\r\n";
+
+                                    if (parseInt(point) == points.length - 1 && parseInt(key) == keys.length - 1) {
+                                        // last iteration
+                                        var encodedUri = encodeURI(csvContent);
+                                        var link = document.createElement("a");
+                                        link.setAttribute("href", encodedUri);
+                                        link.setAttribute("download", "pointslist.csv");
+                                        document.body.appendChild(link);
+                                        link.click();
+                                    }
                                 }
                             }
                         }
@@ -661,28 +660,22 @@
                             }
 
                             const devicePoints = Object.keys(device);
-                            let pointIndex = 0;
-                            doPoints(pointIndex);
 
-                            function doPoints(pointIndex) {
+                            for (let pointIndex = 0; pointIndex <= devicePoints.length; pointIndex++) {
                                 let pointName = devicePoints[pointIndex];
                                 let pointObject = device[pointName];
 
                                 //formatting json payload, still in progress
 
-                                exportJson[key][pointName] = {
-                                    meta: pointObject.meta,
-                                    objectName: pointObject.objectName,
-                                    displayName: pointObject.displayName,
-                                };
-
-                                // exportJson[key][pointName] = pointObject;
+                                if (pointObject) {
+                                    exportJson[key][pointName] = {
+                                        meta: pointObject.meta,
+                                        objectName: pointObject.objectName,
+                                        displayName: pointObject.displayName,
+                                    };
+                                }
 
-                                if (pointIndex < devicePoints.length - 1) {
-                                    //more points to read for device
-                                    pointIndex++;
-                                    doPoints(pointIndex);
-                                } else if (pointIndex == devicePoints.length - 1) {
+                                if (pointIndex == devicePoints.length - 1) {
                                     //all points have been iterated
 
                                     if (deviceIndex < devicesToExport.length - 1) {
@@ -873,6 +866,8 @@
 
             document.getElementById("node-input-object_property_simplePayload").checked = node.object_property_simplePayload;
             document.getElementById("node-input-object_property_simplePayload").onclick = handleCheckboxClick;
+            document.getElementById("node-input-object_property_simpleWithStatus").checked = node.object_property_simpleWithStatus;
+            document.getElementById("node-input-object_property_simpleWithStatus").onclick = handleCheckboxClick;
             document.getElementById("node-input-object_property_fullObject").checked = node.object_property_fullObject;
             document.getElementById("node-input-object_property_fullObject").onclick = handleCheckboxClick;
 
@@ -894,14 +889,16 @@
 
             function handleCheckboxClick() {
                 if (this.id == "node-input-object_property_simplePayload") {
-                    document.getElementById("node-input-object_property_fullObject").checked = !document.getElementById(
-                        "node-input-object_property_fullObject"
-                    ).checked;
+                    document.getElementById("node-input-object_property_fullObject").checked = false;
+                    document.getElementById("node-input-object_property_simpleWithStatus").checked = false;
+                }
+                if (this.id == "node-input-object_property_simpleWithStatus") {
+                    document.getElementById("node-input-object_property_fullObject").checked = false;
+                    document.getElementById("node-input-object_property_simplePayload").checked = false;
                 }
                 if (this.id == "node-input-object_property_fullObject") {
-                    document.getElementById("node-input-object_property_simplePayload").checked = !document.getElementById(
-                        "node-input-object_property_simplePayload"
-                    ).checked;
+                    document.getElementById("node-input-object_property_simplePayload").checked = false;
+                    document.getElementById("node-input-object_property_simpleWithStatus").checked = false;
                 }
             }
 
@@ -948,25 +945,13 @@
         },
         oneditsave: function () {
             let node = this;
-            if (node.vm.$data.devices) node.devices = node.vm.$data.devices;
             if (node.vm.$data.readDevices) node.readDevices = node.vm.$data.readDevices;
             if (node.vm.$data.pointsToRead) node.pointsToRead = node.vm.$data.pointsToRead;
-            //clear reload data function
-            if (node.reloadTimer) {
-                clearInterval(node.reloadTimer);
-                node.reloadTimer = null;
-            }
         },
         oneditcancel: function () {
             let node = this;
-            if (node.vm.$data.devices) node.devices = node.vm.$data.devices;
             if (node.vm.$data.readDevices) node.readDevices = node.vm.$data.readDevices;
             if (node.vm.$data.pointsToRead) node.pointsToRead = node.vm.$data.pointsToRead;
-            //clear reload data function
-            if (node.reloadTimer) {
-                clearInterval(node.reloadTimer);
-                node.reloadTimer = null;
-            }
         },
     });
 </script>
@@ -1264,6 +1249,21 @@
             </label>
           </div>
 
+          <div class="objectPropertiesLabel">
+            <label
+              for="node-input-object_property_simpleWithStatus"
+              style="padding-left: 4px; width: auto; align-items: start;"
+              class="objectPropertiesLabel">
+              <i class="icon-tag"></i> <span data-i18n="bitpool-bacnet.label.object_property_simpleWithStatus"></span>
+              <input
+                style="margin-left: 5px;"
+                class=" objectProp"
+                type="checkbox"
+                id="node-input-object_property_simpleWithStatus" />
+              <a style="white-space: nowrap; padding-left: 20px;">Simple With Status</a>
+            </label>
+          </div>
+
           <div class="objectPropertiesLabel">
             <label
               for="node-input-object_property_fullObject"
@@ -1278,6 +1278,7 @@
               <a style="white-space: nowrap; padding-left: 20px;">Full Object</a>
             </label>
           </div>
+
         </div>
       </div>
 

package/bacnet_read.js

@@ -22,6 +22,7 @@ module.exports = function (RED) {
     this.nodeName = config.name;
 
     this.object_property_simplePayload = config.object_property_simplePayload;
+    this.object_property_simpleWithStatus = config.object_property_simpleWithStatus;
     this.object_property_fullObject = config.object_property_fullObject;
 
 
@@ -62,6 +63,7 @@ module.exports = function (RED) {
         options: readConfig,
         objectPropertyType: {
           simplePayload: node.object_property_simplePayload,
+          simpleWithStatus: node.object_property_simpleWithStatus,
           fullObject: node.object_property_fullObject
         },
         outputType: {