@bitpoolos/edge-bacnet 1.2.7 → 1.3.0

package/bacnet_device.js

@@ -2,7 +2,7 @@ class BacnetDevice {
     constructor(fromImport, config) {
         let that = this;
 
-        if(fromImport == true) {
+        if (fromImport == true) {
             that.address = config.address;
             that.isMstp = config.isMstp;
             that.deviceId = config.deviceId;
@@ -14,27 +14,30 @@ class BacnetDevice {
             that.pointsList = config.pointsList;
             that.pointListUpdateTs = config.pointListUpdateTs;
             that.manualDiscoveryMode = config.manualDiscoveryMode;
-            that.mDiscoverInstanceRange = config.mDiscoverInstanceRange;
             that.pointListRetryCount = config.pointListRetryCount;
             that.priorityQueueIsActive = config.priorityQueueIsActive;
             that.priorityQueue = config.priorityQueue;
             that.lastPriorityQueueTS = config.lastPriorityQueueTS;
 
-            if(config.childDevices) {
+            if (config.childDevices) {
                 that.childDevices = config.childDevices;
             } else {
                 that.childDevices = [];
             }
 
-            if(config.parentDeviceId) {
+            if (config.parentDeviceId) {
                 that.parentDeviceId = config.parentDeviceId;
             } else {
                 that.parentDeviceId = null;
             }
 
-        } else if(fromImport == false) {
-            if(config.net && config.adr) {
-                that.address = {address: config.address, net: config.net, adr: config.adr};
+            that.displayName = config.displayName;
+            that.protocolServicesSupported = config.protocolServicesSupported;
+            that.isProtocolServicesSet = config.isProtocolServicesSet;
+
+        } else if (fromImport == false) {
+            if (config.net && config.adr) {
+                that.address = { address: config.address, net: config.net, adr: config.adr };
                 that.isMstp = true;
             } else {
                 that.address = config.address;
@@ -49,16 +52,27 @@ class BacnetDevice {
             that.pointsList = [];
             that.pointListUpdateTs = null;
             that.manualDiscoveryMode = false;
-            that.mDiscoverInstanceRange = {start: 0, end: 100};
             that.pointListRetryCount = 0;
             that.priorityQueueIsActive = false;
             that.priorityQueue = [];
             that.lastPriorityQueueTS = null;
             that.childDevices = [];
             that.parentDeviceId = null;
+            that.displayName = null;
+            that.protocolServicesSupported = [];
+            that.protocolServicesSupported = [];
+            that.isProtocolServicesSet = false;
         }
     }
 
+    setDisplayName(displayName) {
+        this.displayName = displayName;
+    }
+
+    getDisplayName() {
+        return this.displayName;
+    }
+
     setParentDeviceId(deviceId) {
         this.parentDeviceId = deviceId;
     }
@@ -68,9 +82,9 @@ class BacnetDevice {
     }
 
     hasChildDevices() {
-        if(this.childDevices.length > 0) {
+        if (this.childDevices.length > 0) {
             return true;
-        } else if(this.childDevices.length == 0) {
+        } else if (this.childDevices.length == 0) {
             return false;
         }
     }
@@ -78,7 +92,7 @@ class BacnetDevice {
     addChildDevice(deviceId) {
         let foundIndex = this.childDevices.findIndex(ele => ele == deviceId);
 
-        if(foundIndex == -1) {
+        if (foundIndex == -1) {
             this.childDevices.push(deviceId);
         } else {
             this.childDevices[foundIndex] = deviceId
@@ -88,7 +102,7 @@ class BacnetDevice {
     getChildDevice(deviceId) {
         let foundIndex = this.childDevices.findIndex(ele => ele == deviceId);
 
-        if(foundIndex !== -1) return this.childDevices[foundIndex];
+        if (foundIndex !== -1) return this.childDevices[foundIndex];
 
         return null;
     }
@@ -104,7 +118,7 @@ class BacnetDevice {
     getLastPriorityQueueTS() {
         return this.lastPriorityQueueTS;
     }
-    
+
     setPriorityQueueIsActive(bool) {
         this.priorityQueueIsActive = bool;
     }
@@ -115,14 +129,14 @@ class BacnetDevice {
 
     updatePriorityQueue(point) {
         let foundIndex = this.priorityQueue.findIndex(ele => ele.value.type == point.value.type && ele.value.instance == point.value.instance);
-        if(foundIndex == -1 ) {
+        if (foundIndex == -1) {
             //not found
             this.priorityQueue.push(point);
         }
 
-        if(this.priorityQueue.length > 0) {
+        if (this.priorityQueue.length > 0) {
             this.setPriorityQueueIsActive(true);
-        } else if(this.priorityQueue.length == 0) {
+        } else if (this.priorityQueue.length == 0) {
             this.setPriorityQueueIsActive(false);
         }
     }
@@ -130,20 +144,20 @@ class BacnetDevice {
     setPriorityQueue(points) {
         let queue = [];
         let keys = Object.keys(points);
-        if(keys.length > 0) {
-            keys.forEach(function(key) {
+        if (keys.length > 0) {
+            keys.forEach(function (key) {
                 let point = points[key];
-                let pointRequestObject = {type: 12, value: point.meta.objectId}
+                let pointRequestObject = { type: 12, value: point.meta.objectId }
                 queue.push(pointRequestObject);
             });
             this.priorityQueue = queue;
             this.setPriorityQueueIsActive(true);
-        } else if(keys.length == 0) {
+        } else if (keys.length == 0) {
             this.setPriorityQueueIsActive(false);
         }
     }
 
-    getPriorityQueue(){
+    getPriorityQueue() {
         return this.priorityQueue;
     }
 
@@ -153,17 +167,17 @@ class BacnetDevice {
     }
 
     updateDeviceConfig(config) {
-        if(config.address !== "" && config.address !== null && config.address !== "undefined") {
-            if(config.net && config.adr) {
-                this.address = {address: config.address, net: config.net, adr: config.adr};
+        if (config.address !== "" && config.address !== null && config.address !== "undefined") {
+            if (config.net && config.adr) {
+                this.address = { address: config.address, net: config.net, adr: config.adr };
             } else {
                 this.address = config.address;
             }
         }
-        if(Number.isInteger(config.deviceId)) this.deviceId = config.deviceId;
-        if(Number.isInteger(config.maxApdu)) this.maxApdu = config.maxApdu;
-        if(Number.isInteger(config.segmentation)) this.segmentation = config.segmentation;
-        if(Number.isInteger(config.vendorId)) this.vendorId = config.vendorId;
+        if (Number.isInteger(config.deviceId)) this.deviceId = config.deviceId;
+        if (Number.isInteger(config.maxApdu)) this.maxApdu = config.maxApdu;
+        if (Number.isInteger(config.segmentation)) this.segmentation = config.segmentation;
+        if (Number.isInteger(config.vendorId)) this.vendorId = config.vendorId;
     }
 
     getPointListRetryCount() {
@@ -178,25 +192,6 @@ class BacnetDevice {
         this.pointListRetryCount = 0;
     }
 
-    getmDiscoverInstanceRange() {
-        return this.mDiscoverInstanceRange;
-    }
-
-    setmDiscoverInstanceRange(range) {
-        this.mDiscoverInstanceRange = range;
-    }
-
-    updatemDiscoverInstanceRange(position, value) {
-        this.mDiscoverInstanceRange[position] = value;
-    }
-
-    shouldBeInManualMode() {
-        if(this.mDiscoverInstanceRange.start >= 1000000 || this.mDiscoverInstanceRange.end >= 1000000) {
-            return false;
-        }
-        return true;
-    }
-
     setManualDiscoveryMode(bool) {
         this.manualDiscoveryMode = bool;
     }
@@ -218,14 +213,29 @@ class BacnetDevice {
     }
 
     setPointsList(newPoints) {
-        for(let index = 0; index < newPoints.length; index ++){
+        for (let index = 0; index < newPoints.length; index++) {
             let newPoint = newPoints[index];
-            let foundIndex = this.pointsList.findIndex(ele => ele.value.type == newPoint.value.type && ele.value.instance == newPoint.value.instance);
-            if(foundIndex == -1 ) {
-                //not found
-                this.pointsList.push(newPoint);
+            if (newPoint) {
+                let foundIndex = this.pointsList.findIndex(ele => ele.value.type == newPoint.value.type && ele.value.instance == newPoint.value.instance);
+                if (foundIndex == -1) {
+                    //not found
+                    this.pointsList.push(newPoint);
+                }
             }
         }
+
+        this.pointsList = this.pointsList.filter((point) =>
+            point.value.type == 8 ||  //DEVICE
+            point.value.type == 0 ||  //AI
+            point.value.type == 1 ||  //AV
+            point.value.type == 2 ||  //AO
+            point.value.type == 3 ||  //BI
+            point.value.type == 4 ||  //BV
+            point.value.type == 5 ||  //BO
+            point.value.type == 13 ||  //MSI
+            point.value.type == 14 ||  //MSO
+            point.value.type == 19     //MSV
+        );
     }
 
     getDevicePoints() {
@@ -236,7 +246,7 @@ class BacnetDevice {
         return this.address;
     }
 
-    setAddress(address){
+    setAddress(address) {
         this.address = address;
     }
 
@@ -244,7 +254,7 @@ class BacnetDevice {
         return this.deviceId;
     }
 
-    setDeviceId(deviceId){
+    setDeviceId(deviceId) {
         this.deviceId = deviceId;
     }
 
@@ -252,7 +262,7 @@ class BacnetDevice {
         return this.maxApdu;
     }
 
-    setMaxApdu(maxApdu){
+    setMaxApdu(maxApdu) {
         this.maxApdu = maxApdu;
     }
 
@@ -260,7 +270,7 @@ class BacnetDevice {
         return this.segmentation;
     }
 
-    setSegmentation(segmentation){
+    setSegmentation(segmentation) {
         this.segmentation = segmentation;
     }
 
@@ -268,7 +278,7 @@ class BacnetDevice {
         return this.vendorId;
     }
 
-    setVendorId(vendorId){
+    setVendorId(vendorId) {
         this.vendorId = vendorId;
     }
 
@@ -276,7 +286,7 @@ class BacnetDevice {
         return this.lastSeen;
     }
 
-    setLastSeen(lastSeen){
+    setLastSeen(lastSeen) {
         this.lastSeen = lastSeen;
     }
 
@@ -284,14 +294,66 @@ class BacnetDevice {
         return this.deviceName;
     }
 
-    setDeviceName(deviceName){
+    setDeviceName(deviceName) {
         this.deviceName = deviceName;
+
+        if (this.getDisplayName() == null) {
+            this.setDisplayName(deviceName);
+        }
     }
 
-    getIsMstpDevice(){
+    getIsMstpDevice() {
         return this.isMstp;
     }
 
+    getIsProtocolServicesSet() {
+        return this.isProtocolServicesSet;
+    }
+
+    setIsProtocolServicesSet(boolean) {
+        this.isProtocolServicesSet = boolean;
+    }
+
+    getProtocolServicesSupported() {
+        return this.protocolServicesSupported;
+    }
+
+    setProtocolServicesSupported(bitArray) {
+        let position = 0;
+        for (let i = 0; i < bitArray.length; i++) {
+            let bitString = bitArray[i];
+            for (let x = 0; x < bitString.length; x++) {
+                let bit = bitString[x];
+                this.protocolServicesSupported[position] = bit;
+                position++;
+            }
+        }
+        this.setIsProtocolServicesSet(true);
+    }
+
+    getProtocolServiceSupport(protocol) {
+        switch (protocol) {
+            case "ReadPropertyMultiple":
+                if (this.protocolServicesSupported[14] == '1') {
+                    return true;
+                } else if (this.protocolServicesSupported[14] == '0') {
+                    return false;
+                }
+                break;
+
+            default:
+                return false;
+        }
+    }
+
+    getMstpNetworkNumber() {
+        if (this.isMstp) {
+            return this.address.net;
+        } else {
+            return false;
+        }
+    }
+
 }
 
 module.exports = { BacnetDevice };

package/bacnet_gateway.html

@@ -52,7 +52,7 @@
     // async load as in your code
     function LoadScriptsAsync(_scripts, scripts) {
       for (var i = 0; i < _scripts.length; i++) {
-        loadScript(_scripts[i], scripts[i], function () {});
+        loadScript(_scripts[i], scripts[i], function () { });
       }
     }
 
@@ -84,7 +84,57 @@
       return fetch("/bitpool-bacnet-data/clearBacnetServerPoints").then((res) => res.json());
     }
     getBacnetServerPoints() {
-        return fetch('/bitpool-bacnet-data/getBacnetServerPoints').then(res => res.json());
+      return fetch('/bitpool-bacnet-data/getBacnetServerPoints').then(res => res.json());
+    }
+    purgeDevice(device) {
+      return fetch('/bitpool-bacnet-data/purgeDevice', {
+        method: 'POST',
+        headers: {
+          'Accept': 'application/json',
+          'Content-Type': 'application/json'
+        },
+        body: JSON.stringify({ d: device })
+      }).then(res => res.json());
+    }
+    updatePointsForDevice(device) {
+      return fetch('/bitpool-bacnet-data/updatePointsForDevice', {
+        method: 'POST',
+        headers: {
+          'Accept': 'application/json',
+          'Content-Type': 'application/json'
+        },
+        body: JSON.stringify({ d: device })
+      }).then(res => res.json());
+    }
+    setDeviceDisplayName(device, displayName) {
+      return fetch('/bitpool-bacnet-data/setDeviceDisplayName', {
+        method: 'POST',
+        headers: {
+          'Accept': 'application/json',
+          'Content-Type': 'application/json'
+        },
+        body: JSON.stringify({ d: device, n: displayName })
+      }).then(res => res.json());
+    }
+    setPointDisplayName(deviceKey, pointName, pointDisplayName) {
+      return fetch('/bitpool-bacnet-data/setPointDisplayName', {
+        method: 'POST',
+        headers: {
+          'Accept': 'application/json',
+          'Content-Type': 'application/json'
+        },
+        body: JSON.stringify({ k: deviceKey, p: pointName, n: pointDisplayName })
+      }).then(res => res.json());
+    }
+    importReadList(payload) {
+      return fetch('/bitpool-bacnet-data/importReadList', {
+        method: 'POST',
+        headers: {
+          'Accept': 'application/json',
+          'Content-Type': 'application/json'
+        },
+        body: JSON.stringify({ p: payload })
+      }).then(res => res.json());
     }
   }
   RED.nodes.registerType("Bacnet-Gateway", {
@@ -101,20 +151,20 @@
       retries: { value: "5", required: true },
       broadCastAddr: { value: "255.255.255.255", required: true },
       toLogIam: { value: false },
-      discover_polling_schedule: { value: "60" },
-      discover_polling_schedule_value: { value: "1", required: true },
+      discover_polling_schedule: { value: "900" },
+      discover_polling_schedule_value: { value: "15", required: true },
       discover_polling_schedule_options: { value: "Minutes", required: true },
       deviceId: { value: 817001, required: true },
-      manual_instance_range_enabled: { value: false },
-      manual_instance_range_start: { value: 0 },
-      manual_instance_range_end: { value: 10000 },
       logErrorToConsole: { value: false },
       serverEnabled: { value: false },
-      device_read_schedule: { value: "60" },
-      device_read_schedule_value: { value: "1", required: true },
+      device_read_schedule: { value: "900" },
+      device_read_schedule_value: { value: "15", required: true },
       device_read_schedule_options: { value: "Minutes", required: true },
       deviceRangeRegisters: { value: [] },
-      cacheFileEnabled: {value: false, required: true},
+      cacheFileEnabled: { value: false, required: true },
+      sanitise_device_schedule: { value: "60", required: false },
+      sanitise_device_schedule_value: { value: "1", required: false },
+      sanitise_device_schedule_options: { value: "Hours", required: false },
     },
     networkInterfaces: [],
     inputs: 1,
@@ -187,29 +237,9 @@
 
       queryAdapters();
 
-      function setManualInstanceRangeState(state) {
-        let deviceIdRangeStart = $("#node-input-manual_instance_range_start");
-        let deviceIdRangeEnd = $("#node-input-manual_instance_range_end");
-        if (state == true) {
-          deviceIdRangeStart.removeAttr("readonly");
-          deviceIdRangeEnd.removeAttr("readonly");
-        } else if (state == false) {
-          deviceIdRangeStart.attr("readonly", true);
-          deviceIdRangeEnd.attr("readonly", true);
-        }
-      }
-
-      setManualInstanceRangeState(node.manual_instance_range_enabled);
-
-      $("#node-input-manual_instance_range_enabled").change(function (e) {
-        setManualInstanceRangeState(this.checked);
-      });
-
       if (node.vm1 == undefined) {
         const confirmDialog = document.createElement("p-confirm-dialog");
         document.getElementById("serverParent").appendChild(confirmDialog);
-        //document.getElementById("clearServerContainer").appendChild(confirmDialog);
-        
       }
 
       const { createApp, ref, onMounted } = Vue;
@@ -227,7 +257,7 @@
           };
         },
         mounted() {
-            this.getServerObjects();
+          this.getServerObjects();
         },
         methods: {
           confirmAll(event) {
@@ -239,7 +269,7 @@
               acceptClass: "p-button-danger",
               accept: () => {
                 //handle accept
-                this.nodeService.clearBacnetServerPoints().then(function() {
+                this.nodeService.clearBacnetServerPoints().then(function () {
                   app.getServerObjects();
                 });
               },
@@ -250,41 +280,41 @@
           },
           confirm(json) {
             this.$confirm.require({
-                message: 'Do you want to clear this BACnet server point? This action is not reversible',
-                header: 'Delete Confirmation',
-                icon: 'pi pi-info-circle',
-                acceptClass: 'p-button-danger',
-                accept: () => {
-                    //handle accept 
-                    let app = this;
-                    $.ajax({
-                        type: "POST",
-                        url: '/bitpool-bacnet-data/clearBacnetServerPoint',
-                        dataType: 'json',
-                        contentType: 'application/json',
-                        data: JSON.stringify(json),
-                        success: function (result) {
-                            app.getServerObjects();
-                        },
-                        timeout: 10000
-                    });
-                },
-                reject: () => {
-                    //handle reject
-                }
+              message: 'Do you want to clear this BACnet server point? This action is not reversible',
+              header: 'Delete Confirmation',
+              icon: 'pi pi-info-circle',
+              acceptClass: 'p-button-danger',
+              accept: () => {
+                //handle accept 
+                let app = this;
+                $.ajax({
+                  type: "POST",
+                  url: '/bitpool-bacnet-data/clearBacnetServerPoint',
+                  dataType: 'json',
+                  contentType: 'application/json',
+                  data: JSON.stringify(json),
+                  success: function (result) {
+                    app.getServerObjects();
+                  },
+                  timeout: 10000
+                });
+              },
+              reject: () => {
+                //handle reject
+              }
             });
           },
           getServerObjects() {
             let app = this;
             this.nodeService.getBacnetServerPoints().then(function (result) {
-                app.serverObjects = result;
+              app.serverObjects = result;
             })
           },
           formatObjectName(name) {
             //return shortened point name if longer than 50 characters
-            if(name.length > 45) {
+            if (name.length > 45) {
               return name.slice(0, 45).concat("...");
-            } 
+            }
             return name;
           }
         },
@@ -316,7 +346,7 @@
             dataType: "json",
             contentType: "application/json",
             data: JSON.stringify(jsonPayload),
-            success: function (result) {},
+            success: function (result) { },
             timeout: 10000,
           });
         };
@@ -455,6 +485,11 @@
         document.getElementById("node-input-device_read_schedule_options").value
       );
 
+      document.getElementById("node-input-sanitise_device_schedule").value = getTimePeriodInSeconds(
+        document.getElementById("node-input-sanitise_device_schedule_value").value,
+        document.getElementById("node-input-sanitise_device_schedule_options").value
+      );
+
       node.deviceRangeRegisters = [];
       let deviceRanges = $("#node-input-deviceIdRangeMatrix-container").editableList("items");
       deviceRanges.each(function (i) {
@@ -666,7 +701,7 @@
         </select>
       </div>
 
-      <div class="form-row">
+      <div class="form-row" style="display: none;">
         <label for="node-input-retries"
           ><i class="icon-tag"></i> <span data-i18n="bitpool-bacnet.label.retries"></span>Number of Retries</label
         >
@@ -705,17 +740,6 @@
         </select>
       </div>
 
-      <div class="form-row deviceIdRange">
-        <label for="node-input-device_id_range"
-          ><i class="icon-tag"></i><span data-i18n="bitpool-bacnet.label.device_id_range"></span>Point Discovery Range
-        </label>
-        <input type="checkbox" id="node-input-manual_instance_range_enabled" style="width: auto;" />
-        <a style="padding-left: 60px;">Start: </a
-        ><input type="number" id="node-input-manual_instance_range_start" style="width: 125px;" min="0" max="100000" />
-        <a style="padding-left: 35px;">End: </a
-        ><input type="number" id="node-input-manual_instance_range_end" style="width: 125px;" min="1" max="100000" />
-      </div>
-
       <div class="form-row" style="align-items: center; display: flex;">
         <label for="node-input-device_read_schedule_value"
           ><i class="icon-tag"></i> <span data-i18n="bitpool-bacnet.label.device_read_schedule"></span>Object Discover
@@ -736,6 +760,26 @@
         </select>
       </div>
 
+      <div class="form-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
+        >
+        <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;" />
+        <input
+          type="text"
+          id="node-input-sanitise_device_schedule_value"
+          placeholder="5"
+          style="width: 70px; margin-right: 5px;" />
+        <select name="timePeriod" id="node-input-sanitise_device_schedule_options" style="width: 120px; margin-right: 5px;">
+          <option value="Seconds">Seconds</option>
+          <option value="Minutes">Minutes</option>
+          <option value="Hours">Hours</option>
+          <option value="Days">Days</option>
+        </select>
+      </div>
+
       <div class="form-row">
         <label for="node-input-cacheFileEnabled"> Cache file enabled: </label>
         <input type="checkbox" id="node-input-cacheFileEnabled" style="width: auto;" />
@@ -872,4 +916,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>