@tier0/node-opc-da 1.0.7

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@tier0/node-opc-da",
+  "version": "1.0.7",
+  "description": "A library to communicate with OPC-DA servers",
+  "main": "src/index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/FREEZONEX/node-opc-da.git"
+  },
+  "keywords": [
+    "opc",
+    "opc-da",
+    "automation",
+    "plc",
+    "hardware"
+  ],
+  "author": "Guilherme Francescon <guilherme.francescon@netsmarttech.com>",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@tier0/node-dcom": "^1.2.0",
+    "random": "^2.1.1",
+    "long": "^4.0.0"
+  }
+}

package/src/constants.js

@@ -0,0 +1,212 @@
+//@ts-check
+/*
+  Copyright: (c) 2019, Guilherme Francescon Cittolin <gfcittolin@gmail.com>
+  GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
+*/
+
+const constants = {
+  clsid: {
+    OPCServerList_CLSID: "13486D51-4821-11D2-A494-3CB306C10000"
+  },
+  iid: {
+    IConnectionPointContainer_IID: "B196B284-BAB4-101A-B69C-00AA00341D07",
+    IConnectionPoint_IID: "B196B286-BAB4-101A-B69C-00AA00341D07",
+    IOPCCommon_IID: "F31DFDE2-07B6-11D2-B2D8-0060083BA1FB",
+    IEnumString_IID: "00000101-0000-0000-C000-000000000046",
+    IEnumGUID_IID: "0002E000-0000-0000-C000-000000000046",
+    IOPCServer_IID: "39C13A4D-011E-11D0-9675-0020AFD8ADB3",
+    IOPCGroupStateMgt_IID: "39C13A50-011E-11D0-9675-0020AFD8ADB3",
+    IOPCBrowse_IID: "39227004-A18F-4B57-8B0A-5235670F4468",
+    IOPCBrowseServerAddressSpace_IID: "39C13A4F-011E-11D0-9675-0020AFD8ADB3",
+    IOPCItemMgt_IID: "39C13A54-011E-11D0-9675-0020AFD8ADB3",
+    IOPCItemProperties_IID: "39C13A72-011E-11D0-9675-0020AFD8ADB3",
+    IOPCItemIO_IID: "85C0B427-2893-4CBC-BD78-E5FC5146F08F",
+    IOPCDataCallback_IID: "39C13A70-011E-11D0-9675-0020AFD8ADB3",
+    IOPCAsyncIO2_IID: "39C13A71-011E-11D0-9675-0020AFD8ADB3",
+    IOPCSyncIO_IID: "39C13A52-011E-11D0-9675-0020AFD8ADB3",
+    IOPCServerList_IID: "13486D50-4821-11D2-A494-3CB306C10000"
+  },
+  category: {
+    OPCDAServer10: "63D5F430-CFE4-11d1-B2C8-0060083BA1FB",
+    OPCDAServer20: "63D5F432-CFE4-11d1-B2C8-0060083BA1FB",
+    OPCDAServer30: "CC603642-66D7-48f1-B69A-B625E73652D7",
+    XMLDAServer10: "3098EDA4-A006-48b2-A27F-247453959408"
+  },
+  opc: {
+    browse: {
+      direction: {
+        UNKNOWN: 0,
+        UP: 1,
+        DOWN: 2,
+        TO: 3
+      },
+      type: {
+        UNKNOWN: 0,
+        BRANCH: 1,
+        LEAF: 2,
+        FLAT: 3
+      }
+    },
+    dataSource: {
+      UNKNOWN: 0,
+      CACHE: 1,
+      DEVICE: 2
+    },
+    scope: {
+      UNKNOWN: 0,
+      PRIVATE_CONNECTIONS: 1,
+      PUBLIC_CONNECTIONS: 2,
+      ALL_CONNECTIONS: 3,
+      PRIVATE: 4,
+      PUBLIC: 5,
+      ALL: 6
+    },
+    namespaceType: {
+      UNKNOWN: 0,
+      HIERARCHIAL: 1,
+      FLAT: 2
+    },
+    state: {
+      UNKNOWN: 0,
+      RUNNING: 1,
+      FAILED: 2,
+      NOCONFIG: 3,
+      SUSPENDED: 4,
+      TEST: 5,
+      COMM_FAULT: 6
+    },
+    stateLabel: {
+      "0": "unknown",
+      "1": "running",
+      "2": "failed",
+      "3": "noconfig",
+      "4": "suspended",
+      "5": "test",
+      "6": "comm_fault"
+    },
+    error: {
+      OPCInvalidHandle: 3221487617,
+      OPCBadType: 3221487620,
+      OPCPublic: 3221487621,
+      OPCBadRights: 3221487622,
+      OPCUnknownItemID: 3221487623,
+      OPCInvalidItemID: 3221487624,
+      OPCInvalidFilter: 3221487625,
+      OPCUnknownPath: 3221487626,
+      OPCRange: 3221487627,
+      OPCDuplicateName: 3221487628,
+      OPCUnsupportedRate: 262157,
+      OPCClamp: 262158,
+      OPCInuse: 262159,
+      OPCInvalidConfig: 3221487632,
+      OPCNotFound: 3221487633,
+      OPCInvalidPID: 3221488131
+    },
+    errorDesc: {
+      "3221487617": "The value of the handle is invalid",
+      "3221487620": "The server cannot convert the data between the specified format/requested data type and the canonical data type",
+      "3221487621": "The requested operation cannot be done on a public group",
+      "3221487622": "The Items AccessRights do not allow the operation",
+      "3221487623": "The item ID is not defined in the server address space (on add or validate) or no longer exists in the server address space (for read or write)",
+      "3221487624": "The item ID doesn't conform to the server's syntax",
+      "3221487625": "The filter string was not valid",
+      "3221487626": "The item's access path is not known to the server",
+      "3221487627": "The value was out of range",
+      "3221487628": "Duplicate name not allowed",
+      "262157": "The server does not support the requested data rate but will use the closest available rate",
+      "262158": "A value passed to WRITE was accepted but the output was clamped",
+      "262159": "The operation cannot be performed because the object is bering referenced",
+      "3221487632": "The server's configuration file is in an invalid format",
+      "3221487633": "Requested Object (e.g. a public group) was not found",
+      "3221488131": "The passed property ID is not valid for the item"
+    },
+    property: {
+      DATATYPE: 1,
+      VALUE: 2,
+      QUALITY: 3,
+      TIMESTAMP: 4,
+      ACCESS_RIGHTS: 5,
+      SCAN_RATE: 6,
+      EU_TYPE: 7,
+      EU_INFO: 8,
+      EU_UNITS: 100,
+      DESCRIPTION: 101,
+      HIGH_EU: 102,
+      LOW_EU: 103,
+      HIGH_IR: 104,
+      LOW_IR: 105,
+      CLOSE_LABEL: 106,
+      OPEN_LABEL: 107,
+      TIMEZONE: 108,
+      CONDITION_STATUS: 300,
+      ALARM_QUICK_HELP: 301,
+      ALARM_AREA_LIST: 302,
+      PRIMARY_ALARM_AREA: 303,
+      CONDITION_LOGIC: 304,
+      LIMIT_EXCEEDED: 305,
+      DEADBAND: 306,
+      HIHI_LIMIT: 307,
+      HI_LIMIT: 308,
+      LO_LIMIT: 309,
+      LOLO_LIMIT: 310,
+      CHANGE_RATE_LIMIT: 311,
+      DEVIATION_LIMIT: 312,
+      SOUND_FILE: 313,
+      TYPE_SYSTEM_ID: 600,
+      DICTIONARY_ID: 601,
+      TYPE_ID: 602,
+      DICTIONARY: 603,
+      TYPE_DESCRIPTION: 604,
+      CONSISTENCY_WINDOW: 605,
+      WRITE_BEHAVIOR: 606,
+      UNCONVERTED_ITEM_ID: 607,
+      UNFILTERED_ITEM_ID: 608,
+      DATA_FILTER_VALUE: 609,
+    },
+    propertyDesc: {
+      "1": "Item Canonical Data Type",
+      "2": "Item Value",
+      "3": "Item Quality",
+      "4": "Item Timestamp",
+      "5": "Item Access Rights",
+      "6": "Server Scan Rate",
+      "7": "Item EU Type",
+      "8": "Item EU Info",
+      "100": "EU Units",
+      "101": "Item Description",
+      "102": "High EU",
+      "103": "Low EU",
+      "104": "High Instrument Range",
+      "105": "Low Instrument Range",
+      "106": "Contact Close Label",
+      "107": "Contact Open Label",
+      "108": "Item Timezone",
+      "300": "Condition Status",
+      "301": "Alarm Quick Help",
+      "302": "Alarm Area List",
+      "303": "Primary Alarm Area",
+      "304": "Condition Logic",
+      "305": "Limit Exceeded",
+      "306": "Deadband",
+      "307": "HiHi Limit",
+      "308": "Hi Limit",
+      "309": "Lo Limit",
+      "310": "LoLo Limit",
+      "311": "Rate of Change Limit",
+      "312": "Deviation Limit",
+      "313": "Sound File",
+      "600": "Type System ID",
+      "601": "Dictionary ID",
+      "602": "Type ID",
+      "603": "Dictionary",
+      "604": "Type Description",
+      "605": "Consistency Window",
+      "606": "Write Behavior",
+      "607": "Unconverted Item ID",
+      "608": "Unfiltered Item ID",
+      "609": "Data Filter Value"
+    }
+  }
+};
+
+module.exports = Object.freeze(constants);

package/src/enumString.js

@@ -0,0 +1,161 @@
+//@ts-check
+/*
+  Copyright: (c) 2019, Guilherme Francescon Cittolin <gfcittolin@gmail.com>
+  GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
+*/
+
+const constants = require('./constants.js');
+const dcom = require('node-dcom');
+const util = require('util');
+const debug = util.debuglog('node-opc-da');
+
+/**
+ * Represents an EnumString
+ */
+class EnumString {
+
+    /**
+     * 
+     * @param {number} [batchSize=10]
+     */
+    constructor(batchSize){
+        this._batchSize = batchSize || 10;
+
+        this._comObj = null;
+    }
+
+    /**
+     *
+     * @param {*} unknown
+     * @returns {Promise<?>}
+     */
+    async init(unknown) {
+        debug("Initing EnumString...");
+        if (this._comObj) throw new Error("Already initialized");
+
+        this._comObj = await unknown.queryInterface(constants.iid.IEnumString_IID);
+        debug("EnumString successfully inited.");
+    }
+
+    async end(hresult) {
+        debug("Destroying EnumString...");
+        if (!this._comObj) return;
+
+        let obj = this._comObj;
+        debug(String(new Error(String(hresult))));
+        this._comObj = null;
+        await obj.release();
+        debug("EnumString successfully destroyed.");
+    }
+
+    /**
+     * 
+     * @param {number} num
+     * @returns {Promise<string[]>}
+     * @opNum 0
+     */
+    async next(num) {
+        debug("Querying the server for a batch of  " + num + " items...");
+        if (!this._comObj) throw new Error("Not initialized");
+
+        if (num <= 0) return [];
+
+        let callObject = new dcom.CallBuilder(true);
+        callObject.setOpnum(0);
+
+        let strValue = new dcom.ComValue(new dcom.ComString(dcom.Flags.FLAG_REPRESENTATION_STRING_LPWSTR), dcom.Types.COMSTRING);
+        let strArrayValue = new dcom.ComValue(new dcom.ComArray(strValue, null, 1, true, true), dcom.Types.COMARRAY);
+        callObject.addInParamAsInt(num, dcom.Flags.FLAG_NULL);
+        callObject.addOutParamAsObject(strArrayValue, dcom.Flags.FLAG_NULL);
+        callObject.addOutParamAsType(dcom.Types.INTEGER, dcom.Flags.FLAG_NULL);
+
+        let resultObj = await this._comObj.call(callObject);
+
+        let hresult = resultObj.hresult;
+        let result = resultObj.getResults();
+        if (hresult != 0) {
+            if (result.lenght == 0)
+                throw new Error(String(hresult));
+            else 
+                debug("No more items.");
+        }
+
+        let resultData;
+        if (result instanceof dcom.ComValue)
+            resultData = result[0].getValue().getArrayInstance();
+        else 
+            resultData = result[0].getValue().getArrayInstance();
+        let count = result[1].getValue();
+
+        let res = [];
+        for (let i = 0; i < count; i++) {
+            res.push(resultData[i].getValue().getString());
+        }
+        debug("Items successfullly obtained.");
+        return res;
+    }
+
+    /**
+     * 
+     * @param {number} num 
+     * @returns {Promise<>}
+     * @opnum 1
+     */
+    async skip(num) {
+        if (!this._comObj) throw new Error("Not initialized");
+
+        if (num <= 0) return [];
+
+        let callObject = new dcom.CallBuilder(true);
+        callObject.setOpnum(1);
+
+        callObject.addInParamAsInt(num, dcom.Flags.FLAG_NULL);
+
+        await this._comObj.call(callObject)
+         .catch(function(reject) {
+            throw reject;
+          });
+    }
+
+    /**
+     * 
+     * @returns {Promise<>}
+     * @opnum 2
+     */
+    async reset() {
+        debug("Reseting EnumString...");
+        if (!this._comObj) throw new Error("Not initialized");
+
+        let callObject = new dcom.CallBuilder(true);
+        callObject.setOpnum(2);
+
+        await this._comObj.call(callObject)
+            .catch(function(reject) {
+                throw reject;
+            });
+        debug("EnumString successfully reseted.");
+    }
+
+    // ------
+
+    /**
+     * @returns {Promise<string[]>}
+     */
+    async asArray(){
+        debug("Creating an Array for the current EnumString...");
+        await this.reset();
+        let part, res = [];
+        do {
+            part = await this.next(this._batchSize)
+                .catch(function(reject) {
+                    throw reject;
+                });
+            res.push(...part);
+        } while (part.length == this._batchSize);
+
+        debug("Array of EnumString itens sucessfully created.");
+        return res;
+    }
+}
+
+module.exports = EnumString;

package/src/filetime.js

@@ -0,0 +1,79 @@
+//@ts-check
+
+const {Struct} = require('node-dcom');
+const Long = require('long');
+
+class FileTime {
+
+    constructor(hi, lo){
+        this._hi = hi;
+        this._lo = lo;
+        this._date = null;
+    }
+
+    get hi(){
+        return this._hi;
+    }
+    get lo(){
+        return this._lo;
+    }
+    set hi(hi){
+        this._hi = hi;
+        this._date = null;
+    }
+    set lo(lo){
+        this._lo = lo;
+        this._date = null;
+    }
+
+    /**
+     * @returns {Date}
+     */
+    getDate() {
+        if (!this._date) this._computeDate();
+        return this._date;
+    }
+
+    _computeDate(){
+        let ulong = new Long(this._lo, this._hi, true).div(10000);
+        let epochBase = ulong.sub(11644473600000);
+
+        if (epochBase.greaterThan(ulong))
+            epochBase = epochBase.toSigned();
+        else 
+            epochBase = epochBase.toNumber();
+
+        this._date = new Date(epochBase);
+    }
+
+    toString(){
+        return `FileTime[${this._hi && this._lo ? this.getDate() : 'null'}]`;
+    }
+}
+
+/**
+ * @returns {Struct}
+ */
+function getStruct(){
+    let struct = new Struct();
+    struct.addMember(0); //lo
+    struct.addMember(0); //hi
+
+    return struct;
+}
+
+/**
+ * 
+ * @param {Struct} struct 
+ * @returns {FileTime}
+ */
+function fromStruct(struct){
+    let lo = struct.getMember(0).getValue();
+    let hi = struct.getMember(1).getValue();
+
+    return new FileTime(hi, lo);
+}
+
+module.exports = {
+    FileTime, getStruct, fromStruct
+}

package/src/index.js

@@ -0,0 +1,62 @@
+//@ts-check
+/*
+  Copyright: (c) 2019, Guilherme Francescon Cittolin <gfcittolin@gmail.com>
+  GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
+*/
+
+const constants = require('./constants');
+const OPCAsyncIO = require('./opcAsyncIO');
+const OPCBrowser = require('./opcBrowser');
+const OPCCommon = require('./opcCommon');
+const OPCGroupStateManager = require('./opcGroupStateManager');
+const OPCItemIO = require('./opcItemIO');
+const OPCItemManager = require('./opcItemManager');
+const OPCItemProperties = require('./opcItemProperties');
+const OPCServer = require('./opcServer');
+const OPCSyncIO = require('./opcSyncIO');
+const dcom = require('node-dcom');
+const EventEmitter = require('events').EventEmitter;
+const {ComServer, Session, Clsid} = dcom;
+
+/**
+ * 
+ * @param {String} address
+ * @param {String} domain 
+ * @param {String} user 
+ * @param {String} pass 
+ * @param {String} clsid 
+ * @param {object} [opts] 
+ * @returns {Promise<{comServer:ComServer, opcServer:OPCServer}>}
+ */
+async function createServer(address, domain, user, pass, clsid, opts) {
+  EventEmitter.call(this);
+  let session = new Session();
+  session = session.createSession(domain, user, pass);
+  session.setGlobalSocketTimeout(7000);
+
+  let comServer = new ComServer(new Clsid(clsid), address, session);
+  
+  await comServer.init();
+  console.log(`debug`);
+  let comObject = await comServer.createInstance();
+
+  let opcServer = new OPCServer(opts);
+  await opcServer.init(comObject);
+
+  return {comServer, opcServer};
+}
+
+module.exports = {
+  constants,
+  OPCAsyncIO,
+  OPCBrowser,
+  OPCCommon,
+  OPCGroupStateManager,
+  OPCItemIO,
+  OPCItemManager,
+  OPCItemProperties,
+  OPCServer,
+  OPCSyncIO,
+  dcom,
+  createServer
+}

package/src/opcAsyncIO.js

@@ -0,0 +1,102 @@
+//@ts-check
+/*
+  Copyright: (c) 2019, Guilherme Francescon Cittolin <gfcittolin@gmail.com>
+  GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
+*/
+
+const constants = require('./constants.js');
+
+/**
+ * Represents an OPC Sync IO Object
+ */
+class OPCAsyncIO {
+
+  constructor() {
+    this._comObj = null;
+  }
+
+  /**
+   *
+   * @param {*} unknown
+   * @returns {Promise<?>}
+   */
+  async init(unknown) {
+    if (this._comObj) throw new Error("Already initialized");
+
+    this._comObj = await unknown.queryInterface(constants.iid.IOPCAsyncIO2_IID);
+  }
+
+  async end() {
+    if (!this._comObj) return;
+
+    let obj = this._comObj;
+    this._comObj = null;
+    await obj.release();
+  }
+
+  /**
+   * 
+   * @param {number[]} handles array of server handles
+   * @returns {Promise<object>}
+   * @opNum 0
+   */
+  async read(handles) {
+    if (!this._comObj) throw new Error("Not initialized");
+
+    //should return auto generated transaction id and cancel id
+  }
+
+  /** ??? */
+  async write() {
+    if (!this._comObj) throw new Error("Not initialized");
+
+    throw new Error("Not Implemented");
+  }
+
+  /**
+   * 
+   * @param {number} transactionID 
+   * @param {number} source
+   * @returns {Promise<number>}
+   * @opNum 2
+   */
+  async refresh(transactionID, source) {
+    if (!this._comObj) throw new Error("Not initialized");
+
+  }
+
+  /**
+   * 
+   * @param {number} cancelID
+   * @returns {Promise<void>}
+   * @opNum 3
+   */
+  async cancel(cancelID) {
+    if (!this._comObj) throw new Error("Not initialized");
+
+  }
+
+  /**
+   * 
+   * @param {boolean} state
+   * @returns {Promise<void>}
+   * @opNum 4
+   */
+  async setEnable(state) {
+    if (!this._comObj) throw new Error("Not initialized");
+
+  }
+
+  /**
+   *
+   * @returns {Promise<boolean>}
+   * @opNum 5
+   */
+  async getEnable() {
+    if (!this._comObj) throw new Error("Not initialized");
+
+  }
+
+}
+
+module.exports = OPCAsyncIO;