> 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/rt-lab/model-and-simulation/co-simulation/co-simulation-with-orchestra/connect-simulations-over-ethernet-with-orchestra.md).

# Connect Simulations over Ethernet with Orchestra

## Introduction

Use Orchestra Ethernet when the Framework and External Component execute on different networked systems and exchange Orchestra data through **TCP or UDP**.

Orchestra Ethernet introduces an external communication process responsible for Ethernet communication.

This process exchanges data locally with the Framework or External Component using Orchestra shared memory, then sends that data over the network. For higher performance, the process can be assigned to a dedicated CPU core.

### Configure the DDF

For Orchestra Ethernet, configure the connection with:

`type="local"`

and set:

* `extcomm="tcp"` for TCP; or
* `extcomm="udp"` for UDP. [\[Orchestra | Confluence\]](https://opal-rt.atlassian.net/wiki/spaces/RD/pages/45881870/Orchestra)

The available network parameters include:

* `addrframework`: Framework target IP address;
* `portframework`: Framework communication port;
* `nicframework`: Framework network interface;
* `nicclient`: External Component network interface;
* `coreframework`: CPU core used by the Framework communication process;
* `coreclient`: CPU core used by the External Component communication process. [\[Orchestra | Confluence\]](https://opal-rt.atlassian.net/wiki/spaces/RD/pages/45881870/Orchestra)

If the port is not specified, the documented default `portframework` is **23420**. [\[Orchestra | Confluence\]](https://opal-rt.atlassian.net/wiki/spaces/RD/pages/45881870/Orchestra)

When XHP is enabled, the external communication process must run on a dedicated core using the `coreframework` and `coreclient` settings. [\[Orchestra | Confluence\]](https://opal-rt.atlassian.net/wiki/spaces/RD/pages/45881870/Orchestra)

### Verify the Connection

Before running the complete co-simulation:

1. Verify IP connectivity between systems.
2. Verify the selected TCP or UDP port.
3. Verify that the DDF is consistent on both sides.
4. Verify the Framework address.
5. Verify data-item directions.
6. Start the Framework.
7. Start the External Component.

For troubleshooting, Orchestra can expose external communication-process logs in the RT-LAB Display when logging is set to **Exhaustive** and XHP is disabled. [\[Orchestra | Confluence\]](https://opal-rt.atlassian.net/wiki/spaces/RD/pages/45881870/Orchestra)

***

## 7. Connect Simulations with Dolphin and Orchestra

Use Orchestra Dolphin when two simulation systems connected through supported Dolphin PCIe hardware need low-latency Orchestra communication.

This workflow is conceptually different from **Distribute an RT-LAB Model Across Multiple Targets with Dolphin**:

* **Distributed RT-LAB + Dolphin:** one RT-LAB model is partitioned across multiple targets.
* **Orchestra + Dolphin:** separate simulation components exchange data through Orchestra over the Dolphin network.

The Orchestra documentation explicitly states that Dolphin PX or IX PCIe adapters can be used to synchronize simulations running on different systems. [\[Orchestra | Confluence\]](https://opal-rt.atlassian.net/wiki/spaces/RD/pages/45881870/Orchestra)

### Configure the Dolphin Network

Install and configure the supported Dolphin hardware before configuring Orchestra.

Each participating system must be visible as the appropriate Dolphin node.

### Configure the DDF

Set the Orchestra connection type to:

`dolphin`

The domain also requires:

* `nodeIdFramework`
* `segmentId` [\[Orchestra | Confluence\]](https://opal-rt.atlassian.net/wiki/spaces/RD/pages/45881870/Orchestra)

`nodeIdFramework` identifies the Dolphin node hosting the Orchestra Framework. The documented valid range is **4 to 4096**. [\[Orchestra | Confluence\]](https://opal-rt.atlassian.net/wiki/spaces/RD/pages/45881870/Orchestra)

`segmentId` uniquely identifies the Framework's domain segment. The documented range is **1 to 65535**. [\[Orchestra | Confluence\]](https://opal-rt.atlassian.net/wiki/spaces/RD/pages/45881870/Orchestra)

The Orchestra runtime then performs the domain communication through the Dolphin network. [\[Orchestra | Confluence\]](https://opal-rt.atlassian.net/wiki/spaces/RD/pages/45881870/Orchestra)

> **Note:** The old Orchestra page refers specifically to PX/IX-era Dolphin hardware. For the modern documentation, I would link to the maintained Dolphin hardware/OPAL-RTLinux documentation rather than copy hardware compatibility lists into this Orchestra page.

***

## 8. Orchestra DDF Reference

The Data Description File describes the Orchestra communication contract.

### Structure

A DDF uses the following hierarchy:

1. Orchestra
2. Domain
3. Publish/Subscribe set
4. Data item

The root `<orchestra>` element represents the complete co-simulation configuration. Each `<domain>` underneath it defines an independent data-exchange space. [\[Orchestra | Confluence\]](https://opal-rt.atlassian.net/wiki/spaces/RD/pages/45881870/Orchestra)

### Domain Settings

#### Domain name

Identifies the domain.

Domain names:

* must be unique within the DDF;
* are case-sensitive;
* are limited to 64 characters after trimming;
* must contain at least one non-space character; and
* cannot contain `,` or `#`. [\[Orchestra | Confluence\]](https://opal-rt.atlassian.net/wiki/spaces/RD/pages/45881870/Orchestra)

#### synchronous

Controls whether participants exchange data synchronously or asynchronously. [\[Orchestra | Confluence\]](https://opal-rt.atlassian.net/wiki/spaces/RD/pages/45881870/Orchestra)

#### states

Controls the Writer Access Priority behavior.

The current Orchestra page contains an important correction in its maintainer discussion: the actual DDF XML tag is `<states>`; `hasStates` corresponds to terminology used by the DDF Configurator rather than the XML tag. [\[Orchestra | Confluence\]](https://opal-rt.atlassian.net/wiki/spaces/RD/pages/45881870/Orchestra)

I would therefore use **`states` everywhere in the new DDF reference**.

#### multiplePublishAllowed

Controls whether multiple publishers can write to the same asynchronous shared-memory domain.

A Framework topology with several clients is permitted only for an **asynchronous domain using shared-memory communication** according to the current documentation. [\[Orchestra | Confluence\]](https://opal-rt.atlassian.net/wiki/spaces/RD/pages/45881870/Orchestra)

A synchronous connection does not allow multiple publishers. [\[Orchestra | Confluence\]](https://opal-rt.atlassian.net/wiki/spaces/RD/pages/45881870/Orchestra)

### Publish Set

Defines data sent:

**Framework → External Component**. [\[Orchestra | Confluence\]](https://opal-rt.atlassian.net/wiki/spaces/RD/pages/45881870/Orchestra)

### Subscribe Set

Defines data sent:

**External Component → Framework**. [\[Orchestra | Confluence\]](https://opal-rt.atlassian.net/wiki/spaces/RD/pages/45881870/Orchestra)

### Data Item Settings

#### name

Unique identifier within the domain. [\[Orchestra | Confluence\]](https://opal-rt.atlassian.net/wiki/spaces/RD/pages/45881870/Orchestra)

#### type

Native C-compatible data type such as `double` or `int`; the C `char` type is represented as `byte`. [\[Orchestra | Confluence\]](https://opal-rt.atlassian.net/wiki/spaces/RD/pages/45881870/Orchestra)

#### length

Number of elements in the data item. Use values greater than one for arrays. [\[Orchestra | Confluence\]](https://opal-rt.atlassian.net/wiki/spaces/RD/pages/45881870/Orchestra)

#### description

Optional text describing the data item. [\[Orchestra | Confluence\]](https://opal-rt.atlassian.net/wiki/spaces/RD/pages/45881870/Orchestra)

#### default

Optional default value for eligible **Subscribe** items.

Default values cannot be assigned to Publish items because the Framework writes Publish values every simulation step. [\[Orchestra | Confluence\]](https://opal-rt.atlassian.net/wiki/spaces/RD/pages/45881870/Orchestra)

### Connection Settings

#### Shared memory

Use for Framework and External Components executing on the same system. Legacy Orchestra documentation calls this a `local` connection. [\[Orchestra | Confluence\]](https://opal-rt.atlassian.net/wiki/spaces/RD/pages/45881870/Orchestra)

#### Ethernet

Configure `type="local"` with `extcomm="tcp"` or `extcomm="udp"`. [\[Orchestra | Confluence\]](https://opal-rt.atlassian.net/wiki/spaces/RD/pages/45881870/Orchestra)

#### Dolphin

Use `type="dolphin"` and provide the required Dolphin node and segment configuration. [\[Orchestra | Confluence\]](https://opal-rt.atlassian.net/wiki/spaces/RD/pages/45881870/Orchestra)

#### Reflective memory

The legacy `remote` connection uses reflective memory and requires the appropriate communication-card and PCI-index configuration. [\[Orchestra | Confluence](https://opal-rt.atlassian.net/wiki/spaces/RD/pages/45881870/Orchestra)


---

# 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/rt-lab/model-and-simulation/co-simulation/co-simulation-with-orchestra/connect-simulations-over-ethernet-with-orchestra.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.
