@bitpoolos/edge-bacnet 1.0.6 → 1.1.0

package/bacnet_device.js

@@ -1,23 +1,61 @@
 class BacnetDevice {
-    constructor(config) {
+    constructor(fromImport, config) {
         let that = this;
-        that.address = config.address;
-        that.deviceId = config.deviceId;
-        that.maxApdu = config.maxApdu;
-        that.segmentation = config.segmentation;
-        that.vendorId = config.vendorId;
-        that.lastSeen = null;
-        that.deviceName = null;
-        that.pointsList = [];
-        that.pointListUpdateTs = null;
+
+        if(fromImport == true) {
+            that.address = config.address;
+            that.isMstp = config.isMstp;
+            that.deviceId = config.deviceId;
+            that.maxApdu = config.maxApdu;
+            that.segmentation = config.segmentation;
+            that.vendorId = config.vendorId;
+            that.lastSeen = config.lastSeen;
+            that.deviceName = config.deviceName;
+            that.pointsList = config.pointsList;
+            that.pointListUpdateTs = config.pointListUpdateTs;
+            that.manualDiscoveryMode = config.manualDiscoveryMode;
+
+        } else if(fromImport == false) {
+
+            if(config.header.source) {
+                that.address = {address: config.header.sender.address, net: config.header.source.net, adr: config.header.source.adr};
+                that.isMstp = true;
+            } else {
+                that.address = config.header.sender.address;
+                that.isMstp = false;
+            }
+            that.deviceId = config.payload.deviceId;
+            that.maxApdu = config.payload.maxApdu;
+            that.segmentation = config.payload.segmentation;
+            that.vendorId = config.payload.vendorId;
+            that.lastSeen = null;
+            that.deviceName = null;
+            that.pointsList = [];
+            that.pointListUpdateTs = null;
+            that.manualDiscoveryMode = false;
+        }
     }
 
     updateDeviceConfig(config) {
-        if(config.address !== "" && config.address !== null && config.address !== "undefined") 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(config.header.sender.address !== "" && config.header.sender.address !== null && config.header.sender.address !== "undefined") {
+            if(config.header.source) {
+                this.address = {address: config.header.sender.address, net: config.header.source.net, adr: config.header.source.adr};
+            } else {
+                this.address = config.header.sender.address;
+            }
+        }
+        if(Number.isInteger(config.deviceId)) this.deviceId = config.payload.deviceId;
+        if(Number.isInteger(config.maxApdu)) this.maxApdu = config.payload.maxApdu;
+        if(Number.isInteger(config.segmentation)) this.segmentation = config.payload.segmentation;
+        if(Number.isInteger(config.vendorId)) this.vendorId = config.payload.vendorId;
+    }
+
+    setManualDiscoveryMode(bool) {
+        this.manualDiscoveryMode = bool;
+    }
+
+    getManualDiscoveryMode() {
+        return this.manualDiscoveryMode;
     }
 
     setPointListUpdateTS(ts) {
@@ -33,7 +71,14 @@ class BacnetDevice {
     }
 
     setPointsList(newPoints) {
-        this.pointsList = newPoints;
+        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);
+            }
+        }
     }
 
     getDevicePoints() {
@@ -96,6 +141,10 @@ class BacnetDevice {
         this.deviceName = deviceName;
     }
 
+    getIsMstpDevice(){
+        return this.isMstp;
+    }
+
 }
 
 module.exports = { BacnetDevice };

package/bacnet_gateway.html

@@ -1,8 +1,6 @@
 <!-- 
   MIT License Copyright 2021, 2022 - Bitpool Pty Ltd
 -->
-
-
 <!-- PrimeVue -->
 <link href="resources/@bitpoolos/edge-bacnet/primevue-saga-blue-theme.css" rel="stylesheet" />
 <link href="resources/@bitpoolos/edge-bacnet/primevue.min.css" rel="stylesheet" />
@@ -19,7 +17,12 @@
                 async = false;
             }
             var scripts = [];
-            var _scripts = ['resources/@bitpoolos/edge-bacnet/vue.global.prod.js', 'resources/@bitpoolos/edge-bacnet/core.min.js'];
+            var _scripts = [
+                'resources/@bitpoolos/edge-bacnet/vue.global.prod.js', 
+                'resources/@bitpoolos/edge-bacnet/core.min.js',
+                'resources/@bitpoolos/edge-bacnet/confirmdialog.min.js',
+                'resources/@bitpoolos/edge-bacnet/confirmationservice.min.js'
+            ];
 
             if (async) {
                 LoadScriptsAsync(_scripts, scripts)
@@ -74,7 +77,10 @@
     class NodeService {
         getNetworkData() {
             return fetch('/bitpool-bacnet-data/getNetworkTree').then(res => res.json());
-        }
+        };
+        rebuildDataModel() {
+            return fetch('/bitpool-bacnet-data/rebuildDataModel').then(res => res.json());
+        };
     };
     RED.nodes.registerType('Bacnet-Gateway', {
         category: 'Bitpool BACnet',
@@ -92,16 +98,25 @@
             discover_polling_schedule: {value: ""},
             discover_polling_schedule_value: {value: "1", required: true},
             discover_polling_schedule_options: {value: "Minutes", required: true},
-            device_id_range_enabled: {value: true},
+            device_id_range_enabled: {value: false},
             device_id_range_start: {value: 0},
             device_id_range_end: {value: 4194303},
+            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},
+            bacnetServerRebuildSchedule: {value: ""},
+            bacnetServerRebuildSchedule_value: {value: "1", required: true},
+            bacnetServerRebuildSchedule_options: {value: "Hours", required: true}
         },
         networkInterfaces: [],
         inputs: 1,
         outputs: 1,
         icon: "bitpool.svg",
         label: function () {
-            return "gateway";
+            return this.name || "gateway";
         },
         paletteLabel: function () {
             return "gateway";
@@ -109,6 +124,33 @@
         oneditprepare: function () {
             let node = this;
 
+            let tabs = RED.tabs.create(
+                {
+                    id: "node-input-read-tabs",
+                    onchange: function (tab) {
+                        $("#node-input-tabs-content").children().hide()
+                        $("#" + tab.id).show()
+                    }
+                });
+
+            tabs.addTab(
+                {
+                    id: "read-properties-tab",
+                    label: "Gateway"
+                });
+
+            tabs.addTab(
+                {
+                    id: "read-discover-tab",
+                    label: "Discovery"
+                });
+
+            tabs.addTab(
+                {
+                    id: "read-server-tab",
+                    label: "Server"
+                });
+
             if (node.networkInterfaces && node.networkInterfaces.length > 0) {
                 let nicSelector = document.getElementById("node-input-local_device_address");
                 node.networkInterfaces.forEach(function (option) {
@@ -119,7 +161,6 @@
 
             function queryAdapters() {
                 let nicSelector = document.getElementById("node-input-local_device_address");
-
                 $.ajax({
                     url: '/bitpool-bacnet-data/getNetworkInterfaces',
                     success: function (data) {
@@ -142,8 +183,21 @@
                     timeout: 10000
                 });
             }
+
             queryAdapters();
 
+            // function setBroadCastAddress() {
+            //     let nicSelector = document.getElementById("node-input-local_device_address");
+            //     nicSelector.onchange = function(e) {
+            //         if(typeof e.target.value == "string" && e.target.value !== ""){
+            //             let broadcastAddrPrefill = e.target.value.split(".").slice(0, 3).join(".") + ".255";
+            //             document.getElementById("node-input-broadCastAddr").value = broadcastAddrPrefill;
+            //         }
+            //     };
+            // }
+
+            // setBroadCastAddress();
+
             function setDeviceIdRangeState(state) {
                 let deviceIdRangeStart = $("#node-input-device_id_range_start");
                 let deviceIdRangeEnd = $("#node-input-device_id_range_end");
@@ -162,14 +216,37 @@
                 setDeviceIdRangeState(this.checked);
             }); 
 
+            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);
+            });
+
         },
-        oneditsave: function () {
+        oneditsave: function (test) {
             let node = this;
 
             document.getElementById("node-input-discover_polling_schedule").value = getTimePeriodInSeconds(
                 document.getElementById("node-input-discover_polling_schedule_value").value,
                 document.getElementById("node-input-discover_polling_schedule_options").value
             );
+
+            document.getElementById("node-input-bacnetServerRebuildSchedule").value = getTimePeriodInSeconds(
+                document.getElementById("node-input-bacnetServerRebuildSchedule_value").value,
+                document.getElementById("node-input-bacnetServerRebuildSchedule_options").value
+            );
         }
     });
 
@@ -223,116 +300,182 @@
                 margin-left: 50px;
             }
 
-            /* .form-row deviceIdRange {
-                display: flex;
-                flex-direction: row;
-                flex-wrap: nowrap;
-                align-content: center;
-                justify-content: flex-start;
-                align-items: center;
-            } */
+            .red-ui-editor label {
+                font-size: 12px;
+            }
 
         </style>
-    
-        <div class="form-row">
-          <label for="node-input-name"><i class="icon-tag"></i><span data-i18n="bitpool-bacnet.label.name"></span> Name</label>
-          <input type="text" id="node-input-name" placeholder="Name">
-        </div>
-    
+
         <div class='form-row node-input-read-tabs-row'>
             <ul style='min-width:600px;margin-bottom:20px' id='node-input-read-tabs'></ul>
         </div>
 
-        <div class="form-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>
-            <select id="node-input-local_device_address" style="width: 70%;" >
-            </select>
-        </div>
-
-        <div class="form-row">
-            <label for="node-input-broadCastAddr"><i class="icon-tag"></i><span data-i18n="bitpool-bacnet.label.broadCastAddr"></span> Broadcast Address </label>
-            <input type="text" id="node-input-broadCastAddr" placeholder="255.255.255.255">
-        </div>
-
-        <div class="form-row">
-            <label for="node-input-local_device_port"><i class="icon-tag"></i><span data-i18n="bitpool-bacnet.label.local_device_port"></span> Local Device Port</label>
-            <input type="text" id="node-input-local_device_port" placeholder="47808">
-        </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> Device ID Range </label>
-            <input type="checkbox" id="node-input-device_id_range_enabled" style="width: auto;"/>
-            <a style="padding-left: 60px;">Start: </a><input type="number" id="node-input-device_id_range_start" style="width: 125px;" min="0" max="4194303"/>
-            <a style="padding-left: 35px;">End: </a><input type="number" id="node-input-device_id_range_end" style="width: 125px;" min="1" max="4194303"/>
-
-        </div>
-
-        <div class="form-row">
-            <label for="node-input-apduTimeout"><i class="icon-tag"></i> <span data-i18n="bitpool-bacnet.label.apduTimeout"></span>Apdu Timeout</label>
-            <input type="text" id="node-input-apduTimeout" placeholder="10000">
-        </div>
-
-        <div class="form-row">
-            <label for="node-input-apduSize"><i class="icon-tag"></i> <span data-i18n="bitpool-bacnet.label.apduSize"></span>Max Apdu Size</label>
-            <select id="node-input-apduSize">
-                <option value="0">0</option>
-                <option value="1">1</option>
-                <option value="2">2</option>
-                <option value="3">3</option>
-                <option value="4">4</option>
-                <option value="5">5</option>
-            </select>
-        </div>
-
-        <div class="form-row">
-            <label for="node-input-maxSegments"><i class="icon-tag"></i> <span data-i18n="bitpool-bacnet.label.maxSegments"></span>Max Segments</label>
-            <select id="node-input-maxSegments">
-                <option value="0">0</option>
-                <option value="0x10">0x10</option>
-                <option value="0x20">0x20</option>
-                <option value="0x30">0x30</option>
-                <option value="0x40">0x40</option>
-                <option value="0x50">0x50</option>
-                <option value="0x60">0x60</option>
-                <option value="0x70">0x70</option>
-            </select>
-        </div>
-
-        <div class="form-row" style="align-items: center; display: flex;">
-            <label for="node-input-discover_polling_schedule_value"><i class="icon-tag"></i> <span data-i18n="bitpool-bacnet.label.bacnet_polling_schedule"></span>Global Discover Frequency</label>
-            <p style="margin-right: 5px; margin-bottom: 0px; padding-left: 7px;">Every</p>
-            <input type="text" id="node-input-discover_polling_schedule" style="display: none;">
-            <input type="text" id="node-input-discover_polling_schedule_value" placeholder="5" style="width: 70px; margin-right: 5px;">
-            <select name="timePeriod" id="node-input-discover_polling_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-toLog">
-                Log found device: 
-            </label>
-            <input type="checkbox" id="node-input-toLogIam" style="width: auto;"/>
-        </div>
+        <div id='node-input-tabs-content'>
+            <div id='read-properties-tab' style='display:none'>
+                <div class="form-row">
+                    <label for="node-input-name"><i class="icon-tag"></i><span data-i18n="bitpool-bacnet.label.name"></span> Name</label>
+                    <input type="text" id="node-input-name" placeholder="Name">
+                </div>
+            
+                <div class='form-row node-input-read-tabs-row'>
+                    <ul style='min-width:600px;margin-bottom:20px' id='node-input-read-tabs'></ul>
+                </div>
+    
+                <div class="form-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>
+                    <select id="node-input-local_device_address" style="width: 70%;" >
+                    </select>
+                </div>
+    
+                <div class="form-row">
+                    <label for="node-input-broadCastAddr"><i class="icon-tag"></i><span data-i18n="bitpool-bacnet.label.broadCastAddr"></span> Broadcast Address </label>
+                    <input type="text" id="node-input-broadCastAddr" placeholder="255.255.255.255">
+                </div>
+    
+                <div class="form-row">
+                    <label for="node-input-local_device_port"><i class="icon-tag"></i><span data-i18n="bitpool-bacnet.label.local_device_port"></span> Local Device Port</label>
+                    <input type="text" id="node-input-local_device_port" placeholder="47808">
+                </div>
+    
+                <div class="form-row">
+                    <label for="node-input-deviceId"><i class="icon-tag"></i><span data-i18n="bitpool-bacnet.label.deviceId"></span> Device ID </label>
+                    <input type="text" id="node-input-deviceId" placeholder="817001">
+                </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> Device ID Range </label>
+                    <input type="checkbox" id="node-input-device_id_range_enabled" style="width: auto;"/>
+                    <a style="padding-left: 60px;">Start: </a><input type="number" id="node-input-device_id_range_start" style="width: 125px;" min="0" max="4194303"/>
+                    <a style="padding-left: 35px;">End: </a><input type="number" id="node-input-device_id_range_end" style="width: 125px;" min="1" max="4194303"/>
+                </div>
+            </div>
+
+            <div id='read-discover-tab' style='display:none'>
+
+                <div class="form-row">
+                    <label for="node-input-apduTimeout"><i class="icon-tag"></i> <span data-i18n="bitpool-bacnet.label.apduTimeout"></span>Apdu Timeout</label>
+                    <input type="text" id="node-input-apduTimeout" placeholder="10000">
+                </div>
+    
+                <div class="form-row">
+                    <label for="node-input-apduSize"><i class="icon-tag"></i> <span data-i18n="bitpool-bacnet.label.apduSize"></span>Max Apdu Size</label>
+                    <select id="node-input-apduSize">
+                        <option value="0">0</option>
+                        <option value="1">1</option>
+                        <option value="2">2</option>
+                        <option value="3">3</option>
+                        <option value="4">4</option>
+                        <option value="5">5</option>
+                    </select>
+                </div>
+    
+                <div class="form-row">
+                    <label for="node-input-maxSegments"><i class="icon-tag"></i> <span data-i18n="bitpool-bacnet.label.maxSegments"></span>Max Segments</label>
+                    <select id="node-input-maxSegments">
+                        <option value="0">0</option>
+                        <option value="0x10">0x10</option>
+                        <option value="0x20">0x20</option>
+                        <option value="0x30">0x30</option>
+                        <option value="0x40">0x40</option>
+                        <option value="0x50">0x50</option>
+                        <option value="0x60">0x60</option>
+                        <option value="0x70">0x70</option>
+                    </select>
+                </div>
+    
+                <div class="form-row" style="align-items: center; display: flex;">
+                    <label for="node-input-discover_polling_schedule_value"><i class="icon-tag"></i> <span data-i18n="bitpool-bacnet.label.bacnet_polling_schedule"></span>Discover Frequency</label>
+                    <p style="margin-right: 5px; margin-bottom: 0px; padding-left: 7px;">Every</p>
+                    <input type="text" id="node-input-discover_polling_schedule" style="display: none;">
+                    <input type="text" id="node-input-discover_polling_schedule_value" placeholder="5" style="width: 70px; margin-right: 5px;">
+                    <select name="timePeriod" id="node-input-discover_polling_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 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">
+                    <label for="node-input-toLog">
+                        Log found device: 
+                    </label>
+                    <input type="checkbox" id="node-input-toLogIam" style="width: auto;"/>
+                </div>
+
+                <div class="form-row">
+                    <label for="node-input-logErrorToConsole">
+                        Log BACnet errors to console: 
+                    </label>
+                    <input type="checkbox" id="node-input-logErrorToConsole" style="width: auto;"/>
+                </div>
+
+            </div>
+            <div id='read-server-tab' style='display:none'>
+                <div class="form-row">
+                    <label for="node-input-serverEnabled">
+                        Enabled: 
+                    </label>
+                    <input type="checkbox" id="node-input-serverEnabled" style="width: auto;"/>
+                </div>
+
+                <div class="form-row" style="align-items: center; display: flex;">
+                    <label for="node-input-bacnetServerRebuildSchedule_value"><i class="icon-tag"></i> <span data-i18n="bitpool-bacnet.label.bacnetServerRebuildSchedule"></span>Clear Server Points:</label>
+                    <p style="margin-right: 5px; margin-bottom: 0px; padding-left: 7px;">Every</p>
+                    <input type="text" id="node-input-bacnetServerRebuildSchedule" style="display: none;">
+                    <input type="text" id="node-input-bacnetServerRebuildSchedule_value" placeholder="5" style="width: 70px; margin-right: 5px;">
+                    <select name="timePeriod" id="node-input-bacnetServerRebuildSchedule_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>
 
     </script>
     <script type="text/html" data-help-name="Bacnet-Gateway">
         <p> This node is the brain of the Bitpool BACnet node collection. It acts are the gateway for all BACnet communications and functionality for the collection. </p>
     
-            <h3><strong>Properties</strong></h3>
-            <ol class="node-ports">
+            <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.</li>
                 <li>Broadcast Address - the desired subnet for global msgs to be broadcast and recieved on. This should be as strict as possible. Use 255.255.255.255 if unsure.</li>
                 <li>Local Device Port - the port to be used for BACnet comms. Default is 47808</li>
+
+            </ul>
+
+            <h3><strong>Discovery Tab</strong></h3>
+            <ul class="node-ports">
                 <li>APDU Timeout - BACnet msg timeout option</li>
                 <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.</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 </li>
                 <li>Log Device Found - toggles logging of found devices to the node-red debug tab.</li>
-            </ol>
+                <li>Log BACnet Errors to Console - toggles logging of BACnet related errors to the node-red console</li>
+            </ul>
+
+            <h3><strong>Server Tab</strong></h3>
+            <p>This section provides the ability to simulate a BACnet device and BACnet points using node-red. </p>
+            <p>Injecting a msg.topic and msg.payload into the gateway node will create a virtual point that can be discovered by other 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.</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>
+            </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</p>
+            <p>To find screen shot examples of settings and flows, please go to our wiki <a href="https://wiki.bitpool.com/en/edge/apps/bitpool-edge/nr-bacnet">here</a></p>
+
     
             <h3>Resources:</h3>
             <h4><strong>Online Docs:</strong></h4>