dSPACE: MotionDesk¶

Legacy/internal identifier: MOTIONDESK

Vendor information

Vendor	Web page	Product name	Version
dSPACE	http://www.dspace.com	MotionDesk	dSPACE Release 2018A - 2019B

Operating system	Support
Windows	✓
Linux

Properties 🛈¶

Name	Available if	Default value	Valid values	Type	Description
Load mode		Use currently loaded project and experiment	[Use currently loaded project and experiment, Use currently loaded project and load new experiment, Load new project and experiment]	string
MotionDesk experiment	Load mode: ‘Use currently loaded project and load new experiment’			string	Name of the MotionDesk experiment to be activated in the specified MotionDesk project.
Project directory	Load mode: ‘Load new project and experiment’			string	Base directory for searching MotionDesk project files (*.cdp) on the tool host (absolute or relative to the base path of the tool host)
MotionDesk project	Load mode: ‘Load new project and experiment’			string	MotionDesk project (*.cdp) to load (relative to project directory)
MotionDesk experiment	Load mode: ‘Load new project and experiment’			string	Name of the MotionDesk experiment to be activated in the specified MotionDesk project.
Exit tool		☐		bool	Stops MotionDesk when the configuration shuts down.
Timeout for tool call ❲in sec.❳		‘600’		string	Timeout after which a tool call is aborted.

Jobs 🛈¶

DownloadScene¶

Downloads a scene to a running SensorSim instance. Returns True if successful.

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool

ReadParameter¶

Executes an arbitrary API path given as string and returns its result. The base of the path can be configured by using the BaseElement parameter.

Example call:

ApiPath: ‘VisualizationManagement.Views.HorizontalSplitterPosition’

-> Returns value of horizontal splitter

Parameter

Name	Available if	Default value	Valid values	Type	Description
ApiPath				string	API command path
BaseElement		‘Active Experiment’	[‘Root’, ‘Active Experiment’]	string	Base element for the API path

Return value

Name	Available if	Default value	Valid values	Type	Description
result				object

StartAnimation¶

Starts a MotionDesk animation and takes MotionDesk online. Returns True if successful.

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool

StartSensorSimConnections¶

Starts the specified SensorSim connections. If no connection identifiers are specified, all registered connections will be started.

Parameter

Name	Available if	Default value	Valid values	Type	Description
ConnectionIdentifier				string	Comma-separated list of identifiers of SensorSim connections to be started.

StopAnimation¶

Stops a MotionDesk animation and takes MotionDesk offline. Returns True if successful.

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool

StopSensorSimConnections¶

Stops the specified SensorSim connections. If no connection identifiers are specified, all registered connections will be stopped.

Parameter

Name	Available if	Default value	Valid values	Type	Description
ConnectionIdentifier				string	Comma-separated list of identifiers of SensorSim connections to be stopped.

WriteParameter¶

Executes an arbitrary API path given as string and, writes a given value and returns its new result. The base of the path can be configured by using the BaseElement parameter.

Example call:

ApiPath: ‘VisualizationManagement.Views.HorizontalSplitterPosition’

Value: 30

-> Sets the value of the horizontal splitter to value 30.

Parameter

Name	Default value	Valid values	Type	Description
ApiPath			string	API command path
BaseElement	‘Active Experiment’	[‘Root’, ‘Active Experiment’]	string	Base element for the API path
Value			object	Value

Return value

Name	Available if	Default value	Valid values	Type	Description
result				object