@bitpoolos/edge-bacnet 1.0.9 → 1.1.0

package/bacnet_device.js

@@ -1,21 +1,39 @@
 class BacnetDevice {
-    constructor(config) {
+    constructor(fromImport, config) {
         let that = this;
-        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;
+
+        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;
         }
-        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;
     }
 
     updateDeviceConfig(config) {
@@ -32,6 +50,14 @@ class BacnetDevice {
         if(Number.isInteger(config.vendorId)) this.vendorId = config.payload.vendorId;
     }
 
+    setManualDiscoveryMode(bool) {
+        this.manualDiscoveryMode = bool;
+    }
+
+    getManualDiscoveryMode() {
+        return this.manualDiscoveryMode;
+    }
+
     setPointListUpdateTS(ts) {
         this.pointListUpdateTs = ts;
     }

package/bacnet_gateway.html

@@ -95,17 +95,21 @@
             maxSegments: {value: "0x50", required: true},
             broadCastAddr: {value: "255.255.255.255", required: true},
             toLogIam: {value: true},
-            //toRestartNodeRed: {value: false},
             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: false},
             device_id_range_start: {value: 0},
             device_id_range_end: {value: 4194303},
-            deviceId: {value: 1234, 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},
+            bacnetServerRebuildSchedule: {value: ""},
+            bacnetServerRebuildSchedule_value: {value: "1", required: true},
+            bacnetServerRebuildSchedule_options: {value: "Hours", required: true}
         },
         networkInterfaces: [],
         inputs: 1,
@@ -141,8 +145,11 @@
                     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");
@@ -179,17 +186,17 @@
 
             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;
-                    }
-                };
-            }
+            // 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();
+            // setBroadCastAddress();
 
             function setDeviceIdRangeState(state) {
                 let deviceIdRangeStart = $("#node-input-device_id_range_start");
@@ -225,14 +232,7 @@
 
             $("#node-input-manual_instance_range_enabled").change(function(e) {
                 setManualInstanceRangeState(this.checked);
-            }); 
-
-            // document.getElementById('restart-nr-button').onclick = function () {
-            //     this.disabled = true;
-            //     document.getElementById("node-input-toRestartNodeRed").checked = true;
-            // }
-
-            // console.log("toRestartNodeRed: ", document.getElementById("node-input-toRestartNodeRed").checked);
+            });
 
         },
         oneditsave: function (test) {
@@ -242,6 +242,11 @@
                 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
+            );
         }
     });
 
@@ -295,6 +300,10 @@
                 margin-left: 50px;
             }
 
+            .red-ui-editor label {
+                font-size: 12px;
+            }
+
         </style>
 
         <div class='form-row node-input-read-tabs-row'>
@@ -330,7 +339,7 @@
     
                 <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="1234">
+                    <input type="text" id="node-input-deviceId" placeholder="817001">
                 </div>
     
                 <div class="form-row deviceIdRange">
@@ -338,7 +347,6 @@
                     <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>
 
@@ -376,7 +384,7 @@
                 </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>
+                    <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;">
@@ -388,12 +396,12 @@
                     </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> Manual Point Discovery Instance Range </label>
+                <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>
     
                 <div class="form-row">
                     <label for="node-input-toLog">
@@ -401,35 +409,73 @@
                     </label>
                     <input type="checkbox" id="node-input-toLogIam" style="width: auto;"/>
                 </div>
-            </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">
-            <label for="node-input-toRestartNodeRed">
-                Restart Node-Red: 
-            </label>
-            <button id="restart-nr-button">Restart Node-Red</button>
-            <input type="checkbox" id="node-input-toRestartNodeRed" style="display: none;"/>
-        </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>

package/bacnet_gateway.js

@@ -6,6 +6,7 @@ module.exports = function (RED) {
     const { BacnetClient } = require('./bacnet_client');
     const { BacnetClientConfig, getIpAddress, doNodeRedRestart } = require('./common');
     const { exec } = require("child_process");
+    const { BacnetServer } = require("./bacnet_server.js");
 
     function BitpoolBacnetGatewayDevice (config) {
       RED.nodes.createNode(this, config);
@@ -30,6 +31,10 @@ module.exports = function (RED) {
       this.nodeName = config.name;
       this.toRestartNodeRed = config.toRestartNodeRed;
       this.deviceId = config.deviceId;
+      this.logErrorToConsole = config.logErrorToConsole;
+      this.bacnetServerEnabled = config.serverEnabled;
+      this.bacnetServerRebuildSchedule = config.bacnetServerRebuildSchedule;
+      this.bacnetServer = nodeContext.get("bacnetServer") || null;
 
       //client and config store
       this.bacnetConfig = nodeContext.get("bacnetConfig");
@@ -68,22 +73,11 @@ module.exports = function (RED) {
               node.deviceId,
               node.manual_instance_range_enabled,
               node.manual_instance_range_start,
-              node.manual_instance_range_end
+              node.manual_instance_range_end,
+              node.bacnetServerEnabled
             );
-            nodeContext.set("bacnetConfig", node.bacnetConfig);
-
-            //console.log("toRestartNodeRed:  ", node.toRestartNodeRed);
-
-            // if(node.toRestartNodeRed == true) {
-
-            //   doNodeRedRestart().then(function(result) {
-            //     console.log("restart result: ", result);
-            //   }).catch(function(error) {
-            //     console.log("restart error: ", error);
-            //   });
 
-            //   node.toRestartNodeRed = false;
-            // }
+            nodeContext.set("bacnetConfig", node.bacnetConfig);
 
             if(typeof node.bacnetClient !== 'undefined') {
               node.bacnetClient.removeAllListeners();
@@ -94,6 +88,20 @@ module.exports = function (RED) {
               nodeContext.set("bacnetClient", node.bacnetClient);
             }
 
+            if(node.bacnetServerEnabled == true && node.bacnetClient && node.bacnetServer) {
+              node.bacnetServer.deviceId = node.deviceId;
+            }
+          }
+
+          node.bacnetClient.bacnetServerEnabled = node.bacnetServerEnabled;
+
+          if(node.bacnetServerEnabled == true && node.bacnetClient) {
+            if(node.bacnetServer == null) {
+              node.bacnetServer = new BacnetServer(node.bacnetClient, node.deviceId, node.bacnetServerRebuildSchedule, RED.version());
+              nodeContext.set("bacnetServer", node.bacnetServer);
+            }
+          } else if(node.bacnetServerEnabled == false) {
+            node.bacnetServer = null;
           }
 
           // Clears event handlers of all listeners, avoiding memory leak
@@ -105,9 +113,9 @@ module.exports = function (RED) {
               if (outputType.json && !outputType.mqtt) {
                 if(objectPropertyType.fullObject && objectPropertyType.simplePayload) {
                   sendSimpleJson(values);
-                  node.send(values);
+                  sendJsonAsMqtt(values);
                 } else if(objectPropertyType.fullObject && !objectPropertyType.simplePayload) {
-                  node.send(values);
+                  sendJsonAsMqtt(values);
                 } else if(!objectPropertyType.fullObject && objectPropertyType.simplePayload) {
                   sendSimpleJson(values);
                 }
@@ -135,15 +143,25 @@ module.exports = function (RED) {
             } 
           });
 
+          node.bacnetClient.on('bacnetErrorLog', (param1, param2) => {
+            logOut(param1, param2);
+          });
+
           node.status({});
 
       } else {
-        console.log("Issue with client info: ", node);
         // No client information found
         node.status({fill:"red",shape:"dot",text:"Please define client"})
       }
       
       node.on('input', function(msg) {
+
+        if(msg.topic && msg.payload) {
+          if(node.bacnetServer) {
+            node.bacnetServer.addObject(msg.topic, msg.payload);
+          }
+        }
+
         if(msg.type == "Read") {
 
           node.bacnetClient.doRead(msg.options, msg.outputType, msg.objectPropertyType, msg._msgid);
@@ -155,7 +173,7 @@ module.exports = function (RED) {
 
         } else if(msg.doDiscover == true) {
 
-          node.status({fill:"blue",shape:"dot",text:"Forcing a global Who is"})
+          node.status({fill:"blue",shape:"dot",text:"Sending global Who is"})
 
           node.bacnetClient.globalWhoIs();
 
@@ -171,7 +189,7 @@ module.exports = function (RED) {
       //route handler for network data
       RED.httpAdmin.get('/bitpool-bacnet-data/getNetworkTree', function(req, res) {
         if(!node.bacnetClient) {
-          console.log("Issue with the bacnetClient: ", node.bacnetClient);
+          logOut("Issue with the bacnetClient: ", node.bacnetClient);
           //no bacnet client present
           node.status({fill:"red",shape:"dot",text:"Please define client"});
           res.send(false);
@@ -180,7 +198,7 @@ module.exports = function (RED) {
             res.send(result);
           }).catch(function(error) {
             res.send(error);
-            console.log("Error getting network data:  ", error);
+            logOut("Error getting network data:  ", error);
           });
         }   
       });
@@ -188,7 +206,7 @@ module.exports = function (RED) {
       //route handler for rebuild data model command
       RED.httpAdmin.get('/bitpool-bacnet-data/rebuildDataModel', function(req, res) {
         if(!node.bacnetClient) {
-          console.log("Issue with the bacnetClient: ", node.bacnetClient);
+          logOut("Issue with the bacnetClient: ", node.bacnetClient);
           //no bacnet client present
           node.status({fill:"red",shape:"dot",text:"Please define client"});
           res.send(false);
@@ -197,7 +215,7 @@ module.exports = function (RED) {
             res.send(result);
           }).catch(function(error) {
             res.send(error);
-            console.log("Error getting network data:  ", error);
+            logOut("Error getting network data:  ", error);
           });
         }   
       });
@@ -207,7 +225,7 @@ module.exports = function (RED) {
         getIpAddress().then(function(result) {
           res.send(result);
         }).catch(function(error) {
-          console.log("Error getting network interfaces for client: ", error);
+          logOut("Error getting network interfaces for client: ", error);
         });
       });
 
@@ -221,9 +239,9 @@ module.exports = function (RED) {
           if (outputType.json && !outputType.mqtt) {
             if(objectPropertyType.fullObject && objectPropertyType.simplePayload) {
               sendSimpleJson(values);
-              node.send(values);
+              sendJsonAsMqtt(values);
             } else if(objectPropertyType.fullObject && !objectPropertyType.simplePayload) {
-              node.send(values);
+              sendJsonAsMqtt(values);
             } else if(!objectPropertyType.fullObject && objectPropertyType.simplePayload) {
               sendSimpleJson(values);
             }
@@ -245,6 +263,18 @@ module.exports = function (RED) {
         });
       }
 
+      function logOut(param1, param2) {
+        if(node.logErrorToConsole == true) {
+          if(arguments.length == 1) {
+            console.log("BACnet Error: ");
+            console.log(param1);
+          } else if(arguments.length == 2) {
+            console.log("BACnet Error: ");
+            console.log(param1, param2);
+          }
+        }
+      }
+
       // Returns true if any config values have changed
       function configHasChanged() {
         if(node.bacnetConfig == null){ return true;}
@@ -262,11 +292,13 @@ module.exports = function (RED) {
         if(node.manual_instance_range_enabled !== node.bacnetConfig.manual_instance_range_enabled){ return true;}
         if(node.manual_instance_range_start !== node.bacnetConfig.manual_instance_range_start){ return true;}
         if(node.manual_instance_range_end !== node.bacnetConfig.manual_instance_range_end){ return true;}
+        if(node.bacnetServerEnabled !== node.bacnetConfig.bacnetServerEnabled){ return true;}
+        if(node.deviceId !== node.bacnetConfig.deviceId){ return true;}
         
         return false;
       };
 
-      sendSimpleMqtt = function(values){
+      sendSimpleMqtt = function(values) {
         let devices = Object.keys(values);
         devices.forEach(function(device) {
           if(device !== "_msgid") {
@@ -294,7 +326,6 @@ module.exports = function (RED) {
         });
       };
 
-
       // Breaks down response JSON object into mqtt topic / payload
       sendAsMqtt = function(values) {
         let devices = Object.keys(values);
@@ -347,6 +378,28 @@ module.exports = function (RED) {
         });
       };
 
+      sendJsonAsMqtt = function(values) {
+        if(typeof values == "object") {
+          let keys = Object.keys(values);
+          keys.forEach(function(key) {
+            let points = values[key];
+            let msgg = {};
+
+            if(node.nodeName !== "gateway" && 
+                node.nodeName !== "" && 
+                node.nodeName !== "null" && 
+                node.nodeName !== "undefined" && 
+                typeof node.nodeName == "string") {
+                  msgg.topic = `${node.nodeName}/${key}`;
+            } else {
+              msgg.topic = `BITPOOL_BACNET_GATEWAY/${key}`;
+            }
+            msgg.payload = points;
+            node.send(msgg);
+          });
+        }
+      };
+
     };
 
     RED.nodes.registerType('Bacnet-Gateway', BitpoolBacnetGatewayDevice);