@bitpoolos/edge-bacnet 1.2.8 → 1.3.1

package/bacnet_write.html

@@ -42,6 +42,10 @@
             pointsToWrite: ref([]),
             nodeService: ref(new NodeService()),
             deviceCount: ref(),
+            showDeviceNameDialog: ref(false),
+            showPointNameDialog: ref(false),
+            deviceDisplayNameValue: ref(),
+            pointDisplayNameValue: ref(),
           };
         },
         setup() {
@@ -291,11 +295,184 @@
               return false;
             }
           },
+          calculateMstpCount(slotProps) {
+            let count = 0;
+            slotProps.node.children.forEach(function (child) {
+              if (child.label.includes("MSTP")) {
+                count += child.children.length;
+              }
+            });
+
+            return count;
+          },
+          hasMstpDevices(slotProps) {
+            if (slotProps.node.children[1] && slotProps.node.children[1].children.length > 0) {
+              return true;
+            }
+            return false;
+          },
+          settingDeviceName(slotProps) {
+            let app = this;
+            if (slotProps.node.settingDisplayName) {
+              return true;
+            }
+            return false;
+          },
+          cancelDisplayNameDialog() {
+            let app = this;
+            app.deviceDisplayNameValue = "";
+            app.showDeviceNameDialog = false;
+          },
+          cancelPointNameDialog() {
+            let app = this;
+            app.pointDisplayNameValue = "";
+            app.showPointNameDialog = false;
+          },
+          onDeviceRightClick(slotProps, event) {
+            let app = this;
+            app.rightClickedDevice = slotProps;
+            event.preventDefault();
+            menu.style.setProperty("--mouse-x", event.clientX + "px");
+            menu.style.setProperty("--mouse-y", event.clientY + "px");
+            menu.style.display = "block";
+          },
+          onPointRightClick(slotProps, event) {
+            let app = this;
+            app.rightClickedPoint = slotProps;
+            event.preventDefault();
+            pointMenu.style.setProperty("--mouse-x", event.clientX + "px");
+            pointMenu.style.setProperty("--mouse-y", event.clientY + "px");
+            pointMenu.style.display = "block";
+          },
+          handleContextMenuClick(type) {
+            let app = this;
+            switch (type) {
+              case "purgeDevice":
+                app.purgeDevice(app.rightClickedDevice);
+                break;
+              case "updatePoints":
+                app.updatePointsForDevice(app.rightClickedDevice);
+                break;
+              case "addAllPoints":
+                app.addAllClicked(app.rightClickedDevice);
+                break;
+              case "removeAllPoints":
+                app.removeAllClicked(app.rightClickedDevice);
+                break;
+              case "setDeviceName":
+                app.showDeviceNameDialog = true;
+                app.deviceDisplayNameValue = app.rightClickedDevice.node.label;
+                break;
+              default:
+                break;
+            }
+          },
+          handlePointContextMenuClick(type) {
+            let app = this;
+            switch (type) {
+              case "setPointName":
+                app.showPointNameDialog = true;
+                app.pointDisplayNameValue = app.rightClickedPoint.node.label;
+                break;
+              case "updatePoint":
+                app.updatePoint(app.rightClickedDevice);
+                break;
+              default:
+                break;
+            }
+          },
+          purgeDevice(slotProps) {
+            let app = this;
+            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;
+              }
+            });
+            if (device) {
+              app.nodeService.purgeDevice(device).then(function (result) { });
+            }
+          },
+          updatePointsForDevice(slotProps) {
+            let app = this;
+            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;
+              }
+            });
+            if (device) {
+              app.nodeService.updatePointsForDevice(device).then(function (result) { });
+            }
+          },
+          updatePoint(slotProps) {
+            let app = this;
+            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;
+              }
+            });
+            if (device) {
+              app.nodeService.updatePoint(device).then(function (result) { });
+            }
+          },
+          setDeviceName() {
+            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;
+              }
+            });
+
+            if (device) {
+              app.nodeService.setDeviceDisplayName(device, displayName).then(function (result) {
+                if (result) {
+                  slotProps.node.label = displayName;
+                }
+              });
+            }
+
+            app.showDeviceNameDialog = false;
+          },
+          setPointName() {
+            let app = this;
+
+            const slotProps = app.rightClickedPoint;
+            const pointDisplayName = app.pointDisplayNameValue;
+            const pointName = slotProps.node.pointName;
+
+            let device = app.deviceList.find((ele) => {
+              return ele.deviceName == slotProps.node.parentDevice;
+            });
+
+            if (device) {
+              let deviceAddress = app.getDeviceAddress(device.address);
+              let deviceKey = `${deviceAddress}-${device.deviceId}`;
+
+              app.nodeService.setPointDisplayName(deviceKey, pointName, pointDisplayName).then(function (result) {
+                if (result) {
+                  slotProps.node.label = pointDisplayName;
+                }
+              });
+            }
+
+            app.showPointNameDialog = false;
+          },
         },
         components: {
           "p-tree": primevue.tree,
           "p-button": primevue.button,
           "p-timeline": primevue.timeline,
+          "p-dialog": primevue.dialog,
+          "p-input-text": primevue.inputtext,
         },
       };
 
@@ -337,6 +514,16 @@
       document.getElementById("node-input-applicationTag").value = node.applicationTag;
       document.getElementById("node-input-priority").value = node.priority;
 
+      var menu = document.querySelector(".context-menu");
+      window.addEventListener("click", (event) => {
+        menu.style.display = "none";
+      });
+
+      var pointMenu = document.querySelector(".point-context-menu");
+      window.addEventListener("click", (event) => {
+        pointMenu.style.display = "none";
+      });
+
       //remove loading animation
       let loadingGif = document.getElementById("loadingGif");
       let loadingText = document.getElementById("loadingText");
@@ -431,11 +618,7 @@
     .statusOffline {
       color: red;
     }
-    /*
-        .deviceLabel {
-            position: absolute;
-        }
-        */
+
     .objectPropertiesLabel {
       display: flex !important;
       flex-direction: row;
@@ -562,8 +745,110 @@
   </div>
 
   <div id="node-input-tabs-content">
+
+        <!-- Start Device Context Menu -->
+        <ul
+        class="red-ui-menu red-ui-menu-dropdown red-ui-menu-dropdown-direction-right red-ui-menu-dropdown-noicons red-ui-menu-dropdown-submenus context-menu">
+        <li class="context-menu-item" @click="handleContextMenuClick('purgeDevice')">
+          <a class="red-ui-menu-label">
+            <i class="pi pi-wrench context-menu-icon"></i>
+            <span class="context-menu-item-text">Purge Device</span>
+          </a>
+        </li>
+        <li class="context-menu-item" @click="handleContextMenuClick('updatePoints')">
+          <a class="red-ui-menu-label">
+            <i class="pi pi-refresh context-menu-icon"></i>
+            <span class="context-menu-item-text">Update Points</span>
+          </a>
+        </li>
+        <li class="red-ui-menu-divider"></li>
+        <li class="context-menu-item" @click="handleContextMenuClick('addAllPoints')">
+          <a class="red-ui-menu-label">
+            <i class="pi pi-plus-circle context-menu-icon"></i>
+            <span class="context-menu-item-text">Add All Points </span>
+          </a>
+        </li>
+        <li class="context-menu-item" @click="handleContextMenuClick('removeAllPoints')">
+          <a class="red-ui-menu-label">
+            <i class="pi pi-minus-circle context-menu-icon"></i>
+            <span class="context-menu-item-text">Remove All Points</span>
+          </a>
+        </li>
+        <li class="red-ui-menu-divider"></li>
+        <li class="context-menu-item" @click="handleContextMenuClick('setDeviceName')">
+          <a class="red-ui-menu-label">
+            <i class="pi pi-pencil context-menu-icon"></i>
+            <span class="context-menu-item-text">Set Device Name</span>
+          </a>
+        </li>
+      </ul>
+      <!-- End Device Context Menu -->
+  
+      <!-- Start Point Context Menu -->
+      <ul
+        class="red-ui-menu red-ui-menu-dropdown red-ui-menu-dropdown-direction-right red-ui-menu-dropdown-noicons red-ui-menu-dropdown-submenus point-context-menu">
+        <li class="context-menu-item" @click="handlePointContextMenuClick('setPointName')">
+          <a class="red-ui-menu-label">
+            <i class="pi pi-pencil context-menu-icon"></i>
+            <span class="context-menu-item-text">Set Point Name</span>
+          </a>
+        </li>
+        <li class="red-ui-menu-divider"></li>
+        <li class="context-menu-item" @click="handlePointContextMenuClick('updatePoint')">
+          <a class="red-ui-menu-label">
+            <i class="pi pi-refresh context-menu-icon"></i>
+            <span class="context-menu-item-text">Update Point</span>
+          </a>
+        </li>
+      </ul>
+      <!-- End Point Context Menu -->
+
+
     <div id="read-networkTree-tab" style="display:none">
       <div id="read-networkTree-tab-content" class="networkTreeContent" style="display:none">
+        <p-dialog
+          v-model:visible="showDeviceNameDialog"
+          modal
+          header="Set Display Name"
+          :style="{ width: '25rem' }"
+          class="deviceNameDialog">
+          <div class="flex align-items-center gap-3 mb-3">
+            <label for="displayName" class="font-semibold">Name</label>
+            <p-input-text id="displayName" class="flex-auto" autocomplete="off" v-model="deviceDisplayNameValue" />
+          </div>
+          <div class="flex justify-content-end gap-2">
+            <p-button
+              class="diplayNameDialogCancel"
+              type="button"
+              label="Cancel"
+              severity="secondary"
+              @click="cancelDisplayNameDialog"></p-button>
+            <p-button class="diplayNameDialogSave" type="button" label="Save" @click="setDeviceName"></p-button>
+          </div>
+        </p-dialog>
+
+        <p-dialog
+          v-model:visible="showPointNameDialog"
+          modal
+          header="Set Point Name"
+          :style="{ width: '25rem' }"
+          class="deviceNameDialog">
+          <div class="flex align-items-center gap-3 mb-3">
+            <label for="displayName" class="font-semibold">Name</label>
+            <p-input-text id="displayName" class="flex-auto" autocomplete="off" v-model="pointDisplayNameValue" />
+          </div>
+          <div class="flex justify-content-end gap-2">
+            <p-button
+              class="diplayNameDialogCancel"
+              type="button"
+              label="Cancel"
+              severity="secondary"
+              @click="cancelPointNameDialog"></p-button>
+            <p-button class="diplayNameDialogSave" type="button" label="Save" @click="setPointName"></p-button>
+          </div>
+        </p-dialog>
+
+
         <div>
           <a class="countStatus" style="margin-left: 15px;">Count: {{deviceCount}} device(s)</a>
           <button @click="getData()" class="reloadButton">
@@ -574,30 +859,50 @@
         <div id="deviceListApp">
           <p-tree :value="devices" selectable="false" :filter="true" filterMode="lenient" v-if="hasData()">
             <template #device="slotProps">
-              <div v-if="isDeviceActive(slotProps)" class="deviceLabelParent">
-                <b class="deviceLabel">{{slotProps.node.label}} <b class="statusOnline deviceStatus">Online</b></b>
-              </div>
-              <div v-else>
-                <b class="deviceLabel">{{slotProps.node.label}} <b class="statusOffline deviceStatus">Offline</b></b>
+              <div @contextmenu="onDeviceRightClick(slotProps, $event)" class="p-treenode-label">
+
+                <div v-if="isDeviceActive(slotProps)" class="deviceLabelParent">
+                  <b class="deviceLabel">
+                    <span class="statusOnline deviceStatus dotOnline dot"></span>
+                    {{slotProps.node.label}}
+                    <span v-if="hasMstpDevices(slotProps)" class="mstpDeviceCount"
+                      >&nbsp; {{calculateMstpCount(slotProps)}} &nbsp;</span
+                    > 
+                  </b>
+                </div>
+                <div v-else>
+                  <b class="deviceLabel">
+                    <span class="statusOffline deviceStatus dotOffline dot"></span>
+                    {{slotProps.node.label}} 
+                    <span v-if="hasMstpDevices(slotProps)" class="mstpDeviceCount"
+                      >&nbsp; {{calculateMstpCount(slotProps)}} &nbsp;</span
+                    >
+                  </b>
+                </div>
+
               </div>
             </template>
 
             <template #point="slotProps" v-model:class="pointContent">
-              <b class="pointLabel">{{slotProps.node.label}}</b>
-              <template v-if="isSlotAdded(slotProps)">
-                <button class="addPointButton bacnetbutton">
-                  <i class="pi pi-check-circle " style="color: #00AEEF;"></i>
-                </button>
-              </template>
-              <template v-else>
-                <button @click="addPointClicked(slotProps, this)" class="addPointButton bacnetbutton">
-                  <i class="pi pi-plus-circle "></i>
+              <div @contextmenu="onDeviceRightClick(slotProps, $event)" class="p-treenode-label">
+
+                <b class="pointLabel">{{slotProps.node.label}}</b>
+                <template v-if="isSlotAdded(slotProps)">
+                  <button class="addPointButton bacnetbutton">
+                    <i class="pi pi-check-circle " style="color: #00AEEF;"></i>
+                  </button>
+                </template>
+                <template v-else>
+                  <button @click="addPointClicked(slotProps, this)" class="addPointButton bacnetbutton">
+                    <i class="pi pi-plus-circle "></i>
+                  </button>
+                </template>
+
+                <button @click="removePointClicked(slotProps, this)" class="minusPointButton bacnetbutton">
+                  <i class="pi pi-minus-circle "></i>
                 </button>
-              </template>
+              </div>
 
-              <button @click="removePointClicked(slotProps, this)" class="minusPointButton bacnetbutton">
-                <i class="pi pi-minus-circle "></i>
-              </button>
             </template>
           </p-tree>
           <div v-else style="text-align: center; padding-top: 20px;">
@@ -755,4 +1060,4 @@
     <li><a href="https://wiki.bitpool.com/">wiki.bitpool.com</a> - find more documentation.</li>
     <li><a href="https://bacnet.org/">BACnet</a> - find more about the protocol.</li>
   </ul>
-</script>
+</script>

package/common.js

@@ -1,5 +1,5 @@
 /*
-  MIT License Copyright 2021, 2022 - Bitpool Pty Ltd
+  MIT License Copyright 2021, 2024 - Bitpool Pty Ltd
 */
 
 const { createLogger, format, transports } = require("winston");
@@ -8,6 +8,7 @@ const os = require("os");
 const { exec } = require("child_process");
 const baEnum = require("./resources/node-bacstack-ts/dist/index.js").enum;
 const fs = require("fs");
+const { BitArray } = require("./resources/bitArray.js");
 
 const logger = createLogger({
   format: format.combine(
@@ -181,7 +182,7 @@ const getIpAddress = function () {
       }
     }
 
-    if (os.version().includes("Ubuntu")) {
+    if (os.version().includes("Ubuntu") || os.version().includes("SMP")) {
       let allInterfaceName = "All interfaces";
       if (!results[allInterfaceName]) {
         results[allInterfaceName] = [];
@@ -244,7 +245,6 @@ function Read_Config_Sync() {
   try {
     data = fs.readFileSync("edge-bacnet-datastore.cfg", { encoding: "utf8", flag: "r" });
   } catch (err) {
-    console.log("Read_Config_Sync error:", err);
     data = "{}";
     Store_Config(data);
   }
@@ -261,7 +261,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 ======================================
@@ -273,7 +273,6 @@ function Read_Config_Sync_Server() {
     data = fs.readFileSync("edge-bacnet-server-datastore.cfg", { encoding: "utf8", flag: "r" });
   } catch (err) {
     if (err.errno == -4058) {
-      console.log("Edge-BACnet Server: No save file found, creating new file");
       data = "{}";
       Store_Config_Server(data);
     }
@@ -285,6 +284,24 @@ function isNumber(value) {
   return value != null && typeof value === "number" && !isNaN(value);
 }
 
+function decodeBitArray(size, bits) {
+  let array = [];
+  for (let i = 0; i < bits.length; i++) {
+    let bit = bits[i];
+    let bitString = bit.toString(2);
+    if (bitString.length < size) {
+      const remainingLength = size - bitString.length;
+      const backFillString = "0".repeat(remainingLength);
+      array.push(backFillString + bitString);
+    } else if (bitString.length == size) {
+      array.push(bitString);
+    }
+    if (i == bits.length - 1) {
+      return array;
+    }
+  };
+}
+
 module.exports = {
   BacnetConfig,
   BacnetClientConfig,
@@ -300,4 +317,5 @@ module.exports = {
   Store_Config_Server,
   Read_Config_Sync_Server,
   isNumber,
+  decodeBitArray,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bitpoolos/edge-bacnet",
-  "version": "1.2.8",
+  "version": "1.3.1",
   "description": "A bacnet gateway for node-red",
   "dependencies": {
     "@plus4nodered/ts-node-bacnet": "^1.0.0-beta.2",
@@ -50,4 +50,4 @@
     "type": "github",
     "url": "git+https://github.com/bitpool/edge-bacnet.git"
   }
-}
+}

package/resources/bitArray.js

@@ -0,0 +1,167 @@
+/* BitArray DataType */
+
+// Constructor
+function BitArray(size, bits) {
+    // Private field - array for our bits
+    this.m_bits = new Array();
+
+    //.ctor - initialize as a copy of an array of true/false or from a numeric value
+    if (bits && bits.length) {
+        for (var i = 0; i < bits.length; i++)
+            this.m_bits.push(bits[i] ? BitArray._ON : BitArray._OFF);
+    } else if (!isNaN(bits)) {
+        this.m_bits = BitArray.shred(bits).m_bits;
+    }
+    if (size && this.m_bits.length != size) {
+        if (this.m_bits.length < size) {
+            for (var i = this.m_bits.length; i < size; i++) {
+                this.m_bits.push(BitArray._OFF);
+            }
+        } else {
+            for (var i = size; i > this.m_bits.length; i--) {
+                this.m_bits.pop();
+            }
+        }
+    }
+}
+
+/* BitArray PUBLIC INSTANCE METHODS */
+
+// read-only property - number of bits 
+BitArray.prototype.getLength = function () { return this.m_bits.length; };
+
+// accessor - get bit at index 
+BitArray.prototype.getAt = function (index) {
+    if (index < this.m_bits.length) {
+        return this.m_bits[index];
+    }
+    return null;
+};
+// accessor - set bit at index 
+BitArray.prototype.setAt = function (index, value) {
+    if (index < this.m_bits.length) {
+        this.m_bits[index] = value ? BitArray._ON : BitArray._OFF;
+    }
+};
+
+// resize the bit array (append new false/0 indexes) 
+BitArray.prototype.resize = function (newSize) {
+    var tmp = new Array();
+    for (var i = 0; i < newSize; i++) {
+        if (i < this.m_bits.length) {
+            tmp.push(this.m_bits[i]);
+        } else {
+            tmp.push(BitArray._OFF);
+        }
+    }
+    this.m_bits = tmp;
+};
+
+// Get the complimentary bit array (i.e., 01 compliments 10)
+BitArray.prototype.getCompliment = function () {
+    var result = new BitArray(this.m_bits.length);
+    for (var i = 0; i < this.m_bits.length; i++) {
+        result.setAt(i, this.m_bits[i] ? BitArray._OFF : BitArray._ON);
+    }
+    return result;
+};
+
+// Get the string representation ("101010") 
+BitArray.prototype.toString = function () {
+    var s = new String();
+    for (var i = 0; i < this.m_bits.length; i++) {
+        s = s.concat(this.m_bits[i] === BitArray._ON ? "1" : "0");
+    }
+    return s;
+};
+
+// Get the numeric value 
+BitArray.prototype.toNumber = function () {
+    var pow = 0;
+    var n = 0;
+    for (var i = this.m_bits.length - 1; i >= 0; i--) {
+        if (this.m_bits[i] === BitArray._ON) {
+            n += Math.pow(2, pow);
+        }
+        pow++;
+    }
+    return n;
+};
+
+/* STATIC METHODS */
+
+// Get the union of two bit arrays
+BitArray.getUnion = function (bitArray1, bitArray2) {
+    var len = BitArray._getLen(bitArray1, bitArray2, true);
+    var result = new BitArray(len);
+    for (var i = 0; i < len; i++) {
+        result.setAt(i, BitArray._union(bitArray1.getAt(i), bitArray2.getAt(i)));
+    }
+    return result;
+};
+
+// Get the intersection of two bit arrays 
+BitArray.getIntersection = function (bitArray1, bitArray2) {
+    var len = BitArray._getLen(bitArray1, bitArray2, true);
+    var result = new BitArray(len);
+    for (var i = 0; i < len; i++) {
+        result.setAt(i, BitArray._intersect(bitArray1.getAt(i), bitArray2.getAt(i)));
+    }
+    return result;
+};
+
+// Get the difference between to bit arrays
+BitArray.getDifference = function (bitArray1, bitArray2) {
+    var len = BitArray._getLen(bitArray1, bitArray2, true);
+    var result = new BitArray(len);
+    for (var i = 0; i < len; i++) {
+        result.setAt(i, BitArray._difference(bitArray1.getAt(i), bitArray2.getAt(i)));
+    }
+    return result;
+};
+
+// Convert a number into a bit array
+BitArray.shred = function (number) {
+    var bits = new Array();
+    var q = number;
+    do {
+        bits.push(q % 2);
+        q = Math.floor(q / 2);
+    } while (q > 0);
+    return new BitArray(bits.length, bits.reverse());
+};
+
+/* BitArray PRIVATE STATIC CONSTANTS */
+BitArray._ON = 1;
+BitArray._OFF = 0;
+
+/* BitArray PRIVATE STATIC METHODS */
+
+// Calculate the intersection of two bits 
+BitArray._intersect = function (bit1, bit2) {
+    return bit1 === BitArray._ON && bit2 === BitArray._ON ? BitArray._ON : BitArray._OFF;
+};
+
+// Calculate the union of two bits 
+BitArray._union = function (bit1, bit2) {
+    return bit1 === BitArray._ON || bit2 === BitArray._ON ? BitArray._ON : BitArray._OFF;
+};
+
+// Calculate the difference of two bits 
+BitArray._difference = function (bit1, bit2) {
+    return bit1 === BitArray._ON && bit2 !== BitArray._ON ? BitArray._ON : BitArray._OFF;
+};
+
+// Get the longest or shortest (smallest) length of the two bit arrays 
+BitArray._getLen = function (bitArray1, bitArray2, smallest) {
+    var l1 = bitArray1.getLength();
+    var l2 = bitArray2.getLength();
+
+    return l1 > l2 ? smallest ? l2 : l1 : smallest ? l2 : l1;
+};
+
+module.exports = {
+    BitArray,
+}
+
+/* END BitArray DataType */