@bitpoolos/edge-bacnet 1.5.0 → 1.5.2

package/bacnet_client.js

@@ -6,7 +6,15 @@ const bacnet = require("./resources/node-bacstack-ts/dist/index.js");
 const baEnum = bacnet.enum;
 const bacnetIdMax = baEnum.ASN1_MAX_PROPERTY_ID;
 const { EventEmitter } = require("events");
-const { getUnit, roundDecimalPlaces, parseBacnetError, getBacnetErrorString, Read_Config_Sync, isNumber, decodeBitArray } = require("./common");
+const {
+  getUnit,
+  roundDecimalPlaces,
+  parseBacnetError,
+  getBacnetErrorString,
+  Read_Config_Sync,
+  isNumber,
+  decodeBitArray,
+} = require("./common");
 const { ToadScheduler, SimpleIntervalJob, Task } = require("toad-scheduler");
 const { BacnetDevice } = require("./bacnet_device");
 const { Mutex } = require("async-mutex");
@@ -65,13 +73,12 @@ class BacnetClient extends EventEmitter {
       };
 
       try {
-
         that.client = new bacnet.Client({
           apduTimeout: config.apduTimeout,
           interface: config.localIpAdrress,
           port: config.port,
           broadcastAddress: config.broadCastAddr,
-          portRangeMatrix: config.portRangeMatrix
+          portRangeMatrix: config.portRangeMatrix,
         });
         that.setMaxListeners(1);
 
@@ -193,15 +200,34 @@ class BacnetClient extends EventEmitter {
 
     let addressObject = {
       address: address,
-      port: port
+      port: port,
     };
 
+    const propertiesArray = [{ objectId: { type: type, instance: instance }, properties: [{ id: property }] }];
+
+    that.client.readPropertyMultiple(addressObject, propertiesArray, that.readPropertyMultipleOptions, (err, value) => {
+      console.log("1 - readPropertyMultiple:  ");
+
+      console.log(value);
+      if (value) {
+        // If the result has value, resolve the promise
+        console.log(value.values[0]);
+        value.values[0].values.forEach(function (value) {
+          console.log("value: ", value.value);
+        });
+      } else {
+        console.log(err);
+      }
+    });
+
     that.client.readProperty(
       addressObject,
       { type: type, instance: instance },
       property,
       that.readPropertyMultipleOptions,
       (err, value) => {
+        console.log("2 - readProperty:  ");
+
         console.log(value);
         if (value) {
           // If the result has value, resolve the promise
@@ -264,7 +290,7 @@ class BacnetClient extends EventEmitter {
     let that = this;
     let addressObject = {
       address: device.getAddress(),
-      port: device.getPort()
+      port: device.getPort(),
     };
     return new Promise((resolve, reject) => {
       that.client.readProperty(
@@ -339,6 +365,20 @@ class BacnetClient extends EventEmitter {
     });
   }
 
+  forceUpdateDevices(deviceArray) {
+    let that = this;
+    try {
+      deviceArray.forEach(async function (deviceId) {
+        let device = that.deviceList.find((ele) => ele.getDeviceId() === deviceId);
+        if (device) {
+          await that.buildJsonObject(device);
+        }
+      });
+    } catch (e) {
+      that.logOut("forceUpdateDevices error: ", e);
+    }
+  }
+
   async updatePointsForDevice(deviceObject) {
     try {
       let device = this.deviceList.find((ele) => ele.getDeviceId() === deviceObject.deviceId);
@@ -370,6 +410,7 @@ class BacnetClient extends EventEmitter {
           await this.getDevicePointListWithoutObjectList(device);
           await this.buildJsonObject(device);
         } catch (e) {
+          await this.buildJsonObject(device);
           this.logOut(`Update points list error 4: ${this.getDeviceAddress(device)}`, e);
         }
       }
@@ -469,11 +510,11 @@ class BacnetClient extends EventEmitter {
     });
   }
 
-  //test re write
   async queryDevices() {
     let that = this;
     try {
       that.pollInProgress = true;
+
       let index = 0;
       await query(index);
 
@@ -493,6 +534,7 @@ class BacnetClient extends EventEmitter {
               }
             }
             try {
+
               await that.updateDeviceName(device);
 
               if (device.getSegmentation() !== 3) {
@@ -717,6 +759,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 (device.getProtocolServiceSupport("ReadPropertyMultiple") == true) {
               await that.processBatch(device, requestArray, deviceName, bacnetResults, that, roundDecimal);
             } else {
@@ -731,6 +774,7 @@ class BacnetClient extends EventEmitter {
           // Check if all points for the device have been processed
           if (processedPoints >= totalPoints) {
             pendingRequests++;
+
             // Emit the `values` event for the current device
             that.emit(
               "values",
@@ -825,22 +869,30 @@ class BacnetClient extends EventEmitter {
     for (const request of requestArray) {
       const { objectId, pointRef, pointName } = request;
       try {
+
+
         const result = await that.updatePoint(device, pointRef);
-        const val = result.values[0].value;
 
-        if (isNumber(val)) {
-          pointRef.presentValue = roundDecimalPlaces(val, roundDecimal);
-        } else {
-          pointRef.presentValue = val;
-        }
+        //const result = await that.updatePointWithRetry(device, pointRef, 1);
 
-        pointRef.meta["device"] = deviceMetaInfo;
-        pointRef.timestamp = Date.now();
-        pointRef.status = "online";
-        pointRef.error = "none";
 
-        // Store the point data in results
-        bacnetResults[deviceName][pointName] = pointRef;
+        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);
+          } else {
+            pointRef.presentValue = val;
+          }
+
+          pointRef.meta["device"] = deviceMetaInfo;
+          pointRef.timestamp = Date.now();
+          pointRef.status = "online";
+          pointRef.error = "none";
+
+          // Store the point data in results
+          bacnetResults[deviceName][pointName] = pointRef;
+        }
       } catch (err) {
         that.logOut(`Error updating point ${pointName}:`, err);
 
@@ -856,6 +908,12 @@ class BacnetClient extends EventEmitter {
   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) {
@@ -867,11 +925,27 @@ class BacnetClient extends EventEmitter {
     });
   }
 
+  updatePointWithRetry(device, point, retryCount = 1) {
+    let that = this;
+    const tryUpdate = (retriesLeft) => {
+      return that.updatePoint(device, point).catch((err) => {
+        if (retriesLeft > 0) {
+          that.logOut(`Retrying updatePoint... Attempts left: ${retriesLeft}`);
+          return tryUpdate(retriesLeft - 1);
+        }
+        // If no retries are left, reject with the original error
+        return Promise.reject(err);
+      });
+    };
+
+    return tryUpdate(retryCount);
+  }
+
   updatePoint(device, point) {
     let that = this;
     let addressObject = {
       address: device.getAddress(),
-      port: device.getPort()
+      port: device.getPort(),
     };
     return new Promise((resolve, reject) => {
       that.client.readProperty(
@@ -1029,7 +1103,7 @@ class BacnetClient extends EventEmitter {
 
       let addressObject = {
         address: device.getAddress(),
-        port: device.getPort()
+        port: device.getPort(),
       };
 
       let index = 1;
@@ -1068,7 +1142,7 @@ class BacnetClient extends EventEmitter {
     let that = this;
     let addressObject = {
       address: device.getAddress(),
-      port: device.getPort()
+      port: device.getPort(),
     };
     return new Promise((resolve, reject) => {
       that.client.readPropertyMultiple(addressObject, requestArray, readOptions, (error, value) => {
@@ -1085,7 +1159,7 @@ class BacnetClient extends EventEmitter {
 
     let addressObject = {
       address: device.getAddress(),
-      port: device.getPort()
+      port: device.getPort(),
     };
     let deviceId = device.getDeviceId();
 
@@ -1102,7 +1176,7 @@ class BacnetClient extends EventEmitter {
     let that = this;
     let addressObject = {
       address: device.getAddress(),
-      port: device.getPort()
+      port: device.getPort(),
     };
     let deviceId = device.getDeviceId();
     try {
@@ -1150,7 +1224,7 @@ class BacnetClient extends EventEmitter {
 
     let addressObject = {
       address: device.getAddress(),
-      port: device.getPort()
+      port: device.getPort(),
     };
 
     // Define all properties to be read
@@ -1251,7 +1325,7 @@ class BacnetClient extends EventEmitter {
 
     let addressObject = {
       address: device.getAddress(),
-      port: device.getPort()
+      port: device.getPort(),
     };
 
     // Define all properties to be read
@@ -1333,7 +1407,7 @@ class BacnetClient extends EventEmitter {
         let device = that.deviceList.find((ele) => ele.getDeviceId() === point.deviceId);
         let addressObject = {
           address: device.getAddress(),
-          port: device.getPort()
+          port: device.getPort(),
         };
 
         let writeObject = {
@@ -1671,7 +1745,6 @@ class BacnetClient extends EventEmitter {
     that.buildJsonInProgress = false;
   }
 
-
   async buildJsonObject(device) {
     try {
       const pointList = device.getPointsList();
@@ -1755,32 +1828,36 @@ class BacnetClient extends EventEmitter {
 
                       switch (object.id) {
                         case baEnum.PropertyIdentifier.PRESENT_VALUE:
-                          if (object.value[0] && object.value[0].value !== "undefined" && object.value[0].value !== null) {
-                            //check for binary object type
-                            if (objectType == 3 || objectType == 4 || objectType == 5) {
-                              if (object.value[0].value == 0) {
-                                values[objectId].presentValue = false;
-                              } else if (object.value[0].value == 1) {
-                                values[objectId].presentValue = true;
-                              }
-                            } else if (objectType == 40) {
-                              //character string
-                              values[objectId].presentValue = object.value[0].value;
-                            } else if (objectType == 13 || objectType == 14 || objectType == 19) {
-                              //check for MSV MSI MSO - for enum state text
-                              if (values[objectId].stateTextArray && values[objectId].stateTextArray.length > 0) {
+                          try {
+                            if (object.value[0] && object.value[0].value !== "undefined" && object.value[0].value !== null) {
+                              //check for binary object type
+                              if (objectType == 3 || objectType == 4 || objectType == 5) {
                                 if (object.value[0].value == 0) {
-                                  values[objectId].presentValue = values[objectId].stateTextArray[object.value[0].value].value;
-                                } else if (object.value[0].value !== 0) {
-                                  values[objectId].presentValue =
-                                    values[objectId].stateTextArray[object.value[0].value - 1].value;
+                                  values[objectId].presentValue = false;
+                                } else if (object.value[0].value == 1) {
+                                  values[objectId].presentValue = true;
                                 }
+                              } else if (objectType == 40) {
+                                //character string
+                                values[objectId].presentValue = object.value[0].value;
+                              } else if (objectType == 13 || objectType == 14 || objectType == 19) {
+                                //check for MSV MSI MSO - for enum state text
+                                if (values[objectId].stateTextArray && values[objectId].stateTextArray.length > 0) {
+                                  if (object.value[0].value == 0) {
+                                    values[objectId].presentValue = values[objectId].stateTextArray[object.value[0].value].value;
+                                  } else if (object.value[0].value !== 0) {
+                                    values[objectId].presentValue =
+                                      values[objectId].stateTextArray[object.value[0].value - 1].value;
+                                  }
+                                }
+                              } else if (objectType !== 8) {
+                                values[objectId].presentValue = roundDecimalPlaces(object.value[0].value, 2);
                               }
-                            } else if (objectType !== 8) {
-                              values[objectId].presentValue = roundDecimalPlaces(object.value[0].value, 2);
                             }
+                            values[objectId].meta.arrayIndex = object.index;
+                          } catch (e) {
+                            that.logOut("buildResponse PRESENT_VALUE error: ", e);
                           }
-                          values[objectId].meta.arrayIndex = object.index;
                           break;
                         case baEnum.PropertyIdentifier.DESCRIPTION:
                           if (object.value[0]) values[objectId].description = object.value[0].value;
@@ -1828,20 +1905,24 @@ class BacnetClient extends EventEmitter {
                           }
                           break;
                         case baEnum.PropertyIdentifier.STATE_TEXT:
-                          if (object.value) {
-                            values[objectId].stateTextArray = object.value;
-                            if (
-                              typeof values[objectId].presentValue == "number" &&
-                              values[objectId].presentValue !== null &&
-                              values[objectId].presentValue !== undefined
-                            ) {
-                              const tempIndex = values[objectId].presentValue;
-                              if (tempIndex == 0) {
-                                values[objectId].presentValue = values[objectId].stateTextArray[tempIndex].value;
-                              } else if (tempIndex !== 0) {
-                                values[objectId].presentValue = values[objectId].stateTextArray[tempIndex - 1].value;
+                          try {
+                            if (object.value) {
+                              values[objectId].stateTextArray = object.value;
+                              if (
+                                typeof values[objectId].presentValue == "number" &&
+                                values[objectId].presentValue !== null &&
+                                values[objectId].presentValue !== undefined
+                              ) {
+                                const tempIndex = values[objectId].presentValue;
+                                if (tempIndex == 0) {
+                                  values[objectId].presentValue = values[objectId].stateTextArray[tempIndex].value;
+                                } else if (tempIndex !== 0) {
+                                  values[objectId].presentValue = values[objectId].stateTextArray[tempIndex - 1].value;
+                                }
                               }
                             }
+                          } catch (e) {
+                            that.logOut("buildResponse STATE_TEXT error: ", e);
                           }
                           break;
                         case baEnum.PropertyIdentifier.VENDOR_NAME:

package/bacnet_gateway.html

@@ -238,14 +238,15 @@
 
       queryAdapters();
 
-      if (node.vm1 == undefined) {
+      window.confirmDialogExists = window.confirmDialogExists || false;
+
+      if (node.vm1 == undefined && !window.confirmDialogExists) {
         const confirmDialog = document.createElement("p-confirm-dialog");
         document.getElementById("serverParent").appendChild(confirmDialog);
+        window.confirmDialogExists = true;
       }
 
       const { createApp, ref, onMounted } = Vue;
-      const ConfirmDialog = primevue.confirmdialog;
-      const ConfirmationService = primevue.confirmationservice;
       const ListBox = primevue.listbox;
 
       //prime vue app
@@ -517,7 +518,6 @@
             document.getElementById("node-input-reg-block-count-portRangeMatrix").innerHTML = $(
               "#node-input-portRangeMatrix-container"
             ).editableList("length");
-
           },
           removeItem: function (data) {
             document.getElementById("node-input-reg-block-count-portRangeMatrix").innerHTML = $(
@@ -587,7 +587,6 @@
 
       document.getElementById("node-input-reg-block-count-portRangeMatrix").innerHTML = node.portRangeRegisters.length;
       //end port range matrix
-
     },
     oneditsave: function () {
       let node = this;
@@ -619,7 +618,6 @@
         node.deviceRangeRegisters.push(mapItem);
       });
 
-
       node.portRangeRegisters = [];
       let portRanges = $("#node-input-portRangeMatrix-container").editableList("items");
       portRanges.each(function (i) {
@@ -631,7 +629,6 @@
         };
         node.portRangeRegisters.push(mapItem);
       });
-
     },
   });
 
@@ -680,10 +677,6 @@
       margin-top: 20px;
       margin-left: 50px;
     }
-    .p-confirm-dialog-accept > .p-button-label,
-    .bacnetServerRebuildSchedule_clearButton > .p-button-label {
-      color: white;
-    }
     .red-ui-editor label {
       font-size: 12px;
     }
@@ -761,8 +754,7 @@
 
       <div class="form-row bp-row" id="networkInterfaceDiv">
         <label for="node-input-local_device_address"
-          ><i class="icon-tag"></i><span data-i18n="bitpool-bacnet.label.local_device_address"></span> Network
-          Interface</label
+          ><i class="icon-tag"></i><span data-i18n="bitpool-bacnet.label.local_device_address"></span> Network Interface</label
         >
         <select id="node-input-local_device_address"></select>
       </div>
@@ -795,7 +787,6 @@
       <div class="form-row node-input-deviceIdRangeMatrix-container-row bp-row">
         <ol id="node-input-deviceIdRangeMatrix-container"></ol>
       </div>
-
     </div>
 
     <div id="read-discover-tab" style="display:none">
@@ -898,8 +889,8 @@
 
       <div class="form-row bp-row" style="align-items: center; display: none;">
         <label for="node-input-sanitise_device_schedule_value"
-          ><i class="icon-tag"></i> <span data-i18n="bitpool-bacnet.label.sanitise_device_schedule"></span>Device
-          Sanitisation Frequency</label
+          ><i class="icon-tag"></i> <span data-i18n="bitpool-bacnet.label.sanitise_device_schedule"></span>Device Sanitisation
+          Frequency</label
         >
         <p style="margin-right: 5px; margin-bottom: 0px; padding-left: 7px;">Every</p>
         <input type="text" id="node-input-sanitise_device_schedule" style="display: none;" />
@@ -917,17 +908,17 @@
       </div>
 
       <div class="form-row bp-checkbox-row">
-        <input type="checkbox" id="node-input-cacheFileEnabled" class="bp-checkbox"/>
+        <input type="checkbox" id="node-input-cacheFileEnabled" class="bp-checkbox" />
         <label for="node-input-cacheFileEnabled"> Enable cache file </label>
       </div>
 
       <div class="form-row bp-checkbox-row">
-        <input type="checkbox" id="node-input-toLogIam" class="bp-checkbox"/>
+        <input type="checkbox" id="node-input-toLogIam" class="bp-checkbox" />
         <label for="node-input-toLogIam"> Log found device </label>
       </div>
 
       <div class="form-row bp-checkbox-row" style="border-bottom: 1px solid #cbcbcb; padding-bottom: 20px;">
-        <input type="checkbox" id="node-input-logErrorToConsole" class="bp-checkbox"/>
+        <input type="checkbox" id="node-input-logErrorToConsole" class="bp-checkbox" />
         <label for="node-input-logErrorToConsole"> Log BACnet errors to console </label>
       </div>
 
@@ -949,15 +940,12 @@
 
     <div id="read-server-tab" style="display:none">
       <div class="form-row bp-checkbox-row">
-        <input type="checkbox" id="node-input-serverEnabled" class="bp-checkbox"/>
+        <input type="checkbox" id="node-input-serverEnabled" class="bp-checkbox" />
         <label for="node-input-serverEnabled"> Enable Server </label>
       </div>
 
       <div class="read_server_parent_div" id="serverParent">
-        <div
-          class="form-row bp-row clearServerContainer"
-          id="clearServerContainer"
-          style="align-items: center; display: flex;">
+        <div class="form-row bp-row clearServerContainer" id="clearServerContainer" style="align-items: center; display: flex;">
           <p-button class="bacnetServerRebuildSchedule_clearButton" @click="confirmAll($event)" label="Reinitialize Server">
           </p-button>
         </div>
@@ -990,8 +978,8 @@
   <h3><strong>Gateway Tab</strong></h3>
   <ul class="node-ports">
     <li>
-      Network Interface - the desired interface for the bacstack client to bind to. This interface must not have any other
-      BACnet clients bound to it.
+      Network Interface - the desired interface for the bacstack client to bind to. This interface must not have any other BACnet
+      clients bound to it.
     </li>
     <li>
       Broadcast Address - the desired subnet for global msgs to be broadcast and recieved on. This should be as strict as
@@ -1006,13 +994,13 @@
     <li>Max APDU Size - BACnet max apdu size</li>
     <li>Max Segments - BACnet max segments</li>
     <li>
-      Global Discover Frequency - the frequency at which the gateway issues global WhoIs BACnet commands. This should be
-      limited to the least amount possible, as over-loading a network can be a serious issue with BACnet commmunications.
+      Global Discover Frequency - the frequency at which the gateway issues global WhoIs BACnet commands. This should be limited
+      to the least amount possible, as over-loading a network can be a serious issue with BACnet commmunications.
     </li>
     <li>
-      Manual Point Discovery Instance Range - if a BACnet device doesnt have a Object list (BACnet objectType:propertyId -
-      8:76), the this bacnet client will enter into manual discovery mode, where it iterates through types and instnace
-      ranges. This range can be used to limit this manual scanning
+      Manual Point Discovery Instance Range - if a BACnet device doesnt have a Object list (BACnet objectType:propertyId - 8:76),
+      the this bacnet client will enter into manual discovery mode, where it iterates through types and instnace ranges. This
+      range can be used to limit this manual scanning
     </li>
     <li>Log Device Found - toggles logging of found devices to the node-red debug tab.</li>
     <li>Log BACnet Errors to Console - toggles logging of BACnet related errors to the node-red console</li>
@@ -1025,20 +1013,18 @@
     devices via BACnet/IP
   </p>
   <p>
-    This node only supports 2 BACnet object types, Analog Value - to show numeric data, and a Character String - to show
-    string data.
+    This node only supports 2 BACnet object types, Analog Value - to show numeric data, and a Character String - to show string
+    data.
   </p>
   <ul class="node-ports">
     <li>Enabled - toggles whether or not the local BACnet server is started or not.</li>
-    <li>
-      Clear Server Points - a schedule for the locally generated BACnet points to get cleared from the node object store
-    </li>
+    <li>Clear Server Points - a schedule for the locally generated BACnet points to get cleared from the node object store</li>
   </ul>
 
   <h3><strong>Examples</strong></h3>
   <p>
-    For example flows, please use the examples section for this node. These examples can be found at: Node-red hamburger menu
-    on top right -> Import -> Examples -> @bitpoolos/edge-bacnet
+    For example flows, please use the examples section for this node. These examples can be found at: Node-red hamburger menu on
+    top right -> Import -> Examples -> @bitpoolos/edge-bacnet
   </p>
   <p>
     To find captured examples of settings and flows, please go to our wiki

package/bacnet_gateway.js

@@ -240,6 +240,8 @@ module.exports = function (RED) {
           }).catch(function (error) {
             logOut("Error in applyDisplayNames: ", error);
           });
+      } else if (msg.forceUpdateDevices == true) {
+        node.bacnetClient.forceUpdateDevices(msg.deviceIdArray);
       }
     });