PUT start

Start real-time application on target computer

Since R2026a

collapse all in page

Syntax

curl -i -X PUT http://username:password@address:port/applications/start?Name-Value Pair Arguments
curl -i -k -X PUT https://username:password@address:port/applications/start?Name-Value Pair Arguments

Description

curl -i -X PUT http://username:password@address:port/applications/start?Name-Value Pair Arguments starts execution of the loaded real-time application file on the target computer.

example

curl -i -k -X PUT https://username:password@address:port/applications/start?Name-Value Pair Arguments starts execution of the loaded real-time application file on the target computer by using HTTPS secure protocol. The additional -k option for the curl command directs the connection to accept a self-signed certificate. For information about creating certificate and key files and enabling HTTPS support, see setupTLSCertificate.

example

Examples

collapse all

At the system prompt, use the curl PUT command to start execution of an installed and loaded real-time application on the target computer. In this command, user slrt with password slrt is commanding the target computer at IP address 192.168.7.20 and port 8080 to start execution of the installed and loaded real-time application file. The command also sets the stop time for the application to 100.

curl -i -X PUT http://slrt:slrt@192.168.7.20:8080/applications/start?stoptime=100
HTTP/1.1 200 OK
Server: Boost.Beast/300
Content-Type: application/json
Set-Cookie: sessionId=800109273c07e3209765a56b38972e40; Expires=Tue, 26-Aug-2025 14:44:13 GMT; Path=/applications/start?stoptime=100; HttpOnly
Content-Length: 151

{"application":"slrt_ex_osc","modelName":"slrt_ex_osc","state":"RUNNING","stopTime":100,"logLevel":"info","pollingThreshold":0.0001,"fileLogMaxRuns":1}

The status for the start of application slrt_ex_osc which was generated from model slrt_ex_osc is RUNNING. Additional status information includes the application options: stop time, log level, polling threshold and file log max runs.

Input Arguments

collapse all

The name of the user with access to run the command on the target computer.

Example: slrt

The password of the user with access to run the command on the target computer.

Example: slrt

The IP address of the target computer.

Example: 172.20.146.111

The port number used by the target computer.

Example: 8080

Name-Value Arguments

collapse all

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Example: stoptime=100

The Stop time parameter specifies the stop time for the simulation or generated code in seconds, as a double-precision value. For information about stop time values, see Stop time.

Example: stoptime=100

For information about log level values, see Log level.

Example: loglevel=info

For information about polling threshold values, see Force polling mode.

Example: pollingthreshold=0.0001

For information about file log max run values, see Max file log runs.

Example: filelogmaxruns=1

Selects filtering level that limits Simulink® Real-Time™ target computer system messages that appear in the system log. For more information, see Simulink Real-Time Options Pane.

Example: LogLevel=info

The real-time application is clocked by a timer interrupt, unless the base sample rate is equal to or below the polling threshold (default is 100 μs). If the base sample rate is less than or equal to the threshold, the real-time application is clocked in polling mode.

Example: PollingThreshold=100

Select the number of file logs to retain when logs are stored on the target computer instead of uploaded to the development computer after each simulation run.

Note

You can inadvertently delete existing file logs for an installed real-time application on the target computer if you use the slrealtime.Application function to change the Options for FileLogMaxRuns and then reload the application. To change the number of stored logs without deleting existing logs, load the real-time application and then change the FileLogMaxRuns option by using the start(tg) function.

Example: FileLogMaxRuns=1

Select whether stimulation of root inports and Playback blocks starts when you start the real-time application.

Example: StartStimulation=on

Select stop time value for the real-time application.

Example: StopTime=Inf

Direct Simulink Real-Time to reload the real-time application on the target computer after the application stops.

Example: ReloadOnStop=false

Select whether the file log data is uploaded to the Simulation Data Inspector on the development computer after the real-time application stops.

If a model includes a Enable File Log block, the start(tg) AutoImportFileLog option has no effect, and the startRecording function and stopRecording function only control signal streaming (not File Log logging).

Example: AutoImportFileLog=true

Select whether the file log data is uploaded the Simulink base workspace on the development computer after the real-time application stops

Example: ExportToBaseWorkspace=true

Version History

Introduced in R2026a

See Also

| | | |

Topics