@bitpoolos/edge-bacnet 1.5.3 → 1.6.1

package/common.js

@@ -1,13 +1,12 @@
 /*
-  MIT License Copyright 2021, 2024 - Bitpool Pty Ltd
+  MIT License Copyright 2021, 2025 - Bitpool Pty Ltd
 */
 
-const { createLogger, format, transports } = require("winston");
 const { randomUUID } = require("crypto");
 const os = require("os");
-const { exec } = require("child_process");
 const baEnum = require("./resources/node-bacstack-ts/dist/index.js").enum;
 const fs = require("fs");
+const fs2 = require("fs").promises;
 
 class BacnetConfig {
   constructor(
@@ -102,8 +101,6 @@ class BacnetClientConfig {
   }
 }
 
-
-
 class ReadCommandConfig {
   constructor(pointsToRead, objectProperties, decimalPrecision) {
     this.pointsToRead = pointsToRead;
@@ -190,30 +187,12 @@ const roundDecimalPlaces = function (value, decimals) {
   return value;
 };
 
-const doNodeRedRestart = function () {
-  return new Promise(function (resolve, reject) {
-    try {
-      exec("restart", (error, stdout, stderr) => {
-        if (error) {
-          console.log(`Node-Red restart error: ${error.message}`);
-          reject(error.message);
-        }
-        if (stderr) {
-          console.log(`Node-Red restart stderr: ${stderr}`);
-          reject(stderr);
-        }
-        resolve(stdout);
-      });
-    } catch (e) {
-      console.log(`Node-Red restart error: ${e}`);
-      reject(e);
-    }
-  });
-};
-
 // STORE CONFIG FUNCTION ==========================================================
 //
 // ================================================================================
+
+/*
+
 async function Store_Config(data) {
   try {
     await fs.writeFile("edge-bacnet-datastore.cfg", data, { encoding: "utf8", flag: "w" }, (err) => {
@@ -226,18 +205,185 @@ async function Store_Config(data) {
   }
 }
 
+*/
+
+// refactor:
+
+let storeQueue = [];
+let isStoreProcessing = false;
+
+async function queueConfigStore(data) {
+  storeQueue.push(data);
+
+  if (!isStoreProcessing) {
+    isStoreProcessing = true;
+
+    while (storeQueue.length > 0) {
+      const nextData = storeQueue.pop(); // Get most recent data
+      storeQueue.length = 0; // Clear any accumulated data
+
+      await Store_Config(nextData);
+
+      // Add small delay between attempts
+      await new Promise((resolve) => setTimeout(resolve, 100));
+    }
+
+    isStoreProcessing = false;
+  }
+}
+
+async function Store_Config(data) {
+  const mainFile = "edge-bacnet-datastore.cfg";
+  const tempFile = "edge-bacnet-datastore.cfg.tmp";
+  const backupFile = "edge-bacnet-datastore.cfg.bak";
+
+  try {
+    // First validate the JSON to ensure it's valid before writing
+    try {
+      JSON.parse(JSON.stringify(data));
+    } catch (jsonError) {
+      console.error("Invalid JSON data detected:", jsonError);
+      return false;
+    }
+
+    // Write to temporary file first
+    await fs2.writeFile(tempFile, JSON.stringify(data, null, 2), { encoding: "utf8" });
+
+    // Verify the temporary file is valid JSON
+    try {
+      const tempContent = await fs2.readFile(tempFile, "utf8");
+      JSON.parse(tempContent);
+    } catch (verifyError) {
+      console.error("Temporary file validation failed:", verifyError);
+      await fs2.unlink(tempFile).catch(() => {});
+      return false;
+    }
+
+    // Create backup of current file if it exists
+    try {
+      await fs2.access(mainFile);
+      await fs2.copyFile(mainFile, backupFile);
+    } catch (backupError) {
+      // If main file doesn't exist, no backup needed
+    }
+
+    // Atomic rename of temporary file to main file
+    await fs2.rename(tempFile, mainFile);
+    return true;
+  } catch (error) {
+    console.error("Store_Config error:", error);
+
+    // Cleanup temporary file if it exists
+    try {
+      await fs2.unlink(tempFile).catch(() => {});
+    } catch (cleanupError) {}
+
+    // If main file is corrupted and backup exists, restore from backup
+    try {
+      const backupExists = await fs2.access(backupFile).catch(() => false);
+      if (backupExists) {
+        await fs2.copyFile(backupFile, mainFile);
+        console.log("Restored from backup file");
+      }
+    } catch (restoreError) {
+      console.error("Failed to restore from backup:", restoreError);
+    }
+
+    return false;
+  }
+}
+
 // READ CONFIG SYNC FUNCTION ======================================================
 //
 // ================================================================================
+
 function Read_Config_Sync() {
-  var data = "{}";
+  const mainFile = "edge-bacnet-datastore.cfg";
+  const backupFile = "edge-bacnet-datastore.cfg.bak";
+  const defaultData = "{}";
+
   try {
-    data = fs.readFileSync("edge-bacnet-datastore.cfg", { encoding: "utf8", flag: "r" });
-  } catch (err) {
-    data = "{}";
-    Store_Config(data);
+    // Try to read the main file
+    let data = fsSync.readFileSync(mainFile, { encoding: "utf8" });
+
+    // Validate JSON
+    try {
+      JSON.parse(data);
+      return data;
+    } catch (jsonError) {
+      console.error("Main file contains invalid JSON, attempting backup recovery");
+
+      // Try to read backup file
+      try {
+        const backupData = fsSync.readFileSync(backupFile, { encoding: "utf8" });
+        JSON.parse(backupData); // Validate backup JSON
+
+        // Restore from backup
+        fsSync.copyFileSync(backupFile, mainFile);
+        console.log("Successfully restored from backup file");
+        return backupData;
+      } catch (backupError) {
+        console.error("Backup recovery failed, creating new file");
+        fsSync.writeFileSync(mainFile, defaultData, { encoding: "utf8" });
+        return defaultData;
+      }
+    }
+  } catch (error) {
+    console.error("Error reading config:", error);
+    fsSync.writeFileSync(mainFile, defaultData, { encoding: "utf8" });
+    return defaultData;
+  }
+}
+
+// refactor:
+
+async function Read_Config_Async() {
+  // todo rename function, not using sync
+  const mainFile = "edge-bacnet-datastore.cfg";
+  const backupFile = "edge-bacnet-datastore.cfg.bak";
+  const defaultData = "{}";
+
+  try {
+    // Try to read the main file
+    const data = await fs2.readFile(mainFile, { encoding: "utf8" });
+
+    // Validate JSON
+    try {
+      JSON.parse(data);
+
+      return data;
+    } catch (jsonError) {
+      console.error("Main file contains invalid JSON, attempting backup recovery");
+
+      // Try to read backup file
+      try {
+        const backupData = await fs2.readFile(backupFile, { encoding: "utf8" });
+        JSON.parse(backupData); // Validate backup JSON
+
+        // Restore from backup
+        await fs.copyFile(backupFile, mainFile);
+        console.log("Successfully restored from backup file");
+
+        console.log("log2");
+
+        return backupData;
+      } catch (backupError) {
+        console.error("Backup recovery failed, creating new file");
+        await Store_Config(defaultData);
+
+        console.log("log3");
+
+        return defaultData;
+      }
+    }
+  } catch (error) {
+    console.error("Error reading config:", error);
+    await Store_Config(defaultData);
+
+    console.log("log4");
+
+    return defaultData;
   }
-  return data;
 }
 
 // STORE CONFIG FUNCTION - BACNET SERVER ==========================================
@@ -250,7 +396,7 @@ async function Store_Config_Server(data) {
         //console.log("Store_Config_Server writeFile error: ", err);
       }
     });
-  } catch (err) { }
+  } catch (err) {}
 }
 
 // READ CONFIG SYNC FUNCTION - BACNET SERVER ======================================
@@ -288,12 +434,12 @@ function decodeBitArray(size, bits) {
     if (i == bits.length - 1) {
       return array;
     }
-  };
+  }
 }
 
 function getBacnetErrorString(classInt, codeInt) {
-  const classString = Object.keys(baEnum.ErrorClass).find(key => baEnum.ErrorClass[key] === classInt);
-  const codeString = Object.keys(baEnum.ErrorCode).find(key => baEnum.ErrorCode[key] === codeInt);
+  const classString = Object.keys(baEnum.ErrorClass).find((key) => baEnum.ErrorClass[key] === classInt);
+  const codeString = Object.keys(baEnum.ErrorCode).find((key) => baEnum.ErrorCode[key] === codeInt);
   return `BacnetError - Class:${classString} - Code:${codeString}`;
 }
 
@@ -309,7 +455,22 @@ function parseBacnetError(error) {
   }
 
   return err;
-};
+}
+function debounce(func, wait) {
+  let timeout;
+
+  return function (...args) {
+    const context = this;
+
+    // Clear the previous timeout
+    clearTimeout(timeout);
+
+    // Set a new timeout
+    timeout = setTimeout(() => {
+      func.apply(context, args);
+    }, wait);
+  };
+}
 
 module.exports = {
   BacnetConfig,
@@ -320,13 +481,15 @@ module.exports = {
   generateId,
   getIpAddress,
   roundDecimalPlaces,
-  doNodeRedRestart,
+  queueConfigStore,
   Store_Config,
   Read_Config_Sync,
+  Read_Config_Async,
   Store_Config_Server,
   Read_Config_Sync_Server,
   isNumber,
   decodeBitArray,
   parseBacnetError,
   getBacnetErrorString,
+  debounce,
 };

package/examples/1-Discover-Read.json

@@ -1 +1,170 @@
-[{"id":"a19aaf3c40f060de","type":"Bacnet-Gateway","z":"1bc98a48ab9b3af5","name":"","local_device_address":"","apduTimeout":6000,"roundDecimal":2,"local_device_port":47808,"apduSize":"5","maxSegments":"0x50","retries":"5","broadCastAddr":"255.255.255.255","toLogIam":true,"discover_polling_schedule":"120","discover_polling_schedule_value":"2","discover_polling_schedule_options":"Minutes","device_id_range_enabled":false,"device_id_range_start":"","device_id_range_end":"","deviceId":"817001","manual_instance_range_enabled":false,"manual_instance_range_start":"","manual_instance_range_end":"","logErrorToConsole":false,"serverEnabled":false,"device_read_schedule":"60","device_read_schedule_value":"1","device_read_schedule_options":"Minutes","x":660,"y":420,"wires":[["9d8b6ea1f9d11977"]]},{"id":"3e5f5a6efe7bf8cd","type":"Bitpool-Inject","z":"1bc98a48ab9b3af5","name":"Discover","props":[{"p":"payload"},{"p":"topic","vt":"str"}],"repeat":"","crontab":"","once":false,"onceDelay":0.1,"topic":"","payload":"","payloadType":"date","doPoll":false,"doDiscover":true,"x":480,"y":420,"wires":[["a19aaf3c40f060de"]]},{"id":"1774359e5a636b58","type":"Bitpool-Inject","z":"1bc98a48ab9b3af5","name":"Poll","props":[{"p":"payload"},{"p":"topic","vt":"str"}],"repeat":"","crontab":"","once":false,"onceDelay":0.1,"topic":"","payload":"","payloadType":"date","doPoll":true,"doDiscover":false,"x":310,"y":360,"wires":[["bfec7e0b535bef97"]]},{"id":"9d8b6ea1f9d11977","type":"debug","z":"1bc98a48ab9b3af5","name":"debug 1","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"true","targetType":"full","statusVal":"","statusType":"auto","x":840,"y":420,"wires":[]},{"id":"bfec7e0b535bef97","type":"Bacnet-Discovery","z":"1bc98a48ab9b3af5","name":"","events":true,"json":false,"mqtt":true,"hiddenDeployToggle":false,"prevHiddenToggleState":false,"roundDecimal":2,"pointsToRead":{},"readDevices":[],"object_property_simplePayload":true,"object_property_fullObject":false,"x":490,"y":360,"wires":[["a19aaf3c40f060de"]]}]
+[
+  {
+    "id": "ba92a36a18ffdfac",
+    "type": "Bacnet-Gateway",
+    "z": "f1fc21f44027188c",
+    "name": "",
+    "local_device_address": "",
+    "local_interface_name": "",
+    "apduTimeout": 6000,
+    "roundDecimal": 2,
+    "local_device_port": 47808,
+    "apduSize": "5",
+    "maxSegments": "0x50",
+    "retries": "5",
+    "broadCastAddr": "255.255.255.255",
+    "toLogIam": false,
+    "discover_polling_schedule": "900",
+    "discover_polling_schedule_value": "15",
+    "discover_polling_schedule_options": "Minutes",
+    "deviceId": 817001,
+    "logErrorToConsole": false,
+    "serverEnabled": true,
+    "device_read_schedule": "900",
+    "device_read_schedule_value": "15",
+    "device_read_schedule_options": "Minutes",
+    "deviceRangeRegisters": [
+      {
+        "enabled": true,
+        "start": "0",
+        "end": "4194303"
+      }
+    ],
+    "portRangeRegisters": [
+      {
+        "enabled": true,
+        "start": "47808",
+        "end": "47808"
+      }
+    ],
+    "cacheFileEnabled": false,
+    "sanitise_device_schedule": "3600",
+    "sanitise_device_schedule_value": "1",
+    "sanitise_device_schedule_options": "Hours",
+    "x": 800,
+    "y": 460,
+    "wires": [
+      [
+        "0688901dadf6d984"
+      ]
+    ]
+  },
+  {
+    "id": "c404d53530d50ce9",
+    "type": "Bacnet-Discovery",
+    "z": "f1fc21f44027188c",
+    "name": "",
+    "events": true,
+    "json": true,
+    "mqtt": false,
+    "pointJson": false,
+    "hiddenDeployToggle": false,
+    "prevHiddenToggleState": false,
+    "roundDecimal": 2,
+    "pointsToRead": {},
+    "readDevices": [],
+    "object_property_simplePayload": false,
+    "object_property_simpleWithStatus": false,
+    "object_property_fullObject": true,
+    "useDeviceName": true,
+    "x": 630,
+    "y": 400,
+    "wires": [
+      [
+        "ba92a36a18ffdfac"
+      ]
+    ]
+  },
+  {
+    "id": "d89267e068e24882",
+    "type": "Bitpool-Inject",
+    "z": "f1fc21f44027188c",
+    "name": "Poll",
+    "props": [
+      {
+        "p": "payload"
+      },
+      {
+        "p": "topic",
+        "vt": "str"
+      }
+    ],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "",
+    "payload": "",
+    "payloadType": "date",
+    "doPoll": true,
+    "doDiscover": false,
+    "json": false,
+    "mqtt": false,
+    "pointJson": true,
+    "object_property_simplePayload": false,
+    "object_property_simpleWithStatus": false,
+    "object_property_fullObject": true,
+    "useDeviceName": true,
+    "x": 470,
+    "y": 400,
+    "wires": [
+      [
+        "c404d53530d50ce9"
+      ]
+    ]
+  },
+  {
+    "id": "5f5537b37018ec25",
+    "type": "Bitpool-Inject",
+    "z": "f1fc21f44027188c",
+    "name": "Discover",
+    "props": [
+      {
+        "p": "payload"
+      },
+      {
+        "p": "topic",
+        "vt": "str"
+      }
+    ],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "",
+    "payload": "",
+    "payloadType": "date",
+    "doPoll": false,
+    "doDiscover": true,
+    "json": false,
+    "mqtt": false,
+    "pointJson": true,
+    "object_property_simplePayload": false,
+    "object_property_simpleWithStatus": false,
+    "object_property_fullObject": true,
+    "useDeviceName": true,
+    "x": 620,
+    "y": 460,
+    "wires": [
+      [
+        "ba92a36a18ffdfac"
+      ]
+    ]
+  },
+  {
+    "id": "0688901dadf6d984",
+    "type": "debug",
+    "z": "f1fc21f44027188c",
+    "name": "debug 1",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "false",
+    "statusVal": "",
+    "statusType": "auto",
+    "x": 1000,
+    "y": 460,
+    "wires": []
+  }
+]

package/examples/2-Discover-Write.json

@@ -1 +1,164 @@
-[{"id":"e478e80571442399","type":"Bacnet-Gateway","z":"1bc98a48ab9b3af5","name":"","local_device_address":"","apduTimeout":6000,"roundDecimal":2,"local_device_port":47808,"apduSize":"5","maxSegments":"0x50","retries":"5","broadCastAddr":"255.255.255.255","toLogIam":true,"discover_polling_schedule":"60","discover_polling_schedule_value":"1","discover_polling_schedule_options":"Minutes","device_id_range_enabled":false,"device_id_range_start":"","device_id_range_end":"","deviceId":"817001","manual_instance_range_enabled":false,"manual_instance_range_start":"","manual_instance_range_end":"","logErrorToConsole":false,"serverEnabled":false,"device_read_schedule":"60","device_read_schedule_value":"1","device_read_schedule_options":"Minutes","x":700,"y":320,"wires":[["0313b7ee1cfa6b42"]]},{"id":"c2e012301c4a6af4","type":"Bitpool-Inject","z":"1bc98a48ab9b3af5","name":"Discover","props":[{"p":"payload"},{"p":"topic","vt":"str"}],"repeat":"","crontab":"","once":false,"onceDelay":0.1,"topic":"","payload":"","payloadType":"date","doPoll":false,"doDiscover":true,"x":520,"y":320,"wires":[["e478e80571442399"]]},{"id":"8172620e7be7b505","type":"Bitpool-Inject","z":"1bc98a48ab9b3af5","name":"Poll","props":[{"p":"payload"},{"p":"topic","vt":"str"}],"repeat":"","crontab":"","once":false,"onceDelay":0.1,"topic":"","payload":"1","payloadType":"num","doPoll":true,"doDiscover":false,"x":370,"y":400,"wires":[["b3293195b7c5bd9d"]]},{"id":"0313b7ee1cfa6b42","type":"debug","z":"1bc98a48ab9b3af5","name":"debug 1","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"true","targetType":"full","statusVal":"","statusType":"auto","x":880,"y":320,"wires":[]},{"id":"b3293195b7c5bd9d","type":"Bacnet-Write","z":"1bc98a48ab9b3af5","name":"","applicationTag":"4","priority":"16","pointsToWrite":[],"writeDevices":[],"hiddenDeployToggle":false,"prevHiddenToggleState":false,"x":530,"y":400,"wires":[["e478e80571442399"]]}]
+[
+  {
+    "id": "25ee9078510fe398",
+    "type": "Bacnet-Gateway",
+    "z": "f1fc21f44027188c",
+    "name": "",
+    "local_device_address": "",
+    "local_interface_name": "",
+    "apduTimeout": 6000,
+    "roundDecimal": 2,
+    "local_device_port": 47808,
+    "apduSize": "5",
+    "maxSegments": "0x50",
+    "retries": "5",
+    "broadCastAddr": "255.255.255.255",
+    "toLogIam": false,
+    "discover_polling_schedule": "900",
+    "discover_polling_schedule_value": "15",
+    "discover_polling_schedule_options": "Minutes",
+    "deviceId": 817001,
+    "logErrorToConsole": false,
+    "serverEnabled": true,
+    "device_read_schedule": "900",
+    "device_read_schedule_value": "15",
+    "device_read_schedule_options": "Minutes",
+    "deviceRangeRegisters": [
+      {
+        "enabled": true,
+        "start": "0",
+        "end": "4194303"
+      }
+    ],
+    "portRangeRegisters": [
+      {
+        "enabled": true,
+        "start": "47808",
+        "end": "47808"
+      }
+    ],
+    "cacheFileEnabled": true,
+    "sanitise_device_schedule": "3600",
+    "sanitise_device_schedule_value": "1",
+    "sanitise_device_schedule_options": "Hours",
+    "x": 840,
+    "y": 420,
+    "wires": [
+      [
+        "f41ef6737463370e"
+      ]
+    ]
+  },
+  {
+    "id": "0f90856ca1808ee7",
+    "type": "Bitpool-Inject",
+    "z": "f1fc21f44027188c",
+    "name": "Discover",
+    "props": [
+      {
+        "p": "payload"
+      },
+      {
+        "p": "topic",
+        "vt": "str"
+      }
+    ],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "",
+    "payload": "",
+    "payloadType": "date",
+    "doPoll": false,
+    "doDiscover": true,
+    "json": false,
+    "mqtt": false,
+    "pointJson": true,
+    "object_property_simplePayload": false,
+    "object_property_simpleWithStatus": false,
+    "object_property_fullObject": true,
+    "useDeviceName": true,
+    "x": 660,
+    "y": 420,
+    "wires": [
+      [
+        "25ee9078510fe398"
+      ]
+    ]
+  },
+  {
+    "id": "c7f1aa7764f29aa1",
+    "type": "Bacnet-Write",
+    "z": "f1fc21f44027188c",
+    "name": "",
+    "applicationTag": "4",
+    "priority": "16",
+    "pointsToWrite": [],
+    "writeDevices": [],
+    "hiddenDeployToggle": false,
+    "prevHiddenToggleState": false,
+    "x": 670,
+    "y": 500,
+    "wires": [
+      [
+        "25ee9078510fe398"
+      ]
+    ]
+  },
+  {
+    "id": "c97fbed9db70de7f",
+    "type": "Bitpool-Inject",
+    "z": "f1fc21f44027188c",
+    "name": "Poll",
+    "props": [
+      {
+        "p": "payload"
+      },
+      {
+        "p": "topic",
+        "vt": "str"
+      }
+    ],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "",
+    "payload": "",
+    "payloadType": "date",
+    "doPoll": true,
+    "doDiscover": false,
+    "json": false,
+    "mqtt": false,
+    "pointJson": true,
+    "object_property_simplePayload": false,
+    "object_property_simpleWithStatus": false,
+    "object_property_fullObject": true,
+    "useDeviceName": true,
+    "x": 490,
+    "y": 500,
+    "wires": [
+      [
+        "c7f1aa7764f29aa1"
+      ]
+    ]
+  },
+  {
+    "id": "f41ef6737463370e",
+    "type": "debug",
+    "z": "f1fc21f44027188c",
+    "name": "debug 1",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "true",
+    "targetType": "full",
+    "statusVal": "",
+    "statusType": "auto",
+    "x": 1040,
+    "y": 420,
+    "wires": []
+  }
+]