@bitpoolos/edge-bacnet 1.2.5 → 1.2.7

package/common.js

@@ -2,86 +2,97 @@
   MIT License Copyright 2021, 2022 - Bitpool Pty Ltd
 */
 
-const { createLogger, format, transports } = require('winston');
-const { randomUUID } = require('crypto');
-const os = require('os');
+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 baEnum = require("./resources/node-bacstack-ts/dist/index.js").enum;
+const fs = require("fs");
 
 const logger = createLogger({
-    format: format.combine(
-        format.timestamp({
-            format: 'YYYY-MM-DD HH:mm:ss'
-        }),
-        format.json()
-    ),
-    transports: [new transports.Console()],
+  format: format.combine(
+    format.timestamp({
+      format: "YYYY-MM-DD HH:mm:ss",
+    }),
+    format.json()
+  ),
+  transports: [new transports.Console()],
 });
 
 class DeviceObjectId {
-    constructor(type, instance) {
-        this.type = type;
-        this.instance = instance;
-    }
+  constructor(type, instance) {
+    this.type = type;
+    this.instance = instance;
+  }
 }
 
 class DeviceObject {
-    constructor(objectId, name, description, type, units, presentValue) {
-        this.objectId = objectId;
-        this.name = name;
-        this.description = description;
-        this.type = type;
-        this.units = units;
-        this.presentValue = presentValue;
-    }
+  constructor(objectId, name, description, type, units, presentValue) {
+    this.objectId = objectId;
+    this.name = name;
+    this.description = description;
+    this.type = type;
+    this.units = units;
+    this.presentValue = presentValue;
+  }
 }
 
 class BacnetConfig {
-    constructor(device, objects, bacnet_polling_schedule, apduTimeout, localIpAdrress, roundDecimal, local_device_port, apduSize, maxSegments, broadCastAddr) {
-      this.device = {
-        "deviceId": device.deviceId,
-        "address": device.address
-      };
-      this.polling = {
-        "schedule": bacnet_polling_schedule
-      };
-      this.objects = [{
-        "objectId": {
-          "type": objects.object_type,
-          "instance": objects.instance,
-          "properties": objects.object_props
-        }
-      }];
-      this.apduTimeout = apduTimeout;
-      this.localIpAdrress = localIpAdrress;
-      this.roundDecimal = roundDecimal;
-      this.port = local_device_port;
-      this.apduSize = apduSize;
-      this.maxSegments = maxSegments;
-      this.broadCastAddr = broadCastAddr;
+  constructor(
+    device,
+    objects,
+    bacnet_polling_schedule,
+    apduTimeout,
+    localIpAdrress,
+    roundDecimal,
+    local_device_port,
+    apduSize,
+    maxSegments,
+    broadCastAddr
+  ) {
+    this.device = {
+      deviceId: device.deviceId,
+      address: device.address,
+    };
+    this.polling = {
+      schedule: bacnet_polling_schedule,
+    };
+    this.objects = [
+      {
+        objectId: {
+          type: objects.object_type,
+          instance: objects.instance,
+          properties: objects.object_props,
+        },
+      },
+    ];
+    this.apduTimeout = apduTimeout;
+    this.localIpAdrress = localIpAdrress;
+    this.roundDecimal = roundDecimal;
+    this.port = local_device_port;
+    this.apduSize = apduSize;
+    this.maxSegments = maxSegments;
+    this.broadCastAddr = broadCastAddr;
   }
-};
+}
 
 class BacnetClientConfig {
   constructor(
-    apduTimeout, 
-    localIpAdrress, 
-    local_device_port, 
-    apduSize, 
-    maxSegments, 
-    broadCastAddr, 
+    apduTimeout,
+    localIpAdrress,
+    local_device_port,
+    apduSize,
+    maxSegments,
+    broadCastAddr,
     discover_polling_schedule,
-    device_id_range_enabled, 
-    device_id_range_start, 
-    device_id_range_end, 
-    toRestartNodeRed, 
+    toRestartNodeRed,
     deviceId,
     manual_instance_range_enabled,
     manual_instance_range_start,
     manual_instance_range_end,
     device_read_schedule,
-    retries
+    retries,
+    cacheFileEnabled
   ) {
     this.apduTimeout = apduTimeout;
     this.localIpAdrress = localIpAdrress;
@@ -90,9 +101,6 @@ class BacnetClientConfig {
     this.maxSegments = maxSegments;
     this.broadCastAddr = broadCastAddr;
     this.discover_polling_schedule = discover_polling_schedule;
-    this.device_id_range_enabled = device_id_range_enabled;
-    this.device_id_range_start = device_id_range_start;
-    this.device_id_range_end = device_id_range_end;
     this.toRestartNodeRed = toRestartNodeRed;
     this.deviceId = deviceId;
     this.manual_instance_range_enabled = manual_instance_range_enabled;
@@ -100,8 +108,9 @@ class BacnetClientConfig {
     this.manual_instance_range_end = manual_instance_range_end;
     this.device_read_schedule = device_read_schedule;
     this.retries = retries;
+    this.cacheFileEnabled = cacheFileEnabled;
   }
-};
+}
 
 class ReadCommandConfig {
   constructor(pointsToRead, objectProperties, decimalPrecision) {
@@ -109,33 +118,35 @@ class ReadCommandConfig {
     this.objectProperties = objectProperties;
     this.precision = decimalPrecision;
   }
-};
+}
 
 class WriteCommandConfig {
   constructor(device, objects) {
     this.device = {
-      "deviceId": device.deviceId,
-      "address": device.address
+      deviceId: device.deviceId,
+      address: device.address,
     };
-    this.objects = [{
-      "objectId": {
-        "type": objects.object_type,
-        "instance": objects.instance,
-        "properties": objects.object_props
-      }
-    }];
+    this.objects = [
+      {
+        objectId: {
+          type: objects.object_type,
+          instance: objects.instance,
+          properties: objects.object_props,
+        },
+      },
+    ];
   }
-};
+}
 
-const getUnit = function(id) {
+const getUnit = function (id) {
   for (var key in baEnum.EngineeringUnits) {
-    if(baEnum.EngineeringUnits[key] == id) {
+    if (baEnum.EngineeringUnits[key] == id) {
       if (baEnum.EngineeringUnits.hasOwnProperty(key)) {
         let unitsArr = key.split("_");
         let unit;
-        unitsArr.forEach((ele, index) =>{
-          if(index == 0){
-             unit = ele.toLowerCase();
+        unitsArr.forEach((ele, index) => {
+          if (index == 0) {
+            unit = ele.toLowerCase();
           } else {
             unit += "-" + ele.toLowerCase();
           }
@@ -147,61 +158,61 @@ const getUnit = function(id) {
   return "no-units";
 };
 
-const generateId = function() {
+const generateId = function () {
   return randomUUID();
 };
 
-const getIpAddress = function() {
-  return new Promise(function(resolve, reject) {
+const getIpAddress = function () {
+  return new Promise(function (resolve, reject) {
     const nets = os.networkInterfaces();
     const results = Object.create(null); // Or just '{}', an empty object
     for (const name of Object.keys(nets)) {
-        for (const net of nets[name]) {
-            // Skip over non-IPv4 and internal (i.e. 127.0.0.1) addresses
-            let family = parseInt(net.family.toString().match(/[0-9]/));
-            if (family === 4 && !net.internal) {
-                if (!results[name]) {
-                    results[name] = [];
-                }
-                results[name].push(net.address);
-            }
+      for (const net of nets[name]) {
+        // Skip over non-IPv4 and internal (i.e. 127.0.0.1) addresses
+        let family = parseInt(net.family.toString().match(/[0-9]/));
+        if (family === 4 && !net.internal) {
+          if (!results[name]) {
+            results[name] = [];
+          }
+          results[name].push(net.address);
         }
+      }
     }
 
-    if(os.version().includes('Ubuntu')) {
-      let allInterfaceName = 'All interfaces';
+    if (os.version().includes("Ubuntu")) {
+      let allInterfaceName = "All interfaces";
       if (!results[allInterfaceName]) {
         results[allInterfaceName] = [];
       }
-      results[allInterfaceName].push('0.0.0.0');
-    } else if(os.version().includes('Windows')) {
+      results[allInterfaceName].push("0.0.0.0");
+    } else if (os.version().includes("Windows")) {
       //do nothing
     }
-    
+
     resolve(results);
   });
-}
+};
 
-const roundDecimalPlaces = function(value, decimals) {
-  if(decimals) return Number(Math.round(value+'e'+decimals)+'e-'+decimals);
+const roundDecimalPlaces = function (value, decimals) {
+  if (decimals) return Number(Math.round(value + "e" + decimals) + "e-" + decimals);
   return value;
-}
+};
 
-const doNodeRedRestart = function() {
-  return new Promise(function(resolve, reject) {
+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);
+          console.log(`Node-Red restart error: ${error.message}`);
+          reject(error.message);
         }
         if (stderr) {
-            console.log(`Node-Red restart stderr: ${stderr}`);
-            reject(stderr);
+          console.log(`Node-Red restart stderr: ${stderr}`);
+          reject(stderr);
         }
         resolve(stdout);
       });
-    } catch(e){
+    } catch (e) {
       console.log(`Node-Red restart error: ${e}`);
       reject(e);
     }
@@ -211,11 +222,17 @@ const doNodeRedRestart = function() {
 // STORE CONFIG FUNCTION ==========================================================
 //
 // ================================================================================
-async function Store_Config(data) {
+function Store_Config(data) {
   try {
-    await fs.writeFile("edge-bacnet-datastore.cfg", data, (err) => {
-      if (err) {
-        console.log("Store_Config writeFile error: ", err);
+    fs.access("edge-bacnet-datastore.cfg", fs.constants.W_OK, async function(err) {
+      if(err){
+        console.log("Store_Config writeAccess error found: ", err);
+      } else {
+        await fs.writeFile("edge-bacnet-datastore.cfg", data, {encoding: "utf8", flag: "w"}, (err) => {
+          if (err) {
+            console.log("Store_Config writeFile error: ", err);
+          }
+        });
       }
     });
   } catch(e){
@@ -223,6 +240,8 @@ async function Store_Config(data) {
   }
 };
 
+
+
 // READ CONFIG SYNC FUNCTION ======================================================
 //
 // ================================================================================
@@ -246,13 +265,11 @@ async function Store_Config_Server(data) {
   try {
     await fs.writeFile("edge-bacnet-server-datastore.cfg", data, (err) => {
       if (err) {
-        console.log("Store_Config_Server writeFile error: ", err);
+        //console.log("Store_Config_Server writeFile error: ", err);
       }
     });
-  }
-  catch (err) {
-  }
-};
+  } catch (err) {}
+}
 
 // READ CONFIG SYNC FUNCTION - BACNET SERVER ======================================
 //
@@ -260,29 +277,33 @@ async function Store_Config_Server(data) {
 function Read_Config_Sync_Server() {
   var data = "{}";
   try {
-    data = fs.readFileSync("edge-bacnet-server-datastore.cfg", {encoding:'utf8', flag:'r'});
-  }
-  catch(err) {
-    console.log("Read_Config_Sync_Server error:", err);
-    if(err.errno == -4058) console.log("Edge-BACnet Server: No save file found, creating new file");
-    data = '{}';
+    data = fs.readFileSync("edge-bacnet-server-datastore.cfg", { encoding: "utf8", flag: "r" });
+  } catch (err) {
+    //console.log("Read_Config_Sync_Server error:", err);
+    if (err.errno == -4058) console.log("Edge-BACnet Server: No save file found, creating new file");
+    data = "{}";
     Store_Config_Server(data);
   }
   return data;
-};
+}
+
+function isNumber(value) {
+  return value != null && typeof value === 'number' && !isNaN(value);
+}
 
 module.exports = {
-  BacnetConfig, 
-  BacnetClientConfig, 
-  ReadCommandConfig, 
+  BacnetConfig,
+  BacnetClientConfig,
+  ReadCommandConfig,
   WriteCommandConfig,
-  getUnit, 
-  generateId, 
-  getIpAddress, 
-  roundDecimalPlaces, 
+  getUnit,
+  generateId,
+  getIpAddress,
+  roundDecimalPlaces,
   doNodeRedRestart,
   Store_Config,
   Read_Config_Sync,
   Store_Config_Server,
-  Read_Config_Sync_Server
-};
+  Read_Config_Sync_Server,
+  isNumber,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bitpoolos/edge-bacnet",
-  "version": "1.2.5",
+  "version": "1.2.7",
   "description": "A bacnet gateway for node-red",
   "dependencies": {
     "@plus4nodered/ts-node-bacnet": "^1.0.0-beta.2",
@@ -8,7 +8,6 @@
     "cronosjs": "^1.7.1",
     "debug": "^4.1.1",
     "iconv-lite": "^0.5.1",
-    "node-fetch": "^2.6.1",
     "toad-scheduler": "^1.6.0",
     "underscore": "^1.10.2",
     "winston": "^3.2.1"
@@ -51,4 +50,4 @@
     "type": "github",
     "url": "git+https://github.com/bitpool/edge-bacnet.git"
   }
-}
+}

package/resources/icons/icon-read.svg

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg id="Layer_1" data-name="Layer 1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 30 30">
+  <defs>
+    <style>
+      .cls-1 {
+        fill: none;
+        stroke: #6c757d;
+        stroke-linecap: round;
+        stroke-linejoin: round;
+        stroke-width: 2px;
+      }
+    </style>
+  </defs>
+  <circle class="cls-1" cx="15" cy="15" r="14"/>
+  <g>
+    <path class="cls-1" d="M11.21,22s0-14,0-14h5.13c1.91,0,3.46,1.55,3.46,3.46v.54c0,1.91-1.55,3.46-3.46,3.46h-5.13"/>
+    <line class="cls-1" x1="15.51" y1="15.45" x2="20.03" y2="21.94"/>
+  </g>
+</svg>

package/resources/icons/icon-write.svg

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg id="Layer_1" data-name="Layer 1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 30 30">
+  <defs>
+    <style>
+      .cls-1 {
+        fill: none;
+        stroke: #6c757d;
+        stroke-linecap: round;
+        stroke-linejoin: round;
+        stroke-width: 2px;
+      }
+    </style>
+  </defs>
+  <circle class="cls-1" cx="15" cy="15" r="14"/>
+  <polyline class="cls-1" points="22.21 9.75 18.61 21.35 15 9.75 11.39 21.35 7.79 9.75"/>
+</svg>

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

@@ -616,7 +616,7 @@ class Client extends events_1.EventEmitter {
         const type = baEnum.PduTypes.CONFIRMED_REQUEST | (settings.maxSegments !== baEnum.MaxSegmentsAccepted.SEGMENTS_0 ? baEnum.PduConReqBits.SEGMENTED_RESPONSE_ACCEPTED : 0);
         baApdu.encodeConfirmedServiceRequest(buffer, type, baEnum.ConfirmedServiceChoice.READ_PROPERTY, settings.maxSegments, settings.maxApdu, settings.invokeId, 0, 0);
         baServices.readProperty.encode(buffer, objectId.type, objectId.instance, propertyId, settings.arrayIndex);
-        //baBvlc.encode(buffer.buffer, baEnum.BvlcResultPurpose.ORIGINAL_UNICAST_NPDU, buffer.offset);
+        baBvlc.encode(buffer.buffer, baEnum.BvlcResultPurpose.ORIGINAL_UNICAST_NPDU, buffer.offset);
         this.sendBvlc(address, buffer);
         this._addCallback(settings.invokeId, (err, data) => {
             try{
@@ -672,7 +672,7 @@ class Client extends events_1.EventEmitter {
         baNpdu.encode(buffer, baEnum.NpduControlPriority.NORMAL_MESSAGE | baEnum.NpduControlBits.EXPECTING_REPLY, address, null, DEFAULT_HOP_COUNT, baEnum.NetworkLayerMessageType.WHO_IS_ROUTER_TO_NETWORK, 0);
         baApdu.encodeConfirmedServiceRequest(buffer, baEnum.PduTypes.CONFIRMED_REQUEST, baEnum.ConfirmedServiceChoice.WRITE_PROPERTY, settings.maxSegments, settings.maxApdu, settings.invokeId, 0, 0);
         baServices.writeProperty.encode(buffer, objectId.type, objectId.instance, propertyId, settings.arrayIndex, settings.priority, values);
-        //baBvlc.encode(buffer.buffer, baEnum.BvlcResultPurpose.ORIGINAL_UNICAST_NPDU, buffer.offset);
+        baBvlc.encode(buffer.buffer, baEnum.BvlcResultPurpose.ORIGINAL_UNICAST_NPDU, buffer.offset);
         this.sendBvlc(address, buffer);
         this._addCallback(settings.invokeId, (err) => next(err));
     }
@@ -714,7 +714,7 @@ class Client extends events_1.EventEmitter {
         const type = baEnum.PduTypes.CONFIRMED_REQUEST | (settings.maxSegments !== baEnum.MaxSegmentsAccepted.SEGMENTS_0 ? baEnum.PduConReqBits.SEGMENTED_RESPONSE_ACCEPTED : 0);
         baApdu.encodeConfirmedServiceRequest(buffer, type, baEnum.ConfirmedServiceChoice.READ_PROPERTY_MULTIPLE, settings.maxSegments, settings.maxApdu, settings.invokeId, 0, 0);
         baServices.readPropertyMultiple.encode(buffer, propertiesArray);
-        //baBvlc.encode(buffer.buffer, baEnum.BvlcResultPurpose.ORIGINAL_UNICAST_NPDU, buffer.offset);
+        baBvlc.encode(buffer.buffer, baEnum.BvlcResultPurpose.ORIGINAL_UNICAST_NPDU, buffer.offset);
         this.sendBvlc(address, buffer);
         //this.sendBvlc(address, buffer);
         this._addCallback(settings.invokeId, (err, data) => {

package/resources/style.css

@@ -0,0 +1,11 @@
+.writePointIcon {
+    background: url("icons/icon-write.svg") no-repeat !important;
+    width: 20px;
+    height: 20px;
+}
+
+.readPointIcon {
+    background: url("icons/icon-read.svg") no-repeat !important;
+    width: 20px;
+    height: 20px;
+}