You are on page 1of 206

ControlDesk

Introduction and Overview


For ControlDesk 6.3

Release 2018-A – May 2018


How to Contact dSPACE
Mail: dSPACE GmbH
Rathenaustraße 26
33102 Paderborn
Germany
Tel.: +49 5251 1638-0
Fax: +49 5251 16198-0
E-mail: info@dspace.de
Web: http://www.dspace.com

How to Contact dSPACE Support


If you encounter a problem when using dSPACE products, contact your local dSPACE
representative:
§ Local dSPACE companies and distributors: http://www.dspace.com/go/locations
§ For countries not listed, contact dSPACE GmbH in Paderborn, Germany.
Tel.: +49 5251 1638-941 or e-mail: support@dspace.de

You can also use the support request form:


http://www.dspace.com/go/supportrequest. If you are logged on to mydSPACE, you
are automatically identified and do not need to add your contact details manually.

If possible, always provide the relevant dSPACE License ID or the serial number of the
CmContainer in your support request.

Software Updates and Patches


dSPACE strongly recommends that you download and install the most recent patches
for your current dSPACE installation. Visit http://www.dspace.com/go/support for
software updates and patches.

Important Notice
This document contains proprietary information that is protected by copyright. All
rights are reserved. The document may be printed for personal or internal use provided
all the proprietary markings are retained on all printed copies. In all other cases, the
document must not be copied, photocopied, reproduced, translated, or reduced to any
electronic medium or machine-readable form, in whole or in part, without the prior
written consent of dSPACE GmbH.

© 2010 - 2018 by:


dSPACE GmbH
Rathenaustraße 26
33102 Paderborn
Germany

This publication and the contents hereof are subject to change without notice.

ConfigurationDesk, ControlDesk, MicroAutoBox, MicroLabBox, SCALEXIO, SYNECT,


SystemDesk, TargetLink and VEOS are registered trademarks of dSPACE GmbH in the
United States or other countries, or both. Other brand names or product names are
trademarks or registered trademarks of their respective companies or organizations.
Contents

Contents

About This Document 7


Conventions Used in dSPACE User Documentation................................ .............. 8
Accessing dSPACE Help and PDF Files................................................................... 9
Related Documents............................................................................................ 10

Safety Precautions and Legal Information 13


General Warning When Using the ControlDesk Software................................... 14
General Warning When Using the Internal Bypass Plug-In for the RTI
Bypass Blockset.................................................................................................. 16
Warning About Using a dSPACE ECU Interface...................................... ............ 17
Important Information when Monitoring and Logging Ethernet Traffic............... 20
Legal Information on ASAM Binaries and ASAM Documentation........................ 21

New Features of ControlDesk 23


New Key Features of ControlDesk 6.3................................................................ 23

Introduction to ControlDesk 25
Basics of ControlDesk..................................................................................... ............ 26
About ControlDesk............................................................................................ 26
Software Versions and Modules......................................................................... 27
How to Start ControlDesk.................................................................................. 30

Working with the User Interface of ControlDesk......................................................... 32


User Interface of ControlDesk............................................................................ 33
Basics on Ribbons.............................................................................................. 42
How to Customize the Quick Access Toolbar...................................................... 45
How to Customize the Screen Arrangement.......................................... ............ 47

Working in Operator Mode......................................................................................... 49


Basics on the Operator Version and Operator Mode........................................... 49
Operator Mode Functionalities........................................................................... 50
Preparing an Experiment for Use in Operator Mode............................... ............ 53
How to Switch ControlDesk to the Operator Mode............................................ 53

Getting Support.......................................................................................................... 56
Getting Support................................................................................................. 56

3
May 2018 ControlDesk Introduction and Overview
Contents

Demos for ControlDesk 57


Demo Projects............................................................................................................. 58
Basics on Demo Projects..................................................................................... 58
Bus Navigator Demo.......................................................................................... 61
CalDemo........................................................................................................... 70
ECU Diagnostics Demo...................................................................................... 73
Real-Time Application Demos................................................................ ............ 82
Relay Maintenance Demo...................................................................... ............ 84
Signal Editor Demos........................................................................................... 84
XIL API EESPort Demo........................................................................................ 88

Automation Demos..................................................................................................... 90
Basics on Automation Demos............................................................................. 90
Tool Automation Demos.................................................................................... 91
MC3 Demos...................................................................................................... 94
D3 Demo........................................................................................................... 96
Measurement Data API Demos........................................................................... 97

Demo Devices............................................................................................................. 99
CalDemo ECU.................................................................................................... 99
CANGenerator................................................................................................. 101

Compatibility, Migration and Discontinuations 103


Compatibility of ControlDesk.................................................................................... 104
Compatibility of ControlDesk 6.3..................................................................... 104
Compatibility of Firmware................................................................................ 105
Compatibility of Real‑Time Testing................................................................... 106

Migrating from Prior Versions of ControlDesk............................................................ 110


Basics on Migrating from Prior Versions of ControlDesk.................................... 111
Migrating from ControlDesk 4.0 to 4.1............................................................ 112
Migrating from ControlDesk 4.1 to 4.2.x.......................................................... 114
Migrating from ControlDesk 4.2.x to 4.3.......................................................... 116
Migrating from ControlDesk 4.3 to 5.0............................................................ 117
Migrating from ControlDesk 5.0 to 5.1............................................................ 120
Migrating from ControlDesk 5.1 to 5.2............................................................ 127
Migrating from ControlDesk 5.2 to 5.3............................................................ 131
Migrating from ControlDesk 5.3 to 5.4............................................................ 132
Migrating from ControlDesk 5.4 to 5.5............................................................ 133
Migrating from ControlDesk 5.5 to 5.6............................................................ 138
Migrating from ControlDesk 5.6 to 6.0............................................................ 142

4
ControlDesk Introduction and Overview May 2018
Contents

Migrating from ControlDesk 6.0 to 6.1............................................................ 147


Migrating from ControlDesk 6.1 to 6.2............................................................ 149
Migrating from ControlDesk 6.2 to 6.3............................................................ 154

Discontinuations in ControlDesk..................................................................... .......... 156


Discontinuations as of ControlDesk 4.1............................................................ 156
Discontinuations as of ControlDesk 5.0............................................................ 157
Discontinuations as of ControlDesk 5.1............................................................ 157
Discontinuations as of ControlDesk 5.2............................................................ 157
Discontinuations as of ControlDesk 5.3............................................................ 158
Discontinuations as of ControlDesk 5.4............................................................ 158
Discontinuations as of ControlDesk 5.6............................................................ 158
Discontinuations as of ControlDesk 6.0............................................................ 160
Discontinuations as of ControlDesk 6.1............................................................ 162
Discontinuations as of ControlDesk 6.2............................................................ 163
Discontinuations as of ControlDesk 6.3............................................................ 163

Tutorials, Tutorial Videos, and PDF Documents 165


Tutorials for ControlDesk.................................................................................. 165
Tutorial Videos for ControlDesk........................................................................ 166
PDF Documents for ControlDesk...................................................................... 167

Glossary 169

Index 205

5
May 2018 ControlDesk Introduction and Overview
Contents

6
ControlDesk Introduction and Overview May 2018
About This Document

About This Document

Contents This document introduces you to ControlDesk.

Required knowledge Knowledge in handling the PC and the Microsoft Windows operating system is
assumed.

Legal information Note

Legal Information on ASAM binaries and ASAM documentation

dSPACE GmbH draws your attention to the fact that installing dSPACE
software also installs components that are licensed and released by ASAM
e.V. (Association for Standardisation of Automation and Measuring
Systems).

dSPACE GmbH hereby confirms that dSPACE is a member of ASAM and as


such entitled to use these licenses and to install the ASAM binaries and the
ASAM documentation together with the dSPACE software.

The customer is not authorized to pass the ASAM binaries and the ASAM
documentation to third parties without permission. For more information,
see http://www.asam.net/license.html.

Where to go from here Information in this section

Conventions Used in dSPACE User Documentation .................................. 8

Accessing dSPACE Help and PDF Files ...................................................... 9

Related Documents ............................................................................... 10

7
May 2018 ControlDesk Introduction and Overview
About This Document

Conventions Used in dSPACE User Documentation

Symbols dSPACE user documentation uses the following symbols:

Symbol Description
Indicates a hazardous situation that, if not avoided,
V DANGER will result in death or serious injury.
Indicates a hazardous situation that, if not avoided,
V WARNING could result in death or serious injury.
Indicates a hazardous situation that, if not avoided,
V CAUTION could result in minor or moderate injury.
Indicates a hazard that, if not avoided, could result in
NOTICE
property damage.
Indicates important information that you should take
Note
into account to avoid malfunctions.
Indicates tips that can make your work easier.
Tip
Indicates a link that refers to a definition in the
glossary, which you can find at the end of the
document unless stated otherwise.
Precedes the document title in a link that refers to
another document.

Naming conventions dSPACE user documentation uses the following naming conventions:

%name% Names enclosed in percent signs refer to environment variables for


file and path names.

<> Angle brackets contain wildcard characters or placeholders for variable


file and path names, etc.

Special folders Some software products use the following special folders:

Common Program Data folder A standard folder for application-specific


configuration data that is used by all users.
%PROGRAMDATA%\dSPACE\<InstallationGUID>\<ProductName>
or
%PROGRAMDATA%\dSPACE\<ProductName>\<VersionNumber>

Documents folder A standard folder for user-specific documents.


%USERPROFILE%\My Documents\dSPACE\<ProductName>\
<VersionNumber>

8
ControlDesk Introduction and Overview May 2018
Accessing dSPACE Help and PDF Files

Local Program Data folder A standard folder for application-specific


configuration data that is used by the current, non-roaming user.
%USERPROFILE%\AppData\Local\dSPACE\<InstallationGUID>\
<ProductName>

Accessing dSPACE Help and PDF Files

Introduction After you install and decrypt your dSPACE software, the documentation for the
installed products is available as online help in dSPACE Help and as Adobe® PDF
files.

Online help There are various ways to open dSPACE Help.

Note

Not all the ways to open dSPACE Help are available for all dSPACE software
products.

Opening from Windows You can open dSPACE Help on its home page:
§ Via Windows Start Menu

Opening from dSPACE software with menu bar You can open dSPACE
Help on a product's start page:
§ Via the menu bar in a dSPACE product

Opening from dSPACE software with ribbons If you use dSPACE software
with ribbons, you can open dSPACE Help:
§ Via the Start page in dSPACE software
§ Via the Backstage view in dSPACE software (leftmost ribbon tab)
§ Via the button

Opening context-sensitive help dSPACE Help provides context-sensitive


help. You can open help on the currently active context in dSPACE software:
§ Via F1
§ Via the Help button

9
May 2018 ControlDesk Introduction and Overview
About This Document

PDF files You can open the PDF files as follows:

Opening from a topic in dSPACE Help You can access the PDF file with the
current topic via the button at the topic's top right. The following illustration
shows an example:

The PDF document opens on its first page.

Opening from dSPACE software with ribbons If your dSPACE software


has a user interface with ribbons, you can open a folder that contains the user
documentation in PDF format via the button in the Backstage view (leftmost
ribbon tab).

Related Documents

Related documents Below is a list of documents that you are recommended to read when working
with ControlDesk:

Information in other documents

dSPACE Release documentation


New Features and Migration
Provides information on the new features of all the dSPACE software
products in the current dSPACE Release. It also gives you an overview of
software products with no or minor changes. There are instructions on
migrating from older dSPACE Releases, especially from older product
versions, if required.

ControlDesk introduction and overview


ControlDesk Introduction and Overview ............................................. 1
Introduces ControlDesk.

10
ControlDesk Introduction and Overview May 2018
Related Documents

ControlDesk basic practices


ControlDesk Project and Experiment Management
In ControlDesk, projects and experiments allow you to carry out and
structure experimental tasks according to your needs.

ControlDesk Platform Management


In ControlDesk, platforms/devices are used for carrying out calibration,
prototyping, measurement, and/or ECU diagnostics tasks. A ControlDesk
platform/device is the software representation of a hardware component
(dSPACE real-time hardware, ECU, or DAQ module) or a VPU.

ControlDesk Variable Management


ControlDesk lets you handle the variables of the variable descriptions of
platforms and devices.

ControlDesk Layouting
ControlDesk layouts are used for visualizing variables in instruments.

ControlDesk Instrument Handling


You can use ControlDesk's instruments to visualize the values of
measurement variables and change the values of parameters.

ControlDesk Calibration and Data Set Management


ControlDesk allows you to calibrate parameter values on dSPACE real-
time hardware, on VPUs, and on ECUs.
ControlDesk's data set management lets you handle data sets, which are
complete sets of the parameters of, for example, an ECU.

ControlDesk Measurement and Recording


ControlDesk provides a number of functions for measuring and recording
data.

ControlDesk User Interface Handling


ControlDesk's user interface provides various commands and dialogs,
which are accessible via the ribbon and the context menus of the
ControlDesk components.

ControlDesk Message Handling


ControlDesk lets you handle messages such as errors and warnings.

ControlDesk advanced practices


ControlDesk Automation
ControlDesk lets you automate most of its features via its automation
interface.

ControlDesk Bus Navigator


You can use ControlDesk's Bus Navigator to handle CAN messages, LIN
frames, FlexRay PDUs, and Ethernet packets.

ControlDesk Customization
ControlDesk can be customized.

11
May 2018 ControlDesk Introduction and Overview
About This Document

ControlDesk ECU Diagnostics


The ControlDesk ECU Diagnostics Module lets you communicate with an
ECU via the diagnostic interface.

ControlDesk Electrical Error Simulation via XIL API EESPort


Electrical error simulation is used to disturb the signals that are
transmitted between a hardware-in-the-loop (HIL) simulator and a device
under test (DUT), which is usually an ECU.

ControlDesk MCD-3 Automation


ControlDesk's ASAM MCD-3 compatible interface lets you automate
calibration, measurement, and diagnostic tasks.

ControlDesk Measurement Data API


ControlDesk's Measurement Data API lets you view and edit the content
of measurement data files.

ControlDesk Signal Editor


ControlDesk's Signal Editor lets you edit signal description sets to be
used as signal generators for stimulating model variables of simulation
applications.

12
ControlDesk Introduction and Overview May 2018
Safety Precautions and Legal Information

Safety Precautions and Legal Information

Introduction To avoid risk of injury and/or damage to the dSPACE hardware, read and ensure
that you comply with the following safety precautions. These precautions must
be observed during all phases of system operation.

Where to go from here Information in this section

General Warning When Using the ControlDesk Software ....................... 14


Note the warning when using the ControlDesk software.

General Warning When Using the Internal Bypass Plug-In for the
RTI Bypass Blockset ................................................................................ 16
Note the warning when using the Internal Bypass Plug-In for the RTI
Bypass Blockset.

Warning About Using a dSPACE ECU Interface ...................................... 17


Note the warning when using a dSPACE ECU interface.

Important Information when Monitoring and Logging Ethernet


Traffic .................................................................................................... 20
ControlDesk provides means to monitor and log Ethernet traffic on a low
protocol level to support the development of ECUs communicating over
Ethernet (e.g., for ADAS scenarios). This makes it possible for
ControlDesk to log the entire Ethernet traffic between the PC and the
respective network segment.

Legal Information on ASAM Binaries and ASAM Documentation ........... 21


Legal information on ASAM binaries and ASAM documentation

13
May 2018 ControlDesk Introduction and Overview
Safety Precautions and Legal Information

General Warning When Using the ControlDesk Software

Introduction Note the following warning when using the ControlDesk software.

Danger potential V WARNING

Risk of serious injury and/or property damage

Using this product can be dangerous. You must observe the


following safety instructions and the relevant instructions in the
user documentation.

Using the ControlDesk software can have a direct effect on networked


electronic systems connected to it.

Improper or negligent use can result in serious personal injury


and/or property damage.

Only persons who are qualified to use this software, and who have
been informed of the above dangers and possible consequences, are
permitted to use this product.

ControlDesk provides advanced features to send messages to a connected


network (CAN, Ethernet, FlexRay, LIN) and all connected network nodes or
to modify ECU memory content directly. Using these features increases the
risk of property damage or personal injury, as ControlDesk cannot detect
operating errors made by the user.

When ControlDesk is controlled via an automation interface, the risk of


property damage or personal injury also exists. ControlDesk is then part of
an overall system and may not be visible to the end user. It nevertheless
produces a direct effect on the technical system or networked electronic
system via the controlling application that uses the automation interface.

14
ControlDesk Introduction and Overview May 2018
General Warning When Using the ControlDesk Software

V WARNING

Risk of serious injury and/or property damage

When the Signal Editor is used, it downloads signal generators directly to


the dSPACE real-time processor. These run in parallel to the real-time
application until they are stopped explicitly (closing the ControlDesk
program is not sufficient to stop running signal generators). Signal
generators directly affect the output behavior of the dSPACE hardware at
run time without any further user interaction or user notification.

When work is carried out with ECUs, ControlDesk complies with the ASAM-
MCD 2 standard, and therefore provides suitable measures for avoiding
dangerous situations, including but not only by specifying limits for the
system's parameters. The user can and should take such measures to
minimize the danger involved in influencing the system.

When the Variable Editor is used, variable descriptions can be created or


modified. Accessing networked electronic systems connected to
ControlDesk using an incorrect variable description may lead to
unforeseeable system behavior with an increased risk of property damage or
personal injury. Correct specification of variable descriptions and responsible
use of safety measures such as system parameter limits are therefore crucial
and are the sole responsibility of the user.

All technical systems interfaced by ControlDesk where malfunctions or


misoperation involve the danger of injury or death must be examined for
potential hazards by the user, who must if necessary take additional
measures for protection (for example, an emergency off switch).

Liability It is your responsibility to adhere to instructions and warnings. Any unskilled


operation or other improper use of this product in violation of the respective
safety instructions, warnings or other instructions contained in the user
documentation constitutes contributory negligence, which may lead to a
limitation of liability by dSPACE GmbH, its representatives, agents and local
dSPACE companies, to the point of total exclusion, as the case may be. Any
exclusion or limitation of liability according to other applicable regulations,
individual agreements and applicable general terms and conditions remain
unaffected.

Data loss during operating The shutdown procedure of Microsoft Windows operating systems causes some
system shutdown required processes to be aborted although they are still being used by dSPACE
software. To avoid data loss, the dSPACE software must be terminated manually
before a PC shutdown is performed.

15
May 2018 ControlDesk Introduction and Overview
Safety Precautions and Legal Information

General Warning When Using the Internal Bypass Plug-In for the RTI Bypass
Blockset

Introduction Note the following warning when using the Internal Bypass Plug-In for the RTI
Bypass Blockset.

Danger potential Using this product can be dangerous. You must observe the following safety
instructions and the relevant instructions in the user documentation.

V WARNING

Improper or negligent use can result in serious personal injury


and/or property damage.

The Internal Bypass Plug-In for the RTI Bypass Blockset allows the
integration of function code and associated data in ECU image and ECU
variable description files. Programming ECUs with these image files and
accessing ECUs via calibration tools with these ECU description files can
have a direct effect on networked electronic systems and may lead to
unforeseeable system behavior with an increased risk of property damage or
personal injury.

Only persons who are qualified to use the Internal Bypass Plug-In for
the RTI Bypass Blockset, who have been informed about the above
dangers, and who are able to assess the possible consequences to
take appropriate precautions, are permitted to use this product.

All applications where malfunctions or misoperation involve danger of


property damage, injury or death must be examined for potential hazards
by the user, who must if necessary take additional measures for protection,
for example, by implementing an emergency off switch, and/or by clearly
labeling files to prevent original ECU image and ECU description files being
confused with those modified by the Internal Bypass Plug-In for the
RTI Bypass Blockset.

Liability It is your responsibility to adhere to instructions and warnings. Any unskilled


operation or other improper use of this product in violation of the respective
safety instructions, warnings or other instructions contained in the user
documentation constitutes contributory negligence, which may lead to a
limitation of liability by dSPACE GmbH, its representatives, agents and local
dSPACE companies, to the point of total exclusion, as the case may be. Any
exclusion or limitation of liability according to other applicable regulations,
individual agreements and applicable general terms and conditions remain
unaffected.

16
ControlDesk Introduction and Overview May 2018
Warning About Using a dSPACE ECU Interface

Warning About Using a dSPACE ECU Interface

Introduction Note the following warning when using a dSPACE ECU interface.

Danger potential Connecting a dSPACE ECU interface to devices such as an electronic control unit
can affect system behavior. This can lead to unexpected or critical situations, or
even constitute a risk of death. Therefore, only persons who are qualified to use
dSPACE ECU interfaces, and who have been informed of the dangers and
possible consequences, are permitted to use the interfaces.

Any damage to or malfunction of dSPACE hardware caused by improper


installation is not covered by the warranty, unless the handling and installation
instructions are shown to be defective.

Before integrating an interface and starting operation, read the warnings in this
document carefully.

V WARNING

Risk of serious injury or death due to electrical shock

dSPACE ECU interfaces are designed to be connected to devices that do not


transmit hazardous voltages. According to the EN 61010 standard, a voltage
higher than 33 VRMS/ 46.7 VPEAK AC and 70 V DC is classified as hazardous.
It constitutes a risk of serious injury or even death.

Make sure that your system provides safety provisions so that no


hazardous voltages are applied to a dSPACE ECU interface, even in
the event of electrical faults.

If there is a risk of hazardous voltages being applied to a dSPACE ECU


interface, for example, when it is connected to an engine ECU which
typically generates transient hazardous voltages for ignition, one of the
following measures must be taken to avoid the risk of serious injury or
death due to electrical shock:
§ dSPACE ECU interfaces and all devices connected to them must be within
a separate test area according to the locally valid safety standards for the
installation and operation of electrical test equipment.
§ dSPACE provides dedicated interface cables to ensure an electrically safe
connection to the host PC for systems featuring voltages up to 300 V
DC/ACRMS, or 600 Vpeak. These cables must be used to connect dSPACE
ECU interfaces to the host PC. The dSPACE ECU interfaces and the
devices connected to them must be within a separate test area. When the
above-mentioned cables are used, the host PC can be located outside the
test area.

17
May 2018 ControlDesk Introduction and Overview
Safety Precautions and Legal Information

NOTICE

Protecting dSPACE ECU interfaces against electrical discharge

Depending on your order, a dSPACE ECU interface such as the DCI‑GSI1 is


delivered without an enclosure. Such an interface can be damaged or
destroyed by electrical discharge. Each interface must be kept in its storage
package until it is installed. The interface should be taken out of its
package, configured, and installed only at a workplace that is protected
against electrical discharge.

This warning does not apply to the following interfaces:


§ DCI-CAN1
§ DCI‑CAN2
§ DCI-CAN/LIN1
§ Calibration Hub
§ DCI‑KLine1

These interfaces always come with an enclosure protecting them against


electrical discharge.

Guidelines for safe in-vehicle Any in-vehicle use of dSPACE products in line with the contractual purposes
use of dSPACE products requires the use of enclosed test tracks that are specially safety-secured for the
specific purpose: i.e., with appropriately restricted access and further appropriate
safety measures.

If you intend to use dSPACE products outside enclosed tracks, you have to check
with the relevant authorities in your country under which circumstances this is
possible. You and the local authorities involved bear full responsibility for such
use.

You must take appropriate measures to ensure that the overall system enters a
safe state if a dangerous situation occurs: e.g., by implementing emergency
shutdown or a limp-home mode. This especially applies in the following cases:
§ Where safety-critical interventions that affect vehicle behavior are performed:
e.g., the stimulation of a bus system such as CAN, or the calibration or
bypassing of in-vehicle electronic control units (ECUs) that control powertrain,
chassis, or body systems.
§ Where dSPACE products are deployed in conjunction with ECUs which would
be a hazard if they malfunctioned.

The guidelines accordingly apply to the use of dSPACE products in aircraft or


vessels in line with the contractual purposes.

Example: ECU with DCI‑GSI1 As an example, the illustration below shows a setup with an ECU with DCI-GSI1
connected to the host PC using the USB_CAB11 Interface Cable with
Optoisolation. The cable name is printed on the cable. The cable ensures an
electrically safe connection to the host PC if hazardous voltages occur within the

18
ControlDesk Introduction and Overview May 2018
Warning About Using a dSPACE ECU Interface

test area in case of a hardware failure. For information on the maximal voltage
levels, refer to the cable's data sheet.

Host PC

ECU with DCI-GSI1


USB_CAB5 PC connection cable USB_CAB11 interface
cable with optoisolation

1) 2)
Electrically safe area Test area

1)
No hazardous voltages occur.
2)
Hazardous voltages can occur.

Example: ECU with DCI‑GSI2 As an example, the illustration below shows a setup with an ECU with DCI-GSI2
connected to MicroAutoBox connected to MicroAutoBox. MicroAutoBox is connected to the host PC by the
galvanically isolated ETH_CAB2 Ethernet Connection Cable. The cable name is
printed on the cable. The cable ensures an electrically safe connection to the
host PC if hazardous voltages occur within the test area in case of a hardware
failure. For information on the maximal voltage levels, refer to the cable's data
sheet.

ECU with DCI-GSI2

MicroAutoBox

Ethernet

Host PC

ETH_CAB2 PC
connection cable
to MicroAutoBox

1) 2)
Electrically safe area Test area

1)
No hazardous voltages occur.
2)
Hazardous voltages can occur.

19
May 2018 ControlDesk Introduction and Overview
Safety Precautions and Legal Information

Order of installation Install the components of your system in the exact order stated. Any other
sequence may lead to unpredictable results or even damage the system.

Read the instructions carefully before starting installation. Observe all warnings
given.

Liability It is your responsibility to adhere to instructions and warnings. Any unskilled


operation or other improper use of this product in violation of the respective
safety instructions, warnings or other instructions contained in the user
documentation constitutes contributory negligence, which may lead to a
limitation of liability by dSPACE GmbH, its representatives, agents and local
dSPACE companies, to the point of total exclusion, as the case may be. Any
exclusion or limitation of liability according to other applicable regulations,
individual agreements and applicable general terms and conditions remain
unaffected.

Important Information when Monitoring and Logging Ethernet Traffic

Introduction ControlDesk provides means to monitor and log Ethernet traffic on a low
protocol level to support the development of ECUs communicating over Ethernet
(e.g., for ADAS scenarios). This makes it possible for ControlDesk to log the
entire Ethernet traffic between the PC and the respective network segment.

Intended use ControlDesk’s monitoring and logging function is intended to support the
development of electronic control units (ECUs) that communicate via Ethernet.
The functionality integrated in ControlDesk is exclusively intended for detecting
and analyzing irregularities and weaknesses in the data input and output of the
Ethernet traffic between ECUs.

NOTICE

It is highly recommended to use the functionality only in network


segments where only PCs for ECU development are accessible.

Danger potential If you add other tools or hardware, such as an Ethernet switch with monitoring
mode, or in case of intentional manipulation, data from outside the network
segment that is directly connected to the PC might also be captured and logged.
This is not the intended use of ControlDesk and its monitoring and logging
function. It must also be noted that intercepting and using external or private
data requires the consent of the respective data owner, unless otherwise
stipulated by law. Otherwise, this might violate legal regulations, especially with
regard to criminal and data protection laws.

20
ControlDesk Introduction and Overview May 2018
Legal Information on ASAM Binaries and ASAM Documentation

NOTICE

You are responsible for ensuring that ControlDesk’s monitoring and


logging function is used only in accordance with the intended
purpose and the legal regulations.

Legal Information on ASAM Binaries and ASAM Documentation

Overview Note

Legal Information on ASAM binaries and ASAM documentation

dSPACE GmbH draws your attention to the fact that installing dSPACE
software also installs components that are licensed and released by ASAM
e.V. (Association for Standardisation of Automation and Measuring
Systems).

dSPACE GmbH hereby confirms that dSPACE is a member of ASAM and as


such entitled to use these licenses and to install the ASAM binaries and the
ASAM documentation together with the dSPACE software.

The customer is not authorized to pass the ASAM binaries and the ASAM
documentation to third parties without permission. For more information,
see http://www.asam.net/license.html.

21
May 2018 ControlDesk Introduction and Overview
Safety Precautions and Legal Information

22
ControlDesk Introduction and Overview May 2018
New Features of ControlDesk

New Features of ControlDesk

New Key Features of ControlDesk 6.3

Overview of the new key The new key features of ControlDesk 6.3 are:
features
Platform/device enhancements
§ Video capturing in combination with Windows 10
§ SCALEXIO: DS6241 support
§ SCALEXIO: Support of multiple Simulink behavior models and SIC files per
application process
For more information on the new features, refer to New Features of Platform
Management and Platforms/Devices (ControlDesk 6.3) ( ControlDesk Platform
Management).

Instrument enhancements
§ Table Editor: Support for multiple working points
§ Adding variables to instruments via instrument context menu
For more information on the new features, refer to New Instrument Features
(ControlDesk 6.3) ( ControlDesk Instrument Handling).

Measurement and recording enhancements


§ Improved export and saving of large MF4 files
§ Measurement signal list: Alternating row colors
For more information on the new features, refer to New Measurement and
Recording Features (ControlDesk 6.3) ( ControlDesk Measurement and
Recording).

User interface handling enhancements


§ Customizing ribbons
For more information on the new feature, refer to New User Interface Handling
Features (ControlDesk 6.3) ( New Features and Migration).

Bus Navigator enhancements Bus instrument enhancements:


§ Bus communication manipulation support
§ Bus instrument (TX status type for LIN): Support for LIN network node wake‑up

23
May 2018 ControlDesk Introduction and Overview
New Features of ControlDesk

§ Bus instrument (Inspection type for CAN), Bus instrument (Inspection type for
LIN): Support for PDU raw data inspection
§ Bus instrument (RX type for CAN), Bus instrument (RX type for LIN): Support
for counter signals
§ Bus instrument (TX type for CAN), Bus instrument (RX type for CAN): Support
for CAN frame access
§ Bus configuration enable support
Ethernet monitoring enhancements:
§ Ethernet monitoring: Decoding view
§ Ethernet monitoring: Display of ECU names instead of MAC/IP addresses in the
monitoring list
For more information on the new features, refer to New Bus Navigator Features
(ControlDesk 6.3) ( ControlDesk Bus Navigator).

Electrical error simulation (failure simulation) enhancements


§ Error configuration commands also available in full-screen mode
§ EESPort creation based on non‑dSPACE EESPort implementations
§ New tutorial videos
For more information on the new features, refer to New Electrical Error
Simulation Features (ControlDesk 6.3) ( New Features and Migration).

Signal Editor enhancements


§ Specifying general Signal Editor settings
§ Enhanced zooming signals
For more information on the new features, refer to New Signal Editor Features
(ControlDesk 6.3) ( ControlDesk Signal Editor).

Automation enhancements
§ Importing/exporting the recent platform configuration
For more information on the new features, refer to New Automation Features
(ControlDesk 6.3) ( ControlDesk Automation).

24
ControlDesk Introduction and Overview May 2018
Introduction to ControlDesk

Introduction to ControlDesk

Where to go from here Information in this section

Basics of ControlDesk ............................................................................ 26

Working with the User Interface of ControlDesk .................................... 32

Working in Operator Mode ................................................................... 49


When ControlDesk is in the operator mode, you can work with existing
experiments but not modify them, which protects them from
unintentional changes.

Getting Support .................................................................................... 56

25
May 2018 ControlDesk Introduction and Overview
Introduction to ControlDesk

Basics of ControlDesk
Where to go from here Information in this section

About ControlDesk ................................................................................ 26


ControlDesk is a universal, modular experiment and instrumentation
software for ECU development. ControlDesk also supports calibration,
measurement and diagnostics access to ECUs via standardized protocols
such as CCP, XCP, and ODX.

Software Versions and Modules ............................................................. 27


ControlDesk consists of different versions and optional modules.

How to Start ControlDesk ...................................................................... 30


To start ControlDesk.

About ControlDesk

Overview ControlDesk is a universal, modular experiment and instrumentation software for


ECU development. ControlDesk also supports calibration, measurement and
diagnostics access to ECUs via standardized protocols such as CCP, XCP, and
ODX.

26
ControlDesk Introduction and Overview May 2018
Basics of ControlDesk

It supports synchronized data acquisition across RCP and HIL platforms, ECUs,
and bus systems.

ControlDesk
Rapid control ECU
Virtual prototyping Hardware-in-the- (measurement, Access to vehicle
validation1) (fullpassing/ loop simulation calibration and bus systems
bypassing) diagnostics)

Synchronized time base on all platforms/devices

CAN / CAN FD
LIN
FlexRay
PC-based offline
simulation

ControlDesk can access virtual ECUs generated with dSPACE's SystemDesk and
Simulink models that are simulated offline on the PC.

Software Versions and Modules

Where to go from here Information in this topic

Introduction ............................................................................................................................ 27
ControlDesk ........................................................................................................................... 28
ControlDesk ‑ Operator Version .............................................................................................. 28
ControlDesk ECU Interface Module ......................................................................................... 29
ControlDesk ECU Diagnostics Module ..................................................................................... 29
ControlDesk Signal Editor Module .......................................................................................... 29
ControlDesk Bus Navigator Module ........................................................................................ 29
Failure Simulation Package ...................................................................................................... 30
Required licenses .................................................................................................................... 30

Introduction ControlDesk consists of different versions and optional modules.

27
May 2018 ControlDesk Introduction and Overview
Introduction to ControlDesk

The following illustration provides an overview of the available versions and


modules:

ControlDesk

Versions
(Platform ControlDesk -
support ControlDesk Operator Version
included)

Add-on ECU Interface ECU Diagnostic Signal Editor Bus Navigator


modules Module Module Module Module

ControlDesk The main version of ControlDesk for creating and running experiments, and for
accessing dSPACE real‑time hardware and VEOS. The functionality can be
extended by optional software modules.
§ Same tool for rapid control prototyping, HIL simulation, virtual validation,
ECU calibration, and ECU diagnostics
§ Creation of layouts and instruments
§ Access to:
§ dSPACE real-time hardware
§ VEOS
§ Test benches by using an ASAM XIL API MAPort Server
§ Synchronous measurement on all data sources
§ Tool automation, for example, for user-specific extensions
§ Automation according to the ASAM MCD3 standard

ControlDesk ‑ A version of ControlDesk that provides only a subset of functionality for running
Operator Version existing experiments. The functionality can be extended by optional software
modules.
§ Use of projects and experiment data that have been created before with the
main version of ControlDesk
§ Access to:
§ dSPACE real-time hardware
§ VEOS
§ Test benches by using an ASAM XIL API MAPort Server
§ Synchronous measurement on all data sources
§ Limited tool automation
§ Protection against altering and creating projects and experiments

For details on working in the operator mode, refer to Working in Operator Mode
on page 49.

28
ControlDesk Introduction and Overview May 2018
Basics of ControlDesk

ControlDesk ECU Interface An optional software module for ControlDesk for calibration and measurement
Module access to electronic control units (ECUs). The module is also required for
calibration and measurement access to virtual ECUs (V‑ECUs) used in virtual
validation scenarios.
§ Access to ECUs via on-chip debug ports such as JTAG/Nexus and JTAG/OCDS
(requires a DCI-GSI1 or DCI-GSI2)
§ Access to ECUs via CCP (requires a supported PC-based CAN interface such as
the DCI‑CAN2 or the DCI‑CAN/LIN1)
§ Access to ECUs via XCP on CAN (requires a supported PC-based
CAN interface), XCP on Ethernet (requires an Ethernet network interface card)
and XCP on FlexRay (requires a supported PC-based FlexRay interface)
§ Access to V‑ECUs via XCP on Ethernet

ControlDesk ECU Diagnostics An optional software module for ControlDesk that facilitates the calibration and
Module validation of ECU diagnostic functions.
§ Compliance with ODX database standard
§ Support of ISO protocols for CAN (requires a supported PC‑based
CAN interface such as the DCI‑CAN2 or the DCI‑CAN/LIN1) and K-Line
(requires a supported K-Line interface (refer to Supported K‑Line Interfaces
( ControlDesk Platform Management)) such as the DCI‑KLine1)
§ Instruments for executing diagnostic services and jobs, and for reading and
clearing the fault memory of an ECU
§ ECU flash memory programming via diagnostic interfaces

ControlDesk Signal Editor An optional software module for ControlDesk for the graphical definition and
Module execution of signal generators for stimulating model variables of real-time/offline
simulation applications.
§ Time-synchronous stimulus generation
§ Replay of measured data contained in an ASAM MF4 file
§ Support of XIL-API stimulus format

ControlDesk Bus Navigator An optional software module for ControlDesk for handling bus messages, such
Module as CAN messages, LIN frames, and FlexRay frames and PDUs.
§ Support of CAN (including J1939), Ethernet, FlexRay, and LIN buses for
dSPACE real-time hardware and PC-based bus interfaces

Tip

No license for the Bus Navigator Module is required to access CAN-based


dSPACE real-time hardware and PC-based CAN interfaces (e.g.,
DCI‑CAN2) for handling CAN messages, and for monitoring and logging
CAN bus communication, since this is included in the main version of
ControlDesk.

§ Support of CAN and LIN buses for VEOS

29
May 2018 ControlDesk Introduction and Overview
Introduction to ControlDesk

§ Replay of recorded CAN messages


§ Instruments for handling CAN, LIN and FlexRay bus objects

Failure Simulation Package To prepare an electrical error simulation via the graphical user interface (GUI), use
the ControlDesk XIL API EESPort GUI, which was introduced with
ControlDesk 5.5 (dSPACE Release 2015-B).

To use the ControlDesk XIL API EESPort GUI, the Failure Simulation Package is
required, which is based on XIL API's EESPort. The implementation is based on
dSPACE XIL API .NET.

Required licenses Working with the different versions and modules requires that you have the
related licenses.

Working without a license ControlDesk lets you perform the following


tasks even without a valid license:
§ Registering dSPACE real-time hardware
§ Loading, starting and stopping applications on dSPACE real-time hardware
§ Managing the firmware of dSPACE real‑time hardware
Refer to Managing Platforms Without ControlDesk License ( ControlDesk
Platform Management).

How to Start ControlDesk

Restrictions ControlDesk must not be running. You cannot start a second ControlDesk
instance from the same or from a different dSPACE Release.

Preconditions ControlDesk is installed.

Method To start ControlDesk


1 On the Start menu, select All Programs – dSPACE ControlDesk <x.y>, and
click dSPACE ControlDesk <x.y>.

Note

When you start ControlDesk for the first time after installation, your
firewall may output a security warning. Confirm ControlDesk as trusted
software.

ControlDesk opens.

30
ControlDesk Introduction and Overview May 2018
Basics of ControlDesk

Result You started ControlDesk.

Tip

The installation process automatically creates a shortcut on the desktop. You

can double-click to start ControlDesk.

31
May 2018 ControlDesk Introduction and Overview
Introduction to ControlDesk

Working with the User Interface of ControlDesk


Where to go from here Information in this section

User Interface of ControlDesk ................................................................ 33


Provides an overview of the controlbars and areas of ControlDesk's
graphical user interface.

Basics on Ribbons .................................................................................. 42


Ribbons are user interface elements that provide access to common
commands and dialogs.

How to Customize the Quick Access Toolbar ......................................... 45


Instructions on how to customize the Quick Access Toolbar.

How to Customize the Screen Arrangement .......................................... 47


Instructions on creating a custom pane arrangement.

32
ControlDesk Introduction and Overview May 2018
Working with the User Interface of ControlDesk

User Interface of ControlDesk

Overview The following illustration shows ControlDesk's user interface.

- Instrument Selector
Quick Access toolbar Ribbon Working area - Properties

- Project Manager - Variable Browser Status bar - User Functions Output


- Measurement Configuration - Measurement Data Pool - Signal Selector
- Layout Navigator - Platform / Device Manager - Signal Mapping
- Instrument Navigator - Interpreter - Failure Simulation
- Bus Navigator - Message Viewer - EESPort Configurations

Where to go from here Information in this topic

Quick Access toolbar .............................................................................................................. 34


Ribbon .................................................................................................................................... 34
Working area .......................................................................................................................... 34
Status bar ............................................................................................................................... 34

33
May 2018 ControlDesk Introduction and Overview
Introduction to ControlDesk

Controlbars ............................................................................................................................ 34
Bus Navigator .................................................................................................................... 38
EESPort Configurations ...................................................................................................... 42
Instrument Navigator ......................................................................................................... 38
Instrument Selector ........................................................................................................... 35
Interpreter ......................................................................................................................... 40
Layout Navigator ............................................................................................................... 37
Measurement Configuration .............................................................................................. 37
Measurement Data Pool .................................................................................................... 40
Message Viewer ................................................................................................................ 41
Platform/Device Manager .................................................................................................. 40
Project Manager ................................................................................................................ 36
Properties .......................................................................................................................... 36
Signal Mapping ................................................................................................................. 41
Signal Selector ................................................................................................................... 41
User Functions Output ....................................................................................................... 41
Variable Browser ................................................................................................................ 39

Quick Access toolbar The Quick Access toolbar is an easy way to call commands. You can customize it
to contain the commands you use most frequently.

Ribbon The ribbon organizes, groups and labels commands of ControlDesk.

Working area The working area primarily provides access to instruments placed on layouts.
Python scripts are also opened in the working area by default. In the workbook
mode you can switch between opened layouts and documents via tabs.

Status bar The status bar displays the current state of ControlDesk.

Controlbars A controlbar is a window or pane outside the working area. It can be docked to
an edge of the main window or float in front of it. A controlbar can contain a
document, such as a layout, or a tool, such as the Message Viewer. It can be
grouped with other controlbars in a window with tabbed pages.

ControlDesk's user interface provides the following controlbars:

34
ControlDesk Introduction and Overview May 2018
Working with the User Interface of ControlDesk

Instrument Selector A controlbar that provides access to ControlDesk's


instruments. The instruments can be placed on a layout via double-click or
drag & drop.

35
May 2018 ControlDesk Introduction and Overview
Introduction to ControlDesk

Properties A controlbar providing access to the properties of, for example,


platforms/devices, layouts/instruments, and measurement/recording
configurations.

Project Manager A software component represented by a controlbar. It


provides access to projects and experiments and all the files they contain.

Project

Project-global
items

Experiment

Experiment-
specific items

Item info field

36
ControlDesk Introduction and Overview May 2018
Working with the User Interface of ControlDesk

Measurement Configuration A controlbar that allows you to configure


measurement and recording.

Default raster

Trigger reference
(active trigger)
Trigger reference
(inactive trigger)

Default raster

Available triggers

Available recorders

Navigation area Configuration area

Layout Navigator A controlbar that displays all opened layouts. It can


be used for switching between layouts.

37
May 2018 ControlDesk Introduction and Overview
Introduction to ControlDesk

Instrument Navigator A controlbar that displays a tree with all the


instruments of the active layout and all the variables that are connected to
them. The Instrument Navigator's main function is easy selection of instruments
in complex layouts.

Bus Navigator A controlbar for handling bus messages, such as CAN


messages, LIN frames, FlexRay PDUs, and Ethernet packets.

38
ControlDesk Introduction and Overview May 2018
Working with the User Interface of ControlDesk

Variable Browser The Variable Browser is a controlbar that provides access


to the variables of the currently open experiment.
Function buttons

Model Tree Variable list Favorites list

39
May 2018 ControlDesk Introduction and Overview
Introduction to ControlDesk

Measurement Data Pool A controlbar that provides access to


measurement data recorded in measurement data files.

Recorded data file list Recorded data file property list Checked variables list Bookmark list
(hidden by default)

Platform/Device Manager A software component represented by a


controlbar. It provides functions to handle devices, platforms, and the
applications assigned to the platforms.

Network client
DS1005 platform
SCALEXIO platform
SCALEXIO application
Application processes
SCALEXIO processing unit
XCP on CAN device

Interpreter A controlbar that can be used to execute line-based commands.


It is used by the Interpreter to print out Python standard error messages and
standard output during the execution or import of Python scripts.

40
ControlDesk Introduction and Overview May 2018
Working with the User Interface of ControlDesk

Message Viewer A controlbar displaying a history of all error and warning


messages that occur during work with ControlDesk.

User Functions Output A controlbar that provides access to the output of


external tools added to the Automation ribbon.

Signal Selector A controlbar of the Signal Editor. The Signal Selector is a


graphical instrument providing signals and segments for arranging and
configuring signal description sets in the working area.

Signal Mapping A controlbar of the Signal Editor to map model variables


from the Variable Browser to signals and variable aliases of a signal
generator.

41
May 2018 ControlDesk Introduction and Overview
Introduction to ControlDesk

EESPort Configurations A controlbar for configuring error


configurations.

Related topics Basics

Basics on Ribbons ................................................................................................................... 42

HowTos

How to Customize the Quick Access Toolbar ........................................................................... 45

Basics on Ribbons

Introduction Ribbons are user interface elements that provide access to common commands
and dialogs.

Where to go from here Information in this topic

Ribbon .................................................................................................................................... 43
Ribbon group ......................................................................................................................... 43
Backstage view ....................................................................................................................... 44
Quick Access Toolbar .............................................................................................................. 44
Navigating the ribbon ............................................................................................................. 45
Customizing the ribbon .......................................................................................................... 45

42
ControlDesk Introduction and Overview May 2018
Working with the User Interface of ControlDesk

Ribbon The ribbon organizes and groups commands of a program. The ribbon is located
at the top of the user interface, see the following example.

Ribbon

The ribbon consists of several ribbon tabs, see the following example of the
Home ribbon.
Home ribbon

Ribbon group A ribbon group is a part of a tabbed ribbon. It consists of a set of related
commands.

The following illustration shows a ribbon group in ControlDesk as an example.

Ribbon group

Dialog launcher

Dialog launcher A dialog launcher is an optional element of a ribbon group


that lets you open a dialog related to that ribbon group.

Split button A split button is a special form of a button with two parts. The
main icon part of the button executes a default command. The arrow part of the
button opens a submenu.
You can identify a split button by moving the mouse over the button. The button
then is highlighted, see the following example.
The illustration below shows the Activate Working Page split button of
ControlDesk as an example.
Main icon part

Arrow part
Submenu

43
May 2018 ControlDesk Introduction and Overview
Introduction to ControlDesk

Backstage view The Backstage view provides basic commands of a software program, such as
Save, Open, Close, Exit. The Backstage view can be identified by the colored
ribbon tab. When the Backstage view is opened, it covers the entire user
interface.

The following illustration shows the Backstage view of ControlDesk as an


example.

Ribbon tab Ribbon group Backstage view

Quick Access Toolbar The Quick Access Toolbar is an easy way to call commands. You can customize it
to provide the commands you use most frequently.

Quick Access toolbar

For information on how to add or remove commands to/from the Quick Access
Toolbar, refer to How to Customize the Quick Access Toolbar on page 45.

44
ControlDesk Introduction and Overview May 2018
Working with the User Interface of ControlDesk

Navigating the ribbon You can navigate the ribbon via mouse and via keyboard.

Navigation via mouse You can navigate the ribbon with the mouse scroll
wheel.

Navigation via keyboard If you want to navigate the ribbon via keyboard,
press the Alt key. Each command in the Quick Access Toolbar and each ribbon
tab then is marked by an access key.
The illustration below shows a ribbon after pressing Alt as an example.

If you then press one of the ribbon tab access keys, each command in the
selected ribbon is also marked by an access key.
You can remove the access keys by pressing Alt again.

Customizing the ribbon § You can extend the standard ribbon by your own ribbon tabs, ribbon groups
and commands.
Refer to Customize Quick Access Toolbar/Customize Ribbon/Customize View
Sets/More Commands ( ControlDesk User Interface Handling).
§ You can also customize ControlDesk's ribbon by adding your own ribbon
controls via Python extension scripts.
For details, refer to Customizing the Ribbon via Extension Scripts
( ControlDesk Customization).

Related topics Basics

Customizing the Ribbon via Extension Scripts ( ControlDesk Customization)

How to Customize the Quick Access Toolbar

Objective You can customize the Quick Access Toolbar to display the commands that you
use frequently and you can specify its position.

45
May 2018 ControlDesk Introduction and Overview
Introduction to ControlDesk

Method To customize the Quick Access Toolbar

1 On the Quick Access Toolbar, click – More Commands.


The Quick Access Toolbar page of the Customize dialog is displayed.

2 On the Quick Access Toolbar page you can add and remove commands,
reset the toolbar and specify the position of the Quick Access Toolbar.
§ To add a command to the Quick Access Toolbar, open the Choose
commands from list and select a ribbon. Then select a command from the
list on the left and click Add.

Tip

To add a command to the Quick Access Toolbar, you can also select
Add to Quick Access Toolbar in the context menu of a command in
a ribbon.

§ To remove a command from the Quick Access Toolbar, select the command
in the list on the right and click Remove.

Tip

To remove a command from the Quick Access Toolbar, you can also
select Remove from Quick Access Toolbar in the context menu of a
command icon in the Quick Access Toolbar.

§ To reset the Quick Access Toolbar to the factory default, click Reset.
§ To show the Quick Access Toolbar below the ribbon, select Show Quick
Access Toolbar below the ribbon.
3 Click Close to save the changes.

46
ControlDesk Introduction and Overview May 2018
Working with the User Interface of ControlDesk

Result You have customized the Quick Access Toolbar.

Related topics Basics

Basics on Ribbons ................................................................................................................... 42

References

Customize Quick Access Toolbar/Customize Ribbon/Customize View Sets/More


Commands ( ControlDesk User Interface Handling)

How to Customize the Screen Arrangement

Objective The screen arrangement defines which panes are displayed and how they are
arranged. The first time you execute the application, it starts with its default
screen arrangement, which you can modify.

Screen modifications The screen arrangement contains information about:


§ Display states and positions of the toolbars
§ Display states and positions of the panes such as the Project Manager
§ Pane settings, such as the docking state

View sets A view set is a named configuration of the controlbars, the ribbon and the Quick
Access toolbar of the application. You can create various view sets and switch
between them. All the modifications you make to the screen arrangement are
automatically saved to the currently active view set. For more information on
view sets, refer to Customize Quick Access Toolbar/Customize Ribbon/Customize
View Sets/More Commands ( ControlDesk User Interface Handling).

Commands for customizing The application provides various commands, such as the Floating command, to
the screen arrangement modify the state of each pane. You can execute all of these commands quickly
and flexibly via mouse. The following instructions describe how to do this.

Method To customize the screen arrangement


1 Move the mouse pointer onto the title bar of the pane whose position you
want to change.
If you want to move a tabbed pane, you must select its tab instead of the title
bar.

47
May 2018 ControlDesk Introduction and Overview
Introduction to ControlDesk

2 Drag the pane to another position while holding the left mouse button down.
The docking state of the pane is automatically changed to floating and the
screen displays docking stickers that you can use to specify the new position.

Docking Sticker Description


The pane is docked to the top of your application's main
window.
The pane is docked to the bottom of your application's
main window.
The pane is docked to the left of your application's main
window.
The pane is docked to the right of your application's
main window.
The pane is docked to the top, bottom, left, or right of
your application's working area.

The pane is docked above, below, to the left, or to the


right of the selected pane. If you drag the mouse onto
the middle docking sticker, the pane is docked as a new
page.

3 Move the mouse pointer onto a docking sticker. When the area of the new
position is displayed, release the left mouse button.

Result The component is moved to the new position in the user interface and docked to
another component.

If you release the mouse button anywhere except on a docking sticker, the
docking state of the pane remains floating.

Tip

If you want to change the order of pane tabs, you can drag them to new
positions.

Related topics References

Customize Quick Access Toolbar/Customize Ribbon/Customize View Sets/More


Commands ( ControlDesk User Interface Handling)

48
ControlDesk Introduction and Overview May 2018
Working in Operator Mode

Working in Operator Mode


Where to go from here Information in this section

Basics on the Operator Version and Operator Mode ............................... 49


ControlDesk switched to the operator mode and ControlDesk - Operator
Version provide only a subset of functionality.

Operator Mode Functionalities ............................................................... 50


In the operator mode, you can work with existing experiments but not
modify them, which protects them from unintentional changes.

Preparing an Experiment for Use in Operator Mode ............................... 53


You should prepare an experiment for being used in operator mode.

How to Switch ControlDesk to the Operator Mode ................................ 53


To protect existing experiments against unintentional changes, you can
switch the ControlDesk to the operator mode.

Basics on the Operator Version and Operator Mode

ControlDesk in operator You can switch ControlDesk to the operator mode:


mode
Operator mode A working mode of ControlDesk in which only a subset of
the ControlDesk functionality is provided. You can work with existing
experiments but not modify them, which protects them from unintentional
changes.

ControlDesk ‑ Operator ControlDesk also provides the Operator Version.


Version
ControlDesk ‑ Operator Version A version of ControlDesk that provides
only a subset of functionality for running existing experiments. The functionality
can be extended by optional software modules.

ControlDesk ‑ Operator Version provides the same functionalities as ControlDesk


switched to the operator mode.

49
May 2018 ControlDesk Introduction and Overview
Introduction to ControlDesk

Related topics Basics

Operator Mode Functionalities ................................................................................................ 50


Preparing an Experiment for Use in Operator Mode ................................................................ 53

HowTos

How to Switch ControlDesk to the Operator Mode ................................................................. 53

References

Operator Mode Page ( ControlDesk User Interface Handling)

Operator Mode Functionalities

Introduction In the operator mode, you can work with existing experiments but not modify
them, which protects them from unintentional changes.

Disabled ribbon and context In the operator mode, some ribbon commands and context menu commands are
menu commands not available and are therefore grayed out.

Tip

ControlDesk's reference information provides detailed information on which


ribbon commands and context menu commands are available in the
operator mode.

Functions not available in the The table below lists the most important functions of ControlDesk that are not
operator mode available in the operator mode.

Not Possible in Operator Mode


ControlDesk Project and Experiment Management
§ Creating projects/experiments
§ Removing/deleting files from projects/experiments
§ Migrating experiments from prior versions of ControlDesk

50
ControlDesk Introduction and Overview May 2018
Working in Operator Mode

Not Possible in Operator Mode


ControlDesk Platform Management
§ Adding/removing platforms/devices to/from an experiment
§ Configuring platforms/devices

Tip

§ Registering platforms is possible.


§ Loading, starting and stopping real-time applications is possible.

ControlDesk Variable Management


§ Adding/removing variable descriptions to/from a platform/device
§ Modifying variable properties
§ Adding/removing calculated variables to/from an experiment

Tip

Reloading/replacing variable descriptions is possible.

ControlDesk Layouting and ControlDesk Instrument Handling


§ Adding/removing layouts to/from an experiment
§ Saving/importing/exporting layouts
§ Adding/removing instruments to/from a layout
§ Moving/resizing/grouping instruments on a layout
§ Connecting/disconnecting variables to/from instruments
ControlDesk Measurement and Recording
§ Adding/removing signals to/from the measurement signal list (data
acquisition and recordings)
§ Importing measurement data files
§ Adding/removing triggers
§ Adding/removing/configuring rasters
§ Adding/removing/configuring recorders

Tip

§ Creating/exporting measurement data files is possible.


§ Configuring trigger conditions is possible. However, the changes are
lost when you save the experiment.

ControlDesk Calibration and Data Set Management


§ Importing data sets
§ Editing data sets in the Data Set Manager
§ Creating new reference data sets

Tip

§ Changing values of parameters of the working data set is possible.


§ Creating new data sets is possible.
§ Exporting data sets is possible.

51
May 2018 ControlDesk Introduction and Overview
Introduction to ControlDesk

Not Possible in Operator Mode


ControlDesk Bus Navigator
§ Adding/removing bus instruments
§ Adding/removing monitor nodes, loggers and replay nodes
ControlDesk Signal Editor
§ Adding/importing/removing signal descriptions sets
§ Adding/modifying/removing signals
§ Modifying signal mappings
ControlDesk Electrical Error Simulation via XIL API EESPort
§ Adding/modifying/removing XIL API EESPorts
§ Adding/modifying/removing error configurations
§ Adding/modifying/removing error sets
ControlDesk User Interface Handling
§ Customizing user functions
Automation with Python
§ Importing/removing Python scripts to/from the project/experiment
§ Modifying Python scripts (including scripts which use ControlDesk events)
that are part of the project/experiment
§ Editing/executing Python commands in the Internal Interpreter

Tip

§ Automating ControlDesk from an external Python interpreter, from


applications or from further scripting environments is possible.
§ Using ControlDesk events from Python scripts that run in an external
Python interpreter is possible.
§ Running scripts in the Internal Interpreter is possible if the scripts are
part of the project/experiment.

ControlDesk MCD-3 Automation


§ Not possible in the operator mode

Related topics Basics

Basics on the Operator Version and Operator Mode ................................................................ 49


Preparing an Experiment for Use in Operator Mode ................................................................ 53

HowTos

How to Switch ControlDesk to the Operator Mode ................................................................. 53

References

Operator Mode Page ( ControlDesk User Interface Handling)

52
ControlDesk Introduction and Overview May 2018
Working in Operator Mode

Preparing an Experiment for Use in Operator Mode

Steps to prepare an Perform the following steps to prepare an experiment for use in operator mode:
experiment 1. Add and configure all the required platforms and devices to the experiment;
add variable descriptions to the platforms and devices.
2. Add layouts to the experiment and connect variables to instruments on the
layouts.
3. Configure measurements and recordings.
4. Add Python scripts to the project/experiment.
5. Add and configure signal description sets; map signals to variables of a real-
time application for stimulation.
6. Add and configure failure simulation.

Related topics Basics

Basics on the Operator Version and Operator Mode ................................................................ 49

HowTos

How to Switch ControlDesk to the Operator Mode ................................................................. 53

References

Operator Mode Page ( ControlDesk User Interface Handling)

How to Switch ControlDesk to the Operator Mode

Objective To protect existing experiments against unintentional changes, you can switch
the ControlDesk to the operator mode.

Precondition § ControlDesk is installed on the host PC.


§ The experiment(s) must be prepared for use in operator mode. Refer to
Preparing an Experiment for Use in Operator Mode on page 53.

Possible methods § You can switch ControlDesk to the operator mode via the ControlDesk
Options dialog. Refer to Method 1.
§ You can switch ControlDesk to the operator mode via command line. Refer to
Method 2.

53
May 2018 ControlDesk Introduction and Overview
Introduction to ControlDesk

Method 1 To switch ControlDesk to the operator mode via the ControlDesk Options
dialog
1 On the File ribbon, click Options.
ControlDesk opens the ControlDesk Options dialog.
2 On the Operator Mode page of the ControlDesk Options dialog, select
Activate operator mode on next tool start.
3 If required, specify a password in the Enter password (optional) and Re-
enter password edit fields.
If you specify a password, a user who wants to switch ControlDesk from the
operator mode back to the normal mode will have to enter this password.

Tip

Specifying a password is recommended if not every employee is allowed


to switch ControlDesk from the operator mode to the normal mode.

4 In the ControlDesk Options dialog, click OK to close the dialog.


5 Restart ControlDesk.

Method 2 To switch ControlDesk to the operator mode via command line


1 If ControlDesk is currently running, close it.
2 Start ControlDesk via command line with the additional command line
argument -operator.

Result You have switched ControlDesk to the operator mode. This is indicated in the
caption of the user interface as shown in the following illustration.

Next steps To switch ControlDesk back to the normal mode, open the ControlDesk
Options dialog, and deselect Activate operator mode on next tool start on
the Operator Mode page. Enter the password if one was specified before
ControlDesk was switched to the operator mode.

54
ControlDesk Introduction and Overview May 2018
Working in Operator Mode

Related topics Basics

Basics on the Operator Version and Operator Mode ................................................................ 49


Operator Mode Functionalities ................................................................................................ 50
Preparing an Experiment for Use in Operator Mode ................................................................ 53

References

Operator Mode Page ( ControlDesk User Interface Handling)

55
May 2018 ControlDesk Introduction and Overview
Introduction to ControlDesk

Getting Support

Getting Support

ControlDesk Product Support The ControlDesk Product Support Center offers the most important support
Center information for ControlDesk. Refer to:

http://www.dspace.com/cdngpsc

dSPACE support If you still cannot solve the problem, contact dSPACE Support.

56
ControlDesk Introduction and Overview May 2018
Demos for ControlDesk

Demos for ControlDesk

Where to go from here Information in this section

Demo Projects ....................................................................................... 58

Automation Demos ............................................................................... 90

Demo Devices ........................................................................................ 99

57
May 2018 ControlDesk Introduction and Overview
Demos for ControlDesk

Demo Projects
Where to go from here Information in this section

Basics on Demo Projects ........................................................................ 58


Provides an overview of the available demo projects and a list of the
ControlDesk features that they cover.

Bus Navigator Demo .............................................................................. 61


Demonstrates ControlDesk's bus communication features (monitoring,
logging, replay, message transmission). The demo is based on a
simulated bus interface.

CalDemo ............................................................................................... 70
Demonstrates ControlDesk's measurement and calibration features
without a real ECU connected to the host PC.

ECU Diagnostics Demo .......................................................................... 73


Demonstrates ControlDesk's ECU diagnostics features without a
platform/device connected to the host PC.

Real-Time Application Demos ................................................................ 82


Demonstrate ControlDesk's measurement and calibration features in
connection with dSPACE real-time hardware connected to the host PC.

Relay Maintenance Demo ...................................................................... 84


Allows you to perform relay cleaning in a SCALEXIO system.

Signal Editor Demos .............................................................................. 84


Demonstrate ControlDesk's Signal Editor features in connection with
dSPACE real-time hardware connected to the host PC.

XIL API EESPort Demo ............................................................................ 88


Demonstrates ControlDesk's features for electrical error simulation,
which is based on the ASAM AE XIL API standard.

Basics on Demo Projects

Overview The ControlDesk installation provides the following demo projects:

Demo Project Focus


Real-time application demos Demonstrate ControlDesk's measurement and calibration features
Refer to Real-Time Application Demos in connection with dSPACE real-time hardware connected to the
on page 82. host PC.
Bus Navigator demo Demonstrates ControlDesk's bus communication features
Refer to Bus Navigator Demo on page 61. (monitoring, logging, replay, message transmission). The demo is
based on a simulated bus interface.

58
ControlDesk Introduction and Overview May 2018
Demo Projects

Demo Project Focus


CalDemo Demonstrates ControlDesk's measurement and calibration features
Refer to CalDemo on page 70. without a real ECU connected to the host PC.
ECU Diagnostics demo Demonstrates ControlDesk's ECU diagnostics features without a
Refer to ECU Diagnostics Demo on page 73. platform/device connected to the host PC.
XIL API EESPort Demo Demonstrates ControlDesk's features for electrical error simulation,
Refer to XIL API EESPort Demo on page 88. which is based on the ASAM AE XIL API standard.
Signal Editor demos Demonstrate ControlDesk's Signal Editor features in connection
Refer to Signal Editor Demos on page 84. with dSPACE real-time hardware connected to the host PC.
Relay maintenance demo (refer to Relay Allows you to perform relay cleaning in a SCALEXIO system.
Maintenance Demo on page 84)
Refer to Relay Maintenance Demo
on page 84.

Tip

The ControlDesk installation also provides the CANGenerator, a program


that simulates a CAN system which generates signals that can be measured
and recorded with ControlDesk. Since the program runs on the same PC as
ControlDesk, it allows you to use the CAN Bus Monitoring device under
realistic conditions, but without having to have any device hardware
connected to the PC. Refer to CANGenerator on page 101.

Features covered by the The table below lists important ControlDesk features, and shows which demo
demo projects projects cover each feature (✓) and which do not (—).

Feature Bus Navigator CalDemo ECU Diagnostics XIL API Real-Time Signal
Demo Demo EESPort Application Editor
Demo Demos Demos

Platforms and Devices


CAN Bus Monitoring ✓ – ✓ – – –
DCI-GSI2 – ✓ – – – –
DS1005 PPC Board – – – ✓ ✓ ✓
DS1006 Processor Board – – – ✓ ✓ ✓
DS1007 Processor Board – – – ✓ ✓ ✓
DS1103 PPC Controller – – – – ✓ –
Board
DS1104 R&D Controller – – – – ✓ –
Board
ECU Diagnostics – – ✓ – – –
MicroAutoBox (DS1401) – – – – ✓ ✓
MicroLabBox (DS1202) – – – – ✓ ✓
SCALEXIO – – – – ✓ ✓
VEOS – – – – ✓ ✓

59
May 2018 ControlDesk Introduction and Overview
Demos for ControlDesk

Feature Bus Navigator CalDemo ECU Diagnostics XIL API Real-Time Signal
Demo Demo EESPort Application Editor
Demo Demos Demos
XCP on CAN – ✓ – – – –
XCP on Ethernet – ✓ – – – –

Functional Areas
Automation: event ✓ – – – – –
handling
Bus communication ✓ – ✓ – – –
Calibration and – ✓ ✓ – ✓ –
measurement
ECU diagnostics – – ✓ – – –
Failure simulation / – – – ✓ – –
electrical error simulation
Stimulation of variables via – – – – – ✓
Signal Editor

Instruments
Bus Instrument ✓ – – – – –
Diagnostics Instrument – – ✓ – – –
Fault Memory Instrument – – ✓ – – –
MultiState Display ✓ – – – – –
Multiswitch ✓ – – – – –
Time Plotter ✓ ✓ ✓ – ✓ ✓
Table Editor – ✓ – – ✓ –
Variable Array – ✓ ✓ – ✓ ✓

Variable Management
Calculated variables – ✓ ✓ – ✓ –

Opening a demo project The demo projects are located in the Documents
folder.
To open a demo project, use the Open Project + Experiment ( ControlDesk
Project and Experiment Management) command.

Tip

The .\Demos folder of your ControlDesk installation contains the Backups


subfolder, which provides a ZIP archive for each demo. You can extract an
archive when you need to restore the demos. To open it, use the Open
Project + Experiment from Backup ( ControlDesk Project and Experiment
Management) command.

60
ControlDesk Introduction and Overview May 2018
Demo Projects

Related topics Basics

Bus Navigator Demo ............................................................................................................... 61


CalDemo ................................................................................................................................ 70
ECU Diagnostics Demo ........................................................................................................... 73
Real-Time Application Demos ................................................................................................. 82
Relay Maintenance Demo ....................................................................................................... 84
Signal Editor Demos ................................................................................................................ 84
XIL API EESPort Demo ............................................................................................................. 88

Bus Navigator Demo

Where to go from here Information in this topic

Opening demo projects .......................................................................................................... 61


Description of the demo project .............................................................................................. 61
Required products and modules ......................................................................................... 61
Demo setup ....................................................................................................................... 61
Demo layouts .................................................................................................................... 64
Event handling to activate the monitoring list .................................................................... 65
Replaying CAN data ................................................................................................................ 66
Monitoring CAN data ............................................................................................................. 67
Logging CAN data .................................................................................................................. 68
Transmitting and receiving CAN messages .............................................................................. 69

Opening demo projects For instructions on opening demo projects, refer to Opening a demo project
on page 60.

Description of the demo The BusNavigatorDemo project contains the Monitoring, Logging, Replay
project experiment. The experiment allows you to use ControlDesk's bus communication
features (monitoring, logging, replay, message transmission). The demo is based
on a simulated bus interface.

Required products and modules Working with this demo requires:


§ ControlDesk
§ ControlDesk Bus Navigator Module

Demo setup The Monitoring, Logging, Replay experiment contains two CAN
Bus Monitoring devices, which represent the CAN controllers of two ECUs
interconnected via CAN:
§ The Transceiver Node device represents the CAN controller of the transmitting
ECU.
§ The Receiver Node device represents the CAN controller of the receiving ECU.

61
May 2018 ControlDesk Introduction and Overview
Demos for ControlDesk

The communication between both devices is based on a virtual CAN bus, so no


real CAN bus interface is required.
The illustration below shows the demo setup in ControlDesk's Project
Manager:

62
ControlDesk Introduction and Overview May 2018
Demo Projects

The illustration below shows the related CAN bus configuration in ControlDesk's
Bus Navigator:

63
May 2018 ControlDesk Introduction and Overview
Demos for ControlDesk

Demo layouts The Monitoring, Logging, Replay experiment contains the


following layouts:

§ dashboard layout
Contains instruments that visualize signals of the Display_1, Display_3 and
Engine_1 messages.

Note

For replaying, monitoring and logging CAN data, online calibration must
be started. To visualize CAN data in the Time Plotter on the dashboard
layout, you also have to start measuring.

Tip

The LayoutAndInstrumentHandling demo shows how to create the


dashboard instrument displayed above via tool automation.
Refer to demo (refer to Tool Automation Demos on page 91).

64
ControlDesk Introduction and Overview May 2018
Demo Projects

§ mode signals layout


Contains instruments that visualize the Display_1 message.

§ transmit messages layout


For details on using this layout, see Transmitting and receiving CAN messages
on page 69.

Event handling to activate the monitoring list The BusNavigatorDemo


project provides an event handling example for activating a monitoring list. For
details, refer to Activating a Layout by Using Events ( ControlDesk
Automation).

65
May 2018 ControlDesk Introduction and Overview
Demos for ControlDesk

Replaying CAN data The Monitoring, Logging, Replay experiment contains the CANreplay.asc
replay file:

The replay file is assigned to the CAN Replay node of the Transceiver Node:

To start replaying CAN messages, perform the following steps:


1. On the Home ribbon, click Status Control – Go Online to start online
calibration.
The Monitoring, Logging, Replay experiment contains an event handler that
performs the following steps when you start online calibration:
§ It activates and starts CAN replay via the Transceiver Node.
§ It starts CAN monitoring and CAN logging via the Receiver Node.

Tip

You can also start replay as follows:

§ Click in the dashboard or mode signals layout.


OR
§ Select Start Replay from the context menu of the CAN Replay node
in the Bus Navigator.

66
ControlDesk Introduction and Overview May 2018
Demo Projects

To stop replaying CAN messages, perform the following steps:


1. On the Home ribbon, click Status Control – Go Offline to stop online
calibration.
The experiment contains an event handler that performs the following steps
when you stop online calibration:
§ It stops CAN replay.
§ It stops CAN monitoring and CAN logging.

Tip

You can also stop replay as follows:

§ Click in the dashboard or mode signals layout.


OR
§ Clear Start Replay from the context menu of the CAN Replay node
in the Bus Navigator.

Monitoring CAN data The Receiver Node contains the CAN Monitor node:

During CAN data replay and when monitoring is started, the CAN Monitor
monitoring list displays the data of all the CAN messages monitored by the
Receiver Node (unfiltered monitoring).

67
May 2018 ControlDesk Introduction and Overview
Demos for ControlDesk

Monitoring is started when you start online calibration. You can also start

monitoring by clicking in the monitoring list.

Logging CAN data The Receiver Node contains the CAN Logger node:

The CAN Logger node logs CAN data to the CANlogging.asc file.

Logging is started when you start online calibration. You can also start logging
by selecting Start Logger from the context menu of the CAN Logger node in
the Bus Navigator.

68
ControlDesk Introduction and Overview May 2018
Demo Projects

Transmitting and receiving The transmit messages layout lets you transmit the Diagnostics CAN message
CAN messages from the Transceiver Node device to the Receiver Node device.

To transmit and receive CAN messages, perform the following steps:


1. On the Home ribbon, click Status Control – Go Online to start online
calibration.
2. Then perform one of the following steps:
§ To transmit the message once, click in the Bus Instrument (TX Type
for CAN).
§ To transmit the message cyclically, specify the desired cycle time and
activate Cyclic in the Bus Instrument (TX Type for CAN).

§ To transmit a sequence of messages with changing signals, click


in the layout.

69
May 2018 ControlDesk Introduction and Overview
Demos for ControlDesk

Related topics Basics

General Features of the Bus Navigator ( ControlDesk Bus Navigator)

CalDemo

Where to go from here Information in this topic

Opening demo projects .......................................................................................................... 70


Description of the demo project .............................................................................................. 70
Required products and modules ......................................................................................... 70
Demo setup ....................................................................................................................... 70
Demo layouts .................................................................................................................... 72
Measuring and calibrating variables ........................................................................................ 72

Opening demo projects For instructions on opening demo projects, refer to Opening a demo project
on page 60.

Description of the demo The CalDemo project lets you work with ControlDesk and use its measurement
project and calibration features even without a real ECU connected to your host PC.

Required products and modules Working with this demo requires:


§ ControlDesk

Tip

The ControlDesk ECU Interface Module is not required.

Demo setup The CalDemo project includes three experiments. Each


experiment contains a different device to access a simulated ECU (CalDemo
ECU), which is part of the ControlDesk software environment and which
ControlDesk starts automatically when you open the CalDemo project.
§ XCP on CAN device
The device is part of the XCP on CAN experiment in the CalDemo project.
Since the CalDemo ECU runs on the same PC as ControlDesk, the device is
preconfigured to communicate with the CalDemo ECU via a virtual CAN
channel implemented on the host PC.

70
ControlDesk Introduction and Overview May 2018
Demo Projects

§ XCP on Ethernet device


The device is part of the XCP on Ethernet experiment in the CalDemo project.
Since the CalDemo ECU usually runs on the same PC as ControlDesk, the
device is preconfigured to communicate with the CalDemo ECU via the
localhost loopback address.

§ DCI-GSI2 device
The device is part of the DCI-GSI2 experiment in the CalDemo project. The
DCI-GSI2 device is used to access the CalDemo ECU. If you have no DCI-GSI2
connected to the host PC, the Interface Selection page of the device's
Interface Selection dialog is empty.
However, starting online calibration is possible since the device uses the
localhost loopback address to communicate with the CalDemo ECU.

71
May 2018 ControlDesk Introduction and Overview
Demos for ControlDesk

The illustration below shows the demo setup in ControlDesk's Project


Manager:

Demo layouts Each experiment contains the following layouts:


§ bit signals layout
The layout shows how to handle the Time Plotter and the Variable Array.
§ signal generator layout
The layout shows how to handle the Time Plotter and the Variable Array.
§ throttle controller layout
The layout shows how to handle the Time Plotter and the Variable Array.
§ working point layout
The layout shows how to handle the Table Editor.
§ xy plotter layout
The layout shows how to handle the XY Plotter.

Measuring and calibrating You can measure and calibrate variables.


variables
To measure and calibrate variables, perform the following steps:
1. On the Home ribbon, click Status Control – Start Measuring to start
measuring.
The Time Plotter on the throttle controller layout displays variables that
originate from the CalDemo ECU.
2. On the Home ribbon, click Status Control – Working Page to activate the
working page of the CalDemo ECU.

3. On the throttle controller layout, click below Signal Form to change


the SignalForm parameter value to sawtooth.

72
ControlDesk Introduction and Overview May 2018
Demo Projects

You can observe the effect of the changed parameter value in the Time
Plotter.

Related topics Basics

Basics of Configuring Measurement and Recording ( ControlDesk Measurement


and Recording)
Calibrating Parameters ( ControlDesk Calibration and Data Set Management)

ECU Diagnostics Demo

Where to go from here Information in this topic

Opening demo projects .......................................................................................................... 74


Description of the demo project .............................................................................................. 74
Required products and modules ......................................................................................... 74
Demo setup ....................................................................................................................... 74
Demo layouts .................................................................................................................... 75
Executing diagnostic jobs ........................................................................................................ 75
Configuring and executing diagnostic services ........................................................................ 76
Measuring and calibrating variables via the ECU Diagnostics device ........................................ 78
Measuring diagnostic trouble codes (DTCs) ............................................................................. 79
Monitoring CAN communication ............................................................................................ 81

73
May 2018 ControlDesk Introduction and Overview
Demos for ControlDesk

Opening demo projects For instructions on opening demo projects, refer to Opening a demo project
on page 60.

Description of the demo The DiagDemo project lets you perform the following tasks even without a
project real ECU connected to your host PC:
§ ECU diagnostics with ControlDesk's diagnostics instruments via the ECU
Diagnostics device
§ Measurement and calibration of diagnostics variables via the ECU Diagnostics
device in connection with ControlDesk's standard instruments

Required products and modules Working with this demo requires:


§ ControlDesk

Demo setup The DiagDemo project contains the ECU Diagnostics (MCD-3D
v2.0.2) experiment, which contains the following devices:
§ ECU Diagnostics (MCD-3D v2.0.2) device
The device is preconfigured to access the CalDemo ECU via CAN using a
virtual CAN channel. ControlDesk starts the CalDemo ECU automatically when
you open the DiagDemo project. For instructions on starting the CalDemo ECU
manually, for example, if you closed it unintentionally, refer to Starting the
CalDemo ECU on page 100.
ControlDesk automatically loads a demo ODX database to the device when
you open the DiagDemo project. A variable description based on the ODX
database is added to the device so you can perform measurement and
calibration of diagnostic variables via the ECU Diagnostics device.
§ CAN Bus Monitoring device
The device is preconfigured to monitor CAN communication between
ControlDesk and the CalDemo ECU.

74
ControlDesk Introduction and Overview May 2018
Demo Projects

The illustration below shows the demo setup in ControlDesk's Project


Manager:

Demo layouts The ECU Diagnostics (MCD-3D v2.0.2) experiment contains


the following layouts:
§ diagnostic trouble codes layout
Contains instruments with DTC measurement variables, and a Fault Memory
Instrument. See Measuring diagnostic trouble codes (DTCs) on page 79.
§ diagnostic variables layout
Contains instruments to measure and calibrate diagnostics variables via the
ECU Diagnostics device. See Measuring and calibrating variables via the ECU
Diagnostics device on page 78.
§ diagnostics layout
Contains a Diagnostics Instrument for executing diagnostic jobs and services.
See Executing diagnostic jobs on page 75 and Configuring and executing
diagnostic services on page 76.

Executing diagnostic jobs You can execute jobs with the Diagnostics Instrument. For example, you can
execute the UDS Demo Security Access Job diagnostic job to enable security
access, which is required to perform parameter changes on the CalDemo ECU via
the ECU Diagnostics device.

75
May 2018 ControlDesk Introduction and Overview
Demos for ControlDesk

Tip

The job is executed for demonstration purposes only. Normally, you do not
have to execute it manually. ControlDesk executes it automatically when
you start online calibration since this is necessary for write operations and
access to protected areas.

To get security access by executing a diagnostic job, perform the following steps:
1. On the Home ribbon, click Status Control – Go Online to start online
calibration. ControlDesk connects to the CalDemo ECU. You are now directly
accessing the hardware.
2. In the Diagnostics Instrument on the diagnostics layout, select UDS Demo
Security Access Job and click Execute.

The job performs the following steps:


1. It executes the DiagnosticSessionControl service and changes to the
programmingSession.
2. It executes the SecurityAccessRequestSeed service to request the seed value
from the CalDemo ECU.
3. It executes the SecurityAccessSendKey service to send the key to the
CalDemo ECU.

Configuring and executing You can configure and execute services with the Diagnostics Instrument. For
diagnostic services example, you can execute the WriteDataByIdentifier service to configure the
current gear value.

76
ControlDesk Introduction and Overview May 2018
Demo Projects

To configure the gear value by executing a service, perform the following steps:
1. On the Home ribbon, click Status Control – Go Online to start online
calibration. ControlDesk connects to the CalDemo ECU. You are now directly
accessing the hardware.
2. In the Diagnostics Instrument on the diagnostics layout, select the
WriteDataByIdentifier service.

3. Select DemoCarEngineData as the DataIdentifier.

4. Specify 0x4 as the CurrentGear value.

77
May 2018 ControlDesk Introduction and Overview
Demos for ControlDesk

5. Click Execute to execute the WriteDataByIdentifier service.


The Time Plotter on the diagnostic variables layout displays the gear
change:

Measuring and calibrating You can measure and calibrate diagnostics variables via the ECU Diagnostics
variables via the ECU device in connection with ControlDesk's standard instruments. Measurement
Diagnostics device and calibration via the ECU Diagnostics device uses diagnostic services available
from the ODX database. When you calibrate a parameter value, for example, you
implicitly configure and execute the service related to that parameter.

ControlDesk's Variable Browser shows all the available diagnostics variables:

Perform the following steps:


1. On the Home ribbon, click Status Control – Start Measuring to start
measuring.
The Time Plotter on the diagnostics variables layout displays various
variables that originate from the ECU Diagnostics device.

78
ControlDesk Introduction and Overview May 2018
Demo Projects

2. Use, for example, the Climate Control Multiswitch on the diagnostics


variables layout to change the Desired Temperature parameter value.
You can observe the effect of the changed parameter value in the Time
Plotter.

Measuring diagnostic trouble The demo provides DTC measurement variables generated from the device's
codes (DTCs) ODX database. DTC measurement variables make diagnostic trouble codes visible
in ControlDesk instruments other than the Fault Memory and the Diagnostics
Instrument.

ControlDesk's Variable Browser shows all the available DTC measurement


variables in the <Diagnostic Trouble Codes> node:

79
May 2018 ControlDesk Introduction and Overview
Demos for ControlDesk

To change the current DTC states (set and clear DTCs) for DTC measurements,
perform the following steps:
1. On the Home ribbon, click Status Control – Start Measuring to start
measuring.
The instruments on the diagnostic trouble codes layout display various
DTC measurement variables.

2. Clear the checkboxes next to 0x1CC, 0x145 and 0x78.


This deactivates the occurrence of the selected DTCs, i.e., sets the DTC states
to 0.

80
ControlDesk Introduction and Overview May 2018
Demo Projects

3. Click next to the three DTCs.


This clears the DTCs:

Note

When you clear a DTC without having deactivated its occurrence, the
DTC reoccurs immediately after you clear it.

Tip

The Fault Memory Instrument on the diagnostic trouble codes layout also
displays when DTCs occurred. If you specify an Update Rate [s] value in the
instrument, this information is updated cyclically.

Monitoring Via ControlDesk's Bus Navigator, you can monitor CAN communication using
CAN communication the CAN Bus Monitoring device. The CAN Monitor monitoring list displays the
raw data of the monitored CAN communication:

81
May 2018 ControlDesk Introduction and Overview
Demos for ControlDesk

The monitored CAN messages originate from communication between the


ECU Diagnostics device and the CalDemo ECU:
§ CAN messages with the 0x001 ID are requests from the ECU Diagnostics
device.
§ CAN messages with the 0x002 ID are responses from the CalDemo ECU.

Related topics Basics

CalDemo ECU ......................................................................................................................... 99

Real-Time Application Demos

Opening demo projects For instructions on opening demo projects, refer to Opening a demo project
on page 60.

Description of the demo The RT application demo projects allow you to work with ControlDesk and use
projects all of its features in connection with dSPACE real-time hardware connected to
the host PC, and in connection with VEOS.

Required products and modules Working with this demo requires:


§ ControlDesk

82
ControlDesk Introduction and Overview May 2018
Demo Projects

Demo projects The RT application demos consist of the following demo


projects:

Project Description
DS1005 To access a DS1005 PPC Board connected to the host PC, the experiment
(including the DS1005 Demo contains a DS1005 PPC Board platform.
experiment)
DS1006 To access a DS1006 Processor Board connected to the host PC, the experiment
(including the DS1006 Demo contains a DS1006 Processor Board platform.
experiment)
DS1007 To access a DS1007 PPC Processor Board connected to the host PC, the
(including the DS1007 Demo experiment contains a DS1007 PPC Processor Board platform.
experiment)
DS1103 To access a DS1103 PPC Controller Board connected to the host PC, the
(including the DS1103 Demo experiment contains a DS1103 PPC Controller Board platform.
experiment)
DS1104 To access a DS1104 R&D Controller Board connected to the host PC, the
(including the DS1104 Demo experiment contains a DS1104 R&D Controller Board platform.
experiment)
DS1202 To access a MicroLabBox (DS1202) connected to the host PC, the experiment
(including the DS1202 Demo contains a DS1202 MicroLabBox platform.
experiment)
DS1401 To access a MicroAutoBox (DS1401) connected to the host PC, the experiment
(including the DS1401 Demo contains a MicroAutoBox platform.
experiment)
Scalexio To access a SCALEXIO system connected to the host PC, the experiment
(including the Scalexio Demo contains a SCALEXIO platform.
experiment)
Scalexio MC To access a SCALEXIO MC system connected to the host PC, the experiment
(including the Scalexio MC Demo contains a SCALEXIO platform.
experiment)
VEOS To access VEOS, the experiment contains a VEOS platform.
(including the VEOS Demo
experiment)

Throttle control implemented on the dSPACE real-time hardware The


application running on the dSPACE real-time hardware implements a throttle
control.

SDF and executable file When you open a real-time application demo
project, ControlDesk automatically loads an SDF file to the corresponding
platform. The SDF file describes measurement variables and parameters of the
throttle control application running on the dSPACE real-time hardware. It also
references an executable file with the throttle control application.

Running a demo project After you have opened a demo project, you have to configure the experiment's
platform according to the dSPACE real-time hardware connected to the host PC.

83
May 2018 ControlDesk Introduction and Overview
Demos for ControlDesk

For instructions, refer to How to Assign dSPACE Real-Time Hardware or VEOS to


a Platform ( ControlDesk Platform Management).

Then you can start a measurement to run the demo project. When you start a
measurement, the executable file with the throttle control real-time application is
downloaded to the dSPACE real-time hardware and then started. For
instructions, refer to How to Start Measuring ( ControlDesk Measurement and
Recording).

Related topics Basics

Handling Platforms ( ControlDesk Platform Management)


Handling Real-Time and Offline Simulation Applications ( ControlDesk Platform
Management)

Relay Maintenance Demo

Opening demo projects For instructions on opening demo projects, refer to Opening a demo project
on page 60.

Description of the demo To avoid the bonding of the relay contacts that are usually not switched during
project normal operation, it is recommended to perform relay cleaning in a SCALEXIO
system once a month.

The Relay Maintenance project lets you perform relay cleaning in a


SCALEXIO system.

For instructions, refer to How to Perform Relay Cleaning in a SCALEXIO System


( SCALEXIO Hardware Installation and Configuration).

Signal Editor Demos

Opening demo projects For instructions on opening demo projects, refer to Opening a demo project
on page 60.

Description of the demo The Signal Editor demo projects allow you to work with ControlDesk and use
projects Signal Editor features with dSPACE real-time hardware connected to the host PC.

84
ControlDesk Introduction and Overview May 2018
Demo Projects

Required products and modules Working with this demo requires:


§ ControlDesk
§ ControlDesk Signal Editor Module

Demo projects The Signal Editor application demos consist of the following
demo projects:

Project Description
SignalEditor_DS1005 To access a DS1005 PPC Board connected to the host PC, the
(including the DS1005 Demo experiment) experiment contains a DS1005 PPC Board platform.
SignalEditor_DS1006 To access a DS1006 Processor Board connected to the host PC, the
(including the DS1006 Demo experiment) experiment contains a DS1006 Processor Board platform.
SignalEditor_DS1007 To access a DS1007 PPC Processor Board connected to the host PC, the
(including the DS1007 Demo experiment) experiment contains a DS1007 PPC Processor Board platform.
SignalEditor_DS1202 To access a MicroLabBox (DS1202) connected to the host PC, the
(including the DS1202 Demo experiment) experiment contains a MicroLabBox platform.
SignalEditor_DS1401 To access a MicroAutoBox (DS1401) connected to the host PC, the
(including the DS1401 Demo experiment) experiment contains a MicroAutoBox platform.
SignalEditor_SCALEXIO To access a SCALEXIO system connected to the host PC, the experiment
(including the SCALEXIO Demo contains a SCALEXIO platform.
experiment)
SignalEditor_VEOS To access an offline simulation application running in VEOS, the
(including the VEOS Demo experiment) experiment contains a VEOS platform.

Demo overview The demo provides several signal generators, which can be
downloaded and started after online calibration is started. The illustration below
shows the demo for the DS1005 as an example. Online calibration is started and
the Simple.stz signal generator is downloaded to the DS1005.

85
May 2018 ControlDesk Introduction and Overview
Demos for ControlDesk

Throttle control implemented on the dSPACE real-time hardware The


application running on the dSPACE real-time hardware implements a throttle
control. It is derived from the application used by the Real-Time Application
Demos:
The SignalForm application parameter allows you to switch between a model-
internal signal generator and an external signal generator created by using the
Signal Editor.

SignalForm Description
Value
1 The model-internal signal generator is used. The signal form
is sawtooth.
2 The model-internal signal generator is used. The signal form
is square-wave.
3 The model-internal signal generator is used. The signal form
is sine.
5 The external signal generator created with the Signal Editor
is used. The Stimulus variable is stimulated.
The illustration below shows the two segment signals of the Simple.stz signal
generator as an example. The upper segment signal sets the SignalForm
parameter value to 5 for 59 seconds to enable external signal generation. Then
the value is set to 3 to reenable model-internal signal generation.
The lower segment signal stimulates the Stimulus signal: It is initially set to 0
for the first two seconds, then to a sawtooth signal, and finally to 0 again.

86
ControlDesk Introduction and Overview May 2018
Demo Projects

The illustration below shows the resulting measurement. After about 105
seconds' measurement time, the Simple.stz signal generator is started, and the
SignalForm value changes from 3 to 5. This starts stimulation of the Stimulus
parameter.

Running a demo project After you have opened a Signal Editor demo project, you have to perform the
following steps:
1. Configure the experiment's platform according to the dSPACE real-time
hardware connected to the host PC. For instructions, refer to How to Assign
dSPACE Real-Time Hardware or VEOS to a Platform ( ControlDesk Platform
Management).
2. Start online calibration. For instructions, refer to How to Start and Stop
Online Calibration ( ControlDesk Calibration and Data Set Management).
3. Download the signal generator. From the context menu of a signal generator,
select Stimulus Control – Download.
4. Start measuring. For instructions, refer to How to Start Measuring
( ControlDesk Measurement and Recording).
5. Start the signal generator. From the context menu of a signal generator,
select Stimulus Control – Start.

Related topics Basics

Basics on the Signal Editor ( ControlDesk Signal Editor)

87
May 2018 ControlDesk Introduction and Overview
Demos for ControlDesk

XIL API EESPort Demo

Opening demo projects For instructions on opening demo projects, refer to Opening a demo project
on page 60.

Description of the demo The XILAPIEESPortDemo project shows you ControlDesk and its electrical error
project simulation features in connection with dSPACE failure insertion hardware. As
your simulator probably does not match the configurations used for this demo,
you cannot use it to perform electrical error simulation, but you can gain an
impression of how electrical error simulation works.

Required products and modules Working with this demo requires:


§ ControlDesk
§ Failure Simulation Package
§ (If you work with SCALEXIO failure simulation units) ConfigurationDesk -
Implementation Version: SCALEXIO Failure Simulation

Demo overview The illustration below shows the error configuration for the
SCALEXIO XIL API EESPort as an example:

88
ControlDesk Introduction and Overview May 2018
Demo Projects

Contained XIL API EESPorts The following table shows which simulator
hardware you can use for the XIL API EESPorts in the demo project:

XIL API EESPort For Simulator Hardware


FullSizeVariant1 § dSPACE Simulator Full-Size with DS291 FIU Modules
§ SCALEXIO system with DS291 FIU Modules
FullSizeVariant2 dSPACE Simulator Full-Size with DS293 FIU Modules
MidSizeBasedOnDS2210_DS749 dSPACE Simulator Mid-Size based on DS2210 with DS749 FIU Modules
MidSizeBasedOnDS2210_DS789 dSPACE Simulator Mid-Size based on DS2211 with DS789 Sensor FIU Modules
MidSizeBasedOnDS2211 dSPACE Simulator Mid-Size based on DS2211 with DS791 and DS793 FIU
Modules
MidSizeBusBasedOnDS2211 dSPACE Simulator Mid-Size based on DS2211 with a DS1450 Bus FIU Board
SCALEXIO SCALEXIO system with its integrated FIU

Related topics Basics

Basics on Electrical Error Simulation ( ControlDesk Electrical Error Simulation via


XIL API EESPort)

89
May 2018 ControlDesk Introduction and Overview
Demos for ControlDesk

Automation Demos
Where to go from here Information in this section

Basics on Automation Demos ................................................................ 90


Provides an overview of the available automation demos.

Tool Automation Demos ........................................................................ 91


Demonstrate how to automate ControlDesk and use ControlDesk events.

MC3 Demos .......................................................................................... 94


Demonstrate how to remote-control ControlDesk's measurement and
calibration features using ControlDesk’s ASAM MCD-3 MC‑compatible
interface without platform/device hardware connected to the host PC.

D3 Demo ............................................................................................... 96
Demonstrates how to remote-control ControlDesk's ECU diagnostics
features using ControlDesk’s ASAM MCD-3 D‑compatible interface
without platform/device hardware connected to the host PC. The demo
uses the configuration of an ECU Diagnostics device in a ControlDesk
experiment.

Measurement Data API Demos .............................................................. 97


Demonstrate how to load, edit and create measurement data files using
ControlDesk’s Measurement Data API.

Basics on Automation Demos

Overview The ControlDesk installation provides the following automation demos:

Automation Demo(s) Focus


Tool automation Demonstrate how to automate ControlDesk and use ControlDesk events.
Refer to Tool Automation Demos
on page 91.
MC3 Demonstrate how to remote-control ControlDesk's measurement and
Refer to MC3 Demos on page 94. calibration features using ControlDesk’s ASAM MCD-3 MC‑compatible
interface without platform/device hardware connected to the host PC.
D3 Demonstrates how to remote-control ControlDesk's ECU diagnostics
Refer to D3 Demo on page 96. features using ControlDesk’s ASAM MCD-3 D‑compatible interface without
platform/device hardware connected to the host PC. The demo uses the
configuration of an ECU Diagnostics device in a ControlDesk experiment.
Measurement Data API Demonstrate how to load, edit and create measurement data files using
Refer to Measurement Data API Demos ControlDesk’s Measurement Data API.
on page 97.

90
ControlDesk Introduction and Overview May 2018
Automation Demos

Note

ControlDesk consists of several modules. To run demos, you must have


installed the related licenses.

Tip

For a short introduction to the Python programming language and


explanations on basic Python functions, refer to Basics on Python
( ControlDesk Automation). For example Python scripts, refer to Examples
of Python Scripts ( ControlDesk Automation).

Tool Automation Demos

Where to go from here Information in this topic

Description of the demos ........................................................................................................ 91


Location of the demos ............................................................................................................ 94
Translating code into other programming languages ............................................................... 94

Description of the demos The table below lists the demos that show how to automate ControlDesk and
use ControlDesk events:

Demo Description Refer to


BusNavigatorHandling Shows how to work with the Bus Navigator: Automating the Bus
§ Configuring and starting bus communication replay Navigator
§ Configuring and starting bus communication monitoring ( ControlDesk
§ Configuring and starting bus communication logging Automation)
§ Creating a custom Bus Instrument with events
CreateDefaultProjectOnStartUp Shows how to create a default project when ControlDesk starts. Creating a Project
When ControlDesk
Starts Up
( ControlDesk
Customization)
CustomUI Shows how to customize the ribbon. Example of
To extend the ControlDesk ribbon by using this demo: Customizing Ribbons
1. From the .\Demos\ToolAutomation\Python\CustomUI folder of via Extension Scripts
your ControlDesk installation, copy the ( ControlDesk
ExampleCustomUI.extscript file and the entire Customization)
ExampleCustomUI folder to the following folder:
%USERPROFILE%\Documents\dSPACE\
ControlDesk\6.3\ExtensionScripts
2. Restart ControlDesk.

91
May 2018 ControlDesk Introduction and Overview
Demos for ControlDesk

Demo Description Refer to


DataSetHandling Shows how to work with data sets: § Automating Data
§ Creating and copying a new data set Set Management
§ Showing information on the active data set ( ControlDesk
§ Defining working and reference data sets Automation)
§ Exporting and importing data sets § Automating
§ Managing events Parameter
Calibration
( ControlDesk
Automation)
ECUDiagnosticsHandling Shows how to work with an ECU Diagnostics device: Automating ECU
§ Creating an ECU Diagnostics (MCD-3D v2.0.2) device Diagnostics Tasks
§ Importing ODX database files for diagnostic tasks ( ControlDesk
§ Adding another ODX database and activating it Automation)
§ Selecting a vehicle for diagnostics tasks
§ Selecting a logical link for diagnostics tasks
§ Selecting a CAN interface for the logical link
§ Connecting the ECU Diagnostics (MCD-3D v2.0.2) device
§ Executing several diagnostic services and jobs
§ Executing an ECU flash programming session via ECU Diagnostics
§ Reading DTCs from the ECU fault memory
§ Reading environment data for a specific DTC
EventHandling Shows how to handle events:
§ Loading the CalDemo project via automation
§ Configuring events in the Project and Experiment context
§ Changing some parameter values to trigger events
§ Displaying logging information
ExperimentHandling Shows how to work with experiments: Automating Project
§ Creating, renaming, removing, importing and exporting an experiment and Experiment
§ Showing information on the active experiment Handling
§ Showing information on all experiments in the active project ( ControlDesk
§ Adding an XCP on CAN device to an experiment Automation)
§ Managing events
InterpreterHandling Shows how to work with the Internal Interpreter: Automating the
§ Running external scripts in the Interpreter Interpreter
§ Importing scripts to the Interpreter's namespace and adding commands ( ControlDesk
to the command stack Automation)
§ Running and stopping threads in the Interpreter
§ Editing Python scripts and document properties
§ Managing events
LayoutAndInstrumentHandling Shows how to work with layouts: § Automating
§ Adding and removing layouts Visualization of
§ Grouping layouts Variables on
§ Exporting and importing layouts in a new experiments Layouts
§ Adding instruments to a layout and arranging instruments ( ControlDesk
§ Showing layout and instrument information Automation)
§ Editing the Time Plotter § Automating
§ Editing the Variable Array Parameter
§ Editing the Table Editor Calibration
§ Creating an instrument with photorealistic appearance ( ControlDesk
§ Managing events Automation)

92
ControlDesk Introduction and Overview May 2018
Automation Demos

Demo Description Refer to


MeasuringAndRecording Shows how to measure and record data: Automating
§ Starting, configuring and stopping measurements Measurement and
§ Starting, configuring and stopping recordings Recording
§ Showing information about recorded measurement data ( ControlDesk
§ Exporting and importing recorded measurement data Automation)
§ Managing events
PlatformHandling Shows how to work with platforms: Automating Platform
§ Registering a platform Management and
§ Adding a registered platform to an experiment Variable
§ Creating and removing a platform Management
§ Editing a platform ( ControlDesk
§ Adding and editing a variable description Automation)
§ Connecting to a platform
§ Starting and stopping online calibration
§ Managing events
ProjectHandling Shows how to work with projects: § Automating
§ Showing information about the project roots Project and
§ Creating and removing the project root directory Experiment
§ Creating, loading and removing projects Handling
§ Showing information about the active project ( ControlDesk
§ Adding an experiment and a platform to the active project Automation)
§ Creating and loading a backup of a project § Automating Event
§ Managing events Management
( ControlDesk
Automation)
SignalEditorHandling Shows how to work with signal generators: Automating the
§ Opening an experiment with signal generators and reading signal Signal Editor
generator information ( ControlDesk
§ Downloading, starting, pausing and stopping signal generators Automation)
§ Mapping model variables to signals and variable aliases of a signal
generator
StartControlDesk Shows how to start ControlDesk, read some properties and close Automating the Start
ControlDesk. of ControlDesk
( ControlDesk
Automation)
UserInterfaceHandling Shows how to customize the user interface of ControlDesk, including the Automating User
main and child windows. Interface Handling
( ControlDesk
Automation)
VariableAccessHandling Shows how to access variable values directly, without using instruments: Automating Direct
§ Getting information on variables Variable Access
§ Reading and writing scalar variables ( ControlDesk
§ Reading and writing multidimensional variables Automation)
§ Accessing a variable via the variable identifier path

93
May 2018 ControlDesk Introduction and Overview
Demos for ControlDesk

The demos are available for the following programming languages:


§ C#
§ Python

Note

The Python demo scripts located in


the .\Demos\ToolAutomation\Python\AutomatingControlDesk
folder use Wait() functions to set the script execution to sleep. When
you execute these Python scripts in ControlDesk's Internal Interpreter,
the Wait() functions also set ControlDesk to sleep.

As a workaround, always execute Python demo scripts located in


the .\Demos\ToolAutomation\Python\AutomatingControlDesk
folder in an external interpreter.

Implementing modal dialogs in Python ControlDesk also provides some


example scripts that show you how to implement modal dialogs in Python.
However, the scripts run only in ControlDesk's Internal Interpreter. They are
located in the .\Demos\ToolAutomation\Python\DialogExamples folder of
your ControlDesk installation.

Location of the demos All the demos are located in


the .\Demos\ToolAutomation\<ProgrammingLanguage>\ folder of your
ControlDesk installation.

Translating code into other You can translate the Python demo scripts into other programming languages,
programming languages such as Visual Basic.

For further information, refer to Translating Python Code into Different


Programming Languages ( ControlDesk Automation).

Related topics Basics

Translating Python Code into Different Programming Languages ( ControlDesk


Automation)

MC3 Demos

Description of the demos Several Python demo scripts show how to use the commands of the asammc3
Python library to remote-control ControlDesk.

94
ControlDesk Introduction and Overview May 2018
Automation Demos

Remote-controlling the CalDemo project The demos are configured to


automate measurement and calibration tasks with the XCP on CAN experiment
of the CalDemo project. To automate measurement tasks, you have to start the
CalDemo ECU.

Demo scripts for calibration and measurement The table below lists the
calibration and measurement demo scripts, and the actions the scripts automate:

Demo Script Description


CalibrationDemoScalar.py1) Shows how to read and write scalar characteristics.
CalibrationDemoCurve.py1) Shows how to read and write CurveCharacteristics.
CalibrationDemoMap.py1) Shows how to read and write MapCharacteristics.
MeasurementDemo.py1) Shows how to measure values via collector events.
MeasurementDemoPolling.py1) Shows how to measure values by polling the collector.
MeasurementDemoRecording.py1) Shows how to record values.
1) The script contains named objects corresponding to the CalDemo project and the CalDemo ECU.

Demo scripts accessing the database side of the ASAM MCD-3


interface The table below lists the demos accessing the database side of the
ASAM MCD-3 interface, and the actions the scripts automate:

Demo Script Description


ListDbObjectsDemo.py § The ShowDbLogicalLink function shows how to iterate through
the projects, logical links and binaries available in the MCSystem.
§ The ShowDbObjects function loads the first project available in the
system and shows its contents, which is basically the contents of
one A2L file.
ListDbObjectsDemo_Devices.py1) The PrintDeviceInfo function shows how to list devices and
variable descriptions of an experiment.
ListDbObjectsDemo_VariableInfo.py1) The PrintDbLocationInfo function shows how to list names and
properties of variables in an experiment.
1) The script contains named objects corresponding to the CalDemo project and the CalDemo ECU.

Tip

You can translate the Python demo scripts into other programming
languages, such as C#, Visual Basic, and MATLAB M-files. As a starting
point, you can use the demo source files
in .\Demos\MC3\<ProgrammingLanguage> (available for C#, MATLAB and
VB). With these demo source files, you should be able to translate the
Python demo scripts into the language of your choice.

For further information, refer to Translating Python Code into Different


Programming Languages ( ControlDesk Automation).

Location of the demos All the Python demo scripts are located in the .\Demos\MC3\Python folder of
your ControlDesk installation.

95
May 2018 ControlDesk Introduction and Overview
Demos for ControlDesk

Related topics Basics

Basics on Automating Measurement and Calibration via ControlDesk's


MCD3 Interface ( ControlDesk MCD-3 Automation)

D3 Demo

Description of the demo The MCD3D_v2_0_2_DiagDemo.py demo script shows how to use the
commands of the asamd3 Python library to remote-control ControlDesk.

The demo script accesses ControlDesk's ASAM MCD-3 D interface via the
D3System202 interface. Using the D3System202 interface, you can access the
configuration of an ECU Diagnostics device in a ControlDesk experiment. The
ControlDesk experiment represents the D3 project.

Remote-controlling the DiagDemo project The demo script is configured


to automate the DiagDemo project (refer to ECU Diagnostics Demo on page 73).
It uses the ECU Diagnostics device configuration in the ECU Diagnostics
(MCD-3D v2.0.2) experiment (MCD3D_v2_0_2_DiagDemo.py) of the DiagDemo
project.
The demo script automates the following actions:
1. Creating the DSystem object
2. Selecting the D3 project (ControlDesk experiment)
3. Selecting vehicle information
4. Printing ODX database content for the selected vehicle
5. Creating and opening the logical link
6. Configuring the logical link
7. Executing some diagnostic services
8. Executing a single-ECU job
9. Deinitializing the DSystem object

Location of the demo The demo script is located in the .\Demos\D3\Python\DiagDemo folder of your
ControlDesk installation.

96
ControlDesk Introduction and Overview May 2018
Automation Demos

Related topics Basics

Basics on Automating ECU Diagnostics via ControlDesk's MCD3 Interface


( ControlDesk MCD-3 Automation)

HowTos

How to Perform Diagnostic Tasks ( ControlDesk MCD-3 Automation)

Measurement Data API Demos

Description of the demos The table below lists the Python demo scripts that show how to use the
Measurement Data API interfaces:

Demo Script Description


CreateAddAndRemove.py Shows basic aspects of the modification of measurements. It shows how to call the
methods Create, Add, and Remove for measurements, x-axes, scalings, signals,
bookmarks, and description categories.
DescriptionCategories.py Explains how the description categories are used with the Measurement Data API.
Measurements contain description information arranged in categories. The
description categories do not have to be created or removed. They are created
automatically with the measurement. The attributes of the description categories
can have different data types.
Downsample.py Performs downsampling on a measurement. The script needs the following
command line arguments:

Downsample <Factor> <SourceFilePath> [<DestinationFilePath>]

ListMeasurements.py Lists the measurement files that are passed as arguments to the standard output.
The script needs the following command line arguments:

ListMeasurements <FilePath1> [<FilePath2> [<FilePath3> [...] ] ]

LoadSaveAndExport.py Shows basic aspects of the creation and removal of measurements. It shows how to
call the methods Load, Save, and Export for measurements.
LoadSection.py Shows how to load a part of a measurement by defining a time section.
Lookups.py Shows how to create and access look-up tables.
MarkMinMax.py Marks the minimum and maximum values of a measurement by bookmarks. The
script needs the following command line arguments:

MarkMinMax <SignalKey> <SourceFilePath> [<DestinationFilePath>]

MeasurementArrays.py Shows how to create measurement arrays.

97
May 2018 ControlDesk Introduction and Overview
Demos for ControlDesk

Demo Script Description


ScalingTypes.py Scalings are used to transform a measurement signal's source value into a
converted value. This script explains all the scaling types and demonstrates how
scalings are used with the Measurement Data API.
SignalIdentification.py Shows how signals, x-axes, and scalings are identified within their collections.

Location of the demos All the demo scripts are located in the .\Demos\MeasurementDataAPI\Python
folder of your ControlDesk installation.

Related topics Basics

Basics on the Measurement Data API ( ControlDesk Measurement Data API)

98
ControlDesk Introduction and Overview May 2018
Demo Devices

Demo Devices
Where to go from here Information in this section

CalDemo ECU ....................................................................................... 99


The ControlDesk installation provides the CalDemo ECU.

CANGenerator .................................................................................... 101


The ControlDesk installation provides the CANGenerator.

CalDemo ECU

Introduction The ControlDesk installation provides the CalDemo ECU.

CalDemo ECU A program that runs on the same PC as ControlDesk. It


simulates an ECU on which the Universal Measurement and Calibration ( XCP)
protocol and the Unified Diagnostic Services (UDS) protocol are implemented.
The CalDemo ECU allows you to perform parameter calibration, variable
measurement, and ECU diagnostics with ControlDesk under realistic conditions,
but without having to have a real ECU connected to the PC. Communication
between the CalDemo ECU and ControlDesk can be established via XCP on CAN
or XCP on Ethernet, and UDS on CAN.

Tip

If communication is established via XCP on Ethernet, the CalDemo ECU can


also run on a PC different from the PC on which ControlDesk is running.

The memory of the CalDemo ECU consists of two areas called memory page.
Each page contains a complete set of parameters, but only one page is accessible
by the CalDemo ECU at a time. You can easily switch the memory pages of the
CalDemo ECU to change from one parameter to another in a single step.
Two ECU tasks run on the CalDemo ECU:
§ ECU task #1 runs at a fixed sample time of 5 ms. In ControlDesk's
Measurement Configuration, ECU task #1 is related to the time-based 5 ms,
10 ms, 50 ms and 100 ms measurement rasters of the CalDemo ECU.
§ ECU task #2 has a variable sample time. Whenever the CalDemo ECU program
is started, the initial sample time is 5 ms. This can then be increased or
decreased by using the dSPACE CalDemo dialog.
ECU task #2 is related to the extEvent measurement raster of the
CalDemo ECU.
The CalDemo ECU can also be used to execute diagnostic services and jobs,
handle DTCs and perform measurement and calibration via ECU diagnostics.

99
May 2018 ControlDesk Introduction and Overview
Demos for ControlDesk

The CalDemo ECU program is run by invoking CalDemo.exe. The file is located
in the .\Demos\CalDemo folder of the ControlDesk installation.

Throttle control implemented on the CalDemo ECU The application


running on the CalDemo ECU implements a throttle control.

A2L and ECU Image file The CalDemo ECU comes with an A2L file and an
ECU Image file. The A2L file describes measurement variables and parameters of
the throttle control application running on the CalDemo ECU.
The A2L file and the ECU Image file are located in the .\Demos\CalDemo folder
of your ControlDesk installation.

Demo projects using the CalDemo ECU The CalDemo ECU is used in the
following demo projects:
§ CalDemo on page 70
§ ECU Diagnostics Demo on page 73

Starting the CalDemo ECU ControlDesk starts the CalDemo ECU automatically when you open the CalDemo
or the DiagDemo project.

Starting the CalDemo ECU manually There are two ways to start the
CalDemo ECU manually, for example, if you closed it unintentionally:
§ From the Start menu, select All Programs – dSPACE ControlDesk <x.y> –
Demo Devices, and click CalDemo.
- OR -
§ Open a command prompt window, change to the .\Demos\CalDemo folder
of your ControlDesk installation, and type CalDemo.
You can also specify one of the following command line options:
§ -can to communicate with the CalDemo ECU via XCP on CAN. This is the
default if you do not specify a command line option.
§ -tcp to communicate with the CalDemo ECU via XCP on Ethernet (TCP)
§ -udp to communicate with the CalDemo ECU via XCP on Ethernet (UDP)

Result The CalDemo ECU is started and the dSPACE CalDemo dialog opens.

100
ControlDesk Introduction and Overview May 2018
Demo Devices

Note

Closing the dSPACE CalDemo dialog will stop the CalDemo ECU.

Related topics Basics

CalDemo ................................................................................................................................ 70
ECU Diagnostics Demo ........................................................................................................... 73

CANGenerator

Introduction The ControlDesk installation provides the CANGenerator.

CANGenerator A program that simulates a CAN system, that is, it generates


signals that can be measured and recorded with ControlDesk. The program runs
on the same PC as ControlDesk.
The CANGenerator allows you to use the CAN Bus Monitoring device under
realistic conditions, but without having to have any device hardware connected
to the PC.
The CAN (Controller Area Network) protocol is used for communication between
the CANGenerator and ControlDesk. However, since the CANGenerator runs on
the same PC as ControlDesk, ControlDesk does not communicate with the
device via a real CAN channel, but via a virtual CAN channel implemented on the
host PC.
The CAN generator program is run by invoking CANGenerator.exe. The file is
located in the .\Demos\CANGenerator folder of the ControlDesk installation.

Starting the CANGenerator There are two ways to start the CANGenerator:
§ From the Windows Start menu, select All Programs – dSPACE ControlDesk
<x.y> – Demo Devices, and click CanGenerator.
§ Invoke CANGenerator.exe, which is located in the .\Demos\CANGenerator
folder of the ControlDesk installation.

101
May 2018 ControlDesk Introduction and Overview
Demos for ControlDesk

Result The CalDemo ECU is started and the CanGenerator dialog opens.

Note

Closing the CanGenerator dialog will stop the CAN generator program.

Preparing a demo project There is no demo project prepared for the CANGenerator. To work with the
CANGenerator, you therefore have to create a project and experiment with a
CAN Bus Monitoring device yourself. Specify the CANGenerator.dbc file as the
variable description of the device. The file is located in
the .\Demos\CANGenerator folder of your ControlDesk installation.

Configure the device to use a virtual CAN channel:

102
ControlDesk Introduction and Overview May 2018
Compatibility, Migration and Discontinuations

Compatibility, Migration and Discontinuations

Where to go from here Information in this section

Compatibility of ControlDesk ............................................................... 104

Migrating from Prior Versions of ControlDesk ...................................... 110

Discontinuations in ControlDesk .......................................................... 156

103
May 2018 ControlDesk Introduction and Overview
Compatibility, Migration and Discontinuations

Compatibility of ControlDesk
Where to go from here Information in this section

Compatibility of ControlDesk 6.3 ......................................................... 104


To give you an overview of dSPACE software products that are
compatible with ControlDesk 6.3.

Compatibility of Firmware .................................................................... 105


To provide guidelines to determine the correct firmware version.

Compatibility of Real‑Time Testing ....................................................... 106


To give you guidelines to determine the correct Real‑Time Testing
(RTT) version.

Compatibility of ControlDesk 6.3

General product compatibility ControlDesk 6.3 is compatible with other dSPACE software products.
Compatibility means that different products can be used in parallel after software
installation.

Note

dSPACE recommends using only software products from the same dSPACE
Release. This ensures maximum run-time compatibility.

Working with real‑time ControlDesk 6.3, which is part of dSPACE Release 2018-A, lets you work with
applications on PHS‑bus- real‑time applications on PHS‑bus-based hardware, such as the DS1007 or
based hardware MicroAutoBox II, if these applications were built with one of the three previous
dSPACE Releases.

Working with a real‑time application means:


§ Downloading it to the hardware
§ Measuring and calibrating variables of the application

Note

It will not be possible to use ControlDesk 6.3 from dSPACE Release 2018-A
to experiment with applications generated with products from future
dSPACE Releases.

104
ControlDesk Introduction and Overview May 2018
Compatibility of ControlDesk

For details, refer to Run-Time Compatibility of dSPACE Software ( New


Features and Migration).

Working with a The products for working with a SCALEXIO system must be compatible. This is
SCALEXIO system guaranteed only for products delivered with the same dSPACE Release. Contact
dSPACE for more information if you have any questions.

Working with VEOS ControlDesk 6.3 supports only VEOS 4.2 from dSPACE Release 2018-A.

Working with the Signal To work with ControlDesk's Signal Editor and/or the Bus Navigator:
Editor and/or Bus Navigator § The RTT versions used for building the real-time application and used by the
Signal Editor and/or the Bus Navigator must be identical.
§ The RTT version must be 1.7.1 or higher.

For details, refer to RTT Installation and Signal Editor ( ControlDesk Signal
Editor) and/or RTT Installation and Bus Navigator ( ControlDesk Bus
Navigator).

Supported MATLAB Releases ControlDesk 6.3 supports real‑time applications only if they were built with one
of the supported MATLAB Releases.

For details, refer to Required MATLAB Releases ( Installing dSPACE Software).

Related topics Basics

Compatibility of Firmware ..................................................................................................... 105


Compatibility of Real‑Time Testing ........................................................................................ 106

Compatibility of Firmware

Introduction To provide guidelines to determine the correct firmware version.

General guideline dSPACE recommends using only software products from the same dSPACE
Release. This ensures maximum run-time compatibility.

105
May 2018 ControlDesk Introduction and Overview
Compatibility, Migration and Discontinuations

Firmware compatibility Firmware and real‑time application Firmware is downward‑compatible.


guidelines This means:
§ You can use the firmware from a dSPACE Release in the following cases:
§ The firmware is of the same dSPACE Release with which the real‑time
application was built.
§ The firmware is of a newer dSPACE Release than the dSPACE Release with
which the real‑time application was built.
§ You cannot use the firmware from a dSPACE Release if the firmware is of an
older dSPACE Release than the dSPACE Release with which the real‑time
application was built.

Hardware dependency of the required firmware version


§ If you work with DS1007, DS1202 MicroLabBox, or SCALEXIO, use the
firmware version that matches the dSPACE Release you are working with.

Real-Time SCALEXIO DS1202 DS1007 VEOS


Testing Firmware MicroLabBox Firmware Version
Version Version Firmware Version
Version
3.4 4.2 2.4 3.4 4.2
3.3 4.1 2.2 3.2 4.1
3.2 4.0 2.0 3.0 4.0
3.1 3.5 1.7 2.6 3.7
3.0 3.4 1.5 2.4 3.6
2.6 3.3 1.3 2.2 3.5
2.5 3.2 – 2.0 3.4
2.4 3.1 – – 3.3
2.3 3.0 – – 3.2
2.2 2.3 – – 3.1
§ If you work with any other dSPACE real‑time hardware, use the newest
firmware version available.

For up‑to‑date information on firmware updates, refer to


http://www.dspace.com/go/firmware.

Compatibility of Real‑Time Testing

Introduction To give you guidelines to determine the correct Real‑Time Testing (RTT) version.

Several RTT versions on the host PC If more than one RTT version is
installed on the host PC, only one RTT version is active. ControlDesk uses the
active RTT version.

106
ControlDesk Introduction and Overview May 2018
Compatibility of ControlDesk

You can use the dSPACE Installation Manager to:


§ Look up the RTT versions currently installed on the host PC
§ Activate another RTT version if you also have RTT 1.7.1 or later installed on the
host PC

Tip

You can install RTT 1.7.1 or later from the dSPACE Release DVD.

DS1005, DS1006, The RTT version used for building the real-time application and the RTT version
MicroAutoBox: required RTT active on the host PC must be identical to use RTT in connection with
versions ControlDesk and one of the following dSPACE simulation platforms:
§ DS1005
§ DS1006
§ MicroAutoBox

Looking up the RTT version used for building the real-time


application You can look up the RTT version used for building the real-time
application currently loaded on the dSPACE platform.
To look up the RTT version, the platform state must be one of the following:
§ Connected
§ Online calibration started
§ Measuring/recording
When you select the platform in ControlDesk's Platform Manager, the
RTT version of the application is displayed in the Properties controlbar. The
following illustration shows an example.

107
May 2018 ControlDesk Introduction and Overview
Compatibility, Migration and Discontinuations

SCALEXIO, MicroLabBox, The RTT version of the simulation platform and the RTT version active on the
DS1007, VEOS: required RTT host PC must be identical to use RTT in connection with ControlDesk and one of
versions the following dSPACE simulation platforms:
§ dSPACE real‑time simulation platforms:
§ SCALEXIO
§ MicroLabBox
§ DS1007
The RTT version of a real‑time simulation platform depends on the platform's
firmware version.
§ VEOS
The RTT version of VEOS depends on the product version.

The following table shows the mapping between the firmware/product version
and the corresponding RTT version:

Real-Time SCALEXIO DS1202 DS1007 VEOS


Testing Firmware MicroLabBox Firmware Version
Version Version Firmware Version
Version
3.4 4.2 2.4 3.4 4.2
3.3 4.1 2.2 3.2 4.1

108
ControlDesk Introduction and Overview May 2018
Compatibility of ControlDesk

Real-Time SCALEXIO DS1202 DS1007 VEOS


Testing Firmware MicroLabBox Firmware Version
Version Version Firmware Version
Version
3.2 4.0 2.0 3.0 4.0
3.1 3.5 1.7 2.6 3.7
3.0 3.4 1.5 2.4 3.6
2.6 3.3 1.3 2.2 3.5
2.5 3.2 – 2.0 3.4
2.4 3.1 – – 3.3
2.3 3.0 – – 3.2
2.2 2.3 – – 3.1

Looking up the firmware version You can look up the firmware version
used on a dSPACE real‑time simulation platform.
To look up the firmware version, the platform state must be one of the
following:
§ Connected
§ Online calibration started
§ Measuring/recording
When you select the platform in ControlDesk's Project Manager, the firmware
version is displayed in the Properties controlbar. The following illustration shows
an example.

Related topics Basics

RTT Installation and Bus Navigator ( ControlDesk Bus Navigator)


RTT Installation and Signal Editor ( ControlDesk Signal Editor)

109
May 2018 ControlDesk Introduction and Overview
Compatibility, Migration and Discontinuations

Migrating from Prior Versions of ControlDesk


Where to go from here Information in this section

Basics on Migrating from Prior Versions of ControlDesk ....................... 111


When you migrate from older ControlDesk versions to ControlDesk 6.3
and reuse existing experiments, you may have to carry out additional
migration steps.

Migrating from ControlDesk 4.0 to 4.1 ................................................ 112


To migrate from ControlDesk 4.0 to ControlDesk 4.1 and reuse existing
experiments, you may have to carry out additional migration steps.

Migrating from ControlDesk 4.1 to 4.2.x ............................................. 114


To migrate from ControlDesk 4.1 to ControlDesk 4.2.x and reuse existing
experiments, you may have to carry out additional migration steps.

Migrating from ControlDesk 4.2.x to 4.3 ............................................. 116


To migrate from ControlDesk 4.2.x to ControlDesk 4.3 and reuse existing
experiments, you do not have to carry out any migration steps.

Migrating from ControlDesk 4.3 to 5.0 ................................................ 117


To migrate from ControlDesk 4.3 to ControlDesk 5.0 and reuse existing
experiments, you may have to carry out additional migration steps.

Migrating from ControlDesk 5.0 to 5.1 ................................................ 120


To migrate from ControlDesk 5.0 to ControlDesk 5.1 and reuse existing
experiments, you may have to carry out additional migration steps.

Migrating from ControlDesk 5.1 to 5.2 ................................................ 127


To migrate from ControlDesk 5.1 to ControlDesk 5.2 and reuse existing
experiments, you may have to carry out additional migration steps.

Migrating from ControlDesk 5.2 to 5.3 ................................................ 131


To migrate from ControlDesk 5.2 to ControlDesk 5.3 and reuse existing
experiments, you may have to carry out additional migration steps.

Migrating from ControlDesk 5.3 to 5.4 ................................................ 132


To migrate from ControlDesk 5.3 to ControlDesk 5.4 and reuse existing
experiments, you may have to carry out additional migration steps.

Migrating from ControlDesk 5.4 to 5.5 ................................................ 133


To migrate from ControlDesk 5.4 to ControlDesk 5.5 and reuse existing
experiments, you may have to carry out additional migration steps.

Migrating from ControlDesk 5.5 to 5.6 ................................................ 138


To migrate from ControlDesk 5.5 to ControlDesk 5.6 and reuse existing
experiments, you may have to carry out additional migration steps.

Migrating from ControlDesk 5.6 to 6.0 ................................................ 142


To migrate from ControlDesk 5.6 to ControlDesk 6.0 and reuse existing
experiments, you may have to carry out additional migration steps.

110
ControlDesk Introduction and Overview May 2018
Migrating from Prior Versions of ControlDesk

Migrating from ControlDesk 6.0 to 6.1 ................................................ 147


To migrate from ControlDesk 6.0 to ControlDesk 6.1 and reuse existing
experiments, you may have to carry out additional migration steps.

Migrating from ControlDesk 6.1 to 6.2 ................................................ 149


To migrate from ControlDesk 6.1 to ControlDesk 6.2 and reuse existing
experiments, you may have to carry out additional migration steps.

Migrating from ControlDesk 6.2 to 6.3 ................................................ 154


To migrate from ControlDesk 6.2 to ControlDesk 6.3 and reuse existing
experiments, you may have to carry out additional migration steps.

Basics on Migrating from Prior Versions of ControlDesk

Automatic migration of When you open a project last saved with ControlDesk 6.2 or earlier in
projects ControlDesk 6.3, ControlDesk opens the following dialog that lets you convert
the project and all its contained experiments.

Click Yes to confirm project conversion.

Tip

Since the converted project cannot be loaded with ControlDesk 6.2 or


earlier, a backup of the original project is stored in the project root folder
during migration.

Additional migration steps in In some cases, you have to carry out additional migration steps after project
some cases conversion.

As described in the following topics, check whether you have to perform


additional migration steps. Do this in ascending order of the intermediate
ControlDesk versions, as shown in the illustration below.

111
May 2018 ControlDesk Introduction and Overview
Compatibility, Migration and Discontinuations

Version

ControlDesk x

x+1
Check whether to perform
... additional migration steps

x+m-1

ControlDesk x+m

Migrating from ControlDesk 4.0 to 4.1

Introduction To migrate from ControlDesk 4.0 to ControlDesk 4.1 and reuse existing
experiments, you may have to carry out additional migration steps.

Where to go from here Information in this topic

Reloading variable descriptions of XCP devices ...................................................................... 112


Corrected indexing of measurement array elements .............................................................. 112
Measurement arrays in measurement data files created with the Measurement Data
API ....................................................................................................................................... 113
Tool automation changes ...................................................................................................... 113
Discontinuation of the Enums module ............................................................................. 113

Reloading variable If your project/experiment contains one or more XCP devices, you have to reload
descriptions of XCP devices the related variable description (A2L) files in ControlDesk 6.3. Refer to Reload
Variable Description ( ControlDesk Variable Management).

Corrected indexing of The indexing of the elements of a measurement array was incorrect in
measurement array elements ControlDesk 4.0 and in CalDesk. It is correct in ControlDesk 4.1 and later.

§ Indexing in ControlDesk 4.0 and CalDesk


The illustration below shows a measurement array with the dimension [5;2;1]
in a Table Editor as an example. The elements of the measurement array are
also visualized in a Variable Array.
The element with index [2;1;1] has row (x-axis) index 2 and column (y-axis)
index 1 in the Table Editor. The row index and the column index are correct. In
the Variable Array, the indexing is erroneously swapped.

112
ControlDesk Introduction and Overview May 2018
Migrating from Prior Versions of ControlDesk

§ Indexing as of ControlDesk 4.1


The illustration below shows the same measurement array in a Table Editor
and in a Variable Array of ControlDesk 4.1 or later.
In the Table Editor, the element with the index [2;1;1] has row (x-axis) index 2
and column (y-axis) index 1. The indexing is correct and consistent in the Table
Editor and in the Variable Array.

Measurement arrays in The orientation of multidimensional measurement arrays in measurement data


measurement data files files created with the Measurement Data API has changed: As of
created with the ControlDesk 4.3, measurement arrays are stored in a column-oriented layout.
Measurement Data API
Indexing of measurement array elements (see above) has been corrected, so
ControlDesk now interprets measurement arrays in measurement data files as
being column-oriented. Measurement data file creation via the Measurement
Data API has been changed accordingly.

Tool automation changes Discontinuation of the Enums module The Python-based tool automation
demos for ControlDesk 4.1 and later no longer use the Enums module
containing enumeration definitions for configuring automation elements of
ControlDesk.

113
May 2018 ControlDesk Introduction and Overview
Compatibility, Migration and Discontinuations

If you imported the Enums module in your script, you are recommended to
replace the import and usage of the module like this:
1. In your script, remove the import instruction for the Enums module. For
example, remove from Enums import PlatformType from your script.
2. Import the enumeration definitions like this:
from dspace.com import Enums
3. Define an Enums object like this:
self.Enums = Enums(self.ControlDeskApplication)

4. Change the usage of enumeration definitions like this:


Change

MyDevice = self.ControlDeskApplication.ActiveProject.Platforms.Add(PlatformType.CCP)

to

MyDevice = self.ControlDeskApplication.ActiveProject.Platforms.Add(self.Enums.PlatformType.CCP)

Related topics Basics

Basics on Migrating from Prior Versions of ControlDesk ........................................................ 111

Migrating from ControlDesk 4.1 to 4.2.x

Introduction To migrate from ControlDesk 4.1 to ControlDesk 4.2.x and reuse existing
experiments, you may have to carry out additional migration steps.

Where to go from here Information in this topic

Migrating to the new ECU Diagnostics device ....................................................................... 114


CAN Bus Monitoring device: Enhanced CAN message display ............................................... 115
Migrating Plotters originally created with ControlDesk 4.1 or earlier ...................................... 115
Tool automation changes ...................................................................................................... 115
Changed automation access to saved measurement data files ......................................... 115

Migrating to the new ECU ControlDesk now provides two variants for the ECU Diagnostics device, each
Diagnostics device supporting a different ASAM MCD 3D standard version:
§ The ECU Diagnostics v2.0.1 device supports ASAM MCD-3 D 2.0.1.

114
ControlDesk Introduction and Overview May 2018
Migrating from Prior Versions of ControlDesk

When you open an experiment (last saved with ControlDesk 4.0 or 4.1) in
ControlDesk 4.2, an ECU Diagnostics device is converted into the ECU
Diagnostics v2.0.1 device automatically.
§ The ECU Diagnostics v2.0.2 device supports ASAM MCD-3 D 2.0.2.

Using the ECU Diagnostics v2.0.2 device instead of the ECU Diagnostics v2.0.1
device has the advantage of an extended automation interface.

To migrate from the ECU Diagnostics v2.0.1 device to the new ECU Diagnostics
v2.0.2 device, you have to recompile the relevant diagnostic jobs according to
ASAM MCD-3 D 2.0.2.

CAN Bus Monitoring device: As of ControlDesk 4.2, the Variable Browser displays the names of
Enhanced CAN message CAN messages (instead of their IDs), so that they are easier to identify.
display
To display the names of CAN messages (instead of their IDs) when you reuse an
experiment created with ControlDesk 4.1 or earlier, you have to reload the
related variable description (DBC file). Refer to Reload Variable Description
( ControlDesk Variable Management).

Migrating Plotters originally As of ControlDesk 4.2, the Plotter uses the settings of the leading raster for the
created with ControlDesk 4.1 Plotter's triggered visualization. The leading raster is the raster of one of the
or earlier connected variables of a real-time application.

When you migrate a project/experiment with Plotters originally created with


ControlDesk 4.1 or earlier, no leading raster is defined for these Plotters so that
modifications to raster settings such as the duration value of a duration trigger
are not automatically applied to the migrated Plotters.

As a workaround, specify a leading raster for these Plotters manually.

Tool automation changes Changed automation access to saved measurement data files The
automation access to measurement data files created with one of the following
commands has changed in ControlDesk 4.2:
§ Save Buffer ( ControlDesk Measurement and Recording)
§ Save Displayed Data as New Measurement ( ControlDesk Instrument
Handling)
§ Upload Flash Flight Recorder Contents ( ControlDesk Platform
Management)
Up to ControlDesk 4.1, access to such a measurement data file by a Python script
was like this:

Application.MeasurementDataManagement.MainRecorder.LastRecordedFiles[0]

As of ControlDesk 4.2, access to such a measurement data file by a Python script


is like this:

§ Application.MeasurementDataManagement.MeasurementConfiguration.
SaveMeasurementBufferStorageInformation.LastCreatedFile

115
May 2018 ControlDesk Introduction and Overview
Compatibility, Migration and Discontinuations

§ Application.MeasurementDataManagement.MeasurementConfiguration.
SaveDisplayedDataStorageInformation.LastCreatedFile

§ Application.MeasurementDataManagement.MeasurementConfiguration.
SaveFlightRecorderDataStorageInformation.LastCreatedFile

Related topics Basics

Basics on Migrating from Prior Versions of ControlDesk ........................................................ 111

Migrating from ControlDesk 4.2.x to 4.3

Introduction To migrate from ControlDesk 4.2.x to ControlDesk 4.3 and reuse existing
experiments, you do not have to carry out any migration steps.

Where to go from here Information in this topic

Changed behavior when opening a project/experiment from backup .................................... 116


Tool automation changes ...................................................................................................... 117
Changed behavior of the HCenterPosition and HHubPosition automation
properties ........................................................................................................................ 117
Changed behavior of the GetInstrument automation method .......................................... 117

Changed behavior when The behavior when opening a project/experiment from backup has been
opening a project/experiment changed:
from backup

Behavior ...
... up to and including ControlDesk ... as of ControlDesk 4.3
4.2.x
When you open a project/experiment from When you open a project/experiment from backup with ControlDesk
backup with ControlDesk 4.2.x or before, 4.3 or later, only the layouts that were open when the backup was
all the layouts in the experiment are created are opened if the backup was created with ControlDesk 4.3 or
opened. later.

Note

When you open a project/experiment from backup with


ControlDesk 4.3 or later, no layout is opened if the backup was
created with ControlDesk 4.2.x or before.

116
ControlDesk Introduction and Overview May 2018
Migrating from Prior Versions of ControlDesk

Tool automation changes Changed behavior of the HCenterPosition and HHubPosition automation
properties The behavior of the following automation properties has
changed:
§ HCenterPosition (IViSlideBar interface)
§ HHubPosition (IViGaugeInstrument and IViKnobInstrument interfaces)

Behavior ...
... up to and including ControlDesk 4.2.x ... as of ControlDesk 4.3
When you specify a positive value for one of the above When you specify a positive value for one of the above
properties, the position is moved to the left. properties, the position is moved to the right.

Changed behavior of the GetInstrument automation method The


behavior of the GetInstrument automation method, which belongs to the
IXaLayoutDocument interface, has changed.

Behavior ...
... up to and including ControlDesk 4.2.x ... as of ControlDesk 4.3
If the specified instrument is not on the layout, the method If the specified instrument is not on the layout, an
returns None. exception is thrown.

Related topics Basics

Basics on Migrating from Prior Versions of ControlDesk ........................................................ 111

Migrating from ControlDesk 4.3 to 5.0

Introduction To migrate from ControlDesk 4.3 to ControlDesk 5.0 and reuse existing
experiments, you may have to carry out additional migration steps.

Where to go from here Information in this topic

Multiconnect group support discontinued ............................................................................. 118


Migrating from multiconnect groups ............................................................................... 118
Migrating formulas for calculated variables ........................................................................... 118
Tool automation changes ...................................................................................................... 118
Changes to failure simulation automation interfaces ........................................................ 118
Changes to Bus Navigator automation interfaces ............................................................. 119
Changes to Signal Editor automation interfaces ............................................................... 119

117
May 2018 ControlDesk Introduction and Overview
Compatibility, Migration and Discontinuations

Multiconnect group support Before ControlDesk 5.0, to experiment with several network clients (= expansion
discontinued boxes and/or MicroAutoBox II systems connected to the host PC via Ethernet) at
the same time, you had to define multiconnect groups in the
dsgroups.ini file.

As of ControlDesk 5.0, working with multiconnect groups defined in the


dsgroups.ini file is no longer supported. To experiment with several network
clients at the same time, you have to register each client such as MicroAutoBox II
individually.

Migrating from multiconnect groups If you worked with multiconnect


groups before ControlDesk 5.0, you have to register each multiconnect group
member when you migrate to ControlDesk 5.0 or later. For instructions, refer to
How to Register a Platform ( ControlDesk Platform Management).

Migrating formulas for The interpretation of formulas for calculated variables has changed: Up to
calculated variables ControlDesk 5.0, a Python interpreter was used to interpret formulas. As of
ControlDesk 5.0, a new interpreter based on C# is used. As a consequence, you
may have to adapt existing formulas to reuse them in ControlDesk 5.0.

The table below shows examples of syntax differences:

Python Syntax1) C# Syntax2)

NaN
NaN Double.NaN

Ternary Operator
§ (Param2, (NaN))[not Param1 == 0] Param1 != 0 ? Param2 : Double.NaN
§ a if a != 0 else NaN
§ a != 0 and a or NaN

Cast
§ int(a) § ((Int32) a)
§ float(a) § ((Double) a)
§ ((Single) a)

Exponent
a**2 Math.Pow(a,2)
1) To be used up to ControlDesk 5.0
2) To be used as of ControlDesk 5.0

For details on the new formula syntax, refer to Defining Formulas for Calculated
Variables ( ControlDesk Variable Management).

Tool automation changes Changes to failure simulation automation interfaces The type of the
parameter in the Contains method of the failure simulation collection interfaces
has been changed to object. This lets you specify the item in question more
flexibly as shown in the following examples:

118
ControlDesk Introduction and Overview May 2018
Migrating from Prior Versions of ControlDesk

# Systems / IFsSystems <<Collection>>


Systems.Contains(SystemObj)
Systems.Contains("C:\\Users\\DemoUser\\Documents\\dSPACE\\ControlDeskNG\\5.0\\FailureSimulationDemo\\
MidSizeBasedOnDS2211\\Failure Simulation\\FIU Mid-Size DS2211.fsn")
Systems.Contains("FIU Mid-Size DS2211.fsn")
Systems.Contains("FIU Mid-Size DS2211")

# FailureClasses / IFsFailureClasses <<Collection>>


FailureClasses.Contains(FailureClassObj)
FailureClasses.Contains(300) # ID
FailureClasses.Contains("Open circuit") # Name

# FailurePatterns / IFsFailurePatterns <<Collection>>


FailurePatterns.Contains(FailurePatternObj)
FailurePatterns.Contains("FailurePatternName")

# FailurePatternPins / IFsFailurePatternPins <<Collection>>


FailurePatternPins.Contains(FailurePatternPinObj)
FailurePatternPins.ContainsByName("PinName", "ECUName") # Both names are required to specify a pin

# FailurePatternFailures / IFsFailurePatternFailures <<Collection>>


FailurePatternFailures.Contains("FailureName")

# FailurePins / IFsFailurePins <<Collection>>


FailurePins.Contains(FailurePinObj)
FailurePins.ContainsByName("PinName", "ECUName") # Both names are required to specify a pin

# ECUs / IFsECUs <<Collection>>


ECUs.Contains(ECUObj)
ECUs.Contains("ECUName")

# Pins / IFsPins <<Collection>>


Pins.Contains(PinObj)
Pins.Contains("PinName")

Changes to Bus Navigator automation interfaces ControlDesk's behavior


concerning the CANReplay / IBnCANReplay <<Interface>> ( ControlDesk
Automation) interface has been changed.
When you enable the Activated property of the interface, ControlDesk
validates the specified values of the interface and throws an exception if the
validation is unsuccessful.

Changes to Signal Editor automation interfaces ControlDesk's behavior


concerning the SignalDescriptionSets / IXaSignalDescriptionSets <<Collection>>
( ControlDesk Automation) and the SignalGenerators / IXaSignalGenerators
<<Collection>> ( ControlDesk Automation) collections has been changed.
If you specify an incorrect path when importing a signal generator or signal
description set via automation, an exception is thrown as of ControlDesk 5.0.

Related topics Basics

Basics on Migrating from Prior Versions of ControlDesk ........................................................ 111

119
May 2018 ControlDesk Introduction and Overview
Compatibility, Migration and Discontinuations

Migrating from ControlDesk 5.0 to 5.1

Introduction To migrate from ControlDesk 5.0 to ControlDesk 5.1 and reuse existing
experiments, you may have to carry out additional migration steps.

Where to go from here Information in this topic

Migrating to the ECU Diagnostics v2.0.2 device .................................................................... 120


Migration overview .......................................................................................................... 120
Migrating projects containing experiments with the ECU Diagnostics v2.0.1 device........... 120
Migrating tool automation scripts with the ECU Diagnostics v2.0.1 device ....................... 124
Migrating MCD-3 D automation scripts ........................................................................... 124
Tool automation changes ...................................................................................................... 125
Migrating scripts from Python 2.5 to Python 2.7 .............................................................. 125
Changed default assignment mode for SCALEXIO ........................................................... 125
Changed behavior of the TimingSequenceName property ................................................ 126
Changed behavior of the Selection Box's SelectedItemChanged event ............................. 126

Migrating to the ECU The ECU Diagnostics v2.0.1 device (supporting ASAM MCD-3 D V2.0.1) was
Diagnostics v2.0.2 device delivered for the last time with dSPACE Release 2013-A. This means you must
migrate to the ECU Diagnostics v2.0.2 device (supporting ASAM MCD-3 D
V2.0.2), the successor to the ECU Diagnostics v2.0.1 device.

Migration overview The main migration steps are:


§ Adapt the COMPARAM‑SPEC containing communication parameter (COMPARAM)
definitions according to the D-PDU API (ISO 22900‑2).

Tip

ControlDesk's Project Converter lets you perform these adaptations


when you open a project containing experiments with the ECU
Diagnostics v2.0.1 device. Refer to Migrating projects containing
experiments with the ECU Diagnostics v2.0.1 device on page 120.

§ If you use diagnostic jobs, recompile them against the job API of the MCD-3 D
v2.0.2 standard.
§ Adapt your automation scripts (refer to Migrating tool automation scripts with
the ECU Diagnostics v2.0.1 device on page 124 and Migrating MCD-3 D
automation scripts on page 124).

Migrating projects containing experiments with the ECU Diagnostics


v2.0.1 device To reuse a project containing experiments with the ECU
Diagnostics v2.0.1 device, perform the following steps:
1. Open the project containing experiments with the ECU Diagnostics v2.0.1
device. The following dialog opens, asking you to convert the project and the
contained experiments:

120
ControlDesk Introduction and Overview May 2018
Migrating from Prior Versions of ControlDesk

2. Click Yes to confirm.


ControlDesk's Project Converter converts the project like this:
1. Each ECU Diagnostics v2.0.1 device in the project is converted into an ECU
Diagnostics v2.0.2 device.

Tip

Since the project cannot be loaded with ControlDesk 5.0 or earlier, a


backup of the original project is stored in the project root folder
during migration.

2. The COMPARAM‑SPEC of the device's ODX database is adapted using the


diagnostic protocol-specific COMPARAM‑SPEC template files in
the .\Main\bin\Templates\ODX\COM_PARAMs folder in the
ControlDesk installation.
Adaptation is necessary since the ECU Diagnostics v2.0.1 device and the
ECU Diagnostics v2.0.2 device use different methods for
COMPARAM identification:
§ The ECU Diagnostics v2.0.1 device used the optional PDU-API-INDEX
parameter to identify a COMPARAM.
§ The ECU Diagnostics v2.0.2 device uses the short name of the
parameter to identify a COMPARAM. ControlDesk supports all the
standard communication parameters defined in D-PDU API according
to ISO 22900-2.
The COMPARAMs are adapted like this:
§ The values of COMPARAMs identified by a PDU-API-INDEX parameter are
added to the COMPARAM-SPEC template file and adapted to the D-PDU
API (ISO 22900-2) communication parameter format, e.g., timings are
specified in µs instead of in ms.
§ COMPARAMs that are not identified by a PDU-API-INDEX parameter are
adapted using a default value.

121
May 2018 ControlDesk Introduction and Overview
Compatibility, Migration and Discontinuations

§ COMPARAMs that are identified by a PDU-API-INDEX parameter but for


which there is no corresponding D-PDU API (ISO 22900-2)
communication parameter are not adapted. A dSPACE Log entry is
made.
3. After conversion, there are two different ways to proceed:
§ Using the ODX data converted by ControlDesk's Project Converter:
1. Check the dSPACE Log for possible conversion errors.
2. Check whether communication to the ECU can be established after
device conversion.
If no communication to the ECU can be established, you can also add
ODX data to the converted device. See below (Using new ODX data).
If still no communication to the ECU can be established, contact
dSPACE Support.
3. If you use diagnostic jobs, recompile them against the job API of the
MCD-3 D v2.0.2 standard.
4. Reload the recompiled diagnostic jobs in the Select ODX Files Dialog.

Note

Do not reload all the ODX data since this overwrites the converted
ODX data.

§ OR: Using new ODX data, which is an alternative to the


COMPARAM conversion described above:
1. If you use diagnostic jobs, recompile them against the job API of the
MCD-3 D v2.0.2 standard.

122
ControlDesk Introduction and Overview May 2018
Migrating from Prior Versions of ControlDesk

2. Add ODX data to the converted device with COMPARAMs according to


the D-PDU API (ISO 22900-2) communication parameter format.

Note

There are some conversion limitations:


§ Conversion is possible only for the following protocols:
§ KWP2000 on K‑Line (ISO 14230)
§ Diagnostics on CAN (ISO 15765)
§ UDS on CAN (ISO 14229)
§ OBD
Contact dSPACE Support for migration support if you use other
diagnostic protocols.
§ Do not reload the ODX data after device conversion since this overwrites
the converted ODX data. Recompiled diagnostic jobs are an exception.
§ If the ODX database contains no vehicle information specification, logical
link names are automatically generated. The generation of logical link
names, however, is different for the ECU Diagnostics v2.0.1 device and
the ECU Diagnostics v2.0.2 device. Logical link names are used to name
nodes in the generated variable description containing diagnostic
variables. To avoid invalid connections between these variables and
instruments after conversion, ControlDesk does not change the logical
link names used for nodes in the generated variable description.
As a consequence, the names of logical links used for nodes in the
generated variable description are different from the logical link names
appearing in the device configuration.
For details on the naming of logical links, refer to Add ODX Database
( ControlDesk Platform Management).

Note

The generation of the names of the Hex service and of the


ProtocolParameterSet control primitive is different for the ECU
Diagnostics v2.0.1 device and the ECU Diagnostics v2.0.2 device:
§ ECU Diagnostics v2.0.1 device:
§ #RT_GEN_DS HEXSERVICE <LogicalLink_name>
§ #RT_GEN_DS PROTOCOL PARAMETER SET <LogicalLink_name>
ECU Diagnostics v2.0.2 device:
§ #RT_GEN_DS_HEXSERVICE
§ #RT_GEN_DS_PROTOCOLPARAMETERSET
The generation of the name of the parameter of the Hex service is different
for the ECU Diagnostics v2.0.1 device and the ECU Diagnostics v2.0.2
device:
§ ECU Diagnostics v2.0.1 device:
§ #RT_GEN_PARAM BYTEFIELD <LogicalLink_name>
§ ECU Diagnostics v2.0.2 device:
§ #RT_GEN_PARAM_BYTEFIELD

123
May 2018 ControlDesk Introduction and Overview
Compatibility, Migration and Discontinuations

Migrating tool automation scripts with the ECU Diagnostics v2.0.1


device To reuse tool automation scripts with the ECU Diagnostics v2.0.1
device, perform the following steps:
1. Migrate the ControlDesk project containing experiments with the ECU
Diagnostics v2.0.1 device (see Migrating projects containing experiments with
the ECU Diagnostics v2.0.1 device on page 120).

2. In the script to be reused, change the following:


1. If your script contains a statement to add an ECU Diagnostics v2.0.1
device, you have to change the selected PlatformType:

ECU Diagnostics v2.0.1 Device ECU Diagnostics v2.0.2 Device


Adding a device PlatformType = Diagnostic = 14 PlatformType = Diagnostic2 = 27

For details, refer to PlatformType <<Enumeration>> ( ControlDesk


Automation).
2. The automation interface for selecting the physical connection to be used
for a logical link is different for the ECU Diagnostics v2.0.1 device and the
ECU Diagnostics v2.0.2 device. You therefore have to adapt your script:

ECU Diagnostics v2.0.1 Device ECU Diagnostics v2.0.2 Device


Automation interface IPmECUDiagnosticsLogicalLink IPmECUDiagnostics2LogicalLink
Property § CANInterfaceSelection InterfaceSelection
§ KlineInterfaceSelection

For details, refer to ECUDiagnostics2LogicalLink /


IPmECUDiagnostics2LogicalLink <<Interface>> ( ControlDesk
Automation).
3. If the ODX database contains no vehicle information specification, logical
link names are automatically generated. The generation of logical link
names, the generation of the names of the Hex service and of the
ProtocolParameterSet control primitive, and the generation of the
name of the parameter of the Hex service, however, are different for the
ECU Diagnostics v2.0.1 device and the ECU Diagnostics v2.0.2 device. You
therefore have to adapt your script according to the new names.
For details on the naming of logical links, refer to Add ODX Database
( ControlDesk Platform Management).

Migrating MCD-3 D automation scripts In connection with the


discontinuation of the ECU Diagnostics v2.0.1 device, the DSystem and the
D3System201 interfaces have also been discontinued:
§ Via the DSystem interface, you accessed the ODX database directly without
using a ControlDesk experiment.
To reuse MCD-3 D automation scripts that use the DSystem interface, perform
the following steps:
1. Create a new ControlDesk project with an experiment and an ECU
Diagnostics v2.0.2 device. Configure the experiment and the ECU
Diagnostics v2.0.2 device according to your requirements.

124
ControlDesk Introduction and Overview May 2018
Migrating from Prior Versions of ControlDesk

Note

To reuse the original ODX data, you have to adapt the COMPARAM‑SPEC
containing communication parameter (COMPARAM) definitions
according to the D-PDU API (ISO 22900‑2).
If you do not have adapted ODX data, contact dSPACE Support.

2. In the MCD-3 D automation script, change the Dispatch command like


this:
From:

Dispatch("ControlDeskNG.DSystem")

to:

Dispatch("ControlDeskNG.D3System202")

3. Since the DSystem.Configuration is no longer supported, you have to


comment its methods out.
§ Via the D3System201 interface, you used the configuration of an ODX
database contained in a ControlDesk experiment.
To reuse MCD-3 D automation scripts that use the D3System201 interface,
perform the following steps:
1. Migrate the ControlDesk project containing experiments with the ECU
Diagnostics v2.0.1 device (see Migrating projects containing experiments
with the ECU Diagnostics v2.0.1 device on page 120).
2. In the MCD-3 D automation script, change the Dispatch command like
this:
From:

Dispatch("ControlDeskNG.D3System201")

to:

Dispatch("ControlDeskNG.D3System202")

Tool automation changes Migrating scripts from Python 2.5 to Python 2.7 ControlDesk's tool
automation interface and MCD‑3 automation interface now use Python 2.7.

Changed default assignment mode for SCALEXIO Up to and including


ControlDesk 5.0, Assign to any equal platform was the default mode for
assigning registered SCALEXIO hardware to a platform in an experiment.
This means that the Assign to any equal platform mode is implicitly used if
your automation script created for ContolDesk 5.0 (or before) contains code
similar to the following lines:

Platform = PlatformCollection.Add(22) #SCALEXIO


Platform.Assignment.NetClient = '10.60.201.152'
Platform.Connect()

125
May 2018 ControlDesk Introduction and Overview
Compatibility, Migration and Discontinuations

As of ControlDesk 5.1, the Assign to first available platform assignment


mode is also supported for SCALEXIO, and it is the new default assignment
mode.
As a consequence, if you still want to use the Assign to any equal platform
assignment mode when you work with ControlDesk 5.1 or later, you have to
modify the above code lines like this:

Platform = PlatformCollection.Add(22) #SCALEXIO


Platform.Assignment.Mode = 1 # Assign to any equal platform
Platform.Assignment.NetClient = '10.60.201.152'
Platform.Connect()

For reference information, refer to AssignmentMode <<Enumeration>>


( ControlDesk Automation).

Changed behavior of the TimingSequenceName property Up to and


including ControlDesk 5.0, any string could be specified for the
TimingSequenceName property. If the specified string was not part of the list of
timing sequences, the running automation script was continued without
activating a sequence.
As of ControlDesk 5.1, ControlDesk outputs an error message when a string is
specified for the TimingSequenceName property for which there is no
corresponding entry in the list of timing sequences.

Changed behavior of the Selection Box's SelectedItemChanged


event Up to and including ControlDesk 5.0, the Selection Box's
SelectedItemChanged event was not triggered in the following cases:
§ You used the SelectionBoxItem / IViSelectionBoxItem
<<Interface>>'s Remove method to remove an item from the Selection Box.
§ You used the SelectionBoxInstrument / IViSelectionBoxInstrument
<<Interface>>'s ImportConfiguration method to import a CSV file with
Selection Box items.
As of ControlDesk 5.1, the Selection Box's SelectedItemChanged event is also
triggered in the cases described above.
For information on the event, refer to SelectionBoxInstrumentEvents /
IViSelectionBoxInstrumentEvents <<EventInterface>> ( ControlDesk
Automation).

Related topics Basics

Basics on Migrating from Prior Versions of ControlDesk ........................................................ 111

126
ControlDesk Introduction and Overview May 2018
Migrating from Prior Versions of ControlDesk

Migrating from ControlDesk 5.1 to 5.2

Introduction To migrate from ControlDesk 5.1 to ControlDesk 5.2 and reuse existing
experiments, you may have to carry out additional migration steps.

Where to go from here Information in this topic

Migrating platform management automation ....................................................................... 127


Version incompatibility ..................................................................................................... 127
Migrating Python scripts .................................................................................................. 127
Migrating when using other languages ............................................................................ 128
Using cmdloader in connection with SCALEXIO .................................................................... 130
SCALEXIO applications built with dSPACE Release 2013‑A or earlier ..................................... 130

Migrating platform ControlDesk 5.2 ... 5.6 came with two platform management automation
management automation API versions.

Version incompatibility Platform automation API versions 1.0 and 2.0 are
incompatible. To migrate to API version 2.0 and reuse automation scripts
originally developed according to API version 1.0, you might have to perform
some migration steps.

Migrating Python scripts If you use Python and want to migrate to platform
management automation API version 2.0, you do not have to perform any
migration steps unless you access a SCALEXIO system and/or VEOS in the
Platform/Device Manager context via automation.
To access a SCALEXIO system and/or VEOS via automation from the context of
the Platform/Device Manager, you have to adapt your automation scripts.
The table below shows an example of SCALEXIO access via API version 1.0:

API Version 1.0


Registering a SCALEXIO Platform with One Processing Unit

SCLX_Reg_Info = Application.PlatformManagement.CreatePlatformRegistrationInfo(Enums.PlatformType.SCALEXIO)
SCLX_Reg_Info.NetClient = "192.168.2.10"
SCLX_Platform = Application.PlatformManagement.RegisterPlatform(SCLX_Reg_Info)

Accessing a Processing Unit

# Access a registered SCALEXIO processing unit via API version 1.0


SCALEXIOPlatform = Application.PlatformManagement.Platforms.Item(0)
SCALEXIOPlatform.BoardHardware.CPU
u'Intel(R) Core(TM) i7 CPU 920'

127
May 2018 ControlDesk Introduction and Overview
Compatibility, Migration and Discontinuations

API Version 1.0


Registering a SCALEXIO Platform with One Processing Unit

Accessing an Application Loaded to a Platform

# Access a loaded SCALEXIO real-time application via API version 1.0


SCALEXIOPlatform = Application.PlatformManagement.Platforms.Item(0)
RTA = SCALEXIOPlatform.RealTimeApplication
RTA.Name
u'Scalexio_Demo'

This table shows the SCALEXIO access via API Version 2.0:

API Version 2.0


Registering a SCALEXIO Platform with One Processing Unit

SCLX_Reg_Info = Application.PlatformManagement.CreatePlatformRegistrationInfo(Enums.PlatformType.SCALEXIO)
SCLX_PU_Info = SCLX_Reg_Info.RegistrationInfos.Add()
SCLX_PU_Info.IPAddress = "192.168.2.10"
SCLX_Platform = Application.PlatformManagement.RegisterPlatform(SCLX_Reg_Info)

Accessing a Processing Unit

# Access a registered SCALEXIO processing unit via API version 2.0


SCALEXIOPlatform = Application.PlatformManagement.Platforms.Item(0)
SCALEXIOProcessingUnit = SCALEXIOPlatform.ProcessingUnits.Item(0)
SCALEXIOProcessingUnit.BoardHardware.CPU
u'Intel(R) Core(TM) i7 CPU 920'

Accessing an Application Loaded to a Platform

# Access a loaded SCALEXIO real-time application via API version 2.0


SCALEXIOPlatform = Application.PlatformManagement.Platforms.Item(0)
RTA = SCALEXIOPlatform.RealTimeApplications.Item(0)
RTA.Name
u'Scalexio_Demo'

Migrating when using other languages If you use programming


languages other than Python, such as C#, and you want to migrate to platform
management automation version 2.0, you have to perform migration steps if you
access platforms from the context of the Platform/Device Manager. No
migration steps have to be performed if you access platforms from within the
experiment.
To access platforms from the context of the Platform/Device Manager via
automation, you have to adapt your automation programs by using interfaces
specific to version 2.0. For example, to access a registered SCALEXIO platform
from the context of the Platform/Device Manager, you have to use the
IPmRegisteredSCALEXIOPlatform interface instead of the version 1.0-specific
IPmSCALEXIOPlatform interface.
This table shows how to register and access a SCALEXIO processing unit via
API Version 1.0 (in connection with the C# programming language) as an
example:

128
ControlDesk Introduction and Overview May 2018
Migrating from Prior Versions of ControlDesk

API Version 1.0

public void RegisterSCALEXIOPlatformV1()


{
// Set API version explicitly to version 1.
this.Application.PlatformManagement.PlatformAutomationAPIVersion =
AutomationAPIVersion.APIVersion1;
IPmSCALEXIORegisterInfo registrationInfo =
(IPmSCALEXIORegisterInfo)this.Application.PlatformManagement.
CreatePlatformRegistrationInfo(PlatformType.SCALEXIO);
registrationInfo.NetClient = "xy.yx.zyx.xyz";

// Registering and accessing the platform.


IPmSCALEXIOPlatform platform =
(IPmSCALEXIOPlatform)this.Application.PlatformManagement.
RegisterPlatform(registrationInfo);
string uniqueName = platform.UniqueName;

The table below shows how to register and access a SCALEXIO processing unit
via API Version 2.0 (in connection with the C# programming language):

API Version 2.0

public void RegisterSCALEXIOPlatformV2()


{
// Set API version explicitly to version 2.
this.Application.PlatformManagement.PlatformAutomationAPIVersion =
AutomationAPIVersion.APIVersion2;
IPmSCALEXIORegistrationInfo registrationInfo =
(IPmSCALEXIORegistrationInfo)this.Application.PlatformManagement.
CreatePlatformRegistrationInfo(PlatformType.SCALEXIO);
IPmProcessingUnitRegisterInfo processingUnitRegisterInfo =
registrationInfo.RegistrationInfos.Add();
processingUnitRegisterInfo.IPAddress = "xy.yx.zyx.xyz";

// Registering and accessing the platform.


IPmRegisteredSCALEXIOPlatform platform =
(IPmRegisteredSCALEXIOPlatform)this.Application.PlatformManagement.
RegisterPlatform(registrationInfo);
string uniqueName = platform.UniqueName;

Tip

The C# listing below shows how to avoid using a version-specific platform


interface by accessing the platform dynamically:

129
May 2018 ControlDesk Introduction and Overview
Compatibility, Migration and Discontinuations

public void RegisterSCALEXIOPlatformV2Dynamic()


{
// Set API version explicitly to version 2.
this.Application.PlatformManagement.PlatformAutomationAPIVersion =
AutomationAPIVersion.APIVersion2;
IPmSCALEXIORegistrationInfo registrationInfo =
(IPmSCALEXIORegistrationInfo)this.Application.PlatformManagement.
CreatePlatformRegistrationInfo(PlatformType.SCALEXIO);
IPmProcessingUnitRegisterInfo processingUnitRegisterInfo =
registrationInfo.RegistrationInfos.Add();
processingUnitRegisterInfo.IPAddress = "xy.yx.zyx.xyz";

// Identical code for version 1 and 2 due to dynamic platform access.


dynamic platform =
this.Application.PlatformManagement.
RegisterPlatform(registrationInfo);
string uniqueName = platform.UniqueName;

Using cmdloader in The following migration step is relevant only if you use the
connection with SCALEXIO cmdloader command line tool in connection with a SCALEXIO system:

Registration information for SCALEXIO systems registered with dSPACE products


of dSPACE Release 2013-B or earlier, e.g., ControlDesk 5.1, cannot be used by
the cmdloader command line tool of ControlDesk 5.2 or later.

To use the cmdloader command line tool of ControlDesk 5.2 or later, register
the SCALEXIO system with a dSPACE product such as ControlDesk or
AutomationDesk of dSPACE Release 2014-A or later. You can specify a platform
name for the SCALEXIO system during registration.

After registration the platform name to be used in connection with the


cmdloader command line tool is displayed in the Properties controlbar:

SCALEXIO applications built Loading a SCALEXIO application built with dSPACE Release 2013-A or earlier fails
with dSPACE Release 2013‑A if there is more than one processing unit available via the SCALEXIO platform to
or earlier which the application is loaded.

To load such an application to such a SCALEXIO platform, you have to rebuild


the application with dSPACE Release 2013-B or later. In addition, you have to
assign the application processes in your real-time application to the available
processing unit(s).

For details, refer to Basics on the SCALEXIO Platform ( ControlDesk Platform


Management).

130
ControlDesk Introduction and Overview May 2018
Migrating from Prior Versions of ControlDesk

Related topics Basics

Basics on Migrating from Prior Versions of ControlDesk ........................................................ 111

Migrating from ControlDesk 5.2 to 5.3

Introduction To migrate from ControlDesk 5.2 to ControlDesk 5.3 and reuse existing
experiments, you may have to carry out additional migration steps.

Where to go from here Information in this topic

Tool automation changes ...................................................................................................... 131


Changed behavior of the MultiCaptureHistoryEnabled property ....................................... 131
Changed behavior of the Remove method (IXaMainRecorder interface) ........................... 131
Changes due to the support of the TextTable parameter type ........................................... 131

Tool automation changes Changed behavior of the MultiCaptureHistoryEnabled property The


behavior of the MultiCaptureHistoryEnabled property of the
MeasurementTriggeredRaster / IXaMeasurementTriggeredRaster <<Interface>>
( ControlDesk Automation) interface was incorrect in ControlDesk 5.2 and
earlier. It is correct in ControlDesk 5.3 and later.
The property setting can no longer be changed during a running measurement.
When you try to change the property setting during a running measurement in
ControlDesk 5.3 and later, an exception occurs. You must adapt your script
accordingly.

Changed behavior of the Remove method


(IXaMainRecorder interface) The behavior of the Remove method of the
MainRecorder / IXaMainRecorder <<Interface>> interface was incorrect
in ControlDesk 5.2 and earlier. It is correct in ControlDesk 5.3 and later.
A recorder can no longer be removed while it is running. When you try to
remove a running recorder in ControlDesk 5.3 and later, an exception occurs.
You must adapt your script accordingly.

Changes due to the support of the TextTable parameter type Up to and


including ControlDesk 5.2, the TextTable type was not supported for parameters
of, for example, diagnostic services. Instead, the string type was also used for
parameters of the TextTable type.
As of ControlDesk 5.3, the TextTable type is supported for parameters.
As a consequence, you must adapt your automation script if the parameter type
is used in the script.

131
May 2018 ControlDesk Introduction and Overview
Compatibility, Migration and Discontinuations

Related topics Basics

Basics on Migrating from Prior Versions of ControlDesk ........................................................ 111

Migrating from ControlDesk 5.3 to 5.4

Introduction To migrate from ControlDesk 5.3 to ControlDesk 5.4 and reuse existing
experiments, you may have to carry out additional migration steps.

Where to go from here Information in this topic

Migrating signal description sets and signal generators ......................................................... 132


Modified default auto repeat behavior .................................................................................. 133

Migrating signal description ControlDesk's Signal Editor lets you import/export signal description sets and
sets and signal generators signal generators.

The following table shows the compatibility between signal description sets and
signal generators and the ASAM standard version:

Signal Description Sets and Signal Generators Compatible with ...


Last Saved with ...
ControlDesk 5.3 or earlier ASAM AE HIL API 1.0.2
ControlDesk 5.4 or later ASAM AE XIL API 2.0.1

When you open a project last saved with ControlDesk 5.3 or earlier in
ControlDesk 5.4 or later, signal description sets and signal generators are
automatically migrated to be compatible with ASAM AE XIL API 2.0.1.

Note

Migrated signal description sets and signal generators cannot be used


anymore with ControlDesk 5.3 or earlier.

However, a backup of the original project is stored in the project root folder
during migration.

During migration:
§ If a Condition was specified for a Duration segment property, this condition
is applied to the new Stop Trigger segment property, which is ASAM AE XIL
API 2.0.1‑compatible.

132
ControlDesk Introduction and Overview May 2018
Migrating from Prior Versions of ControlDesk

The Duration segment property is disabled and ignored whenever a Stop


Trigger segment property is specified.
§ Segments that have the Measured Data type are renamed Signal Value.

Modified default auto repeat As of ControlDesk 5.4, you can specify whether to re-arm the start trigger for
behavior the next capture in an automatically repeated measurement immediately
("Immediate" Auto repeat behavior) or after a delay for data upload
("Delayed" Auto repeat behavior) for measurement rasters in applications of
the following platforms:
§ DS1007 PPC Processor Board
§ DS1202 MicroLabBox
§ SCALEXIO
§ VEOS

Up to and including ControlDesk 5.3, the "Immediate" Auto repeat behavior


was implicitly selected for measurement rasters in applications of newly created
platforms. This default setting could not be changed with ControlDesk 5.3 or
earlier.

Migration aspects:
§ As of ControlDesk 5.4, the default setting for measurement rasters in
applications of newly created platforms is the "Delayed" Auto repeat
behavior.
§ When you open a project last saved with ControlDesk 5.3 or earlier in
ControlDesk 5.4 or later, the "Immediate" Auto repeat behavior is
preselected for measurement rasters of platforms listed above.

As of ControlDesk 5.4, you can change the setting. For details, refer to Triggered
Raster Properties ( ControlDesk Measurement and Recording).

Related topics Basics

Basics on Migrating from Prior Versions of ControlDesk ........................................................ 111

Migrating from ControlDesk 5.4 to 5.5

Introduction To migrate from ControlDesk 5.4 to ControlDesk 5.5 and reuse existing
experiments, you may have to carry out additional migration steps.

133
May 2018 ControlDesk Introduction and Overview
Compatibility, Migration and Discontinuations

Where to go from here Information in this topic

CAN Bus Monitoring device: Repairing layout connections due to changed


DBC import .......................................................................................................................... 134
Change to the default behavior when downloading an incompatible SCALEXIO
application ............................................................................................................................ 135
Change to the Path property ................................................................................................ 135
Change to the evaluation of recording triggers with multiscaling variables ............................ 137
Changed handling of checked variables and label lists .......................................................... 137
Tool automation changes ...................................................................................................... 138
Changes to variable management automation interfaces ................................................. 138
Change to the VideoDisplayStyleConstants enumeration ................................................. 138
Change to the storage of recorded multidimensional arrays ............................................. 138
Changes to the Measurement Data API ................................................................................ 138

CAN Bus Monitoring device: As of version 5.5, ControlDesk's DBC file import in connection with the CAN Bus
Repairing layout connections Monitoring device supports FIBEX and AUTOSAR system description files. As a
due to changed DBC import consequence, paths to variables in a DBC file are different depending on
whether you import the DBC file in ControlDesk 5.4 (or earlier) or
ControlDesk 5.5 (or later).

When you reuse an experiment originally created with ControlDesk 5.4 or earlier,
you can continue working with the device and layouts/instruments on the basis
of the originally imported DBC file as usual.

The following limitations apply:


§ Replacing and reloading the originally imported DBC file is blocked.
§ When you add a new DBC file to the CAN Bus Monitoring device, ControlDesk
activates this DBC variable description and tries to restore the original variable
connections. Due to the changed DBC file import, however, the paths to the
variables in the newly added DBC file are different, so ControlDesk cannot
restore any variable connection even if you added the same DBC file.

You can use the MigrateBusMonitoringDevices Python script to repair the


variable connections. You can download the script from the ControlDesk Product
Support Center at: http://www.dspace.com/cdngpsc.

To repair the variable connections, perform the following steps:


1. Start ControlDesk and activate the experiment that contains affected variable
connections.
2. In a Python editor, such as PythonWin, start the
MigrateBusMonitoringDevices Python script.
In ControlDesk's Project Manager, the script adds the context menu entry
Migrate Bus Monitoring Devices to the node of the currently active
experiment.
3. From the context menu of the active experiment, select Migrate Bus
Monitoring Devices and confirm the start dialog.

The affected variable connections in each layout of the experiment are repaired.
Closed layouts are opened, modified, saved, and closed.

134
ControlDesk Introduction and Overview May 2018
Migrating from Prior Versions of ControlDesk

The following limitations remain after executing the script:


§ Bus Navigator: User-defined objects in the Bus Navigator tree, such as
monitor, logger, and replay nodes, are lost.
§ Measurement Configuration: Affected variables in the measurement and
recording signal lists are lost.
§ Measurement Configuration: Trigger rules that contain affected variables
remain corrupted and must be removed or repaired manually.

Tip

If you want to add the context menu entry permanently, you can use the
script as an extension script. Copy it together with the file
MigrateMonitoringDevice.extscript to the appropriate place in the
file system.

For more information on using extension scripts, refer to Executing


Extension Scripts When ControlDesk Starts Up ( ControlDesk
Customization).

Change to the default When you download a real‑time application to a SCALEXIO system, ControlDesk
behavior when downloading detects incompatibilities such as differences between the SCALEXIO system I/O
an incompatible SCALEXIO and the I/O as required by the real‑time application.
application
ControlDesk's default behavior on detecting such incompatibilities has been
changed:
§ Up to and including ControlDesk 5.4, ControlDesk simulated the access to the
diverging I/O channels by default.
§ As of ControlDesk 5.5, ControlDesk activates the access to the diverging
I/O channels by default.
To let ControlDesk simulate the access to the diverging I/O channels, you have
to clear the default behavior explicitly.

The default behavior was changed for downloading an application via


ControlDesk's graphical user interface. It was not changed for downloading an
application via ControlDesk's automation interface.

Change to the Path property The Path property of visualized variables of multiprocessor and multicore
real‑time applications displayed in the Properties controlbar has changed in
ControlDesk 5.5.

135
May 2018 ControlDesk Introduction and Overview
Compatibility, Migration and Discontinuations

The following illustration shows a SCALEXIO platform with a variable description


related to multicore application as an example:

§ Path in ControlDesk 5.4 or earlier:

[PlatformName()://ModelRoot/...]

The following illustration shows the path to a variable from the multicore
application as displayed in the Properties controlbar (ControlDesk 5.4 or
earlier) as an example:

§ Path in ControlDesk 5.5 or later:

[MasterPlatform()://SubPlatform/ModelRoot/...]

136
ControlDesk Introduction and Overview May 2018
Migrating from Prior Versions of ControlDesk

The illustration below shows the path to the same variable as displayed in the
Properties controlbar (ControlDesk 5.5 or later) as an example:

This change does not require any manual migration steps.

For reference information, refer to Variables Properties ( ControlDesk


Instrument Handling).

Change to the evaluation of As of ControlDesk 5.5, if a variable using a multiscaling table is used within a
recording triggers with recording trigger rule, the variable's source value is used for trigger evaluation.
multiscaling variables
In ControlDesk 5.4, the variable's converted value was used for trigger
evaluation.

Changed handling of checked The Variable Browser has been renewed in ControlDesk 5.5. The Variable
variables and label lists Browser's new Favorite list integrates the Checked variables list and the
Label list:

Function buttons

Model Tree Variable list Favorites list

For an overview of the Variable Browser, refer to Basics of the Variable Browser
( ControlDesk Variable Management). For details on the Favorite list, refer to
Favorites List ( ControlDesk Variable Management).

137
May 2018 ControlDesk Introduction and Overview
Compatibility, Migration and Discontinuations

Tool automation changes Changes to variable management automation interfaces As of


version 5.5, ControlDesk provides an enhanced Variable Browser.
As a consequence, the following properties of the VariablesManagement /
IXaVariablesManagement <<Interface>> are no longer required and have
been removed from the automation interface:
§ Application.VariablesManagement.OperationButtonsVisible
§ Application.VariablesManagement.SubsystemFirstEnabled

Change to the VideoDisplayStyleConstants enumeration In


ControlDesk 5.5, the Strech value of the VideoDisplayStyleConstants
<<Enumeration>> enumeration has been corrected to Stretch.
The numerical value of the Stretch enumeration value is unchanged.
Refer to VideoDisplayStyleConstants <<Enumeration>> ( ControlDesk
Automation).

Change to the storage of recorded multidimensional arrays Up to and


including ControlDesk 5.4, recorded multidimensional arrays were not stored as
arrays but as nested vectors.
As of ControlDesk 5.5, recorded multidimensional arrays are stored as arrays. As
a consequence, you may have to adapt automation scripts accordingly.

Tip

No script adaptation is required if you use Python to automate ControlDesk.

Changes to the Measurement § The data type of the Size attribute of the FileDescription interface has
Data API been changed from Int to Float.
Refer to Class Description (FileDescription) ( ControlDesk Measurement Data
API).
§ The BitOffset and NumberOfBits attributes of the Signal interface can no
longer be set. You can only get these attribute values.
Refer to Class Description (Signal) ( ControlDesk Measurement Data API).

Related topics Basics

Basics on Migrating from Prior Versions of ControlDesk ........................................................ 111

Migrating from ControlDesk 5.5 to 5.6

Introduction To migrate from ControlDesk 5.5 to ControlDesk 5.6 and reuse existing
experiments, you may have to carry out additional migration steps.

138
ControlDesk Introduction and Overview May 2018
Migrating from Prior Versions of ControlDesk

Where to go from here Information in this topic

Changed TRC file generation ................................................................................................ 139


MicroAutoBox platform: Migrating experiments .................................................................... 139
LIN Bus Monitoring device: Repairing layout connections due to changed LDF import ........... 139
User-defined databases (UDDBs): Discontinuation and migration ........................................... 140
DSSIGCONV tool, Measurement Data API: Changed behavior when converting files ............. 141
Tool automation changes ...................................................................................................... 141
Change to the IPmVEOSGeneralSettings interface ........................................................... 141
Moved definitions of XIL API MAPort platform-specific interfaces ..................................... 142

Changed TRC file generation You have to note some modifications on TRC file generation in connection with
MATLAB R2015b.

For more information on TRC file generation and the latest migration
instructions, refer to the dSPACE website: http://www.dspace.com/go/trc.

MicroAutoBox platform: dSPACE Release 2015-B was the last release supporting MicroAutoBox with its
Migrating experiments variants 1401/1501, 1401/1504, 1401/1505/1506, 1401/1505/1507, and
1401/1507.

As of dSPACE Release 2016‑A, dSPACE software supports only MicroAutoBox II


with its variants 1401/1501, 1401/1504, 1401/1505/1507, 1401/1507,
1401/1511, 1401/1513, 1401/1511/1514, and 1401/1513/1514.

ControlDesk 5.6 and later lets you open an experiment with a


MicroAutoBox platform configured for an unsupported MicroAutoBox variant,
and reconfigure the platform so it can be reused with MicroAutoBox II.

To do this, perform the following steps:


1. Open the experiment to be reused in ControlDesk 5.6 or later.
ControlDesk changes the MicroAutoBox platform's connection type
automatically from BUS to NET, and prompts you to specify the IP address of
MicroAutoBox II.
2. Specify the IP address of MicroAutoBox II.

The experiment can now be reused with MicroAutoBox II.

LIN Bus Monitoring device: As of version 5.6, ControlDesk's LDF file import in connection with the LIN Bus
Repairing layout connections Monitoring device supports FIBEX and AUTOSAR system description files. As a
due to changed LDF import consequence, paths to variables in an LDF file are different depending on
whether you import the LDF file in ControlDesk 5.5 (or earlier) or
ControlDesk 5.6 (or later).

When you reuse an experiment originally created with ControlDesk 5.5 or earlier,
you can continue working with the device and layouts/instruments on the basis
of the originally imported LDF file as usual.

139
May 2018 ControlDesk Introduction and Overview
Compatibility, Migration and Discontinuations

The following limitations apply:


§ Replacing and reloading the originally imported LDF file is blocked.
§ When you add a new LDF file to the LIN Bus Monitoring device, ControlDesk
activates this LDF variable description and tries to restore the original variable
connections. Due to the changed LDF file import, however, the paths to the
variables in the newly added LDF file are different, so ControlDesk cannot
restore any variable connection even if you added the same LDF file.

You can use the MigrateBusMonitoringDevices Python script to repair the


variable connections. You can download the script from the ControlDesk Product
Support Center at: http://www.dspace.com/cdngpsc.

To repair the variable connections, perform the following steps:


1. Start ControlDesk and activate the experiment that contains affected variable
connections.
2. In a Python editor, such as PythonWin, start the
MigrateBusMonitoringDevices Python script.
In ControlDesk's Project Manager, the script adds the context menu entry
Migrate Bus Monitoring Devices to the node of the currently active
experiment.
3. From the context menu of the active experiment, select Migrate Bus
Monitoring Devices and confirm the start dialog.

The affected variable connections in each layout of the experiment are repaired.
Closed layouts are opened, modified, saved, and closed.

The following limitations remain after executing the script:


§ Bus Navigator: User-defined objects in the Bus Navigator tree, such as
monitor, logger, and replay nodes, are lost.
§ Measurement Configuration: Affected variables in the measurement and
recording signal lists are lost.
§ Measurement Configuration: Trigger rules that contain affected variables
remain corrupted and must be removed or repaired manually.

Tip

If you want to add the context menu entry permanently, you can use the
script as an extension script. Copy it together with the file
MigrateMonitoringDevice.extscript to the appropriate place in the
file system.

For more information on using extension scripts, refer to Executing


Extension Scripts When ControlDesk Starts Up ( ControlDesk
Customization).

User-defined databases User-defined databases (UDDBs) were supported for the last time with
(UDDBs): Discontinuation and ControlDesk 5.5 (dSPACE Release 2015‑B).
migration

140
ControlDesk Introduction and Overview May 2018
Migrating from Prior Versions of ControlDesk

As a consequence, to replace the UDDB‑based manipulation of CAN


communication on dSPACE real‑time hardware, you have to change the real-time
model.

Keep the following migration aspects in mind:


§ When you open an experiment with UDDB‑specific items in ControlDesk 5.6 or
higher, these items are not loaded to ControlDesk.
§ When you open an experiment with Bus Instruments for experimental
messages based on a UDDB, these instruments are loaded, but they are not
functional.

DSSIGCONV tool, You can use the DSSIGCONV tool to:


Measurement Data API: § Extract data from a measurement data file via the /t:time1,time2 option.
Changed behavior when § Split a measurement data file into several files via the /p:parts option.
converting files
In ControlDesk 5.6, the values of the following Description properties in
measurement data files created by using these options have changed:
§ StartTimestamp
§ StopTimestamp
§ Length

Behavior up to and Including Behavior as of ControlDesk 5.6


ControlDesk 5.5
Up to and including ControlDesk 5.5, As of ControlDesk 5.6, these values
these values were taken from the are adapted in relation to the values
original measurement data file without of the original measurement data file.
modification.

This change also applies to measurement data files created by saving a part of a
measurement by using ControlDesk's Measurement Data API.
§ For more information on using the DSSIGCONV tool, refer to How to Extract
Data from a Measurement Data File ( ControlDesk Measurement and
Recording).
§ For more information on using the Measurement Data API, refer to
ControlDesk Measurement Data API.

Tool automation changes Change to the IPmVEOSGeneralSettings interface In ControlDesk 5.6,


the ModelIsExecutedInRealTime property of the VEOSGeneralSettings /
IPmVEOSGeneralSettings <<Interface>> interface has been removed.
Refer to VEOSGeneralSettings / IPmVEOSGeneralSettings <<Interface>>
( ControlDesk Automation).

141
May 2018 ControlDesk Introduction and Overview
Compatibility, Migration and Discontinuations

Moved definitions of XIL API MAPort platform-specific interfaces In


ControlDesk 5.6, the definitions of the following interfaces have been moved:
§ XILAPIMAPortAssignment / IPmXILAPIMAPortAssignment
<<Interface>>
§ XILAPIMAPortGeneralSettings / IPmXILAPIMAPortGeneralSettings
<<Interface>>
§ XILAPIMAPortPlatform / IPmXILAPIMAPortPlatform <<Interface>>
Up to and including ControlDesk 5.5, the definitions of these interfaces were
located in the following library:

dSPACE.InterfaceDefinitions.PlatformManagement.Automation<Version>.dll

As of ControlDesk 5.6, the definitions of these interfaces are located in the


following library:

AutomationDevicesInterfaces<Version>.dll

As a consequence, if you did not add all the assemblies from


the ./Main/bin/AutomationAssemblies folder of your ControlDesk
installation to your C# project, you have to add the
AutomationDevicesInterfaces<Version>.dll library to your project.

Related topics Basics

Basics on Migrating from Prior Versions of ControlDesk ........................................................ 111

Migrating from ControlDesk 5.6 to 6.0

Introduction To migrate from ControlDesk 5.6 to ControlDesk 6.0 and reuse existing
experiments, you may have to carry out additional migration steps.

Where to go from here Information in this topic

Failure Simulation Module: Discontinuation and migration .................................................... 143


Plotter: Discontinuation and migration .................................................................................. 144
Table Editor ........................................................................................................................... 144
Changed default behavior for measurements on dSPACE platforms ...................................... 144
Change to the import of A2L files ......................................................................................... 145
ECU Diagnostics: DLLs called by ECU diagnostic jobs ............................................................. 145
Signal Editor: Changed implementation of the eBACKWARD interpolation method .............. 145

142
ControlDesk Introduction and Overview May 2018
Migrating from Prior Versions of ControlDesk

Tool automation changes ...................................................................................................... 145


Failure Simulation Module: Discontinuation and migration ............................................... 145
Discontinuation of platform management automation API version 1.0 ............................. 145
No support for 32‑bit third-party Python extension modules ............................................ 146
Change to the IXaMeasurementDataManagement interface ............................................ 146
Change to the IXaECUDiagnostics202ServerSettings interface ......................................... 146
Table Editor: Change to the creation of Table Editor arrays ............................................... 146
Discontinuation of the dSPACE Message Monitor ............................................................ 147
Change to the ILoLog interface ........................................................................................ 147
Measurement Data API changes ........................................................................................... 147
MDFFormatOption2 interface no longer available ............................................................ 147

Failure Simulation Module: ControlDesk’s Failure Simulation Module was delivered for the last time with
Discontinuation and ControlDesk 5.6 of dSPACE Release 2016‑A.
migration § To prepare an electrical error simulation via the graphical user interface (GUI),
use the ControlDesk XIL API EESPort GUI, which was introduced with
ControlDesk 5.5 (dSPACE Release 2015-B).
To use the ControlDesk XIL API EESPort GUI, the Failure Simulation Package is
required, which is based on XIL API's EESPort. The implementation is based on
dSPACE XIL API .NET.
Keep in mind that electrical error configurations of ControlDesk’s Failure
Simulation Module are not compatible with XIL API EESPort configurations.
For the migration, you can use the FailureSimulationExportTool to
export information from an existing ControlDesk failure simulation system
(FSN) file to the following files:
§ A hardware-dependent port configuration (PORTCONFIG) file
You can use the file to create a new EESPort. For instructions, refer to How
to Create a New EESPort ( ControlDesk Electrical Error Simulation via XIL
API EESPort).
§ One error configuration XML file for each failure pattern
You can use the files to create and configure electrical errors, refer to How
to Create and Configure an Electrical Error ( ControlDesk Electrical Error
Simulation via XIL API EESPort).
The FailureSimulationExportTool version to use depends on the installed
version of ControlDesk and dSPACE XIL API .NET as shown in the following
table:

Installed Installed Required


ControlDesk dSPACE XIL API .NET FailureSimulationExportTool
Version Version Version
5.3 2.0 2014-B
5.4 2015-A 2015-A
5.5 2015-B 2015-B
5.6 2016-A 2016-A

To get the FailureSimulationExportTool, including a ReadMe file


containing user documentation, contact dSPACE Support.

143
May 2018 ControlDesk Introduction and Overview
Compatibility, Migration and Discontinuations

§ To prepare an electrical error simulation via automation, use the dSPACE XIL
API .NET implementation, which supports the Electrical Error Simulation Port
(EESPort).

Plotter: Discontinuation and The Plotter was delivered for the last time with ControlDesk 5.6 of dSPACE
migration Release 2016‑A.
§ ControlDesk 6.0 and later lets you open an experiment with Plotters. Plotter
instruments including their properties and variable connections are
automatically migrated to Time Plotter (refer to Time Plotter Handling
( ControlDesk Instrument Handling)) instruments during experiment
migration.
§ The Time Plotter, which is the successor to the Plotter for displaying signals
measured in a time-based raster, provides a new automation concept. As a
consequence, automation scripts originally developed for automating the
Plotter cannot be reused for automating the Time Plotter.

Table Editor ControlDesk 6.0 comes with an enhanced Table Editor.

ControlDesk 6.0 and later lets you open an experiment with Table Editors created
in ControlDesk 5.6 or earlier. These instruments keep their properties and
variable connections during experiment migration.

Automation scripts originally developed for automating the Table Editor in


ControlDesk 5.6 or earlier can be reused in ControlDesk 6.0 and later.

However, there are some migration aspects:


§ The order of tabbed pages of Table Editors created in ControlDesk 5.6 or
earlier cannot be restored automatically. You have to restore the tab order
manually after experiment migration.
§ There are some migration aspects in connection with the automation of Table
Editor arrays. Refer to Table Editor: Change to the creation of Table Editor
arrays on page 146.
§ If the project to be migrated was backed up as a ZIP archive, automation
events that relate to a specific tabbed page of a Table Editor created in
ControlDesk 5.6 or earlier are not migrated if the layout containing that Table
Editor was open during project backup.
Use one of the following actions as a workaround:
§ In ControlDesk 5.6 or earlier, close the layouts containing Table Editors prior
to project backup.
§ In ControlDesk 5.6 or earlier, export the layouts containing Table Editors,
and import them to the migrated experiment.

Changed default behavior for Up to and including ControlDesk 5.6, the Measure continuously on newly
measurements on dSPACE added dSPACE platforms option on the Measurement Configuration Page
platforms ( ControlDesk Measurement and Recording) was inactive after installation, i.e.,
measurements on newly added dSPACE platforms were triggered by default.

144
ControlDesk Introduction and Overview May 2018
Migrating from Prior Versions of ControlDesk

As of ControlDesk 6.0, the Measure continuously on newly added dSPACE


platforms option is active after installation, i.e., measurements on newly added
dSPACE platforms are continuous by default.

Change to the import of There is a change in the import of A2L files in ControlDesk 6.0:
A2L files § Up to and including version 5.6, ControlDesk did not support the
COLUMN_DIR setting for the LAYOUT flag of measurement arrays. If an A2L
file to be imported contained such measurement arrays, ControlDesk assumed
the ROW_DIR setting for the LAYOUT flag of the measurement array instead.
§ As of version 6.0, ControlDesk supports the COLUMN_DIR setting for the
LAYOUT flag of measurement arrays. If an A2L file to be imported contains
such measurement arrays, ControlDesk uses the COLUMN_DIR setting.

ECU Diagnostics: DLLs called Diagnostic jobs can call DLLs, for example, Seed&Key DLLs to get security access
by ECU diagnostic jobs for ECU parameter calibration.

As of version 6.0, ControlDesk supports only 64‑bit DLLs called by ECU


diagnostic jobs. 32‑bit DLLs called by ECU diagnostic jobs are no longer
supported. You therefore have to recompile these DLLs.

Signal Editor: Changed The implementation used for the eBACKWARD interpolation method for Data
implementation of the File segments and Signal Value segments has been changed:
eBACKWARD interpolation § Up to and including ControlDesk 5.6 and Real-Time Testing 3.0 (dSPACE
method Release 2016-A), Real‑Time Testing's RM_SAMPLED data streaming mode was
used.
§ As of ControlDesk 6.0 and Real-Time Testing 3.1 (dSPACE Release 2016-B),
Real‑Time Testing's RM_BACKWARD data streaming mode is used. The mode
complies with the specification of the eBACKWARD interpolation method
defined in the ASAM AE XIL API standard.

For details on the difference between the two interpolation methods, refer to
MatFile Class Description ( Real-Time Testing Library Reference).

Tool automation changes Failure Simulation Module: Discontinuation and


migration ControlDesk’s Failure Simulation Module was delivered for the last
time with ControlDesk 5.6 of dSPACE Release 2016‑A.
To prepare an electrical error simulation via automation, use the dSPACE XIL
API .NET implementation, which supports the Electrical Error Simulation Port
(EESPort).

Discontinuation of platform management automation


API version 1.0 Platform management automation API version 1.0 was
supported for the last time with ControlDesk 5.6 of dSPACE Release 2016‑A.
For information on migrating to API version 2.0, which was introduced with
ControlDesk 5.2 from dSPACE Release 2014‑A, refer to Migrating from
ControlDesk 5.1 to 5.2 on page 127.

145
May 2018 ControlDesk Introduction and Overview
Compatibility, Migration and Discontinuations

No support for 32‑bit third-party Python extension modules As of


version 6.0, ControlDesk's Internal Interpreter supports only 64‑bit third‑party
Python extension modules. 32‑bit third-party Python extension modules are no
longer supported.

Change to the IXaMeasurementDataManagement interface As of


ControlDesk 6.0, exporting MDF measurement data files (MDF file format
versions 2.0 and 3.0) is no longer supported.
The following properties of the MeasurementDataManagement /
IXaMeasurementDataManagement <<Interface>> interface have therefore
been removed in ControlDesk 6.0:
§ MDFFormat
§ VariableNameStorage
§ MDFXAxisDataType
Refer to MeasurementDataManagement / IXaMeasurementDataManagement
<<Interface>>.

Change to the IXaECUDiagnostics202ServerSettings interface As of


ControlDesk 6.0, the diagnostic server is always started from within the
ControlDesk process.
The following properties of the ECUDiagnostics202ServerSettings /
IXaECUDiagnostics202ServerSettings <<Interface>> interface have
therefore been removed in ControlDesk 6.0:
§ ExecuteDiagnosticsServerInProcessOfCDNGEnabled
This is always enabled and cannot be changed.
§ UseServerJVMForDatabaseOptimizationEnabled
This is always enabled and cannot be changed.
Refer to ECUDiagnostics202ServerSettings / IXaECUDiagnostics202ServerSettings
<<Interface>> ( ControlDesk Automation).

Table Editor: Change to the creation of Table Editor


arrays ControlDesk 6.0 comes with an enhanced Table Editor. Automation
scripts originally developed for automating the Table Editor in ControlDesk 5.6 or
earlier can be reused in ControlDesk 6.0 and later.
However, the Table Editor Array instrument type is no longer available. You
have to use the Table Editor instrument type instead. Unlike the Table
Editor Array instrument type, the Table Editor instrument type already has
one subinstrument by default.
The following listing shows how to create a Table Editor with two
subinstruments in ControlDesk 5.6 and earlier:

TableEditor = ControlDeskApplication.LayoutManagement.ActiveLayout.Instruments.Add(
"Table Editor Array",
TableEditorInstrumentName,
0,
0,
500,
500)

146
ControlDesk Introduction and Overview May 2018
Migrating from Prior Versions of ControlDesk

# Add sub instrument.


TableEditor.SubInstruments.Add()
(...)
# Add sub instrument.
TableEditor.SubInstruments.Add()

The following listing shows how to create a Table Editor with two
subinstruments in ControlDesk 6.0 and later:

TableEditor = ControlDeskApplication.LayoutManagement.ActiveLayout.Instruments.Add(
"Table Editor",
TableEditorInstrumentName,
0,
0,
500,
500)

# Add sub instrument.


TableEditor.SubInstruments.Add()

Discontinuation of the dSPACE Message Monitor In ControlDesk 6.0, the


dSPACE Message Monitor, which allows you to monitor log messages that are
recorded by the dSPACE Message Service, has been removed.

Change to the ILoLog interface In ControlDesk 6.0, the


LogFilePath property of the Log / ILoLog <<Interface>>, which gets the
full path name of the message log file, has been removed.
Refer to Log / ILoLog <<Interface>>.

Measurement Data API MDFFormatOption2 interface no longer available As of ControlDesk 6.0,


changes exporting MDF measurement data files (MDF file format versions 2.0 and 3.0) is
no longer supported.
As a consequence, the MDFFormatOption2 interface is no longer available.
Refer to ControlDesk Measurement Data API.

Related topics Basics

Basics on Migrating from Prior Versions of ControlDesk ........................................................ 111


Implementing an EESPort Client Application ( dSPACE XIL API Implementation
Guide)

Migrating from ControlDesk 6.0 to 6.1

Introduction To migrate from ControlDesk 6.0 to ControlDesk 6.1 and reuse existing
experiments, you may have to carry out additional migration steps.

147
May 2018 ControlDesk Introduction and Overview
Compatibility, Migration and Discontinuations

Where to go from here Information in this topic

Tool automation changes ...................................................................................................... 148


Change to the SignalMappings interface ......................................................................... 148
Change to the FlashDriveSize property ............................................................................. 148
Change to the IPiInterpreter interface .............................................................................. 148

Tool automation changes Change to the SignalMappings interface In ControlDesk 6.1, the return
value of the Variable property of the SignalGeneratorMapping /
IXaSignalGeneratorMapping <<Interface>> interface has been changed.
Via the Variable property, you can get or set the variable mapped to a signal
generator.
§ As of ControlDesk 6.1, the Variable property returns the Path value for
multiprocessor systems.
Up to and including ControlDesk 6.0, the SPPath value was returned for
multiprocessor systems.
Unlike the SPPath value, the Path value represents the fully qualified
connection string that can also be used in other dSPACE automation APIs.
§ As of ControlDesk 6.1, the Variable property returns None for an unmapped
symbol.
Up to and including ControlDesk 6.0, an empty string was returned for an
unmapped symbol.
Refer to SignalGeneratorMapping / IXaSignalGeneratorMapping <<Interface>>
( ControlDesk Automation).

Change to the FlashDriveSize property As of ControlDesk 6.1, the


FlashDriveSize property of the following interfaces has the Long type:
§ DS1007HardwareInformation / IPmDS1007HardwareInformation
<<Interface>>
§ DS1202HardwareInformation / IPmDS1202HardwareInformation
<<Interface>>
§ SCALEXIOHardwareInformation / IPmSCALEXIOHardwareInformation
<<Interface>>
Up to and including ControlDesk 6.0, the FlashDriveSize property of these
interfaces had the Signed 32 Bit Integer type.
Refer to:
§ DS1007HardwareInformation / IPmDS1007HardwareInformation
<<Interface>> ( ControlDesk Automation)
§ DS1202HardwareInformation / IPmDS1202HardwareInformation
<<Interface>> ( ControlDesk Automation)
§ SCALEXIOHardwareInformation / IPmSCALEXIOHardwareInformation
<<Interface>> ( ControlDesk Automation)

Change to the IPiInterpreter interface In ControlDesk 6.1, the


Macros property of the Interpreter / IPiInterpreter
<<Interface>> interface has been removed.

148
ControlDesk Introduction and Overview May 2018
Migrating from Prior Versions of ControlDesk

Refer to Interpreter / IPiInterpreter <<Interface>> ( ControlDesk Automation).

Related topics Basics

Basics on Migrating from Prior Versions of ControlDesk ........................................................ 111

Migrating from ControlDesk 6.1 to 6.2

Introduction To migrate from ControlDesk 6.1 to ControlDesk 6.2 and reuse existing
experiments, you may have to carry out additional migration steps.

Where to go from here Information in this topic

Global platforms/devices: Discontinuation and migration ...................................................... 149


Automatic migration ....................................................................................................... 149
Manual migration ............................................................................................................ 150
Migrating automation scripts ........................................................................................... 150
dSPACE failure simulation hardware controlled via CAN: Migrating to dSPACE CAN
API 2.0 ................................................................................................................................. 151
Sampling period of event‑based rasters ................................................................................. 151
Changed order of rasters in the Measurement Configuration ................................................ 152
Changed raster order ...................................................................................................... 152
Changed trigger assignment in some cases ...................................................................... 152
Migrating variable connections due to TRC file changes for Bus Manager elements .............. 152
Tool automation changes ...................................................................................................... 152
Change to the IXaActiveProject interface ......................................................................... 152
Change to the IBnCANCommunicationChannel and
IBnLINCommunicationChannel interfaces ........................................................................ 153
Change to the VariableDescriptionRemoving event .......................................................... 153
Change to the IXaMeasurementRaster interface .............................................................. 154

Global platforms/devices: As of ControlDesk 6.2, you can no longer specify a platform/device as a


Discontinuation and project‑global platform/device.
migration
Automatic migration When you open an experiment with global
platforms/devices in ControlDesk 6.2 or later, ControlDesk automatically migrates
the project and the contained experiments.
In the first experiment that contains global platforms/devices, ControlDesk
performs the following steps during experiment migration:
§ ControlDesk changes global platforms/devices in the first experiment to
experiment‑specific platforms/devices.
§ ControlDesk assigns variable descriptions and data sets that are originally
assigned to global platforms/devices in the first experiment to the related
experiment‑specific platforms/devices.

149
May 2018 ControlDesk Introduction and Overview
Compatibility, Migration and Discontinuations

Manual migration In all the other experiments that originally contained


global platforms/devices, you have to perform the following manual migration
steps after ControlDesk's experiment migration:
§ Add new platforms/devices to all the other experiments that originally
contained global platforms/devices.
Refer to How to Add a Platform/Device to an Experiment ( ControlDesk
Platform Management).

§ Assign the variable descriptions and data sets originally assigned to global
platforms/devices in all the other experiments to the related
experiment‑specific platforms/devices.

Note

When you select a variable description that is already assigned to a


platform/device in the first experiment, you cannot reload and replace the
variable description since it is used in other experiments.
Instead of selecting a variable description that is already assigned,
reimport the variable description, as shown in the following illustration.

Refer to How to Add a Variable Description to a Platform/Device


( ControlDesk Variable Management).

Migrating automation scripts You may have to migrate your automation


scripts.
For information on related changes to ControlDesk's automation interface, refer
to Change to the IXaActiveProject interface on page 152.

150
ControlDesk Introduction and Overview May 2018
Migrating from Prior Versions of ControlDesk

dSPACE failure simulation Some dSPACE failure simulation hardware can be controlled by CAN interfaces.
hardware controlled via CAN: To access these CAN interfaces, ControlDesk uses dSPACE CAN API.
Migrating to dSPACE CAN
As of ControlDesk 6.2, when you configure the EESPort for dSPACE failure
API 2.0
simulation hardware controlled by CAN interfaces, you can select one of the
following versions of dSPACE CAN API:
§ dSPACE CAN API 1.0
dSPACE CAN API 1.0 is supported for compatibility reasons only. Support for
dSPACE CAN API 1.0 will be discontinued in the future.
§ dSPACE CAN API 2.0
dSPACE CAN API 2.0 was introduced with dSPACE Release 2016‑B. It is the
successor of dSPACE CAN API 1.0, includes all previous features, and
additionally supports CAN FD. Unlike dSPACE CAN API 1.0, dSPACE CAN
API 2.0 will be developed further.

You are therefore recommended to migrate the EESPort configuration to use


dSPACE CAN API 2.0.

For reference information, refer to EESPort - Configuration Properties


( ControlDesk Electrical Error Simulation via XIL API EESPort).

Sampling period of In ControlDesk 6.2, the value of the sampling period of event‑based rasters as
event‑based rasters displayed in ControlDesk's Properties controlbar and as returned by using
ControlDesk's automation interface has been changed.

As of ControlDesk 6.2:
§ The sampling period value of event‑based rasters as displayed in ControlDesk's
Properties controlbar is "‑1 s".
§ The sampling period value of event‑based rasters as returned by using
ControlDesk's automation interface is "‑1.0".

Up to and including ControlDesk 6.1, the behavior was as follows:


§ Sampling period value of event‑based rasters as displayed in ControlDesk's
Properties controlbar:
§ The sampling period value of event‑based rasters on multiprocessor and
multi‑core platforms as displayed in ControlDesk's Properties controlbar
was "0 s".
§ The sampling period value of event‑based rasters on devices and on all other
platforms as displayed in ControlDesk's Properties controlbar was "‑1 s".
§ Sampling period value of event‑based rasters as returned by using
ControlDesk's automation interface:
§ The sampling period value of event‑based rasters on multiprocessor and
multi‑core platforms as returned by ControlDesk's automation interface was
"0.0".
§ The sampling period value of event‑based rasters on devices and on all other
platforms as returned by ControlDesk's automation interface was "‑1.0".

151
May 2018 ControlDesk Introduction and Overview
Compatibility, Migration and Discontinuations

Changed order of rasters in Changed raster order The order of the rasters displayed in ControlDesk's
the Measurement Measurement Configuration controlbar has changed from ControlDesk 6.1 to
Configuration ControlDesk 6.2.
The following illustrations show an example of the platform rasters of a real‑time
application in ControlDesk:

Up to and Including ControlDesk 6.1 As of ControlDesk 6.2

Changed trigger assignment in some cases The above illustrations also


show the platform and duration triggers of the rasters.
The names of unmodified triggers assigned to a raster might change due to the
new order, but their default configuration remains the same.
If you modify the properties of Platform Trigger 1 in ControlDesk 6.1, save the
experiment and reopen it in ControlDesk 6.2, the original assignment of
Platform Trigger 1 to the 100ms raster is kept.

Note

To modify a platform or duration trigger via ControlDesk's automation


interface, do not access the trigger by its name. Instead, access the trigger
via the related raster. If you do so, you are independent of the trigger name.

Migrating variable The paths of Bus Manager elements in the TRC file have changed from dSPACE
connections due to TRC file Release 2017-A to dSPACE Release 2017-B. As a consequence, when you build
changes for Bus Manager an application including bus communication configured with the Bus Manager of
elements dSPACE Release 2017-B, you might have to adapt the ControlDesk experiments
that use the generated TRC file (e.g., generate new instrument layouts and
adapt automation scripts).

Tool automation changes Change to the IXaActiveProject interface As of ControlDesk 6.2, you can
no longer specify a platform/device as a project‑global platform/device.
For this reason, the Platforms property of the ActiveProject /
IXaActiveProject <<Interface>> has been removed.

152
ControlDesk Introduction and Overview May 2018
Migrating from Prior Versions of ControlDesk

Refer to ActiveProject / IXaActiveProject <<Interface>> ( ControlDesk


Automation).

Change to the IBnCANCommunicationChannel and


IBnLINCommunicationChannel interfaces In ControlDesk 6.2, the return
value of the Name property of the following interfaces was changed:
§ CANCommunicationChannel / IBnCANCommunicationChannel
<<Interface>>
§ LINCommunicationChannel / IBnLINCommunicationChannel
<<Interface>>
As of ControlDesk 6.2, the Name property of these interfaces returns the
channel's ShortName. Up to and including ControlDesk 6.1, an internal ID was
returned by the Name property.
Refer to:
§ CANCommunicationChannel / IBnCANCommunicationChannel <<Interface>>
( ControlDesk Automation)
§ LINCommunicationChannel / IBnLINCommunicationChannel <<Interface>>
( ControlDesk Automation)

Change to the VariableDescriptionRemoving event In ControlDesk 6.2,


the behavior of the VariableDescriptionRemoving event of the
VariablesManagementEvents / IXaVariablesManagementEvents
<<EventInterface>> interface was changed.
The VariableDescriptionRemoving event is triggered when a variable
description is removed from a platform/device. This is possible only for inactive
variable descriptions.
A variable description can be referenced in only one experiment or in multiple
experiments of a project:
§ When you remove a variable description that is referenced in only one
experiment, the variable description is removed from the platform/device and
from the project.
§ When you remove a variable description that is referenced in multiple
experiments, the variable description is removed from the platform/device, but
not from the project.
The behavior of the VariableDescriptionRemoving event has been changed
as follows:
§ Up to and including ControlDesk 6.1, the
VariableDescriptionRemoving event was triggered as in the two cases
described above, i.e., even if the variable description was removed from the
platform/device, but not from the project.
§ As of ControlDesk 6.2, the VariableDescriptionRemoving event is
triggered if the variable description is referenced in only one experiment, i.e., if
the variable description is removed from the platform/device and from the
project.
Refer to VariablesManagementEvents / IXaVariablesManagementEvents
<<EventInterface>> ( ControlDesk Automation).

153
May 2018 ControlDesk Introduction and Overview
Compatibility, Migration and Discontinuations

Change to the IXaMeasurementRaster interface In ControlDesk 6.2, the


return value of the SamplingPeriod property of the MeasurementRaster /
IXaMeasurementRaster <<Interface>> interface has been changed; for
details on the change, refer to Sampling period of event‑based rasters
on page 151.
For details on the interface, refer to MeasurementRaster / IXaMeasurementRaster
<<Interface>> ( ControlDesk Automation).

Related topics Basics

Basics on Migrating from Prior Versions of ControlDesk ........................................................ 111

Migrating from ControlDesk 6.2 to 6.3

Introduction To migrate from ControlDesk 6.2 to ControlDesk 6.3 and reuse existing
experiments, you may have to carry out additional migration steps.

Note

To migrate to ControlDesk 6.3 from versions previous to 6.2, you might also
have to perform the migration steps of the intervening
ControlDesk versions.

Tool automation changes Change to the interfaces accessing platforms/devices in an


experiment In ControlDesk 6.3, using the IsAssignable property of the
interfaces that access platforms and devices in an experiment returns an
exception. Do not use the property any longer.
This applies to the following interfaces:
§ IPmCANMonitoringPlatform (refer to CANMonitoringPlatform /
IPmCANMonitoringPlatform <<Interface>> ( ControlDesk
Automation))
§ IPmCCPPlatform (refer to CCPPlatform / IPmCCPPlatform
<<Interface>> ( ControlDesk Automation))
§ IPmDS1005Platform (refer to DS1005Platform / IPmDS1005Platform
<<Interface>> ( ControlDesk Automation))
§ IPmDS1006Platform (refer to DS1006Platform / IPmDS1006Platform
<<Interface>> ( ControlDesk Automation))
§ IPmDS1007Platform (refer to DS1007Platform / IPmDS1007Platform
<<Interface>> ( ControlDesk Automation))
§ IPmDS1103Platform (refer to DS1103Platform / IPmDS1103Platform
<<Interface>> ( ControlDesk Automation))

154
ControlDesk Introduction and Overview May 2018
Migrating from Prior Versions of ControlDesk

§ IPmDS1104Platform (refer to DS1104Platform / IPmDS1104Platform


<<Interface>> ( ControlDesk Automation))
§ IPmDS1202Platform (refer to DS1202Platform / IPmDS1202Platform
<<Interface>> ( ControlDesk Automation))
§ IPmECUDiagnostics2Platform (refer to ECUDiagnostics2Platform /
IPmECUDiagnostics2Platform <<Interface>> ( ControlDesk
Automation))
§ IPmECUDiagnosticsPlatform (refer to ECUDiagnosticsPlatform /
IPmECUDiagnosticsPlatform <<Interface>> ( ControlDesk
Automation))
§ IPmFlexRayMonitoringPlatform (refer to
FlexRayMonitoringPlatform / IPmFlexRayMonitoringPlatform
<<Interface>> ( ControlDesk Automation))
§ IPmGSI2Platform (refer to GSI2Platform / IPmGSI2Platform
<<Interface>> ( ControlDesk Automation))
§ IPmGSIPlatform (refer to GSIPlatform / IPmGSIPlatform
<<Interface>> ( ControlDesk Automation))
§ IPmIPEPlatform (refer to IPEPlatform / IPmIPEPlatform
<<Interface>> ( ControlDesk Automation))
§ IPmLINMonitoringPlatform (refer to LINMonitoringPlatform /
IPmLINMonitoringPlatform <<Interface>> ( ControlDesk
Automation))
§ IPmMABXPlatform (refer to MABXPlatform / IPmMABXPlatform
<<Interface>> ( ControlDesk Automation))
§ IPmMultiProcessorPlatform (refer to MultiProcessorPlatform /
IPmMultiProcessorPlatform <<Interface>> ( ControlDesk
Automation))
§ IPmSCALEXIOPlatform (refer to SCALEXIOPlatform /
IPmSCALEXIOPlatform <<Interface>> ( ControlDesk Automation))
§ IPmVEOSPlatform (refer to VEOSPlatform / IPmVEOSPlatform
<<Interface>> ( ControlDesk Automation))
§ IPmVideoCapturingPlatform (refer to VideoCapturingPlatform /
IPmVideoCapturingPlatform <<Interface>> ( ControlDesk
Automation))
§ IPmXCPonCANPlatform (refer to XCPonCANPlatform /
IPmXCPonCANPlatform <<Interface>> ( ControlDesk Automation))
§ IPmXCPonEthernetPlatform (refer to XCPonEthernetPlatform /
IPmXCPonEthernetPlatform <<Interface>> ( ControlDesk
Automation))
§ IPmXCPonFlexRayPlatform (refer to XCPonFlexRayPlatform /
IPmXCPonFlexRayPlatform <<Interface>> ( ControlDesk Automation))

Related topics Basics

Basics on Migrating from Prior Versions of ControlDesk ........................................................ 111

155
May 2018 ControlDesk Introduction and Overview
Compatibility, Migration and Discontinuations

Discontinuations in ControlDesk
Where to go from here Information in this section

Discontinuations as of ControlDesk 4.1 ................................................ 156


Gives you an overview of the discontinuations as of ControlDesk 4.1.

Discontinuations as of ControlDesk 5.0 ................................................ 157


Gives you an overview of the discontinuations as of ControlDesk 5.0.

Discontinuations as of ControlDesk 5.1 ................................................ 157


Gives you an overview of the discontinuations as of ControlDesk 5.1.

Discontinuations as of ControlDesk 5.2 ................................................ 157


Gives you an overview of the discontinuations as of ControlDesk 5.2.

Discontinuations as of ControlDesk 5.3 ................................................ 158


Gives you an overview of the discontinuations as of ControlDesk 5.3.

Discontinuations as of ControlDesk 5.4 ................................................ 158


Gives you an overview of the discontinuations as of ControlDesk 5.4.

Discontinuations as of ControlDesk 5.6 ................................................ 158


Gives you an overview of the discontinuations as of ControlDesk 5.6.

Discontinuations as of ControlDesk 6.0 ................................................ 160


Gives you an overview of the discontinuations as of ControlDesk 6.0.

Discontinuations as of ControlDesk 6.1 ................................................ 162


Gives you an overview of the discontinuations as of ControlDesk 6.1.

Discontinuations as of ControlDesk 6.2 ................................................ 163


Gives you an overview of the discontinuations as of ControlDesk 6.2.

Discontinuations as of ControlDesk 6.3 ................................................ 163


Gives you an overview of the discontinuations as of ControlDesk 6.3.

Discontinuations as of ControlDesk 4.1

Tool automation: Enums The Python-based tool automation demos for ControlDesk 4.1 and later no
module discontinued longer use the Enums module containing enumeration definitions for configuring
automation elements of ControlDesk.

For migration information, refer to Migrating from ControlDesk 4.0 to 4.1


on page 112.

156
ControlDesk Introduction and Overview May 2018
Discontinuations in ControlDesk

Discontinuations as of ControlDesk 5.0

Multiconnect group support Before ControlDesk 5.0, to experiment with several network clients (= expansion
boxes and/or MicroAutoBox II systems connected to the host PC via Ethernet) at
the same time, you had to define multiconnect groups in the
dsgroups.ini file.

As of ControlDesk 5.0, working with multiconnect groups defined in the


dsgroups.ini file is no longer supported. To experiment with several network
clients at the same time, you have to register each client such as MicroAutoBox II
individually.

For migration information, refer to Migrating from ControlDesk 4.3 to 5.0


on page 117.

Discontinuations as of ControlDesk 5.1

ECU Diagnostics v2.0.1 device The ECU Diagnostics v2.0.1 device (supporting ASAM MCD-3 D V2.0.1) was
delivered for the last time with dSPACE Release 2013-A. This means you must
migrate to the ECU Diagnostics v2.0.2 device (supporting ASAM MCD-3 D
V2.0.2), the successor to the ECU Diagnostics v2.0.1 device.

For migration information, refer to Migrating from ControlDesk 5.0 to 5.1


on page 120.

Discontinuations as of ControlDesk 5.2

Flash User Identifier option The Flash User Identifier option, which lets you specify a user ID for a dSPACE
CAN interface (DCI‑CAN1, Calibration hub) and save the ID to the flash memory
of the interface, has been discontinued.

The following properties of the IPmCANInterface tool automation interface


have also been discontinued:
§ FlashUserIdentifierSupported
§ UserIdentifier

Refer to CANInterface / IPmCANInterface <<Interface>> ( ControlDesk


Automation).

Elektrobit's EB 61x0 interface Elektrobit's EB 61x0 (formerly BUSDOCTOR) interface is no longer supported.

157
May 2018 ControlDesk Introduction and Overview
Compatibility, Migration and Discontinuations

Discontinuations as of ControlDesk 5.3

CANcardX support Vector Informatik's CANcardX interface is no longer supported.

Default services according to ControlDesk no longer provides a default diagnostic service according to ODX
ODX semantics for fault read semantics for the following ECU diagnostics functions:
functions § Reading fault memory entries
§ Reading environment data
§ Clearing single or all fault memory entries

However, ControlDesk still provides a default diagnostic service for the above
functions according to protocol-specific service identification. To change from
working with default services according to ODX semantics to default services
according to protocol-specific service identification, you must adapt the names of
the services in your automation scripts.

In addition, you can use an XML configuration file to set up services different
from the default diagnostic services, see Basics of the XML Configuration File
( ControlDesk ECU Diagnostics).

Discontinuations as of ControlDesk 5.4

No evaluation of Python- As of ControlDesk 5.4, Python-specific environment variables such as


specific environment PYTHONHOME are no longer evaluated by ControlDesk's Internal Interpreter and
variables when they are used in extension scripts.

Discontinuations as of ControlDesk 5.6

32‑bit software support As of version 5.6, ControlDesk supports only 64-bit operating systems. 32‑bit
operating systems are not supported any longer.

MicroAutoBox software dSPACE Release 2015-B was the last release supporting MicroAutoBox with its
support variants 1401/1501, 1401/1504, 1401/1505/1506, 1401/1505/1507, and
1401/1507.

As of dSPACE Release 2016‑A, dSPACE software supports only MicroAutoBox II


with its variants 1401/1501, 1401/1504, 1401/1505/1507, 1401/1507,
1401/1511, 1401/1513, 1401/1511/1514, and 1401/1513/1514.

158
ControlDesk Introduction and Overview May 2018
Discontinuations in ControlDesk

For migration aspects, refer to Migrating from ControlDesk 5.5 to 5.6


on page 138.

MicroAutoBox Embedded PC dSPACE Release 2015-B was the last release supporting 32‑bit operating systems.
support
As a consequence, MicroAutoBox Embedded PC with Intel® AtomTM Processor
N270 with the Windows 7 (32 bit) operating system was supported for the last
time with ControlDesk 5.5 (dSPACE Release 2015‑B).

ControlDesk's ASAP3 ControlDesk's ASAM ASAP3‑compatible interface was delivered for the last time
interface with ControlDesk 5.5 (dSPACE Release 2015-B).

To automate calibration and measurement tasks, you can alternatively use:


§ ControlDesk's automation interface. Refer to Basics of ControlDesk's
Automation Interface ( ControlDesk Automation).
§ ControlDesk's ASAM MCD‑3‑compatible interface. Refer to ControlDesk
MCD-3 Automation.

CDF import/export The Calibration Data File (CDF) format used to import/export data sets was
supported for the last time with ControlDesk 5.5 (dSPACE Release 2015‑B).

To exchange calibration data, use one of the other file formats supported by
ControlDesk such as CDFX (ASAM Calibration Data File 2.0), DCM, or DSV. The
CDFX format is ControlDesk's default exchange format for data sets.

Refer to Exporting and Converting Data Sets ( ControlDesk Calibration and


Data Set Management).

User-defined databases User-defined databases (UDDBs) were supported for the last time with
(UDDBs) ControlDesk 5.5 (dSPACE Release 2015‑B).

As a consequence, to replace the UDDB‑based manipulation of CAN


communication on dSPACE real‑time hardware, you have to change the real-time
model.

For migration aspects, refer to Migrating from ControlDesk 5.5 to 5.6


on page 138.

LDF (format version 1.2 and LDF files (format version 1.2 and earlier) were supported by the
earlier) LIN Bus Monitoring device for the last time with ControlDesk 5.5 (dSPACE
Release 2015‑B).

MAT file (version 6) export ControlDesk 5.5 and earlier created version 6 MAT files that can be loaded in
MATLAB Versions 5 (R8) or later.

159
May 2018 ControlDesk Introduction and Overview
Compatibility, Migration and Discontinuations

As of version 5.6, ControlDesk creates version 7.3 MAT files that can be loaded
in MATLAB Versions 7.3 (R2006b) or later.

Discontinuations as of ControlDesk 6.0

Where to go from here Information in this topic

ControlDesk Failure Simulation Module ................................................................................ 160


Platform management automation API version 1.0 ............................................................... 160
Plotter .................................................................................................................................. 160
Integrated Variable Editor ..................................................................................................... 161
MDF file (format versions 2.0 and 3.0) export ....................................................................... 161
Methods for handling messages ........................................................................................... 161
Migration of ControlDesk 3.x experiments ............................................................................ 161
Migration of CalDesk projects ............................................................................................... 162

ControlDesk Failure ControlDesk’s Failure Simulation Module was delivered for the last time with
Simulation Module ControlDesk 5.6 of dSPACE Release 2016‑A.
§ To prepare an electrical error simulation via the graphical user interface (GUI),
use the ControlDesk XIL API EESPort GUI, which was introduced with
ControlDesk 5.5 (dSPACE Release 2015-B).
§ To prepare an electrical error simulation via automation, use the dSPACE XIL
API .NET implementation, which supports the Electrical Error Simulation Port
(EESPort).

For information on migration aspects, refer to Migrating from ControlDesk 5.6 to


6.0 on page 142.

Platform management Platform management automation API version 1.0 was supported for the last
automation API version 1.0 time with ControlDesk 5.6 of dSPACE Release 2016‑A.

For information on migrating to API version 2.0, which was introduced with
ControlDesk 5.2 from dSPACE Release 2014‑A, refer to Migrating from
ControlDesk 5.1 to 5.2 on page 127.

Plotter The Plotter was delivered for the last time with ControlDesk 5.6 of dSPACE
Release 2016‑A.

Use one of the following instruments instead:


§ Index Plotter
§ Time Plotter
§ XY Plotter

160
ControlDesk Introduction and Overview May 2018
Discontinuations in ControlDesk

For information on the differences between the different plotter types, refer to
Differences Between Time Plotter, Index Plotter, and XY Plotter ( ControlDesk
Instrument Handling).

For information on migration aspects, refer to Migrating from ControlDesk 5.6 to


6.0 on page 142.

Integrated Variable Editor ControlDesk no longer provides the Variable Editor as an integrated component.

However, you can still work with the Variable Editor as a stand-alone tool. The
stand‑alone Variable Editor is available at
https://www.dspace.com/go/requestreleasedownload.

MDF file (format versions 2.0 As of ControlDesk 6.0, exporting MDF measurement data files (MDF file format
and 3.0) export versions 2.0 and 3.0) is no longer supported.

Support for importing MDF files (format versions 2.0 and 3.0) will continue.

To export measurement data, use one of the other file formats supported by
ControlDesk. Refer to How to Configure the Storage Settings for Recording
( ControlDesk Measurement and Recording).

Methods for handling As of dSPACE Release 2016‑B, all dSPACE products use improved methods for
messages handling messages such as errors and warnings.

As a consequence:
§ Messages are no longer written to the dSPACE.log file, i.e., they are no
longer available as plain text.
To collect diagnostics information including log messages and send it to
dSPACE Support, use the dSPACE Installation Manager.
§ In ControlDesk 6.0, the dSPACE Message Monitor, which allows you to
monitor log messages that are recorded by the dSPACE Message Service, has
been removed.
§ In ControlDesk 6.0, the LogFilePath property of the Log / ILoLog
<<Interface>>, which gets the full path name of the message log file, has
been removed.

For information on the improved methods for handling messages, refer to


ControlDesk Message Handling.

Migration of ControlDesk 3.x ControlDesk 5.6 of dSPACE Release 2016-A was the last version that supports
experiments the migration of ControlDesk 3.x experiments for reuse in ControlDesk. This also
applies to the import of ControlDesk 3.x layouts.

161
May 2018 ControlDesk Introduction and Overview
Compatibility, Migration and Discontinuations

To reuse a ControlDesk 3.x experiment in ControlDesk 6.0 (or later):


1. Migrate the ControlDesk 3.x experiment to ControlDesk 5.6 (or earlier).
2. Migrate the resulting ControlDesk project from ControlDesk 5.6 (or earlier) to
ControlDesk 6.0 (or later).

Note

Remember to check whether further migration steps of the intervening


ControlDesk versions have to be carried out.

Refer to Basics on Migrating from Prior Versions of ControlDesk


on page 111.

Migration of CalDesk projects ControlDesk 5.6 of dSPACE Release 2016-A was the last version that supports
the migration of CalDesk projects for reuse in ControlDesk. This also applies to
the import of CalDesk layouts.

To reuse a CalDesk project in ControlDesk 6.0 (or later):


1. Migrate the CalDesk project to ControlDesk 5.6 (or earlier).
2. Migrate the resulting ControlDesk project from ControlDesk 5.6 (or earlier) to
ControlDesk 6.0 (or later).

Note

Remember to check whether further migration steps of the intervening


ControlDesk versions have to be carried out.

Refer to Basics on Migrating from Prior Versions of ControlDesk


on page 111.

Related topics Basics

Implementing an EESPort Client Application ( dSPACE XIL API Implementation


Guide)

Discontinuations as of ControlDesk 6.1

PAR file import As of version 6.1, ControlDesk no longer supports the import of PAR files created
with ControlDesk 3.x.

SYNECT server connection As of version 6.1, ControlDesk can no longer connect to the SYNECT server. As a
result, exchanging data, such as build results provided by ConfigurationDesk,
with the SYNECT server is no longer possible.

162
ControlDesk Introduction and Overview May 2018
Discontinuations in ControlDesk

Discontinuations as of ControlDesk 6.2

Global platforms/devices As of ControlDesk 6.2, you can no longer specify a platform/device as a


project‑global platform/device.

For migration aspects, refer to Global platforms/devices: Discontinuation and


migration on page 149.

Loader version You can perform the following platform management tasks with ControlDesk
even without a valid license:
§ Registering dSPACE real-time hardware
§ Loading, starting, and stopping applications on dSPACE real-time hardware
§ Managing the firmware of dSPACE real‑time hardware

Up to and including ControlDesk 6.1, performing these tasks without a valid


license required that you install ControlDesk ‑ Loader Version.

As of ControlDesk 6.2, the installation of ControlDesk ‑ Loader Version is no


longer available. You can perform these tasks by simply working with
ControlDesk without a valid license.

PCAN tools no longer part of As of ControlDesk 6.2, the PCAN tools from PEAK‑System Technik GmbH are no
the setup longer part of the dSPACE Release setup.

Discontinuations as of ControlDesk 6.3

Third‑party PC‑based As of ControlDesk 6.3, the following third‑party PC‑based interfaces are no
interfaces longer supported:

Supplier Interface
CAN1)
Vector Informatik § CANcardXL
§ CANcardXLe
Kvaser § LAPcan
§ LAPcan II
Eberspächer Electronics § FlexCard Cyclone II
§ FlexCard Cyclone II SE
§ FlexCard USB
LIN2)
Vector Informatik § CANcardXL
§ CANcardXLe

163
May 2018 ControlDesk Introduction and Overview
Compatibility, Migration and Discontinuations

Supplier Interface
Kvaser § LAPcan
§ LAPcan II
FlexRay3)
Eberspächer Electronics § FlexCard Cyclone II
§ FlexCard Cyclone II SE
§ FlexCard USB
1) For a list of CAN interfaces supported by ControlDesk, refer to Supported CAN
Interfaces ( ControlDesk Platform Management).
2) For a list of LIN interfaces supported by ControlDesk, refer to Supported LIN Interfaces
( ControlDesk Platform Management).
3) For a list of FlexRay interfaces supported by ControlDesk, refer to Supported FlexRay
Interfaces ( ControlDesk Platform Management).

Related topics Basics

Supported CAN Interfaces ( ControlDesk Platform Management)


Supported FlexRay Interfaces ( ControlDesk Platform Management)
Supported LIN Interfaces ( ControlDesk Platform Management)

164
ControlDesk Introduction and Overview May 2018
Tutorials, Tutorial Videos, and PDF Documents

Tutorials, Tutorial Videos, and PDF Documents

Where to go from here Information in this section

Tutorials for ControlDesk ..................................................................... 165


The ControlDesk installation provides a measurement and recording
tutorial.

Tutorial Videos for ControlDesk ........................................................... 166


The dSPACE website provides tutorial videos for ControDesk.

PDF Documents for ControlDesk .......................................................... 167


Provides an overview of the PDF documents for ControlDesk users.

Tutorials for ControlDesk

Measurement and recording This tutorial gives you step-by-step instructions for configuring and performing
tutorial measurements and recordings with ControlDesk. It focuses on the concepts of
measuring and recording with dSPACE hardware, which provides numerous
flexible and sophisticated settings. For example, you can reduce the uploaded
data stream by defining measurement triggers for the real-time application.
Unlike ECUs, dSPACE platforms usually run measurements with high-frequency
measurement rasters and data throughput has to be reduced.

The objective of this tutorial is to guide you through the first steps of measuring
and recording and to show you the basic operating concepts.

Refer to Introduction to the Measurement and Recording Tutorial


( ControlDesk Measurement and Recording).

165
May 2018 ControlDesk Introduction and Overview
Tutorials, Tutorial Videos, and PDF Documents

Related topics Basics

Tutorial Videos for ControlDesk ............................................................................................. 166

Tutorial Videos for ControlDesk

Tutorial videos The following table shows the tutorial videos for ControlDesk available on the
dSPACE website. Refer to https://www.dspace.com/go/controldesktutorial.

Accessing tutorial videos requires a mydSPACE login.

Subject Tutorial Videos


Basic practices
ControlDesk § https://www.dspace.com/go/tutorial_cd_meas_on_platf
Instrument You can perform triggered measurement on a dSPACE platform.
Handling The tutorial videos show you:
§ How to use a Time Plotter to configure trigger settings automatically.
§ How to use a Time Plotter to configure trigger settings interactively.
§ https://www.dspace.com/go/tutorial_cd_custom_instr
You can add a Python automation script to an instrument to customize it and extend its functionality.
The tutorial videos show you:
§ How to add a Python script to an instrument and make the instrument a custom instrument.
§ How to extend instrument functionality via instrument scripts. The stopwatches in the Instrument
Selector are used as examples.
§ https://www.dspace.com/go/tutorial_cd_plotters
ControlDesk offers three different plotters to display signals.
The tutorial videos give you an overview of how to handle the plotters:
§ Comparing Time Plotter, Index Plotter, and XY Plotter
§ Sensitive areas and adding signals
§ Zooming and moving
§ Properties controlbar
§ Displaying cursors
§ Signal settings
ControlDesk https://www.dspace.com/go/tutorial_cd_meas_on_platf
Measurement You can perform triggered measurement on a dSPACE platform.
and Recording The tutorial videos show you:
§ How to use a Time Plotter to configure trigger settings automatically.
§ How to use a Time Plotter to configure trigger settings interactively.

166
ControlDesk Introduction and Overview May 2018
PDF Documents for ControlDesk

Subject Tutorial Videos


Advanced practices
ControlDesk https://www.dspace.com/go/tutorial_cd_el_err_sim
Electrical Error You can use electrical error simulation to test ECU software under error conditions.
Simulation via XIL The tutorial videos show you:
API EESPort § Basics on electrical error simulation
§ How to create an Electrical Error Simulation Port (EESPort) to interface dSPACE failure simulation
hardware.
§ How to configure and switch an electrical error.
§ How to work with multiple error sets when performing electrical error simulation.
§ How to monitor the switching behavior of discrete failure simulation hardware.
§ How to monitor the switching behavior of SCALEXIO failure simulation hardware.
§ How to use software triggers for electrical error simulation.
ControlDesk https://www.dspace.com/go/tutorial_cd_custom_instr
Customization You can add a Python automation script to an instrument to customize it and extend its functionality.
The tutorial videos show you:
§ How to add a Python script to an instrument and make the instrument a custom instrument.
§ How to extend instrument functionality via instrument scripts. The stopwatches in the Instrument Selector
are used as examples.

Public product videos For public product videos, refer to ControlDesk product videos.

Related topics Basics

Tutorials for ControlDesk ...................................................................................................... 165

PDF Documents for ControlDesk

Overview The following table shows the PDF documents available for ControlDesk:

Subject PDF Document


Introduction and overview ControlDeskIntroductionAndOverview.pdf1)
Basic practices
ControlDesk Project and Experiment ControlDeskProjectAndExperimentManagement.pdf
Management
ControlDesk Platform Management ControlDeskPlatformManagement.pdf
ControlDesk Variable Management ControlDeskVariableManagement.pdf
ControlDesk Layouting ControlDeskLayouting.pdf
ControlDesk Instrument Handling ControlDeskInstrumentHandling.pdf
ControlDesk Calibration and Data Set ControlDeskCalibrationandDataSetManagement.pdf
Management

167
May 2018 ControlDesk Introduction and Overview
Tutorials, Tutorial Videos, and PDF Documents

Subject PDF Document


ControlDesk Measurement and Recording ControlDeskMeasurementAndRecording.pdf
ControlDesk User Interface Handling ControlDeskUserInterfaceHandling.pdf
ControlDesk Message Handling ControlDeskCustomization.pdf
Advanced practices
ControlDesk Bus Navigator ControlDeskBusNavigator.pdf
ControlDesk ECU Diagnostics ControlDeskECUDiagnostics.pdf
ControlDesk Signal Editor ControlDeskSignalEditor.pdf
ControlDesk Electrical Error Simulation via ControlDeskElectricalErrorSimulation.pdf
XIL API EESPort
ControlDesk Automation ControlDeskAutomation.pdf
ControlDesk MCD-3 Automation ControlDeskMCD3Automation.pdf
ControlDesk Measurement Data API ControlDeskMeasurementDataAPI.pdf
ControlDesk Customization ControlDeskMessageHandling.pdf
1) A printed copy of this document is available on demand. You can order it free of charge by using the following link:
http://www.dspace.com/go/requestreleasematerial

168
ControlDesk Introduction and Overview May 2018
Glossary

Glossary

Introduction Briefly explains the most important expressions and naming conventions used in
the ControlDesk documentation.

Where to go from here Information in this section

A ......................................................................................................... 170

B ......................................................................................................... 171

C ......................................................................................................... 172

D ......................................................................................................... 176

E ......................................................................................................... 180

F .......................................................................................................... 182

G ......................................................................................................... 183

H ......................................................................................................... 184

I .......................................................................................................... 184

K ......................................................................................................... 186

L .......................................................................................................... 186

M ........................................................................................................ 187

N ......................................................................................................... 190

O ......................................................................................................... 190

P ......................................................................................................... 192

Q ......................................................................................................... 194

R ......................................................................................................... 194

S ......................................................................................................... 196

169
May 2018 ControlDesk Introduction and Overview
Glossary

T ......................................................................................................... 198

U ......................................................................................................... 199

V ......................................................................................................... 200

W ........................................................................................................ 203

X ......................................................................................................... 203

A2L file A file that contains all the relevant information on measurement and
calibration variables in an ECU application and the ECU's communication
interface(s). This includes information on the variables' memory addresses and
conversion methods, the memory layout and data structures in the ECU as well
as interface description data (IF_DATA).

Acquisition An object in the Measurement Configuration controlbar that


specifies the variables to be measured and their measurement configuration.

Active variable description The variable description that is currently active


for a platform/device. Multiple variable descriptions can be assigned to one
platform/device, but only one of them can be active at a time.

Additional write variable A scalar parameter or writable measurement


variable that can be connected to an instrument in addition to the main
variable. When the value of the main variable changes, the changed value is also
applied to all the additional write variables connected to the instrument.

Airspeed Indicator An instrument for displaying the airspeed of a simulated


aircraft.

Altimeter An instrument for displaying the altitude of a simulated aircraft.

Animated Needle An instrument for displaying the value of a connected


variable by a needle deflection.

Application image An image file that contains all the files that are created
when the user builds a real-time application. It particularly includes the variable
description (SDF) file. To extend a real-time application, ControlDesk lets the user
create an updated application image from a data set. The updated application
image then contains a real-time application with an additional set of parameter
values.

Artificial Horizon An instrument displaying the rotation on both the lateral


and the longitudinal axis to indicate the angle of pitch and roll of a simulated
aircraft. The Artificial Horizon has a pitch scale and a roll scale.

170
ControlDesk Introduction and Overview May 2018
B

Automatic Reconnect Feature for automatically reconnecting to


platform/device hardware, for example, when the ignition is turned off and on,
or when the physical connection between the ControlDesk PC and the ECU is
temporarily interrupted.
If the feature is enabled for a platform/device and if the platform/device is in the
'unplugged' state, ControlDesk tries to re-establish the logical connection to
the platform/device hardware. After the logical connection is re-established, the
platform/device has the same state as before the unplugged state was detected.
A measurement started before the unplugged state was detected is resumed.

Automation A communication mechanism that can be used by various


programming languages. A client can use it to control a server by calling
methods and properties of the server's automation interface.

Automation script A script that uses automation to control an automation


server.

Axis point object Common axis

Bar An instrument for displaying a numerical value as a bar deflection on a


horizontal or vertical scale. Also available as a value cell type of the Variable
Array.

Bitfield A value cell type of the Variable Array for displaying and editing
the source value of a parameter as a bit string.

Bookmark A marker for a certain event during a measurement or recording.

Browser An instrument for displaying HTML and TXT files. It also supports
Microsoft Internet Explorer© plug-ins that are installed on your system.

Bus communication replay A feature of the Bus Navigator that lets you
replay logged bus communication data from a log file. You can add replay nodes
to the Bus Navigator tree for this purpose. You can specify filters to replay
selected parts of the logged bus communication.

Bus connection A mode for connecting dSPACE real-time hardware to the


host PC via bus. The list below shows the possible bus connections:
§ dSPACE real-time hardware installed directly in the host PC
§ dSPACE real-time hardware installed in an expansion box connected to the
host PC via dSPACE link board

Bus Instrument An instrument available for the Bus Navigator. It can be


configured for different purposes, for example, to display information on
received messages (RX messages) or to manipulate and transmit messages (TX
messages). The instrument is tailor-made and displays only the message- and
signal-specific settings which are enabled for display and/or manipulation by
ControlDesk during run time.

171
May 2018 ControlDesk Introduction and Overview
Glossary

Bus logging A feature of the Bus Navigator that lets you log raw bus
communication data. You can add logger nodes on different hierarchy levels of
the Bus Navigator tree for this purpose. You can specify filters to log filtered bus
communication. The logged bus communication can be replayed.

Bus monitoring A feature of the Bus Navigator that lets you observe bus
communication. You can open monitoring lists and add monitor nodes on
different hierarchy levels of the Bus Navigator tree for this purpose. You can
specify filters to monitor filtered bus communication.

Bus Navigator A controlbar for handling bus messages, such as CAN


messages, LIN frames, FlexRay PDUs, and Ethernet packets.

Bypassing A method for replacing an existing ECU function by running a


new function.

Calculated variable A variable that is derived from one or more input


variables. Input variables are measurement variables, single elements of
measurement arrays/value blocks, scalar parameters, or existing calculated
variables. The value of a calculated variable is calculated via a user‑defined
computation formula that must contain at least one input variable from the
related variable description.
Calculated variables are added to the variable list of the Variable Browser. They
can be visualized, measured, and recorded like "normal" variables in
ControlDesk.
Calculated variables are represented by the symbol.

CalDemo ECU A program that runs on the same PC as ControlDesk. It


simulates an ECU on which the Universal Measurement and Calibration ( XCP)
protocol and the Unified Diagnostic Services (UDS) protocol are implemented.
The CalDemo ECU allows you to perform parameter calibration, variable
measurement, and ECU diagnostics with ControlDesk under realistic conditions,
but without having to have a real ECU connected to the PC. Communication
between the CalDemo ECU and ControlDesk can be established via XCP on CAN
or XCP on Ethernet, and UDS on CAN.

Tip

If communication is established via XCP on Ethernet, the CalDemo ECU can


also run on a PC different from the PC on which ControlDesk is running.

The memory of the CalDemo ECU consists of two areas called memory page.
Each page contains a complete set of parameters, but only one page is accessible
by the CalDemo ECU at a time. You can easily switch the memory pages of the
CalDemo ECU to change from one parameter to another in a single step.

172
ControlDesk Introduction and Overview May 2018
C

Two ECU tasks run on the CalDemo ECU:


§ ECU task #1 runs at a fixed sample time of 5 ms. In ControlDesk's
Measurement Configuration, ECU task #1 is related to the time-based 5 ms,
10 ms, 50 ms and 100 ms measurement rasters of the CalDemo ECU.
§ ECU task #2 has a variable sample time. Whenever the CalDemo ECU program
is started, the initial sample time is 5 ms. This can then be increased or
decreased by using the dSPACE CalDemo dialog.
ECU task #2 is related to the extEvent measurement raster of the
CalDemo ECU.
The CalDemo ECU can also be used to execute diagnostic services and jobs,
handle DTCs and perform measurement and calibration via ECU diagnostics.
The CalDemo ECU program is run by invoking CalDemo.exe. The file is located
in the .\Demos\CalDemo folder of the ControlDesk installation.

Calibration Changing the parameter values of real-time applications,


ECU applications, or VPUs.

Calibration Hub A dSPACE-specific interface between the host PC, and up to


two CAN buses and USB devices. The Calibration Hub transfers data to the host
PC via the universal serial bus (USB).

Calibration memory segment Part of the memory of an ECU containing the


calibratable parameters. Memory segments can be defined as MEMORY_SEGMENT
in the A2L file. ControlDesk can use the segments to evaluate the memory pages
of the ECU.
ControlDesk lets you perform the calibration of:
§ Parameters inside memory segments
§ Parameters outside memory segments
§ Parameters even if no memory segments are defined in the A2L file. However,
ECUs with DCI-GSI1 always require memory segments.

CAN Bus Monitoring device A device that monitors the data stream on a
CAN bus connected to the ControlDesk PC.
The CAN Bus Monitoring device works, for example, with PC-based CAN
interfaces such as the DCI‑CAN2 or the DCI‑CAN/LIN1.
The device supports the following variable description file types:
§ DBC
§ FIBEX
§ AUTOSAR system description

CANGenerator A program that simulates a CAN system, that is, it generates


signals that can be measured and recorded with ControlDesk. The program runs
on the same PC as ControlDesk.
The CANGenerator allows you to use the CAN Bus Monitoring device under
realistic conditions, but without having to have any device hardware connected
to the PC.
The CAN (Controller Area Network) protocol is used for communication between
the CANGenerator and ControlDesk. However, since the CANGenerator runs on
the same PC as ControlDesk, ControlDesk does not communicate with the

173
May 2018 ControlDesk Introduction and Overview
Glossary

device via a real CAN channel, but via a virtual CAN channel implemented on the
host PC.
The CAN generator program is run by invoking CANGenerator.exe. The file is
located in the .\Demos\CANGenerator folder of the ControlDesk installation.

Capture A data packet of all the measurement variables assigned to a


measurement raster. The packet comprises the data that results from a single
triggering of the raster.

CCP Abbreviation of CAN Calibration Protocol. This protocol can be


implemented on electronic control units (ECUs) and allows users to access ECUs
with Measurement and Calibration Systems (MCS).
The basic features of CCP are:
§ Read and write access to the ECU memory, i.e., providing access for calibration
§ Synchronous data acquisition
§ Flash programming for ECU development purposes
The CCP protocol was developed by ASAM e.V. (Association for Standardization
of Automation and Measuring Systems e.V.). For the protocol specification, refer
to http://www.asam.net.

CCP device A device that provides access to an ECU with CCP connected to
the ControlDesk PC via CAN, for example, for measurement and calibration
purposes via CCP (CAN Calibration Protocol).

Check Button An instrument (or a cell type of the Variable Array) for
displaying whether the value of a connected variable matches predefined values
or for writing a predefined value to a connected variable.

cmdloader A command line tool for handling applications without using the
GUI of ControlDesk.

Common axis A parameter that consists of a 1‑dimensional array


containing axis points. A common axis can be referenced by one or more
curves and/or maps. Calibrating the data points of a common axis affects all
the curves and/or maps referencing the axis.
Common axes are represented by the symbol.

Common Program Data folder A standard folder for application-specific


configuration data that is used by all users.
%PROGRAMDATA%\dSPACE\<InstallationGUID>\<ProductName>
or
%PROGRAMDATA%\dSPACE\<ProductName>\<VersionNumber>

Computation method A computation method is a formula or a table that


defines the transformation of a source value into a converted value (and vice
versa). In addition to the computation methods defined in the variable
description file, ControlDesk provides the __Identity computation method which
means the converted and the source value are equal.

Connected A platform/device state defined by the following characteristics:


§ A continuous logical connection is established between ControlDesk and the
platform/device hardware or VPU.

174
ControlDesk Introduction and Overview May 2018
C

§ A platform/device must be in the 'connected' state before it can change to the


'measuring/recording' or 'online calibration started' state.
§ Online calibration is impossible. ControlDesk did not yet adjust the memory
segments containing calibration data in the platform/device and on the
corresponding hardware or VPU. Offline calibration is possible.
§ Platform/device configuration is not possible. However, you can invoke
platform/device configuration for a platform/device that is in the connected
state. ControlDesk temporarily sets the platform/device to the disconnected
state.
The 'connected' platform/device state is indicated by the icon.

Connection mode dSPACE real‑time systems can be installed within the host
PC or connected to the host via a bus interface and/or via Ethernet. When the
Ethernet is being used, different network clients might exist. The connection type
being used and, in the case of Ethernet, the network client being used,
determine the dSPACE systems that can be accessed.

Control primitive A special diagnostic communication object for changing


communication states or protocol parameters, or for identifying (ECU) variants.

Controlbar A window or pane outside the working area. Can be docked to


an edge of the main window or float in front of it. A controlbar can contain a
document, such as a layout, or a tool, such as the Message Viewer. It can be
grouped with other controlbars in a window with tabbed pages.

ControlDesk The main version of ControlDesk for creating and running


experiments, and for accessing dSPACE real‑time hardware and VEOS. The
functionality can be extended by optional software modules.

ControlDesk ‑ Operator Version A version of ControlDesk that provides


only a subset of functionality for running existing experiments. The functionality
can be extended by optional software modules.

ControlDesk Bus Navigator Module An optional software module for


ControlDesk for handling bus messages, such as CAN messages, LIN frames, and
FlexRay frames and PDUs.

ControlDesk ECU Diagnostics Module An optional software module for


ControlDesk that facilitates the calibration and validation of ECU diagnostic
functions.

ControlDesk ECU Interface Module An optional software module for


ControlDesk for calibration and measurement access to electronic control units
(ECUs). The module is also required for calibration and measurement access to
virtual ECUs (V‑ECUs) used in virtual validation scenarios.

ControlDesk Signal Editor Module An optional software module for


ControlDesk for the graphical definition and execution of signal generators for
stimulating model variables of real-time/offline simulation applications.

Controller board Single‑board hardware computing the real-time


application. Contains a real-time processor for fast calculation of the model and
I/O interfaces for carrying out the control developments.

175
May 2018 ControlDesk Introduction and Overview
Glossary

Conversion table A table that specifies the computation of a source value


into a converted value. In the case of verbal conversion, the converted value is a
string that represents one numerical value or a range of numerical values.

Conversion type The type of a computation method, for example a linear


function or a verbal computation method.

Curve (variable type) A parameter that consists of


§ A 1‑dimensional array containing the axis points for the x‑axis. This array can
also be specified by a reference to a common axis.
§ Another 1‑dimensional array containing data points. The curve assigns one
data point to each axis point.
Curves are represented by the symbol.

DAQ module A hardware module for the acquisition of physical quantities

Data Cursor One or two cursors that are used to display the values of
selected chart positions in a Time Plotter or an Index Plotter.

Data set A set of the parameters and their values of a platform/device


derived from the variable description of the platform/device. There are different
types of data sets:
§ Global data set
§ Reference data set
§ Sub data set
§ Unassigned data set
§ Working data set

Data set container A ZIP archive that contains a variable description


together with a number of data sets and/or ECU Image files belonging to it.
A data set container makes it easy to consistently exchange the results of
parameter calibration.

Data Set Manager A software component that manages the data sets of an
experiment.

Data type Record layout

DCI-CAN/LIN1 A dSPACE-specific interface between the host PC and the


CAN/CAN FD bus and/or LIN bus. The DCI-CAN/LIN1 transfers messages between
the CAN‑/LIN‑based devices and the host PC via the universal serial bus (USB).

DCI-CAN1 A dSPACE-specific interface between the host PC and the CAN


bus. The DCI‑CAN1 transfers CAN messages between the CAN‑based devices
and the host PC via the universal serial bus (USB).

176
ControlDesk Introduction and Overview May 2018
D

DCI-CAN2 A dSPACE-specific interface between the host PC and the CAN


bus. The DCI‑CAN2 transfers CAN and CAN FD messages between the
CAN‑based devices and the host PC via the universal serial bus (USB).

DCI‑GSI1 device A device that provides access to an ECU with DCI‑GSI1


connected to the ControlDesk PC for measurement, calibration, and bypassing
purposes via the ECU's debug interface.

DCI-GSI2 device A device that provides access to an ECU with DCI-GSI2


connected to the ControlDesk PC for measurement, calibration, and bypassing
purposes via the ECU's debug interface.

DCI-GSIx Abbreviation of dSPACE Communication Interface - Generic Serial


Interface. A dSPACE-specific interface for ECU calibration, measurement and
ECU interfacing.

DCI-KLine1 Abbreviation of dSPACE Communication Interface - K-Line


Interface. A dSPACE-specific interface between the host PC and the diagnostics
bus via K-Line.

Debug interface An ECU interface for diagnostics tasks and flashing.

Default raster A platform-/device-specific measurement raster that is used


when a variable of the platform/device is connected to a plotter or a
recorder, for example.

Deposition definition A definition specifying the sequence in which the axis


point values of a curve or map are deposited in memory.

Device A software component for carrying out calibration and/or


measurement, bypassing, ECU flash programming, or ECU diagnostics
tasks. ControlDesk provides the following devices:
§ CAN Bus Monitoring device
§ CCP device
§ DCI‑GSI1 device
§ DCI-GSI2 device
§ ECU Diagnostics device
§ Ethernet Bus Monitoring device
§ FlexRay Bus Monitoring device
§ LIN Bus Monitoring device
§ Video Capturing device
§ XCP on CAN device
§ XCP on Ethernet device
§ XCP on FlexRay device
Each device usually has a variable description that specifies the device’s
variables to be calibrated and measured.

Diagnostic interface Interface for accessing the fault memory of an ECU.

Diagnostic job (often called Java job) Programmed sequence that is usually
built from a sequence of the diagnostic service. A diagnostic job is either a
single-ECU job or a multiple-ECU job, depending on whether it communicates
with one ECU or multiple ECUs.

177
May 2018 ControlDesk Introduction and Overview
Glossary

Diagnostic protocol A protocol that defines how an ECU communicates


with a connected diagnostic tester. The protocol must be implemented on the
ECU and on the tester. The diagnostics database specifies the diagnostic
protocol(s) supported by a specific ECU.
ControlDesk’s ECU Diagnostics device supports CAN and K‑Line as the physical
layers for communication with an ECU connected to the ControlDesk PC. For
information on the supported diagnostic protocols with CAN and K‑Line, refer to
Basics of ECU Diagnostics ( ControlDesk ECU Diagnostics).

Diagnostic service A service implemented on the ECU as a basic diagnostic


communication element. Communication is performed by selecting a service,
configuring its parameters, executing it, and receiving the ECU results. When a
service is executed, a defined request is sent to the ECU and the ECU answers
with a specific response.

Diagnostic trouble code (DTC) A hexadecimal index for the identification of


vehicle malfunctions. DTCs are stored in the fault memory of ECUs and can be
read by diagnostic testers.

Diagnostics database A database that completely describes one or more


ECUs with respect to diagnostics communication. ControlDesk supports the
ASAM MCD-2 D ODX database format, which was standardized by ASAM e.V.
(Association for Standardisation of Automation and Measuring Systems e.V.). For
the format specification, refer to http://www.asam.net.
Proprietary diagnostics database formats are not supported by ControlDesk.

Diagnostics Instrument An instrument for communicating with an ECU via


the diagnostic protocol using diagnostic services, diagnostic jobs, and control
primitives.

Disabled A platform/device state defined by the following characteristics:


§ No logical connection is established between ControlDesk and the
platform/device hardware or VPU.
§ When a platform/device is disabled, ControlDesk does not try to establish the
logical connection for that platform/device. Any communication between the
platform/device hardware or VPU and ControlDesk is rejected.
§ Online calibration is impossible. Offline calibration is possible.
§ Platform/device configuration is possible.

The 'disabled' platform/device state is indicated by the icon.

Disconnected A platform/device state defined by the following


characteristics:
§ No logical connection is established between ControlDesk and the
platform/device hardware or VPU.
§ When a platform/device is in the disconnected state, ControlDesk does not try
to re-establish the logical connection for that platform/device.
§ Online calibration is impossible. Offline calibration is possible.
§ Platform/device configuration is possible.
The 'disconnected' platform/device state is indicated by the icon.

178
ControlDesk Introduction and Overview May 2018
D

Display An instrument (or a value cell type of the Variable Array) for
displaying the value of a scalar variable or the text content of an ASCII variable.

Documents folder A standard folder for user-specific documents.


%USERPROFILE%\My Documents\dSPACE\<ProductName>\
<VersionNumber>

DS1005 PPC Board platform A platform that provides access to a DS1005


PPC Board connected to the host PC for function prototyping and HIL simulation
purposes.

DS1006 Processor Board platform A platform that provides access to a


DS1006 Processor Board connected to the host PC for HIL simulation and
function prototyping purposes.

DS1007 PPC Processor Board platform A platform that provides access to a


single multicore DS1007 PPC Processor Board or a DS1007 multiprocessor system
consisting of two or more DS1007 PPC Processor Boards, connected to the
host PC for HIL simulation and function prototyping purposes.

DS1103 PPC Controller Board platform A platform that provides access to


a DS1103 PPC Controller Board connected to the host PC for function
prototyping purposes.

DS1104 R&D Controller Board platform A platform that provides access to


a DS1104 R&D Controller Board installed in the host PC for function prototyping
purposes.

DS1202 MicroLabBox platform A platform that provides access to a


MicroLabBox connected to the host PC for function prototyping purposes.

DsDAQ service A service in a real-time application or offline simulation


application (OSA) that provides measurement data from the application to the
host PC. Unlike the host service, the DsDAQ service lets you perform, for
example, triggered measurements with complex trigger conditions.
The following platforms support applications that contain the DsDAQ service:
§ DS1007 PPC Processor Board
§ DS1202 MicroLabBox
§ SCALEXIO
§ VEOS
§ XIL API MAPort

dSPACE Calibration and Bypassing Service An ECU service for


measurement, calibration, bypassing, and ECU flash programming. The dSPACE
Calibration and Bypassing Service can be integrated on the ECU. It provides
access to the ECU application and the ECU resources and is used to control
communication between an ECU and a calibration and/or bypassing tool.
With the dSPACE Calibration and Bypassing Service, users can run measurement,
calibration, bypassing, and flash programming tasks on an ECU via the DCI‑GSI1
or DCI‑GSI2. The service is also designed for bypassing ECU functions using
dSPACE prototyping hardware by means of the RTI Bypass Blockset in connection
with DPMEM PODs and the DCI‑GSI1. The dSPACE Calibration and Bypassing

179
May 2018 ControlDesk Introduction and Overview
Glossary

Service allows measurement, calibration, and bypassing tasks to be performed in


parallel.

dSPACE Internal Bypassing Service An ECU service for on‑target


prototyping. The dSPACE Internal Bypassing Service can be integrated in the ECU
application. It lets you add additional functions to be executed in the context of
the ECU application without the need for recompiling the ECU application.

dSPACE system A hardware system such as MicroAutoBox or SCALEXIO on


which the real-time application runs.

Duration trigger A trigger that defines a duration. Using a duration


trigger, you can, for example, specify the duration of data acquisition for a
measurement raster. A duration trigger can be used as a stop trigger.

ECU Abbreviation of electronic control unit.

ECU application A sequence of operations executed by an ECU. An


ECU application is mostly represented by a group of files such as
ECU Image files, MAP files, A2L files and/or software module description
files.

ECU calibration interface Interface for accessing an ECU by either


emulating the ECU's memory or using a communication protocol (for example,
XCP on CAN).

ECU diagnostics Functions such as:


§ Handling the ECU fault memory: Entries in the ECU´s fault memory can be
read, cleared, and saved.
§ Executing diagnostic services and jobs: Users can communicate with an ECU
via a diagnostic protocol using diagnostic services, diagnostic jobs, and control
primitives.
ControlDesk provides the ECU Diagnostics device device to access ECUs for
diagnostic tasks. Communication is via diagnostic protocols implemented on
the ECUs.
ECU diagnostics with ControlDesk are completely based on Open Diagnostic
Data Exchange (ODX), the ASAM MCD-2 D diagnostics standard.
ControlDesk provides the Fault Memory Instrument and the Diagnostics
Instrument for ECU diagnostics tasks.

ECU Diagnostics device A device that provides access to ECUs connected to


the ControlDesk PC via CAN or K-Line for diagnostics or flash programming
purposes.
ControlDesk provides the ECU Diagnostics v2.0.2 device, which supports the
ASAM MCD-3 D V2.0.2 standard.

180
ControlDesk Introduction and Overview May 2018
E

ControlDesk supports the following ODX database standards:


§ ASAM MCD-2 D V2.0.1
§ ASAM MCD-2 D V2.2.0 (ISO 22901‑1)

ECU flash programming A method by which new code or data is stored in


ECU flash memory.

ECU Image file A binary file that is part of the ECU application. It usually
contains the code of an ECU application and the data of the parameters within
the application. It can be stored as an Intel Hex (HEX) or Motorola S‑Record
(MOT or S19) file.

EESPort Configurations controlbar A controlbar for configuring error


configurations.

Electrical Error Simulation port (EESPort) An Electrical Error Simulation


port (EESPort) provides access to a failure simulation hardware for simulating
electrical errors in an ECU wiring according to the ASAM AE XIL API standard.
The configuration of the EESPort is described by a hardware-dependent port
configuration and one or more error configurations.

Environment model A model that represents a part or all of the ECU's


environment in a simulation scenario.
The environment model is a part of the simulation system.

Environment VPU The executable of an environment model built for the


VEOS platform. An environment VPU is part of an offline simulation application
(OSA).

Error An electrical error that is specified by:


§ An error category
§ An error type
§ A load type

Error category The error category defines how a signal is disturbed. Which
errors you can create for a signal depends on the connected failure simulation
hardware.

Error configuration An XML file that describes a sequence of errors you


want to switch during electrical error simulation. Each error configuration
comprises error sets with one or more errors.

Error set An error set is used to group errors (pin failures).

Error type The error type specifies the way an error category – i.e., an
interruption or short circuit of signals – is provided. The error type defines the
disturbance itself.

Ethernet Bus Monitoring device A device that monitors the data stream on
an Ethernet network connected to the ControlDesk PC.

Ethernet connection A mode for connecting dSPACE real-time hardware to


the host PC via Ethernet. The list below shows the possible Ethernet connections:

181
May 2018 ControlDesk Introduction and Overview
Glossary

§ dSPACE real-time hardware installed in an expansion box connected to the


host PC via Ethernet.
§ MicroAutoBox and MicroLabBox connected via Ethernet.

Event An event that is triggered by an action performed in ControlDesk.

Event context The scope of validity of event sources and events. There is
one event handler code area for each event context.

Event handler Code that is executed when the related event occurs.

Event management Functionality for executing custom code according to


actions triggered by ControlDesk.

Event source An object providing and triggering events.


LayoutManagement is an example of an event source.

Event state State of an event. ControlDesk provides the following event


states:
§ No event handler is defined
§ Event handler is defined and enabled
§ Event handler is defined and disabled
§ Event handler is defined, but no Python code is available
§ Event handler is deactivated because a run-time error occurred during the
execution of the Python code

Expansion box A box that hosts dSPACE boards. It can be connected to the
host PC via bus connection or via network.

Experiment A container for collecting and managing information and files


required for a parameter calibration and/or measurement task. A number of
experiments can be collected in a project but only one of them can be active.

Extension script A Python script (PY or PYC file) that is executed each time
ControlDesk starts up. An extension script can be executed for all users or user-
specifically.

Failure insertion unit Hardware unit used with dSPACE simulators to


simulate failures in the wiring of an ECU, such as broken wire and short circuit to
ground.

Fault memory Part of the ECU memory that stores diagnostic trouble code
(DTC) entries with status and environment information.

Fault Memory Instrument An instrument for reading, clearing, and saving


the content of the ECU’s fault memory.

182
ControlDesk Introduction and Overview May 2018
G

Firmware update An update for the firmware installed in the board’s flash
memory. Firmware should be updated if it is older than required by the real-time
application to be downloaded.

Fixed axis An axis with data points that are not deposited in the ECU
memory. Unlike a common axis, a fixed axis is specified within a curve
(variable type) or map. The parameters of a fixed axis cannot be calibrated.

Fixed parameter A parameter that has a fixed value during a running


simulation. Changing the value of a fixed parameter does not immediately affect
the simulation results. The affect occurs only after you stop the simulation and
start it again. A fixed parameter is represented by an added pin in its symbol, for
example: .

Flash job A specific diagnostic job for flashing the ECU memory. A flash job
implements the process control for flashing the ECU memory, such as
initialization, security access, writing data blocks, etc.

FlexRay Bus Monitoring device A device that monitors the data stream on
a FlexRay bus connected to the ControlDesk PC.
The FlexRay Bus Monitoring device works only with PC-based FlexRay interfaces.
The device supports the following variable description file types:
§ FIBEX
§ AUTOSAR system description

Flight recording The recording of data on a hardware device that does not
require a physical connection between the host PC and the hardware device.

Frame An instrument for adding a background frame to a layout, for


example, to visualize an instrument group.

Gauge An instrument for displaying the value of the connected variable by a


needle deflection on a circular scale.

Gigalink module A dSPACE board for connecting several processor boards in


a multiprocessor system. The board allows high-speed serial data transmission via
fiber-optic cable.

Global data set A data set that is independent of a variable description and
can be compared to and merged with other (global) data sets.

Group A collection of variables that are grouped according to a certain


criterion.

183
May 2018 ControlDesk Introduction and Overview
Glossary

Heading Indicator An instrument displaying the heading direction of a


simulated aircraft on a circular scale.

Hex Editor An editor that displays the memory segments of a device. A data
set represents the memory segments of one device. The memory can be edited if
the data set is writable.

Host service A service in a real-time application that provides


measurement data from the application to the host PC.
The following platforms support applications that contain the host service:
§ DS1005 PPC Board
§ DS1006 Processor Board
§ DS1103 PPC Controller Board
§ DS1104 R&D Controller Board
§ MicroAutoBox
§ Multiprocessor System

Index Plotter A plotter instrument for displaying signals that are measured
in an event-based raster (index plots).

Input quantity A measurement variable that is referenced by a common axis


and that provides the input value of that axis.

Instrument An on-screen representation that is designed to monitor and/or


control simulator variables interactively and to display data captures. Instruments
can be arranged freely on layouts.
The following instruments can be used in ControlDesk:
§ Airspeed Indicator
§ Altimeter
§ Animated Needle
§ Artificial Horizon
§ Bar
§ Browser
§ Bus Instrument
§ Check Button
§ Diagnostics Instrument
§ Display
§ Fault Memory Instrument
§ Frame

184
ControlDesk Introduction and Overview May 2018
I

§ Gauge
§ Heading Indicator
§ Index Plotter
§ Invisible Switch
§ Knob
§ Multistate Display
§ Multiswitch
§ Numeric Input
§ On/Off Button
§ Push Button
§ Radio Button
§ Selection Box
§ Slider
§ Sound Controller
§ Static Text
§ Steering Controller
§ Table Editor
§ Time Plotter
§ Variable Array
§ Video Monitoring instrument
§ XY Plotter

Instrument Navigator A controlbar that displays a tree with all the


instruments of the active layout and all the variables that are connected to
them. The Instrument Navigator's main function is easy selection of instruments
in complex layouts.

Instrument Selector A controlbar that provides access to ControlDesk's


instruments. The instruments can be placed on a layout via double-click or
drag & drop.

Instrumentation The entirety of functions, menus, commands, and dialogs


for working with instruments.

Interface description data (IF_DATA) An information structure, mostly


provided by an A2L file, describing the type, features and configuration of an
implemented ECU interface.

Interpreter ControlDesk's built-in programming interface for editing, running


and importing Python scripts. It contains an Interpreter controlbar where the
user can enter Python commands interactively and which displays output and
error messages of Python commands.

Interpreter controlbar A controlbar that can be used to execute line-based


commands. It is used by the Interpreter to print out Python standard error
messages and standard output during the execution or import of Python scripts.

Invisible Switch An instrument for defining an area that is sensitive to


mouse operations.

185
May 2018 ControlDesk Introduction and Overview
Glossary

IOCNET IOCNET (I/O carrier network) is a dSPACE-specific high-speed serial


communication bus that connects all the real-time hardware in a SCALEXIO
system. IOCNET can also be used to build a multiprocessor system that consists
of multiple SCALEXIO processor hardware components.

Knob An instrument for displaying and setting the value of the connected
variable by means of a knob on a circular scale.

Label list A list of user-defined variables that can be used for taking
snapshots, etc.

Layout A window with instruments connected to variables of one or more


simulation models.

Layout Navigator A controlbar that displays all opened layouts. It can


be used for switching between layouts.

Leading raster The measurement raster that specifies the trigger settings
for the Time Plotter display. The leading raster determines the time range that
is visible in the plotter if a start and stop trigger is used for displaying the signals.

LIN Bus Monitoring device A device that monitors the data stream on a LIN
bus connected to the ControlDesk PC.
The LIN Bus Monitoring device works, for example, with PC-based LIN interfaces.
The device supports the following variable description file types:
§ LDF
§ FIBEX
§ AUTOSAR system description

Load type The load type specifies the option to disturb a signal with or
without load rejection.

Local Program Data folder A standard folder for application-specific


configuration data that is used by the current, non-roaming user.
%USERPROFILE%\AppData\Local\dSPACE\<InstallationGUID>\
<ProductName>

Logical link A representation of an ECU specified in the diagnostics database.


A logical link contains information on the ECU itself, and all the information
required for accessing it, such as the diagnostic protocol used for

186
ControlDesk Introduction and Overview May 2018
M

communication between the ECU and ControlDesk. Each logical link is


represented by a unique short name in the ODX database.

Look-up table A look-up table maps one or more input values to one output
value. You have to differentiate between the following look-up table types:
§ A 1-D look-up table maps one input value to one output value.
§ A 2-D look-up table maps two input values to one output value.
§ An n-D look-up table maps multidimensional table data with 3 or more input
values to one output value.
Look-up table is a generic term for curves and maps.

Main variable A scalar variable that is visualized in an instrument that can be


used to change parameter values. In addition to the main variable, additional
write variables can also be connected to (but not visualized in) the same
instrument. When you change the value of the main variable in an instrument,
the changed value is also applied to all the additional write variables connected
to that instrument.

Map A parameter that consists of


§ A 1‑dimensional array containing the axis points for the x‑axis. This array can
also be specified by a reference to a common axis.
§ A 1‑dimensional array containing the axis points for the y‑axis. This array can
also be specified by a reference to a common axis.
§ A 2–dimensional array containing data points. The map assigns one data point
of the array to each pair of x‑axis and y‑axis points
Maps are represented by the symbol.

Map file A file that contains symbols (symbolic names) and their physical
addresses. It is generated during a build process of an ECU application.

Measurement Viewing and analyzing the time traces of variables, for


example, to observe the effects of ECU parameter changes.
ControlDesk provides various instruments for measuring variables.

Measurement (variable type) A scalar variable that can be measured,


including individual elements of a measurement array.
Measurement variables are represented by the symbol.

Measurement array A 1‑, 2‑, or 3‑dimensional array of measurement


variables. In variable lists, ControlDesk displays entries for the measurement array
itself and for each array element.
Measurement arrays are represented by the symbol.

187
May 2018 ControlDesk Introduction and Overview
Glossary

Measurement Configuration A controlbar that allows you to configure


measurement and recording.

Measurement Data API Application programming interface for accessing


measurement data. Measurement data access is possible without ControlDesk.

Measurement Data Pool A controlbar that provides access to


measurement data recorded in measurement data files.

Measurement raster Specification of how often a value of a variable is


updated during a measurement. A measurement raster is derived from a
measurement service.

Measurement service The generic term for the following services:


§ CCP service
§ DsDAQ service
§ Host service
§ XCP service

Measurement signal list A list containing the variables to be included in


subsequent measurements and recording. The list is global for all
platforms/devices of the current experiment.

Measurement variable Any variable type that can be measured but not
calibrated.

Measuring / Recording A platform/device state defined by the following


characteristics:
§ A continuous logical connection is established between ControlDesk and the
platform/device hardware or VPU.
§ Online calibration is possible. Parameter values can be changed directly on the
platform/device hardware or VPU.
§ A measurement (or recording) is currently running.
§ Platform/device configuration is not possible.
The 'measuring' / 'recording' platform/device state is indicated by the icon.

Memory page An area of a calibration memory. Each page contains a


complete set of parameters of the platform/device hardware or VPU, but only
one of the pages is “visible” to the microcontroller of the ECU, the real‑time
processor (RTP) of the platform hardware, or to the VPU at a time.
ControlDesk supports platform/device hardware with up to two memory pages.
These are usually the working page and the reference page. The parameter
values on the two memory pages usually are different. ControlDesk lets you
switch from one page to the other, so that when parameters are changed on
one page, the changes can be made available to the ECU or prototyping
hardware via a single page switch.

Note

Some platforms/devices provide only a working page. You cannot switch to


a reference page in this case.

188
ControlDesk Introduction and Overview May 2018
M

Message Viewer A controlbar displaying a history of all error and warning


messages that occur during work with ControlDesk.

MicroAutoBox platform A platform that provides access to a MicroAutoBox


connected to the host PC for function prototyping purposes such as bypassing.

Mirrored memory A memory area created by ControlDesk on the host PC


that mirrors the contents of the available memory pages of calibration and
prototyping hardware or VPUs. For hardware with two memory pages, the
mirrored memory is divided into a reference and a working page, each of them
containing a complete set of parameters. When a calibration or prototyping
platform/device is added to an experiment, ControlDesk initially fills the available
memory pages of the mirrored memory with the contents of the ECU Image
file (initial filling for calibration devices) or with the contents of the SDF file (initial
filling for platforms).
§ Mirrored memory for offline calibration
Parameter values can even be changed offline. Changes to parameter values
that are made offline affect only the mirrored memory.
§ Offline‑to‑online transition for online calibration
For online calibration, an offline-to-online transition must be performed.
During the transition, ControlDesk compares the memory pages of the
hardware or VPU of each platform/device with the corresponding pages of the
mirrored memory. If the pages differ, the user has to equalize them by
uploading them from the hardware or VPU to the host PC, or downloading
them from the host PC to the hardware or VPU.
§ Mirrored memory for online calibration
When ControlDesk is in the online mode, parameter value changes become
effective synchronously on the memory pages of the hardware or VPU and in
the mirrored memory. In other words, parameter values on the hardware or
VPU and on the host PC are always the same while you are performing online
calibration.

Modular system A dSPACE processor board and one or more I/O boards
connected to it.

Multi-capture history The storage of all the captures acquired during a


triggered measurement. The amount of stored data depends on the
measurement buffer.

Multi-pin error A feature of the SCALEXIO concept for electrical error


simulation that lets you simulate a short circuit between three or more signal
channels and/or bus channels. The channels can be located on the same or
different boards or I/O units. You can simulate a short circuit between:
§ Channels of the same signal category (e.g., four signal generation channels)
§ Channels of different signal categories (e.g., three signal generation channels
and two signal measurement channels)
§ Signal channels and bus channels (e.g., two signal generation channels, one
signal measurement channel, and one bus channel)

Multiple electrical errors A feature of the SCALEXIO concept for electrical


error simulation that lets you switch electrical errors at the same time or in
succession. For example, you can simulate an open circuit for one channel and a

189
May 2018 ControlDesk Introduction and Overview
Glossary

short circuit for another channel at the same time, without deactivating the first
error.

Multiprocessor System platform A platform that provides access to:


§ A multicore application running on a multicore DS1006 board
§ A multiprocessor application on a multiprocessor system consisting of two or
more dSPACE processor boards interconnected via Gigalink.
A multiprocessor system can be based on DS1005 processor boards, or on
DS1006 processor boards.
ControlDesk handles a multiprocessor/multicore system as a unit and uses one
system description file (SDF file) to load the applications to all the processor
boards/cores in the system.

Multistate Display An instrument for displaying the value of a variable as an


LED state and/or as a message text.

Multistate LED A value cell type of the Variable Array for displaying the
value of a variable as an LED state.

Multiswitch An instrument for changing variable values by clicking sensitive


areas in the instrument and for visualizing different states depending on the
current value of the connected variable.

Numeric Input An instrument (or a value cell type of the Variable Array) for
displaying and setting the value of the connected variable numerically.

Observing variables Reading variable values cyclically from the dSPACE real-
time hardware and displaying their current values in ControlDesk, even if no
measurement is currently running. Variable observation is performed without
using a measurement buffer, and no value history is kept.
For platforms that support variable observation, variable observation is available
for parameters and measurement variables that are visualized in single-shot
instruments (all instruments except for a plotter). If you visualize a variable in a
single‑shot instrument, the variable is not added to the measurement signal list.
Visualizing a parameter or measurement variable in a plotter automatically adds
the variable to the measurement signal list.

190
ControlDesk Introduction and Overview May 2018
O

ControlDesk starts observing variables if one of the following conditions is true:


§ Online Calibration is started for the platform.
All the parameters and measurement variables that are visualized in single‑shot
instruments are observed.
§ Measurement is started for the platform.
All the visualized parameters and measurement variables that are not activated
for measurement in the measurement signal list are observed. Data of the
activated parameters and measurement variables is acquired using
measurement rasters.

ODX database Abbreviation of Open Diagnostic Data Exchange, a


diagnostics database that is the central ECU description for working with an
ECU Diagnostics device in ControlDesk. The ODX database contains all the
information required to perform diagnostic communication between
ControlDesk and a specific ECU or set of ECUs in a vehicle network. ControlDesk
expects the database to be compliant with ASAM MCD-2 D (ODX).

Offline State in which the parameter values of hardware or a VPU in the


current experiment cannot be changed. This applies regardless of whether or not
the host PC is physically connected to the hardware.
The mirrored memory allows parameter values to be changed even offline.

Offline simulation A PC-based simulation in which the simulator is not


connected to a physical system and is thus independent of the real time.

Offline simulation application (OSA) An offline simulation application


(OSA) file is an executable file for VEOS. After the build process with a tool such
as the VEOS Player, the OSA file can be downloaded to VEOS.
An OSA can contain multiple VPUs, each of which contains either a V‑ECU or
environment VPU. Each VPU runs in a separate process of the PC's operating
system.

On/Off Button An instrument (or a value cell type of the Variable Array)
for setting the value of the connected parameter to a predefined value when the
button is pressed (On value) and released (Off value).

Online calibration started A platform/device state defined by the following


characteristics:
§ A continuous logical connection is established between ControlDesk and the
platform/device hardware or VPU.
§ Online calibration is possible. Parameter values can be changed directly on the
platform/device hardware or VPU.
§ Platform/device configuration is not possible.
Before starting online calibration, ControlDesk lets you compare the memory
pages on the platform/device hardware or VPU with the corresponding pages of
the mirrored memory. If the parameter values on the pages differ, they must
be equalized by uploading the values from the hardware or VPU to ControlDesk,
or downloading the values from ControlDesk to the hardware or VPU. However,
a page cannot be downloaded if it is read‑only.
The 'online calibration started' platform/device state is indicated by the
Symbol.

191
May 2018 ControlDesk Introduction and Overview
Glossary

Operation signal A signal which represents the result of an arithmetical


operation (such as addition or multiplication) between two other signals.

Operator mode A working mode of ControlDesk in which only a subset of


the ControlDesk functionality is provided. You can work with existing
experiments but not modify them, which protects them from unintentional
changes.

Output parameter A parameter whose memory address is used to write


the computed value of a calculated variable to.

Parameter Any variable type that can be calibrated.

Parameter (variable type) A scalar parameter, including individual


elements of a value block.
Scalar parameters are represented by the symbol.

Parameter limits Limits within which parameters can be changed.


Parameters have hard and weak limits.
§ Hard limits
Hard limits designate the value range of a parameter that you cannot cross
during calibration.
The hard limits of a parameter originate from the corresponding variable
description and cannot be edited in ControlDesk.
§ Weak limits
Weak limits designate the value range of a parameter that you should not
cross during calibration. When you cross the value range defined by the weak
limits, ControlDesk warns you.
In ControlDesk, you can edit the weak limits of a parameter within the value
range given by the parameter’s hard limits.

PHS (Peripheral High Speed) bus A dSPACE-specific bus for communication


between a processor board and the I/O boards in a modular system. It allows
direct I/O operations between the processor board (bus master) and I/O boards
(bus slaves).

PHS-bus-based system A modular dSPACE system consisting of a processor


board such as the DS1006 Processor Board and I/O boards. They communicate
with each other via the PHS (Peripheral High Speed) bus.

Pitch variable A variable connected to the pitch scale of an Artificial


Horizon.

Platform A software component representing a simulator where a simulation


application is computed in real-time (on dSPACE real-time hardware) or in non-
real-time (on VEOS).

192
ControlDesk Introduction and Overview May 2018
P

ControlDesk provides the following platforms:


§ DS1005 PPC Board platform
§ DS1006 Processor Board platform
§ DS1007 PPC Processor Board platform
§ DS1103 PPC Controller Board platform
§ DS1104 R&D Controller Board platform
§ DS1202 MicroLabBox platform
§ MicroAutoBox platform
§ Multiprocessor System platform
§ SCALEXIO platform
§ VEOS platform
§ XIL API MAPort platform
Each platform usually has a variable description that specifies its variables.

Platform trigger A trigger that is available for a platform and that is


evaluated on the related dSPACE real-time hardware or VEOS.

Platform/Device Manager A software component represented by a


controlbar. It provides functions to handle devices, platforms, and the
applications assigned to the platforms.

Plotter instrument ControlDesk offers three plotter instruments with


different main purposes:
§ The Index Plotter displays signals in relation to events.
§ The Time Plotter displays signals in relation to measurement time.
§ The XY Plotter displays signals in relation to other signals.

Port configuration To interface the failure simulation hardware, an EESPort


needs the hardware-dependent port configuration file (PORTCONFIG file). The
file's contents must fit the connected HIL simulator architecture and its failure
simulation hardware.

Postprocessing The handling of measured and recorded data by the


following actions:
§ Displaying measured or recorded data
§ Zooming into measured or recorded signals with a plotter
§ Displaying the values of measurement variables and parameters as they were
at any specific point in time

Processor board A board that computes real-time applications. It has an


operating system that controls all calculations and communication to other
boards.

Project A container for collecting and managing the information and files
required for experiment/calibration/modification tasks in a number of
experiments. A project collects the experiments and manages their common
data.

193
May 2018 ControlDesk Introduction and Overview
Glossary

Project Manager A software component represented by a controlbar. It


provides access to projects and experiments and all the files they contain.

Project root directory The directory on your file system to which


ControlDesk saves all the experiments and documents of a project. Every
project is associated with a project root directory, and several projects can use
the same project root directory. The user can group projects by specifying several
project root directories.
ControlDesk uses the Documents folder as the default project root directory
unless a different one is specified.

Properties controlbar A controlbar providing access to the properties of,


for example, platforms/devices, layouts/instruments, and measurement/recording
configurations.

Proposed calibration A calibration mode in which the parameter value


changes that the user makes do not become effective on the hardware or VPU
until they are applied. This allows several parameter changes to be written to the
hardware or VPU synchronously. Being in proposed calibration mode is like being
in the offline calibration mode temporarily.

Push Button An instrument (or a value cell type of the Variable Array) for
setting the value of the connected parameter by push buttons.

Python Editor An editor for opening and editing PY files.

Quick start measurement A type of measurement in which all the ECU


variables configured for measurement are measured and recorded, starting with
the first execution of an ECU task. ControlDesk supports quick start
measurements on ECUs with DCI‑GSI1, DCI‑GSI2, CCP, and XCP (except for XCP
on Ethernet with the TCP transmission protocol).
Quick start measurement can be used to perform cold start measurements. Cold
start means that the vehicle and/or the engine are cooled down to the
temperature of the environment and then started. One reason for performing
cold start measurements is to observe the behavior of an engine during the
warm‑up phase.

Radio Button An instrument for displaying and setting the value of the
connected parameter by radio buttons.

194
ControlDesk Introduction and Overview May 2018
R

Real-time application An application that can be executed in real time on


dSPACE real‑time hardware. A real-time application can be built from a Simulink
model containing RTI blocks, for example.

Record layout A record layout is used to specify a data type and define the
order of the data in the memory of the target system (ECU, for example). For
scalar data types, a record layout allows you to add an address mode (direct or
indirect). For structured (aggregated) data types, the record layout specifies all
the structure elements and the order they appear in.
The 'RECORD_LAYOUT' keyword in an ASAP2 file is used to specify the various
record layouts of the data types in the memory. The structural setup of the
various data types must be described in such a way that a standard application
system will be able to process all data types (reading, writing, operating point
display etc.).

Record layout component A component of a record layout. A structured


record layout consists of several components according to the ASAP2
specification. For example, the AXIS_PTS_X component specifies the x-axis
points, and the FNC_VALUES component describes the function values of a map
or a curve.

Recorder An object in the Measurement Configuration controlbar that


specifies and executes the recording of variables according to a specific
measurement configuration.

Recording Saving the time traces of variables to a file. Both measurement


variables and parameters can be recorded. Recorded data can be
postprocessed directly in ControlDesk.
A recording can be started and stopped immediately or via a trigger:
§ Immediate recording
The recording is started and stopped without delay, without having to meet a
trigger condition.
§ Triggered recording
The recording is not started or stopped until certain trigger conditions are met.
These conditions can be defined and edited in ControlDesk.

Reduction data Additional content in an MF4 file that allows for visualizing
the MF4 file data depending on the visualization resolution. Reduction data
therefore improves the performance of the visualization and postprocessing of
measurement data.

Reference data set A read-only data set assigned to the reference page of a
device that has two memory pages. There can be only one reference data set
for each device. The reference data set is read‑only.

Reference page Memory area containing the parameters of an ECU. The


reference page contains the read‑only reference data set.

Resynchronization Mechanism to periodically synchronize the drifting timers


of the platform/device hardware ControlDesk is connected to. Resynchronization
means adjustment to a common time base.

Roll variable A variable connected to the roll scale of an Artificial Horizon.

195
May 2018 ControlDesk Introduction and Overview
Glossary

Sample count trigger A trigger that specifies the number of samples in a


data capture.
A sample count trigger can be used as a stop trigger.

SCALEXIO platform A platform that provides access to a single-core,


multicore or multiprocessor SCALEXIO system connected to the host PC for HIL
simulation and function prototyping purposes.

SCALEXIO system A dSPACE hardware-in-the-loop (HIL) system consisting of


a real-time industry PC as the processing unit, I/O boards, and I/O units. They
communicate with each other via the IOCNET. The system simulates the
environment to test an ECU. It provides the sensor signals for the ECU, measures
the signals of the ECU, and provides the power (battery voltage) for the ECU and
a bus interface for restbus simulation.

SDF file The variable description file that describes the files to be loaded to
the individual processing units of a simulation platform.
It is generated automatically when the TRC file is built.

Segment The minimum part a segment signal can consist of.


There are different kinds of segments to be used in segment signals:
§ Segments to form synthetic signal shapes (sine, sawtooth, ramp, etc.)
§ Segments to perform arithmetical operations (addition, multiplication) with
other segments
§ Segments to represent numerical signal data (measured data)

Segment signal A signal consisting of one or more segments.

Selection Box An instrument for selecting a text-value entry and setting the
respective numerical value for the connected variable.

Signal
§ Representation of a variable measured in a specific measurement raster.
§ Generic term for segment signals and operation signals.
A signal is part of a signal description set which can be displayed and edited
in the working area.

Signal description set A group of one or more signals.


A signal description set and its signals can be edited in the working area by
means of the Signal Editor. Each signal description set is stored as an STZ file
either in the Signal Description Sets folder or in the Signal Generators folder.

Signal file A file that contains the wiring information of a simulator and that
is part of the standard dSPACE documentation of dSPACE Simulator Full-Size.
Normally, dSPACE generates this file when designing the simulator. Before using
a failure simulation system, users can adapt the signal file to their needs.

Signal generator An STZ file containing a signal description set and


optional information about the signal mapping, the description of variables,
and the real-time platform.

196
ControlDesk Introduction and Overview May 2018
S

The file is located in the Signal Generators folder and used to generate,
download, and control Real-Time Testing sequences, which are executed on the
real-time platform to stimulate model variables in real time.

Signal Mapping A controlbar of the Signal Editor to map model variables


from the Variable Browser to signals and variable aliases of a signal
generator.

Signal Selector A controlbar of the Signal Editor. The Signal Selector is a


graphical instrument providing signals and segments for arranging and
configuring signal description sets in the working area.

Simulation application The generic term for offline simulation application


(OSA) and real-time application.

Simulation system A description of the composition of V‑ECU models,


environment models, real ECUs, and their interconnections required for
simulating the behavior of a system. A simulation system is the basis for the
generation of a simulation application for a given simulator platform.

Simulation time group Group of platforms/devices in an experiment whose


simulation times are synchronized with each other. If resynchronization is
enabled, ControlDesk synchronizes a simulation time group as a whole, not the
single members of the group individually.

Simulator A system that imitates the characteristics or behaviors of a selected


physical or abstract system.

Single-processor system A system that is based on one dSPACE processor


or controller board.

Slave application An application assigned to the slave DSP of a controller


or I/O board. It is usually loaded and started together with the real-time
application running on the corresponding main board.

Slave DSP A DSP subsystem installed on a controller or I/O board. Its slave
application can be loaded together with the real-time application or
separately.

Slider An instrument (or a value cell type of the Variable Array for
displaying and setting the value of the connected variable by means of a slide.

Snapshot The current values of selected ECU variables captured at a specific


time and stored in a comma separated values (CSV) file.

Sound Controller An instrument for generating sounds to be played.

Standard axis An axis with data points that are deposited in the ECU
memory. Unlike a common axis, a standard axis is specified within a curve
(variable type) or map. The parameters of a standard axis can be calibrated,
which affects only the related curve or map.

Start trigger A trigger that is used, for example, to start a measurement


raster. A platform trigger can be used as a start trigger.

Static Text An instrument for displaying explanations or inscriptions on the


layout.

197
May 2018 ControlDesk Introduction and Overview
Glossary

Steering Controller An instrument for changing variable values using a


game controller device such as a joystick or a steering wheel.

Stimulation Writing signals to variables in real-time models during a


simulation run.

Stop trigger A trigger that is used, for example, to stop a measurement


raster.

String A text variable in ASCII format.


Strings are represented by the symbol.

Struct A variable with the struct data type. A struct contains a structured list
of variables that can have various data types. In ControlDesk, a struct variable
can contain either parameters and value blocks or measurement variables and
measurement arrays. ControlDesk supports nested structs, i.e., structs that
contain further structs and struct arrays as elements.
Structs are represented by the symbol.

Struct array An array of homogeneous struct variables.


Struct arrays are represented by the symbol.

STZ file A ZIP file containing signal descriptions in the STI format. The STZ file
can also contain additional MAT files to describe numerical signal data.

Sub data set A data set that does not contain the complete set of the
parameters of a platform/device.

Symbol A symbolic name of a physical address in a MAP file. A symbol can


be associated to a variable in the Variable Editor, for example, to support an
address updates.

System variable A type of variable that represents internal variables of the


device or platform hardware and that can be used as measurement signals in
ControlDesk to give feedback on the status of the related device or platform
hardware. For example, an ECU’s power supply status or the simulation state of a
dSPACE board can be visualized via system variables.

Table Editor An instrument for displaying and setting values of a connected


curve, map, value block, or axis in a 2-D, 3-D, and grid view. The Table Editor can
also display the values of a measurement array.
The Table Editor can be used for the following variable types:
§ Axis points ( )
§ Curve ( )
§ Map ( )

198
ControlDesk Introduction and Overview May 2018
U

§ Measurement array ( )
§ Value block ( )

Time Plotter A plotter instrument for displaying signals that are measured
in a time-based raster (time plots).

Topology A description of the processor boards belonging to a


multiprocessor system and their interconnections via Gigalinks. The topology also
contains information on which Gigalink port of each processor board is
connected to the Gigalink ports of other processor boards in the multiprocessor
system.
Topology information is contained in the real-time application (PPC/x86/RTA) files
of the multiprocessor system's processor boards.

TRC file A variable description file with information on the variables available
in an environment model running on a dSPACE platform.

Trigger A condition for executing an action such as starting and stopping a


measurement raster or a recorder.
The generic term for the following trigger types:
§ Duration trigger
§ Platform trigger
§ Sample count trigger

Trigger condition A formula that specifies the condition of a trigger


mathematically.

Triggered measurement The measurement of a measurement raster


started by a platform trigger. The data flow between the dSPACE real-time
hardware or VEOS and the host PC is not continuous.

Unassigned data set A data set that is assigned neither to the working page
nor to the reference page of a platform/device. An unassigned data set can be
defined as the new working or reference data set. It then replaces the
“old“ working or reference data set and is written to the corresponding memory
page, if one is available on the platform/device.

Unplugged A platform/device state defined by the following characteristics:


§ The logical connection between ControlDesk and the hardware was
interrupted, for example, because the ignition was turned off or the
ControlDesk PC and the hardware were disconnected.

199
May 2018 ControlDesk Introduction and Overview
Glossary

§ Before the state of a platform/device changes to 'unplugged', the


platform/device was in one of the following states:
§ 'Connected'
§ 'Online calibration started'
§ 'Measuring' / 'Recording'

Tip

A device for which the connection between ControlDesk and the device
hardware currently is interrupted is also set to the 'unplugged' state when
you start online calibration if both the following conditions are fulfilled:
§ The device's Start unplugged property is enabled.
§ The Start online calibration behavior property is set to 'Ignore
differences'.
This is possible for CCP and XCP devices. For details on the two properties
listed above, refer to General Settings Properties ( ControlDesk
Platform Management).

§ If the Automatic Reconnect feature is enabled for a platform/device and if the


platform/device is in the 'unplugged' state, ControlDesk periodically tries to re-
establish the logical connection for that platform/device.
§ Online calibration is impossible. Offline calibration is possible.
§ Platform/device configuration is possible.
The 'unplugged' platform/device state is indicated by the icon.

Untriggered measurement The measurement of a measurement raster


not started by a platform trigger. The data flow between the dSPACE real-time
hardware or VEOS and the host PC is continuous.

User function An external function or program that is added to the


Automation - User Functions ribbon group for quick and easy access during
work with ControlDesk.

User Functions Output A controlbar that provides access to the output of


external tools added to the Automation ribbon.

Value block A parameter that consists of a 1‑ or 2‑dimensional array of


scalar parameters.
In variable lists, ControlDesk displays entries for the value block itself and for
each array element.
Value blocks are represented by the symbol.

Value conversion The conversion of the original values of simulator or ECU


variables (source values) to the corresponding scaled values to be displayed by
the instrument (read connection) and vice versa (write connection).

200
ControlDesk Introduction and Overview May 2018
V

Variable Any parameter or measurement variable defined in a variable


description. ControlDesk provides various instruments to visualize variables.

Variable alias An alias name that lets the user control the property of a
segment by a model parameter of a real-time application.

Variable Array An instrument for calibrating parameters and displaying


measurement variable values.
The Variable Array can be used for the following variable types:
§ Measurement ( )
§ Measurement array ( )
§ String ( )
§ Struct ( )
§ Struct array ( )
§ Value ( )
§ Value block ( )

Variable Browser The Variable Browser is a controlbar that provides access


to the variables of the currently open experiment.

Variable connection The connection of a variable to an instrument. Via


the variable connection, data is exchanged between a variable and the
instrument used to measure or calibrate the variable. In other words, variable
connections are required to visualize variables in instrument.

Variable description A file describing the variables in a simulation


application, which are available for measurement, calibration, and stimulation.

Variable Editor A tool for viewing, editing, and creating variable descriptions
in the ASAM MCD-2MC (A2L) file format. The Variable Editor allows you to
create A2L files from scratch, or to import existing A2L files for modification.

Variable Filter A variable filter contains the filter configuration of a


combined filter, which is used to filter the variable list in the Variable Browser
using a combination of filter conditions.

V‑ECU Abbreviation of virtual ECU.


An executable element in a simulation system that emulates a real ECU in a
simulation scenario.
V‑ECU is also the generic term for:
§ Adaptive V‑ECU
§ Classic V‑ECU

Vehicle information The ODX database can contain information for one
or more vehicles. Vehicle information data is used for vehicle identification
purposes and for access to vehicles. It references the access paths (logical links)
to the ECUs.

VEOS A simulator which is part of the PC and allows the user to run an
offline simulation application (OSA) without relation to real time.

201
May 2018 ControlDesk Introduction and Overview
Glossary

VEOS platform A platform that configures and controls the offline


simulation application (OSA) running in VEOS and that also provides access to
the application's environment VPU.

VEOS Player An application running on the host PC for editing, configuring


and controlling an offline simulation application (OSA) running in VEOS.

Verbal conversion A conversion in which a conversion table is used to


specify the computation of numerical values into strings. The verbal conversion
table is used when you switch the value representation from source to converted
mode and vice versa.

Verbal conversion range A conversion in which a conversion table is used


to specify the computation of a range of numerical values into strings. The verbal
conversion range table is used when you switch the value representation from
source to converted mode and vice versa.

Version control A mechanism for holding a second set of files in addition to


the local working files. The two sets of files are synchronized by means of check
out and check in commands. This allows a team of people to work together on a
project and save various development stages. The team members can examine
the file history, add comments as revision descriptions, restore any previous
version of a file, etc, via the version control system's user interface.

Video Capturing device A device that provides access to video signals from
a connected camera and allows you to record video data synchronously to
signals from other platforms/devices.

Video Monitoring instrument An instrument for displaying video signals.

View set A named configuration of the controlbars of ControlDesk. A view


set has a default state and a current state that can differ from the default state.
The configuration includes the geometry, visibility, and docking or floating state
of controlbars.

Virtual validation Offline and real-time simulation scenarios that involve


virtual ECUs ( V‑ECUs).

Visualization The representation of variables in instruments:


§ Measurement variables are visualized in instruments to view and analyze
their time traces.
§ Calibration parameters are visualized in instruments to change their values.

VPU Abbreviation of virtual processing unit, and generic term for:


§ V-ECUs
§ Environment VPUs
§ Controller VPUs
§ Bus VPUs
Part of an offline simulation application in VEOS. Each VPU runs in a separate
process of the PC.

202
ControlDesk Introduction and Overview May 2018
W

Working data set The data set currently residing in the memory of a
platform/device hardware or VPU. There can be only one working data set for
each calibration platform/device. The working data set is read/write.

Working page Memory area containing the parameters of an ECU, VPU, or


prototyping hardware ( memory page). The working page contains the
read/write working data set.

Writable measurement A scalar variable that can be measured and


calibrated.

XCP Abbreviation of Universal Measurement and Calibration Protocol. A


protocol that is implemented on electronic control units (ECUs) and provides
access to ECUs with measurement and calibration systems (MCS) such as
ControlDesk. The “X“ stands for the physical layers for communication between
the ECU and the MCS, such as CAN (Controller Area Network) and Ethernet.
The basic features of XCP are:
§ Read and write access to the ECU memory, i.e., providing access for calibration
§ Synchronous data acquisition
§ Synchronous data stimulation, i.e., for bypassing
§ Flash programming for ECU development
The XCP protocol was developed by ASAM e.V. (Association for Standardisation
of Automation and Measuring Systems e.V.). For the protocol specification, refer
to http://www.asam.net.
XCP is often used together with an A2L variable description.

XCP on CAN device A device that provides access to an ECU with XCP
connected to the ControlDesk PC via CAN. Using the XCP on CAN device, you
can access the ECU for measurement and calibration purposes via XCP (Universal
Measurement and Calibration Protocol).

XCP on Ethernet device A device that provides access to an ECU or


V‑ECU with XCP connected to the ControlDesk PC via Ethernet. The XCP on
Ethernet device provides access to the ECU/V-ECU via XCP (Universal
Measurement and Calibration Protocol) for measurement and calibration
purposes.

XCP on FlexRay device A device that provides access to an ECU with XCP
connected to the ControlDesk PC via FlexRay. The XCP on FlexRay device
provides access to the ECU via XCP (Universal Measurement and Calibration
Protocol) for measurement and calibration purposes.

203
May 2018 ControlDesk Introduction and Overview
Glossary

XIL API EESPort Electrical Error Simulation port (EESPort)

XIL API MAPort platform A platform that provides access to a simulation


platform via the ASAM XIL API implementation that is installed on your host PC.

XY Plotter A plotter instrument for displaying signals as functions of other


signals.

204
ControlDesk Introduction and Overview May 2018
Index

R
B ribbons
basics basics 42
operator mode 49
operator version 49 S
ribbons 42
safety precautions 13
starting ControlDesk 30
C
Common Program Data folder 8, 174 U
CommonProgramDataFolder 8, 174
user interface of ControlDesk 33
ControlDesk
operator mode 49
Product Support Center 56 V
safety precautions 13 Variable Browser 201
customizing the screen arrangement 47 view set 47

D
demos
basics 58
overview 58
Documents folder 8, 179
DocumentsFolder 8, 179

F
functionalities
operator mode 50

I
Instrument Selector 35, 185

L
Local Program Data folder 9, 186
LocalProgramDataFolder 9, 186

M
Measurement Data Pool 40, 188
Message Viewer 189
multiconnect group 118, 157
multiconnect group support discontinued 118,
157

O
operator mode
basics 49
functionalities 50
operator version
basics 49

P
Platform/Device Manager 193
Product Support Center 56
Project Manager 194
Properties controlbar 194

205
May 2018 ControlDesk Introduction and Overview
Index

206
ControlDesk Introduction and Overview May 2018

You might also like