🖥
🖥
🖥
🖥
AugeLab Studio Manual
English
Ask or search…
K
Comment on page

OPC UA Client

OPC UA Client Documentation

The OPC UA Client node in AugeLab Studio enables communication with OPC UA servers. OPC UA (Open Platform Communications Unified Architecture) is a standardized communication protocol for industrial automation and IoT applications.

Node Overview

The OPC UA Client node serves as a client to connect to an OPC UA server and interact with its data and services.

Node Properties

  • Node Title: OPC UA Client
  • Node ID: OP_NODE_OPC_UA_CLIENT

Inputs

The OPC UA Client node has one input socket:
  1. 1.
    UaClient: Connect the output of another OPC UA client node or pass the UaClient object obtained from the OPC UA Server node.

Outputs

The OPC UA Client node has one output socket:
  1. 1.
    Value: Provides the UaClient object representing the OPC UA client connection.

Node Configuration

The OPC UA Client node requires configuration to establish a connection with an OPC UA server. The configuration is done through the following node widgets:
  • Server Address: Enter the address, including credentials if required, of the OPC UA server in the format Address:[email protected]:PortNumber.
  • View Nodes-IDs Button: Click this button to open a window that displays the available nodes and their IDs on the connected OPC UA server.
  • Connect Button: Click this button to connect to the OPC UA server using the provided server address.
  • Disconnect Button: Click this button to disconnect from the OPC UA server.

Usage

  1. 1.
    Drag and drop the OPC UA Client node from the node library onto the canvas in AugeLab Studio.
  2. 2.
    Connect the UaClient output from another OPC UA client node or from the OPC UA Server node to the "UaClient" input socket of the OPC UA Client node. Alternatively, you can directly configure the server address using the node widgets.
  3. 3.
    Configure the server address by entering the server details in the "Server Address" widget.
  4. 4.
    (Optional) Click the "View Nodes-IDs" button to explore the available nodes on the connected OPC UA server.
  5. 5.
    Click the "Connect" button to establish a connection with the OPC UA server.
  6. 6.
    If the connection is successful, the UaClient object representing the connection will be available at the output socket.
  7. 7.
    Use the UaClient object in downstream nodes to access data or services provided by the OPC UA server.
  8. 8.
    To disconnect from the OPC UA server, click the "Disconnect" button.

Example

Let's walk through an example to illustrate how to use the OPC UA Client node:
  1. 1.
    Drag and drop the OPC UA Client node onto the canvas.
  2. 2.
    Connect the UaClient output from another OPC UA client node or from the OPC UA Server node to the "UaClient" input socket of the OPC UA Client node. Alternatively, you can directly configure the server address using the node widgets.
  3. 3.
    Configure the server address by entering the server details in the "Server Address" widget.
  4. 4.
    (Optional) Click the "View Nodes-IDs" button to explore the available nodes on the connected OPC UA server.
  5. 5.
    Click the "Connect" button to establish a connection with the OPC UA server.
  6. 6.
    If the connection is successful, the UaClient object representing the connection will be available at the output socket.
  7. 7.
    Use the UaClient object in downstream nodes to access data or services provided by the OPC UA server.
  8. 8.
    To disconnect from the OPC UA server, click the "Disconnect" button.

Notes

  • The OPC UA Client node uses the underlying implementation provided by the UaClient class in the studio.view.libs.opcuaclientgui.uaclient.uaclient module.
  • The node provides a user interface to configure the server address and interact with the OPC UA server.
  • The OPC UA Client node connects to the OPC UA server when the "Connect" button is clicked and disconnects when the "Disconnect" button is clicked.
  • The UaClient object obtained from the OPC UA Client node can be passed to other OPC UA nodes in the pipeline for further data retrieval or interaction with the server.
That concludes the documentation for the OPC UA Client node in AugeLab Studio. This node enables seamless integration with OPC UA servers, allowing access to data and services in industrial automation and IoT applications.