@opcua/for-node-red 2.1.1 → 2.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/DOC.md +3 -3
  2. package/EXAMPLES.md +29 -0
  3. package/README.md +29 -19
  4. package/package.json +2 -2
package/DOC.md CHANGED
@@ -7,14 +7,14 @@
7
7
 
8
8
  ![node palette](./resources/endpoint-edition.png)
9
9
 
10
- > the `check connection` button allows you to immediatly test your connection parameters and provide useful feedback to help you fix commonly found issues.
10
+ > the `check connection` button allows you to immediately test your connection parameters and provide useful feedback to help you fix commonly found issues.
11
11
 
12
12
  ![subscriptions](./resources/endpoint-subscriptions.png)
13
13
  Three default subscriptions are automatically created for you:
14
- Default (1 seconde), Fast (500ms) and Slow(5 secondes). They provide differents publishing intervals for the most common scenarii we usually find in typical IIoT applications. You can customize the parameter or delete or add new subscriptions if you wish.
14
+ Default (1 seconde), Fast (500ms) and Slow(5 secondes). They provide different publishing intervals for the most common scenarios we usually find in typical IIoT applications. You can customize the parameter or delete or add new subscriptions if you wish.
15
15
  Most of the time, only a few subscriptions are needed.
16
16
 
17
- Note: The default subscription cannot be deleted, it serves as a mechanism to keep the connection always active with the server by handligng a keepalive packet, and serves as well in the automatic reconnection mechanism, in case of a network outage.
17
+ Note: The default subscription cannot be deleted, it serves as a mechanism to keep the connection always active with the server by handling a keepalive packet, and serves as well in the automatic reconnection mechanism, in case of a network outage.
18
18
 
19
19
 
20
20
  ## setting up custom certificate
package/EXAMPLES.md ADDED
@@ -0,0 +1,29 @@
1
+ ## Examples
2
+
3
+ ### Read a variable
4
+
5
+ ![Read][def1]
6
+
7
+ ### Specifying an endpoint connection
8
+
9
+ ![Endpoint][def2]
10
+
11
+
12
+ ## Monitoring a variable
13
+
14
+ ![Monitor][def3]
15
+
16
+
17
+ ## browsing the OPCUA server address space
18
+
19
+ ![Browse][def4]
20
+
21
+
22
+
23
+
24
+
25
+ [def1]: ./resources/opcu-client2-read.png "Read"
26
+ [def2]: ./resources/endpoint-edition.png "Endpoint"
27
+ [def3]: ./resources/opcua-client2-monitor.png "Monitor"
28
+ [def4]: ./resources/opcua-client2-browse-to-select-node.png "Browse"
29
+
package/README.md CHANGED
@@ -1,42 +1,52 @@
1
1
  @opcua/for-node-red (Preview Version)
2
2
 
3
- :rotating_light: this product is currently provided as beta version.
3
+ __this product is currently provided as a beta version.__
4
4
 
5
5
 
6
- This node is the second next generation OPCUA Node for NodeRED build by Sterfive, the company that develops the [NodeOPCUA](https://node-opcua.github.io/) stack.
6
+ This node is the second next-generation OPCUA Node for NodeRED built by Sterfive, the company that develops the [NodeOPCUA](https://node-opcua.github.io/) stack.
7
7
 
8
- Ir brings the following OPCUA Client features
9
- - Read
10
- - Write
11
- - Browse
12
- - Monitor
13
- - Call
8
+ Ir brings the following OPCUA Client features.
9
+ - **Read** - read one or more UAVariables.
10
+ - **Write** - write one or more UAVariables.
11
+ - **Browse** - browse a UANode for references and child nodes.
12
+ - **Monitor** - monitor a UAVariable for changes.
13
+ - **MonitorEvents** - monitor a UAObject for events.
14
+ - **Call** - call a method passing input arguments and getting output arguments.
15
+ - **Explore** - explore the OPCUA server address space subtree and get information about nodes and references as JSON structure.
16
+
14
17
 
15
- The community edition works with one connection to one OPCUA server and can hanldes up to 100 simulatenous operation per nodes.
18
+ The community edition works with one connection to one OPCUA server and can handle up to 100 simultaneous operations per node.
16
19
 
17
- The professional edition works with multiple connections to multiple OPCUA servers and have no limitation on the number of simultaneous operations per nodes, exxcept the one imposed by the OPCUA server itself.
20
+ The professional edition works with multiple connections to multiple OPCUA servers and has no limitation on the number of simultaneous operations per node, except the one imposed by the OPCUA server itself.
18
21
 
19
22
  It has been designed with the following goals in mind:
20
23
 
21
24
  - easy to use, easy to configure; no deep OPCUA knowledge required.
22
- - provide visual tools to pick up nodeId by browsing the OPCUA server
25
+ - provide visual tools to pick up nodeId by browsing the OPCUA server.
23
26
  - handle nodes address with either nodeId or browse path, or both.
24
- - works well with complex OPCUA servers, exposing complex data structures (extension objects)
25
- - arbitraty number of node sharing the same connection
27
+ - works well with complex OPCUA servers, exposing complex data structures (extension objects).
28
+ - arbitrary number of nodes sharing the same connection
26
29
  - support for multiple connections to multiple OPCUA servers.
27
- - handles automatically transactions optimisation by grouping or splitting operations based on actual OPCUA server capabilities.
28
- - handles automatically reconnections in case of network failure, in a way that works
29
- - do not consume Client session unexpectedly on the OPCUA server side.
30
- - handles automatically OPCUA server certificate management
30
+ - automatically handle transaction optimization by grouping or splitting operations based on actual OPCUA server capabilities.
31
+ - automatically handle reconnections in case of network failure, in a way that works.
32
+ - use Client sessions sparingly on the OPCUA server side.
33
+ - handle automatically OPCUA server certificate management.
34
+ - explore and monitor complex UAObject structures in the address space with ease.
31
35
 
32
36
  ## Getting Started
33
37
 
34
- To install the node execute the following command inside the `.node-red`` directory:
38
+ The easiest way to install the nodes is to use the Manage palette option in the Node-RED editor menu. In the Install tab, you can search for the @opcua/for-node-red package and click `install`. Once the installation is complete the nodes are available.
39
+
40
+ Alternatively, you can install the nodes in your `Node-RED` configuration folder inside the `.node-red`` directory:
35
41
 
36
42
  ```console
43
+ cd ~/.node-red
37
44
  npm install @opcua/for-node-red
38
45
  ```
39
46
 
47
+ The nodes will be available after a restart of the Node-RED application.
48
+
49
+
40
50
  ### how to use
41
51
 
42
52
  see the [documentation](./DOC.md) guide for more information
@@ -50,5 +60,5 @@ see the [documentation](./DOC.md) guide for more information
50
60
 
51
61
  ## Copyright and Licence
52
62
 
53
- Copyrigth (c) Sterfive SAS 2017-2023, under [proprietary licence](./LICENSE.md).
63
+ Copyright (c) Sterfive SAS 2017-2023, under [proprietary licence](./LICENSE.md).
54
64
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@opcua/for-node-red",
3
- "version": "2.1.1",
3
+ "version": "2.1.3",
4
4
  "description": "The Node-RED node to communicate via OPC UA, powered NodeOPCUA and developed by Sterfive's team",
5
5
  "repository": {
6
6
  "type": "git",
@@ -42,7 +42,7 @@
42
42
  }
43
43
  },
44
44
  "dependencies": {
45
- "node-opcua": "2.116.0",
45
+ "node-opcua": "2.118.0",
46
46
  "node-opcua-json": "0.50.0",
47
47
  "antlr4ts": "0.5.0-alpha.4",
48
48
  "body-parser": "^1.20.2",