> 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/automation-api-and-scripting/datalogger-api/python-datalogger-api-reference/class-signalgroup.md).

# Class SignalGroup

## Arguments

SignalGroup(arg1, arg2=-1)

<table><thead><tr><th width="289.55548095703125">Arguments</th><th>Description</th></tr></thead><tbody><tr><td>arg1</td><td>IP address (live streaming) or file name (.oprec file streaming).<br>str</td></tr><tr><td>arg2</td><td>Connection port or signal group name (live streaming) or default value (file streaming).<br>str or int</td></tr></tbody></table>

## Method

<table><thead><tr><th width="289.66668701171875">Method</th><th>Description</th></tr></thead><tbody><tr><td>clear_trigger()</td><td>Remove trigger (file mode only)<br>Return: None</td></tr><tr><td>close()</td><td>Close DataLogger connection<br>Return: Error code if any, or None</td></tr><tr><td>configure_frame(frame_config: FrameConfig)</td><td>Configure frame (required before reading)<br>Return: None</td></tr><tr><td>configure_trigger(trigger_config: TriggerConfig)</td><td>Configure trigger<br>Return: None</td></tr><tr><td>get_file_name()</td><td>Recording file name<br>Return: str, the name of the file in which the signals’ values are stored.</td></tr><tr><td>get_frame_config()</td><td>Current frame configuration<br>Return: FrameConfig</td></tr><tr><td>get_last_error_message()</td><td>Last error message<br>Return: str, the last error message.</td></tr><tr><td>get_lost_steps()</td><td>Timestamps of lost steps<br>Return: tuple[int], a tuple of timestamps of the lost steps.</td></tr><tr><td>get_recording_status()</td><td>Recording status<br>Return: int, the status of the recording. Refer to RecordingStatus for available statuses.</td></tr><tr><td>get_signals_info()</td><td>Available signal metadata<br>Return: tuple[SignalInfo]</td></tr><tr><td>get_step_info()</td><td>Simulation step info<br>Return: StepInfo</td></tr><tr><td>get_sub_frame()</td><td><p>Retrieve recorded data. The frame MUST be configured (with configure_frame()) before calling this function.</p><p>For the live streaming, this function returns the latest subframe recorded by the DataLogger.</p><p>The returned sub-frame may or may not be complete for live streaming, and is always complete for file streaming.<br>Return: Frame filled with the values of the configured signals.<br><strong>Raises:</strong> DataloggerApi.exceptions.NoDataAvailableError: No data are available, try later to get next frame data (live streaming only).</p></td></tr><tr><td>get_timestamp_range()</td><td>Timestamp range<br>Return: TimeStampRange</td></tr><tr><td>get_trigger_config()</td><td>Current trigger configuration<br>Return: TriggerConfig containing following trigger information: trigger_level, trigger_type, trigger_holdoff.</td></tr><tr><td>save_as(dest_type: FileType, dest_file_path: str | None = None)</td><td><p>Convert and save data.</p><p>Only file related signal group may be converted to other file type. Stream based signal group cannot be converted yet.</p><p>Configure a frame (start time + step count) to convert a subset of the file.</p><p>dest_file_path (str)is the full path to the destination file. If not specified, the current file path is used with the file extension replaced.<br>Return: str, the generated output file path.</p><p>Exceptions: OprecConversionError: conversion error</p></td></tr><tr><td>set_trigger(trigger_config: TriggerConfig)</td><td>Set trigger (file mode only)<br>Return: None</td></tr><tr><td>start_recording(file_name: str = "")</td><td>Start recording<br>file_name (str) is the file name used to store signals’ values. When not specified, the preconfigured file name is used along with integer id. This id is incremented for each started record.<br>Return: None</td></tr><tr><td>stop_recording()</td><td>Stop recording of the .oprec file.<br>Return: None</td></tr></tbody></table>

## Example usage

{% code overflow="wrap" lineNumbers="true" %}

```python
from opal.convert.file_type import FileType 
signal_group.save_as(FileType.csv)
```

{% endcode %}


---

# 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/automation-api-and-scripting/datalogger-api/python-datalogger-api-reference/class-signalgroup.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.
