Target

Represent real-time application and target computer status

Description

A Target object represents a Speedgoat^® target computer and provides access to Object Functions, Target Object Properties, and Target Object Events related to the target computer.

The object provides access to methods and properties that:

Start and stop the real-time application.
Read and set parameters.
Log and stream signals.
Retrieve status information about the target computer.
Restart the target computer.
Load the real-time application.
Start, stop, and retrieve information from the profiler.

Function names are case-sensitive. Type the entire name. Property names are not case-sensitive. You do not need to type the entire name if the characters you type are unique for the property.

You can invoke some of the object properties and functions from the target computer command line when the real-time application has been loaded. For more information, see Target Computer Command-Line Interface.

Creation

target_object = slrealtime constructs a target object representing the default target computer.

target_object = slrealtime(target_name) constructs a target object representing the target computer designated by target_name.

The slrealtime function accepts these arguments:

target_name — Name assigned to target computer (character vector or string scalar). For example, 'TargetPC1'.
target_object — Object representing target computer. For example, tg.

Example: Create Target Object for Default Target Computer

Example: Build and Run Real-Time Application

Properties

See Target Object Properties

Object Functions

`addInstrument`	Add instrument object to target object
`clearLogs`	Remove system log file and backup log file on target computer
`clearStartupApp`	Clear startup application selection on target computer
`configureModelForTargetPlatform`	Configure model to build for selected and connectable target computer
`connect`	Connect MATLAB to target computer
`copyPage`	Copy one calibration page to another in the real-time application
`deleteCoreFiles`	Deletes crash stack core files from target computer
`deleteParamSet`	Delete selected parameter set file from an application
`deleteProfilerData`	Delete profiler data from target computer
`deleteTracerData`	Delete tracer data from target computer
`disconnect`	Disconnect MATLAB from target computer
`exportParamSet`	Write `ParameterSet` object data to parameter set file
`getAllInstruments`	Get information on instruments added to target object
`getApplicationFile`	Get name of real-time application file
`getAvailableProfile`	Get list of applications with profiler data available on target computer
`getAvailableTrace`	Get list of application with tracing information available on target computer
`getCrashStack`	Downloads and decodes crash stack core files from target computer and opens these in MATLAB editor
`getCurrentParamSet`	Get current parameter set on target computer
`getDefaultParamSet`	Get default parameter set on target computer
`getECUPage`	Get current page number used by ECU on real-time application
`getInstalledApplications`	Get list of installed real-time application files
`getLastApplication`	Get name of real-time application most recently run on target computer
`getNumPages`	Get number of pages in memory for real-time application
`getparam`	Read value of observable parameter in real-time application
`getPersistentVariables`	Get persistent variables from the Simulink Real-Time target computer to MATLAB
`getProfilerData`	Download profiler data from target computer
`getProfilerStatus`	Get profiler status on target computer
`getsignal`	Read a signal value from a real-time application
`getStartupApp`	Get information about startup application configuration on target computer
`getTargetTime`	Get target computer date and time
`getTargetTimezone`	Get target computer time zone information
`getTracerData`	Download tracer data from target computer
`getTracerStatus`	Get tracer status on target computer
`getVersion`	Get MATLAB and Speedgoat I/O Blockset version information
`getXCPPage`	Get current page number used by XCP on real-time application
`importParamSet`	Create `ParameterSet` object
`install`	Install real-time application on target computer
`isConnected`	Get target computer connected status
`isLoaded`	Get real-time application loaded status
`isRunning`	Get real-time application running status
`listParamSet`	List available parameter set files for application on target computer
`load`	Deploy to target and load real-time application to target computer
`loadParamSet`	Restore parameter values saved in specified file
`loadPreviousParamSetOnAppLoad`	Load autosaved parameter set on application reload
`reboot`	Restart target computer
`removeAllApplications`	Removes all Simulink Real-Time applications from target computer
`removeAllInstruments`	Remove instrument objects from target object
`removeApplication`	Removes Simulink Real-Time application from Speedgoat target computer
`removeInstrument`	Remove selected instrument object from target object
`reset`	Reset target object
`resetProfiler`	Reset profiler on target computer
`resetTracer`	Reset tracer on target computer
`saveParamSet`	Save real-time application parameter values
`setDefaultParamSet`	Set default parameter set on target computer
`setECUAndXCPPage`	Set memory pages used by XCP and ECU to selected memory page on real-time application
`setECUPage`	Set memory page used by ECU to selected memory page on real-time application
`setipaddr`	Set IP address and netmask on the target computer
`setparam`	Change value of tunable parameter in real-time application
`setPersistentVariables`	Set persistent variables from MATLAB to the Simulink Real-Time target computer
`setStartupApp`	Configure startup real-time application for target computer
`setStopTime`	Configure stop time for real-time application
`setTargetTime`	Set target computer date and time
`setTargetTimezone`	Set target computer time zone preference
`setXCPPage`	Set memory page used by XCP to selected memory page on real-time application
`start`	Start execution of real-time application on target computer
`startProfiler`	Start profiler on target computer
`startRecording`	Starts signal data live streaming and File Log logging
`startTracer`	Start tracer on target computer
`status`	Get status of real-time application on target computer
`stop`	Stop execution of real-time application and unload it from the target computer
`stopProfiler`	Stop profiler on target computer
`stopRecording`	Stops signal data live streaming and File Log logging
`stopTracer`	Stop tracer on target computer
`update`	Update RTOS version on target computer

Examples

collapse all

Create Target Object for Default Target Computer

Create a target object that represents the default target computer.

Create target object tg for the default target computer. You can select the default target computer by using Simulink Real-Time Explorer.

tg = slrealtime

Create Target Object for Named Target Computer

Create a target object that represents target computer TargetPC1.

Create target object tg for a target computer by using an explicit name.

tg = slrealtime('TargetPC1')

Build and Run Real-Time Application

Build and download slrt_ex_osc and execute the real-time application.

Open, build, and download the real-time application:

tg = slrealtime;
mdlSTF = getSTFName(tg);
mdlName = 'slrt_ex_osc';
openExample(mdlName);
set_param(mdlName,"SystemTargetFile",mdlSTF);
slbuild(mdlName);
load(tg,mdlName);
start(tg);

Share Target Computer Settings

Use these steps to share target computer settings (TargetSettings property) from one target computer to another.

On a development computer that is connected to the target computer with settings to be shared, create a Target object tg. Create a variable s that holds settings from the Target object. Save the settings to a MAT file tgSettingsShared.mat.
```
tg = slrealtime;
s = tg.TargetSettings;
save("tgSettingsShared","s");
```
On a development computer that is connected to the target computer where the settings are to be applied to another target computer, load the MAT file tgSettingsShared.mat and create a Targets object tgs.
```
load('tgSettingsShared.mat');
tgs=slrealtime.Targets();
```
If the target computer name (for example, TargetPC3) already exists on the development computer, remove it. This step is needed because if the name exists then it is reset to empty when applying the settings from variable s. If the target computer name does not already exist, you can skip this step.
```
removeTarget(tgs,'TargetPC3');
```
If using a different target computer name than the original, define the target computer name in variable s. Apply the target computer settings.
```
% If using a different target computer name, 
% define the name in s. For example:
% s.name = 'TargetPC4';
tgs.addTarget(s);
```

Version History

Introduced in R2020b

expand all

R2022b: Removed and Added Target Object Functions

Removed the isRecording utility function from the Target object.

These Target object utility functions have been added: deleteParamSet and removeAllApplications.

R2021b: Additional Target Object Functions

These Target object utility functions have been added: deleteParamSet, getAllInstruments, getApplicationFile, getInstalledApplications, getLastApplication, isConnected, isLoaded, isRunning, and removeAllApplications, reset.

These Target object ECU and XCP memory page functions have been added: copyPage, getECUPage, getNumPages, getXCPPage, setECUAndXCPPage, setECUPage, and setXCPPage. To support these functions, the default storage class for new models has changed from default to PageSwitching for model parameters and external parameters.