Latest revision as of 05:15, 8 August 2023

Introduction

OPC Unified Architecture (OPC UA) is a machine to machine communication protocol for industrial automation developed by the OPC Foundation.

Features

EdgeSense OPC-UA Client aims to collect data from OPC-UA Server and control.

Feature:

Connection with multiple OPC-UA server and multiple Node ID.
Support anonymous authentication, username/password authentication.
Support individual node data update interval of subscription.
Configurable node alias.
Currently support up-link OPC-UA data to WISE-PaaS , not support down-link from WISE-PaaS.
Detailed features, please see https://docs.google.com/spreadsheets/d/1hxUJgHvcPYq8f44gmVVmwUCddHhOPBflSRkSKR0H9Q4/edit?ts=5ca2bfc9#gid=348272669

How to

Login

Step 1. Launch a web browser (Google Chrome, Microsoft Edge ...) and open iEdge local web http://127.0.0.1:8080

Step 2. Login iEdge local web:

Account: root

Password: P@ssw0rd

Config OPCUACLient Plugin

Please follow below steps to config OPCUAClient plugin to subscribe data from OPCUA Demo Server:

Step 1. Go to "Plug-ins" / Plugin Config to select OPCUAClient Plug-in

Setp 2. Click "+" to add OPCUA project

Setp 3. Edit new OPCUA Project

PROJECT NAME: Enter a project name in unique
ENDPOINT URL: Endpoint URL of OPCUA Server

SECURITY MODE: None / Sign
USER NAME: Account of OPCUA Server
PASSWORD: Password of OPCUA Server

Setp 4. Click "+" to add Sensor Node

Step 5. Edit Node Information

NODEID: Node ID you'd like to monitor
NODENAME: Node name you'd like to show
INTERVAL(SEC): Subscribe/update interval in seconds

Step 6. Click "+" to add multiple nodes

Step 7. Click on delete icon to remove sensor node or click on edit icon to modify sensor node

Step 8. Click "Save" to complete node editing.

Setp 9. Click "Apply" to set and apply the new setting

Setp 10. You can monitor OPCUA sensor nodes at "Plugin List".

How to import plugin settings

Step 1. Click Import button from OPCUAClient Configuration

Step 2. Select target file you like to import

Import successful

Step 3. Click APPLY to use imported configuration

How to export plugin settings

Step 1. Click Export button from OPCUAClient Configuration

Step 2. Explore the exported file

How to use RESTful API to get history data

Example:

http://172.22.12.84:8080//rmm/v1/data/devices/histdata?plugin=OPCUAClient&sensorId=/OPCUA-01/Node/Temperature&beginTs=2022-01-21%2017:30:00.000&endTs=2022-01-21%2017:35:00.000

Appendix

Install OPCUA Demo Server

Please follow below steps to setup OPCUA Demo Server:

1. Download Unified Automation C++ Demo Server from https://www.unified-automation.com/downloads/opc-ua-servers.html and install it to the server machine.

2. Launch UaCppServer from Windows Start Menu.

3. Information of OPCUA Demo Server, include Username/Password, Endpoint URL and Node IDs are shown in below.

Username	Password
root	secret

Endpoint URL Format	opc.tcp://<Mancine Name or IP>:<Port>
Endpoint URL for this Demo	opc.tcp://Protocol-Converter-GW:48010

Node Nmae	Node ID
AirConditioner_1.Humidity	ns=3;s=AirConditioner_1.Humidity
AirConditioner_1.Temperature	ns=3;s=AirConditioner_1.Temperature
AirConditioner_2.Humidity	ns=3;s=AirConditioner_2.Humidity
AirConditioner_2.Temperature	ns=3;s=AirConditioner_2.Temperature

Difference between revisions of "OPC-UA Client"

Latest revision as of 05:15, 8 August 2023

Contents

Introduction

Features

How to

Login

Config OPCUACLient Plugin

How to import plugin settings

How to export plugin settings

How to use RESTful API to get history data

Appendix

Install OPCUA Demo Server

Navigation menu

Personal tools

Namespaces

Variants

Views

More

Search

Navigation

Tools

@@ Line 1: / Line 1: @@
 = Introduction =
 OPC Unified Architecture (OPC UA) is a machine to machine communication protocol for industrial automation developed by the OPC Foundation.
+&nbsp;
 = Features =
@@ Line 11: / Line 12: @@
 Feature:
-*Manage multi OPC-UA server&nbsp;and multi NodeID
+*Connection with multiple&nbsp;OPC-UA server&nbsp;and multiple Node ID.
 *Support anonymous authentication, username/password authentication.
-*Currently support up-link OPC-UA data&nbsp;to WISE-PaaS , not support down-link from WISE-PaaS.
+*Support individual node data update interval of subscription.
-*Detailed features, please see&nbsp;[https://docs.google.com/spreadsheets/d/1hxUJgHvcPYq8f44gmVVmwUCddHhOPBflSRkSKR0H9Q4/edit?ts=5ca2bfc9#gid=348272669 https://docs.google.com/spreadsheets/d/1hxUJgHvcPYq8f44gmVVmwUCddHhOPBflSRkSKR0H9Q4/edit?ts=5ca2bfc9#gid=348272669]
+*Configurable node alias.
+*Currently support up-link OPC-UA data&nbsp;to WISE-PaaS , not support down-link from WISE-PaaS.
+*Detailed features, please see&nbsp;[https://docs.google.com/spreadsheets/d/1hxUJgHvcPYq8f44gmVVmwUCddHhOPBflSRkSKR0H9Q4/edit?ts=5ca2bfc9#gid=348272669 https://docs.google.com/spreadsheets/d/1hxUJgHvcPYq8f44gmVVmwUCddHhOPBflSRkSKR0H9Q4/edit?ts=5ca2bfc9#gid=348272669]
+&nbsp;
+= How to =
+== Login ==
+Step 1. Launch a web browser (Google Chrome, Microsoft Edge ...) and open iEdge local web '''http://127.0.0.1:8080'''
+Step 2. Login iEdge local web:
+Account: '''root'''
+Password: '''P@ssw0rd'''
+[[File:Ros2-iedge-plugin-config-01.png|frameless|900x520px|Ros2-iedge-plugin-config-01.png]]
+&nbsp;
+== Config OPCUACLient Plugin ==
+Please follow below steps to config OPCUAClient plugin to subscribe data from OPCUA Demo Server:
+Step 1. Go to "Plug-ins" / Plugin Config to select OPCUAClient Plug-in
+[[File:Opcua config UtQlI7p.png|border|800x480px|Opcua config UtQlI7p.png]]
+Setp 2. Click "+" to add OPCUA project
+[[File:Opcua config uNA2oIS.png|border|800x480px|Opcua config uNA2oIS.png]]
+Setp 3. Edit new OPCUA Project
+'''PROJECT NAME''': Enter a project name in unique<br/>
+'''ENDPOINT URL''': Endpoint URL of OPCUA Server<br/>
+[[File:Opcua config 4nAWV6Z.png|border|800x480px|Opcua config 4nAWV6Z.png]]
+'''SECURITY MODE''': None / Sign<br/>
+'''USER NAME''': Account of OPCUA Server<br/>
+'''PASSWORD''': Password of OPCUA Server<br/>
+[[File:Opcua config N19A761.png|border|800x480px|Opcua config N19A761.png]]
+Setp 4. Click "+" to add Sensor Node
+[[File:Opcua config bgenwaL.png|border|800x480px|Opcua config bgenwaL.png]]
+Step 5. Edit Node Information
+'''NODEID''': Node ID you'd like to monitor<br/>
+'''NODENAME''': Node name you'd like to show<br/>
+'''INTERVAL(SEC)''': Subscribe/update interval in seconds<br/>
+[[File:Opcua config UeyMgDP.png|border|800x480px|Opcua config UeyMgDP.png]]
+Step 6. Click "+" to add multiple nodes
+[[File:Opcua config BlLUlTV.png|border|800x480px|Opcua config BlLUlTV.png]]
+Step 7. Click on delete icon to remove sensor node or click on edit icon to modify sensor node
+[[File:Opcua config jDMeU3E.png|border|800x480px|Opcua config jDMeU3E.png]]
-= How to =
-== Software Requirements ==
+Step 8. Click "Save" to complete node editing.
+[[File:Opcua config qYQ76Qq.png|border|800x480px|Opcua config qYQ76Qq.png]]
+Setp 9. Click "Apply" to set and apply the new setting
+[[File:Opcua config 4A88VkH.png|border|800x480px|Opcua config 4A88VkH.png]]
-*MQTT broker
-*Node.js
-*.NET Framework 3.5 or above
-== Installation ==
+Setp 10. You can monitor OPCUA sensor nodes at "Plugin List".
-'''Windows:'''
+[[File:Opcua config 9TEBrJF.png|border|800x480px|Opcua config 9TEBrJF.png]]
-. Download OPC-UA Client&nbsp;for Windows from [http://ess-wiki.advantech.com.tw/view/OPC-UA_Client#Release Release] Table.
+<br/><br/>
-. Double click the&nbsp;installer to launch the installer to install it to the machine.
+==== How to import plugin settings ====
-'''Linux:'''
+Step 1. Click Import button from OPCUAClient Configuration
-. Download OPC-UA Client&nbsp;for Linux&nbsp;from Release Table.
+[[File:Opcua config YngfFAe.png|border|800x480px|Opcua config YngfFAe.png]]
-. Launch the installer to install it to the machine.
-== Configuration ==
+Step 2. Select target file you like to import
-EdgeSense OPC-UA client can manage multi OPC-UA setting and multi NodeID, below settings are default after OPC-UA client installation.
+[[File:Opcua config 4M3dBVW.png|border|800x480px|Opcua config 4M3dBVW.png]]
+Import successful
-<pre>{
+[[File:Opcua config V5bZgSz.png|border|800x480px|Opcua config V5bZgSz.png]]
-&nbsp; &nbsp; "OPCUA_Server":[
-&nbsp; &nbsp; &nbsp; &nbsp; {
-&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "Name": "opcua-server-1",
-&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "endpointUrl":"opc.tcp://opcua-server-1:66666",
-&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "userIdentity": {
-&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "userName": "admin",
-&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "password": ""
-&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; }, &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
-&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "NodeIDList":[{"NodeId":"node-id-1","Name":"node-name-1", "Type":"v", "Interval":2},
-&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {"NodeId":"node-id-2","Name":"node-name-2", "Type":"v", "Interval":2},
-&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {"NodeId":"node-id-3","Name":"node-name-3", "Type":"v", "Interval":2}
-&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; ]
-&nbsp; &nbsp; &nbsp; &nbsp; },
-&nbsp; &nbsp; &nbsp; &nbsp; {
-&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "Name": "opcua-server-2",
-&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "endpointUrl":"opc.tcp://opcua-server-2:66666",
-&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "userIdentity": {
-&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "userName": "admin",
-&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "password": ""
-&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; }, &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
-&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "NodeIDList":[{"NodeId":"node-id-4","Name":"node-name-4", "Type":"v", "Interval":2},
-&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {"NodeId":"node-id-5","Name":"node-name-5", "Type":"v", "Interval":2},
-&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {"NodeId":"node-id-6","Name":"node-name-6", "Type":"v", "Interval":2}
-&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; ]
-&nbsp; &nbsp; &nbsp; &nbsp; }
+Step 3. Click APPLY to use imported configuration
-&nbsp; &nbsp; ]
-}
-</pre>
+[[File:Opcua config R6EsxAJ.png|border|800x480px|Opcua config R6EsxAJ.png]]
+<br/><br/>
-Name
-*Assign name for OPC-UA server.
-endpointUrl
+==== How to export plugin settings ====
-*Assign OPC-UA Server Endpoint URL ,&nbsp;format is opc:tcp://hostname:Port/&nbsp; , hostname also can use ip address.
+Step 1. Click Export button from OPCUAClient Configuration
-userIdentity
+[[File:Opcua config cy8mrSR.png|border|800x480px|Opcua config cy8mrSR.png]]
-*Assign username and password for&nbsp;OPC-UA server security check.
-NodeIDList
+Step 2. Explore the exported file
-*NodeId: Assign node ID you'd&nbsp;like to monitor.
+[[File:Opcua config D1OvcOS.png|border|800x480px|Opcua config D1OvcOS.png]]
-*Name: Assign node name&nbsp;you'd&nbsp;like to show for the node.
-*Type: Assign node type: "v" is Number, "bv" is Boolean, "sv" is String.
+==== How to use RESTful API to get history data ====
-{| border="1" cellspacing="1" cellpadding="1" style="width: 156px;"
+<br/>
-|-
-| style="width: 51px; text-align: center;" | v
-| style="width: 93px; text-align: center;" | Number
-|-
-| style="width: 51px; text-align: center;" | bv
-| style="width: 93px; text-align: center;" | Boolean
-|-
-| style="width: 51px; text-align: center;" | sv
-| style="width: 93px; text-align: center;" | String
-|}
+Example:
+<code>[http://172.22.12.84:8080//rmm/v1/data/devices/histdata?plugin=OPCUAClient&sensorId=/OPCUA-01/Node/Temperature&beginTs=2022-01-21%2017:30:00.000&endTs=2022-01-21%2017:35:00.000 http://172.22.12.84:8080//rmm/v1/data/devices/histdata?plugin=OPCUAClient&sensorId=/OPCUA-01/Node/Temperature&beginTs=2022-01-21%2017:30:00.000&endTs=2022-01-21%2017:35:00.000] </code>
-*Interval: Assign node data subscribe/update interval in seconds.
+[[File:Opcua config fqD2QRq.png|border|800x480px]]
+<br/><br/>
+= Appendix =
-= Demonstration =
+== Install OPCUA Demo Server ==
-== Connect a Unified Automation C++ Demo Server ==
+Please follow below steps to setup OPCUA Demo Server:
 . Download Unified Automation C++ Demo Server from&nbsp;[https://www.unified-automation.com/downloads/opc-ua-servers.html https://www.unified-automation.com/downloads/opc-ua-servers.html]&nbsp;and install it to the server machine.
 . Launch UaCppServer from Windows Start&nbsp;Menu.
+[[File:Opcua config POK0jrK.png|border|800x480px|Opcua config POK0jrK.png]]
 [[File:Uacpp-demo-server-01.png|800x480px|Uacpp-demo-server-01.png]]
+. Information of OPCUA Demo Server, include Username/Password, Endpoint URL and Node IDs are shown in below.
-. Config OPC-UA Client to connect to the Unified Automation C++ Demo Server, Username/Password, Endpoint URL and Node IDs are shown in below.
-{| border="1" cellspacing="1" cellpadding="1" style="width:500px;"
+{| border="1" cellpadding="1" cellspacing="1" style="width:500px;"
 |-
 | style="width: 220px;" | '''Username'''
@@ Line 148: / Line 186: @@
-{| border="1" cellspacing="1" cellpadding="1" style="width:500px;"
+{| border="1" cellpadding="1" cellspacing="1" style="width:500px;"
 |-
 | style="width: 217px;" | '''Endpoint URL Format'''
-| style="width: 270px;" | opc.tcp://&lt;Mancine Name or IP&gt;:&lt;Port&gt;
+| style="width: 270px;" | opc.tcp://<Mancine Name or IP>:<Port>
 |-
-| style="width: 217px;" | '''Endpoint URL for this Demo'''<br/>
+| style="width: 217px;" | '''Endpoint URL for this Demo'''
-| style="width: 270px;" | opc.tcp://Protocol-Converter-GW:48010<br/>
+| style="width: 270px;" | opc.tcp://Protocol-Converter-GW:48010
 |}
-{| border="1" cellspacing="1" cellpadding="1" style="width:500px;"
+{| border="1" cellpadding="1" cellspacing="1" style="width:500px;"
 |-
 | style="width: 217px;" | '''Node Nmae'''
 | style="width: 270px;" | '''Node ID'''
 |-
-| style="width: 217px;" | AirConditioner_1.Humidity<br/>
+| style="width: 217px;" | AirConditioner_1.Humidity
-| style="width: 270px;" | ns=3;s=AirConditioner_1.Humidity<br/>
+| style="width: 270px;" | ns=3;s=AirConditioner_1.Humidity
-|-
-| style="width: 217px;" | AirConditioner_1.Temperature<br/>
-| style="width: 270px;" | ns=3;s=AirConditioner_1.Temperature<br/>
-|-
-| style="width: 217px;" | AirConditioner_2.Humidity<br/>
-| style="width: 270px;" | ns=3;s=AirConditioner_2.Humidity<br/>
 |-
-| style="width: 217px;" | AirConditioner_2.Temperature<br/>
+| style="width: 217px;" | AirConditioner_1.Temperature
-| style="width: 270px;" | ns=3;s=AirConditioner_2.Temperature<br/>
+| style="width: 270px;" | ns=3;s=AirConditioner_1.Temperature
-|}
-. Edit opcua-client.json to set up client configuration, for&nbsp;example:
-<pre>{
-    "OPCUA_Server":[
-        {
-            "Name": "OPCUA-UACPP-SERVER",
-            "endpointUrl":"opc.tcp://Protocol-Converter-GW:48010",
-            "userIdentity": {
-                "userName": "root",
-                "password": "secret"
-            },
-            "NodeIDList":[{"NodeId":"ns=3;s=AirConditioner_1.Humidity","Name":"AirConditioner_1.Humidity", "Type":"v", "Interval":2},
-                          {"NodeId":"ns=3;s=AirConditioner_1.Temperature","Name":"AirConditioner_1.Temperature", "Type":"v", "Interval":2},
-                          {"NodeId":"ns=3;s=AirConditioner_2.Humidity","Name":"AirConditioner_2.Humidity", "Type":"v", "Interval":2},
-                          {"NodeId":"ns=3;s=AirConditioner_2.Temperature","Name":"AirConditioner_2.Temperature", "Type":"v", "Interval":2}
-                        ]
-        }
-    ]
-}
-</pre>
-. Restart device-opcua-client service from Windows Task Manager.
-<br/>
-= Release =
-<span style="font-size:larger;">This is an overview that displays Modbus Service&nbsp;versions and some stats and numbers for each release.</span>
-{| border="1" cellspacing="1" cellpadding="1" style="width: 1030px;"
 |-
-| style="width: 47px; text-align: center;" | <span style="font-size:larger;">Index</span>
+| style="width: 217px;" | AirConditioner_2.Humidity
-| style="width: 63px; text-align: center;" | <span style="font-size:larger;">Version</span>
+| style="width: 270px;" | ns=3;s=AirConditioner_2.Humidity
-| style="width: 85px; text-align: center;" | <span style="font-size:larger;">Date</span>
-| style="width: 78px; text-align: center;" | <span style="font-size:larger;">Platform</span>
-| style="width: 109px; text-align: center;" | <span style="font-size:larger;">OS</span>
-| style="width: 353px; text-align: center;" | <span style="font-size:larger;">Release Note</span>
-| style="width: 259px; text-align: center;" | <span style="font-size:larger;">Installer</span>
 |-
-| style="width: 47px; text-align: center;" | <span style="font-size:larger;">1</span>
+| style="width: 217px;" | AirConditioner_2.Temperature
-| style="width: 63px; text-align: center;" | <span style="font-size:larger;">v2.0.1</span>
+| style="width: 270px;" | ns=3;s=AirConditioner_2.Temperature
-| style="width: 85px; text-align: center;" |
-<span style="font-size:medium;">2020/1/03</span>
-| style="width: 78px; text-align: center;" | <span style="font-size:larger;">x86_64 CPU</span><br/>
-| style="width: 109px; text-align: center;" | <span style="font-size:larger;">Windows</span><br/>
-| style="width: 353px; text-align: center;" |
-Support Multiple OPCUA server.&lt;/span&gt;
-Support Anonymous, Username/Password&lt;/span&gt;<span style="font-size:medium;">security check.</span>
-Support individual node access interval configuration.&lt;/span&gt;
-Configurable node alias.&lt;/span&gt;
-<span style="font-size:larger;">[file://eossfs/ESS-Release/EdgeSense/Release/Windows/OPCUA_Client/OPCUA_Client OPCUA_Client_ReleaseNote_2.0.1.txt]</span>
-| style="width: 259px; text-align: center;" | <span style="font-size:larger;">[file://eossfs/ESS-Release/EdgeSense/Release/Windows/OPCUA_Client/OPCUA_Client device-opcua-client-2.0.1.exe]</span>
 |}
-<span style="font-size:larger;">Above files are available at local server, please paste file's&nbsp;url in File Explorer&nbsp;to copy file. ([[EdgeSense_FAQ|How to access to EOSSFS file server]]&nbsp;)</span>
-[[Category:Editor]]