@tier0/node-opc-da 1.0.7

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,171 @@
+# opc-da
+
+This library implements the OPC-DA specifications and allows to communicate with OPC Servers, relying on the [node-dcom](https://github.com/netsmarttech/node-dcom) library for DCOM/DCE-RPC for protocol implementation. Currently this lib support browsing calls and synchronous reads. The code overall strucuture was heavly based on [Utgard](https://en.wikipedia.org/wiki/Utgard_(software)).
+
+This node was created by [Smart-Tech](https://netsmarttech.com) as part of the [ST-One](https://netsmarttech.com/page/st-one) project.
+
+## Table of Contents
+- [Install](#install)
+- [Usage](#usage)
+  - [OPC Server](#opc-server)
+    - [Creating a Server](#creating-a-server)
+    - [Deleting  a Server](#deleting-a-server)
+  - [OPC Browse](#opc-browser)
+    - [Flat browsing](#flat-browsing)
+    - [Tree browsing](#tree-browsing)
+  - [OPC Groups](#opc-groups)
+    - [Creating a Group](#creating-a-group)
+    - [Removing a Group](#removing-a-group)
+  - [OPC Items](#opc-items)
+    - [Adding an Item](#adding-an-item)
+    - [Validating an Item](#validating-an-item)
+  - [Reading with OPC Sync](#reading-with-opc-sync)
+- [Disclaimer](#disclaimer)
+- [Contributing](#contributing)
+
+## Install
+
+Using npm:
+
+```bash
+npm install node-opc-da
+```
+
+## Usage
+
+### OPC Server
+
+An OPC server is on object you will be using as the basis for every operation and object instantiation to communicate with a remote OPC server. Since OPC-DA relies on COM/DCOM for all it's features, to create a basic OPC Server object we'll need to create a few COM objects first.
+
+#### Creating a Server
+
+```javascript
+// creates a COM Session from a domain, an username, and a password
+let comSession = new Session();
+comSession = comSession.createSession(domain, username, password);
+
+// sets a global timeout for connections related to this session
+comSession.setGlobalSocketTimeout(timeout);
+
+// create a COM Server from a classid, an IP address and the previously created session
+let comServer = new ComServer(clsid, address, comSession);
+
+// star the COM Server
+await comServer.init();
+
+/* from the COM Server, we create a instance we'll use to create every other COM related object */
+let comObject = await comServer.createInstance();
+
+// with the comObjet created, we create an OPC Server object and call init()
+let opcServer = new OPCServer();
+await opcServer.init(comObject);
+```
+
+#### Removing a Server
+
+To remove an OPC Server reference we call the ```end()``` function. This call only release objects created from the server object (opcBrowser, opcItemManager, opcGroupStateManager) and the server object itself. See the ```node-dcom``` library for more information on how to remove a COM session and server.
+
+```javascript
+opcServer.end()
+```
+
+### OPC Browse
+
+Browsing function are used to explore the items stored in the server. OPC-DA offers mainly two types of browsing: flat browsing and tree browsing. Flat Browsing returns a flat list of all server items, ignoring any internal directory tree. Tree Browsing, walks throughout the internal directory tree and returns a list of directories, each containing a list of items.
+
+#### Flat browsing
+
+```Javascript
+let opcBrowser = await opcServer.getBrowser();
+let items = await opcBrowser.browseAllFlat();
+```
+
+#### Tree browsing
+
+```Javascript
+let opcBrowser = await opcServer.getBrowser();
+let items = await opcBrowser.browseAllTree();
+```
+
+### OPC Groups
+
+After an OPC Server is created, if you want to read one or more items you must first create a group. To achieve this we call the function ```addGroup``` giving a group name and a list of options as parameters.
+
+#### Creating a Group
+
+```Javascript
+/* opts {
+ * {Boolean} [active]
+ * {Number} [updateRate]
+ * {Number} [clientHandle]
+ * {Number} [timeBias]
+ * {Number} [deadband] - until asyn read is implemented this does nothing
+ * {Number} [localeID]
+ * }
+ */
+let opcGroup = await opcServer.addGroup(name, opts)
+```
+
+#### Removing a Group
+
+To remove a group from an opcServer we call the function ```removeGroup``` giving the group handle as paremeter, and a ```boolean``` value to indicate if the server must wait any ongoing operation to end before being removed or not.
+
+```Javascript
+/* {Number} [handle]
+ * {Boolean} [force]
+ */
+opcServer.removeGroup(groupHandle, force);
+```
+
+### OPC Items
+
+#### Adding an Item
+
+```javascript
+// create a item manager from the group object
+let opcItemManager = await opcGroup.getItemManager();
+
+/* item {
+ * {String} [itemID] - the name of the item on the server, can be obtained through browser
+ * {Number} [clientHandle] - a locally generated number to identify this item
+ * }
+ * calls the add() function passing one or more item objects as parameter
+ */
+opcItemManager.add(item | itemList);
+```
+
+#### Validating an Item
+
+```javascript
+/* item {
+ * {String} [itemID] - the name of the item on the server, can be obtained through browser
+ * {Number} [clientHandle] - a locally generated number to identify this item
+ * }
+ */
+opcItemManager.validate(item | itemList);
+```
+
+### Reading with OPC Sync
+
+```javascript
+// create a reading object for the group
+let opcSyncIO = await opcGroup.getSyncIO();
+
+/* {Number} [dataSource] - from where it will be read
+ * {Number} [serverHandles] - one or more handles. An item handle is obtained by calling 
+ * the add() function, which returns an array of properties for each item readed.
+*/
+await opcSyncIO.read(dataSource, serverHandles);
+```
+
+## Disclaimer
+
+**This is a work in progress.** Expect things to break, crash and burn. We cannot be hold liable for any damage to any equipment or issues directly or indirectly caused by this library. You've been warned.
+
+## Contributing
+
+This is a partial implementation and there are lots that could be done to improve what is already supported or to add support for more OPC-DA features. Feel free to dive in! Open an issue or submit PRs.
+
+
+## License
+Copyright 2017 Smart-Tech, [Apache 2.0 license](LICENSE).