> For the complete documentation index, see [llms.txt](https://www.opal-rt.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.opal-rt.com/docs/hypersim/configure-ios/communication-protocol-ios/opc-ua-da/configure-opc-ua-server.md).

# Configure OPC UA Server

When working with communication protocols, it is recommended to begin by configuring the protocol through the **I/O Interfaces** section in <code class="expression">space.vars.Software</code> before proceeding with other steps.

## Configure the OPC UA server I/O interface

{% stepper %}
{% step %}

### Add a new I/O interface

1. In the **HYPERSIM** tab, click **I/O Interface** in the **Sensors & I/Os** section to open the **I/O Interface Configuration** window.

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-881ca3164b1b5fa2d589ecb145163b15e7af8f64%2FDR-hyp-io-interface.png?alt=media" alt=""><figcaption></figcaption></figure>

2. Right‑click **OPC UA Server** and select **Add**. Keep the default name or enter a custom one. If multiple **OPC UA Server** are added, each one must have a unique name.

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-080032443fffe038952c83239893eacf78f85283%2FDR-hyp-opcua-add.png?alt=media" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### Configure the general settings

Click the newly added **OPC UA Server** in the **I/O Interface Configuration** window and configure the general settings.

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-448d59a983a2a5934d4fdd52707d1686962c06ec%2FDR-hyp-opcua-gen.png?alt=media" alt=""><figcaption></figcaption></figure>

<table><thead><tr><th width="165">Parameter</th><th>Value (Description)</th></tr></thead><tbody><tr><td><strong>Network interface</strong></td><td>Network interface name. Select the correct interface based on your <strong>System Description Document</strong> or Linux <code>ifconfig</code> command.</td></tr><tr><td><strong>IP address</strong></td><td>IP address assigned to the OPC UA Server. This address is used by OPC UA clients to establish a network connection to the server. Can be set to <strong>any</strong> to select the first available IP on the simulator.</td></tr><tr><td><strong>Use an RT core for asynchronous computation</strong></td><td><strong>Checked:</strong> Reserves a dedicated real-time CPU core for its communication.<br><strong>Unchecked:</strong> Defaults to core 0.</td></tr><tr><td><strong>TCP port</strong></td><td>Defines the TCP port on which the OPC UA Server listens for incoming client connections. The default OPC UA port is <strong>4840</strong>.</td></tr><tr><td><strong>Verbose</strong></td><td><strong>Checked:</strong> Displays the full configuration during model loading for debugging.<br><strong>Unchecked:</strong> Suppresses detailed output.</td></tr><tr><td><strong>Advanced options</strong></td><td><strong>Checked:</strong> A new <strong>Advanced options</strong> folder appears in the <strong>Folders</strong> / <strong>OPC UA Server</strong> list, allowing access to additional settings intended for advanced users and specialized use cases.<br><strong>Unchecked:</strong> Only basic OPC UA Server configuration parameters are shown. Advanced options remain hidden to simplify setup and reduce the risk of misconfiguration.</td></tr><tr><td><strong>Use external synchronization</strong></td><td><p><strong>Checked:</strong> Exposes the <strong>Timestamp epoch time</strong> and <strong>Timestamp ns</strong> connectable points. These connectable points allow the use of a timestamp reference <strong>from the model</strong> for synchronization purposes. This model‑provided timestamp is typically derived from an external time source, enabling alignment with external systems or time‑synchronized environments.</p><p><strong>Unchecked:</strong> External time synchronization data points are not exposed.</p></td></tr><tr><td><strong>Enable virtual mode</strong></td><td><strong>Checked:</strong> Allows the model to run even if the I/O interface is not compatible with the hardware configuration. Connections are initialized, but the interface performs no actions.<br><strong>Unchecked:</strong> Troubleshoot without hardware or prepare a model for a future hardware platform.</td></tr></tbody></table>
{% endstep %}

{% step %}

### Configure advanced options (for advanced users only)

When the **Advanced options** parameter is enabled in the general settings, an **Advanced options** list appears. Expand the list to view and configure these additional configuration settings.

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-e9674d1d96f7811ace911d0e21da4f6d59c9bd36%2FDR-hyp-opcua-advanced.png?alt=media" alt=""><figcaption></figcaption></figure>

<table><thead><tr><th width="160">Section</th><th>Description</th></tr></thead><tbody><tr><td><strong>TCP Binary</strong></td><td>Configures TCP transport parameters used by the OPC UA binary protocol, including maximum message size, number of simultaneous connections, and connection timeout values.</td></tr><tr><td><strong>Secure Conversation</strong></td><td>Configures the secure channel layer, including the number of renewed secure channels and the maximum number of concurrent secure channels supported by the OPC UA Server.</td></tr><tr><td><strong>Security</strong></td><td>Configures end‑to‑end security policies used by the OPC UA Server, such as supported security modes, encryption settings, and authentication mechanisms.</td></tr><tr><td><strong>Services</strong></td><td>Configures session‑related parameters used between OPC UA clients and the server, including the maximum number of sessions, session timeout values, and service queue sizes.</td></tr><tr><td><strong>Address Space and Profiles</strong></td><td>Configures user‑defined objects and information models exposed in the OPC UA address space and exchanged between the server and clients.</td></tr><tr><td><strong>Server Capabilities</strong></td><td>Defines server capability limits, including the maximum number of browse results, array length limits for data points, and maximum string lengths supported by the server.</td></tr><tr><td><strong>Operation Limits</strong></td><td>Configures limits related to node operations between the server and clients, such as the maximum number of nodes per read or write request, maximum nodes per method call, and maximum monitored items per subscription.</td></tr><tr><td><strong>Internals</strong></td><td>Configures internal server parameters, including buffer sizes and the number of buckets used for the address space hash table.</td></tr><tr><td><strong>Diagnostics</strong></td><td>Configures diagnostic features, including enabling or disabling informational and error logging.</td></tr><tr><td><strong>Intervals</strong></td><td>Defines an array of predefined cyclic sampling and reporting intervals that the server can execute efficiently. All intervals must be multiples of the server cyclic rate. The minimum interval must be less than or equal to the first entry in the array, and the maximum interval must be greater than or equal to the last entry. The <strong>cyclicRateMs</strong> parameter specifies the server execution and polling rate (default: <strong>100 ms</strong>). Reducing this value (e.g., to 50 ms) is not recommended without thorough performance testing.</td></tr></tbody></table>
{% endstep %}

{% step %}

### Configure the data points

1. Click **Points setup** to reveal the list of data points and use:
   * **+** icon to add data points
   * **–** icon to remove data points
   * **Arrow** icons to reorder data points

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-348671a5fbcec2c57f2d48c4ac38a7fe89323924%2FDR-hyp-opcua-data.png?alt=media" alt=""><figcaption></figcaption></figure>

2. Configure each data point as desired.

<table data-header-hidden><thead><tr><th width="140"></th><th></th></tr></thead><tbody><tr><td><strong>Name</strong></td><td>Specifies the unique name of the configured data point. This name is used to identify the data point within the OPC UA Server and is visible to OPC UA clients.</td></tr><tr><td><strong>Type</strong></td><td><p>Defines the data type of the data point:</p><ul><li><strong>boolean</strong> – Boolean value (0 or 1)</li><li><strong>int8</strong> – Signed 8‑bit integer (−128 to 127)</li><li><strong>uint8</strong> – Unsigned 8‑bit integer (0 to 255)</li><li><strong>int16</strong> – Signed 16‑bit integer (−32,768 to 32,767)</li><li><strong>uint16</strong> – Unsigned 16‑bit integer (0 to 65,535)</li><li><strong>int32</strong> – Signed 32‑bit integer (−2,147,483,648 to 2,147,483,647)</li><li><strong>uint32</strong> – Unsigned 32‑bit integer (0 to 4,294,967,295)</li><li><strong>int64</strong> – Signed 64‑bit integer (−2⁶³ to 2⁶³ − 1)</li><li><strong>uint64</strong> – Unsigned 64‑bit integer (0 to 2⁶⁴ − 1)</li><li><strong>float</strong> – Single‑precision floating‑point value (approximately ±3.4 × 10³⁸)</li><li><strong>double</strong> – Double‑precision floating‑point value (approximately ±1.7 × 10³⁰⁸)</li></ul></td></tr><tr><td><strong>Direction</strong></td><td>Specifies the direction of data communication. Supported values are <strong>Server to Client</strong> (data published by the server and read by the client) and <strong>Client to Server</strong> (data written by the client and consumed by the simulation).</td></tr><tr><td><strong>Array Length</strong></td><td>Defines the size of the data point. A value of <strong>1</strong> indicates a scalar data point, while values greater than <strong>1</strong> indicate a vector (array) of the specified length.</td></tr><tr><td><strong>Path</strong></td><td>Specifies the folder hierarchy for the data point within the OPC UA address space. All folders are visible to OPC UA clients, and multiple data points can be organized under the same folder path.</td></tr><tr><td><strong>Enable quality control</strong></td><td><p><strong>Checked:</strong> Exposes the data point <strong>quality control</strong> connectable point. This connectable point allows to monitor the data point quality independently by the OPC UA client.</p><p><strong>Unchecked:</strong> The <strong>quality control</strong> connectable point is not exposed for this data point.</p></td></tr><tr><td><strong>Initial value(s)</strong></td><td>Defines the initial value(s) assigned to <strong>Client to Server</strong> data points at model startup. These values are applied before the OPC UA client writes any data to the data point.</td></tr></tbody></table>
{% endstep %}

{% step %}

### Save the configuration

Click **Ok** or **Apply** to save the configuration.
{% endstep %}
{% endstepper %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://www.opal-rt.com/docs/hypersim/configure-ios/communication-protocol-ios/opc-ua-da/configure-opc-ua-server.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
