startRecording

Starts signal data live streaming and File Log logging

Since R2022a

Syntax

startRecording(target_object)

Description

startRecording(target_object) starts a simulation run in the Simulation Data Inspector, enables signal data live streaming, and enables signal data File Log logging. Every time that signal logging and streaming is enabled by using the startRecording function, Start Recording button, or enabling the Enable File Log block creates a log run on the target computer.

When a model includes an Enable File Log block, the startRecording function and stopRecording function only control signal streaming and do not control file logging. For such a model, the AutoImportFileLog option does not import file log data into the Simulation Data Inspector on a stopRecording.

When a boolean signal in the model triggers the Enable File Log block, new Logs are created on the target. Retention of these new logs depends on the FileLogMaxRuns setting.

For more information about the file logging workflow, see Signal Logging and Streaming Basics.

Examples

Start Recording on Target Computer

Use the startRecording function to start recording on the target computer. You also can use the Start Recording button on the Real-Time tab in the Simulink Editor or in the Simulink Real-Time Explorer.

tg = slrealtime;
load(tg,'slrt_ex_osc')
start(tg);
stopRecording(tg);
startRecording(tg);

Input Arguments

target_object — Object that represents target computer

slrealtime.Target object

Provides access to methods that manipulate the target computer properties.

Example: tg

Version History

Introduced in R2022a

R2022b: Added Dashboard Block Compatibility

Added compatibility with Simulink dashboard blocks to the startRecording function and stopRecording function. When a model includes Simulink dashboard blocks, using the startRecording function or stopRecording function does not generate an error.

R2022b: Made Start and Stop Logging and Streaming Independent of Real-Time Application

You can set the start or stop state for logging and streaming independent of the run or stop state of the real-time application. This independence lets you start a real-time application with logging and streaming stopped by using the stopRecording function or the Stop Recording button on the Real-Time tab in the Simulink Editor or in the Simulink Real-Time Explorer.