@bitpoolos/edge-bacnet 1.3.0 → 1.3.2

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # Changelog
 
+## [1.3.1] - 06-06-2024
+
+### Summary 
+
+Primarily bug fixes and performance improvements
+
+### Bug Fixes
+
+- Adding individual points for MSTP devices would add incorrect device name to read list
+
+- Adding individual points for IP devices would add all MSTP network folders to read list
+
+- Intermittent incorrect device naming issues
+
+- Fixed BACnet server incompatibility with YABE and other BACnet browsers.
+
+- Added undefined check to bacstack client
+
+### Improvements
+
+- First poll cycle only queries Object Name and Present Value properties for all applicable Object Types for smaller initial network load. Objects are then back populated with the remaining Object properties on the subsequent poll cycles.
+
+- Devices are immediately added to the UI tree with a device placeholder on a whoIs/iAm response. The devices are then back populated with Names and BACnet Objects. This gives the user a fast understanding of the size and relationships of the BACnet network.
+
+- Added docstrings to bacnet_server.js and code clean up. 
+
+- Set Server enable to default on True
+
+
 ## [1.3.0] - 16-05-2024
 
 ### Summary

package/README.md

@@ -45,6 +45,7 @@ Upon updating to the latest version, we highly recommend:
  - Deploy all flows 
  - Restart Node-RED 
  - Insert and reconfigure new @bitpoolos/edge-bacnet nodes. 
+ - Restart Node-RED again if no devices are discovered.
 ```
 Main reason being, the behaviour of the bacnet client binding to network interfaces can remain stagnent if the Node-RED service is not restarted. This also ensures that all of the nodes are correctly configured as there are often properties added and removed from nodes. 
 
@@ -61,6 +62,8 @@ Main reason being, the behaviour of the bacnet client binding to network interfa
 
  - If you are using this node in a linux environment, using the 'All interfaces : 0.0.0.0' can be more reliable with a greater range of BACnet devices. 
 
+ - Note your broadcast address, compatibility can vary from 255.255.255.255 (all subnets) and 192.x.x.255 (locked down to your current subnet).
+
 ## Resources
 - [bitpool.com](https://www.bitpool.com/) - who are we.
 - [wiki.bitpool.com](https://wiki.bitpool.com/) - helpful docs.

package/bacnet_client.js

@@ -124,14 +124,15 @@ class BacnetClient extends EventEmitter {
                   that.addToParentMstpNetwork(newBacnetDevice);
                 }
                 that.deviceList.push(newBacnetDevice);
+                that.addToNetworkTree(newBacnetDevice);
               } else if (foundIndex !== -1) {
                 that.deviceList[foundIndex].updateDeviceConfig(device);
                 that.deviceList[foundIndex].setLastSeen(Date.now());
                 if (that.deviceList[foundIndex].getIsMstpDevice()) {
                   that.addToParentMstpNetwork(that.deviceList[foundIndex]);
                 }
+                that.addToNetworkTree(that.deviceList[foundIndex]);
               }
-
               //emit event for node-red to log
               that.emit("deviceFound", device);
             }
@@ -145,12 +146,14 @@ class BacnetClient extends EventEmitter {
                 that.addToParentMstpNetwork(newBacnetDevice);
               }
               that.deviceList.push(newBacnetDevice);
+              that.addToNetworkTree(newBacnetDevice);
             } else if (foundIndex !== -1) {
               that.deviceList[foundIndex].updateDeviceConfig(device);
               that.deviceList[foundIndex].setLastSeen(Date.now());
               if (that.deviceList[foundIndex].getIsMstpDevice()) {
                 that.addToParentMstpNetwork(that.deviceList[foundIndex]);
               }
+              that.addToNetworkTree(that.deviceList[foundIndex]);
             }
 
             //emit event for node-red to log
@@ -177,27 +180,68 @@ class BacnetClient extends EventEmitter {
 
   testFunction(address, type, instance, property) {
     let that = this;
-
     console.log("test function ");
-
     that.client.readProperty(
       address,
       { type: type, instance: instance },
       property,
       that.readPropertyMultipleOptions,
       (err, value) => {
-        if (err) {
-          console.log("err: ", err);
-        }
-
+        console.log(value);
         if (value) {
-          console.log("value : ", value);
-          console.log("value1 : ", value.values[0].value);
+          // If the result has value, resolve the promise
+          console.log(value.values[0]);
+          value.values[0].values.forEach(function (value) {
+            console.log("value: ", value.value);
+          });
+        } else {
+          console.log(err);
         }
       }
     );
   }
 
+  addToNetworkTree(device) {
+    let that = this;
+    try {
+      const deviceKey = that.createDeviceKey(device);
+      let deviceName = device.getDeviceName();
+      if (deviceName !== null) {
+        const deviceId = device.getDeviceId();
+        if (deviceId !== null) {
+          let lastIndex = deviceName.lastIndexOf(deviceId);
+          if (lastIndex) {
+            let formattedName = deviceName.substring(0, lastIndex);
+            formattedName = `${formattedName.trim()}_Device_${deviceId}`;
+            if (that.networkTree[deviceKey][formattedName] &&
+              Object.keys(that.networkTree[deviceKey][formattedName]).length > 0) {
+              delete that.networkTree[deviceKey]["device"];
+            }
+          }
+        }
+      } else {
+        const json = {
+          "objectId": {
+            "type": 8,
+            "instance": device.getDeviceId()
+          }
+        };
+
+        if (that.networkTree[deviceKey] && that.networkTree[deviceKey]["device"]) {
+          that.networkTree[deviceKey]["device"]["meta"] = json;
+        } else {
+          that.networkTree[deviceKey] = {
+            "device": {
+              "meta": json
+            }
+          }
+        }
+      }
+    } catch (e) {
+      that.logOut("addToNetworkTree error: ", e);
+    }
+  }
+
   getProtocolSupported(device) {
     //return protocols support for device
     let that = this;
@@ -283,8 +327,26 @@ class BacnetClient extends EventEmitter {
         let device = that.deviceList.find((ele) => ele.getDeviceId() == deviceObject.deviceId);
         that.updateDeviceName(device);
 
+
+        //test
+
+        that.getProtocolSupported(device).then(function (result) {
+          console.log("updatePointsForDevice getProtocolSupported ", result.values[0].originalBitString);
+          console.log(result.values[0]);
+          console.log(result);
+          console.log(result.values[0]);
+          let decodedValues = decodeBitArray(8, result.values[0].originalBitString.value);
+          device.setProtocolServicesSupported(decodedValues);
+        }).catch(function (error) {
+          that.logOut("getProtocolSupported error: ", error);
+        });
+
+        //test
+
+
         if (device.getIsProtocolServicesSet() == false) {
           that.getProtocolSupported(device).then(function (result) {
+            console.log("updatePointsForDevice getProtocolSupported ", result.values[0].originalBitString);
             let decodedValues = decodeBitArray(8, result.values[0].originalBitString.value);
             device.setProtocolServicesSupported(decodedValues);
           }).catch(function (error) {
@@ -302,11 +364,11 @@ class BacnetClient extends EventEmitter {
                 resolve(true);
               })
               .catch(function (e) {
-                that.logOut(`Update points list error 1: ${device.getAddress()}`, e);
+                that.logOut(`Update points list error 1: ${that.getDeviceAddress(device)}`, e);
               });
           })
           .catch(function (e) {
-            that.logOut(`Update points list error 2: ${device.getAddress()}`, e);
+            that.logOut(`Update points list error 2: ${that.getDeviceAddress(device)}`, e);
             device.setManualDiscoveryMode(true);
             that
               .getDevicePointListWithoutObjectList(device)
@@ -318,11 +380,11 @@ class BacnetClient extends EventEmitter {
                     resolve(true);
                   })
                   .catch(function (e) {
-                    that.logOut(`Update points list error 3: ${device.getAddress()}`, e);
+                    that.logOut(`Update points list error 3: ${that.getDeviceAddress(device)}`, e);
                   });
               })
               .catch(function (e) {
-                that.logOut(`Update points list error 4: ${device.getAddress()}`, e);
+                that.logOut(`Update points list error 4: ${that.getDeviceAddress(device)}`, e);
               });
           });
       } catch (e) {
@@ -416,9 +478,9 @@ class BacnetClient extends EventEmitter {
               that.logOut("getProtocolSupported error: ", error);
             });
           }
+          try {
 
-          if (!device.getManualDiscoveryMode()) {
-            try {
+            if (device.getSegmentation() !== 3) {
               that.updateDeviceName(device);
               that
                 .getDevicePointList(device)
@@ -435,7 +497,6 @@ class BacnetClient extends EventEmitter {
                 })
                 .catch(function (e) {
                   that.logOut(`getDevicePointList error: ${device.getAddress()}`, e);
-                  device.setManualDiscoveryMode(true);
                   that
                     .getDevicePointListWithoutObjectList(device)
                     .then(function () {
@@ -453,11 +514,29 @@ class BacnetClient extends EventEmitter {
                       query(index);
                     });
                 });
-            } catch (e) {
-              that.logOut("Error while querying devices: ", e);
-              query(index);
+
+            } else if (device.getSegmentation() == 3) {
+
+              that.updateDeviceName(device);
+              that
+                .getDevicePointListWithoutObjectList(device)
+                .then(function () {
+                  that
+                    .buildJsonObject(device)
+                    .then(function () {
+                      query(index);
+                    })
+                    .catch(function (e) {
+                      that.logOut(`getDevicePointList error: ${device.getAddress()}`, e);
+                      query(index);
+                    });
+                })
+                .catch(function (e) {
+                  query(index);
+                });
             }
-          } else {
+          } catch (e) {
+            that.logOut("Error while querying devices: ", e);
             query(index);
           }
         } else {
@@ -1061,6 +1140,83 @@ class BacnetClient extends EventEmitter {
   }
 
 
+  _readObjectLite(device, deviceAddress, type, instance) {
+    const that = this;
+    const readOptions = {
+      maxSegments: that.readPropertyMultipleOptions.maxSegments,
+      maxApdu: that.readPropertyMultipleOptions.maxApdu,
+    };
+
+    // Define all properties to be read
+    const allProperties = [
+      { id: baEnum.PropertyIdentifier.PRESENT_VALUE },
+      { id: baEnum.PropertyIdentifier.OBJECT_NAME },
+    ];
+
+    return new Promise((resolve, reject) => {
+      // Try to read all properties at once
+      that._readObject(deviceAddress, type, instance, allProperties, readOptions)
+        .then(result => {
+          if (result.value) {
+            // If the result has value, resolve the promise
+            resolve(result);
+          } else {
+            // If not, proceed to read individual properties
+            readPropertiesIndividually();
+          }
+        })
+        .catch(() => {
+          // On error, proceed to read individual properties
+          readPropertiesIndividually();
+        });
+
+      // Function to read properties individually
+      const readPropertiesIndividually = () => {
+        const promises = allProperties.map((property, index) => new Promise((propertyResolve) => {
+          that.client.readProperty(
+            deviceAddress,
+            { type: type, instance: instance },
+            property.id,
+            readOptions,
+            (err, value) => {
+              if (err) {
+                propertyResolve(null);
+              } else {
+                propertyResolve({
+                  id: property.id,
+                  index: value.property.index,
+                  value: value.values,
+                });
+              }
+            }
+          );
+        }));
+
+        Promise.all(promises)
+          .then(resultArray => {
+            // Filter out null results
+            const validResults = resultArray.filter(result => result !== null);
+
+            resolve({
+              error: null,
+              value: {
+                values: [
+                  {
+                    objectId: {
+                      type: type,
+                      instance: instance,
+                    },
+                    values: validResults,
+                  },
+                ],
+              },
+            });
+          })
+          .catch(reject);
+      };
+    });
+  }
+
   _readObjectPropList(deviceAddress, type, instance) {
     return this._readObject(deviceAddress, type, instance, [{ id: baEnum.PropertyIdentifier.PROPERTY_LIST }]);
   }
@@ -1394,49 +1550,100 @@ class BacnetClient extends EventEmitter {
       if (typeof pointList !== "undefined" && pointList.length > 0) {
         pointList.forEach(function (point, pointListIndex) {
           requestMutex.acquire().then(function (release) {
-            that
-              ._readObjectFull(device, address, point.value.type, point.value.instance)
-              .then(function (result) {
-                if (!result.error) {
-                  if (result.length > 0 && Array.isArray(result)) {
-                    promiseArray = result;
-                  } else {
-                    promiseArray.push(result);
+            if (device.getIsInitialQuery()) {
+              that
+                ._readObjectLite(device, address, point.value.type, point.value.instance)
+                .then(function (result) {
+                  if (!result.error) {
+                    if (result.length > 0 && Array.isArray(result)) {
+                      promiseArray = result;
+                    } else {
+                      promiseArray.push(result);
+                    }
                   }
-                }
 
-                release();
+                  release();
+
+                  if (pointListIndex == pointList.length - 1) {
+                    device.setIsInitialQuery(false);
+                    that
+                      .buildResponse(promiseArray, device)
+                      .then(function () {
+                        that.lastNetworkPoll = Date.now();
+                        resolve({ deviceList: that.deviceList, pointList: that.networkTree });
+                      })
+                      .catch(function (e) {
+                        that.logOut("Error while building json object: ", e);
+                        reject(e);
+                      });
+                  }
+                })
+                .catch(function (e) {
+                  release();
+                  that.logOut("_readObjectLite error: ", e);
+
+                  if (pointListIndex == pointList.length - 1) {
+                    device.setIsInitialQuery(false);
+                    that
+                      .buildResponse(promiseArray, device)
+                      .then(function () {
+                        that.lastNetworkPoll = Date.now();
+                        resolve({ deviceList: that.deviceList, pointList: that.networkTree });
+                      })
+                      .catch(function (e) {
+                        that.logOut("Error while building json object: ", e);
+                        reject(e);
+                      });
+                  }
+                });
 
-                if (pointListIndex == pointList.length - 1) {
-                  that
-                    .buildResponse(promiseArray, device)
-                    .then(function () {
-                      that.lastNetworkPoll = Date.now();
-                      resolve({ deviceList: that.deviceList, pointList: that.networkTree });
-                    })
-                    .catch(function (e) {
-                      that.logOut("Error while building json object: ", e);
-                      reject(e);
-                    });
-                }
-              })
-              .catch(function (e) {
-                release();
-                that.logOut("_readObjectFull error: ", e);
 
-                if (pointListIndex == pointList.length - 1) {
-                  that
-                    .buildResponse(promiseArray, device)
-                    .then(function () {
-                      that.lastNetworkPoll = Date.now();
-                      resolve({ deviceList: that.deviceList, pointList: that.networkTree });
-                    })
-                    .catch(function (e) {
-                      that.logOut("Error while building json object: ", e);
-                      reject(e);
-                    });
-                }
-              });
+
+            } else {
+              that
+                ._readObjectFull(device, address, point.value.type, point.value.instance)
+                .then(function (result) {
+                  if (!result.error) {
+                    if (result.length > 0 && Array.isArray(result)) {
+                      promiseArray = result;
+                    } else {
+                      promiseArray.push(result);
+                    }
+                  }
+
+                  release();
+
+                  if (pointListIndex == pointList.length - 1) {
+                    that
+                      .buildResponse(promiseArray, device)
+                      .then(function () {
+                        that.lastNetworkPoll = Date.now();
+                        resolve({ deviceList: that.deviceList, pointList: that.networkTree });
+                      })
+                      .catch(function (e) {
+                        that.logOut("Error while building json object: ", e);
+                        reject(e);
+                      });
+                  }
+                })
+                .catch(function (e) {
+                  release();
+                  that.logOut("_readObjectFull error: ", e);
+
+                  if (pointListIndex == pointList.length - 1) {
+                    that
+                      .buildResponse(promiseArray, device)
+                      .then(function () {
+                        that.lastNetworkPoll = Date.now();
+                        resolve({ deviceList: that.deviceList, pointList: that.networkTree });
+                      })
+                      .catch(function (e) {
+                        that.logOut("Error while building json object: ", e);
+                        reject(e);
+                      });
+                  }
+                });
+            }
           });
         });
       } else {
@@ -1467,7 +1674,8 @@ class BacnetClient extends EventEmitter {
             let currobjectId = pointProperty.objectId.type;
             let bac_obj = that.getObjectType(currobjectId);
             let objectName = that._findValueById(pointProperty.values, baEnum.PropertyIdentifier.OBJECT_NAME);
-            let objectType = that._findValueById(pointProperty.values, baEnum.PropertyIdentifier.OBJECT_TYPE);
+            let objectType = pointProperty.objectId.type;
+
             let objectId;
             if (objectName !== null && typeof objectName == "string") {
               objectName = objectName.replace(reg, '');
@@ -1504,7 +1712,7 @@ class BacnetClient extends EventEmitter {
                                 values[objectId].presentValue = values[objectId].stateTextArray[object.value[0].value - 1].value;
                               }
                             }
-                          } else {
+                          } else if (objectType !== 8) {
                             values[objectId].presentValue = roundDecimalPlaces(object.value[0].value, 2);
                           }
                         }

package/bacnet_device.js

@@ -34,6 +34,7 @@ class BacnetDevice {
             that.displayName = config.displayName;
             that.protocolServicesSupported = config.protocolServicesSupported;
             that.isProtocolServicesSet = config.isProtocolServicesSet;
+            that.isInitialQuery = config.isInitialQuery;
 
         } else if (fromImport == false) {
             if (config.net && config.adr) {
@@ -62,6 +63,7 @@ class BacnetDevice {
             that.protocolServicesSupported = [];
             that.protocolServicesSupported = [];
             that.isProtocolServicesSet = false;
+            that.isInitialQuery = true;
         }
     }
 
@@ -354,6 +356,14 @@ class BacnetDevice {
         }
     }
 
+    getIsInitialQuery() {
+        return this.isInitialQuery;
+    }
+
+    setIsInitialQuery(bool) {
+        this.isInitialQuery = bool;
+    }
+
 }
 
 module.exports = { BacnetDevice };

package/bacnet_gateway.html

@@ -75,19 +75,19 @@
 <script type="text/javascript">
   class NodeService {
     getNetworkData() {
-      return fetch("/bitpool-bacnet-data/getNetworkTree").then((res) => res.json());
+      return fetch(RED.settings.httpNodeRoot + "bitpool-bacnet-data/getNetworkTree").then((res) => res.json());
     }
     rebuildDataModel() {
-      return fetch("/bitpool-bacnet-data/rebuildDataModel").then((res) => res.json());
+      return fetch(RED.settings.httpNodeRoot + "bitpool-bacnet-data/rebuildDataModel").then((res) => res.json());
     }
     clearBacnetServerPoints() {
-      return fetch("/bitpool-bacnet-data/clearBacnetServerPoints").then((res) => res.json());
+      return fetch(RED.settings.httpNodeRoot + "bitpool-bacnet-data/clearBacnetServerPoints").then((res) => res.json());
     }
     getBacnetServerPoints() {
-      return fetch('/bitpool-bacnet-data/getBacnetServerPoints').then(res => res.json());
+      return fetch(RED.settings.httpNodeRoot + 'bitpool-bacnet-data/getBacnetServerPoints').then(res => res.json());
     }
     purgeDevice(device) {
-      return fetch('/bitpool-bacnet-data/purgeDevice', {
+      return fetch(RED.settings.httpNodeRoot + 'bitpool-bacnet-data/purgeDevice', {
         method: 'POST',
         headers: {
           'Accept': 'application/json',
@@ -97,7 +97,7 @@
       }).then(res => res.json());
     }
     updatePointsForDevice(device) {
-      return fetch('/bitpool-bacnet-data/updatePointsForDevice', {
+      return fetch(RED.settings.httpNodeRoot + 'bitpool-bacnet-data/updatePointsForDevice', {
         method: 'POST',
         headers: {
           'Accept': 'application/json',
@@ -107,7 +107,7 @@
       }).then(res => res.json());
     }
     setDeviceDisplayName(device, displayName) {
-      return fetch('/bitpool-bacnet-data/setDeviceDisplayName', {
+      return fetch(RED.settings.httpNodeRoot + 'bitpool-bacnet-data/setDeviceDisplayName', {
         method: 'POST',
         headers: {
           'Accept': 'application/json',
@@ -117,7 +117,7 @@
       }).then(res => res.json());
     }
     setPointDisplayName(deviceKey, pointName, pointDisplayName) {
-      return fetch('/bitpool-bacnet-data/setPointDisplayName', {
+      return fetch(RED.settings.httpNodeRoot + 'bitpool-bacnet-data/setPointDisplayName', {
         method: 'POST',
         headers: {
           'Accept': 'application/json',
@@ -127,7 +127,7 @@
       }).then(res => res.json());
     }
     importReadList(payload) {
-      return fetch('/bitpool-bacnet-data/importReadList', {
+      return fetch(RED.settings.httpNodeRoot + 'bitpool-bacnet-data/importReadList', {
         method: 'POST',
         headers: {
           'Accept': 'application/json',
@@ -156,7 +156,7 @@
       discover_polling_schedule_options: { value: "Minutes", required: true },
       deviceId: { value: 817001, required: true },
       logErrorToConsole: { value: false },
-      serverEnabled: { value: false },
+      serverEnabled: { value: true },
       device_read_schedule: { value: "900" },
       device_read_schedule_value: { value: "15", required: true },
       device_read_schedule_options: { value: "Minutes", required: true },
@@ -213,7 +213,7 @@
       function queryAdapters() {
         let nicSelector = document.getElementById("node-input-local_device_address");
         $.ajax({
-          url: "/bitpool-bacnet-data/getNetworkInterfaces",
+          url: RED.settings.httpNodeRoot + "bitpool-bacnet-data/getNetworkInterfaces",
           success: function (data) {
             let keys = Object.keys(data);
 
@@ -289,7 +289,7 @@
                 let app = this;
                 $.ajax({
                   type: "POST",
-                  url: '/bitpool-bacnet-data/clearBacnetServerPoint',
+                  url: RED.settings.httpNodeRoot + 'bitpool-bacnet-data/clearBacnetServerPoint',
                   dataType: 'json',
                   contentType: 'application/json',
                   data: JSON.stringify(json),
@@ -342,7 +342,7 @@
 
           $.ajax({
             type: "POST",
-            url: "/bitpool-bacnet-data/updateDeviceList",
+            url: RED.settings.httpNodeRoot + "bitpool-bacnet-data/updateDeviceList",
             dataType: "json",
             contentType: "application/json",
             data: JSON.stringify(jsonPayload),
@@ -356,7 +356,7 @@
 
       $("#file-export").click(function (params) {
         $.ajax({
-          url: "/bitpool-bacnet-data/getDeviceList",
+          url: RED.settings.httpNodeRoot + "bitpool-bacnet-data/getDeviceList",
           success: function (deviceList) {
             let data = "text/json;charset=utf-8," + encodeURIComponent(JSON.stringify(deviceList));
             let aEle = document.getElementById("exportJSON");

package/bacnet_read.html

@@ -218,8 +218,9 @@
                     addPointClicked(slotProps) {
                         let app = this;
                         //update UI
-                        let parentDeviceName = slotProps.node.parentDevice;
-                        let device = this.deviceList.find((ele) => ele.deviceName == parentDeviceName);
+                        const parentDeviceName = slotProps.node.parentDevice;
+                        const slotDeviceId = slotProps.node.parentDeviceId;
+                        let device = this.deviceList.find((ele) => ele.deviceId == slotDeviceId);
                         let foundDeviceIndex = this.readDevices
                             ? this.readDevices.findIndex((ele) => ele.deviceId == device.deviceId)
                             : -1;
@@ -228,11 +229,24 @@
                         let parentDevice = this.devices.find((ele) => ele.ipAddr == deviceAddress);
                         let childDevice;
                         if (device.isMstp) {
-                            let foundChildIndex = parentDevice.children[1].children.findIndex(
-                                (ele) => ele.initialName == parentDeviceName
-                            );
-                            if (foundChildIndex !== -1) {
-                                childDevice = parentDevice.children[1].children[foundChildIndex];
+                            let indexMap = {
+                                deviceIndex: -1,
+                                mstpNetorkIndex: -1
+                            };
+                            parentDevice.children.forEach(function (child, index) {
+                                if (child.label.includes("MSTP")) {
+                                    const tempIndex = child.children.findIndex(
+                                        (ele) => ele.deviceId == slotDeviceId
+                                    );
+                                    if (tempIndex !== -1) {
+                                        indexMap.deviceIndex = tempIndex;
+                                        indexMap.mstpNetorkIndex = index;
+                                    }
+                                }
+                            });
+
+                            if (indexMap.deviceIndex !== -1 && indexMap.mstpNetorkIndex !== -1) {
+                                childDevice = parentDevice.children[indexMap.mstpNetorkIndex].children[indexMap.deviceIndex];
                             }
                         }
 
@@ -246,6 +260,13 @@
                             }
                             newReadParent.children[0].children = [];
                             newReadParent.children[0].children.push(slotProps.node);
+                            while (newReadParent.children.length > 1) {
+                                newReadParent.children.forEach(function (child, index) {
+                                    if (child.label.includes("MSTP")) {
+                                        newReadParent.children.splice(index, 1);
+                                    }
+                                });
+                            }
                             if (this.readDevices) {
                                 this.readDevices.push(newReadParent);
                             } else {

package/bacnet_server.js

@@ -3,6 +3,19 @@ const pjson = require('./package.json');
 const baEnum = bacnet.enum;
 const { Store_Config_Server, Read_Config_Sync_Server } = require('./common');
 
+/**
+ * Class representing a BACnet Server.
+ * 
+ * This class initializes a BACnet server with specified client, device ID, and Node-Red version.
+ * It provides methods to set device name, add objects, retrieve objects, clear server points, clear server point, and get server points.
+ * 
+ * Simulates a BACnet IP device on a regular IP network
+ * 
+ * @constructor
+ * @param {Object} client - The BACnet client object.
+ * @param {number} deviceId - The ID of the device.
+ * @param {string} nodeRedVersion - The version of Node-Red.
+ */
 class BacnetServer {
 
     constructor(client, deviceId, nodeRedVersion) {
@@ -14,13 +27,13 @@ class BacnetServer {
         that.objectIdNumber[baEnum.ObjectType.ANALOG_VALUE] = 0;
         that.objectIdNumber[baEnum.ObjectType.CHARACTERSTRING_VALUE] = 0;
         that.objectIdNumber[baEnum.ObjectType.BINARY_VALUE] = 0;
-
         that.nodeRedVersion = nodeRedVersion;
         that.deviceId = deviceId;
         that.vendorId = 1401;
         that.objectList = [
             { value: { type: baEnum.ObjectType.DEVICE, instance: that.deviceId }, type: 12 }
         ];
+
         that.objectStore = {
             [baEnum.ObjectType.DEVICE]: {
                 [baEnum.PropertyIdentifier.OBJECT_IDENTIFIER]: [{ value: { type: baEnum.ObjectType.DEVICE, instance: that.deviceId }, type: 12 }],
@@ -36,8 +49,7 @@ class BacnetServer {
                 [baEnum.PropertyIdentifier.PROTOCOL_REVISION]: [{ value: 19, type: 2 }],
                 [baEnum.PropertyIdentifier.PROTOCOL_VERSION]: [{ value: 0, type: 2 }],
                 [baEnum.PropertyIdentifier.APPLICATION_SOFTWARE_VERSION]: [{ value: pjson.version, type: 7 }],
-                [baEnum.PropertyIdentifier.PROTOCOL_SERVICES_SUPPORTED]: [{ value: { value: [0, 80, 0, 4, 4], bitsUsed: 40 }, type: 8 }],
-                [baEnum.PropertyIdentifier.PROTOCOL_OBJECT_TYPES_SUPPORTED]: [{ value: { value: [0, 80, 0, 4, 4], bitsUsed: 40 }, type: 8 }],
+                [baEnum.PropertyIdentifier.PROTOCOL_SERVICES_SUPPORTED]: [{ value: { value: [0, 10, 0, 32, 32], bitsUsed: 40 }, type: 8 }],
                 [baEnum.PropertyIdentifier.MAX_APDU_LENGTH_ACCEPTED]: [{ value: 1476, type: 2 }],
                 [baEnum.PropertyIdentifier.SEGMENTATION_SUPPORTED]: [{ value: 0, type: 9 }],
                 [baEnum.PropertyIdentifier.APDU_TIMEOUT]: [{ value: that.bacnetClient.config.apduTimeout, type: 2 }],
@@ -76,8 +88,10 @@ class BacnetServer {
         try {
             let cachedData = JSON.parse(Read_Config_Sync_Server());
             if (typeof cachedData == "object") {
-
-                if (cachedData.objectList) that.objectList = cachedData.objectList;
+                if (cachedData.objectList) {
+                    that.objectList = cachedData.objectList;
+                    that.objectStore[baEnum.ObjectType.DEVICE][baEnum.PropertyIdentifier.OBJECT_LIST] = that.objectList;
+                }
                 if (cachedData.objectStore) {
                     that.objectStore[baEnum.ObjectType.ANALOG_VALUE] = cachedData.objectStore[baEnum.ObjectType.ANALOG_VALUE];
                     that.objectStore[baEnum.ObjectType.CHARACTERSTRING_VALUE] = cachedData.objectStore[baEnum.ObjectType.CHARACTERSTRING_VALUE];
@@ -94,24 +108,20 @@ class BacnetServer {
         });
 
         that.bacnetClient.client.on('readPropertyMultiple', (data) => {
-
             let senderAddress = data.address;
             let requestProps = data.request.properties;
             let responseObject = [];
 
             try {
                 if (requestProps) {
-
                     for (let i = 0; i < requestProps.length; i++) {
                         let prop = requestProps[i].properties[0].id;
                         let type = requestProps[i].objectId.type;
                         let instance = requestProps[i].objectId.instance;
                         let foundObject = that.getObjectMultiple(type, prop, instance, requestProps[i].properties);
-
                         if (foundObject !== null && foundObject !== undefined && foundObject !== "undefined") {
                             responseObject.push({ objectId: { type: type, instance: instance }, values: foundObject });
                         }
-
                         if (i == requestProps.length - 1) {
                             if (responseObject.length > 0) {
                                 that.bacnetClient.client.readPropertyMultipleResponse(senderAddress, data.invokeId, responseObject);
@@ -127,7 +137,6 @@ class BacnetServer {
                         }
                     }
                 }
-
             } catch (e) {
                 that.bacnetClient.client.errorResponse(
                     data.address,
@@ -137,24 +146,21 @@ class BacnetServer {
                     baEnum.ErrorCode.UNKNOWN_PROPERTY
                 );
             }
-
         });
 
         that.bacnetClient.client.on('readProperty', (data) => {
-
             try {
-
                 let objectId = data.request.objectId.type;
                 let objectInstance = data.request.objectId.instance;
                 let propId = data.request.property.id.toString();
-
                 let responseObj = that.getObject(objectId, propId, objectInstance);
-
-                if (propId == baEnum.PropertyIdentifier.OBJECT_LIST && ((Date.now() - that.lastWhoIsRecived) / 1000) < 0.7) {
-                    responseObj = [{ value: that.objectList.length, type: 2 }];
+                if (propId == baEnum.PropertyIdentifier.OBJECT_LIST) {
+                    if (data.request.property.index !== 0xFFFFFFFF) {
+                        responseObj = responseObj[data.request.property.index];
+                    }
                 }
                 if (responseObj !== null && responseObj !== undefined && typeof responseObj !== "undefined") {
-                    that.bacnetClient.client.readPropertyResponse(data.address, data.invokeId, objectId, data.request.property, responseObj);
+                    that.bacnetClient.client.readPropertyResponse(data.address, data.invokeId, data.request.objectId, data.request.property, responseObj);
                 } else {
                     that.bacnetClient.client.errorResponse(
                         data.address,
@@ -167,13 +173,17 @@ class BacnetServer {
             } catch (e) {
                 console.log("Local BACnet device readProperty error: ", e);
             }
-
         });
 
         //do initial iAm broadcast when BACnet server starts
         that.bacnetClient.client.iAmResponse(that.deviceId, baEnum.Segmentation.SEGMENTED_BOTH, that.vendorId);
     }
 
+    /**
+     * Set the name of the device.
+     * 
+     * @param {string} nodeName - The new name for the device.
+     */
     setDeviceName(nodeName) {
         let that = this;
         if (typeof nodeName == "string" && nodeName !== "") {
@@ -181,6 +191,13 @@ class BacnetServer {
         }
     }
 
+    /**
+     * Adds a new object to the BacnetServer's object store based on the provided name and value.
+     * 
+     * @param {string} name - The name of the object to be added.
+     * @param {number|boolean|string} value - The value of the object to be added.
+     * @returns {void}
+     */
     addObject(name, value) {
         let that = this;
         let objectType = that.getBacnetObjectType(value);
@@ -290,11 +307,18 @@ class BacnetServer {
         Store_Config_Server(JSON.stringify({ objectList: that.objectList, objectStore: that.objectStore }));
     }
 
+    /**
+     * Retrieves a specific property of an object based on the object ID, property ID, and instance number.
+     * 
+     * @param {number} objectId - The ID of the object type.
+     * @param {number} propId - The ID of the property to retrieve.
+     * @param {number} instance - The instance number of the object.
+     * @returns {any} The requested property value if found, otherwise null.
+     */
     getObject(objectId, propId, instance) {
         let that = this;
         let objectGroup = that.objectStore[objectId];
 
-
         if (Array.isArray(objectGroup)) {
             for (let i = 0; i < objectGroup.length; i++) {
                 let object = objectGroup[i];
@@ -306,19 +330,26 @@ class BacnetServer {
                 }
             }
         } else {
-
             return objectGroup[propId];
         }
 
         return null;
     }
 
+    /**
+     * Retrieves the properties of a specific object instance from the objectStore based on the provided parameters.
+     * 
+     * @param {number} objectId - The type of the object to retrieve.
+     * @param {number} propId - The property identifier to retrieve.
+     * @param {number} instance - The instance number of the object to retrieve.
+     * @param {Array} properties - An array of additional properties to retrieve along with the main property.
+     * @returns {Array|null} - An array of properties with values for the specified object instance, or null if not found.
+     */
     getObjectMultiple(objectId, propId, instance, properties) {
         let that = this;
         let objectGroup = that.objectStore[objectId];
 
         try {
-
             if (Array.isArray(objectGroup)) {
                 for (let i = 0; i < objectGroup.length; i++) {
                     let object = objectGroup[i];
@@ -379,6 +410,12 @@ class BacnetServer {
         return null;
     }
 
+    /**
+     * Clear all server points by resetting the object lists and object store.
+     * This method resets the object list for the device, clears the character string values,
+     * and clears the analog values. It also resets the object id numbers for analog, character string, and binary values.
+     * Finally, it stores the updated object list and object store in the server configuration.
+     */
     clearServerPoints() {
         let that = this;
 
@@ -397,6 +434,14 @@ class BacnetServer {
         Store_Config_Server(JSON.stringify({ objectList: that.objectList, objectStore: that.objectStore }));
     }
 
+    /**
+     * Removes a server point from the objectStore and objectList based on the provided JSON data.
+     * 
+     * @param {Object} json - The JSON data containing information about the server point to be removed.
+     * @param {string} json.body.type - The type of the server point ('SV' for CharacterString, 'BV' for BinaryValue, default is AnalogValue).
+     * @param {number} json.body.instance - The instance number of the server point to be removed.
+     * @returns {Promise<boolean>} A Promise that resolves to true if the server point is successfully removed, otherwise rejects with an error.
+     */
     clearServerPoint(json) {
         let that = this;
         return new Promise(async function (resolve, reject) {
@@ -447,6 +492,17 @@ class BacnetServer {
         });
     }
 
+    /**
+     * Retrieves all server points from the BacnetServer objectStore.
+     * Points include Analog Value, Character String Value, and Binary Value objects.
+     * Each point is represented as an object with properties:
+     * - name: The name of the object.
+     * - type: The type of the object (AV for Analog Value, SV for Character String Value, BV for Binary Value).
+     * - instance: The instance number of the object.
+     * 
+     * @returns {Promise<Array>} A promise that resolves with an array of points sorted by instance number.
+     * @throws {Error} If an error occurs during the retrieval process.
+     */
     getServerPoints() {
         let that = this;
         let points = [];
@@ -502,10 +558,12 @@ class BacnetServer {
         });
     }
 
-    getRandomArbitrary(min, max) {
-        return Math.random() * (max - min) + min;
-    }
-
+    /**
+     * Determines the BACnet object type based on the provided value.
+     * 
+     * @param {any} value - The value to determine the BACnet object type for.
+     * @returns {string|null} The BACnet object type as a string ('string', 'number', 'boolean') or null if the type is not recognized.
+     */
     getBacnetObjectType(value) {
         let type = typeof value;
 
@@ -521,6 +579,13 @@ class BacnetServer {
         }
     }
 
+    /**
+     * Returns the object identifier for the given type and instance number.
+     * 
+     * @param {string} type - The type of the object.
+     * @param {number} instanceNumber - The instance number of the object.
+     * @returns {number} The object identifier.
+     */
     getObjectIdentifier(type, instanceNumber) {
         let that = this;
         // manual instance numbering
@@ -533,7 +598,6 @@ class BacnetServer {
         that.objectIdNumber[type]++;
         return objectId;
     }
-
 }
 
 module.exports = { BacnetServer };

package/bacnet_write.html

@@ -42,6 +42,10 @@
             pointsToWrite: ref([]),
             nodeService: ref(new NodeService()),
             deviceCount: ref(),
+            showDeviceNameDialog: ref(false),
+            showPointNameDialog: ref(false),
+            deviceDisplayNameValue: ref(),
+            pointDisplayNameValue: ref(),
           };
         },
         setup() {
@@ -301,6 +305,12 @@
 
             return count;
           },
+          hasMstpDevices(slotProps) {
+            if (slotProps.node.children[1] && slotProps.node.children[1].children.length > 0) {
+              return true;
+            }
+            return false;
+          },
           settingDeviceName(slotProps) {
             let app = this;
             if (slotProps.node.settingDisplayName) {
@@ -461,6 +471,8 @@
           "p-tree": primevue.tree,
           "p-button": primevue.button,
           "p-timeline": primevue.timeline,
+          "p-dialog": primevue.dialog,
+          "p-input-text": primevue.inputtext,
         },
       };
 
@@ -794,6 +806,49 @@
 
     <div id="read-networkTree-tab" style="display:none">
       <div id="read-networkTree-tab-content" class="networkTreeContent" style="display:none">
+        <p-dialog
+          v-model:visible="showDeviceNameDialog"
+          modal
+          header="Set Display Name"
+          :style="{ width: '25rem' }"
+          class="deviceNameDialog">
+          <div class="flex align-items-center gap-3 mb-3">
+            <label for="displayName" class="font-semibold">Name</label>
+            <p-input-text id="displayName" class="flex-auto" autocomplete="off" v-model="deviceDisplayNameValue" />
+          </div>
+          <div class="flex justify-content-end gap-2">
+            <p-button
+              class="diplayNameDialogCancel"
+              type="button"
+              label="Cancel"
+              severity="secondary"
+              @click="cancelDisplayNameDialog"></p-button>
+            <p-button class="diplayNameDialogSave" type="button" label="Save" @click="setDeviceName"></p-button>
+          </div>
+        </p-dialog>
+
+        <p-dialog
+          v-model:visible="showPointNameDialog"
+          modal
+          header="Set Point Name"
+          :style="{ width: '25rem' }"
+          class="deviceNameDialog">
+          <div class="flex align-items-center gap-3 mb-3">
+            <label for="displayName" class="font-semibold">Name</label>
+            <p-input-text id="displayName" class="flex-auto" autocomplete="off" v-model="pointDisplayNameValue" />
+          </div>
+          <div class="flex justify-content-end gap-2">
+            <p-button
+              class="diplayNameDialogCancel"
+              type="button"
+              label="Cancel"
+              severity="secondary"
+              @click="cancelPointNameDialog"></p-button>
+            <p-button class="diplayNameDialogSave" type="button" label="Save" @click="setPointName"></p-button>
+          </div>
+        </p-dialog>
+
+
         <div>
           <a class="countStatus" style="margin-left: 15px;">Count: {{deviceCount}} device(s)</a>
           <button @click="getData()" class="reloadButton">
@@ -809,13 +864,19 @@
                 <div v-if="isDeviceActive(slotProps)" class="deviceLabelParent">
                   <b class="deviceLabel">
                     <span class="statusOnline deviceStatus dotOnline dot"></span>
-                    {{slotProps.node.label}} 
+                    {{slotProps.node.label}}
+                    <span v-if="hasMstpDevices(slotProps)" class="mstpDeviceCount"
+                      >&nbsp; {{calculateMstpCount(slotProps)}} &nbsp;</span
+                    > 
                   </b>
                 </div>
                 <div v-else>
                   <b class="deviceLabel">
                     <span class="statusOffline deviceStatus dotOffline dot"></span>
                     {{slotProps.node.label}} 
+                    <span v-if="hasMstpDevices(slotProps)" class="mstpDeviceCount"
+                      >&nbsp; {{calculateMstpCount(slotProps)}} &nbsp;</span
+                    >
                   </b>
                 </div>
 

package/common.js

@@ -1,5 +1,5 @@
 /*
-  MIT License Copyright 2021, 2022 - Bitpool Pty Ltd
+  MIT License Copyright 2021, 2024 - Bitpool Pty Ltd
 */
 
 const { createLogger, format, transports } = require("winston");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bitpoolos/edge-bacnet",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "description": "A bacnet gateway for node-red",
   "dependencies": {
     "@plus4nodered/ts-node-bacnet": "^1.0.0-beta.2",

package/resources/node-bacstack-ts/dist/lib/client.js

@@ -430,7 +430,7 @@ class Client extends events_1.EventEmitter {
         const result = baNpdu.decode(buffer, offset);
         var addressObject, destAddress;
         // @todo a MSTP Dest & Source could occur. this case is not handled. 
-        if (typeof (result.source) != 'undefined') {
+        if (typeof (result.source) != 'undefined' && result && result.source) {
             addressObject = result.source;
             addressObject.ip = remoteAddress;
         } else {

package/treeBuilder.js

@@ -60,8 +60,18 @@ class treeBuilder {
         }
 
         // Check if the device object exists and the device name is valid
-        if (deviceObject && typeof deviceName !== 'object') {
+        //if (deviceObject && typeof deviceName !== 'object') {
+        if (deviceObject) {
+
+
+            //console.log("processDevice found deviceObject ");
+
+            //await this.processDevicePoints(device, deviceObject, "testingDeviceName", ipAddress, deviceId, index);
+
             await this.processDevicePoints(device, deviceObject, deviceName, ipAddress, deviceId, index);
+
+        } else {
+            //console.log("Unable to find device object");
         }
     }
 
@@ -165,6 +175,7 @@ class treeBuilder {
             children: pointProperties,
             type: 'point',
             parentDevice: deviceName,
+            parentDeviceId: device.getDeviceId(),
             showAdded: false,
             bacnetType: point.meta.objectId.type,
         };
@@ -190,7 +201,6 @@ class treeBuilder {
         this.addPointProperty(pointProperties, 'Modification Date', point.modificationDate);
         this.addPointProperty(pointProperties, 'Program State', point.programState);
         this.addPointProperty(pointProperties, 'Record Count', point.recordCount);
-        this.addPointProperty(pointProperties, 'Vendor Name', point.vendorName);
 
         // Return the array of point properties
         return pointProperties;
@@ -394,7 +404,9 @@ class treeBuilder {
      * @returns {string} - The computed device name.
      */
     computeDeviceName(device) {
-        if (device.getDisplayName() !== null && device.getDisplayName() !== "" && device.getDisplayName() !== undefined) {
+        if (device.getDeviceName() == null && device.getDisplayName() == null) {
+            return `${this.getDeviceIpAddress(device)}-${device.getDeviceId()}`;
+        } else if (device.getDisplayName() !== null && device.getDisplayName() !== "" && device.getDisplayName() !== undefined) {
             return device.getDisplayName();
         }
         return device.getDeviceName();