> 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/hyperlab/simulation-control-monitoring-and-logging/log-simulation-data/configure-the-recorder.md).

# Configure the Recorder

{% stepper %}
{% step %}

### Open the Recorder window

1. Click on **Recorder File** in the navigation pane. This opens the Recorder window.
2. The Recorder is **Enabled** by default: it waits for the **Trigger** condition to be true to start recording. When **Disabled**, no data recording would happen during the simulation.

<figure><img src="https://2712201518-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fbs0l9jugXixa0ghErrqs%2Fuploads%2FE5kIu4OarlHLXDzCj2Uw%2FRecorders_select_enable.png?alt=media&amp;token=ab749c0e-0a4d-4dcd-a7ab-42aee11c9bf3" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### Configure the Trigger

The **Trigger** is the mechanism that tells the Recorder under which conditions it has to start recording the data. The trigger signal can be the **Simulation Time**, or any signal from the model.

1. Click on the **Trigger** button to open the trigger options.
2. By default, the trigger signal is **Simulation Time**. This can be used to trigger the recording as soon as the recorder is **Enabled** while the simulation is running (Simulation Time ≥ 0).
3. Click on **Browse** to select a different trigger signal.
4. The condition on the trigger signal can be
   1. **RISING**: a rising edge is detected on the trigger signal and its value is above **Level**.
   2. **FALLING**: a falling edge is detected  on the trigger signal and its value is below **Level**.
   3. **ABOVE**: the value of the trigger signal is above **Level**.
   4. **BELOW**: the value of the trigger signal is below **Level**.

<figure><img src="https://2712201518-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fbs0l9jugXixa0ghErrqs%2Fuploads%2FRVDHvYhGthCwCx9cunse%2FRecorders_trigger.png?alt=media&amp;token=7d64145b-a37c-46cd-9529-3a65fd8c912a" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### Select the Mode

The **Mode** can be *SINGLE* or *REPEAT*

* **SINGLE** : the recording happens only once when the trigger condition is met. Data is recorded during a fixed amout of time specified by the parameter **Duration**.
* **REPEAT** : the recording happens at most as many times as specified by the parameter **Number of repeats**. Each repeat starts when the trigger condition is met again. There can be a hold-off time specified by the parameter **Time between repeats** *(feature coming soon)*, between the end of the recording of a certain repeat and the start of the next one.

<figure><img src="https://2712201518-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fbs0l9jugXixa0ghErrqs%2Fuploads%2Ffs6gdBssJ8yS473FYONj%2FRecorders_mode.png?alt=media&amp;token=48a3eb50-4288-4e52-a6a4-cc4993fc5c34" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### Select the Duration and Pre-trigger

The **Duration** tells the length of the frame to be recorded. It can be expressed in number of samples (Sa) or in a unit of time (from nanoseconds to hours).

**Pre-trigger** allows to record data generated before the trigger condition is met.

<figure><img src="https://2712201518-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fbs0l9jugXixa0ghErrqs%2Fuploads%2F63R6pVQO6s83BCRXP1ed%2FRecorders_duration.png?alt=media&amp;token=d53e8173-89bf-4226-9cab-c36e827f55bd" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### Set advanced settings

Advanced settings let the user:

* Specify the recording file name.
* Specify the Export Format : \*.oprec or \*.csv
* Specify the folder where the recording files are stored.
* Enable the automatic time stamping of the recording files.
* Specify the **Decimation Factor** *(feature coming soon)*, which allows to downsample the recording with respect to the model Time Step.

<figure><img src="https://2712201518-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fbs0l9jugXixa0ghErrqs%2Fuploads%2FqfY9XLrK1aVG8PMzGWZb%2FRecorders_advanced.png?alt=media&amp;token=080aaab8-e8c5-46a1-b2ef-93fdacda1fb1" alt=""><figcaption></figcaption></figure>

{% 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/hyperlab/simulation-control-monitoring-and-logging/log-simulation-data/configure-the-recorder.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.
