Port MODELACCESS - DEFAULT¶

Default

Stimulation¶

DataFileSegment:

  • An absolute path must be provided

  • Only MAT and MF4 can be referenced

SignalValueSegment:

  • A relative path must be provided

Supported execution modes¶

See also: Specifics of time modes

Preferred time source/mode: Real-time

Real-time:

To use real-time mode, the Test configuration in the Execution tab must be configured as the source ‘real time’.

Stepwise simulation time:

To use the stepwise simulation mode, the port in the Test configuration in the Execution tab must be selected and the mode set to ‘stepwise’.

Info

The following modes are not supported: Continuous simulation time

Specifics¶

  • To use the default model port port, you will need a “Platform API License” for ControlDesk. You can check the licenses in the “Licensing” tab of the dSPACE Installation Manager.

  • If you are using the simulation time mode, the simulation time is acquired from the variable <activeValueDescription>/Simulation and RTOS/Simulation/SimulationTime which needs to be available in your model.

Configuration

The “Platform Name” must always be configured so that ecu.test can access the model. Please note that this option is case-sensitive. The correct identifier can be inspected in a started ControlDesk experiment under Platforms -> Manage Platforms. All other settings are optional. In particular the setting “Model file” should usually be left empty since it is inherited from the test configuration. If you want to connect to an already configured and started ControlDesk, the option “Always reload model” should be set to “Do not download”.

Info

Real-time package references are no longer supported. Use the RTT sequence administration test step instead, or execute your own Python real-time scripts via the ExecuteTargetScript port job.

Name

Available if

Default value

Valid values

Type

Description

Platform name

‘SCALEXIO’

string

Name of the platform as specified in the Experiment. Alternatively the platform name in the ControlDesk Platform Management can be used.

dSPACE RTT Version

‘<auto>’

[‘1.7’, ‘1.8’, ‘1.9’, ‘2.0’, ‘2.1’, ‘2.2’, ‘2.3’, ‘2.4’, ‘2.5’, ‘2.6’, ‘3.0’, ‘3.1’, ‘3.2’, ‘3.3’, ‘3.4’, ‘4.0’, ‘4.1’, ‘4.2’, ‘4.3’, ‘4.4’, ‘5.0’, ‘5.1’, ‘5.2’, ‘22.2’, ‘23.1’, ‘23.2’, ‘24.1’, ‘<auto>’]

string

Product version of dSPACE Real-Time Testing

Online model query

☐

bool

(De-)Activates the interface for online querying of model information by the test configuration, including the list of available parameters and signals. If the property is enabled, the information is queried from the tool at runtime. If disabled, the model file is parsed instead.

Model file

uri

Path relative to the model directory

Loading behavior on reduced compatibility

‘cancel’

[‘cancel’, ‘fix and download’, ‘ignore’]


Display values:

  • ‘cancel’: ‘Cancel’

  • ‘fix and download’: ‘Fix reduced compatibility and download’

  • ‘ignore’: ‘Ignore reduced incompatibility’

string

Behavior of loading on reduced compatibility between model and SCALEXIO System

Always reload model

‘download’

[‘download’, ‘no download’]


Display values:

  • ‘download’: ‘Download always’

  • ‘no download’: ‘Do not download’

string

If this setting is set to Download always (default value), an already loaded model will be unloaded and the selected model will be reloaded. If the setting is Do not download, an already loaded model will not be unloaded. ControlDesk will return an error message, if the loaded model does not correspond to the selected model.

Start model

‘start’

[‘start’, ‘no start’]


Display values:

  • ‘start’: ‘Start’

  • ‘no start’: ‘Do not start’

string

Automatic startup of the model after loading

Model reset behavior

‘never’

[‘on test start’, ‘never’]


Display values:

  • ‘on test start’: ‘On start of test’

  • ‘never’: ‘Never’

string

Resets the model at each package start if set to “On start of test”. This will reload the model to the platform and reinitialize the XIL MA port. Measurement and online calibration are temporarily stopped. Automatic reset requires automatic “Download always” to be enabled in property “Always reload model”.

Recording task

‘Tool-Default’

string

Recording acquisition rate to use as fallback, if there is no given acquisition rate for the test value (’*’ and ‘?’ may be used as wildcards).

“Tool-Default” uses the first available acquisition rate.

Use common recorder

☐

bool

Defines whether signals of this port should be recorded together with those of other ports of this tool. This guarantees a common time base and creates a single recording file. Otherwise a separate recording file is created.

ExecuteTargetScript¶

Loads a target script to the target system and executes it. The execution time is limited by the tool’s setting “Timeout for tool call”. If you specify input or ouput parameters, you must create an XML configuration file with the same file name as the script. For example, “scripts/rtt_script.py” expects the configuration file “scripts/rtt_script.xml”. You can find sample configurations in the dSpace XIL examples.

Parameterization

Parameter

Name

Available if

Default value

Valid values

Type

Description

customProperties

{}

object

Custom properties for Target Script as dictionary, e.g. {“ApplicationProcessor”: “leaderAppl”}.

inputParameters

{}

object

Input parameters for Target Script as dictionary {“parameterName”: “parameterValue”}. Only primitive data types are supported.

outputParameterNames

[]

object

List of output parameters to be returned. These are read from the target script after execution. To be entered as a list of strings. Only primitive data types are supported.

targetScriptPath

uri

Absolute or relative path to target script on this machine. Relative paths are resolved relative to the workspace directory.

Return value

Name

Available if

Default value

Valid values

Type

Description

result

object

Values of output parameters as dictionary {“outputParameter”: “valueAfterExecution”}. The target script parameters to be returned need to be specified before execution with the respective job parameter.

GetStimulationState¶

GetStatus of stimulation

Parameterization

Parameter

Name

Available if

Default value

Valid values

Type

Description

InstanceIdentifier

string

Instance identifier of the stimulus of which to query the state.

Return value

Name

Available if

Default value

Valid values

Type

Description

return

string

‘configuration’, ‘ready’, ‘running’, ‘paused’, ‘finished’, ‘stopped’, ‘not started’ or ‘unkown: <SignalGeneratorState>’

ReadVariable¶

Read model variables

Parameterization

Parameter

Name

Available if

Default value

Valid values

Type

Description

VariablePath

uri

full model path

WriteVariable¶

Write model variables

Parameterization

Parameter

Name

Available if

Default value

Valid values

Type

Description

Value

string

VariablePath

uri

full model path