@bitpoolos/edge-bacnet 1.4.1 → 1.4.3

package/CHANGELOG.md

@@ -1,4 +1,47 @@
 # Changelog
+
+## [1.4.3] - 01-08-2024
+### Summary 
+
+Minor updates.
+
+Added refresh button to readList tab on read node, to handle scenarios where read node jsons may be programatically created. 
+
+Added "Use device name in topic" topic property in inject and read nodes. This option toggles whether or not the device name is included in the msg.topic. 
+
+Merge github PR 19. Added ability to configure the creation of a BacnetServer object:
+```javascript
+        payload = {
+            value: 12,
+            resolution: 0,
+            priorityArray: 0,
+            units: 0,
+        }
+```
+
+Inject nodes may need to be deleted and replaced. Try deploying node-red 2 times to instantiate the new deviceName property.
+
+
+## [1.4.2] - 23-07-2024
+### Summary 
+
+Improved UI tree generation, fixing some unique scenarios where devices were not being correctly added. 
+
+Added new payload type: Individual JSON. This publishes JSON payloads to a point level, rather than to a device or property level. 
+
+Added payload and output types to be configured via Inject node. Any checked options in the inject node will take priority over read node options. Note - to use read node output types only, please deselect all inject node output options.
+
+Added dumb BACnet parent devices to UI tree, for unique situations where MSTP devices are on a network without a parent IP device. 
+
+Bug fixes:
+ - Importing read list was incorrectly generating UI 
+ - Block per device JSON payloads were not using DisplayName and JSON key 
+ - Added node-red context variable to monitor if writeProperty event has been subscribed to, avoiding a new subscription for every node-red deploy.
+ - Fixed issue requiring Bacnet server to be constantly enabled in order for the node to function. 
+
+
+No nodes need to be deleted and replaced for this update. 
+
 ## [1.4.1] - 09-07-2024
 
 ### Summary

package/README.md

@@ -39,6 +39,8 @@ $ npm install @bitpoolos/edge-bacnet
 The module can be updated via the Node-RED pallette manager, or via the npm cli. 
 
 ```javascript
+Note: the following is our reccommendation based on error encountered in our experience. The below steps are mostly critical for updates that modify or add new properties to the UI of a node. Refer to comments in changelog.
+
 Upon updating to the latest version, we highly recommend:
  - Check out the changelog for latest feature notes and updates 
  - Remove all @bitpoolos/edge-bacnet nodes from all flows 

package/bacnet_gateway.js

@@ -45,8 +45,6 @@ module.exports = function (RED) {
     //determines whether or not to log a found device on whoIs response
     this.toLogIam = config.toLogIam;
 
-    this.websocketListener = null;
-
     node.bacnetConfig = new BacnetClientConfig(
       node.apduTimeout,
       node.localDeviceAddress,
@@ -75,6 +73,8 @@ module.exports = function (RED) {
     } else {
       node.bacnetClient = new BacnetClient(node.bacnetConfig);
       nodeContext.set("bacnetClient", node.bacnetClient);
+
+      nodeContext.set("serverWritePropEvent", false);
     }
 
     node.bacnetClient.scanMatrix = node.deviceRangeRegisters.filter((ele) => ele.enabled === true);
@@ -107,29 +107,42 @@ module.exports = function (RED) {
             node.status({});
           }, 3000);
         }
-        if (outputType.json && !outputType.mqtt) {
+        let useDeviceName = outputType.useDeviceName;
+        if (outputType.json && !outputType.mqtt && !outputType.pointJson) {
           //json
           if (objectPropertyType.simpleWithStatus && !objectPropertyType.fullObject && !objectPropertyType.simplePayload) {
             //simpleWithStatus
-            sendSimpleWithStatus(values, readNodeName, true);
+            sendSimpleWithStatus(values, readNodeName, true, useDeviceName);
           } else if (objectPropertyType.fullObject && !objectPropertyType.simplePayload && !objectPropertyType.simpleWithStatus) {
             //fullObject
-            sendJsonAsMqtt(values, readNodeName);
+            sendJsonAsMqtt(values, readNodeName, useDeviceName);
           } else if (objectPropertyType.simplePayload && !objectPropertyType.fullObject && !objectPropertyType.simpleWithStatus) {
             //simplePayload
-            sendSimpleJson(values, readNodeName);
+            sendSimpleJson(values, readNodeName, useDeviceName);
           }
-        } else if (!outputType.json && outputType.mqtt) {
+        } else if (outputType.mqtt && !outputType.json && !outputType.pointJson) {
           //mqtt
           if (objectPropertyType.simpleWithStatus && !objectPropertyType.fullObject && !objectPropertyType.simplePayload) {
             //simpleWithStatus
-            sendSimpleWithStatus(values, readNodeName, false);
+            sendSimpleWithStatus(values, readNodeName, false, useDeviceName);
+          } else if (objectPropertyType.fullObject && !objectPropertyType.simplePayload && !objectPropertyType.simpleWithStatus) {
+            //fullObject
+            sendAsMqtt(values, readNodeName, useDeviceName);
+          } else if (objectPropertyType.simplePayload && !objectPropertyType.fullObject && !objectPropertyType.simpleWithStatus) {
+            //simplePayload
+            sendSimpleMqtt(values, readNodeName, useDeviceName);
+          }
+        } else if (outputType.pointJson && !outputType.json && !outputType.mqtt) {
+          //pointJson
+          if (objectPropertyType.simpleWithStatus && !objectPropertyType.fullObject && !objectPropertyType.simplePayload) {
+            //simpleWithStatus
+            sendSimpleWithStatus(values, readNodeName, false, useDeviceName);
           } else if (objectPropertyType.fullObject && !objectPropertyType.simplePayload && !objectPropertyType.simpleWithStatus) {
             //fullObject
-            sendAsMqtt(values, readNodeName);
+            sendIndividualMsgJson(values, readNodeName, useDeviceName);
           } else if (objectPropertyType.simplePayload && !objectPropertyType.fullObject && !objectPropertyType.simpleWithStatus) {
             //simplePayload
-            sendSimpleMqtt(values, readNodeName);
+            sendSimpleJsonPerPoint(values, readNodeName, useDeviceName);
           }
         }
       }
@@ -164,22 +177,25 @@ module.exports = function (RED) {
       }
     }
 
-    node.bacnetServer.on("writeProperty", (topic, newValue) => {
-      let formattedTopic = topic;
-      if (
-        node.nodeName !== "gateway" &&
-        node.nodeName !== "" &&
-        node.nodeName !== "null" &&
-        node.nodeName !== "undefined" &&
-        typeof node.nodeName == "string"
-      ) {
-        formattedTopic = `${node.nodeName}/BITPOOL_EDGE_BACNET_GATEWAY/BACNET_SERVER/${topic}`;
-      } else {
-        formattedTopic = `BITPOOL_EDGE_BACNET_GATEWAY/BACNET_SERVER/${topic}`;
-      }
+    if (node.bacnetServerEnabled == true && node.bacnetClient && node.bacnetServer && nodeContext.get("serverWritePropEvent") == false) {
+      node.bacnetServer.on("writeProperty", (topic, newValue) => {
+        let formattedTopic = topic;
+        if (
+          node.nodeName !== "gateway" &&
+          node.nodeName !== "" &&
+          node.nodeName !== "null" &&
+          node.nodeName !== "undefined" &&
+          typeof node.nodeName == "string"
+        ) {
+          formattedTopic = `${node.nodeName}/BITPOOL_EDGE_BACNET_GATEWAY/BACNET_SERVER/${topic}`;
+        } else {
+          formattedTopic = `BITPOOL_EDGE_BACNET_GATEWAY/BACNET_SERVER/${topic}`;
+        }
 
-      node.send({ payload: newValue, topic: formattedTopic });
-    });
+        node.send({ payload: newValue, topic: formattedTopic });
+      });
+      nodeContext.set("serverWritePropEvent", true);
+    }
 
     node.on("input", function (msg) {
       if (msg.topic && msg.payload !== null) {
@@ -441,29 +457,42 @@ module.exports = function (RED) {
               node.status({});
             }, 3000);
           }
-          if (outputType.json && !outputType.mqtt) {
+          let useDeviceName = outputType.useDeviceName;
+          if (outputType.json && !outputType.mqtt && !outputType.pointJson) {
             //json
             if (objectPropertyType.simpleWithStatus && !objectPropertyType.fullObject && !objectPropertyType.simplePayload) {
               //simpleWithStatus
-              sendSimpleWithStatus(values, readNodeName, true);
+              sendSimpleWithStatus(values, readNodeName, true, useDeviceName);
             } else if (objectPropertyType.fullObject && !objectPropertyType.simplePayload && !objectPropertyType.simpleWithStatus) {
               //fullObject
-              sendJsonAsMqtt(values, readNodeName);
+              sendJsonAsMqtt(values, readNodeName, useDeviceName);
             } else if (objectPropertyType.simplePayload && !objectPropertyType.fullObject && !objectPropertyType.simpleWithStatus) {
               //simplePayload
-              sendSimpleJson(values, readNodeName);
+              sendSimpleJson(values, readNodeName, useDeviceName);
             }
-          } else if (!outputType.json && outputType.mqtt) {
+          } else if (outputType.mqtt && !outputType.json && !outputType.pointJson) {
             //mqtt
             if (objectPropertyType.simpleWithStatus && !objectPropertyType.fullObject && !objectPropertyType.simplePayload) {
               //simpleWithStatus
-              sendSimpleWithStatus(values, readNodeName, false);
+              sendSimpleWithStatus(values, readNodeName, false, useDeviceName);
+            } else if (objectPropertyType.fullObject && !objectPropertyType.simplePayload && !objectPropertyType.simpleWithStatus) {
+              //fullObject
+              sendAsMqtt(values, readNodeName, useDeviceName);
+            } else if (objectPropertyType.simplePayload && !objectPropertyType.fullObject && !objectPropertyType.simpleWithStatus) {
+              //simplePayload
+              sendSimpleMqtt(values, readNodeName, useDeviceName);
+            }
+          } else if (outputType.pointJson && !outputType.json && !outputType.mqtt) {
+            //pointJson
+            if (objectPropertyType.simpleWithStatus && !objectPropertyType.fullObject && !objectPropertyType.simplePayload) {
+              //simpleWithStatus
+              sendSimpleWithStatus(values, readNodeName, false, useDeviceName);
             } else if (objectPropertyType.fullObject && !objectPropertyType.simplePayload && !objectPropertyType.simpleWithStatus) {
               //fullObject
-              sendAsMqtt(values, readNodeName);
+              sendIndividualMsgJson(values, readNodeName, useDeviceName);
             } else if (objectPropertyType.simplePayload && !objectPropertyType.fullObject && !objectPropertyType.simpleWithStatus) {
               //simplePayload
-              sendSimpleMqtt(values, readNodeName);
+              sendSimpleJsonPerPoint(values, readNodeName, useDeviceName);
             }
           }
         }
@@ -487,14 +516,94 @@ module.exports = function (RED) {
       }
     }
 
-    function getPointName(object, pointName) {
-      if (object.displayName) {
-        return object.displayName;
+    function getTopicString(type, useDeviceName, readNodeName, device, pointName, prop) {
+      let topic = "";
+      if (
+        node.nodeName !== "gateway" &&
+        node.nodeName !== "" &&
+        node.nodeName !== "null" &&
+        node.nodeName !== "undefined" &&
+        typeof node.nodeName == "string"
+      ) {
+        if (readNodeName !== '' &&
+          readNodeName !== null &&
+          readNodeName !== undefined
+        ) {
+          if (useDeviceName) {
+            topic = `${node.nodeName}/${readNodeName}/${device}`;
+          } else {
+            topic = `${node.nodeName}/${readNodeName}`;
+          }
+
+        } else {
+          if (useDeviceName) {
+            topic = `${node.nodeName}/${device}`;
+          } else {
+            topic = `${node.nodeName}`;
+          }
+        }
+      } else {
+        if (readNodeName !== '' &&
+          readNodeName !== null &&
+          readNodeName !== undefined
+        ) {
+          if (useDeviceName) {
+            topic = `BITPOOL_BACNET_GATEWAY/${readNodeName}/${device}`;
+          } else {
+            topic = `BITPOOL_BACNET_GATEWAY/${readNodeName}`;
+          }
+
+        } else {
+          if (useDeviceName) {
+            topic = `BITPOOL_BACNET_GATEWAY/${device}`;
+          } else {
+            topic = `BITPOOL_BACNET_GATEWAY`;
+          }
+        }
       }
-      return pointName;
+
+      switch (type) {
+        case "sendSimpleWithStatus":
+          topic += `/${pointName}`;
+          break;
+
+        case "sendSimpleWithStatusJson":
+          //do nothing
+          break;
+
+        case "sendSimpleMqtt":
+          topic += `/${pointName}`;
+          break;
+
+        case "sendAsMqtt":
+          topic += `/${pointName}/${prop}`;
+          break;
+
+        case "sendSimpleJson":
+          //do nothing
+          break;
+
+        case "sendJsonAsMqtt":
+          //do nothing
+          break;
+
+        case "sendIndividualMsgJson":
+          topic += `/${pointName}`;
+          break;
+
+        case "sendSimpleJsonPerPoint":
+          topic += `/${pointName}`;
+          break;
+
+        default:
+          break;
+      }
+
+      return topic;
+
     }
 
-    sendSimpleWithStatus = function (values, readNodeName, isJson) {
+    sendSimpleWithStatus = function (values, readNodeName, isJson, useDeviceName) {
       let devices = Object.keys(values);
       devices.forEach(function (device) {
         if (device !== "_msgid") {
@@ -504,31 +613,9 @@ module.exports = function (RED) {
           for (let point in points) {
             if (points[point] && "presentValue" in points[point]) {
               let pointName = getPointName(points[point], point);
-              if (
-                node.nodeName !== "gateway" &&
-                node.nodeName !== "" &&
-                node.nodeName !== "null" &&
-                node.nodeName !== "undefined" &&
-                typeof node.nodeName == "string"
-              ) {
-                if (readNodeName !== '' &&
-                  readNodeName !== null &&
-                  readNodeName !== undefined
-                ) {
-                  msgg.topic = `${node.nodeName}/${readNodeName}/${device}/${pointName}`;
-                } else {
-                  msgg.topic = `${node.nodeName}/${device}/${pointName}`;
-                }
-              } else {
-                if (readNodeName !== '' &&
-                  readNodeName !== null &&
-                  readNodeName !== undefined
-                ) {
-                  msgg.topic = `BITPOOL_BACNET_GATEWAY/${readNodeName}/${device}/${pointName}`;
-                } else {
-                  msgg.topic = `BITPOOL_BACNET_GATEWAY/${device}/${pointName}`;
-                }
-              }
+              let topic = getTopicString("sendSimpleWithStatus", useDeviceName, readNodeName, device, pointName);
+
+              msgg.topic = topic;
               let payload = {
                 presentValue: points[point]["presentValue"],
                 timestamp: points[point]["timestamp"],
@@ -549,32 +636,7 @@ module.exports = function (RED) {
 
           if (isJson) {
             //json payload
-            let topic = "";
-            if (
-              node.nodeName !== "gateway" &&
-              node.nodeName !== "" &&
-              node.nodeName !== "null" &&
-              node.nodeName !== "undefined" &&
-              typeof node.nodeName == "string"
-            ) {
-              if (readNodeName !== '' &&
-                readNodeName !== null &&
-                readNodeName !== undefined
-              ) {
-                topic = `${node.nodeName}/${readNodeName}/${device}`;
-              } else {
-                topic = `${node.nodeName}/${device}`;
-              }
-            } else {
-              if (readNodeName !== '' &&
-                readNodeName !== null &&
-                readNodeName !== undefined
-              ) {
-                topic = `BITPOOL_BACNET_GATEWAY/${readNodeName}/${device}`;
-              } else {
-                topic = `BITPOOL_BACNET_GATEWAY/${device}`;
-              }
-            }
+            let topic = getTopicString("sendSimpleWithStatusJson", useDeviceName, readNodeName, device);
 
             msgg.topic = topic;
             msgg.payload = structuredObject;
@@ -585,7 +647,7 @@ module.exports = function (RED) {
       });
     }
 
-    sendSimpleMqtt = function (values, readNodeName) {
+    sendSimpleMqtt = function (values, readNodeName, useDeviceName) {
       let devices = Object.keys(values);
       devices.forEach(function (device) {
         if (device !== "_msgid") {
@@ -597,31 +659,9 @@ module.exports = function (RED) {
               pointProps.forEach(function (prop) {
                 let msg = {};
                 if (prop == "presentValue") {
-                  if (
-                    node.nodeName !== "gateway" &&
-                    node.nodeName !== "" &&
-                    node.nodeName !== "null" &&
-                    node.nodeName !== "undefined" &&
-                    typeof node.nodeName == "string"
-                  ) {
-                    if (readNodeName !== '' &&
-                      readNodeName !== null &&
-                      readNodeName !== undefined
-                    ) {
-                      msg.topic = `${node.nodeName}/${readNodeName}/${device}/${pointName}`;
-                    } else {
-                      msg.topic = `${node.nodeName}/${device}/${pointName}`;
-                    }
-                  } else {
-                    if (readNodeName !== '' &&
-                      readNodeName !== null &&
-                      readNodeName !== undefined
-                    ) {
-                      msg.topic = `BITPOOL_BACNET_GATEWAY/${readNodeName}/${device}/${pointName}`;
-                    } else {
-                      msg.topic = `BITPOOL_BACNET_GATEWAY/${device}/${pointName}`;
-                    }
-                  }
+                  let topic = getTopicString("sendSimpleMqtt", useDeviceName, readNodeName, device, pointName);
+
+                  msg.topic = topic;
                   msg.payload = points[point][prop];
                   node.send(msg);
                 }
@@ -633,7 +673,7 @@ module.exports = function (RED) {
     };
 
     // Breaks down response JSON object into mqtt topic / payload
-    sendAsMqtt = function (values, readNodeName) {
+    sendAsMqtt = function (values, readNodeName, useDeviceName) {
       let devices = Object.keys(values);
       devices.forEach(function (device) {
         if (device !== "_msgid") {
@@ -645,31 +685,8 @@ module.exports = function (RED) {
               pointProps.forEach(function (prop) {
                 let msg = {};
                 if (prop !== "objectName") {
-                  if (
-                    node.nodeName !== "gateway" &&
-                    node.nodeName !== "" &&
-                    node.nodeName !== "null" &&
-                    node.nodeName !== "undefined" &&
-                    typeof node.nodeName == "string"
-                  ) {
-                    if (readNodeName !== '' &&
-                      readNodeName !== null &&
-                      readNodeName !== undefined
-                    ) {
-                      msg.topic = `${node.nodeName}/${readNodeName}/${device}/${pointName}/${prop}`;
-                    } else {
-                      msg.topic = `${node.nodeName}/${device}/${pointName}/${prop}`;
-                    }
-                  } else {
-                    if (readNodeName !== '' &&
-                      readNodeName !== null &&
-                      readNodeName !== undefined
-                    ) {
-                      msg.topic = `BITPOOL_BACNET_GATEWAY/${readNodeName}/${device}/${pointName}/${prop}`;
-                    } else {
-                      msg.topic = `BITPOOL_BACNET_GATEWAY/${device}/${pointName}/${prop}`;
-                    }
-                  }
+                  let topic = getTopicString("sendAsMqtt", useDeviceName, readNodeName, device, pointName, prop);
+                  msg.topic = topic;
                   msg.payload = points[point][prop];
                   node.send(msg);
                 }
@@ -680,7 +697,7 @@ module.exports = function (RED) {
       });
     };
 
-    sendSimpleJson = function (values, readNodeName) {
+    sendSimpleJson = function (values, readNodeName, useDeviceName) {
       let devices = Object.keys(values);
       devices.forEach(function (device) {
         let msgg = {};
@@ -702,74 +719,85 @@ module.exports = function (RED) {
               });
             }
           }
-          if (
-            node.nodeName !== "gateway" &&
-            node.nodeName !== "" &&
-            node.nodeName !== "null" &&
-            node.nodeName !== "undefined" &&
-            typeof node.nodeName == "string"
-          ) {
-            if (readNodeName !== '' &&
-              readNodeName !== null &&
-              readNodeName !== undefined
-            ) {
-              msgg.topic = `${node.nodeName}/${readNodeName}/${device}`;
-            } else {
-              msgg.topic = `${node.nodeName}/${device}`;
-            }
-          } else {
-            if (readNodeName !== '' &&
-              readNodeName !== null &&
-              readNodeName !== undefined
-            ) {
-              msgg.topic = `BITPOOL_BACNET_GATEWAY/${readNodeName}/${device}`;
-            } else {
-              msgg.topic = `BITPOOL_BACNET_GATEWAY/${device}`;
-            }
-          }
+          let topic = getTopicString("sendSimpleJson", useDeviceName, readNodeName, device);
+          msgg.topic = topic;
           msgg.payload = value[device];
           node.send(msgg);
         }
       });
     };
 
-    sendJsonAsMqtt = function (values, readNodeName) {
+    sendJsonAsMqtt = function (values, readNodeName, useDeviceName) {
       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"
-          ) {
-            if (readNodeName !== '' &&
-              readNodeName !== null &&
-              readNodeName !== undefined
-            ) {
-              msgg.topic = `${node.nodeName}/${readNodeName}/${key}`;
-            } else {
-              msgg.topic = `${node.nodeName}/${key}`;
-            }
-          } else {
-            if (readNodeName !== '' &&
-              readNodeName !== null &&
-              readNodeName !== undefined
-            ) {
-              msgg.topic = `BITPOOL_BACNET_GATEWAY/${readNodeName}/${key}`;
-            } else {
-              msgg.topic = `BITPOOL_BACNET_GATEWAY/${key}`;
-            }
+          let structuredObject = {};
+
+          let topic = getTopicString("sendJsonAsMqtt", useDeviceName, readNodeName, key);
+          msgg.topic = topic;
+
+          for (let point in points) {
+            let pointName = getPointName(points[point], point);
+            structuredObject[pointName] = points[point];
           }
-          msgg.payload = points;
+          msgg.payload = structuredObject;
           node.send(msgg);
         });
       }
     };
-  }
 
+    sendIndividualMsgJson = function (values, readNodeName, useDeviceName) {
+      if (typeof values == "object") {
+        let keys = Object.keys(values);
+        keys.forEach(function (key) {
+          let points = values[key];
+          let msgg = {};
+          for (let point in points) {
+            let pointName = getPointName(points[point], point);
+            let topic = getTopicString("sendIndividualMsgJson", useDeviceName, readNodeName, key, pointName);
+            msgg.topic = topic;
+
+            msgg.payload = points[point];
+            node.send(msgg);
+            msgg = {};
+          }
+        });
+      }
+    }
+
+    sendSimpleJsonPerPoint = function (values, readNodeName, useDeviceName) {
+      let devices = Object.keys(values);
+      devices.forEach(function (device) {
+        if (device !== "_msgid") {
+          let points = values[device];
+          let msgg = {};
+          for (let point in points) {
+            if (points[point] && "presentValue" in points[point]) {
+              let pointName = getPointName(points[point], point);
+              let topic = getTopicString("sendSimpleJsonPerPoint", useDeviceName, readNodeName, device, pointName);
+
+              msgg.topic = topic;
+              let payload = {
+                presentValue: points[point]["presentValue"]
+              };
+              msgg.payload = payload;
+              node.send(msgg);
+              msgg = {};
+            }
+          }
+        }
+      });
+    }
+
+    function getPointName(object, pointName) {
+      if (object.displayName) {
+        return object.displayName;
+      }
+      return pointName;
+    }
+
+  }
   RED.nodes.registerType("Bacnet-Gateway", BitpoolBacnetGatewayDevice);
 };