> 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/model-and-simulation/manage-sensors.md).

# Manage Sensors

HYPERSIM sensors are used to [acquire signals in **ScopeView**](https://www.opal-rt.com/docs/hypersim/simulation-control-monitoring-and-logging/interact-using-scopeview.md), [record signals with the **Data Logger**](https://www.opal-rt.com/docs/hypersim/simulation-control-monitoring-and-logging/log-simulation-data-with-datalogger.md), and to [connect the simulation to **I/O interfaces**](broken://spaces/N9x5CUu79pubjsBH7Ja1/pages/KaQ9kEO4w6pf3ygQpusj) through their associated connection points. Because sensors are managed independently of the schematic wiring, they provide a flexible way to monitor and exchange signals without affecting the circuit design.

This section provides an introduction to sensors and general information about their usage. Refer to the linked sections above for detailed instructions on how to accomplish specific objectives.

## Add, view, or edit a component's sensors

1. To add, view, or edit sensors of a **component block** or **bus**, right‑click the component and select **Open Sensors Form**.

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-6e4106de88024e788e99f5951138e73eef358eb9%2Fimage%20(19).png?alt=media" alt=""><figcaption></figcaption></figure>

2. The **Sensors Form** lists all signals available for monitoring or for I/O connection for the selected component. Use the **Selected** checkbox to activate or deactivate each sensor. Signals can be selected before or while the simulation is running.

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

{% hint style="info" %}
Available sensors for a given component block are documented under the **Signals available for monitoring and external I/O connections (via the Sensors Form)** section. Refer to the [Library Blocks Reference](broken://spaces/N9x5CUu79pubjsBH7Ja1/pages/CkgCJ6bLso31hzRDfitz) to access the corresponding block documentation.
{% endhint %}

## Manage all block sensors

To view and manage all the selected sensors across the entire model, go to the **HYPERSIM** ribbon and click **Sensor Summary** in the **Sensors & I/Os** section.

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-af1b85fb06bec8c7b1960d370b327d4958c31f15%2Fimage%20(1204).png?alt=media" alt=""><figcaption></figcaption></figure>

The top menu of the **Sensor Summary** window provides several filtering and view options. The leftmost buttons allow you to **select all** sensors. The next button allow you to **unselect all** sensors. The **Type** list filters sensors by their type, while the **I/O** list filters sensors based on whether they are connected to an **I/O interface**. The **Category** list filters sensors by component category, and the **View** list controls which parameter columns are displayed in the table.

<table data-search="false"><thead><tr><th width="200.08331298828125">Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>Selected</strong></td><td>Indicates whether the sensor is selected.</td></tr><tr><td><strong>Device</strong></td><td>Device name. Corresponds to the block name assigned in the model schematic.</td></tr><tr><td><strong>Category</strong></td><td>Device category. Can be filtered from the dropdowns.</td></tr><tr><td><strong>Type</strong></td><td>Sensor type. A sensor is either an input or an output.</td></tr><tr><td><strong>Name</strong></td><td>Sensor name. Matches the pin name on the device.</td></tr><tr><td><strong>Description</strong></td><td>Editable description. Empty by default.</td></tr><tr><td><strong>Unit</strong> (hidden by default)</td><td>Unit defined by the device documentation.</td></tr><tr><td><strong>Base Unit</strong> (hidden by default)</td><td>Editable base unit, for readability purposes.</td></tr><tr><td><strong>Base Factor</strong> (hidden by default)</td><td>Editable factor applied to the base unit.</td></tr><tr><td><strong>I/O Type</strong></td><td>Legacy information (no longer used).</td></tr><tr><td><strong>I/O Number</strong></td><td>Legacy information (no longer used).</td></tr><tr><td><strong>I/O Factor</strong></td><td>Analog I/O scaling factor. Output signals are divided by this value; input signals are multiplied by it.</td></tr><tr><td><strong>Record</strong></td><td>Select to record the sensor using the Data Logger.</td></tr><tr><td><strong>Group</strong></td><td>Data Logger signal group in which the signal is recorded.</td></tr><tr><td><strong>Trigger</strong></td><td>Data Logger signal group trigger. Only one trigger source is allowed per group. If none is selected, acquisition starts automatically.</td></tr><tr><td><strong>Disable I/O</strong></td><td>Disables the I/O connection without clearing it. The connection is ignored during simulation.</td></tr><tr><td><strong>I/O Connection</strong></td><td>Data point connecting the sensor to an I/O Interface. Defined by an exchanger name, datapoint name, and optional datapoint index. If the datapoint contains a single element, the index is −1; otherwise, it ranges from 0 to <em>n</em>−1. In the Python API, the exchanger name is the portion before the first “/”, and the datapoint name follows it.</td></tr></tbody></table>

Use multi‑selection (Ctrl + click) to edit multiple sensors at once:

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-89f879d7ef518fc819d5d4a545ff01ca65cfbd75%2Fimage%20(26).png?alt=media" alt=""><figcaption></figcaption></figure>

The buttons at the bottom of the window control how changes to the sensor configuration are applied:

* **OK**: Applies the sensor configuration for the current session, then closes the window.
* **Apply**: Applies the sensor configuration while keeping the window open for further editing.
* **Revert**: Discards unapplied changes and restores the previous configuration. Changes that have already been applied cannot be reverted.
* **Cancel**: Discards all unapplied changes and closes the window.

## Save the sensor configuration

In the **HYPERSIM** tab, click **Save** or **Save As** in the **Sensors & I/Os** section to save the current sensor configuration to a sensor file on disk. **Save As** enables managing multiple configurations for different use cases.

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-8856ce06b6e7fae33d6874fbcb82b57ff6cfa28c%2Fimage%20(30).png?alt=media" alt=""><figcaption></figcaption></figure>

If there are unapplied or unsaved sensor changes when closing the model, HYPERSIM prompts you to save the sensor configuration. You may choose to save or discard the changes. If you save the configuration, you can select the save location and decide whether it becomes the new default sensor file.

If automatic loading of the default sensor file is enabled, this saved configuration will be reloaded the next time the model is opened.

## Load or append sensor configurations

In the **HYPERSIM** tab, click **Load** in the **Sensors & I/Os** section to load a specific sensor configuration. Alternatively, use **Append** to load a sensor configuration file and add its sensors to the current configuration without replacing existing sensors.

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-b9a756e555ff0e78b04ec2478e134ad75baa3f3b%2Fimage%20(31).png?alt=media" alt=""><figcaption></figcaption></figure>

## Select a default sensor file

Each model uses a default sensor file, which is automatically loaded when the model is opened (if enabled). To select, enable, or disable the default sensor file, go to the **HYPERSIM** tab and click **Settings** in the **Simulation** section.

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-97aa8bc6630192e1ff1d234bb0fea90fb0872fe8%2Fimage%20(27).png?alt=media" alt=""><figcaption></figcaption></figure>

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-89e68fcf896b57db96602c2c172cc93f99e2f54a%2Fimage%20(28).png?alt=media" alt=""><figcaption></figcaption></figure>

## Update an old sensor file to the current version <a href="#migrating-from-to-2022.1-and-older" id="migrating-from-to-2022.1-and-older"></a>

Sensor configurations created with versions prior to **2022.1** use legacy formats that are no longer managed automatically. When opening such a model in a recent HYPERSIM version, the sensor configuration must be updated to ensure compatibility and predictable behavior.

When opening a model created with an older HYPERSIM version:

* A legacy sensor file (for example, `sessionSensor.dat`) is detected.
* The configuration is automatically converted to the current sensor format.
* The legacy file is removed to avoid ambiguity.
* The converted configuration is preserved in a **CSV file**, which can be reused or edited.

A notification indicates that a sensor configuration has been converted.

{% hint style="danger" %}

### **Version interoperability notes**

* Older HYPERSIM versions do not recognize the new sensor file format.
* To reopen the model in an older version, the sensor configuration must be reloaded manually in that version, which recreates the legacy file.
* Returning to a newer version will trigger a new migration.
  {% endhint %}


---

# 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/model-and-simulation/manage-sensors.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.
