> 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/time-synchronization-driver/configure-synchronization.md).

# Configure Synchronization

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 Synchronization 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 **Synchronization** and select **Add**. Keep the default name or enter a custom one. If multiple **Synchronization** 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-6a8d9b9469f53ac9ff3516c727690579cc18a380%2FDR-hyp-sync-add.png?alt=media" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### 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-6a2d58520791964bbc24c9dfb8971d4f47f55728%2FDR-hyp-sync-gen.png?alt=media" alt=""><figcaption></figcaption></figure>

<table><thead><tr><th width="175">Parameter</th><th>Value (Description)</th></tr></thead><tbody><tr><td><strong>Hardware</strong></td><td>Specifies the synchronization hardware. Currently, only the <strong>Oregano Syn1588 PCIe card</strong> is supported.</td></tr><tr><td><strong>Enable verbose mode</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>Synchronization mode</strong></td><td><p>Selects the synchronization source: <strong>PTP</strong>, <strong>IRIG‑B</strong>, or <strong>1PPS</strong>.</p><ul><li>In <strong>PTP mode</strong>, the driver can operate as a <strong>PTP master</strong> or <strong>PTP slave</strong>, depending on the selected PTP profile and priority.</li><li>In <strong>IRIG‑B</strong> or <strong>1PPS mode</strong>, the driver expects a valid signal on the external SMA input. In these modes, the driver can also act as a PTP master to synchronize other PTP slaves on the network.</li></ul></td></tr><tr><td><strong>Generate sync signal</strong></td><td><p>Available only in <strong>PTP mode</strong>.</p><p><strong>Checked:</strong> The external SMA connector is used to generate either a <strong>1PPS</strong> or <strong>IRIG‑B</strong> signal.<br><strong>Unchecked:</strong> No synchronization signal is generated on the external SMA connector.</p></td></tr><tr><td><strong>Wait for next second</strong></td><td><strong>Checked:</strong> Simulation start is delayed until the next second boundary. The rising edge of the synchronization signal is aligned with the rising edge of the <strong>1PPS</strong> signal in <strong>PTP</strong>, <strong>IRIG‑B</strong>, or <strong>1PPS</strong> mode.<br><strong>Unchecked:</strong> The simulation may start in the middle of a second, without alignment to a second boundary.</td></tr><tr><td><strong>Wait for synchronization timeout (seconds)</strong></td><td>Specifies the maximum time the driver waits for synchronization before starting the simulation. Synchronization begins when the model is loaded, but execution starts only after the timeout expires. Set to <strong>0</strong> to start the simulation immediately.</td></tr><tr><td><strong>Network interface</strong></td><td>Optional. Leave blank or set to <strong>auto</strong> to allow automatic detection of the network interface. If specified, the value must match the name of an IEEE‑1588‑capable network interface. An error is reported at load time if the selected interface does not support PTP.</td></tr><tr><td><strong>PTP profile</strong></td><td>Selects the PTP profile matching the architecture. A profile defines a predefined set of IEEE‑1588 parameters and operating behavior. Available options include: <strong>Default</strong>, <strong>P2P default</strong>, <strong>Power</strong>, <strong>Power slave</strong>, <strong>Power2</strong>, <strong>Power2 slave</strong>, <strong>C37.238‑2017</strong>, <strong>C37.238‑2017 slave</strong>, <strong>SMPTE</strong>, <strong>SMPTE slave</strong>, <strong>Telecom master</strong>, <strong>Telecom 2</strong>, <strong>Telecom 2 slave</strong>, <strong>gPTP</strong>, <strong>gPTP slave</strong>.</td></tr><tr><td><strong>Delay mechanism</strong></td><td>Selects how network propagation delays are calculated. Supported mechanisms are <strong>peer‑to‑peer</strong> and <strong>end‑to‑end</strong>.</td></tr><tr><td><strong>Use VLAN</strong></td><td><strong>Checked:</strong> Use this option when the synchronization hardware is connected to a <strong>VLAN</strong>. A <strong>VLAN identifier must be specified</strong>.<br><strong>Unchecked:</strong> VLAN configuration is not used for the synchronization hardware.</td></tr><tr><td><strong>Priority</strong></td><td>Sets the priority value used by the <strong>Best Master Clock Algorithm (BMCA)</strong>. Lower values indicate higher priority. If the simulator operates as a PTP master and a higher‑priority master appears on the network, the simulator automatically switches to slave mode.</td></tr><tr><td><strong>Advanced options</strong></td><td>Allows configuration of advanced or specialized features supported by the Oregano Syn1588 PCIe card. This field should only be used by advanced users or under guidance from OPAL‑RT Support.</td></tr><tr><td><strong>Time offset (s)</strong></td><td>Specifies a time offset applied to the timestamp read from the hardware, with nanosecond‑level precision. When the offset is non‑zero, the <strong>Shifted time/Seconds</strong> and <strong>Shifted time/Nanoseconds</strong> connectable points are exposed, allowing the shifted timestamp to be monitored directly <strong>in the model</strong> during execution.<br>The original timestamps <strong>Seconds</strong> and <strong>Nanoseconds</strong> connectable points remain exposed. If the clock is not yet synchronized (timestamp starting at 0), the original timestamp may be adjusted to prevent negative shifted values.</td></tr><tr><td><strong>Apply this configuration automatically next time the system boots</strong></td><td><strong>Checked:</strong> The card is configured by an operating system service at boot time, allowing synchronization with the Grandmaster clock before the simulation starts.<br><strong>Unchecked:</strong> The card is configured only when the model is loaded, and synchronization begins at that time.</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 %}

### 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/time-synchronization-driver/configure-synchronization.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.
