@bitpoolos/edge-bacnet 1.6.1 → 1.6.2

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## [1.6.2] - 07-05-2025
+
+Minor feature: 
+  - Added "Enable device discovery" check box to gateway settings, discovery tab. 
+    - This check box controls whether on not the auto point discovery and property discovery is enabled. 
+    - This can be used to turn off unecessary network traffic once you have discovered all of the desired devices and points.
+    - IMPORTANT - if you are updating a existing deployment, the new property will be unticked, however new installs / dragging from the pallete will by default have the option checked. So if you want to keep this enabled on an existing deployment, please check the setting. 
+    - Note - This does not turn off the whoIs task schedule.
+    - A user can use Right Click -> Update points on desired deviced in the read node tree if you would like to manually discover devices. 
+
+Minor update: 
+  - Adjusted initial whoIs broadcast delay from 5seconds to 15seconds after node-red is started with a deployed gateway. This is to ensure large cached files are completely read and loaded.
+
+Bug fixes: 
+  - Inspector:
+    - Table resized to avoid scroll bars
+    - Percentage rounding to nearest 2 decimal places rather than whole integer for more detailed data. 
+    - Loading animation added
+    - NAN years ago - removed as invalid time differential 
+    - Last seen for device points adjusted to be more accurate
+
+  
+
 ## [1.6.1] - 14-04-2025
 
 Bug fixes: 

package/bacnet_client.js

@@ -52,6 +52,7 @@ class BacnetClient extends EventEmitter {
       that.deviceRetryCount = parseInt(config.retries);
       that.sanitise_device_schedule = config.sanitise_device_schedule;
       that.buildTreeException = false;
+      that.enable_device_discovery = config.enable_device_discovery;
 
       that.readPropertyMultipleOptions = {
         maxSegments: 112,
@@ -80,11 +81,11 @@ class BacnetClient extends EventEmitter {
 
         //query device task
         const queryDevices = new Task("simple task", () => {
-          if (!that.pollInProgress) {
+          if (!that.pollInProgress && that.enable_device_discovery) {
             that.queryDevices();
           }
 
-          if (!that.buildJsonInProgress) {
+          if (!that.buildJsonInProgress && that.enable_device_discovery) {
             that.buildJsonTree();
           }
         });
@@ -106,10 +107,15 @@ class BacnetClient extends EventEmitter {
         setTimeout(() => {
           that.globalWhoIs();
           setTimeout(() => {
-            that.queryDevices();
-            that.buildJsonTree();
+            if (!that.pollInProgress && that.enable_device_discovery) {
+              that.queryDevices();
+            }
+
+            if (!that.buildJsonInProgress && that.enable_device_discovery) {
+              that.buildJsonTree();
+            }
           }, "4000");
-        }, "5000");
+        }, "15000");
 
       } catch (e) {
         that.logOut("Issue initializing client: ", e);
@@ -615,6 +621,7 @@ class BacnetClient extends EventEmitter {
     that.deviceId = config.deviceId;
     that.broadCastAddr = config.broadCastAddr;
     that.device_read_schedule = config.device_read_schedule;
+    that.enable_device_discovery = config.enable_device_discovery;
 
     if (that.scheduler !== null) {
       that.scheduler.stop();
@@ -640,11 +647,11 @@ class BacnetClient extends EventEmitter {
 
       // //query device task
       const queryDevices = new Task("simple task", () => {
-        if (!that.pollInProgress) {
+        if (!that.pollInProgress && that.enable_device_discovery) {
           that.queryDevices();
         }
 
-        if (!that.buildJsonInProgress) {
+        if (!that.buildJsonInProgress && that.enable_device_discovery) {
           that.buildJsonTree();
         }
       });

package/bacnet_gateway.html

@@ -177,6 +177,7 @@
       sanitise_device_schedule: { value: "60", required: false },
       sanitise_device_schedule_value: { value: "1", required: false },
       sanitise_device_schedule_options: { value: "Hours", required: false },
+      enable_device_discovery: { value: true, required: true },
     },
     networkInterfaces: [],
     inputs: 1,
@@ -985,6 +986,11 @@
         </select>
       </div>
 
+      <div class="form-row bp-checkbox-row">
+        <input type="checkbox" id="node-input-enable_device_discovery" class="bp-checkbox" />
+        <label for="node-input-enable_device_discovery"> Enable device discovery </label>
+      </div>
+
       <div class="form-row bp-checkbox-row">
         <input type="checkbox" id="node-input-cacheFileEnabled" class="bp-checkbox" />
         <label for="node-input-cacheFileEnabled"> Enable cache file </label>
@@ -1100,6 +1106,7 @@
       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>Enable device discovery - toggles whether automatic device discovery, object scanning, and tree building is enabled.</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>
   </ul>

package/bacnet_gateway.js

@@ -37,6 +37,7 @@ module.exports = function (RED) {
     this.portRangeRegisters = config.portRangeRegisters;
     this.cacheFileEnabled = config.cacheFileEnabled;
     this.sanitise_device_schedule = config.sanitise_device_schedule;
+    this.enable_device_discovery = config.enable_device_discovery;
 
     //client and config store
     this.bacnetConfig = nodeContext.get("bacnetConfig");
@@ -65,7 +66,8 @@ module.exports = function (RED) {
         node.retries,
         node.cacheFileEnabled,
         node.sanitise_device_schedule,
-        node.portRangeRegisters.filter((ele) => ele.enabled === true)
+        node.portRangeRegisters.filter((ele) => ele.enabled === true),
+        node.enable_device_discovery
       );
 
       if (typeof node.bacnetClient !== "undefined") {
@@ -263,7 +265,7 @@ module.exports = function (RED) {
         } else if (msg.doUpdatePriorityDevices == true && msg.priorityDevices !== null) {
           node.bacnetClient
             .updatePriorityQueue(msg.priorityDevices)
-            .then(function (result) {})
+            .then(function (result) { })
             .catch(function (error) {
               logOut("Error updating priorityQueue: ", error);
             });
@@ -277,7 +279,7 @@ module.exports = function (RED) {
 
           node.bacnetClient
             .applyDisplayNames(msg.pointsToRead)
-            .then(function (result) {})
+            .then(function (result) { })
             .catch(function (error) {
               logOut("Error in applyDisplayNames: ", error);
             });

package/bacnet_inspector_worker.js

@@ -3,10 +3,10 @@ const { Worker } = require("worker_threads");
 const path = require("path");
 
 function getRelativeTime(timestamp) {
-  if (!timestamp) return "N/A";
+  if (!timestamp || isNaN(timestamp) || typeof timestamp !== 'number') return "N/A";
   let now = Date.now();
   let timeDiff = now - timestamp;
-  if (timeDiff < 0) return "In the future";
+  if (isNaN(timeDiff) || timeDiff < 0) return "Invalid timestamp";
 
   let seconds = Math.floor(timeDiff / 1000);
   let minutes = Math.floor(seconds / 60);

package/common.js

@@ -65,7 +65,8 @@ class BacnetClientConfig {
     retries,
     cacheFileEnabled,
     sanitise_device_schedule,
-    portRangeMatrix
+    portRangeMatrix,
+    enable_device_discovery
   ) {
     this.apduTimeout = apduTimeout;
     this.localIpAdrress = localIpAdrress;
@@ -84,6 +85,7 @@ class BacnetClientConfig {
     this.cacheFileEnabled = cacheFileEnabled;
     this.sanitise_device_schedule = sanitise_device_schedule;
     this.portRangeMatrix = this.generatePortRangeArray(portRangeMatrix);
+    this.enable_device_discovery = enable_device_discovery;
   }
 
   generatePortRangeArray(rangeMatrix) {
@@ -255,7 +257,7 @@ async function Store_Config(data) {
       JSON.parse(tempContent);
     } catch (verifyError) {
       console.error("Temporary file validation failed:", verifyError);
-      await fs2.unlink(tempFile).catch(() => {});
+      await fs2.unlink(tempFile).catch(() => { });
       return false;
     }
 
@@ -275,8 +277,8 @@ async function Store_Config(data) {
 
     // Cleanup temporary file if it exists
     try {
-      await fs2.unlink(tempFile).catch(() => {});
-    } catch (cleanupError) {}
+      await fs2.unlink(tempFile).catch(() => { });
+    } catch (cleanupError) { }
 
     // If main file is corrupted and backup exists, restore from backup
     try {
@@ -396,7 +398,7 @@ async function Store_Config_Server(data) {
         //console.log("Store_Config_Server writeFile error: ", err);
       }
     });
-  } catch (err) {}
+  } catch (err) { }
 }
 
 // READ CONFIG SYNC FUNCTION - BACNET SERVER ======================================

package/inspector.html

@@ -133,9 +133,9 @@
         <div class="center">
           <p class="headertext">{{siteName}} - Point Status Display</p>
         </div>
-        <p-datatable :value="displayData" paginator :rows="12" filterDisplay="menu" :filters="filters"
-          v-model:filters="filters" :sortMode="'multiple'" @filter="onFilter" scrollable scrollHeight="800px"
-          class="datatable fixed-height-table">
+        <p-datatable :value="displayData" paginator scrollable scrollHeight="800px" :rows="12" filterDisplay="menu"
+          :filters="filters" v-model:filters="filters" :sortMode="'multiple'" @filter="onFilter"
+          class="datatable fixed-height-table" :loading="loading">
           <template #header>
             <div class="tableHeaderDiv">
               <div style="margin-right: 5px">
@@ -177,6 +177,14 @@
               </div>
             </div>
           </template>
+          <template #loading>
+            <div class="loading-overlay">
+              <div class="loading-spinner">
+                <i class="pi pi-spin pi-spinner" style="font-size: 2rem"></i>
+                <p>Loading data...</p>
+              </div>
+            </div>
+          </template>
           <p-column v-for="col in visibleColumns" :key="col.field" :field="col.field" :header="col.header" sortable
             filter></p-column>
           <template #paginatorstart>
@@ -188,6 +196,7 @@
             </span>
           </template>
         </p-datatable>
+
       </div>
     </div>
   </div>
@@ -199,7 +208,7 @@
       data() {
         return {
           tableData: null,
-          loading: false,
+          loading: true,
           totalRecords: 0,
           first: 0,
           lazyParams: {},
@@ -263,6 +272,7 @@
         this.observeHeaderHeight();
 
         this.selectedColumns = JSON.parse(JSON.stringify(this.allColumns));
+        this.loading = true;
 
         fetch("/getModelStats")
           .then((response) => {
@@ -288,19 +298,22 @@
             // Calculate percentages
             const total = tableData.length || 1; // Avoid division by zero
             app.statPercentages = {
-              readCount: Math.round((data.statCounts.readCount / total) * 100),
-              ok: Math.round((data.statCounts.statBlock.ok / total) * 100),
-              error: Math.round((data.statCounts.statBlock.error / total) * 100),
-              missing: Math.round((data.statCounts.statBlock.missing / total) * 100),
-              warnings: Math.round((data.statCounts.statBlock.warnings / total) * 100),
-              deviceIdChange: Math.round((data.statCounts.statBlock.deviceIdChange / total) * 100),
-              deviceIdConflict: Math.round((data.statCounts.statBlock.deviceIdConflict / total) * 100),
-              unmapped: Math.round((data.statCounts.statBlock.unmapped / total) * 100)
+              readCount: Math.round((data.statCounts.readCount / total) * 10000) / 100,
+              ok: Math.round((data.statCounts.statBlock.ok / total) * 10000) / 100,
+              error: Math.round((data.statCounts.statBlock.error / total) * 10000) / 100,
+              missing: Math.round((data.statCounts.statBlock.missing / total) * 10000) / 100,
+              warnings: Math.round((data.statCounts.statBlock.warnings / total) * 10000) / 100,
+              deviceIdChange: Math.round((data.statCounts.statBlock.deviceIdChange / total) * 10000) / 100,
+              deviceIdConflict: Math.round((data.statCounts.statBlock.deviceIdConflict / total) * 10000) / 100,
+              unmapped: Math.round((data.statCounts.statBlock.unmapped / total) * 10000) / 100
             };
           })
           .catch((error) => {
             // Handle any errors
             console.error("Error:", error);
+          })
+          .finally(() => {
+            app.loading = false;
           });
       },
       computed: {

package/package.json

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

package/resources/downloadAsHtml.js

@@ -146,14 +146,14 @@ async function processPrimeVueHtml(appData) {
         // Calculate percentages
         const total = this.tableData.length || 1; // Avoid division by zero
         this.statPercentages = {
-          readCount: Math.round((this.statCounts.readCount / total) * 100),
-          ok: Math.round((this.statCounts.statBlock.ok / total) * 100),
-          error: Math.round((this.statCounts.statBlock.error / total) * 100),
-          missing: Math.round((this.statCounts.statBlock.missing / total) * 100),
-          warnings: Math.round((this.statCounts.statBlock.warnings / total) * 100),
-          deviceIdChange: Math.round((this.statCounts.statBlock.deviceIdChange / total) * 100),
-          deviceIdConflict: Math.round((this.statCounts.statBlock.deviceIdConflict / total) * 100 || 0),
-          unmapped: Math.round((this.statCounts.statBlock.unmapped / total) * 100)
+          readCount: Math.round((this.statCounts.readCount / total) * 10000) / 100,
+          ok: Math.round((this.statCounts.statBlock.ok / total) * 10000) / 100,
+          error: Math.round((this.statCounts.statBlock.error / total) * 10000) / 100,
+          missing: Math.round((this.statCounts.statBlock.missing / total) * 10000) / 100,
+          warnings: Math.round((this.statCounts.statBlock.warnings / total) * 10000) / 100,
+          deviceIdChange: Math.round((this.statCounts.statBlock.deviceIdChange / total) * 10000) / 100,
+          deviceIdConflict: Math.round((this.statCounts.statBlock.deviceIdConflict / total) * 10000) / 100,
+          unmapped: Math.round((this.statCounts.statBlock.unmapped / total) * 10000) / 100
         };
       },
       computed: {

package/resources/inspectorStyles.css

@@ -183,32 +183,15 @@ body {
 }
 
 
-/* changes start */
-
-/* Add these rules to forcefully control table height */
-.fixed-height-table {
-  height: 800px !important; /* Fixed height matching scrollHeight */
-}
-
-.fixed-height-table .p-datatable-wrapper {
-  height: calc(800px - 92px) !important; /* Subtract header and paginator height */
-  min-height: calc(800px - 92px) !important;
-}
-
 .fixed-height-table .p-datatable-table {
-  min-height: 800px !important; /* Force table to maintain minimum height */
-}
-
-/* Make sure the table body expands to fill available space */
-.fixed-height-table .p-datatable-tbody {
-  min-height: 760px !important; /* Approximate calculation for body only */
+  height: 70vh !important;
 }
 
-/* Add an empty row to maintain height when filtered results are few */
 .p-datatable-emptymessage td {
   height: 760px !important;
 }
 
+
 .row-missing {
   background-color: #00adef;
 }
@@ -234,7 +217,7 @@ body {
   width: -webkit-fill-available;
   margin: 5px;
   left: 0px;
-  height: 1000px !important;
+  /* height: 1000px !important; */
 }
 
 .datatable-card {
@@ -242,7 +225,7 @@ body {
   padding-bottom: 1rem !important;
   padding-left: 2rem;
   padding-right: 2rem;
-  height: 1000px !important;
+  /* height: 1000px !important; */
 }
 
 .p-multiselect-overlay {
@@ -500,4 +483,33 @@ body {
 /* Ensure table takes minimum space when empty */
 .p-datatable-empty-message {
   height: 576px !important;
+}
+.loading-overlay {
+  position: absolute;
+  top: 0;
+  left: 0;
+  width: 100%;
+  height: 100%;
+  display: flex;
+  justify-content: center;
+  align-items: center;
+  background-color: rgba(255, 255, 255, 0.7);
+  z-index: 1000;
+}
+
+.loading-spinner {
+  display: flex;
+  flex-direction: column;
+  align-items: center;
+  gap: 1rem;
+}
+
+.loading-spinner p {
+  margin: 0;
+  color: #495057;
+  font-weight: 500;
+}
+
+.p-datatable .p-datatable-loading-overlay {
+  position: relative;
 }

package/ssrHtmlExporter.js

@@ -278,14 +278,14 @@ async function generatePrimeVueAppHtmlStatic(appData, filename = "bacnet-inspect
           // Calculate percentages
           const total = this.tableData.length || 1; // Avoid division by zero
           this.statPercentages = {
-            readCount: Math.round((this.statCounts.readCount / total) * 100) || 0,
-            ok: Math.round((this.statCounts.statBlock?.ok / total) * 100) || 0,
-            error: Math.round((this.statCounts.statBlock?.error / total) * 100) || 0,
-            missing: Math.round((this.statCounts.statBlock?.missing / total) * 100) || 0,
-            warnings: Math.round((this.statCounts.statBlock?.warnings / total) * 100) || 0,
-            deviceIdChange: Math.round((this.statCounts.statBlock?.deviceIdChange / total) * 100) || 0,
-            deviceIdConflict: Math.round((this.statCounts.statBlock?.deviceIdConflict / total) * 100) || 0,
-            unmapped: Math.round((this.statCounts.statBlock?.unmapped / total) * 100) || 0
+            readCount: Math.round((this.statCounts.readCount / total) * 10000) / 100 || 0,
+            ok: Math.round((this.statCounts.statBlock.ok / total) * 10000) / 100 || 0,
+            error: Math.round((this.statCounts.statBlock.error / total) * 10000) / 100 || 0,
+            missing: Math.round((this.statCounts.statBlock.missing / total) * 10000) / 100 || 0,
+            warnings: Math.round((this.statCounts.statBlock.warnings / total) * 10000) / 100 || 0,
+            deviceIdChange: Math.round((this.statCounts.statBlock.deviceIdChange / total) * 10000) / 100 || 0,
+            deviceIdConflict: Math.round((this.statCounts.statBlock.deviceIdConflict / total) * 10000) / 100 || 0,
+            unmapped: Math.round((this.statCounts.statBlock.unmapped / total) * 10000) / 100 || 0
           };
         },
         computed: {