0% found this document useful (0 votes)
40 views802 pages

Control Desk Instrument Handling

The document provides handling instructions for the ControlDesk 2024-A software, including access information, support contact details, and recommendations for software updates. It contains extensive sections on various instrument handling features, configuration instructions, and reference information for different types of instruments. The publication is proprietary and subject to copyright restrictions, with all rights reserved by dSPACE GmbH.
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
40 views802 pages

Control Desk Instrument Handling

The document provides handling instructions for the ControlDesk 2024-A software, including access information, support contact details, and recommendations for software updates. It contains extensive sections on various instrument handling features, configuration instructions, and reference information for different types of instruments. The publication is proprietary and subject to copyright restrictions, with all rights reserved by dSPACE GmbH.
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 802

ControlDesk

Instrument Handling
For ControlDesk 2024‑A

Release 2024-A – May 2024

To access the Web version of this document, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/FNHTg
To access the Web version, you must have a mydSPACE account. For more information on the
mydSPACE registration process, refer to https://www.dspace.com/faq?097.
How to Contact dSPACE
Mail: dSPACE GmbH
Rathenaustraße 26
33102 Paderborn
Germany
Tel.: +49 5251 1638-0
E-mail: [email protected]
Web: https://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: https://www.dspace.com/go/locations
§ For countries not listed, contact dSPACE GmbH in Paderborn, Germany.
Tel.: +49 5251 1638-941 or e-mail: [email protected]

You can also use the support request form: https://www.dspace.com/go/supportrequest. If


you are logged on to mydSPACE, you are automatically identified and do not have to add
your contact details manually.

If possible, always provide the serial number of the hardware, 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 https://www.dspace.com/go/patches for the
software updates and patches themselves and for more information, such as how to
receive an automatic notification when an update or a patch is available for your dSPACE
software.

Important Notice
This publication contains proprietary information that is protected by copyright. All rights
are reserved. The publication may be printed for personal or internal use provided all the
proprietary markings are retained on all printed copies. In all other cases, the publication
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 - 2024 by:


dSPACE GmbH
Rathenaustraße 26
33102 Paderborn
Germany

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

AURELION, AUTERA, ConfigurationDesk, ControlDesk, MicroAutoBox, MicroLabBox,


SCALEXIO, SIMPHERA, 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 17

New Features 21
New Instrument Features (ControlDesk 2024‑A)............................................ 21
New Instrument Features (ControlDesk 2023‑B)............................................. 23
New Instrument Features (ControlDesk 2023‑A)............................................ 26
New Instrument Features (ControlDesk 7.6)................................................... 29
New Instrument Features (ControlDesk 7.5)................................................... 30
New Instrument Features (ControlDesk 7.3)................................................... 31
New Instrument Features (ControlDesk 7.2)................................................... 33
New Instrument Features (ControlDesk 7.1)................................................... 34

Basics and Instructions 35


Introduction to Instrument Handling....................................................................... 37
Instruments and the Variable Types they can Visualize.................................... 37
Choosing Between Time Plotter, Index Plotter, and XY Plotter........................ 40
How to Configure the Instrument Selector........................................ ............ 44
How to Define Default and Favorite Instruments............................................ 47
How to Make an Instrument Reusable........................................................... 50
How to Configure the Properties of Instruments............................................ 51

3-D Viewer Handling.............................................................................................. 54


Basics of Handling the 3-D Viewer................................................................. 55
Selecting the Coordinate System................................................................... 62
Connecting Variables to 3-D Viewer Properties.............................................. 64
Overview of Possible Variable Connections.................................................... 67
Example of Using the 3-D Viewer.................................................................. 71
How to Add an Item and Configure the Item Properties ................... ............ 79
Adding Roads via MAT File Import................................................................. 82
How to Track the Distance Between Two Items.............................................. 83
How to Work with Item Templates................................................................ 86
Basics of Group Items.................................................................................... 89
Basics of Surfaces.......................................................................................... 90
Example of Using an Instrument Script with the 3-D Viewer.......................... 91

Browser Handling................................................................................................... 97
Basics on Handling the Browser..................................................................... 97

3
May 2024 ControlDesk Instrument Handling
Contents

How to Configure the Browser...................................................................... 99


How to Visualize GNSS Positioning Data in a Map......................................... 99

Artificial Horizon Handling.................................................................................... 103


Basics of Handling the Artificial Horizon............................................ .......... 103
How to Configure the Artificial Horizon....................................................... 108

Gauge Handling................................................................................................... 110


Basics of Handling the Gauge...................................................................... 110
How to Configure the Gauge...................................................................... 112

Hierarchy Array Handling...................................................................................... 114


Basics of Handling the Hierarchy Array.............................................. .......... 114
How to Configure the Hierarchy Array......................................................... 116

Index Plotter Handling.......................................................................................... 120


Basics of Handling the Index Plotter............................................................. 120
Zooming and Moving the Chart (Index Plotter)............................................ 124
How to Configure the Index Plotter............................................................. 128
How to Display Curves with Mean, Minimum, and Maximum Values........... 130
How to Specify a Trigger for the Index Plotter Visualization.......................... 132
How to Change Trigger Settings via the Index Plotter........................ .......... 136

Invisible Switch Handling...................................................................................... 140


Basics of Handling the Invisible Switch......................................................... 140
How to Use the Invisible Switch................................................................... 141

Knob Handling..................................................................................................... 143


Basics of Handling the Knob........................................................................ 143
How to Configure the Knob........................................................................ 145
How to Change Values with the Knob......................................................... 146

Multiswitch Handling........................................................................................... 148


Basics of Handling the Multiswitch.............................................................. 148
How to Configure the Multiswitch.............................................................. 151
How to Change Values with the Multiswitch............................................... 153

On/Off Button Handling....................................................................................... 156


Basics of Handling the On/Off Button.......................................................... 156
How to Configure the On/Off Button.......................................................... 159
How to Change Values with the On/Off Button........................................... 160

Slider Handling..................................................................................................... 162


Basics of Handling the Slider............................................................. .......... 162
How to Configure the Slider........................................................................ 164
How to Change Values with the Slider.............................................. .......... 165

Sound Controller Handling................................................................................... 167


Basics on Handling the Sound Controller..................................................... 167

4
ControlDesk Instrument Handling May 2024
Contents

How to Configure the Sound Controller...................................................... 168


How to Generate a Complex Sound with the Sound Controller................... 170

Steering Controller Handling................................................................................ 175


Basics of Handling the Steering Controller................................................... 175
How to Place a Steering Controller on a Layout and Connect
Variables to it.............................................................................................. 177
How to Configure the Steering Controller................................................... 179
How to Change Values with the Steering Controller.................................... 181
How to Configure Force Feedback Effects.................................................... 182

Table Editor Handling........................................................................................... 187


Basics of Handling the Table Editor.............................................................. 188
Connecting Variables to the Table Editor...................................................... 192
How to Connect Multidimensional Table Data to the Table Editor................ 196
How to Configure the Table Editor.............................................................. 199
Basics of Changing Values in the Table Editor.............................................. 202
How to Change Function Values in the Table Editor..................................... 203
How to Change Axis Point Values in the Table Editor................................... 207
How to Insert or Delete Axis Points.............................................................. 209
How to Set Up a View of the Table Editor.................................................... 211
How to Export and Import Values................................................................ 214

Time Plotter Handling........................................................................................... 216


Basics of Handling the Time Plotter................................................... .......... 216
Zooming and Moving the Chart (Time Plotter)............................................. 224
How to Configure the Time Plotter.............................................................. 227
How to Display Curves with Mean, Minimum, and Maximum Values........... 229
How to Specify a Trigger for the Time Plotter Visualization................ .......... 232
How to Change Trigger Settings via the Time Plotter................................... 236

Variable Array Handling........................................................................................ 241


Basics of Handling the Variable Array........................................................... 241
How to Configure the Variable Array........................................................... 244
How to Change Values with the Variable Array (Alphanumeric Input
Value Cell Type)........................................................................................... 246
How to Change Values with the Variable Array (Bitfield Editor Value
Cell Type).................................................................................................... 249
How to Visualize Variable States with the Variable Array (Multistate
LED Value Cell Type).................................................................................... 251

XY Plotter Handling.............................................................................................. 253


Basics of Handling the XY Plotter...................................................... .......... 253
Zooming and Moving the Chart (XY Plotter)................................................ 257
XY Plots...................................................................................................... 259
How to Configure the XY Plotter................................................................. 260

5
May 2024 ControlDesk Instrument Handling
Contents

Reference Information 265


Instrument Descriptions........................................................................................ 266

Automotive Controls............................................................................. .......... 267


Automotive Controls Library........................................................................ 267

Avionics Instruments........................................................................................ 268


Airspeed Indicator....................................................................................... 268
Altimeter..................................................................................................... 270
Artificial Horizon......................................................................................... 272
Heading Indicator........................................................................................ 275

Browser Samples................................................................................... .......... 276


Map............................................................................................................ 277

Date and Time................................................................................................. 279


Date and Time Library................................................................................. 280

FPGA Instruments............................................................................................ 280


FPGA Scale ADC............................................................................... .......... 281
FPGA Scale DAC............................................................................... .......... 286
FPGA Scope................................................................................................ 290

Gauges Automotive......................................................................................... 295


Gauges Automotive Library......................................................................... 295

LEDs Automotive............................................................................................. 296


LEDs Automotive Library................................................................... .......... 297

Measurement.................................................................................................. 298
Measurement Library................................................................................... 298

Standard Instruments....................................................................................... 300


3-D Viewer.................................................................................................. 303
Animated Needle........................................................................................ 307
Bar.............................................................................................................. 309
Browser....................................................................................................... 312
Bus Instrument............................................................................................ 315
Check Button.............................................................................................. 319
Diagnostics Instrument................................................................................ 321
Display........................................................................................................ 324
Fault Memory Instrument............................................................................ 326
Frame............................................................................................... .......... 330
Gauge......................................................................................................... 332
Hierarchy Array........................................................................................... 336
Index Plotter................................................................................................ 341
Invisible Switch............................................................................................ 346

6
ControlDesk Instrument Handling May 2024
Contents

Knob........................................................................................................... 347
MultiState Display....................................................................................... 352
Multiswitch................................................................................................. 354
Numeric Input............................................................................................. 357
On/Off Button............................................................................................. 359
Push Button................................................................................................ 361
Radio Button............................................................................................... 363
Selection Box.................................................................................... .......... 366
Slider................................................................................................ .......... 368
Sound Controller......................................................................................... 372
Static Text......................................................................................... .......... 374
Steering Controller...................................................................................... 375
Table Editor................................................................................................. 379
Time Plotter...................................................................................... .......... 384
Variable Array................................................................................... .......... 389
XY Plotter......................................................................................... .......... 396

Stopwatches.................................................................................................... 399
Stopwatches............................................................................................... 399

Instrument-Related Properties............................................................................... 402


2-D View Properties..................................................................................... 411
3-D View Properties..................................................................................... 412
Active Property............................................................................................ 415
Additional Write Variables Properties........................................................... 415
Advanced Settings Properties (Time Plotter/Index Plotter)............................. 416
Aircraft Symbol Properties (Artificial Horizon)............................................... 417
Aircraft Symbol Properties (Heading Indicator)............................................. 418
Alignment Property..................................................................................... 419
Alignment/Text Alignment Property (Hierarchy Array)................................... 419
Alternating Row Colors Properties............................................................... 419
Angle Properties.......................................................................................... 420
Automatic Sizing Property (Bar, Gauge, Knob, Slider)................................... 421
Automatic Sizing Property (Hierarchy Array)................................................. 422
Axes and Signals Properties (Time Plotter/Index Plotter)................................ 422
Axes Properties (3-D Viewer)....................................................................... 427
Axes Properties (Table Editor)....................................................................... 429
Axis Color Property (XY Plotter)................................................................... 431
Axis Properties (XY Plotter).......................................................................... 431
Background Properties...................................................................... .......... 433
Bands Properties.......................................................................................... 433
Bands Properties (Airspeed Indicator)........................................................... 436
Bitmask Properties....................................................................................... 436
Border Properties......................................................................................... 437
Browser Properties............................................................................ .......... 438

7
May 2024 ControlDesk Instrument Handling
Contents

Button Cell Properties (Value Cell – Button)................................................. 438


Button Color Property................................................................................. 439
Button Style Property................................................................................... 440
Button Style Settings Properties (Check Button)........................................... 440
Buttons Properties....................................................................................... 441
Camera Properties....................................................................................... 442
Captions/Operating Elements Properties...................................................... 443
Cell Properties............................................................................................. 447
Cell Properties (Bus Instrument)................................................................... 448
Cell Type Property (Variable Array)............................................................... 449
Center Point X Property............................................................................... 450
Center Point Y Property............................................................................... 450
Check Box Style Property............................................................................. 451
Clip Content Property.................................................................................. 451
Color Property............................................................................................. 452
Colors Properties (Time Plotter/Index Plotter)............................................... 453
Column Header Height Property.................................................................. 453
Connection Assignment Properties.............................................................. 454
Connection Nodes Properties...................................................................... 456
Conversion Table Settings Properties (Time Plotter/Index Plotter).................. 457
Current Display Format Property.................................................................. 458
Curves Properties (XY Plotter)...................................................................... 459
Custom Header Text Property (Variable Array).............................................. 460
Custom Value Conversion Properties........................................................... 461
DAQ Properties (Time Plotter/Index Plotter).................................................. 462
Data Cursor Properties (Time Plotter/Index Plotter)....................................... 463
Data Cursor Properties (XY Plotter).............................................................. 464
Description Property.................................................................................... 465
Display Formats Properties........................................................................... 465
Display Properties........................................................................................ 467
Display Value Property................................................................................. 468
Display Variable Information Property.......................................................... 468
Distance Tracking Properties........................................................................ 469
Edit Mode Property (Animated Needle)........................................................ 470
Edit Mode Property (Invisible Switch)........................................................... 470
Edit Points Properties................................................................................... 471
File Archive Properties....................................................................... .......... 471
Focus Border Visible Property....................................................................... 472
Focus Color Property................................................................................... 472
Global Caption Enabled Property................................................................. 473
Grid Enabled Property (XY Plotter)............................................................... 473
Grid Minor Tics Property (XY Plotter)........................................................... 474
Grid Properties (Time Plotter/Index Plotter)........................................ .......... 474

8
ControlDesk Instrument Handling May 2024
Contents

Grid View Properties.................................................................................... 474


Header Property (Variable Array).................................................................. 476
Header Visible Property............................................................................... 477
Horizon View Properties.............................................................................. 477
Horizontal Hub Position Property................................................................. 478
Icon Properties............................................................................................ 479
Increments Properties.................................................................................. 479
Items and Templates Properties.................................................................... 481
Items Properties........................................................................................... 487
Label Properties (Label Cell)......................................................................... 488
Layout Settings Properties (XY Plotter)......................................................... 490
LED States Properties (Value Cell – Multistate LED)....................................... 491
Legend Properties (Time Plotter/Index Plotter).............................................. 492
Logical Links Properties................................................................................ 493
Lubber Line Properties................................................................................. 494
Magnifier Properties.................................................................................... 494
Map Properties............................................................................................ 495
Mark Properties........................................................................................... 497
Min/Max Property........................................................................................ 497
MultiState Display Properties....................................................................... 498
Multistate LED Properties............................................................................. 500
Multiswitch Properties................................................................................. 500
Name Property............................................................................................ 503
Needle Properties (Animated Needle)........................................................... 503
Needle Properties (Gauge)........................................................................... 504
Numeric Display Properties.......................................................................... 505
Numeric Input Properties............................................................................. 505
Off-Value Property....................................................................................... 505
On-Value Property....................................................................................... 506
Orientation Property.................................................................................... 506
Origin Property............................................................................................ 507
Output Properties........................................................................................ 507
Overflow Warning Property......................................................................... 508
Overlay Elements Properties (Time Plotter/Index Plotter)............................... 508
Overlay Picture Properties............................................................................ 512
Picture Properties.............................................................................. .......... 512
Pitch Scale Properties................................................................................... 513
Quick Sort Property..................................................................................... 514
Radio Button Style Property......................................................................... 515
Radius Property........................................................................................... 515
Range Check Properties............................................................................... 516
Range Properties......................................................................................... 517
Range Properties (Animated Needle)............................................................ 517

9
May 2024 ControlDesk Instrument Handling
Contents

Regions Properties....................................................................................... 518


Roll Scale Properties.................................................................................... 518
Row Header Width Property........................................................................ 520
Rows Properties........................................................................................... 520
Rows Properties (Hierarchy Array)................................................................ 521
Scale Properties........................................................................................... 522
Scale Properties (Avionics)................................................................. .......... 525
Scale Range Properties (Value Cell – Bar/Slider)............................................ 526
Script Property............................................................................................. 527
Scroll Bar Properties (Time Plotter/Index Plotter)........................................... 527
Segmented Property.................................................................................... 528
Selected Cells Properties (Variable Array - Value Cell)................................... 529
Selected Column Properties......................................................................... 529
Selected Element(s) Property........................................................................ 530
Selected Variables Property.......................................................................... 531
Selection Border Style Property.................................................................... 531
Selection Box Cell Properties........................................................................ 531
Selection Box Properties.............................................................................. 532
Separator Color Property............................................................................. 533
Size and Position Properties (Instrument)........................................... .......... 533
Size and Position Properties (Scale and Magnifier)........................................ 534
Slide Properties............................................................................................ 535
Slidebar Properties....................................................................................... 535
Sound Controller Properties......................................................................... 537
States Properties.......................................................................................... 540
Static Text Properties................................................................................... 543
Steering Controller Properties...................................................................... 543
Switch Mode Property................................................................................. 548
Tab Bar Properties........................................................................................ 549
Tab Pages Properties (Bus Instrument).......................................................... 549
Tab Properties (Table Editor)......................................................................... 550
Tabbed Pages Properties (Table Editor)......................................................... 551
Tabs Properties (Hierarchy Array).................................................................. 552
Text / Numeric Output Font Properties......................................................... 553
Text Alignment Property.............................................................................. 554
Text Color Property...................................................................................... 554
Text Font Property....................................................................................... 555
Text Properties (Numeric Input).................................................................... 555
Text Property (Check Button)....................................................................... 556
Text Property (Hierarchy Array)..................................................................... 556
Time Cursor Properties................................................................................ 558
Title Properties............................................................................................ 559
Toolbar Properties (Time Plotter/Index Plotter).............................................. 559

10
ControlDesk Instrument Handling May 2024
Contents

Tooltip Property........................................................................................... 560


Tree View Properties.................................................................................... 560
Use Custom Colors Property........................................................................ 561
Use Custom Fonts Property......................................................................... 562
Use Custom Header Settings Property............................................... .......... 562
Variables Properties..................................................................................... 562
Variables Properties (Z-Axis)......................................................................... 565
Vertical Hub Position Property...................................................................... 566
View Properties (Time Plotter/Index Plotter)....................................... .......... 566
Walls Properties........................................................................................... 568
Width Property (Hierarchy Array)................................................................. 568
Word Wrap Property................................................................................... 568
Working Point Properties............................................................................. 569
Working Points Properties (Multiple Working Points)......................... .......... 569

Instrument-Related Commands............................................................................ 571


2-D View..................................................................................................... 582
3-D View..................................................................................................... 584
Add Category................................................................................... .......... 585
Add to Favorites.......................................................................................... 585
Adjust Value(s)............................................................................................ 586
Always Show List.............................................................................. .......... 589
Append Variable............................................................................... .......... 589
Assign Properties......................................................................................... 590
Assign Recent Value.................................................................................... 591
Assign Reference Value(s)............................................................................ 591
Available Raster (XY Plotter).............................................................. .......... 592
Best Fit........................................................................................................ 593
Best Fit (All Columns).................................................................................. 593
Bin (Source)................................................................................................. 594
Bitmask....................................................................................................... 595
Bottom............................................................................................. .......... 596
Cancel (Diagnostics Instrument)........................................................ .......... 596
Cell - Change To............................................................................... .......... 597
Cell - Delete................................................................................................ 598
Cell Properties............................................................................................. 598
Change Icon..................................................................................... .......... 599
Change To/Variables - Change To................................................................ 600
Clear All DTCs............................................................................................. 601
Clear Display............................................................................................... 601
Clear Selected DTC........................................................................... .......... 602
Clear Sorting............................................................................................... 603
Code Editor Dialog...................................................................................... 604
Collapse All................................................................................................. 606

11
May 2024 ControlDesk Instrument Handling
Contents

Collapse Subordinate Rows......................................................................... 606


Column Chooser (Time Plotter/Index Plotter)............................................... 607
Columns - Customize.................................................................................. 609
Columns - Delete........................................................................................ 611
Columns - Insert ......................................................................................... 611
Columns (Diagnostics Instrument)............................................................... 613
Columns (Fault Memory Instrument)............................................................ 614
Compu Tab Items Sorted............................................................................. 616
Configure Connection Assignment.............................................................. 617
Connect as Additional Write Variable(s)....................................................... 618
Connect as Main Variable / Connect Variable(s)........................................... 619
Connect as Pitch......................................................................................... 620
Connect as Roll........................................................................................... 620
Connect to New Instrument........................................................................ 621
Copy (Diagnostics Instrument)..................................................................... 622
Copy (Fault Memory Instrument)................................................................. 624
Copy (Instrument)....................................................................................... 626
Copy / Variables - Copy............................................................................... 626
Copy Here................................................................................................... 627
Copy Here Without Connections................................................................. 628
Copy Value (Instruments).................................................................. .......... 629
Copy Value(s).............................................................................................. 630
Create XML Configuration.......................................................................... 630
Cut (Instrument).......................................................................................... 633
DAQ - Available Raster (Time Plotter/Index Plotter)....................................... 633
DAQ – Leading Raster (Time Plotter/Index Plotter)........................................ 634
DAQ – Mode (Time Plotter/Index Plotter)..................................................... 635
DAQ - Trigger (Time Plotter/Index Plotter).................................................... 637
Dec (Source)................................................................................................ 638
Delete (Instrument)........................................................................... .......... 639
Delete (Y-Axis Time Plotter/Index Plotter)..................................................... 639
Delete Active Tab.............................................................................. .......... 640
Delete Axis Point(s)...................................................................................... 641
Delete Curve (XY Plotter)............................................................................. 642
Delete Disconnected Tabs............................................................................ 643
Delete Signal (Time Plotter/Index Plotter)..................................................... 644
Display Format Page.................................................................................... 645
Display Formats........................................................................................... 647
Display Output – Clear Output on Execution................................................ 647
Display Output – Display Results Only.......................................................... 648
Display Values............................................................................................. 648
Edit Bookmarks........................................................................................... 649
Enable Move Mode (XY Plotter)................................................................... 650

12
ControlDesk Instrument Handling May 2024
Contents

Execute / Execute Cyclically (Diagnostics Instrument).................................... 651


Expand All................................................................................................... 652
Expand Subordinate Rows........................................................................... 652
Export (Instrument Selector)........................................................................ 653
Export Value(s)............................................................................................ 653
Filter Editor....................................................................................... .......... 654
Find Bookmarks................................................................................ .......... 655
Grid View.................................................................................................... 656
Group by This Column................................................................................ 656
Hex (Source)................................................................................................ 657
Hide Auto Filter Row................................................................................... 658
Hide Expand Button.................................................................................... 658
Hide Group By Box...................................................................................... 659
Hide Search Panel........................................................................................ 660
Import (Instrument Selector)........................................................................ 660
Import Library................................................................................... .......... 661
Import Value(s)............................................................................................ 661
Increments.................................................................................................. 662
Indicators - Reset Max................................................................................. 663
Indicators - Reset Min.................................................................................. 664
Insert Axis Point(s)....................................................................................... 664
Insert Before................................................................................................ 665
Instrument Properties.................................................................................. 666
Instrument Script......................................................................................... 667
Instrument Selector..................................................................................... 668
Instruments Page.............................................................................. .......... 672
Items........................................................................................................... 674
Label........................................................................................................... 674
Left............................................................................................................. 675
Line Style (Time Plotter/Index Plotter)........................................................... 676
Line Style (XY Plotter).................................................................................. 676
Lock Update................................................................................................ 677
Maximize Column Width............................................................................. 678
Move Here.................................................................................................. 679
Navigation – Enable/Disable Move Mode (Time Plotter/Index Plotter)........... 679
Navigation – Move Mode (Time Plotter/Index Plotter)........................ .......... 680
Navigation – Rescale (Time Plotter/Index Plotter).......................................... 681
Navigation – Zoom Mode (Time Plotter/Index Plotter).................................. 681
On/Off Values / On Value............................................................................. 682
Optimize..................................................................................................... 683
Overlay Element - Delete............................................................................. 684
Overlay Element - Move Down.................................................................... 684
Overlay Element - Move to Bottom.............................................................. 685

13
May 2024 ControlDesk Instrument Handling
Contents

Overlay Element - Move to Top.................................................................... 686


Overlay Element - Move Up......................................................................... 687
Parameter – Assign Default Value(s) to Selected Service............................... 688
Paste Value(s).............................................................................................. 688
Physical (Converted).................................................................................... 689
Point Style (Time Plotter/Index Plotter)......................................................... 690
Point Style (XY Plotter)...................................................................... .......... 691
Preview Signal Visible.................................................................................. 692
Remove (Instrument Selector)...................................................................... 692
Remove This Column........................................................................ .......... 693
Rename (Custom Instrument)...................................................................... 694
Replace Variable.......................................................................................... 695
Rescale........................................................................................................ 696
Rescale Data Axis........................................................................................ 696
Resize to Image........................................................................................... 697
Right........................................................................................................... 698
Row - Cells.................................................................................................. 698
Row - Delete............................................................................................... 699
Row - Highlighted - Color................................................................. .......... 700
Row - Highlighted - Enabled........................................................................ 700
Save Displayed Data as New Measurement.................................................. 701
Save to File.................................................................................................. 702
Scale Range...................................................................................... .......... 703
Scaling Mode.............................................................................................. 703
Select in Bus Navigator................................................................................ 705
Select in Instrument Navigator..................................................................... 705
Set as Default for........................................................................................ 706
Show Auto Filter Row....................................................................... .......... 707
Show Bookmarks........................................................................................ 708
Show Column Headers (Time Plotter/Index Plotter)...................................... 709
Show Current/Reference................................................................... .......... 710
Show Expand Button................................................................................... 711
Show Find Panel.......................................................................................... 711
Show Group By Panel.................................................................................. 712
Show Legend.............................................................................................. 713
Show Libraries............................................................................................. 714
Show Scroll Bar (Time Plotter/Index Plotter)....................................... .......... 715
Show Toolbar.............................................................................................. 715
Sort Ascending............................................................................................ 718
Sort Descending.......................................................................................... 719
Sort Items......................................................................................... .......... 720
Switch to Move Mode / Switch to Zoom Mode (XY Plotter)......................... 721
Switch Variable (XY Plotter)......................................................................... 721

14
ControlDesk Instrument Handling May 2024
Contents

Tic Format................................................................................................... 722


Toggle Bits........................................................................................ .......... 723
Top................................................................................................... .......... 724
Tree Mode - Hierarchical View..................................................................... 725
Ungroup..................................................................................................... 725
Update All LLs............................................................................................. 726
Update Selected LLs.................................................................................... 727
Variable - Converted (Plotter Instruments).................................................... 728
Variable - Delete Variable (Time Plotter/Index Plotter)................................... 729
Variable - Source (Time Plotter/Index Plotter)..................................... .......... 729
Variable(s) - Add.......................................................................................... 730
Variable(s) - Select in Variables/Mappings Pane............................................ 731
Variable(s) Properties................................................................................... 732
Variables – Copy to Instrument.................................................................... 733
Variables - Cut.................................................................................. .......... 733
Variables - Delete........................................................................................ 734
Variables - Paste/Paste Variables................................................................... 735
Y-Axes View – Horizontal Stacked..................................................... .......... 735
Y-Axes View – Rescale All Axes.................................................................... 736
Y-Axes View – Settings................................................................................ 737
Y-Axes View – Vertical Fixed........................................................................ 738
Y-Axes View – Vertical Scroll........................................................................ 738

Automation 741
Programming ControlDesk Automation................................................................ 742
Automating Visualization of Variables on Layouts........................................ 742
Automating Parameter Calibration.............................................................. 751

Layout and Instrument Handling........................................................................... 754


Layout- and Instrument-Related Interfaces................................................... 754

Troubleshooting 757
Repairing Variable Connections................................................................... 757
Time Plotter: No Display of Recorded Data Based on Triggered
Measurement with Sample Count Set to '1'................................................ 758

Limitations 761
Limitations for Instrument Handling............................................................. 761

15
May 2024 ControlDesk Instrument Handling
Contents

Glossary 763

Index 801

16
ControlDesk Instrument Handling May 2024
About This Document

About This Document

Content This document introduces you to ControlDesk's instrument handling.

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.
Follows 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.

17
May 2024 ControlDesk Instrument Handling
About This Document

Special Windows folders Windows‑based software products use the following special folders:

Common Program Data folder A standard folder for application-specific


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

Tip

The Common Program Data folder is available


via the CommonApplicationSettingsPath property of
the ApplicationEnvironment / IAeApplicationEnvironment
<<Interface>> interface.

Documents folder A standard folder for application‑specific files that are


used by the current user.
%USERPROFILE%\Documents\dSPACE\<ProductName>\<VersionNumber>

Tip

The Documents folder is available via the UserWorkFolder property


of the ApplicationEnvironment / IAeApplicationEnvironment
<<Interface>> interface.

Local Program Data folder A standard folder for application-specific


program data that is used by the current user.
%USERPROFILE%\AppData\Local\dSPACE\<InstallationGUID>\
<ProductName>

Tip

The Local Program Data folder is available


via the ApplicationSettingsPath property of
the ApplicationEnvironment / IAeApplicationEnvironment
<<Interface>> interface.

Accessing dSPACE Help and After you install and decrypt Windows‑based dSPACE software, the
PDF files documentation for the installed products is available in dSPACE Help and as PDF
files.

dSPACE Help (local) You can open your local installation of dSPACE Help:
§ On its home page via Windows Start Menu
§ On specific content using context-sensitive help via F1

PDF files You can access PDF files via the icon in dSPACE Help. The PDF
opens on the first page.

18
ControlDesk Instrument Handling May 2024
About This Document

dSPACE Help (Web) Independently of the software installation, you can


access the Web version of dSPACE Help at https://www.dspace.com/go/help.
To access the Web version, you must have a mydSPACE account.
For more information on the mydSPACE registration process, refer to
https://www.dspace.com/faq?097.

19
May 2024 ControlDesk Instrument Handling
About This Document

20
ControlDesk Instrument Handling May 2024
New Features

New Features

Where to go from here Information in this section

New Instrument Features (ControlDesk 2024‑A)...................................... 21


Provides an overview of the new instrument features in
ControlDesk 2024‑A.

New Instrument Features (ControlDesk 2023‑B)....................................... 23


Provides an overview of the new instrument features in
ControlDesk 2023‑B.

New Instrument Features (ControlDesk 2023‑A)...................................... 26


Provides an overview of the new instrument features in
ControlDesk 2023‑A.

New Instrument Features (ControlDesk 7.6)............................................. 29


Provides an overview of the new instrument features in ControlDesk 7.6.

New Instrument Features (ControlDesk 7.5)............................................. 30


Provides an overview of the new instrument features in ControlDesk 7.5.

New Instrument Features (ControlDesk 7.3)............................................. 31


Provides an overview of the new instrument features in ControlDesk 7.3.

New Instrument Features (ControlDesk 7.2)............................................. 33


Provides an overview of the new instrument features in ControlDesk 7.2.

New Instrument Features (ControlDesk 7.1)............................................. 34


Provides an overview of the new instrument features in ControlDesk 7.1.

New Instrument Features (ControlDesk 2024‑A)

Searching for instrument ControlDesk now lets you search for instrument connections so you can quickly
connections find the instruments to which a variable is connected. All open layouts are
searched.

21
May 2024 ControlDesk Instrument Handling
New Features

ControlDesk searches for the following names:


§ Layout names
§ Instrument names
§ The names of connected framework labels or variables (depending on the
connection type)

You can search for instrument connections via the search field introduced with
ControlDesk 2023‑B.

See the following illustration:

For an animated graphic, refer to dSPACE Help.

Tip

You can now also access the search via automation. Refer to Automating
central search (ControlDesk Automation ).

Refer to Search (ControlDesk User Interface Handling ).

Multistate Display, Variable ControlDesk now lets you enable LED blinking for the following instruments:
Array, Hierarchy Array: § Hierarchy Array (multistate LED cell type)
Blinking LEDs
§ Multistate Display
§ Variable Array (multistate LED cell type)

LED blinking allows you, for example, to draw the user's attention to the
instrument when a certain state of the connected variable is reached.

You can enable blinking and specify the blinking color and interval for each
LED state individually.

You can enable and configure LED blinking via the graphical user interface or via
the automation interface:
§ To enable and configure LED blinking via the graphical user interface, refer to
States Properties on page 540 (Multistate Display) and LED States Properties
(Value Cell – Multistate LED) on page 491 (Variable Array, Hierarchy Array).

22
ControlDesk Instrument Handling May 2024
New Instrument Features (ControlDesk 2023-B)

§ The following Python code shows you how to enable and configure
LED blinking for one of the states of a Multistate Display via automation as
an example:
MultiStateDisplay = Application.LayoutManagement.Layouts["Layout1"].Instruments["MultiState Display_484"]
MultiStateDisplay.States[0].Led.BlinkingEnabled = True
MultiStateDisplay.States[0].Led.BlinkingInterval = 250

Refer to Led / IViLed <<Interface>> (ControlDesk Automation )


(Multistate Display) and LedState / IViLedState <<Interface>>
(ControlDesk Automation ) (Variable Array), and HierarchyArrayLedState /
IViHierarchyArrayLedState <<Interface>> (ControlDesk Automation ).

Variable Array: Moving rows ControlDesk now lets you move rows of a Variable Array via drag & drop.
via drag & drop You can select one or more rows and drop them to any position of the same or
another Variable Array.

Refer to the following illustration:

New Instrument Features (ControlDesk 2023‑B)

Time Plotter, Index Plotter: ControlDesk now lets you display signal names in the Time Plotter and Index
Displaying signal names in the Plotter legends.
legend
Time Plotter: Displaying Signal Names in the Legend

This video shows you how to display signal names in the Time Plotter
legend. The
procedure for the Index Plotter is the same.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/3RH93

Refer to Column Chooser (Time Plotter/Index Plotter) on page 607.

23
May 2024 ControlDesk Instrument Handling
New Features

Time Plotter: Showing the ControlDesk now lets you show the name of the connected variable in the time
connection name in time and and data cursor tooltips of the Time Plotter .
data cursor tooltips
Time Plotter: Showing the Connection Name in Time and Data Cursor
Tooltips

This video shows you how to enable the display of the connection name in
the time and data cursor tooltips of the Time Plotter.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/459cw

Refer to Time Cursor Properties on page 558 and Data Cursor Properties (Time
Plotter/Index Plotter) on page 463.

Variable Array: Specifying ControlDesk now lets you specify custom text for the header of Variable
custom header text Arrays . This is useful, for example, to split a group of variables across multiple
Variable Arrays and use the group name for all the instruments.

Variable Array: Specifying Custom Header Text

This video shows you how to specify custom header text for the Variable
Array via the Properties pane and via the IViVariableArrayInstrument
automation interface.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/biMMs

Refer to Custom Header Text Property (Variable Array) on page 460


and VariableArrayInstrument / IViVariableArrayInstrument <<Interface>>
(ControlDesk Automation ).

Sound Controller: MP3 file The ControlDesk Sound Controller now also supports MP3 sound files.
support
Refer to Sound Controller Properties on page 537 and SoundController /
IViSoundController <<Interface>> (ControlDesk Automation ).

24
ControlDesk Instrument Handling May 2024
New Instrument Features (ControlDesk 2023-B)

Hierarchy Array: Usability The Hierarchy Array was improved.


improvements
Customizing the font of tab header text You can now customize the font
of the text in the tab header. You can customize the font separately for the
headers of the active and inactive tabs.
The following illustration shows a Hierarchy Array with two tabs. The header text
font of the currently active tab is customized.

Refer to Tabs Properties (Hierarchy Array) on page 552.

Expanding/collapsing subordinate rows You can now expand/collapse all


the subordinate rows of a specific header row.
The following illustration shows the related commands in the instrument context
menu. For an animated graphic, refer to dSPACE Help.

Moving the instrument by dragging the tab header You can now move
the Hierarchy Array by dragging the tab header.

25
May 2024 ControlDesk Instrument Handling
New Features

For an animated graphic, refer to dSPACE Help.

Date and Time instrument The ControlDesk Instrument Selector now provides the Date and
category Time category with preconfigured instruments that let you display the host PC
system time and/or date on a layout in different formats.

The following illustration shows the instrument category:

The following illustration shows the Date DD.MM.YYYY HH:MM:SS instrument


as an example:

Refer to Date and Time Library on page 280.

New Instrument Features (ControlDesk 2023‑A)

Hierarchy Array The Hierarchy Array was improved.


improvements
Automatic width and height sizing of instrument cells The Hierarchy
Array now lets you enable automatic sizing of instrument cells. If enabled,

26
ControlDesk Instrument Handling May 2024
New Instrument Features (ControlDesk 2023-A)

the width and height of the cells are automatically adjusted according to their
content.
ControlDesk disables automatic sizing for the instrument if the size of any
cell or the tab bar is modified manually, via tool automation, or via the
Properties pane.
For more information, refer to Automatic Sizing Property (Hierarchy Array) on
page 422.

Resizing columns manually You can now resize the width of columns of the
Hierarchy Array.
When you double‑click a column separator in the instrument, ControlDesk
resizes the width of the column to the left of the separator according to its
content.
The following illustrations show an example:
§ Column sizes before double‑clicking the separator:

§ Column sizes after double‑clicking the separator:

Multistate LED: Specifying alignment You can now specify the alignment
of the cell content for the Multistate LED cell type:
The following illustration shows the available settings:

For more information, refer to Alignment/Text Alignment Property (Hierarchy


Array) on page 419.

Selection box: Specifying ranges For the Selection box cell type, you can
now enable the use of value ranges. If enabled, the selection box cell displays the
item that corresponds to the value of the connected variable with regard to the
specified value ranges.

27
May 2024 ControlDesk Instrument Handling
New Features

For more information, refer to Items Properties on page 487.

Expanding/collapsing header row structures You can now expand/collapse


header row structures.
The following illustration shows the related commands in the instrument context
menu.

New FPGA Scale instruments ControlDesk now provides the new FPGA Scale ADC and FPGA Scale DAC
instruments. They allow you to incorporate the FPGA test access and scaling
functionality into a ControlDesk experiment.

By setting scaling parameters and replacement values, you can test and debug
an FPGA application from within the ControlDesk environment.

28
ControlDesk Instrument Handling May 2024
New Instrument Features (ControlDesk 7.6)

The following illustration shows the new FPGA Scale instruments:

For further information, refer to FPGA Scale ADC on page 281 and FPGA Scale
DAC on page 286.

Improved access to property Access to important instrument property dialogs was improved. You can access
dialogs the dialogs via the instrument context menu.

The following illustration shows the new access to the Rows dialog of the
Variable Array as an example.

New Instrument Features (ControlDesk 7.6)

Hierarchy Array: Specifying You can now specify the alignment of text in selected cells of the Hierarchy
text alignment Array introduced with ControlDesk 7.5.

29
May 2024 ControlDesk Instrument Handling
New Features

The following illustration shows the available alignment settings:

For more information on the instrument, refer to Basics of Handling the


Hierarchy Array on page 114.

Variable Array: Specifying text You can now select a rule for abbreviating text if it is too long to be displayed
abbreviation in the cell of a Variable Array . This replaces the options of the Variable
Abbreviation Rules page, which is no longer available.

The following illustration shows the available rules:

For more information, refer to Selected Column Properties on page 529.

New Instrument Features (ControlDesk 7.5)

New Hierarchy Array The new Hierarchy Array lets you calibrate scalar parameters and display scalar
measurement variable values. In the instrument, you can group the variable
display freely on different hierarchy levels. You can select different instrument
types to visualize the individual variables, such as the Alphanumeric Input, Slider,
or the Display.

30
ControlDesk Instrument Handling May 2024
New Instrument Features (ControlDesk 7.3)

The following illustration shows an example:


Tab bar

Header row
Row

Column Cell

For more information, refer to Basics of Handling the Hierarchy Array on


page 114.

Related topics Basics

Basics of Handling the Hierarchy Array.................................................................................... 114

New Instrument Features (ControlDesk 7.3)

3-D Viewer: Selecting the The ControlDesk 3-D Viewer now also supports the right-handed coordinate
coordinate system system. This system complies with the automotive coordinate system according
to the DIN 70000 standard.

For more information, refer to Selecting the Coordinate System on page 62.

3-D Viewer: Importing The automation interface of the 3-D Viewer now lets you import road networks
MAT files for roads from MAT files created with the ModelDesk Road Generator. The elements of the
road network are imported to point lines of the 3-D Viewer.

31
May 2024 ControlDesk Instrument Handling
New Features

The following illustration shows an example:

For more information, refer to Adding Roads via MAT File Import on page 82.

3-D Viewer: Dynamic item You can now connect a variable to the text label of an item in the 3-D Viewer.
labeling This allows you to display the current value of the variable, for example.

For more information, refer to Items and Templates Properties on page 481.

3-D Viewer: Rotating the If you specified a camera target, for example, the blue car in the illustration
camera via mouse if a camera below, you can now use the mouse to rotate the view:
target is selected
Hold the left mouse button and move the pointer. You can also use the mouse
wheel to zoom the view.

For more information, refer to Basics of Handling the 3-D Viewer on page 55.

32
ControlDesk Instrument Handling May 2024
New Instrument Features (ControlDesk 7.2)

New Instrument Features (ControlDesk 7.2)

Display, Numeric Input, The following ControlDesk instruments now support 64‑bit integer variables
Variable Array: Support of (int64 and uint64) in source mode:
64‑bit integer variables § Display (read)
§ Numeric Input (read and write)
§ Variable Array (read and write)

3-D Viewer: Displaying The 3-D Viewer introduced with ControlDesk 7.1 has been improved: You can
surfaces now display shapes in the 3-D Viewer by using the new surface item type. This
lets you display a road surface or the height profile of a landscape, for example.

You can also display the values of one or more variables as a three-dimensional
chart, as shown in the following illustration:

10 FunctionValues.Value =
[[1,1,1],[2,2,2],[2,6,6],[2,4,5]]
30

20 ZAxis.Value = [5,10,15]

0 10

0
30

20

10
XAxis.Value = [5,10,15,20]

For more information, refer to Basics of Surfaces on page 90.

3-D Viewer: Specifying the You can now specify the pattern of point lines in the 3-D Viewer. This lets you
pattern of point lines create a more realistic visualization of road markings, for example.

33
May 2024 ControlDesk Instrument Handling
New Features

The following illustration shows some point lines with different pattern styles as
an example.

For more information, refer to Items and Templates Properties on page 481.

New Instrument Features (ControlDesk 7.1)

New 3-D Viewer The new 3-D Viewer lets you display items in a 3-D environment. You can
display stationary items or connect the properties of items to variables to
visualize changing item properties.

The following illustration shows the 3-D Viewer. It displays a simplified race track
scenario with an ego‑vehicle (blue) and other vehicles inside (red) and outside
(green) the fixed range of an ego‑vehicle sensor.

§ For a demo introducing the 3-D Viewer, refer to Instrumentation Demo


(ControlDesk Introduction and Overview ).
§ For more information, refer to Basics of Handling the 3-D Viewer on page 55.

34
ControlDesk Instrument Handling May 2024
Basics and Instructions

Basics and Instructions

Where to go from here Information in this section

Introduction to Instrument Handling........................................................ 37

3-D Viewer Handling............................................................................... 54


The 3-D Viewer lets you display items in a 3-D environment.

Browser Handling.................................................................................... 97
The Browser lets you display HTML, TXT, and PDF files.

Artificial Horizon Handling..................................................................... 103


The Artificial Horizon lets you display the values of the scalar variables for
roll and pitch.

Gauge Handling.................................................................................... 110


The Gauge lets you display the values of scalar variables.

Hierarchy Array Handling....................................................................... 114


The Hierarchy Array lets you display variables and icons grouped into
custom hierarchy levels using different cell types for visualization.

Index Plotter Handling........................................................................... 120


The Index Plotter lets you display the values of measurement variables in
relation to corresponding event numbers (index plots).

Invisible Switch Handling....................................................................... 140


The Invisible Switch lets you calibrate the values of scalar parameters.

Knob Handling...................................................................................... 143


The Knob lets you calibrate the values of scalar parameters.

Multiswitch Handling............................................................................. 148


The Multiswitch lets you calibrate the values of scalar parameters using
mouse-sensitive areas.

On/Off Button Handling........................................................................ 156


The On/Off Button lets you calibrate the values of scalar parameters.

Slider Handling...................................................................................... 162


The Slider lets you calibrate the values of scalar parameters.

35
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Sound Controller Handling.................................................................... 167


The Sound Controller lets you generate simple and complex sounds.

Steering Controller Handling................................................................. 175


The Steering Controller lets you calibrate the values of scalar parameters
using a game controller device, such as a joystick or a steering wheel.

Table Editor Handling............................................................................. 187


The Table Editor lets you calibrate complex values, such as maps, curves,
value blocks, and points of an axis. It can also be used to display the
values of a measurement array.

Time Plotter Handling............................................................................ 216


The Time Plotter lets you display signals that are measured in a time-
based raster.

Variable Array Handling......................................................................... 241


The Variable Array lets you calibrate and measure the values of scalar
parameters.

XY Plotter Handling............................................................................... 253


The XY Plotter lets you display signals as functions of other signals.

36
ControlDesk Instrument Handling May 2024
Introduction to Instrument Handling

Introduction to Instrument Handling


Where to go from here Information in this section

Instruments and the Variable Types they can Visualize.............................. 37


Instruments usually can visualize more than one variable type. A table
lists all the ControlDesk instruments, and shows which variable type an
instrument can visualize.

Choosing Between Time Plotter, Index Plotter, and XY Plotter.................. 40


ControlDesk offers three plotters types with different main purposes.
Knowing the differences helps you to select the appropriate type.

How to Configure the Instrument Selector............................................... 44


To customize the selection of instruments, you can configure the
Instrument Selector.

How to Define Default and Favorite Instruments...................................... 47


You can specify a default instrument for a certain variable type
and define favorite instruments for quick access to frequently used
instruments.

How to Make an Instrument Reusable..................................................... 50


To reuse instrument settings, you can define custom instruments.

How to Configure the Properties of Instruments...................................... 51


You can configure not only the properties of an individual instrument,
but also the common properties of multiple instruments simultaneously.

Instruments and the Variable Types they can Visualize

Introduction The table below lists all the ControlDesk instruments, and shows which variable
type an instrument can visualize.

Instrument Variable Types


1)

2)

3)

4) 5) 6) 7) 8) 9) 10) 11)

3-D Viewer12) ✓ ✓ ✓ – – – ✓ ✓ ✓ – –
Airspeed Indicator ✓ – ✓ – – – – – ✓ – –
Altimeter ✓ – ✓ – – – – – ✓ – –
Animated Needle ✓ – ✓ – – – – – ✓ – –
Artificial Horizon ✓ – ✓ – – – – – ✓ – –
Bar ✓ – ✓ – – – – – ✓ – –
Check Button ✓ – ✓ – – – – – ✓ – –
Diagnostics Instrument – – – – – – – – – – –
Display ✓ – ✓ – – – – ✓ ✓ – –

37
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Instrument Variable Types

1)

2)

3)
4) 5) 6) 7) 8) 9) 10) 11)

Fault Memory Instrument – – – – – – – – – – –


Frame ✓ – ✓ – – – – ✓ ✓ – –
Gauge ✓ – ✓ – – – – – ✓ – –
Heading Indicator ✓ – ✓ – – – – – ✓ – –
Hierarchy Array ✓ – ✓ – – – – ✓ ✓ – –
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 (single connection) – ✓ – ✓ ✓ ✓ ✓ – – – –
Table Editor (multiple connections) ✓ ✓ ✓ ✓ – – ✓ – ✓ – –
Time Plotter ✓ – ✓ – – – – – ✓ – –
Variable Array ✓ ✓ ✓ – – – ✓ ✓ ✓ (✓)13) (✓)13)
XY Plotter ✓ ✓14) ✓ – – – – – ✓ – –
1) Measurement
2) Measurement array
3)
Value (Float, Int)
4) Common axis
5) Curve
6) Map
7) Value block
8) String
9) Calculated variable
10) Struct
11) Struct array
12) You can connect variables to properties of the 3-D Viewer as well as properties of
items displayed in the 3-D Viewer. For more information, refer to Overview of Possible
Variable Connections on page 67.
13) You can connect the contained variables to different instruments in one step by
customizing the connection assignment. Refer to How to Customize the Connection
Assignment of Variables and Framework Labels to Instruments (ControlDesk
Layouting ).

38
ControlDesk Instrument Handling May 2024
Introduction to Instrument Handling

14) You can connect one-dimensional measurement arrays to the x‑ and y‑axis if they have
the same length.

Handling conversion tables Some instruments support variables with conversion tables and multiscalings.
and multiscalings The following table shows the most suitable instruments:

Instrument Conversion Table Multiscaling


Display ✓ ✓
Numeric Input ✓ ✓
Push Button ✓ –
Radio Button ✓ –
Selection Box ✓ –
Variable Array ✓ ✓

For details, refer to Basics on Variables Using Conversion Tables (ControlDesk


Variable Management ).

Accessing 64-bit integer The following table shows the ControlDesk instruments that support 64-bit
variables via ControlDesk integer variables (int64 and uint64 data types) in source mode. The support
instruments depends on whether you use the instrument via the ControlDesk user interface
or via automation:

Instrument Instrument Usage


Via the Graphical User Via the Instrument Automation
Interface Interface1)
Browser — ✓ (read)
Display ✓ (read) ✓ (read)
Frame — ✓ (read)
Hierarchy Array ✓ (read and write) ✓ (read and write)
Numeric Input ✓ (read and write) ✓ (read and write)
Variable Array ✓ (read and write) ✓ (read and write)
1) For information on accessing a variable value via an instrument automation interface,
refer to Connecting variables to instruments on page 746.

Note

§ If you connect a 64-bit integer variable to an instrument that does not


support this, the precision is limited to 52‑bit.
§ If you enter a 64-bit integer value in an instrument that is not connected
to a variable, the precision is limited to 52‑bit. This also applies to
instruments that support 64-bit integer variables, such as the Numeric
Input .
§ Bitmasks are not supported for 64-bit integer variables. Bitmask settings
are ignored.
§ A range check is not supported for 64-bit integer variables. Range
limitations (weak limits) are ignored.

39
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Preserving variable If the data source changes and the variable of a variable connection is not
connections available any longer, the instrument preserves the connection path or the URI.

The following illustration shows this case after the data source of the layout has
been switched to a different measurement data file:

ControlDesk reactivates the variable connection if the data source offers an


appropriate variable with the same connection path or URI.

Related topics Basics

Automating Direct Variable Access (ControlDesk Automation )


Automating Parameter Calibration......................................................................................... 751
Automating Visualization of Variables on Layouts................................................................... 742
Basics of Connecting Variables and Framework Labels to Instruments (ControlDesk
Layouting )
Basics on Variable Types (ControlDesk Variable Management )
Basics on Variables Using Conversion Tables (ControlDesk Variable
Management )

References

Range / IXaRange <<Interface>> (ControlDesk Automation )


Range Check Properties.......................................................................................................... 516
RangeCheck / IViRangeCheck <<Interface>> (ControlDesk Automation )

Choosing Between Time Plotter, Index Plotter, and XY Plotter

Introduction ControlDesk offers three plotters types with different main purposes. Knowing
the differences helps you to select the appropriate type.

40
ControlDesk Instrument Handling May 2024
Introduction to Instrument Handling

Tutorial video
Comparing Time Plotter, Index Plotter, and XY Plotter

This video compares Time Plotter, Index Plotter, and XY Plotter.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/RRwgM

Overview The following table gives you an overview of the differences between the
Plotters.

Function Time Plotter Index Plotter XY Plotter


Main purpose Specific use case: Displays Specific use case: Specific use case:
signals in relation to Displays signals in Displays signals in
measurement time relation to events relation to other signals
X-axis as time axis ✓ – –
X-axis as event axis – ✓ –
X-axis as signal axis – – ✓
Several signals on the y-axis ✓ ✓ ✓
XY plots: One signal on the x‑axis – – ✓
XY plots: Several signals on the x‑axis – – ✓
XY plots: Several curves in one plot – – ✓
XY plots: Measurement raster check – – ✓
XY plots: Triggered visualization – – ✓

Time Plotter

41
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Signals in relation to the measurement time The Time Plotter displays one
or more measured signals in relation to the measurement time.

The following table shows the other possible relations and how they are
restricted with the Time Plotter.

Relation Description
Signals in relation You can connect a signal that is measured in an event-based
to events measurement raster to the Time Plotter.
§ Disadvantage: The x-axis continues to display measurement times.
It does not switch to displaying events.
§ Optimum instrument: Index Plotter
Signals in relation The Time Plotter cannot display signals in relation to other signals.
to other signals You cannot connect a signal to the x-axis.
§ Optimum instrument: XY Plotter

For more information on the Time Plotter, refer to Time Plotter Handling on
page 216.

Index Plotter

Signals in relation to events The Index Plotter displays one or more signals
in relation to events. It uses the x-axis as an event axis that displays indices
for each captured sample. The Index Plotter is usually used for signals with
event-based rasters.

The following table shows the other possible relations and how they are
restricted with the Index Plotter.

Relation Description
Signals in relation to You can connect a signal that is measured in a time-based
measurement time measurement raster to the Index Plotter.
§ Disadvantage: The x-axis continues displaying numbered
events. It does not switch to displaying measurement times.
§ Optimum instrument: Time Plotter
Signals in relation to The Index Plotter cannot display signals in relation to other
other signals signals. You cannot connect a signal to the x-axis.
§ Optimum instrument: XY Plotter

42
ControlDesk Instrument Handling May 2024
Introduction to Instrument Handling

For more information on the Index Plotter, refer to Index Plotter Handling on
page 120.

XY Plotter

Signals in relation to other signals The XY Plotter displays one or more


signals in relation to other signals.You can connect more than one signal to the
x-axis and define several curves in one plot.
In addition, the XY Plotter checks whether the signals that are connected to a
curve have the same measurement raster. This allows the XY Plotter to display
triggered signals in the XY plot.

The following table shows the other possible relations and how they are
restricted with the XY Plotter.

Relation Description
Signals in relation to You can connect a signal that is measured in an event-based
events measurement raster to the XY Plotter, but the measurement
raster is irrelevant for displaying the xy-plot.
§ Optimum instrument: Index Plotter
Signals in relation to The XY Plotter does not have a time mode. Its x-axis is always a
measurement time signal axis.
§ Optimum instrument: Time Plotter

For more information on the XY Plotter, refer to XY Plotter Handling on


page 253.

Related topics Basics

Index Plotter Handling............................................................................................................ 120


Time Plotter Handling............................................................................................................. 216
XY Plotter Handling................................................................................................................ 253

43
May 2024 ControlDesk Instrument Handling
Basics and Instructions

How to Configure the Instrument Selector

Objective To customize the selection of instruments, you can configure the Instrument
Selector .

Introduction The Instrument Selector is a pane that provides access to ControlDesk's


instruments. You can select instruments from the Instrument Selector and
place them on layouts.

Instrument categories ControlDesk's Instrument Selector has various


categories. The following list shows examples:
§ The Favorites category lists the user-defined favorite instruments. These are
displayed in a list below the default instrument when you drag a variable to a
layout.
§ The Standard Instruments category lists all the ControlDesk instruments.
§ The Custom Instruments category lists customized instruments. You can
use this category for your custom instruments but you are not limited to
it. Custom instruments can be placed in any category of the Instrument
Selector, whether it is a custom category or not.
§ The LEDs Automotive category provides a library of LEDs with common
instrument symbols for automotive applications.
§ The Gauges Automotive category provides a library of gauges with common
instrument symbols for automotive applications.
§ The Measurement category provides a library of measurement instruments
with common instrument symbols for measurement purposes.

44
ControlDesk Instrument Handling May 2024
Introduction to Instrument Handling

For detailed information on the categories, refer to Instrument Descriptions on


page 266.

Method To configure the Instrument Selector


1 To add a new category to the Instrument Selector, open the context menu
and select Add Category.
ControlDesk adds a new category below the existing categories.

2 To rename the new category, select it and press F2. Change the name, and
press Enter.

Note

An easy way to add a new category is to hover the pointer above the
area directly below the existing categories, select the displayed New
Category proposal, and change its name.

45
May 2024 ControlDesk Instrument Handling
Basics and Instructions

3 To move an instrument from one category to another, drag it to the new


position. Press Ctrl to copy it.

4 You can also move a category to a new position and build subcategories.
5 You can add a user-defined instrument by dragging it from a layout to a
category of the Instrument Selector.
6 To remove a category or an instrument, select it and press Delete.
7 If you need to copy a default instrument or library, select Show Libraries
from the context menu of the Instrument Selector.
ControlDesk opens the Instrument Libraries pane that shows all the
predefined dSPACE instrument libraries.

§ To copy an instrument, select it in the library and drag it to the desired


position in the Instrument Selector.
§ To copy a complete library, select it and press Copy. In the Instrument
Selector, the new category is placed below the existing ones. The new
category is named after the library. You can copy the same library several
times.

46
ControlDesk Instrument Handling May 2024
Introduction to Instrument Handling

§ To copy an instrument to all the categories that have the same name
as the library, select the instrument in the library and press Copy. The
instrument is added to those categories that it is not contained in yet..
If no category has the same name as the library, ControlDesk creates a
new one containing the selected instrument.
8 You can export and import instrument libraries via the context menu of the
Instrument Selector.
§ Select Export to export a category with the custom instruments it
contains to an instrument library (ILX) file.
§ Select Import library to import an instrument library and the related
instruments as a new category.
§ Select Import to import only the instruments of an instrument library to
the currently selected category.

Result You have configured the Instrument Selector.

Adding custom instruments If you have changed the properties of an instrument, you can use the
Instrument Selector to make the custom instrument reusable. Refer to How
to Make an Instrument Reusable on page 50.

Related topics References

Add Category......................................................................................................................... 585


Export (Instrument Selector).................................................................................................... 653
Import (Instrument Selector)................................................................................................... 660
Import Library......................................................................................................................... 661
Instrument Selector................................................................................................................ 668

How to Define Default and Favorite Instruments

Objective You can specify a default instrument for a certain variable type and define
favorite instruments for quick access to frequently used instruments.

Basics Default instruments There is one default instrument for each variable type.
If you enable Always show List on the context menu of the Instrument
Selector, and then drag a variable to a layout, the default instrument is
displayed at the top of the instrument selection list. In the Instrument Selector,
default instruments are underscored. You can specify other instruments as
default instruments.

47
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Default instrument

Favorite instruments

A variable is automatically visualized in the corresponding default instrument in


the following cases:
§ You drag a variable to a layout while Always show List is disabled
§ You select Visualize Variables in the variable's context menu in the
Variables pane

Favorite instruments You can define frequently used instruments as favorite


instruments. They are displayed in a list below the default instrument when you
drag a variable to a layout via the Variables pane.

Tip

When you hover over a favorite instrument in the Instrument Selector with
your mouse pointer, the star behind the instrument is highlighted yellow.

Preconditions The Instrument Selector must be opened. For information on opening it, refer
to Instrument Selector on page 668.

Part 1 To define a default instrument


1 Click an instrument, for example, a Bar, in the Instrument Selector.
2 From the context menu of the instrument, select Set as default for.
ControlDesk expands a list with variable types.
3 Select a variable type, for example, Measurement.
ControlDesk underscores the instrument. It is displayed at the top of a list
when you drag a measurement variable to a layout via the Variables pane.

48
ControlDesk Instrument Handling May 2024
Introduction to Instrument Handling

Interim result You defined a default instrument. Continue with Part 2 on page 49.

Part 2 To define a favorite instrument


1 From the context menu of an instrument, for example, a Gauge, select Add
to Favorites.
ControlDesk adds the selected instrument to the Favorites category in
the Instrument Selector. The instrument is also displayed in a list below
the default instrument when you drag a variable to a layout via the
Variables pane.

Tip

§ You can also drag an instrument directly from the ControlDesk


Instruments category to the Favorites category in the Instrument
Selector.
§ You can also click on the star right to the instrument name in
the Instrument Selector to add an instrument to the Favorites
category:

Result You defined a default instrument and a favorite instrument which you can access
directly from a list when you drag a variable to a layout via the Variables pane.

Related topics References

Add to Favorites..................................................................................................................... 585


Instrument Selector................................................................................................................ 668
Set as Default for.................................................................................................................... 706

49
May 2024 ControlDesk Instrument Handling
Basics and Instructions

How to Make an Instrument Reusable

Objective To reuse instrument settings, you can define custom instruments.

Basics Custom instruments are instruments which you have customized and saved. The
advantage is that you configure the properties of the custom instruments once
and can then reuse the preconfigured instruments.

Preconditions The Instrument Selector must be opened.

Method To make an instrument reusable


1 Add an instrument on a layout.
2 Customize the properties of the instrument via the Properties pane, for
example, by changing the background color or the caption text.
3 Drag the instrument to a category in the Instrument Selector.

ControlDesk adds the instrument to the category.


4 To rename the custom instrument, open its context menu and select
Rename.

5 Change the name and press Enter.

50
ControlDesk Instrument Handling May 2024
Introduction to Instrument Handling

Result You have made an instrument reusable by adding it to a category in the


Instrument Selector.

When you add a custom instrument to a layout, ControlDesk adds the


instrument and its settings.

Tip

Each time you define a custom instrument, it is also added to the Custom
Instruments library. It remains in the library until you remove it via the
Delete shortcut key. Refer to Show Libraries on page 714.

Related topics References

Change Icon........................................................................................................................... 599


Export (Instrument Selector).................................................................................................... 653
Import (Instrument Selector)................................................................................................... 660
Rename (Custom Instrument)................................................................................................. 694

How to Configure the Properties of Instruments

Objective You can configure not only the properties of an individual instrument, but also
the common properties of multiple instruments simultaneously.

Instrument properties Properties pane You can configure the properties of instruments via the
Properties pane, which displays the properties of the currently selected
instruments hierarchically. Some properties of the Variable Array have to be
configured in additional properties dialogs via the context menu of the cells.

Instrument‑specific properties Each instrument has instrument‑specific


properties. The list below shows some examples:
§ Table Editor: Axes properties, Views properties, Instrument Header
properties.
§ Time Plotter: Axes/Signals properties, Data cursor properties and Toolbar
properties.

Common instrument properties There are some common instrument


properties which are identical for several instruments. For example, the Name
property is common to all instruments, and the Scale properties are common to
the Bar, Slider, Gauge and Knob.
When you select several instruments, the Properties pane displays their
common properties. You can configure the common properties for all the
selected instruments simultaneously.

51
May 2024 ControlDesk Instrument Handling
Basics and Instructions

You can also assign the property settings of one instrument to another. The
second instrument then gets the same settings for all common properties.

Collapsing and expanding the properties tree The Properties pane


provides buttons to expand or collapse categories and properties.

Searching and filtering The Properties pane provides buttons to search and
filter the content. The results are highlighted and you can jump to the previous
or next occurrence of the search string.

Extending the functionality of an instrument You can extend the


functionality of an instrument by adding Python code to it. Refer to Script
Property on page 527.

Method To configure the properties of instruments


1 Click the instrument(s) to be configured on the layout. To select multiple
instruments, keep the Ctrl key pressed while selecting.
The selected instruments are marked with frames.
2 Click Instrument Properties from the context menu of the selected
instrument(s).
ControlDesk displays the (common) properties of the selected instrument(s)
in the Properties pane.

3 Select the properties and configure them according to your needs.


4 If you want to save the changes without saving the whole
project/experiment, press Ctrl+S.

52
ControlDesk Instrument Handling May 2024
Introduction to Instrument Handling

Result The properties of the selected instrument(s) are changed.

Related topics References

Instrument-Related Properties................................................................................................. 402


Properties (Pane) (ControlDesk User Interface Handling )

53
May 2024 ControlDesk Instrument Handling
Basics and Instructions

3-D Viewer Handling


Introduction The 3-D Viewer lets you display items in a 3-D environment.

Where to go from here Information in this section

Basics of Handling the 3-D Viewer........................................................... 55


The 3-D Viewer lets you display items in a 3-D environment. You can
display stationary items or connect variables to the properties of the
items to visualize changing item properties.

Selecting the Coordinate System............................................................. 62


The 3-D Viewer offers a left-handed and a right-handed coordinate
system. You must select the appropriate system for your task.

Connecting Variables to 3-D Viewer Properties........................................ 64


You can connect variables to the properties of the items or to the
properties of the camera.

Overview of Possible Variable Connections.............................................. 67


To display items with changing properties, you can connect variables to
the properties of the items.

Example of Using the 3-D Viewer............................................................ 71


The following example is based on the Instrumentation Demo. The goal
is to visualize the ego-vehicle driving on a race track while passing
multiple other vehicles.

How to Add an Item and Configure the Item Properties .......................... 79


You can add items to be displayed in the 3-D Viewer and configure the
item properties.

Adding Roads via MAT File Import........................................................... 82


The automation interface of the 3-D Viewer lets you import complete
road networks from MAT files created with the ModelDesk Road
Generator.

How to Track the Distance Between Two Items........................................ 83


You can track the distance between two items. For example, you can
track the distance between two cuboids representing moving cars to
check if the cars collide.

How to Work with Item Templates........................................................... 86


You can create a template of an item. The template can be used to save
the properties of an item to add more items with the same properties
later.

Basics of Group Items.............................................................................. 89


You can use group items to display multiple items with just one one-
dimensional variable array per property.

54
ControlDesk Instrument Handling May 2024
3-D Viewer Handling

Basics of Surfaces.................................................................................... 90
You can use surfaces to display shapes in the 3-D Viewer. For example,
you can use a surface to display a landscape. You can also display the
values of one or more variables as a three-dimensional chart.

Example of Using an Instrument Script with the 3-D Viewer..................... 91


The following example is based on the Instrumentation Demo. The
example visualizes the vertical movement of a mass connected to a
spring.

Basics of Handling the 3-D Viewer

Introduction The 3-D Viewer lets you display items in a 3-D environment. You can display
stationary items or connect the properties of the items to variables to visualize
changing item properties.

3-D Viewer

Items When working with the 3-D Viewer, you can add the following items to the 3-D
environment:

Item Type Description Example


Cuboid You can add cuboids and configure their properties, for
example color, size, position, and rotation.
You can use cuboids as stationary items, for example as a
visualization of obstacles. You can also connect variables
to the cuboids to visualize moving objects such as cars.

55
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Item Type Description Example


Rectangle You can add rectangles and configure their properties,
for example color, size, position, and rotation.
You can use a rectangle to add an image to the 3-D
environment. Via the Alpha property, you can specify the
transparency of the image.

Point Line You can add point lines. A point line is defined by an
array of points connected by a line. You can configure
the properties of the points and the properties of the
line.
For example, you can use a point line to display a
trajectory. You can also add a point line with only one
point to display a sphere.

Cuboid You can add cuboid groups and connect them to one-
group dimensional variable arrays to display an array of similar
cuboids.
For example, you can use a cuboid group to visualize a
large number of cars simultaneously.
For more information, refer to Basics of Group Items on
page 89.

Rectangle You can add rectangle groups and connect them to one-
group dimensional variable arrays to display an array of similar
rectangles.
For example, you can use a rectangle group to display a
large number of traffic signs simultaneously.
For more information, refer to Basics of Group Items on
page 89.

56
ControlDesk Instrument Handling May 2024
3-D Viewer Handling

Item Type Description Example


Surface You can add surfaces. The shape of the surface is defined
by an array of points connected by a wireframe.
For example, you can use a surface to display a
landscape. You can also display the values of one or more
variables as a three-dimensional chart.
For more information, refer to Basics of Surfaces on
page 90.

For more information on adding and configuring items, refer to How to Add an
Item and Configure the Item Properties on page 79.

Camera You can configure the point of view by configuring the following camera
properties:
§ Distance
§ Position
§ Rotation

Via the Angle property, you can select a predefined camera angle.

You can specify an item to follow via the Target property, for example if you
want to follow a cuboid representing a moving car.

You can also connect variables to the camera properties to specify custom
camera movement.

The following mouse commands are an easy way to quickly configure the
camera properties.

Mouse command Purpose


Hold the middle mouse button and move the To move the camera position.
pointer.
Hold the left mouse button and move the To rotate the camera.
pointer.
Turn the mouse wheel. To change the camera
distance.

Distance tracking You can track the distances between two items via the Tracked distances
property. The distance tracking is visualized by means of a distance line that
connects the items in the 3-D environment. The distance is displayed as a label
on top of the distance line. The following illustration shows the distance tracking
of two cuboids.

57
May 2024 ControlDesk Instrument Handling
Basics and Instructions

You cannot track the distance to a surface, a cuboid group or a rectangle group.

For more information on tracking the distance between two items, refer to How
to Track the Distance Between Two Items on page 83.

3-D environment Selecting the coordinate system You can select a left-handed or a right-
handed coordinate system for the 3-D Viewer via the Properties pane. The
selected coordinate system affects the arrangement, directions, and rotations of
the axes. The right-handed coordinate system, for example, complies with the
automotive coordinate system according to the DIN 70000 standard.

Note

Select the instrument coordinate system before you specify other instrument
properties. Otherwise, you might have to modify these properties
afterwards.

Refer to Selecting the Coordinate System on page 62.

X-axis, y-axis, and z-axis You can configure the display of each axis via
the Properties pane. For example, you can scale each axis according to your
requirements by specifying the length of the axis as well as the minimum and
maximum value displayed on the axis. You can also configure the display of
major and minor tics. The axes define the visible area of the 3-D environment, as
shown in the following illustration:

58
ControlDesk Instrument Handling May 2024
3-D Viewer Handling

Visible area Clipped cuboid

Clip content By default, any item beyond the visible area is not displayed. If
an item expands beyond the visible area, it is clipped. The following illustration
shows a cuboid that is clipped beyond the visible area.

59
May 2024 ControlDesk Instrument Handling
Basics and Instructions

To fully display any item beyond the visible area, disable the Clip content
property, as shown in the following illustration:

Tip

If you cannot find an item, you can disable the Clip content property to
check whether the item is beyond the visible area.

Walls You can display walls and specify the color for each wall. The same
properties can be specified for the bottom and the top of the visible area.

Orthographic projection You can specify to display the 3-D environment


as an orthographic projection via the Orthographic property. When disabled,
items near the camera appear to be larger than identical items further away. The
orthographic projection is disabled in the following illustration.

60
ControlDesk Instrument Handling May 2024
3-D Viewer Handling

When the Orthographic property is enabled, all identical items appear to be the
same size, regardless of the point of view, as shown in the following illustration.

Related topics Basics

Connecting Variables to 3-D Viewer Properties......................................................................... 64


Overview of Possible Variable Connections............................................................................... 67
Selecting the Coordinate System.............................................................................................. 62

References

3-D Viewer............................................................................................................................. 303

61
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Videos

Adding Items and Connecting Variables (3:48) in dSPACE Help


Changing the Camera Distance via an Instrument Script (2:24) in dSPACE Help
Street Scene Demo (3:10) in dSPACE Help
Tracking Distances (2:23) in dSPACE Help
Working With Group Items (5:15) in dSPACE Help
Working With Point Lines (3:54) in dSPACE Help
Working with Rectangles and Pictures (2:55) in dSPACE Help

Selecting the Coordinate System

Introduction The 3-D Viewer offers a left-handed and a right-handed coordinate system. You
must select the appropriate system for your task.

Coordinate system as basic The visualization of objects in the 3-D Viewer is determined by the coordinate
property for visualization system that is specified for the instrument. The selected coordinate system
affects the arrangement, directions, and rotations of the axes.

Note

Select the instrument coordinate system before you specify other instrument
properties. Otherwise, you might have to modify these properties
afterwards.

Right-handed coordinate The default coordinate system for the 3-D Viewer is right-handed and complies
system with the automotive coordinate system according to the DIN 70000 standard.

It has the following properties:


§ x-axis points backwards
§ y-axis points to the left
§ z-axis points upwards

An object rotates clockwise around the selected axis when you increase the
rotation value.

62
ControlDesk Instrument Handling May 2024
3-D Viewer Handling

See the following illustration (for an animated graphic, refer to dSPACE Help).

Left-handed coordinate The 3-D Viewer supports a left-handed coordinate system with the following
system properties:
§ x-axis points to the right
§ y-axis points upwards
§ z-axis points backwards

63
May 2024 ControlDesk Instrument Handling
Basics and Instructions

An object rotates counterclockwise around the selected axis when you increase
the rotation value.

See the following illustration (for an animated graphic, refer to dSPACE Help).

Related topics Basics

Basics of Handling the 3-D Viewer............................................................................................ 55

References

Axes Properties (3-D Viewer)................................................................................................... 427

Connecting Variables to 3-D Viewer Properties

Introduction You can connect variables to the properties of the items or to the properties of
the camera.

For an overview of all possible variable connections, refer to Overview of Possible


Variable Connections on page 67.

64
ControlDesk Instrument Handling May 2024
3-D Viewer Handling

Tutorial video
Adding Items and Connecting Variables

This video shows you how to add items to the 3‑D environment and connect
variables to item properties.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/tE4fn

Connecting variables via drag You can connect a variable via drag & drop (for an animated graphic, refer to
& drop dSPACE Help).

1. From the Variables pane or the Measurement Data Pool pane, click a
variable, then drag and drop it onto the 3-D Viewer.

65
May 2024 ControlDesk Instrument Handling
Basics and Instructions

2. Select a property from the list.

Connecting variables via the You can connect a variable via the Instrument Navigator.
Instrument Navigator
From the Variables pane or the Measurement Data Pool pane, click a variable,
then drag and drop it onto a property in the Instrument Navigator (for an
animated graphic, refer to dSPACE Help).

66
ControlDesk Instrument Handling May 2024
3-D Viewer Handling

Related topics Basics

Basics of Handling the 3-D Viewer............................................................................................ 55


Overview of Possible Variable Connections............................................................................... 67

Videos

Working With Group Items (5:15) in dSPACE Help


Working With Point Lines (3:54) in dSPACE Help
Working with Rectangles and Pictures (2:55) in dSPACE Help

Overview of Possible Variable Connections

Introduction By default, the properties of an item, like its x-, y-, or z-position, are constant.
You can specify the properties via the Properties pane or via the Items dialog.

To display items with changing properties, you can connect variables to the
properties of the items. The properties to which you can connect the variables
depend on the item type and the variable type.

67
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Note

While a variable is connected to a property, you cannot change the value of


the property. Instead, information on the connected variable is displayed.

Connecting variables to the You can connect the following variable types to the properties of a cuboid:
properties of a cuboid

Item Calculated Measurement Parameter Measurement Value


Property variable ( ) ( ) ( ) array ( ) block
( )
Visible ✓ ✓ ✓ — —
Color ✓ ✓ ✓ — —
Text1) ✓ ✓ ✓ — —
Position ✓ ✓ ✓ — —
Size ✓ ✓ ✓ — —
Rotation ✓ ✓ ✓ — —
1) If you connect a variable to the label text, you can insert dynamic text parts via macros.

Connecting variables to the You can connect the following variable types to the properties of a rectangle:
properties of a rectangle

Item Calculated Measurement Parameter Measurement Value


Property variable ( ) ( ) ( ) array ( ) block
( )
Visible ✓ ✓ ✓ — —
Color ✓ ✓ ✓ — —
Text1) ✓ ✓ ✓ — —
Position ✓ ✓ ✓ — —
Size ✓ ✓ ✓ — —
Rotation ✓ ✓ ✓ — —
1) If you connect a variable to the label text, you can insert dynamic text parts via macros.

68
ControlDesk Instrument Handling May 2024
3-D Viewer Handling

Connecting variables to the You can connect the following variable types to the properties of a point line:
properties of a point line

Item Property Calculated Measurement Parameter Measurement Value


variable ( ) ( ) ( ) array ( ) block
( )2)
Visible ✓ ✓ ✓ — —
Line Color ✓ ✓ ✓ — —
Point Color ✓ ✓ ✓ — —
Position — ✓1) — ✓2) ✓2)
1) Available only for recorded measurements. When you connect a measurement variable
to a position property of a point line, you can choose to connect either the
measurement values or the time values.
2) The number of points is equal to the length of the array. You can connect only one-
dimensional arrays.

Connecting variables to the You can connect the following variable types to the properties of a cuboid
properties of a cuboid group group:

Item Calculated Measurement Parameter Measurement Value


Property variable ( ) ( 1)) ( ) array ( )2) block
( )2)
Visible — ✓ — ✓ ✓
Color — ✓ — ✓ ✓
Text3) — — — ✓ ✓
Position — ✓ — ✓ ✓
Size — ✓ — ✓ ✓
Rotation — ✓ — ✓ ✓
1) Available only for recorded measurements. When you connect a measurement variable
to a property of a cuboid group, you can choose to connect either the measurement
values or the time values.
2)
The number of displayed cuboids is equal to the length of the array. You can connect
only one-dimensional arrays.
3) If you connect a variable to the label text, you can insert dynamic text parts via macros.

Connecting variables to the You can connect the following variable types to the properties of a rectangle
properties of a rectangle group:
group

Item Calculated Measurement Parameter Measurement Value


Property variable ( ) ( 1)) ( ) array ( )2) block
( )2)
Visible — ✓ — ✓ ✓
Color — ✓ — ✓ ✓

69
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Item Calculated Measurement Parameter Measurement Value


Property variable ( ) ( 1)
) ( ) array ( )2) block
( )2)
Text3) — — — ✓ ✓
Position — ✓ — ✓ ✓
Size — ✓ — ✓ ✓
Rotation — ✓ — ✓ ✓
1) Available only for recorded measurements. When you connect a measurement variable
to a property of a rectangle group, you can choose to connect either the measurement
values or the time values.
2) The number of displayed rectangles is equal to the length of the array. You can connect
only one-dimensional arrays.
3) If you connect a variable to the label text, you can insert dynamic text parts via macros.

Connecting variables to the You can connect the following variable types to the properties of a surface:
properties of a surface

Item Property Calculated Measurement Parameter Measurement Value


variable ( ) ( ) ( ) array ( ) block
( )
Visible ✓ ✓ ✓ — —
Color ✓ ✓ ✓ — —
x-axis — ✓1) — ✓2) ✓2)
z-axis — ✓1) — ✓2) ✓2)
Function values — — — ✓3) ✓3)
1) Available only for recorded measurements. When you connect a measurement variable
to an axis, you can choose to connect either the measurement values or the time
values. Connecting a measurement variable with a high number of values might have a
negative impact on the performance of the instrument.
2)
The number of points is equal to the length of the array. You can connect only one-
dimensional arrays.
3) You can connect only a two-dimensional array. The length of this array has to match
the length of the arrays connected to the x-axis and z-axis properties.

Connecting variables to the You can connect the following variable types to the camera properties:
camera properties

Item Calculated Measurement Parameter Measurement Value


Property variable ( ) ( ) ( ) array ( ) block
( )
Distance ✓ ✓ ✓ — —
Position ✓ ✓ ✓ — —
Rotation ✓ ✓ ✓ — —

70
ControlDesk Instrument Handling May 2024
3-D Viewer Handling

Related topics Basics

Basics of Group Items............................................................................................................... 89


Basics of Handling the 3-D Viewer............................................................................................ 55
Basics of Surfaces..................................................................................................................... 90
Connecting Variables to 3-D Viewer Properties......................................................................... 64

References

Items and Templates Properties............................................................................................... 481

Videos

Adding Items and Connecting Variables (3:48) in dSPACE Help


Working With Point Lines (3:54) in dSPACE Help

Example of Using the 3-D Viewer

Introduction The following example is based on the Instrumentation Demo. The goal is to
visualize the ego-vehicle driving on a race track while passing multiple other
vehicles. Also, every object in a fixed radius around the ego-vehicle is supposed
to be colored red to display the range of a sensor.

The goal of this demo is to show examples of how the different item types and
their properties can be used in a meaningful way.

Item type Use Case Example


Point line § Boundaries of the race track
§ Detected boundaries
Cuboid § Ego-vehicle
Cuboid group § Other vehicles
§ Detected vehicles
Rectangle § Display of sensor range
§ Traffic signs

71
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Tutorial video
Street Scene Demo

This video shows you an introduction to the Street Scene demo, which is part
of the ControlDesk Instrumentation Demo.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/zHAp8

Controlling the demo You can control the demo by using the TimeCursorControl instrument group:

Recorded measurement data The item properties in this demo are connected to recorded measurement data
provided by the Street.mf4 file. The data is time-dependent. To animate the
movement of all vehicles, the TimeCursorControl instrument group can be used
to specify the time position.

For example, the VehicleObjectsList Block contains the XPosition


measurement array. This variable contains 50 time-dependent values. When
connected to the x-position property of a cuboid group, the x-positions of every
cuboid in the cuboid group is given by the values of the measurement array.

Race track To visualize the race track, two point lines are added. The point lines represent
the left and the right boundary of the road. The values of the x- and z-positions

72
ControlDesk Instrument Handling May 2024
3-D Viewer Handling

of each point line are connected to recorded measurement variables to define


the shape of the race track.

To display the entire race track, the ranges of the x-axis and the z-axis have to be
set accordingly.

Tip

In this demo, the race track is added by connecting variables from the MF4
file to point lines representing the boundaries of the road.
Another way to visualize complete road networks in the 3-D Viewer is to
add them via MAT file import. Refer to Adding Roads via MAT File Import on
page 82.

Vehicles Every vehicle in this demo is displayed as a cuboid. To display multiple identical
vehicles with one item, a cuboid group is used.

73
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Ego-vehicle The ego-vehicle is visualized as a blue cuboid. The size of the


cuboid is constant. In order to move the cuboid along the race track, the values
of the x- and z-position are connected to recorded measurement variables. Also,
the y-rotation of the cuboid is connected to a recorded measurement variable in
order to rotate the cuboids similar to a real vehicle.

Other vehicles Every other vehicle that is not the ego-vehicle is visualized as
a green cuboid group. Every cuboid in the group has the same size. Similar to
the ego-vehicle, the x- and z-position, as well as the y-rotation is connected to a
recorded measurement array.

74
ControlDesk Instrument Handling May 2024
3-D Viewer Handling

Display of the sensor range Other vehicles within the sensor range Every vehicle within the sensor
range must be red. To achieve this, a second cuboid group with the color
red is added. The red cuboid group has the same variable connections to the
x-position, z-position and y-rotation as the green cuboid group representing
the other vehicles. To make sure that only vehicles within the sensor range are
displayed, the Visible property of both cuboid groups is connected to a recorded
measurement array. For every vehicle within the sensor range, the value of the
measurement is 1, for every other vehicle it is 0. After setting the Match value
of the red cuboid group to be 1 and the Match value of the green cuboid group
to be 0, every vehicle within the sensor range is displayed red.

75
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Boundaries of the race track within the sensor range The boundaries of
the race track are supposed to be colored red within the sensor range. In the
demo, a maximum total of 4 boundaries can be included in the sensor range
at any time. To display them, 4 new point lines are added. The values of the
x- and z-positions of each point line are connected to recorded measurement
arrays. These variables are defined only within the sensor range. The point lines
are colored red and the Width property is set to be slightly larger than that of
the race track to make the red point lines more visible.

76
ControlDesk Instrument Handling May 2024
3-D Viewer Handling

Red circle to display the sensor range The sensor range is supposed to be
displayed with a red circle. To do so, a rectangle is added. The x- and z-position
is connected to the same recorded measurement variables as the ego-vehicle. An
image of a red circle is specified to be shown on the surface of the rectangle.
The transparency of the circle is set via the Alpha property.

77
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Traffic signs Rectangles can be used to add traffic signs. In this demo, an image of two
flags is specified to be shown on the surface of a rectangle to show the start
of the race track. Because the rectangle does not move, its properties are not
connected to any variable. Another rectangle displays the ground of the race
track.

Result The instrument displays a race track and multiple vehicles driving, including the
ego-vehicle and multiple green vehicles. Every green vehicle within the sensor
range of the ego-vehicle is colored red as well as the boundaries of the race track
within the sensor range. A red circle also visualizes the sensor range. Finally, a
start sign is added to the 3-D environment.

78
ControlDesk Instrument Handling May 2024
3-D Viewer Handling

The following illustration shows the result of the demo (for an animated graphic,
refer to dSPACE Help).

Related topics Basics

Basics of Handling the 3-D Viewer............................................................................................ 55


Connecting Variables to 3-D Viewer Properties......................................................................... 64
Instrumentation Demo (ControlDesk Introduction and Overview )
Overview of Possible Variable Connections............................................................................... 67

How to Add an Item and Configure the Item Properties

Objective You can add items to be displayed in the 3-D Viewer and configure the item
properties.

Tutorial video
Adding Items and Connecting Variables

This video shows you how to add items to the 3‑D environment and connect
variables to item properties.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/nN8kT

79
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Method To add an item and configure the item properties


1 Click the Browse button of the Items property.

A dialog opens.
2 From the list, select the type of item you want to add. If you created a
template for an item beforehand, you can also select the template from the
same list.

3 Select the Add button.

80
ControlDesk Instrument Handling May 2024
3-D Viewer Handling

4 If required, you can configure the item properties. Select the item whose
properties you want to configure.

5 Configure the item properties.

Note

While a variable is connected to a property, you cannot change the


value of the property. Instead, information on the connected variable is
displayed.

6 Close the dialog.

Result You have added an item and configured its properties.

Related topics Basics

Adding Roads via MAT File Import............................................................................................ 82


Basics of Handling the 3-D Viewer............................................................................................ 55

81
May 2024 ControlDesk Instrument Handling
Basics and Instructions

HowTos

How to Work with Item Templates............................................................................................ 86

References

3-D Viewer............................................................................................................................. 303


Axes Properties (3-D Viewer)................................................................................................... 427
Items and Templates Properties............................................................................................... 481

Adding Roads via MAT File Import

Introduction The automation interface of the 3-D Viewer lets you import complete road
networks from MAT files created with the ModelDesk Road Generator. The
road's data must be prepared according to the ground truth data format of
the Open Simulation Interface (OSI). To get this data format, you must enable
the OSI road support in ModelDesk. Refer to Environment Configuration Dialog
(ModelDesk Scenario Creation ).

Automation example The following program listing shows an example.

# Importing road network from a MAT File


3dvInstrument = Application.LayoutManagement.Layouts["Layout4"].Instruments["3-D Viewer_12"]
3dvInstrument.RoadImport.Import(r"E:\test\TestRoad.mat")

All road segments in the MAT file are imported to single point lines as shown in
the following illustration.

For more information, refer to Viewer3DInstrument / IViViewer3DInstrument


<<Interface>> (ControlDesk Automation ).

82
ControlDesk Instrument Handling May 2024
3-D Viewer Handling

Related topics Basics

Features of the Road Generator (ModelDesk Road Creation )

HowTos

How to Add an Item and Configure the Item Properties ........................................................... 79

References

Viewer3DInstrument / IViViewer3DInstrument <<Interface>> (ControlDesk


Automation )

How to Track the Distance Between Two Items

Objective You can track the distance between two items. For example, you can track the
distance between two cuboids representing moving cars to check if the cars
collide.

The distance tracking is visualized with a distance line connecting the items in
the 3-D environment.

Tutorial video
Tracking Distances

This video shows you how to track distances in the 3‑D environment.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/gRxe5

Restriction You cannot track the distance to the following items:


§ Cuboid group
§ Rectangle group
§ Surface

83
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Precondition At least two items whose distance can be tracked must have been added to the
3-D Viewer. Refer to How to Add an Item and Configure the Item Properties on
page 79.

Method To track the distance between two items


1 Click the Browse button of the Tracked distances property.

A dialog opens.
2 Select the Add button.

3 Select the distance tracking element to display its properties.

84
ControlDesk Instrument Handling May 2024
3-D Viewer Handling

4 Specify the first item via the First item property.

5 Specify the second item via the Second item property.

6 If required, you can specify the name and the properties of the distance line.
Refer to Distance Tracking Properties on page 469.
7 Close the dialog.

85
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Result The distance between both items is displayed in the 3-D environment.

Related topics Basics

Basics of Handling the 3-D Viewer............................................................................................ 55

HowTos

How to Add an Item and Configure the Item Properties ........................................................... 79

References

3-D Viewer............................................................................................................................. 303


Distance Tracking Properties................................................................................................... 469

How to Work with Item Templates

Objective You can create a template of an item. The template can be used to save the
properties of an item to add more items with the same properties later.

Basics of item templates After adding an item and configuring its properties, you can create a template of
this item. By default, the template has the same properties as the item.

Note

If a variable is connected to a property of the item, the corresponding


property of the template is not connected to the variable as well. Instead,
the property of the template is specified by the value the variable had when
the template was created.

After you created a template, you can add new items according to the template
to create exact copies of the item. Configuring the properties of a template

86
ControlDesk Instrument Handling May 2024
3-D Viewer Handling

affects only the properties of items created after the changes to the template
were made.

Precondition At least one item must have been added to the 3-D Viewer. Refer to How to Add
an Item and Configure the Item Properties on page 79.

Method To work with item templates


1 Click the Browse button of the Items property.

A dialog opens.
2 Select the item for which you want to create a template.

87
May 2024 ControlDesk Instrument Handling
Basics and Instructions

3 Click the Create button of the Template property.

4 Close the dialog.


5 To configure the properties of the template, click the Browse button of the
Templates property.

A dialog opens.
6 Select the template whose properties you want to configure.

7 Select the properties and configure them according to your needs.


8 Close the dialog.

88
ControlDesk Instrument Handling May 2024
3-D Viewer Handling

Result You created a template of an item and configured the properties of the
template.

Next steps If you add a new item to the 3-D Viewer, you can now select the template. Refer
to How to Add an Item and Configure the Item Properties on page 79.

Related topics Basics

Basics of Handling the 3-D Viewer............................................................................................ 55

HowTos

How to Add an Item and Configure the Item Properties ........................................................... 79

References

3-D Viewer............................................................................................................................. 303

Basics of Group Items

Introduction You can use group items to display multiple items with just one one-dimensional
variable array per property. There are two types of group items:
§ Cuboid group
§ Rectangle group

For example, you can visualize the position of multiple cars by adding a cuboid
group to the 3-D Viewer and connecting the Position and Rotation properties
of the cuboid group to one-dimensional variable arrays.

Tutorial video
Working With Group Items

This video shows you how to work with group items.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/EggaR

89
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Connecting variables You can connect one-dimensional variable arrays to the properties of the group
item. The number of displayed cuboids or rectangles is equal to the length of
the variable array. If no variable is connected, no cuboid or rectangle is displayed.
Any property not connected to a variable array is identical for every cuboid or
rectangle displayed by the group item. These properties can be configured via
the Items dialog.

For more information, refer to Overview of Possible Variable Connections on


page 67.

Related topics Basics

Basics of Handling the 3-D Viewer............................................................................................ 55


Overview of Possible Variable Connections............................................................................... 67

Examples

Example of Using the 3-D Viewer............................................................................................. 71

Basics of Surfaces

Introduction You can use surfaces to display shapes in the 3-D Viewer. For example, you can
use a surface to display a landscape. You can also display the values of one or
more variables as a three-dimensional chart.

Specifying the shape of the You can specify the shape of the surface by specifying the following properties:
surface § x-axis
§ z-axis
§ Function values

Connect one-dimensional arrays to the x-axis and z-axis properties to specify the
number and position of axis points along the x- and z-axis. The number of axis
points is equal to the length of the array.

To specify the position of each point along the y-axis, connect a two-dimensional
array to the Function values property. The length of the two-dimensional array
must match the number of axis points along the x- and z-axis.

For more information, refer to Overview of Possible Variable Connections on


page 67.

Example In this example, the x-axis property is connected to an array with a length of
4 and the z-axis property to an array with a length of 3. The Function values
property is connected to an array with the dimension [4][3].

90
ControlDesk Instrument Handling May 2024
3-D Viewer Handling

You can specify the shape of the surface using the following instrument script ,
where Instr is the path of a 3-D Viewer instrument with a surface item.
Instr.Items.Surfaces[0].XAxis.Value = [5,10,15,20]
Instr.Items.Surfaces[0].ZAxis.Value = [5,10,15]
Instr.Items.Surfaces[0].FunctionValues.Value = [[1,1,1],[2,2,2],[2,6,6],[2,4,5]]

10 FunctionValues.Value =
[[1,1,1],[2,2,2],[2,6,6],[2,4,5]]
30

20 ZAxis.Value = [5,10,15]

0 10

0
30

20

10
XAxis.Value = [5,10,15,20]

Related topics Basics

Basics of Handling the 3-D Viewer............................................................................................ 55


Overview of Possible Variable Connections............................................................................... 67

References

Items and Templates Properties............................................................................................... 481

Example of Using an Instrument Script with the 3-D Viewer

Introduction The following example is based on the Instrumentation Demo. The example
visualizes the vertical movement of a mass connected to a spring.

The goal of this example is to show how to change item properties using an
instrument script . The movement of items in this example is not related to the
value change of connected variables, but is calculated by the instrument script
that is added to a Push Button.

91
May 2024 ControlDesk Instrument Handling
Basics and Instructions

The following illustration shows the result of the demo (for an animated graphic,
refer to dSPACE Help).

Instruments The example uses the following instruments. Both instruments are combined in
an instrument group.

Push Button The Push Button has a button labeled Start/Stop Simulation
to start or stop the simulation.
An instrument script is added to the Push Button. When you click the button, the
instrument script is executed.

3-D Viewer The 3-D Viewer visualizes the anchor, the spring and the mass.

Object Item Type Description


Anchor Cuboid Because the anchor does not move, the item properties
are defined once by the instrument script and are not
altered afterwards.
Spring Point Line The spring is hanging from the anchor. For every
simulation step, the new positions of the points are
calculated by the instrument script.
Mass Point Line The mass is represented by a point line with only one
point. For every simulation step, the new position of the
point is calculated by the instrument script.

92
ControlDesk Instrument Handling May 2024
3-D Viewer Handling

Starting the simulation When you click the Start/Stop Simulation button, the ButtonClicked event
occurs and the OnButtonClicked function is executed.

For more information on the event, refer to PushButtonInstrumentsEvents /


IViPushButtonInstrumentsEvents <<EventInterface>> (ControlDesk
Automation ).

The following script is executed as a part of the OnButtonClicked function.


if self.simulation_timer is None and self.demo_instrument is not None:
self.simulation_init()
self.simulation_timer = SimulationTimer(self.simulation_step, self.update_interval)
self.simulation_timer.start()

If no simulation is running, a SimulationTimer object is created with the


simulation_step function and the update_interval as parameters.

According to the following script, a thread is started to execute the run function.
class SimulationTimer(Thread):
(…)
def __init__(self, func, interval):
"""Initialize the timer.
func: the function called by the timer
interval: the interval in seconds between function calls
"""
Thread.__init__(self)
self.func = func
self.interval = interval
self.finished = Event()
self.daemon = True
def cancel(self):
"""Cancel the timer.
"""
self.finished.set()
def run(self):
"""Run the timer.
"""
pythoncom.CoInitialize()

while True:
self.finished.wait(self.interval)
if self.finished.is_set():
break

self.func()

pythoncom.CoUninitialize()

Refer to Multithreaded Scripting (ControlDesk Automation ).

As a result, the simulation_step function is called repeatedly. The parameter


update_interval specifies the time period between the steps.

Single simulation step As part of a single simulation step, the simulation_step function is called to
calculate the vertical displacement of the mass relative to the default position.
The simulation_step function calls the set_values function to calculate
the positions of the spring and the mass depending on the displacement
length_delta.

93
May 2024 ControlDesk Instrument Handling
Basics and Instructions

simulation_step The simulation_step function calculates the


displacement of the mass. To calculate the positions of the spring and the mass,
the set_values function is called. Depending on the number of steps, the
damping_increment is calculated, or the simulation is canceled if the end of
the simulation is reached.
def simulation_step(self):
(…)
#Calculate the displacement of the mass relative to the default position
length_delta = math.sin(self.step_angle) * self.spring_length_max_delta * self.damping_factor
#Calculate the positions of the spring and the mass
self.set_values(length_delta)
#Calculate the damping for the next simulation step or cancel the simulation
self.step_angle += self.step_angle_increment

if self.step <= self.step_count:


self.damping_factor += self.damping_increment
self.step += 1

elif self.step <= 2 * self.step_count:


self.damping_factor -= self.damping_increment
self.step += 1

else:
self.simulation_timer.cancel()
self.simulation_timer = None

set_values The set_values function calculates the positions of the points


for the spring and the mass for a given length_delta displacement. The
position values of the points are added to a set of arrays. When all positions
are calculated, the arrays are used to add the points to the point lines.
@locking
def set_values(self, length_delta):
(…)
demo = self.demo_instrument
(…)

spring = demo.Items.PointLines[0]
mass = demo.Items.PointLines[1]
# Remove the points of the spring and the mass
spring.Points.Clear()
mass.Points.Clear()
# Define arrays to save the positions of the spring points
spring_x = []
spring_y = []
spring_z = []
# Define various helpful variables
spring_end_y = self.spring_length_base_position + length_delta
point_count = math.floor((2 * math.pi * self.windings_count) / self.spring_angle_increment)

y_value = self.spring_ypos_anchor
y_increment = (self.spring_ypos_anchor - spring_end_y) / point_count
spring_angle = 0
spring_radius = 1

94
ControlDesk Instrument Handling May 2024
3-D Viewer Handling

# Calculate the positions of the spring points and add them to the arrays
for i in range(point_count):
spring_x.append(math.sin(spring_angle) * spring_radius)
spring_y.append(y_value)
spring_z.append(math.cos(spring_angle) * spring_radius)

spring_angle += self.spring_angle_increment
y_value -= y_increment
# Add two additional points to the spring
spring_x.append(0)
spring_z.append(0)
spring_y.append(spring_y[-1])

spring_x.append(0)
spring_z.append(0)
spring_y.append(spring_y[-2] - 2)
# Define arrays to save the position of the mass
mass_x = [0]
mass_y = [spring_y[-1] - .4]
mass_z = [0]
# Use the arrays to add the points to the spring and the mass
spring.Points.AddRange(spring_x, spring_y, spring_z)
mass.Points.AddRange(mass_x, mass_y, mass_z)

Avoid item flickering via When you start the simulation using the previously shown instrument script, the
locking decorator spring and the mass flicker.

While calculating the position values for the items, there is a brief period of time
when all position values are cleared and both point lines are not visible. The
repeated appearance and disappearance of the point lines lead to flickering. To
fix this, the locking decorator is defined to lock the instrument until the new
points are added. The locking decorator is applied to the set_values function.
Whenever the function is called, the 3-D Viewer will lock before executing the
function and unlock afterwards.
def locking(func):
(…)
def wrapper(*args, **kwargs):
self_obj = args[0]
instr = self_obj.demo_instrument

try:
instr.Lock()
func(*args, **kwargs)
finally:
instr.Unlock()

return wrapper

Stopping the simulation When you click the Start/Stop Simulation button while a simulation is running,
the following script is executed as a part of the OnButtonClicked function.
elif self.simulation_timer is not None:
self.simulation_timer.cancel()
self.simulation_timer.join()
self.simulation_timer = None
self.set_values(0)

95
May 2024 ControlDesk Instrument Handling
Basics and Instructions

The script cancels the simulation thread and resets the spring and the mass to
their default position.

Result To simulate a mass hanging from a spring, an instrument script is added to a


Push Button. When you click a button, the instrument script is executed.
§ When you click the Start/Stop Simulation button while no simulation is
running, the script starts a thread to repeatedly calculate new positions for
two point lines representing the mass and the spring. When the simulation is
finished, the simulation thread is canceled.
§ When you click the Start/Stop Simulation button while a simulation is
running, the script cancels the simulation thread and resets the spring and
the mass to their default position.

Related topics Basics

Basics of Handling the 3-D Viewer............................................................................................ 55


Instrumentation Demo (ControlDesk Introduction and Overview )

Examples

Example of Using the 3-D Viewer............................................................................................. 71

References

3-D Viewer............................................................................................................................. 303

Videos

Changing the Camera Distance via an Instrument Script (2:24) in dSPACE Help

96
ControlDesk Instrument Handling May 2024
Browser Handling

Browser Handling
Introduction The Browser lets you display HTML, TXT, and PDF files.

Where to go from here Information in this section

Basics on Handling the Browser............................................................... 97


The Browser lets you display HTML and TXT files. It also supports
Microsoft Internet Explorer plug-ins that are installed on your system.

How to Configure the Browser................................................................ 99


You can change the Browser settings, for example, the URL of the start
page, via the instrument properties.

How to Visualize GNSS Positioning Data in a Map................................... 99


You can visualize positioning data from a GNSS device in a Map
instrument .

Basics on Handling the Browser

Introduction The Browser lets you display HTML and TXT files. It also supports Microsoft
Internet Explorer© plug-ins that are installed on your system.

Properties of the Browser The Browser provides a number of properties in the Properties pane. Some
example settings are described below.

97
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Displaying various file types The Browser can display HTML and TXT files.
§ Browser displaying HTML content:

Hiding Browser elements You can hide elements of the Browser such as its
toolbar.

Disable links If you want to prevent the user from moving to other pages
you can disable all the links on a page.

File archive You can add various files, such as HTML files including Java
Script, to the Browser's file archive. The files are saved with the Browser and are
also available if you add the Browser as a custom instrument to a category in the
Instruments Selector.

Connection of variables You can connect variables to a Browser by


specifying one or more connection nodes and then dragging variables to the
instrument. If you combine the connected variables with code stored in the
file archive (HTML, Java Script, JSON, etc.), you can create custom browser
instruments with web controls.
The Map instrument is an example for a customized Browser instrument using
connected variables and code in the file archive. Refer to How to Visualize GNSS
Positioning Data in a Map on page 99.

Related topics HowTos

How to Configure the Browser................................................................................................. 99


How to Visualize GNSS Positioning Data in a Map.................................................................... 99

References

Browser.................................................................................................................................. 312

98
ControlDesk Instrument Handling May 2024
Browser Handling

How to Configure the Browser

Objective You can change the Browser settings, for example, the URL of the start page, via
the instrument properties.

Method To configure the Browser


1 From the context menu of the Browser, select Instrument Properties.
ControlDesk activates the Properties pane and displays the properties of the
selected Browser.

2 Select the properties and configure them according to your needs.

Result The Browser's settings are changed.

Related topics Basics

Basics on Handling the Browser................................................................................................ 97

References

Browser.................................................................................................................................. 312

How to Visualize GNSS Positioning Data in a Map

Objective You can visualize positioning data from a GNSS device in a Map
instrument .

99
May 2024 ControlDesk Instrument Handling
Basics and Instructions

The Map instrument offers prepared connection nodes for you to connect
variables with GNSS positioning data.

Visualization of satellite In order to also obtain status information on the satellite connection
status information during a running measurement, you can visualize the Status/Quality,
Status/Satellites, and Status/Status variables in a suitable instrument,
e.g., a Variable Array. They provide information on the quality of the satellite
fix, the number of satellites currently in use, and whether the receiver has valid
values. The satellite fix indicates the quality of the signal, i.e., the accuracy and
reliability of the location being reported.

Precondition To receive GNSS positioning data , add a GNSS device to the experiment.

For instructions on configuring the device, refer to How to Configure a GNSS


Device (ControlDesk Platform Management ).

Method To visualize GNSS positioning data in a Map


1 From the Instrument Selector, select a Map instrument from the Browser
Samples category and drag it onto a layout.

2 In the Variables pane select the GNSS variable description and drag the
following variables to the Map:
§ Position/Latitude
§ Position/Longitude
§ Position/Heading

Note

The availability of the Heading variable depends on the GNSS


receiver. However, the visualization of GNSS positioning data in a
Map also works without heading information.

100
ControlDesk Instrument Handling May 2024
Browser Handling

Select each of the variables separately, individually drag them to the Map
instrument, and connect them to the related connection node.

After you connected the variables, the Map displays the GNSS position data.
A route can visualize the course already traveled.

101
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Result You visualized GNSS positioning data in a Map.

Tip

§ You can also visualize recorded GNSS positioning data from an MF4 or
GPX file in a Map instrument.
§ MF4 file: You can save a measurement with GNSS positioning data to
an MF4 file in a recording.
§ GPX file: You can import a GPX file to the measurement data folder.
To use the GNSS positioning data, the GPX file must contain time
stamps.
In both cases, open the file in the Measurement Data Pool and connect
the Latitude and Longitude variables to a Map as described in the
instructions above. To navigate through the recording, also connect these
variables to a Time Plotter, and select a time stamp via the time cursor .
Refer to the following illustration (for an animated graphic, refer to
dSPACE Help).

Related topics Basics

Basics on Handling the Browser................................................................................................ 97

References

Import (Measurement Data File) (ControlDesk Measurement and Recording )


Map....................................................................................................................................... 277
Map Properties....................................................................................................................... 495

102
ControlDesk Instrument Handling May 2024
Artificial Horizon Handling

Artificial Horizon Handling


Introduction The Artificial Horizon lets you display the values of the scalar variables for roll and
pitch.

Where to go from here Information in this section

Basics of Handling the Artificial Horizon................................................. 103


The Artificial Horizon lets you display the rotation on both the lateral and
the longitudinal axis of a simulated aircraft to indicate the angle of the
aircraft's pitch and roll.

How to Configure the Artificial Horizon................................................. 108


You can configure the Artificial Horizon to fit your own needs. You can
configure the Artificial Horizon , even if a measurement is running. This
includes the Artificial Horizon's common properties such as the color and
its specific properties such as the center point's position on the x- and
y-axis, to name just a few examples.

Basics of Handling the Artificial Horizon

Introduction The Artificial Horizon lets you display the rotation on both the lateral and the
longitudinal axis of a simulated aircraft to indicate the angle of the aircraft's
pitch and roll.

Roll pointer Zero pointer

Upper sky

Roll scale

Lower sky

Horizon

Aircraft symbol Upper land

Pitch scale

Lower land

103
May 2024 ControlDesk Instrument Handling
Basics and Instructions

The principal elements of the Artificial Horizon are:


§ A horizon view showing the upper/lower land and upper/lower sky, separated
by a horizon line. The movement of the land and sky indicates the position of
the aircraft.
§ An Aircraft symbol.
§ A pitch scale and roll scale with a roll pointer. The pitch scale and the roll scale
rotate in synchronization with the aircraft’s movements.

Longitudinal

Lateral

Pitch
Roll

Pitch and Roll scale The pitch scale and roll scale can be connected with a scalar measurement or a
parameter as the pitch variable or roll variable, respectively.

The pitch scale, roll scale, and horizon rotate in the direction opposite to the roll
of the aircraft. When the aircraft rolls to the right, they rotate to the left, and
vice versa.

Displaying the pitch angle The pitch does not represent the actual pitch
angle of the aircraft in the range 0° ... 360°. The indicated pitch angle differs
from the actual pitch angle.
The scale for displaying the pitch angle (θ) is:
θindicated = θactual for 0° ≤ θactual ≤ 90°
θindicated = 180° − θactual for 90° < θactual ≤ 180°
θindicated = θactual − 180° for 180° < θactual ≤ 270°
θindicated = θactual − 360° for 270° < θactual ≤ 360°

Example The table below shows some examples of the actual pitch or roll
angle and the corresponding indicated angles.

Actual Indicated Pitch Indicated Roll


Pitch/Roll Angle Angle (θindicated) Angle (φindicated)
(θactual/φactual)
0°, 360°, -360° 0° 0°
60°, -300° 60° 60°
90°, -270° 90° 90°1)
120°, -240° 60° 120°1)
180°, -180° 0° 180°1)
240°, -120° 60° 240°1)
270°, -90° 90° 270°1)

104
ControlDesk Instrument Handling May 2024
Artificial Horizon Handling

Actual Indicated Pitch Indicated Roll


Pitch/Roll Angle Angle (θindicated) Angle (φindicated)
(θactual/φactual)
300°, -60° 60° 300°
320°, -40° 40° 320°
1) Angles higher than 60° and lower than 300° are outside of the range of the roll scale.
Roll scale, pitch scale, and horizon are turned, only the roll pointer does not point to
the roll scale anymore.

Horizon The horizon changes position according to the aircraft’s movements.

Level flight The aircraft is in level flight when its wings are aligned with the
horizon. If the ground is above the sky, the aircraft pitched up 180° or down
-180°.

Pitch The aircraft is ascending when its wings are above the horizon and
descending when they are below. The aircraft symbol indicates the pitch angle.
The steeper the aircraft’s ascent, the less ground is visible. The following table
shows some extreme ascending cases and the resulting horizon behavior.

Ascending Angle Horizon Behavior


360° = 0° The aircraft is in level flight with the ground
below the sky.

90° Ground and horizon are invisible or,


depending on the pitch scale division, the
ground appears above the sky.

105
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Ascending Angle Horizon Behavior


180° The aircraft is in level flight but the ground is
above the sky.

270° Sky and horizon are invisible or, depending on


the pitch scale division, the sky appears above
the ground.

The behavior is the same for the sky when the aircraft descends.

Roll The aircraft is rolling to the right when the horizon, the pitch scale, and
the roll scale rotate left. The roll pointer indicates the roll angle. The following
table shows some extreme roll cases and the corresponding horizon behavior.

Roll Angle Horizon Behavior


360° = 0° The aircraft is in level flight with the ground
below the sky.

90° When the aircraft rolls to the right, the horizon is


exactly vertical with the ground on the right and

106
ControlDesk Instrument Handling May 2024
Artificial Horizon Handling

Roll Angle Horizon Behavior


the sky on the left. They are reversed for a left
roll.

180° The aircraft is in level flight with the ground


above the sky.

270° When the aircraft rolls to the left, the horizon is


exactly vertical with the ground on the right and
the sky on the left. They are reversed in case of
right roll.

Pitch and Roll If the aircraft pitches and rolls at the same time, the pitch and
roll behaviors of the horizon are combined.

Example The aircraft pitches up at a 20° pitch angle and rolls right at a 60°
roll angle. As a result the aircraft symbol points at 20° on the pitch scale, the roll
pointer points at 60° on the right side of the roll scale. The ground is to the right
and the sky is to the left of the horizon.

107
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Connectable variable types For an overview on the variable types you can connect to an instrument, refer to
Instruments and the Variable Types they can Visualize on page 37.

Related topics Basics

Instruments and the Variable Types they can Visualize............................................................... 37

References

Artificial Horizon..................................................................................................................... 272

How to Configure the Artificial Horizon

Objective You can configure the Artificial Horizon to fit your own needs. You can
configure the Artificial Horizon , even if a measurement is running. This includes
the Artificial Horizon's common properties such as the color and its specific
properties such as the center point's position on the x- and y-axis, to name just a
few examples.

Method To configure the Artificial Horizon


1 From the context menu of the Artificial Horizon, select Instrument
Properties.

108
ControlDesk Instrument Handling May 2024
Artificial Horizon Handling

ControlDesk activates the Properties pane and displays the properties of the
selected Artificial Horizon.

2 Select the properties and configure them.

Tip

§ Via the buttons below the title bar of the Properties pane, you can:
§ Expand or collapse categories and properties
§ Search and filter the pane content
§ On the Layouting ribbon, click Instruments – Assign Properties to
assign the property settings of shared properties from the currently
selected instrument to the next one you select.

Result The Artificial Horizon properties are changed even if a measurement is running.

Related topics References

Artificial Horizon..................................................................................................................... 272

109
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Gauge Handling
Introduction The Gauge lets you display the values of scalar variables.

Where to go from here Information in this section

Basics of Handling the Gauge................................................................ 110


The Gauge provides a circular scale for measuring variables.

How to Configure the Gauge................................................................ 112


You can configure the Gauge according to your needs, for example,
you can change the color of the background, even if a measurement is
running.

Basics of Handling the Gauge

Introduction The Gauge provides a circular scale for measuring variables.

Caption Indicator

Scale Tic

Label

Band Needle

Connectable variable types For an overview on the variable types you can connect to an instrument, refer to
Instruments and the Variable Types they can Visualize on page 37.

110
ControlDesk Instrument Handling May 2024
Gauge Handling

Properties of the Gauge The Gauge contains a number of properties on the Properties pane. The
following table shows some examples of settings.

Example Description
By default, Automatic sizing is enabled.
The size and number of elements are
automatically adjusted to the available space.
If you disable Automatic sizing, you can
set the positions and number of elements
manually. This must be done carefully,
because it might lead to invisible or
unreadable elements, for example, when the
instrument size is changed.
You can change the minimum and maximum
values of the scale and change the start/stop
angle positions.

You can activate an overflow warning. An


arrow visualizes, that a measured value is
outside the scale.

You can visualize the minimum and


maximum measured values by displaying
indicators.

You can display labels on the instrument.


You can use macros to insert variables, such
as the instrument name.

You can highlight value ranges with colored


bands.

If the needle movement appears unrealistic,


you can enable a smooth animation of the
needle via the variable properties.

111
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Example Description
You can use pictures of real instruments as
background.

All the changes can be made during a running measurement.

You can change various other settings sorted by different categories. Click a
property on the Properties pane and read the short information at the bottom
of the pane. Press F1 or click the header of the short information to get detailed
information on a specific property.

Related topics Basics

Instruments and the Variable Types they can Visualize............................................................... 37

References

Gauge.................................................................................................................................... 332

How to Configure the Gauge

Objective You can configure the Gauge according to your needs, for example, you can
change the color of the background, even if a measurement is running.

Method To configure the Gauge


1 From the context menu of the Gauge, select Instrument Properties.

112
ControlDesk Instrument Handling May 2024
Gauge Handling

ControlDesk activates the Properties pane and displays the properties of the
selected Gauge.

2 Select the properties and configure them.

Tip

§ Via the buttons below the title bar of the Properties pane, you can:
§ Expand or collapse categories and properties
§ Search and filter the pane content
§ On the Layouting ribbon, click Instruments – Assign Properties to
assign the property settings of shared properties from the currently
selected instrument to the next one you select.

Result The Gauge properties are changed even if a measurement is running.

Related topics References

Gauge.................................................................................................................................... 332

113
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Hierarchy Array Handling


Introduction The Hierarchy Array lets you display variables and icons grouped into custom
hierarchy levels using different cell types for visualization.

Where to go from here Information in this section

Basics of Handling the Hierarchy Array................................................... 114


The Hierarchy Array lets you display variables grouped into custom
hierarchy levels using different cell types for visualization.

How to Configure the Hierarchy Array................................................... 116


To configure the Hierarchy Array.

Basics of Handling the Hierarchy Array

Introduction The Hierarchy Array lets you display variables grouped into custom hierarchy
levels using different cell types for visualization, such as Multistate LEDs or
displays.

You can create any number of tabs for the Hierarchy Array, each of which can
contain a different configuration of hierarchy levels and cells.

114
ControlDesk Instrument Handling May 2024
Hierarchy Array Handling

Components of the Hierarchy The following illustration shows the components of the Hierarchy Array.
Array Tab bar

Header row
Row

Column Cell

§ Tab bar: You can create any number of tabs. The tab bar lets you switch
between them.
§ Header rows: Header rows act as headers of hierarchy levels. They can also
contain any number of cells.
§ Rows: Below each header row, you can create any number of rows. Each row
can consist of any number of cells.
§ Cells: Each cell displays information according to its cell type, e.g., a variable
value. For an overview of available cell types, refer to Hierarchy Array on
page 336.

Note

Because header rows and rows are initially empty, they are invisible until you
add cells to them.

Connectable variable types You can connect the following variable types to the Hierarchy Array:
§ Measurement variable
§ Value (variable type)
§ String
§ Calculated variable

115
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Related topics HowTos

How to Configure the Hierarchy Array.................................................................................... 116

References

Hierarchy Array....................................................................................................................... 336

Videos

Handling the Hierarchy Array (4:15) in dSPACE Help

How to Configure the Hierarchy Array

Objective To configure the Hierarchy Array.

Tutorial video
Handling the Hierarchy Array

The Hierarchy Array lets you calibrate scalar parameters and display scalar
measurement variable values. In the instrument, you can group the variable
display freely on different hierarchy levels.

You can select different instrument types to visualize the individual variables,
such as the Alphanumeric Input, Slider, or the Display.

This video shows you how to configure the Hierarchy Array and connect it to
variables.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/Qetax

116
ControlDesk Instrument Handling May 2024
Hierarchy Array Handling

Method To configure the Hierarchy Array


1 On the tab bar, click + to create a new tab.

2 From the Properties pane, click the Browse button of the Selected Tab -
Rows property.
The Rows dialog opens.

3 In the dialog, select Header Row from the list and click Add to create a
new hiearchy level.
To create subordinate rows, select the header row on the left side of the
dialog and click the Rows Browse button in the Properties list. This opens a
new Rows dialog from which you can select the subordinate rows.

Note

A new row is invisible as long as it does not contain any cells.

117
May 2024 ControlDesk Instrument Handling
Basics and Instructions

4 To add cells to a row, select the row in the Rows dialog and click the Browse
button of the Cells property.

ControlDesk opens the Cells dialog.


5 In the Cells dialog, select the cell type you want to add to the row and click
Add.
You can add multiple cells of various types and directly specify their
properties in the Cells dialog.
The following illustration shows an example.

If you want to specify cell settings at a later time or you want to change
settings later on, you can reopen the dialog via the Properties pane: Select
a row and click the Browse button of the Selected Row - Cells property.

118
ControlDesk Instrument Handling May 2024
Hierarchy Array Handling

6 Repeat steps 3 on page 117 to 5 on page 118 to create as many rows and
cells as you require. Use header rows to create new hierarchy levels.

Tip

§ You can increase the indent of rows and header rows to delineate
the hierarchy levels more clearly. Use the Selected Row - Indent
property for this.
§ You can change the width of columns by clicking and dragging their
borders.
§ Each cell and its connected variables are also displayed in the
Instrument Navigator pane. This is especially useful if there is a
large number of variable connections in the Hierarchy Array and you
are searching for a specific one.

7 Connect variables to cells by dragging them from the Variables pane to the
cells.
Alternatively, open the context menu of a cell and click Variables - Add to
open the Select Variable dialog and select a variable in the dialog.

Result You configured the Hierarchy Array:


§ You created tabs.
§ You created hierarchy levels by adding header rows and subordinate rows and
adding cells to them.
§ You connected variables to the cells.

Tip

You can apply property settings to multiple cells at once.


For an animated graphic, refer to dSPACE Help.

Related topics Basics

Basics of Handling the Hierarchy Array.................................................................................... 114

References

Hierarchy Array....................................................................................................................... 336

Videos

Handling the Hierarchy Array (4:15) in dSPACE Help

119
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Index Plotter Handling


Introduction The Index Plotter lets you display the values of measurement variables in relation
to corresponding event numbers (index plots).

Where to go from here Information in this section

Basics of Handling the Index Plotter....................................................... 120


The Index Plotter lets you display the values of measurement variables in
relation to corresponding event numbers (index plots).

Zooming and Moving the Chart (Index Plotter)...................................... 124


You can switch between different modes to zoom into the chart or move
the chart.

How to Configure the Index Plotter....................................................... 128


You can change the Index Plotter settings, for example, the color of the
signal, even if the measurement is running.

How to Display Curves with Mean, Minimum, and Maximum


Values................................................................................................... 130
You can activate customized downsampling for the Index Plotter to
display specific curves, such as curves with mean, maximum, or minimum
values.

How to Specify a Trigger for the Index Plotter Visualization.................... 132


The Index Plotter visualization can be triggered. This is especially useful
if data acquisition of connected signals was already triggered on the
hardware (triggered measurement).

How to Change Trigger Settings via the Index Plotter............................. 136


You can change the trigger settings in the Measurement
Configuration directly via the Index Plotter.

Basics of Handling the Index Plotter

Introduction The Index Plotter lets you display the values of measurement variables in relation
to corresponding event numbers (index plots).

120
ControlDesk Instrument Handling May 2024
Index Plotter Handling

Index Plotter

Y-axis

Cursor
Chart area (Move mode)

DAQ info
Signal symbol
Show legend

X-axis Legend

Selecting the optimum plotter ControlDesk provides the following plotter types:
type § Time Plotter
§ Index Plotter
§ XY Plotter

For information on selecting the optimum plotter type for your task, refer to
Choosing Between Time Plotter, Index Plotter, and XY Plotter on page 40.

Connections You can place signals on the Index Plotter via drag & drop. The visualization of a
signal/variable in an Index Plotter depends on where you drop it. The destination
is highlighted.

Tutorial video

Sensitive Areas and Adding Signals


This video shows you how to connect signals to different sensitive areas of a
plotter.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/ykTR2

121
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Dropping on the chart area If you drop one or more variables onto the
chart area, a new y-axis is added to the y-axes area for each.

Dropping on a y-axis If you drop one or more variables onto a y-axis, a new
signal is added to the y-axis for each.

Dropping on a signal symbol If you drop a variable onto a signal symbol, it


is connected to the signal. The new connection replaces the existing one.

Connectable variable types For an overview on the variable types you can connect to an instrument, refer to
Instruments and the Variable Types they can Visualize on page 37.

Properties of the Index Plotter The Index Plotter provides a number of properties in the Properties pane. The
following table shows some example settings.

Example Description
The Index Plotter can display y-axes one beside the other in
the complete view or in the scroll view.

The Index Plotter can display the y-axes one below the
other in the stacked view.

You can show/hide the legend via a button.

You can define value ranges for the colors of a multicolor


signal. The signal can be displayed with smooth color
transitions (multicolor interpolation).

122
ControlDesk Instrument Handling May 2024
Index Plotter Handling

Example Description
One or two cursors can be used to specify chart positions.
The positions of the cursors and the distance between
them can be displayed at the cursor info position.

You can show/hide a toolbar via a button. Via the toolbar,


you can easily change cursor and DAQ settings.

You can sort, group, and filter the signals in the Time
Plotter via the column headers of the legend. Right-click
the column headers to open related commands.
To search for a signal, set the focus to the legend and press
Ctrl+F

You can place overlay elements with text or pictures on top


of the signals or underneath.

If the connected variable is converted via a computation


table, the converted values can be displayed on the y-axis.
Ranges can be visualized in the chart.
Refer to Conversion Table Settings Properties (Time
Plotter/Index Plotter) on page 457.

Tutorial videos

Displaying Cursors
This video gives you an overview of how to display plotter cursors.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/hMGh9

123
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Specifying Plotter Signal Settings


This video shows you how to specify plotter signal properties.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/dT6Lq

Related topics Basics

Instruments and the Variable Types they can Visualize............................................................... 37


Zooming and Moving the Chart (Index Plotter)....................................................................... 124

HowTos

How to Change Trigger Settings via the Index Plotter.............................................................. 136


How to Configure the Index Plotter........................................................................................ 128
How to Specify a Trigger for the Index Plotter Visualization..................................................... 132

References

Index Plotter........................................................................................................................... 341

Videos

Comparing Time Plotter, Index Plotter, and XY Plotter (3:41) in dSPACE Help
Specifying Plotter Settings in the Properties Pane (2:41) in dSPACE Help

Zooming and Moving the Chart (Index Plotter)

Introduction You can switch between different modes to zoom into the chart or move the
chart.

124
ControlDesk Instrument Handling May 2024
Index Plotter Handling

Tutorial video
Zooming and Moving

This video shows you how to zoom into the chart area and how to move the
chart.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/srfAv

Zoom mode The chart area and the axes can be set to zoom mode via context menu. The
mouse pointer shows you the active mode.

Mouse Pointer Description


Zoom mode: You can specify the zoom area.

Move mode The chart area and the axes can be set to move mode via context menu. The
mouse pointer shows the active mode.

Mouse Pointer Description


Move mode (chart area): You can move the
chart in the x‑axis and the y‑axis directions.
Move mode (x‑axis): You can move the chart in
the x‑axis direction.
Move mode (y‑axis): You can move the chart in
the y‑axis direction.

Freeze mode Each time you move or zoom the chart during a running measurement, the
Plotter display switches to freeze mode. The visualization is paused and a lock
symbol is displayed at the bottom left of the chart. Measuring and recording is
continued in the background.

125
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Click the lock symbol or double-click the chart area to leave freeze mode (for an
animated graphic, refer to dSPACE Help).

Synchronized x‑axis Via the x‑axis properties, you can activate the synchronization of the x‑axis in
continuous visualization mode. In this case all synchronized Time Plotters share
the same time range and all Index Plotters share the same event range. Zooming
and moving actions then affect all synchronized plotters in the same way.

Zooming and moving the You can use various methods to zoom or move the chart. See the following
chart table.

Mouse Gesture1), 2) Shortcut Key Purpose


Move and zoom mode
– – O2) To show or hide a scroll bar below the x-axis.3)
To navigate through the measurement, drag the scroll box as shown
below.

To specify the zoom settings, drag the edges of the scroll box as shown
below (for an animated graphic, refer to dSPACE Help).

– – M To set the chart view to move mode.


– – Z To set the chart view to zoom mode.
– To rescale the chart.
§ Use the chart to rescale both axes.
§ Use an axis to rescale the selected axis.
Zoom mode
– – To zoom into the chart by dragging the mouse pointer.

– To zoom into the chart.


§ Use the chart area to zoom into both axes.
(Scroll wheel) § Use an axis to zoom into the selected axis.
– To zoom out.
§ Use the chart area to zoom out of both axes.
(Scroll wheel) § Use an axis to zoom out of the selected axis.
Move mode
– To move the chart in any direction (available on the chart area).

126
ControlDesk Instrument Handling May 2024
Index Plotter Handling

Mouse Gesture1), 2) Shortcut Key Purpose


– To move the chart horizontally (available on the x‑axis).

– To move the chart vertically (available on the y‑axis).

Ctrl – – To zoom the axis while you are in move mode (available on the x‑axis
+
and on the y‑axis).
1) If you are using a multi-touch capable display, you can use gestures to zoom or move
the chart.
2) Available only for Time Plotter and Index Plotter.
3) You must stop a running measurement to use the scroll bar. For information on the
scroll bar settings, refer to Scroll Bar Properties (Time Plotter/Index Plotter) on page 527.

Undo, redo, and toggle You can undo and redo zooming and moving. You can also activate or deactivate
zooming and moving the zoom. See the following table.

Cursor Toolbar1) Shortcut Key Purpose


Back To undo the most recent zoom or move action.

Shift+Back To redo the most recent undone zoom or move action.

+ To activate or deactivate the zoom.

1) For information on the Cursor Toolbar, refer to Show Toolbar on page 715.

Related topics Basics

Basics of Handling the Index Plotter........................................................................................ 120

References

Index Plotter........................................................................................................................... 341


Navigation – Enable/Disable Move Mode (Time Plotter/Index Plotter)....................................... 679
Navigation – Move Mode (Time Plotter/Index Plotter).............................................................. 680
Navigation – Rescale (Time Plotter/Index Plotter)..................................................................... 681
Navigation – Zoom Mode (Time Plotter/Index Plotter).............................................................. 681
Scroll Bar Properties (Time Plotter/Index Plotter)...................................................................... 527
Show Scroll Bar (Time Plotter/Index Plotter)............................................................................. 715
Show Toolbar......................................................................................................................... 715

127
May 2024 ControlDesk Instrument Handling
Basics and Instructions

How to Configure the Index Plotter

Objective You can change the Index Plotter settings, for example, the color of the signal,
even if the measurement is running.

Tutorial video
Specifying Plotter Settings in the Properties Pane

This video shows you how to specify plotter settings in the Properties pane.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/Md5Tr

Index Plotter properties The Index Plotter provides a number of properties on the Properties pane. Some
of them can also be set via the Index Plotter's context menu. Some examples are
listed below.

You can change settings for the axes of the Index Plotter, for example:
§ Scaling mode (Floating, Extended, Fixed)
§ Tic format (Standard, Exponential, Scientific)
§ Minimum and maximum values of the axis, if Scaling mode is set to Fixed.

You can change settings for the curves, for example:


§ Line width for a curve (in pixels)
§ Point size for a curve (in pixels)

The changes can be made during a running measurement.

You can change various other settings sorted by different categories. Click a
property on the Properties pane and read the short information at the bottom
of the pane. Press F1 or click the header of the short information to get detailed
information on a specific property.

Method To configure the Index Plotter


1 From the context menu of the Index Plotter, select Instrument Properties.

128
ControlDesk Instrument Handling May 2024
Index Plotter Handling

ControlDesk activates the Properties pane and displays the properties of the
selected Index Plotter.

The listed properties depend on the element that is selected in the


instrument. In the Index Plotter, you can select the following elements:
§ X-axis
§ Y-axis
§ Signal symbol
2 Select the properties and configure them according to your needs.

Tip

§ Via the buttons below the title bar of the Properties pane, you can:
§ Expand or collapse categories and properties
§ Search and filter the pane content
§ On the Layouting ribbon, click Instruments – Assign Properties to
assign the property settings of shared properties from the currently
selected instrument to the next one you select.

Result The Index Plotter's settings have been changed.

Related topics Basics

Basics of Handling the Index Plotter........................................................................................ 120


Zooming and Moving the Chart (Index Plotter)....................................................................... 124

References

Index Plotter........................................................................................................................... 341

129
May 2024 ControlDesk Instrument Handling
Basics and Instructions

How to Display Curves with Mean, Minimum, and Maximum Values

Objective You can activate customized downsampling for the Index Plotter to display
specific curves, such as curves with mean, maximum, or minimum values.

Visualization downsampling The Index Plotter uses visualization downsampling to control the amount of
visualized data for the displayed signals. The measured data is downsampled
by defining an interval of data points. All measured data points in this
downsampling interval are represented by the visualized data points, such as
the mean value or the maximum value in the interval.

Note

The settings for a visualization downsampling do not influence the amount


of measured or recorded data but only the visualization of the data in the
instrument (no DAQ downsampling).

The following table shows some examples:

Signal Description
Original signal

Visualization downsampling
§ Downsampling interval: 5 data
points
§ Minimum and maximum value
in each interval

Visualization downsampling
§ Downsampling interval: 5 data
points
§ Mean value in each interval

Automatic downsampling The Index Plotter performs an automatic visualization downsampling to ensure
a high performance even if a large amount of data is measured. All measured
data points in the downsampling interval are represented by two signal values:
the minimum and the maximum value in the interval.

130
ControlDesk Instrument Handling May 2024
Index Plotter Handling

The Index Plotter computes an optimum time interval that matches the following
conditions:
§ The visualized signal looks like the original signal, irrespective of the reduction
of data points.
§ Extreme values are displayed.

Customized downsampling You can activate customized downsampling for a signal to set the number of
data points of the downsampling interval manually and to display minimum,
maximum, and mean values. See the following examples:

Min/Max

Min

Max

Mean

Mean value curves and A special use case is to display signals with mean value curves and envelopes.
envelopes See the following example:

Method To display curves with mean, minimum, and maximum values


1 Right-click the chart area of the Index Plotter.

131
May 2024 ControlDesk Instrument Handling
Basics and Instructions

2 From the context menu, select Axes/Signals – Properties.


The Axes/Signals dialog opens.

3 In the axes and signals tree, select the signal you want to configure.
4 In the Properties list, select Custom downsampling.
The downsampling properties are now displayed.

5 Specify Display mode and Interval (in data points) to configure the
downsampling settings according to the desired curve.
6 Click OK to confirm your settings and close the dialog.

Result You changed the visualization downsampling settings to display a curve with
mean, minimum, or maximum values.

Related topics References

Axes and Signals Properties (Time Plotter/Index Plotter)........................................................... 422

How to Specify a Trigger for the Index Plotter Visualization

Objective The Index Plotter visualization can be triggered. This is especially useful if
data acquisition of connected signals was already triggered on the hardware
(triggered measurement).

132
ControlDesk Instrument Handling May 2024
Index Plotter Handling

Triggering the Index Plotter In ControlDesk, you can trigger the visualization of Index Plotter data. You must
visualization specify a start and a stop trigger for the plotter visualization for this.

Tip

To trigger the plotter visualization, ControlDesk uses the same trigger types
as for triggered measurements. Thus, the platform and duration triggers
defined in the measurement configuration are used to start and stop the
plotter visualization.

If the Time Plotter visualization is triggered, the time axis does not show the
original event numbers of the running measurement, but starts with 0 when the
condition of the start trigger is met. When the condition of the stop trigger is
met, the Plotter visualization is frozen until the start trigger is met again. This is
like the stable visualization typical of a triggered oscilloscope.

By default, a plotter uses the trigger settings from the first connected variable
to display data. You can modify the trigger settings for a plotter visualization
manually.

Note

Triggering the plotter visualization does not affect the data stream to the
plotter, only the visualization of plotter data.

Triggering the Plotter visualization allows you to display only that part of the
data stream that meets the trigger conditions. This can be useful if the data
flow of the connected signals is also triggered, that is, if data acquisition of the
connected signals is triggered on the hardware.

Triggered plotter The following illustrations show how the Index Plotter visualization changes
when the triggered mode is enabled. In both cases the same triggers are
activated for the associated measurement raster, which means that parts of the
signal are transferred to the host PC only if they meet the trigger conditions of
the measurement raster.
§ If the Index Plotter visualization is not triggered (and Multi Capture History
and Auto Repeat are enabled for the triggered measurement raster), the
Index Plotter shows the incoming data stream for the signals continuously,
with the numbered events on the x-axis.

133
May 2024 ControlDesk Instrument Handling
Basics and Instructions

§ If the Index Plotter visualization is triggered (using the same trigger settings as
for the associated measurement raster), only that part of the data stream that
meets the trigger conditions is displayed. The index on the x-axis begins with 0
(if no delay is specified).

In the example, the DAQ info is shown on the right side above the x-
axis. The visualization is refreshed automatically (Auto Repeat) or manually
(pressing the trigger's Start button on the Measurement Configuration
pane) according to the trigger settings.

For more information on the triggering of measurement rasters, refer


to Configuring Triggered Measurement on dSPACE Platforms (ControlDesk
Measurement and Recording ).

Leading raster If the variables that are connected to the Index Plotter are associated to several
measurement rasters, you can select one measurement raster to specify the
trigger settings for the Index Plotter visualization. This raster becomes the leading
raster (indicated by in the Leading column of the Index Plotter legend). The
leading raster determines the event range that is visible in the Index Plotter.

If the first signal you connect to an Index Plotter is assigned to a measurement


raster that has trigger settings, this raster automatically becomes the leading
raster and the Index Plotter is set to triggered mode.

134
ControlDesk Instrument Handling May 2024
Index Plotter Handling

Method To specify a trigger for the Index Plotter visualization


1 If not already done, enable the triggered mode for the Index Plotter
visualization. From the context menu of the chart, select DAQ – Mode –
Trigger Mode.
2 From the context menu of the chart, select DAQ – Mode – Leading Raster
and select the event-based raster that has the DAQ trigger settings you want
to use for the Index Plotter visualization.
The Index Plotter visualization is triggered using the trigger settings of the
selected raster.

You can check the trigger assignment to the Index Plotter via the DAQ
settings properties of the Index Plotter.

Result You have specified a start and a stop trigger for the Index Plotter visualization
and activated the triggered mode.

Related topics Basics

Configuring Triggered Measurement on dSPACE Platforms (ControlDesk


Measurement and Recording )

HowTos

How to Change Trigger Settings via the Index Plotter.............................................................. 136

135
May 2024 ControlDesk Instrument Handling
Basics and Instructions

References

DAQ - Available Raster (Time Plotter/Index Plotter).................................................................. 633


DAQ – Leading Raster (Time Plotter/Index Plotter)................................................................... 634
DAQ – Mode (Time Plotter/Index Plotter)................................................................................ 635
DAQ - Trigger (Time Plotter/Index Plotter)............................................................................... 637
DAQ Properties (Time Plotter/Index Plotter)............................................................................. 462

How to Change Trigger Settings via the Index Plotter

Objective You can change the trigger settings in the Measurement Configuration
directly via the Index Plotter.

Interactive Trigger If you activate Interactive Trigger, you can change trigger settings in the
Measurement Configuration via sliders displayed at the Index Plotter axes.

Autoset Trigger If you activate Autoset Trigger, ControlDesk analyzes the current measurement
to find optimum trigger settings for a periodical signal.

Precondition An Autoset Trigger analysis can be started for each signal in the chart, but
it can find trigger settings only if the signal is periodical. If the analysis is not
successful the previous trigger settings are restored.

Possible methods There are two ways to change the trigger settings via the Index Plotter.
§ Automatically by analyzing the signal. Refer to Method 1.

Automatic Trigger Settings


This video shows you how to use a Time Plotter to configure trigger settings
automatically.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/iT2Fd

§ Interactively by dragging sliders on the Index Plotter axes. Refer to Method 2.

136
ControlDesk Instrument Handling May 2024
Index Plotter Handling

Interactive Trigger Settings


This video shows you how to use a Time Plotter to configure trigger settings
interactively.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/gk4NE

Method 1 To change trigger settings via the Index Plotter automatically by


analyzing the signal
1 In the y-axes area, right-click the symbol of the signal you want to change
the trigger settings for.
2 From the context menu, select DAQ – Trigger – Autoset Trigger.
If no measurement is running, ControlDesk prompts you to start one.
ControlDesk analyzes the running measurement and displays progress
messages in the chart area.

Method 2 To change trigger settings via the Index Plotter interactively by dragging
sliders on the axes
1 In the y-axes area, right-click the symbol of the signal you want to change
the trigger settings for.
2 From the context menu, select DAQ – Trigger – Interactive Trigger.
Three sliders are displayed on the Index Plotter axes.

§ On the y-axis, you can drag a slider to change the trigger value.
§ On the x-axis, you can drag two sliders to change the trigger delay and
the samples/duration settings.

137
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Result You have changed the trigger settings in the Measurement Configuration via the
Index Plotter.

Autoset Trigger example The following illustrations show an example of a successful Autoset Trigger
analysis.
1. Before Autoset Trigger is started:

In the Measurement Configuration, the Sample Count Trigger value


of the active signal (ln2) is set to 8 samples, which results in incomplete
representation of the signal period in the chart.
2. Autoset Trigger is started:

The analysis detects that 8 samples are not enough to display a complete
period of the signal. ControlDesk increases the Sample Count Trigger value
to 5000, which is the Maximum number of analyzed data points as
defined in the Advanced settings dialog of the Index Plotter properties.

138
ControlDesk Instrument Handling May 2024
Index Plotter Handling

This dialog also specifies to display 3 complete periods of the signal in the
chart.
3. The Autoset Trigger analysis is successful and detects a frequency of 10
samples for one complete signal period.

The Sample Count Trigger value is set to 30 samples to display 3 complete


periods.

Related topics Basics

Configuring Triggered Measurement on dSPACE Platforms (ControlDesk


Measurement and Recording )

HowTos

How to Specify a Trigger for the Index Plotter Visualization..................................................... 132

References

Index Plotter........................................................................................................................... 341

139
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Invisible Switch Handling


Introduction The Invisible Switch lets you calibrate the values of scalar parameters.

Where to go from here Information in this section

Basics of Handling the Invisible Switch................................................... 140


The Invisible Switch can be configured as an On/Off Button, as a Push
Button or as a Check Button. You can use it to define a sensitive area on
a realistic picture.

How to Use the Invisible Switch............................................................. 141


You can position Invisible Switches on pictures to simulate realistic
appearances.

Basics of Handling the Invisible Switch

Introduction The Invisible Switch is an invisible instrument that can be configured as an


On/Off Button, a Push Button or a Check Button. It can be positioned,
for example, on a Frame with a background picture. Since the instrument
is invisible, positioning it on a background picture allows you to create a
realistic environment with sensitive areas, each of which behaves like a button
instrument. As with the other button instruments, you can enter an Off and On
value.

Basics Edit mode To configure and locate the instrument, you have to enable the
edit mode. The Invisible Switch is displayed as a blue square when the edit mode
is enabled. When you calibrate the connected variable(s) on the Invisible Switch,
you must disable the edit mode.

Switch mode Via the switch mode property, you can. configure the Invisible
Switch as an invisible On/Off Button, Push Button or Check Button instrument.
For detailed information on the instruments, refer to Invisible Switch on
page 346.

Example of the Invisible Switch The following illustration shows three


Invisible Switches on a frame with a dashboard as the background picture. When
you click the area containing the Invisible Switch, a predefined value is written to
the connected variable. For details on using the Invisible switch, refer to How to
Use the Invisible Switch on page 141.

140
ControlDesk Instrument Handling May 2024
Invisible Switch Handling

Related topics References

Invisible Switch....................................................................................................................... 346

How to Use the Invisible Switch

Objective You can position Invisible Switches on pictures to simulate realistic appearances.

Method To use the Invisible Switch


1 From the Instrument Selector, drag a Frame to the layout.
2 In the Properties pane, select the Frame's Visible checkbox in the
Background - Picture properties group and specify a file which contains
a background picture in the Picture Path property.
ControlDesk displays the specified picture on the Frame.
3 From the Instrument Selector, drag an Invisible Switch to the Frame.
The Invisible Switch is placed on the frame and indicated by blue corners.
The following illustration shows a Frame with a picture of a tachometer, and
an Invisible Switch positioned on the Frame as an example.

141
May 2024 ControlDesk Instrument Handling
Basics and Instructions

4 In the Properties pane, select the Edit Mode checkbox.


The Invisible Switch is displayed as a blue rectangle.

5 From the Variables pane, drag a parameter to the Invisible Switch.


The selected parameter is connected to the Invisible Switch.
6 Resize and position the Invisible Switch on a suitable part of the Frame,
select a switch mode and specify the On and Off values of the simulated
button in the Properties pane.
7 In the Properties pane, clear the Edit Mode checkbox.
The Invisible Switch is indicated by blue corners. When you click the area
outside of the Invisible Switch, the blue corners disappear.

8 Click , or press Ctrl+Alt+F8 to activate the working page.


9 Click the Invisible Switch to write the specified value to the connected
variable.

Result The Invisible Switch is placed on a certain part of the Frame and the value of the
connected parameter is changed.

Related topics References

Invisible Switch....................................................................................................................... 346

142
ControlDesk Instrument Handling May 2024
Knob Handling

Knob Handling
Introduction The Knob lets you calibrate the values of scalar parameters.

Where to go from here Information in this section

Basics of Handling the Knob.................................................................. 143


The Knob provides a circular scale with a knob for calibrating a
parameter.

How to Configure the Knob.................................................................. 145


You can configure the knob according to your needs. For example, you
can change its appearance, even if a measurement is running.

How to Change Values with the Knob................................................... 146


The knob lets you calibrate the values of numeric parameter.

Basics of Handling the Knob

Introduction The Knob provides a circular scale with a knob for calibrating a parameter.

Caption

Indicator Knob

Scale
Tic

Label

Mark Band

Connectable variable types For an overview on the variable types you can connect to an instrument, refer to
Instruments and the Variable Types they can Visualize on page 37.

143
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Properties of the Knob The Knob provides a number of properties in the Properties pane. The following
table shows some example settings.

Example Description
By default, Automatic sizing is enabled for
the Knob. The size and number of elements
are automatically adjusted to the available
space.
If you disable Automatic sizing, you can
set the positions and number of elements
manually. This must be done carefully,
because it might lead to invisible or
unreadable elements, for example, when the
instrument size is changed.
You can change the value range of the scale
and change the appearance of the Knob
(size, style, shape, and color).

You can change the settings of the start and


stop angle.

You can display labels on the instrument.


You can use macros to insert variables, such
as the parameter name.

You can highlight value ranges with colored


bands.

Scale angle > 360° You can specify a scale angle greater than 360°. If you move the mark and pass
360°, 720°, and so on, the appropriate part of the scale is displayed immediately.

The example shows a knob with a scale angle from 0 to 1070°. This angle
setting results in 3 scale parts: 0-33.5, 33.5-67.5, and 67.5-100.

0-33,5 360° 33,5-67,5 720° 67,5-100

144
ControlDesk Instrument Handling May 2024
Knob Handling

Related topics Basics

Instruments and the Variable Types they can Visualize............................................................... 37

References

Knob...................................................................................................................................... 347

How to Configure the Knob

Objective You can configure the Knob according to your needs. For example, you can
change its appearance, even if a measurement is running.

Method To configure the Knob


1 From the context menu of the Knob, select Instrument Properties.
ControlDesk activates the Properties pane and displays the properties of the
selected Knob.

145
May 2024 ControlDesk Instrument Handling
Basics and Instructions

2 Select the properties and configure them according to your needs.

Tip

§ Via the buttons below the title bar of the Properties pane, you can:
§ Expand or collapse categories and properties
§ Search and filter the pane content
§ On the Layouting ribbon, click Instruments – Assign Properties to
assign the property settings of shared properties from the currently
selected instrument to the next one you select.

Result The Knob's settings are changed.

Related topics Basics

Basics of Handling the Knob................................................................................................... 143

References

Knob...................................................................................................................................... 347

How to Change Values with the Knob

Objective The Knob lets you calibrate the values of a numeric parameter.

Preconditions A parameter must be assigned to the instrument. Refer to How to Connect


Variables and Framework Labels to Instruments (ControlDesk Layouting ).

The working page must be activated. Refer to How to Activate the Working or
Reference Page (ControlDesk Calibration and Data Set Management ).

Possible methods § To change values using the mouse, refer to Method 1.


§ To change values using the keyboard, refer to Method 2.

Method 1 To change values with the Knob


1 Click the Knob.
2 Hold down the left mouse button to move the mark along the scale.
3 Release the left mouse button at the desired position.

146
ControlDesk Instrument Handling May 2024
Knob Handling

Method 2 To change values with the Knob using the keyboard


1 Select a Knob.
2 Press the Up or Down key to change the value using small increments. Press
the Ctrl key when changing a value to use big increments.
To specify small and big increments, select Adjust values – Increments from
the row's context menu.

Result The parameter value is changed.

Related topics HowTos

How to Configure the Knob................................................................................................... 145

References

Knob...................................................................................................................................... 347

147
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Multiswitch Handling
Introduction The Multiswitch lets you calibrate the values of scalar parameters using mouse-
sensitive areas.

Where to go from here Information in this section

Basics of Handling the Multiswitch........................................................ 148


The Multiswitch lets you define sensitive areas that can be clicked to
change a value. It also can display different background pictures for
different variable states.

How to Configure the Multiswitch......................................................... 151


You can configure the Multiswitch according to your needs. For example,
you can change the shape of the mouse-sensitive areas.

How to Change Values with the Multiswitch......................................... 153


The Multiswitch lets you set a numeric parameter to predefined values
via sensitive areas that react like buttons.

Basics of Handling the Multiswitch

Introduction The Multiswitch lets you define sensitive areas that can be clicked to change
a value. It also can display different background pictures for different variable
states.
Edit mode disabled Edit mode enabled

Toolbox

Raster

State picture Sensitive area

Connectable variable types For an overview on the variable types you can connect to an instrument, refer to
Instruments and the Variable Types they can Visualize on page 37.

148
ControlDesk Instrument Handling May 2024
Multiswitch Handling

Properties of the Multiswitch The Multiswitch provides a number of properties in the Properties pane. Some
example settings are described below.

Defining sensitive areas You can use different rasters to define the sensitive
areas of the instrument. As an alternative, you can draw shapes with the mouse.
In the Edit mode of the instrument, the sensitive areas are visible and can be
changed.

Toolbox If the instrument is in Edit mode, a toolbox can be displayed in it.

Via the toolbox, you can easily change raster settings such as the current raster
type and the number of raster cells. The arrow button in the left corner allows
you to close (and open) the toolbox.

Sensitive areas, states, and background pictures Each sensitive area is


connected to a state.

The illustration above shows the background picture for state 1: Gear_1.bmp. If
you click the sensitive area for state 6 (shown as a filled rectangle), the variable
gets the value 7. All values between 7 and 8 (not including 8 itself) specify
Gear_6.bmp as the background picture. It is displayed immediately.

149
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Multiswitch in On-Off mode The illustration below shows a Multiswitch in


On-Off mode.

State 0 Off-Value State 1


Range [1-2) – Range [2-3)
Write value = 1 Write value = 0 Write value = 2

§ If the variable value matches the range of a state, the assigned picture is
displayed.
§ If you click a sensitive area (marked by dashed lines here), the write value
assigned to the state remains set while you hold the mouse button down.
§ If you release the button, the picture assigned to the off-value is displayed.

Multiswitch in Push mode The illustration below shows a Multiswitch in


Push mode.

State 0 State 1 State 2


Range [1-2) Range [2-3) Range [3-4)
Write value = 1 Write value = 2 Write value = 3

§ If the variable value matches the range of a state, the assigned picture is
displayed.
§ If you click a sensitive area (marked by dashed lines here), the write value
assigned to the state is written to the connected variable.

Specifying values for the You can specify how the sensitive areas react when they are clicked.
sensitive areas
Write Mode Description
Push button The value of the connected parameter is set to
a predefined value when you click a sensitive
area.
On/Off mode The value of the connected parameter is set to
a predefined value when you click a sensitive
area (on-value) and to another predefined
value when you release it (off-value).
Check mode The value of the connected parameter is
set to a predefined value when you activate
a sensitive area (on-value) and to another
predefined value when you clear it (off-value).
Increase/Decrease The value of the connected parameter is
mode incremented/decremented by a predefined
value when you click the area. You can define

150
ControlDesk Instrument Handling May 2024
Multiswitch Handling

Write Mode Description


a large increment that is used if you hold the
mouse button down.

Related topics Basics

Instruments and the Variable Types they can Visualize............................................................... 37

HowTos

How to Change Values with the Multiswitch.......................................................................... 153


How to Configure the Multiswitch.......................................................................................... 151

References

Multiswitch............................................................................................................................ 354

How to Configure the Multiswitch

Objective You can configure the Multiswitch according to your needs. For example, you
can change the shape of the mouse-sensitive areas.

Method To configure the Multiswitch


1 From the context menu of the Multiswitch, select Instrument Properties.

151
May 2024 ControlDesk Instrument Handling
Basics and Instructions

ControlDesk activates the Properties pane and displays the properties of the
selected Multiswitch.

2 Select the properties and configure them according to your needs.

Tip

§ Via the buttons below the title bar of the Properties pane, you can:
§ Expand or collapse categories and properties
§ Search and filter the pane content
§ On the Layouting ribbon, click Instruments – Assign Properties to
assign the property settings of shared properties from the currently
selected instrument to the next one you select.

Result The settings of the Multiswitch are changed.

Next steps For the Multiswitch, the writing of values is inseparable from the configuring
of sensitive areas. For more details, refer to How to Change Values with the
Multiswitch on page 153.

Related topics Basics

Basics of Handling the Multiswitch......................................................................................... 148

152
ControlDesk Instrument Handling May 2024
Multiswitch Handling

HowTos

How to Change Values with the Multiswitch.......................................................................... 153

References

Multiswitch............................................................................................................................ 354

How to Change Values with the Multiswitch

Objective The Multiswitch lets you set a numeric parameter to predefined values via
sensitive areas that react like buttons.

Preconditions § The working page must be activated. Refer to How to Activate the Working or
Reference Page (ControlDesk Calibration and Data Set Management ).

Method To change values with the Multiswitch


1 Place a Multiswitch on a layout and connect it to a scalar parameter. The
instrument is displayed in Edit mode.

2 From the context menu of the Multiswitch, select Instrument Properties


and on the Properties pane, specify a Default state picture for the
instrument.
The default state picture is displayed if the value of the connected parameter
does not match any of the ranges of the sensitive areas you will define in the
next steps.
If the Multiswitch displays a yaw trim switch, for example, the default state
picture can look like this:

You must disable the Edit mode to see the default state picture in the
instrument.
3 Select a Push mode for the instrument.
The columns of the States table are tailored to the selected push mode.

153
May 2024 ControlDesk Instrument Handling
Basics and Instructions

If you select the On/Off mode or Check mode, the property list displays an
Off-value property.
4 In the States table, specify a state picture for State[0].
The example shows a yaw trim switch turned to the left.

5 In the instrument's Edit mode, change the raster settings according to your
needs and click all the segments you want to use as sensitive areas for
State[0].

Tip

You can activate Toolbox expanded to change the raster settings via a
toolbox in the instrument. Another way to open and close the toolbox
is to click the arrow button that appears when you move the mouse
pointer to the top left corner of the instrument.

The example shows the Circle raster type with an activated sensitive area on
the left side.

6 In the States table, specify the Minimum and Maximum of the range
and the Write value of State[0]. The minimum and maximum specify the
variable values that the picture of State[0] is associated to. The write value
specifies the value that is written to the variable when the sensitive area of
the state is clicked.

7 Click next to States to add further states and configure their properties.
If the On/Off mode or Check mode is selected as the Push mode, the Off-
value property specifies the write value for the off mode and the default
state picture specifies the picture that is displayed.
The example shows the settings for the yaw trim switch. The Push mode is
set to On/Off mode.

154
ControlDesk Instrument Handling May 2024
Multiswitch Handling

Note the bracket setting in the Inc. max. column. It specifies that the
maximum limit of the state is not included in the range.
§ While you hold the mouse button on the left side of the Multiswitch,
State [0] is active. The write value is written to the connected variable and
therefore the picture with the left switch position is displayed.
§ While you hold the mouse button down on the right side of the
Multiswitch, State [1] is active. The write value is written to the connected
variable and therefore the picture with the right switch position is
displayed.
§ If you release the mouse button, the off-value is written to the connected
variable and therefore the default state picture (middle switch position) is
displayed.
8 Connect a scalar parameter to the Multiswitch.

Result You have specified the sensitive areas of a Multiswitch and can now change the
value of the connected parameter by clicking them.

Related topics HowTos

How to Configure the Multiswitch.......................................................................................... 151

References

Multiswitch............................................................................................................................ 354

155
May 2024 ControlDesk Instrument Handling
Basics and Instructions

On/Off Button Handling


Introduction The On/Off Button lets you calibrate the values of scalar parameters.

Where to go from here Information in this section

Basics of Handling the On/Off Button.................................................... 156


The On/Off Button can be used for setting one parameter to a
predefined value when you press the corresponding On/Off button (On
value) and when you release it (Off value).

How to Configure the On/Off Button............................................ ........ 159


You can configure the On/Off Button according to your needs, for
example, you can change the orientation of the buttons.

How to Change Values with the On/Off Button..................................... 160


The On/Off Button lets you set a numeric parameter to predefined values
and reset it via On/Off buttons.

Basics of Handling the On/Off Button

Introduction The On/Off Button can be used for setting one parameter to a predefined value
when you press the corresponding On/Off button (On value) and when you
release it (Off value).

Caption

On/Off buttons

Connectable variable types For an overview on the variable types you can connect to an instrument, refer to
Instruments and the Variable Types they can Visualize on page 37.

156
ControlDesk Instrument Handling May 2024
On/Off Button Handling

Properties of the On/Off The On/Off Button provides a number of properties in the Properties pane. The
Button following table shows some example settings.

Example Description
You can change the orientation of the On/Off buttons in
the instrument. You can arrange the buttons horizontally or
vertically in the instrument.

You can display the specified converted or source value after the
button text.

You can add as many buttons to the instruments as required.


You must specify a value for each button. ControlDesk sets
the value to the connected parameter when you press the
corresponding button.

You can specify the button color, text color and text font.

157
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Specifying values for the In the On/Off button, you always have to specify one Off value. This value
On/Off buttons is written to the connected parameter when you release any of the available
On/Off buttons. You also have to specify, for each button displayed in the
instrument, an On value which is written to the connected parameter when
you press the corresponding On/Off button.

Depending on the type of the parameter connected to the On/Off Button, you
have to specify the On and Off values in different ways in the Properties pane:
§ If you assign a scalar parameter to this instrument, you must specify the Off
value for all the On/Off buttons via the Off-value property.
In this case, you can specify the On value for each On/Off button via the Value
property in the Buttons properties.

§ If you assign a parameter with a computation table to this instrument,


ControlDesk displays all the entries in the computation table in the Buttons
properties. You have to specify one of the computation table entries as the
instrument's Off value via the Is-off value property. ControlDesk automatically
creates a button for each of the table entries.

Related topics Basics

Instruments and the Variable Types they can Visualize............................................................... 37

158
ControlDesk Instrument Handling May 2024
On/Off Button Handling

References

On/Off Button........................................................................................................................ 359

How to Configure the On/Off Button

Objective You can configure the On/Off Button according to your needs.

Method To configure the On/Off Button


1 From the context menu of the On/Off Button, select Instrument Properties.
ControlDesk activates the Properties pane and displays the properties of the
selected On/Off Button.

159
May 2024 ControlDesk Instrument Handling
Basics and Instructions

2 Select the properties and configure them according to your needs.

Tip

§ Via the buttons below the title bar of the Properties pane, you can:
§ Expand or collapse categories and properties
§ Search and filter the pane content
§ On the Layouting ribbon, click Instruments – Assign Properties to
assign the property settings of shared properties from the currently
selected instrument to the next one you select.

Result The On/Off Button settings are changed.

Related topics Basics

Basics of Handling the On/Off Button..................................................................................... 156

References

On/Off Button........................................................................................................................ 359

How to Change Values with the On/Off Button

Objective The On/Off Button lets you set a numeric parameter to predefined values and
reset it via On/Off buttons.

Preconditions § A parameter must be assigned to the instrument. Refer to How to Connect


Variables and Framework Labels to Instruments (ControlDesk Layouting ).
§ The working page must be activated. Refer to How to Activate the Working or
Reference Page (ControlDesk Calibration and Data Set Management ).
§ You must have added some On/Off Buttons and predefined their values to be
set in the Properties pane. Refer to How to Configure the On/Off Button on
page 159.

Possible methods § To change values via the mouse, refer to Method 1.


§ To change values via the keyboard, refer to Method 2.

160
ControlDesk Instrument Handling May 2024
On/Off Button Handling

Method 1 To change values via the mouse


1 Click one of the buttons and keep pressing the left mouse button as long as
required.
The predefined value of the button is written to the connected parameter.
2 Release the left mouse button.
The Off value of the button is written to the connected parameter.

Method 2 To change values via the keyboard


1 Select an On/Off Button.
2 Press the Up or Down key to select a button.
3 Keep pressing the Enter key as long as required.
The predefined value of the button is written to the connected parameter.
4 Release the Enter key.
The Off value of the button is written to the connected parameter.

Result The parameter value is changed and reset.

Related topics HowTos

How to Configure the On/Off Button...................................................................................... 159

References

On/Off Button........................................................................................................................ 359

161
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Slider Handling
Introduction The Slider lets you calibrate the values of scalar parameters.

Where to go from here Information in this section

Basics of Handling the Slider.................................................................. 162


The Slider provides a slide on horizontal or vertical scale for calibrating a
parameter.

How to Configure the Slider.................................................................. 164


You can configure the Slider according to your needs. For example, you
can change the appearance of the slidebar, even if a measurement is
running.

How to Change Values with the Slider................................................... 165


You can change scalar parameter with the Slider.

Basics of Handling the Slider

Introduction The Slider provides a slide on horizontal or vertical scale for calibrating a
parameter.
Scale Tic Caption

Label

Slidebar Indicator Slide Band

Connectable variable types For an overview on the variable types you can connect to an instrument, refer to
Instruments and the Variable Types they can Visualize on page 37.

162
ControlDesk Instrument Handling May 2024
Slider Handling

Properties of the Slider The Slider provides a number of properties on the Properties pane. The
following table shows some example settings.

Example Description
By default, Automatic Sizing is enabled.
The size and number of elements are
automatically adjusted to the available space.
If you disable Automatic Sizing, you can
set the positions and number of elements
manually. This must be done carefully,
because it might lead to invisible or
unreadable elements, for example, when the
instrument size is changed.
You can change the value range of the scale
and change the appearance of the slide (size,
style, shape, and color).

You can activate an overflow warning. An


arrow visualizes, that a measured value is
outside the scale.

You can change the settings of the slidebar


(color, orientation, position, and direction).

You can visualize the minimum and


maximum measured values by displaying
indicators.

You can display labels on the instrument.


You can use macros to insert variables, such
as the parameter name.

You can highlight value ranges with colored


bands.

Related topics Basics

Instruments and the Variable Types they can Visualize............................................................... 37

163
May 2024 ControlDesk Instrument Handling
Basics and Instructions

References

Slider...................................................................................................................................... 368

How to Configure the Slider

Objective You can configure the Slider according to your needs. For example, you can
change the appearance of the slidebar, even if a measurement is running.

Method To configure the Slider


1 From the context menu of the Slider, select Instrument Properties.
ControlDesk activates the Properties pane and displays the properties of the
selected Slider.

164
ControlDesk Instrument Handling May 2024
Slider Handling

2 Select the properties and configure them according to your needs.

Tip

§ Via the buttons below the title bar of the Properties pane, you can:
§ Expand or collapse categories and properties
§ Search and filter the pane content
§ On the Layouting ribbon, click Instruments – Assign Properties to
assign the property settings of shared properties from the currently
selected instrument to the next one you select.

Result The Slider settings are changed even if a measurement is running.

Related topics Basics

Basics of Handling the Slider................................................................................................... 162

References

Slider...................................................................................................................................... 368

How to Change Values with the Slider

Objective The Slider lets you calibrate the values of scalar parameter.

Slider A Slider can visualize one scalar parameter. The parameter is displayed with a
slide on a slidebar with scale. You can change the values by moving the slide
with the mouse.

Preconditions A parameter must be assigned to the instrument. Refer to How to Connect


Variables and Framework Labels to Instruments (ControlDesk Layouting ).

The working page must be activated. Refer to How to Activate the Working or
Reference Page (ControlDesk Calibration and Data Set Management ).

165
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Possible methods § To change values using the mouse, refer to Method 1.


§ To change values using the keyboard, refer to Method 2.

Method 1 To change values with the Slider using the mouse


1 Click the slide on the slidebar.
2 Hold down the left mouse button to move the slide to the left or right.

Method 2 To change values with the Slider using the keyboard


1 Select a Slider.
2 Press the Up or Down key to change the value using small increments. Press
the Ctrl key when changing a value to use big increments.
To specify small and big increments, select Adjust values – Increments from
the row's context menu.

Result The parameter value is changed.

Related topics References

Slider...................................................................................................................................... 368

166
ControlDesk Instrument Handling May 2024
Sound Controller Handling

Sound Controller Handling


Introduction The Sound Controller lets you generate simple and complex sounds.

Where to go from here Information in this section

Basics on Handling the Sound Controller............................................... 167


The Sound Controller lets you generate simple and complex sounds.

How to Configure the Sound Controller................................................ 168


You can change the Sound Controller settings, for example, the start and
stop times for the sound output.

How to Generate a Complex Sound with the Sound Controller............. 170


When using complex sounds, you can specify sound groups and
interpolate between various sound streams in relation to specific variable
values.

Basics on Handling the Sound Controller

Introduction The Sound Controller lets you generate simple and complex sounds.

Simple sound You can create a simple sound to play audio streams stored in MP3 or WAV files.

167
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Complex sound You can create a complex sound to assign various audio streams (stored in
MP3 or WAV files) to audio groups. You can then interpolate the sound
output between the audio groups and audio streams to create a realistic sound
experience.

Preconfigured Sound The Automotive Controls instrument library provides a preconfigured Sound
Controller with car sounds Controller with various car sounds.

Refer to Automotive Controls Library on page 267.

Connectable variable types For an overview on the variable types you can connect to an instrument, refer to
Instruments and the Variable Types they can Visualize on page 37.

Related topics Basics

Instruments and the Variable Types they can Visualize............................................................... 37

References

Sound Controller.................................................................................................................... 372

How to Configure the Sound Controller

Objective You can change the Sound Controller settings, for example, the start and stop
times for the sound output.

168
ControlDesk Instrument Handling May 2024
Sound Controller Handling

Method To configure the Sound Controller


1 From the context menu of the Sound Controller, select Instrument
Properties.
ControlDesk activates the Properties pane and displays the properties of the
selected Sound Controller. You can change the properties of the currently
selected sounds.

2 Click the Browse button of the Configure property.


ControlDesk opens the Configure dialog where you can add sounds to the
Sound Controller and configure their settings.

169
May 2024 ControlDesk Instrument Handling
Basics and Instructions

3 Select the properties and configure them according to your needs.

Tip

§ Via the buttons below the title bar of the Properties pane, you can:
§ Expand or collapse categories and properties
§ Search and filter the pane content
§ On the Layouting ribbon, click Instruments – Assign Properties to
assign the property settings of shared properties from the currently
selected instrument to the next one you select.

Result You have configured the Sound Controller.

Related topics References

Sound Controller.................................................................................................................... 372

How to Generate a Complex Sound with the Sound Controller

Objective When using complex sounds, you can specify sound groups and interpolate
between various sound streams in relation to specific variable values.

Method To generate a complex sound with the Sound Controller


1 Select an existing Sound Controller or drag a new one from the Instrument
Selector to a layout.

2 In the Properties pane, select Sound Controller – Configure and click .

170
ControlDesk Instrument Handling May 2024
Sound Controller Handling

The Configure dialog opens.

3 From the list, select Complex Sound and click Add to add a complex sound
element to the elements list.
4 Select the Complex sound element in the element list.
The list changes according to the element selected in the element list. For
complex sounds, it contains audio groups.

5 From the list, select Audio group and click Add to add an audio group
element to the elements list.
In the following illustration, two audio groups have been added.

6 Select each audio group and specify a name, description, and quality value
for it. Make sure that the quality values are unique for each audio group.

7 Add wave elements to each audio group.


For each wave element you add, a dialog opens for you to select an MP3 or
WAV file from the file system.

171
May 2024 ControlDesk Instrument Handling
Basics and Instructions

In the following illustration four wave elements have been added to each
audio group.

8 Select each wave element and specify a frequency value for it. Make sure
that the frequency values are unique for each wave element of one audio
group.

9 In the elements list, select Complex sound and specify its properties.
§ To play sounds in relation to variable values independently of pressing the
Sound Controller's play button or dragging its sliders, you must connect
variables and specify the minimum and maximum values of the frequency
and quality parameters.
The following illustration shows these settings with a red rectangular
frame.
§ You must also connect variables for the start and stop condition, the
frequency parameter, and the quality parameter. The red ovals and red
print in the illustration below indicate the variables to be connected.

172
ControlDesk Instrument Handling May 2024
Sound Controller Handling

Note

You do not connect the variables in the dialog, but by dragging them
onto the Sound Controller (see below).

10 Click OK to close the dialog.


11 From the Variables pane, drag each required variable to the Sound
Controller and select the appropriate connection.

173
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Result You have configured a complex sound for the sound controller.

The following tables list some examples of how the sound output would be
generated for the complex sound shown in the illustrations above.

Load_perCent RPM Generated Sound (Volume %)


0 800 100 % rpm_800_noload
0 900 50 % rpm_800_noload
50 % rpm_1000_noload
0 1000 100 % rpm_100_noload
100 1350 25 % rpm_1200_load
75 % rmp_1300_load
50 1300 25 % rpm_1200_noload
25 % rpm 1400_noload
25 % rpm_1200_load
25 % rpm_1400_load

ControlDesk interpolates the sound output via the volume of the sound stream:
The % values in the Generated Sound column represent the volume each sound
stream is played with.

Tip

As shown in the illustrations above, you can also control the volume for the
complex sound as a whole (via slider or variable).

Related topics References

Sound Controller.................................................................................................................... 372

174
ControlDesk Instrument Handling May 2024
Steering Controller Handling

Steering Controller Handling


Introduction The Steering Controller lets you calibrate the values of scalar parameters using a
game controller device, such as a joystick or a steering wheel.

Where to go from here Information in this section

Basics of Handling the Steering Controller............................................. 175


The Steering Controller provides a graphical representation of a
connected game controller device and lets you calibrate scalar
parameters by moving the device or pressing its buttons or switches.

How to Place a Steering Controller on a Layout and Connect


Variables to it........................................................................................ 177
A Steering Controller must be placed on a layout via the Instrument
Selector. You can then connect various variables to its elements.

How to Configure the Steering Controller..................................... ........ 179


You can configure the Steering Controller according to your needs. For
example, you can change the predefined values that are written to a
parameter when you press a button.

How to Change Values with the Steering Controller.............................. 181


The Steering Controller lets you change values using a game controller
device.

How to Configure Force Feedback Effects.............................................. 182


If the game controller device provides force feedback features, you can
add effect elements to the Steering Controller and configure constant,
periodic, and condition effects.

Basics of Handling the Steering Controller

Introduction The Steering Controller provides a graphical representation of a connected game


controller device and lets you calibrate scalar parameters by moving the device or
pressing its buttons or switches.

175
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Title bar

Tab Force-feedback effects

X-axis full range

X-axis negative split X-axis positive split

Buttons

Point-of-view switch

Supported game controller devices The Steering Controller supports any


game controller device that is connected to a USB port of the host PC, and that
is supported by the Microsoft DirectInput API.
You can connect more than one game controller device to the same instrument.
There is one instrument tab for each device.

Connectable variable types For an overview on the variable types you can connect to an instrument, refer to
Instruments and the Variable Types they can Visualize on page 37.

Properties of the Steering The Steering Controller provides a number of properties in the Properties pane.
Controller instrument The following table shows some example settings.

Example Description
You can specify a dead zone in the middle and saturation
zones at the ends of an axis to exclude specific motions of
the controller from changing values.
You can connect different variables to the full range of an
axis, and to its positive and negative parts (positive and
negative split).

176
ControlDesk Instrument Handling May 2024
Steering Controller Handling

Example Description
Each button can be used as an On/Off button, Push
button, or Increment button for different variables.

A point-of-view switch can be connected with one


parameter. Each position of the point-of-view switch
specifies one write value.You can use the switch positions
as Push buttons or as On/Off buttons. If you use them as
On/Off buttons, the center position specifies the off-value.
If the game controller device provides force feedback
features, you can add effect elements to the Steering
Controller and configure constant, periodic, and condition
effects.

Related topics Basics

Instruments and the Variable Types they can Visualize............................................................... 37

HowTos

How to Change Values with the Steering Controller............................................................... 181


How to Configure Force Feedback Effects............................................................................... 182
How to Configure the Steering Controller............................................................................... 179
How to Place a Steering Controller on a Layout and Connect Variables to it............................ 177

References

Steering Controller................................................................................................................. 375

How to Place a Steering Controller on a Layout and Connect Variables to it

Objective A Steering Controller must be placed on a layout via the Instrument Selector.
You can then connect various variables to its elements.

Method To place a Steering Controller on a layout and connect variables to it


1 On the Layouting ribbon, click Layouts – Insert Layout or select an
existing layout.

177
May 2024 ControlDesk Instrument Handling
Basics and Instructions

2 In the Instrument Selector, double-click the Steering Controller.


The instrument is placed on the layout.

Note

If no game controller device is connected to the PC, this is displayed


in the instrument. You must connect a game controller to configure its
specific properties. After the first connection of a game controller it is
"remembered" by the Steering Controller and can be configured even if
it is disconnected.

The Steering Controller displays a representation for all the elements of the
specific game controller you have connected to the PC. If more than one
game controller is connected, a tab is added for each.
The following illustration shows the representation of a joystick with 4 axes,
9 buttons, and one point of view switch.

3 From the Variables pane, drag the parameter or writable measurement you
want to calibrate with the Steering Controller onto the element you want to
use for controlling. Do this for all the variables you want to control.

178
ControlDesk Instrument Handling May 2024
Steering Controller Handling

Result You have placed a Steering Controller on a layout and connected variables to it.

Tip

The Instrument Navigator provides an overview of all the connections of


a steering controller. You can also use it to connect the variables. Refer to
Instrument Navigator (ControlDesk Layouting ).

Related topics Basics

Basics of Handling the Steering Controller.............................................................................. 175

HowTos

How to Configure the Steering Controller............................................................................... 179

How to Configure the Steering Controller

Objective You can configure the Steering Controller according to your needs. For example,
you can change the predefined values that are written to a parameter when you
press a button.

179
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Method To configure the Steering Controller


1 From the context menu of the Steering Controller, select Instrument
Properties.
ControlDesk activates the Properties pane and displays the properties of the
selected Steering Controller.

The listed properties depend on the element that is selected in the


instrument.
2 Select the properties and configure them according to your needs.
If the game controller device provides force feedback features, you can add
effect elements to the Steering Controller and configure constant, periodic,
and condition effects. For details, refer to How to Configure Force Feedback
Effects on page 182.

Tip

§ Via the buttons below the title bar of the Properties pane, you can:
§ Expand or collapse categories and properties
§ Search and filter the pane content
§ On the Layouting ribbon, click Instruments – Assign Properties to
assign the property settings of shared properties from the currently
selected instrument to the next one you select.

Result The Steering Controller's settings are changed.

180
ControlDesk Instrument Handling May 2024
Steering Controller Handling

Related topics Basics

Basics of Handling the Steering Controller.............................................................................. 175

HowTos

How to Change Values with the Steering Controller............................................................... 181


How to Configure Force Feedback Effects............................................................................... 182
How to Place a Steering Controller on a Layout and Connect Variables to it............................ 177

References

Steering Controller................................................................................................................. 375

How to Change Values with the Steering Controller

Objective The Steering Controller lets you change values using a game controller device.

Preconditions § One or more parameters must be assigned to elements of the instrument.


Refer to How to Place a Steering Controller on a Layout and Connect Variables
to it on page 177.
§ You must have configured the elements, such as buttons or point of view
switches, and predefined the values to be set in the Properties pane. Refer to
How to Configure the Steering Controller on page 179.
§ The working page must be activated. Refer to How to Activate the Working or
Reference Page (ControlDesk Calibration and Data Set Management ).

Method To change values with the Steering Controller


1 Move the game controller or a movable element of the game controller to
change the value of the parameter connected to the associated axis.
2 Press a button on the game controller to write a predefined value to
the connected parameter. Whether the button reacts as a Push button,
an On/Off button, or an Increment button depends on which button
representation in the instrument you have connected the parameter to.
3 Press the button of a point of view switch to a specific direction to write
a predefined value to the connected parameter. Whether the point of view
switch reacts as a Push button or an On/Off button depends on the
settings in the instrument properties.

Result The value of the connected parameter is changed.

181
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Related topics Basics

Basics of Handling the Steering Controller.............................................................................. 175

HowTos

How to Configure the Steering Controller............................................................................... 179

References

Steering Controller................................................................................................................. 375

How to Configure Force Feedback Effects

Objective If the game controller device provides force feedback features, you can add
effect elements to the Steering Controller and configure constant, periodic, and
condition effects.

Force feedback effects The following feedback effects can be configured for a Steering Controller.

Effect Description
Constant Effect Specifies a force output with a defined
magnitude and duration.
Periodic Effect Specifies a force output defined by a
waveform, such as a sine or square wave type.
Condition Effect Specifies a force output defined by
information about device motion, such as the
position or velocity of a joystick handle. A
condition effect represents the stiffness of a
joystick, the reset force of a steering wheel,
etc. There are different condition effect types,
such as damper or spring effects.

182
ControlDesk Instrument Handling May 2024
Steering Controller Handling

Method To configure force feedback effects


1 In the Steering Controller instrument, click in the Effects area and add
the effect element(s) you need.

2 Right-click the effect element you want to configure and select Instrument
Properties.

183
May 2024 ControlDesk Instrument Handling
Basics and Instructions

3 In the Properties pane, ControlDesk displays the properties of the selected


effect and its start and stop conditions.

4 Configure the start and stop conditions of the effect to specify when a force
output is triggered.
5 Configure the properties of the selected effect, for example, the strength of
the force or the wave type of a periodic effect.

184
ControlDesk Instrument Handling May 2024
Steering Controller Handling

6 You can connect a variable to various effect property values. To do so, drag
the selected variable to the effect element in the instrument.

7 To enable and disable an effect, click the start and stop symbols in the
instrument.

185
May 2024 ControlDesk Instrument Handling
Basics and Instructions

8 To delete an effect element, click the delete symbol in the instrument.

Result The Steering Controller's force feedback settings are configured.

Related topics Basics

Basics of Handling the Steering Controller.............................................................................. 175

HowTos

How to Change Values with the Steering Controller............................................................... 181


How to Configure the Steering Controller............................................................................... 179
How to Place a Steering Controller on a Layout and Connect Variables to it............................ 177

References

Steering Controller................................................................................................................. 375

186
ControlDesk Instrument Handling May 2024
Table Editor Handling

Table Editor Handling


Introduction The Table Editor lets you calibrate complex values, such as maps, curves, value
blocks, and points of an axis. It can also be used to display the values of a
measurement array.

Where to go from here Information in this section

Basics of Handling the Table Editor........................................................ 188


The Table Editor lets you display and edit variables of complex variable
type, such as maps and curves, in a 2-D, 3-D, and grid view.

Connecting Variables to the Table Editor................................................ 192


You can connect one single variable to the Table Editor as a whole (single
connection). You can also connect two or more variables, each for a
different part of the table (multiple connection).

How to Connect Multidimensional Table Data to the Table Editor.......... 196


You can connect table data with 3 and more dimensions (n-D look-up
tables) to a Table Editor via z-axes.

How to Configure the Table Editor......................................................... 199


You can configure the Table Editor according to your needs. For example,
you can hide the 3-D view or change the label of an axis.

Basics of Changing Values in the Table Editor......................................... 202


In the Table Editor, you can change function values and axis points.

How to Change Function Values in the Table Editor............................... 203


In the Table Editor, you can change function values in the grid view, the
2-D view, and the 3-D view.

How to Change Axis Point Values in the Table Editor............................. 207


Depending on the connected variable, you can change the axis point
values in the Table Editor.

How to Insert or Delete Axis Points........................................................ 209


If you want to use more or fewer function values in the Table Editor, you
can insert or delete axis points.

How to Set Up a View of the Table Editor.............................................. 211


The Table Editor allows you to set up its 2-D and 3-D views according to
your needs. You can zoom into a view, move a chart, and rotate a chart
if it is 3-D.

How to Export and Import Values.......................................................... 214


You can export the values currently displayed in the Table Editor in other
formats and import them from these formats to ControlDesk.

187
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Basics of Handling the Table Editor

Introduction The Table Editor lets you display and edit variables of complex variable type, such
as maps and curves, in a 2-D, 3-D, and grid view.

Table Editor The following illustration shows the Table Editor:


3-D view Working point

Tab

2-D view

Axis points

Grid view

Function value Data axis X-axis Edit point Y-axis

Tutorial video

Overview of the Instrument


This video gives you an overview of the Table Editor.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/8HK2R

Connecting variables to the For information on connecting variables to the Table Editor, refer to Connecting
Table Editor Variables to the Table Editor on page 192.

188
ControlDesk Instrument Handling May 2024
Table Editor Handling

Term definitions The following table shows the different terms that are used.

Term Description
Input values Original (measured) values of the input quantities x and y. In case of n‑D look‑up tables, z
values are measured for each additional dimension.
Axis points Values in the first row and first column of the table.
Data points XY coordinates which define the point of intersection.
Function value The value at a data point.
Working point The working point represents the resulting input value of all current input values of a look-up
table combined. To get the input values for a working point, you must connect variables as
input quantities to all axes of the Table Editor. Depending on the dimensions of the look-up
table, you must connect one, two, or more input quantities.
The working point is marked by a green dot in the 2-D and 3-D views and by a green table
cell frame in the grid view (up to 4 cells when interpolation is needed). If the working point is
outside of the visible area, the table cell 0/0 is colored red.
For special use cases, you can create multiple working points for one look-up table by
connecting measurement arrays or value blocks as input quantities. This allows you to use
different array elements as input values and change the working points in your measurements
or recordings, for example. Refer to Working Points Properties (Multiple Working Points) on
page 569.
Edit point The edit point represents the currently selected data point (table cell). It is marked by a red dot
in the 2-D and 3-D views and by a gray background in the grid view. In the 2-D and 3-D view,
it can be moved via the mouse. Multiple selection is possible.
Output value The value that is taken for the output. Corresponds to the function value if the input values
are exactly on the axis points. In this case the working point lies exactly on one data point.
Otherwise, it is an interpolation between the function values of the data points that enclose
the working point.

Properties of the Table Editor The Table Editor provides a number of properties in the context menu and in the
Properties pane. The following table shows some example settings.

Example Description
The Table Editor can display various tables via tabbed pages. You can
specify individual colors for each tab.

189
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Example Description
You can show or hide three views in the Table Editor: grid view, 2-D
view, 3-D view. You can also change the spatial division of the views
by dragging the splitters.

In the grid view, the edit point(s) have a colored background (here:
yellow, by default: gray) and additional information can be displayed
(here: address information).
Tendency colors and symbols show that a value differs from its
reference value (not available for platforms).

You can select different chart types for the 3-D view: scatter plot, bar,
or surface.

You can specify the surface color in the 3-D view.

190
ControlDesk Instrument Handling May 2024
Table Editor Handling

Example Description
You can zoom the 2‑D- and 3‑D views.

The 2‑D view displays the values in the table as a 2-dimensional chart.
If the data can be displayed in a 3-D view, the 2-D view displays
a projection of it. You can configure the number of panes that are
shown.

By default, the working point is colored green in the views. If the


output value is interpolated all the corresponding cells are marked in
the grid view.
By default, the edit value is colored red in the 2-D and 3-D view. The
background of the selected cell is colored gray.

191
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Example Description
For special use cases, you can create multiple working points for one
look-up table by connecting measurement arrays or value blocks as
input quantities. This allows you to use different array elements as
input values and switch the displayed working point in a measurement
or recording, for example.

Related topics Basics

Connecting Variables to the Table Editor................................................................................. 192

References

Table Editor............................................................................................................................ 379

Videos

2-D View (4:21) in dSPACE Help


3-D View (3:20) in dSPACE Help
Changing Axis Points and Exporting Table Data (4:20) in dSPACE Help
Changing Function Values (4:15) in dSPACE Help
Grid View and Tabbed Pages (4:00) in dSPACE Help

Connecting Variables to the Table Editor

Introduction You can connect one single variable to the Table Editor as a whole (single
connection). You can also connect two or more variables, each for a different
part of the table (multiple connection).

Establishing single You can connect one variable of complex data type to the Table Editor (single
connections connection). The connected variable contains all the necessary information for
the table.

192
ControlDesk Instrument Handling May 2024
Table Editor Handling

Connecting Variables via Single Connection

This video shows you how to connect variables with the Table Editor via single
connection.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/Qc6Hx

The following variable types can be used for a single connection:


§ Map ( )
§ Curve ( )
§ Value block (dimension [n] and [n,m]) ( )
§ Axis points (common axis as a separate variable) ( )
§ Measurement array (dimension [n] and [n,m]) ( )

To establish a single connection, you can drag a variable from the


Variables pane to a Table Editor on a layout or to a Table Editor item in the
Instrument Navigator. Refer to the following illustration.

193
May 2024 ControlDesk Instrument Handling
Basics and Instructions

When you connect a single variable to a Table Editor, you cannot connect further
variables to it later on. As an alternative, you can connect variables to parts of
the Table Editor (multiple connection).

Establishing multiple You can connect two or more variables to the Table Editor. The connected
connections variables contain all the necessary information for the related table part.

Connecting Variables via Multiple Connection

This video shows you how to connect variables with the Table Editor
via multiple
connection.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/4EEa3

The following variable types can be used for a multiple connection:


§ x-/y-axis
The following variable types can be connected:
§ Value block (dimension [n]) ( )
§ Axis points ( )
§ Measurement array (dimension [n]) ( )
§ Function values
The following variable types can be connected:
§ Value block (dimension [n] and [n,m]) ( )
§ Axis points ( )
§ Measurement array (dimension [n] and [n,m]) ( )
§ Working point
The following variable types can be connected:
§ Value ( )
§ Measurement ( )
§ Calculated variable ( )
§ Value block (dimension [n]) ( )
§ Measurement array (dimension [n]) ( )

To establish a multiple connection, you can drag a variable from the


Variables pane to a part of the Table Editor on a layout or to a Table Editor
subitem in the Instrument Navigator. Refer to the following illustration.

194
ControlDesk Instrument Handling May 2024
Table Editor Handling

Establishing multiple You can connect multidimensional data, i.e., table data with 3 and more
connections for dimensions (n-D look-up tables ), to a Table Editor. Multidimensional data is
multidimensional data (n-D connected via multiple connection.
lookup tables)
The following illustration shows an example with 5-dimensional table data as an
example:

195
May 2024 ControlDesk Instrument Handling
Basics and Instructions

For instructions, refer to How to Connect Multidimensional Table Data to the


Table Editor on page 196.

Related topics Basics

Basics of Handling the Table Editor......................................................................................... 188


Instruments and the Variable Types they can Visualize............................................................... 37

HowTos

How to Connect Multidimensional Table Data to the Table Editor........................................... 196

How to Connect Multidimensional Table Data to the Table Editor

Objective You can connect table data with 3 and more dimensions (n-D look-up tables) to
a Table Editor via z-axes.

Multidimensional table data Variable description (SDF) files can contain n-D look-up table data.

If you connect such table data to a Table Editor, the x-axis and the y-axis
represent the first and second dimension. For each additional dimension, a z-axis
is added to a separate Z-Axes area in the grid view.

Each combination of z-axis values displays another slice of the table data with
further function values:

Method To connect multidimensional table data to the Table Editor


1 Add a new Table Editor to a layout or add a new tab to an existing Table
Editor.

196
ControlDesk Instrument Handling May 2024
Table Editor Handling

2 Connect the appropriate value blocks to the x-axis, the y-axis, and at least
to the function values.

If the table data contains more than 2 dimensions, the Table Editor opens
the z-axis area and adds an axis with the name z0.
3 Connect the appropriate variable of dimension 3 to the z-axis (z0).

The Table Editor inserts the axis points to the first z-axis (z0). If the variable
description contains further table data dimensions, the Table Editor adds a
new z-axis for the next dimension.

197
May 2024 ControlDesk Instrument Handling
Basics and Instructions

4 Connect the appropriate variable of the next dimension to the new z-axis
(z1).

The Table Editor inserts the axis points to the second z-axis (z1).
5 Add more variables to the z-axes area for each additional dimension in the
table data. The illustration shows the result for a table with 4 dimensions.

6 Connect variables to the 4 axes as input values. The illustration shows that 4
input quantities still have to be connected.

198
ControlDesk Instrument Handling May 2024
Table Editor Handling

Result You connected the variables of a multidimensional table to a Table Editor.

Related topics Basics

Basics of Handling the Time Plotter......................................................................................... 216


Connecting Variables to the Table Editor................................................................................. 192

References

Axes Properties (Table Editor).................................................................................................. 429

Videos

Connecting Variables via Multiple Connection (3:11) in dSPACE Help


Connecting Variables via Single Connection (2:12) in dSPACE Help

How to Configure the Table Editor

Objective You can configure the Table Editor according to your needs. For example, you
can hide the 3-D view or change the label of an axis.

Tutorial video
Grid View and Tabbed Pages

This video shows you how to use the grid view and tabbed pages.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/rqNdT

Configuring the Table Editor You can configure the Table Editor via the Properties pane and via its context
menu. The following table lists examples.

Property Description
Via Properties pane or context menu:
2-D view – Visible To show/hide the 2-D view.
3-D view – Visible To show/hide the 3-D view.

199
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Property Description
Grid view – Visible To show/hide the grid view.
Via Properties pane only:
Name To change the name of the
instrument.
Properties of data axis, x-axis, To change the properties of an
and y-axis axis, for example, the axis label.
Color To change the color of an
instrument element.
Via context menu only:
Copy Value(s) To copy selected cells to the
Clipboard.
Import/ Export To import or export table values.

Tip

You can change the arrangement of the Table Editor areas by dragging or
double-clicking the splitter bar (for an animated graphic, refer to dSPACE
Help).

Method To configure the Table Editor


1 From the context menu of the Table Editor, select Instrument Properties.

200
ControlDesk Instrument Handling May 2024
Table Editor Handling

ControlDesk activates the Properties pane and displays the properties of the
selected Table Editor.

Note

The Properties pane displays different properties depending on the


currently selected part of the Table Editor.

2 Select the properties and configure them according to your needs.

Tip

§ Via the buttons below the title bar of the Properties pane, you can:
§ Expand or collapse categories and properties
§ Search and filter the pane content
§ On the Layouting ribbon, click Instruments – Assign Properties to
assign the property settings of shared properties from the currently
selected instrument to the next one you select.

Result The Table Editor's settings are changed.

Related topics Basics

Basics of Handling the Table Editor......................................................................................... 188

201
May 2024 ControlDesk Instrument Handling
Basics and Instructions

References

Table Editor............................................................................................................................ 379

Basics of Changing Values in the Table Editor

Introduction In the Table Editor, you can change function values and axis points.

Changing function values Your control over the output value is indirect. You can change the values of the
axis points and the function values. Additionally, you can increase or decrease
the number of function values by adding or deleting axis points. The more axis
points you have, the more accurate your control over the output values will
become, because the distances between interpolated values are smaller.

Changing axis points If you change axis points, ControlDesk lets you specify to keep the corresponding
function values unchanged or to interpolate them linearly.

Unchanged function values If you specify to keep the function values


unchanged, the changed axis will look like this:

Function
values original axis
changed axis
changed axis

Changed Original Changed Axis


axis point axis point axis point points

202
ControlDesk Instrument Handling May 2024
Table Editor Handling

Interpolated function values If you specify to interpolate function values,


the changed axis will look like this:

Function
values original axis
changed axis
changed axis
Interpolation

Changed Original Changed Axis


axis point axis point axis point points

Note

If you let ControlDesk interpolate the function values when you change
an axis point, weak or hard limits might be exceeded. In this case, the
interpolation is stopped and no values are changed. ControlDesk indicates
this with a beep. An error entry is shown in the Message Viewer.

Common axis Axes can be referenced in several maps or curves. If you


change values of such a common axis, ControlDesk warns you about affecting
the referenced variables.

Related topics Basics

Basics of Handling the Table Editor......................................................................................... 188

HowTos

How to Change Axis Point Values in the Table Editor.............................................................. 207


How to Change Function Values in the Table Editor................................................................ 203
How to Insert or Delete Axis Points......................................................................................... 209

How to Change Function Values in the Table Editor

Objective In the Table Editor, you can change function values in the grid view, the 2-D
view, and the 3-D view.

203
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Tutorial video
Changing Function Values

This video shows you how to change function values.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/e22eL

Changing values For basic information, refer to Basics of Changing Values in the Table Editor on
page 202.

Restrictions You can change function values within their hard limits. A short beep indicates
that the value was not changed.

Preconditions A variable must be assigned to the instrument. Refer to Basics of Handling the
Table Editor on page 188.

The working page must be activated. Refer to How to Activate the Working or
Reference Page (ControlDesk Calibration and Data Set Management ).

Possible methods § You can change function values in the grid view. Refer to Method 1.
§ You can change function values in the 2-D view or 3-D view. Refer to Method
2.

Method 1 To change function values in the Table Editor's grid view


1 Select a table cell and enter a new value. When working with a variable that
uses table conversion, select a value from the drop-down list, or enter a new
value for it if this is possible.
There are several ways to change a function value:
§ You can change a value with Adjust Value(s) in the context menu of an
axis point. Select the desired operation (Add, Multiply, Divide, Assign),
or press +,*,/, or =. In the dialog that opens, enter a value as the operand
to change the variable value.
§ You can double-click a value or press F2 to change the value. The changed
value is written to the variable when you press Enter.
§ If you want to change more than one value in the same way, you can
select a block of values with the mouse, or use the arrow keys while
holding the Shift key.

204
ControlDesk Instrument Handling May 2024
Table Editor Handling

§ Multiple selection of values is also possible by pressing Ctrl or Shift


when clicking a value.

§ You can enter a numeric value in any supported numeric format (DEC,
HEX or BIN) independently of the current conversion mode selected. A
hexadecimal value must always be prefixed by 0x and a binary by 0b.
§ You can select one or more values and assign them the corresponding
values of the reference data set via the Table Editor’s context menu (not
available for platforms).

Method 2 To change function values in the Table Editor's 2-D and 3-D view
1 If the desired view is not visible, activate it via the Table Editor's context
menu:
§ Views – 2-D View – Visible
§ Views – 3-D View – Visible
The selected views are displayed.

2 If the table data allows a 3-D view, specify the projection type of the 2-D
view and the number of panes to be displayed, for example:
§ Views – 2-D View – XZ Projection
§ Views – 2-D View – Three Panes Centered

205
May 2024 ControlDesk Instrument Handling
Basics and Instructions

3 In the 2‑D or 3-D view, click a function value point and drag it up or down
to change its value (for an animated graphic, refer to dSPACE Help).

Tip

§ If you cannot drag a function value make sure that the working page
is active.
§ Multiple selection is possible by pressing CTRL when clicking an edit
point. Keep Ctrl pressed to drag the selected edit points together
(for an animated graphic, refer to dSPACE Help).

Result The selected function values are changed.

Related topics Basics

Basics of Changing Values in the Table Editor.......................................................................... 202


Basics of Handling the Table Editor......................................................................................... 188

HowTos

How to Change Axis Point Values in the Table Editor.............................................................. 207


How to Insert or Delete Axis Points......................................................................................... 209

206
ControlDesk Instrument Handling May 2024
Table Editor Handling

References

Table Editor............................................................................................................................ 379

How to Change Axis Point Values in the Table Editor

Objective Depending on the connected variable, you can change the axis point values in
the Table Editor.

Tutorial video
Changing Axis Points and Exporting Table Data

This video shows you how to change axis points and export table data.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/it5NN

Axis points For basic information on axis points, refer to Basics of Handling the Table Editor
on page 188.

Changing values For basic information, refer to Basics of Changing Values in the Table Editor on
page 202.

Preconditions § The working page must be activated. Refer to How to Activate the Working or
Reference Page (ControlDesk Calibration and Data Set Management ).
§ The Table Editor (or the axis you want to edit) must be connected to a variable
that allows the editing of the axis. Whether an axis can be edited is defined in
the variable description.

Method To change the value of an axis point

1 In the grid view, select an axis value and enter a new value. When working
with a variable that uses table conversion, select a value from the drop-down
list, or enter a new value for it if this is possible.

207
May 2024 ControlDesk Instrument Handling
Basics and Instructions

There are several ways to change an axis value:


§ You can change a value with Adjust Value(s) in the context menu of an
axis point. Select the desired operation (Add, Multiply, Divide, Assign),
or press +,*,/, or =. In the dialog that opens, enter a value as the operand
to change the variable value.
§ You can double-click a value or press F2 to change the value. The changed
value is written to the variable when you press Enter.
§ If you want to change more than one value in the same way, you can
select a block of values with the mouse, or use the arrow keys while
holding the Shift key.
§ Multiple selection of values is also possible by pressing Ctrl or Shift
when clicking a value.

§ You can enter a numeric value in any supported numeric format (DEC,
HEX or BIN) independently of the current conversion mode selected. A
hexadecimal value must always be prefixed by 0x and a binary by 0b.
§ You can select one or more values and assign them the corresponding
values of the reference data set via the Table Editor’s context menu (not
available for platforms).
The Interpolation dialog opens.
2 In the Interpolation dialog, specify whether the function values should be
interpolated.

Tip

You can disable this dialog and specify a default setting on the
Properties pane (Active Table Editor – Axes – Interpolation mode).
Refer to Axes Properties (Table Editor) on page 429.

If the new value violates the monotony of the axis points, the Axis
Monotony Violation dialog opens (if enabled via the instrument’s
properties).
3 In the Axis Monotony Violation dialog, select whether to write the value.

208
ControlDesk Instrument Handling May 2024
Table Editor Handling

If you choose to write the value, the 3-D view no longer displays a chart but
tells you which axis is inconsistent.

As soon as you have reestablished the monotony of the inconsistent axis, the
2‑D and 3‑D views display a chart again.

Result You have changed your control over the output values by inserting or deleting
new axis points.

Related topics Basics

Basics of Changing Values in the Table Editor.......................................................................... 202


Basics of Handling the Table Editor......................................................................................... 188

HowTos

How to Change Function Values in the Table Editor................................................................ 203


How to Insert or Delete Axis Points......................................................................................... 209

References

Delete Axis Point(s)................................................................................................................. 641


Insert Axis Point(s).................................................................................................................. 664

How to Insert or Delete Axis Points

Objective If you want to use more or fewer function values in the Table Editor, you can
insert or delete axis points.

209
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Axis points For basic information on axis points, refer to Basics of Handling the Table Editor
on page 188.

Interpolating In most cases the input values will not be exactly on the axis points. The output
value is then an interpolation between up to 4 function values. You can control
the output value more precisely if you increase the number of axis points. If you
insert a new axis point, the new function values are interpolated between the 2
neighboring values.

Preconditions § The working page must be activated. Refer to How to Activate the Working or
Reference Page (ControlDesk Calibration and Data Set Management ).
§ The Table Editor (or the axis you want to edit) must be connected to a variable
that allows the editing of the axis. Whether an axis can be edited is defined in
the variable description.

Method To insert or delete an axis point


1 From context menu of a Table Editor axis, select Insert Axis Point to insert
an axis point, or select the axis and press Ctrl+Shift+Insert.
The Insert Point dialog opens.

2 Specify where the axis points are inserted, the number of points and the step
width.
ControlDesk inserts the new axis points and interpolates the new function
values between 2 neighboring values.
3 To delete an axis point, select it and press Ctrl+Shift+Delete.

Result You have changed your control over the output values by inserting or deleting
new axis points.

210
ControlDesk Instrument Handling May 2024
Table Editor Handling

Related topics Basics

Basics of Changing Values in the Table Editor.......................................................................... 202


Basics of Handling the Table Editor......................................................................................... 188

HowTos

How to Change Axis Point Values in the Table Editor.............................................................. 207


How to Change Function Values in the Table Editor................................................................ 203

References

Delete Axis Point(s)................................................................................................................. 641


Insert Axis Point(s).................................................................................................................. 664

How to Set Up a View of the Table Editor

Objective The Table Editor allows you to set up its 2-D and 3-D views according to your
needs. You can zoom into a view, move a chart, and rotate a chart if it is 3-D.

Tutorial videos
3-D view

3-D View
This video shows you how to use the 3‑D view.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/5cTRi

211
May 2024 ControlDesk Instrument Handling
Basics and Instructions

2-D view

2-D View
This video shows you how to use the 2‑D view.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/r2Qbr

Setting up a view In the 2-D and 3-D views, you can zoom into a chart and move the zoom area.
You can also rotate a 3-D chart in the 3-D view.

The following table shows how to zoom, move, and rotate a chart in the
different views.

Mouse Shortcut Keys Purpose


3-D charts only: Translation in the 2-D view
Ctrl+Shift+← → Rotation in the 3-D view (z-
Hold the left mouse Ctrl+Shift+↑ ↓ axis, y-axis, x-axis)
button and move the Ctrl+Shift+Page Up/Page
pointer. Down
3-D charts only: Zooming
Alt+Shift+Page Up/Page
Turn the scroll wheel. Down

2-D charts only: – Zooming by specifying a


rectangle area
Alt +
Hold Alt and the left
mouse button and
move the pointer.
3-D charts only: Translation in the 3-D view
Alt+Shift+↑ ↓
Hold the middle Alt+Shift+← →
mouse button and
move the pointer.
Ctrl+R To reset the Table Editor's
views to the default settings.
Double-click the left
mouse button.
– Ctrl+U To restore the user settings
for the Table Editor's 3-D
view.

212
ControlDesk Instrument Handling May 2024
Table Editor Handling

Mouse Shortcut Keys Purpose


– Ctrl+Shift+U To save the current settings
of the Table Editor's 3-D view
(Zoom and Rotation) as user
default settings.
– Ctrl+Shift+Z To use the same data axes
scaling for all panes in the 2-
D view.

Restrictions § The 3-D view and the projection functions of the 2-D view are available only
for variables that allow a 3-D view, e.g., maps.
§ The 2-D and 3-D views are not available for variables that use conversion
tables (with the exception of verbal conversion tables).

Preconditions The 2-D or 3-D view must be visible.

Method To set up a view of the Table Editor


1 Move the mouse pointer to the desired Table Editor.
2 Click on the 2-D or the 3-D view. Make sure not to click on the point of a
function value.
3 To move the chart hold down the left mouse button and drag the mouse
pointer. In the 3-D view, this rotates the chart.
4 To zoom in and out of the chart hold down the left mouse button and drag
the mouse wheel. In the 2-D view, the axes are rescaled and remain visible
during zooming.

5 To activate the default settings, click the Table Editor and press Ctrl+R.

Result You zoomed into the 2-D and 3-D view.

213
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Related topics Basics

Basics of Handling the Table Editor......................................................................................... 188

How to Export and Import Values

Objective You can export the values of a variable that is currently displayed in the Table
Editor in other formats and import them from these formats to ControlDesk.
ControlDesk always exports and imports all the axes and function values of the
(multidimensional) variable.

Export/import formats You can choose between two file formats for exporting or importing table data:
§ Comma separated values file (CSV)
§ MATLAB file format (MAT)

Note

Imported values are written directly to the connected variable. Values that
make no sense are ignored. For example, if a Table Editor is connected to a
curve, the y-axis values are ignored and the x-axis values are written.

Note

The Table Editor uses the vertical x-axis orientation by default.


When you export table data to a CSV file, the x-axis orientation in the CSV
file is horizontal.

Method To export and import values


1 From the Table Editor’s context menu, select Import/ Export – Export
Value(s).
A standard Save As dialog opens.
2 Select a file format and specify a path and file name.
If you select a file from the list, it will be replaced.
3 Close the dialog.
4 Change to the Table Editor which you want to import the values to.
5 From the Table Editor’s context menu, select Import/Export – Import
Value(s).
A standard Open dialog opens.
6 Select a table data file from the list.

214
ControlDesk Instrument Handling May 2024
Table Editor Handling

Result ControlDesk writes the imported values directly to the connected variable. Values
that make no sense are ignored.

Tip

For information on loading exported data in MATLAB, refer to the


description of loading exported recorded data: How to Use Exported Data in
MATLAB (ControlDesk Measurement and Recording ).

Related topics References

Export Value(s)........................................................................................................................ 653


Import Value(s)....................................................................................................................... 661

Videos

Changing Axis Points and Exporting Table Data (4:20) in dSPACE Help

215
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Time Plotter Handling


Introduction The Time Plotter lets you display signals that are measured in a time-based raster.

Where to go from here Information in this section

Basics of Handling the Time Plotter........................................................ 216


The Time Plotter lets you display the values of measurement variables in
relation to the measurement time (time plots).

Zooming and Moving the Chart (Time Plotter)....................................... 224


You can switch between different modes to zoom into the chart or move
the chart.

How to Configure the Time Plotter........................................................ 227


You can change the Time Plotter settings, for example, the color of the
signal, even if the measurement is running.

How to Display Curves with Mean, Minimum, and Maximum


Values................................................................................................... 229
You can activate customized downsampling for the Time Plotter to
display specific curves, such as curves with mean, maximum, or minimum
values.

How to Specify a Trigger for the Time Plotter Visualization..................... 232


The Time Plotter visualization can be triggered. This is especially useful
if data acquisition of connected signals was already triggered on the
hardware (triggered measurement).

How to Change Trigger Settings via the Time Plotter............................. 236


You can change the trigger settings in the Measurement
Configuration directly via the Time Plotter.

Basics of Handling the Time Plotter

Introduction The Time Plotter lets you display the values of measurement variables in relation
to the measurement time (time plots).

216
ControlDesk Instrument Handling May 2024
Time Plotter Handling

Time Plotter

Toolbar

Y-axis Data cursor info

Data cursor
Chart area

Cursor (move mode)

DAQ info
Signal symbol
Show legend

X-axis Legend

Selecting the optimum plotter ControlDesk provides the following plotter types:
type § Time Plotter
§ Index Plotter
§ XY Plotter

For information on selecting the optimum plotter type for your task, refer to
Choosing Between Time Plotter, Index Plotter, and XY Plotter on page 40.

Connections You can place signals or variables on the Time Plotter via drag & drop. The
visualization of a signal/variable in the Time Plotter depends on where you drop
it. The destination is highlighted.

Tutorial video

Sensitive Areas and Adding Signals


This video shows you how to connect signals to different sensitive areas of a
plotter.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/Km4Qs

217
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Dragging variables You can drag variables, for example, from the
Variables pane to the Time Plotter. Multiselection is possible.

Operation Description
Dropping a variable onto a signal symbol If you drop a variable
onto a signal symbol, it is
connected to the signal. The
new connection replaces the
existing one.

Dropping one or more variables onto a y-axis If you drop one or more
variables onto a y-axis, a new
signal is added to the y-axis for
each variable.

Dropping one or more variables onto the If you drop one or more
chart area variables onto the chart area,
a new y-axis is added to the
y-axis area for each variable.

Dragging signals You can drag signals inside of a Time Plotter or from one
Time Plotter to another. If you drag signals inside the Time Plotter, they are
moved, if you drag them out of a Time Plotter, they are copied. Pressing Ctrl
(inside) or Shift (outside) changes this default action. Multiselection of signals is
possible if you drag them from the legend.

218
ControlDesk Instrument Handling May 2024
Time Plotter Handling

Operation Description
Dropping a signal onto a y-axis outside the If you drop a signal onto a y-
signal symbols axis outside the signal symbols,
it is connected to the axis. The
signal symbol is added above
the existing ones.

Dropping a signal onto a y-axis between the If you drop a signal onto
signal symbols a y-axis between the signal
symbols, it is connected to
the axis. The signal symbol is
inserted at the drop position.

Dropping a signal onto the chart area If you drop a signal onto the
chart area, a new y-axis is
added to the y-axis area for the
signal.

Dragging an axis You can drag an axis inside of a Time Plotter or from one
Time Plotter to another. You must first drag the axis to the chart area and then
to the dropping position. If you drag an axis inside the Time Plotter, it is moved,
if you drag it out of a Time Plotter, it is copied. Pressing Ctrl (inside) or Shift
(outside) changes this default action.

219
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Operation Description
Dropping an axis onto the axis area If you drop an axis onto the axis area, it is
inserted at the highlighted position.

If the y-axis area has a scroll bar, arrows


are displayed to reach a hidden axis.

Connectable variable types For an overview on the variable types you can connect to an instrument, refer to
Instruments and the Variable Types they can Visualize on page 37.

Properties of the Time Plotter The Time Plotter provides a number of properties in its context menu and in the
Properties pane. The following table shows some example settings.

Example Description
The Time Plotter can display y-axes one beside the other in the
Complete view or in the Scroll view axis modes. Refer to View
Properties (Time Plotter/Index Plotter) on page 566.

220
ControlDesk Instrument Handling May 2024
Time Plotter Handling

Example Description
The Time Plotter can display the y-axes one below the other in the
Stacked view axis mode. Refer to View Properties (Time Plotter/Index
Plotter) on page 566.

You can show/hide the legend via a button. Refer to Legend Properties
(Time Plotter/Index Plotter) on page 492.

You can select between different line styles and point styles. Refer to
Axes and Signals Properties (Time Plotter/Index Plotter) on page 422.

You can define value ranges for the colors of a multicolor signal.
For example, you can let ControlDesk display a signal with smooth
color transitions (Multicolor interpolation). Refer to Axes and Signals
Properties (Time Plotter/Index Plotter) on page 422.

You can enable one or two cursors to specify chart positions.


The positions of the cursors and the distance between them can be
displayed at the cursor info position. Refer to Data Cursor Properties
(Time Plotter/Index Plotter) on page 463.

221
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Example Description
You can enable the time cursor to specify a time position in the
chart. The time position of the cursor and the related signal value can
be displayed. Refer to Time Cursor Properties on page 558.

You can show/hide a toolbar via a button. Via the toolbar, you can
easily change cursor and DAQ settings. Refer to Toolbar Properties
(Time Plotter/Index Plotter) on page 559.

You can sort, group, and filter the signals in the Time Plotter via the
column headers of the legend. Right-click the column headers to open
related commands.
To search for a signal, set the focus to the legend and press Ctrl+F

You can place overlay elements with text or pictures on top of the
signals or underneath them.
An overlay element can be fixed to a chart position (moving with the
chart) or to an instrument position (not moving with the chart).
Refer to Overlay Elements Properties (Time Plotter/Index Plotter) on
page 508.

If the connected variable is converted via a computation table, the


converted values can be used for the y-axis and the time cursor.
Ranges can be visualized in the chart.

222
ControlDesk Instrument Handling May 2024
Time Plotter Handling

Example Description
The example shows a verbal range table conversion with the following
ranges:

Refer to Conversion Table Settings Properties (Time Plotter/Index


Plotter) on page 457.

Tutorial videos

Displaying Cursors
This video gives you an overview of how to display plotter cursors.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/bremQ

Specifying Plotter Signal Settings


This video shows you how to specify plotter signal properties.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/hm236

Related topics Basics

Instruments and the Variable Types they can Visualize............................................................... 37


Zooming and Moving the Chart (Time Plotter)........................................................................ 224

223
May 2024 ControlDesk Instrument Handling
Basics and Instructions

HowTos

How to Change Trigger Settings via the Time Plotter.............................................................. 236


How to Configure the Time Plotter......................................................................................... 227
How to Specify a Trigger for the Time Plotter Visualization...................................................... 232
How to View Values at a Specific Point in Time (Time Cursor) (ControlDesk
Measurement and Recording )

References

Show Legend......................................................................................................................... 713


Time Plotter............................................................................................................................ 384

Videos

Comparing Time Plotter, Index Plotter, and XY Plotter (3:41) in dSPACE Help
Specifying Plotter Settings in the Properties Pane (2:41) in dSPACE Help

Zooming and Moving the Chart (Time Plotter)

Introduction You can switch between different modes to zoom into the chart or move the
chart.

Tutorial video
Zooming and Moving

This video shows you how to zoom into the chart area and how to move the
chart.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/hFyzy

Zoom mode The chart area and the axes can be set to zoom mode via context menu. The
mouse pointer shows you the active mode.

Mouse Pointer Description


Zoom mode: You can specify the zoom area.

224
ControlDesk Instrument Handling May 2024
Time Plotter Handling

Move mode The chart area and the axes can be set to move mode via context menu. The
mouse pointer shows the active mode.

Mouse Pointer Description


Move mode (chart area): You can move the
chart in the x‑axis and the y‑axis directions.
Move mode (x‑axis): You can move the chart in
the x‑axis direction.
Move mode (y‑axis): You can move the chart in
the y‑axis direction.

Freeze mode Each time you move or zoom the chart during a running measurement, the
Plotter display switches to freeze mode. The visualization is paused and a lock
symbol is displayed at the bottom left of the chart. Measuring and recording is
continued in the background.

Click the lock symbol or double-click the chart area to leave freeze mode (for an
animated graphic, refer to dSPACE Help).

Synchronized x‑axis Via the x‑axis properties, you can activate the synchronization of the x‑axis in
continuous visualization mode. In this case all synchronized Time Plotters share
the same time range and all Index Plotters share the same event range. Zooming
and moving actions then affect all synchronized plotters in the same way.

Zooming and moving the You can use various methods to zoom or move the chart. See the following
chart table.

Mouse Gesture1), 2) Shortcut Key Purpose


Move and zoom mode
– – O2) To show or hide a scroll bar below the x-axis.3)
To navigate through the measurement, drag the scroll box as shown
below.

225
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Mouse Gesture1), 2) Shortcut Key Purpose


To specify the zoom settings, drag the edges of the scroll box as shown
below (for an animated graphic, refer to dSPACE Help).

– – M To set the chart view to move mode.


– – Z To set the chart view to zoom mode.
– To rescale the chart.
§ Use the chart to rescale both axes.
§ Use an axis to rescale the selected axis.
Zoom mode
– – To zoom into the chart by dragging the mouse pointer.

– To zoom into the chart.


§ Use the chart area to zoom into both axes.
(Scroll wheel) § Use an axis to zoom into the selected axis.
– To zoom out.
§ Use the chart area to zoom out of both axes.
(Scroll wheel) § Use an axis to zoom out of the selected axis.
Move mode
– To move the chart in any direction (available on the chart area).

– To move the chart horizontally (available on the x‑axis).

– To move the chart vertically (available on the y‑axis).

Ctrl – – To zoom the axis while you are in move mode (available on the x‑axis
+
and on the y‑axis).
1)
If you are using a multi-touch capable display, you can use gestures to zoom or move
the chart.
2) Available only for Time Plotter and Index Plotter.
3) You must stop a running measurement to use the scroll bar. For information on the
scroll bar settings, refer to Scroll Bar Properties (Time Plotter/Index Plotter) on page 527.

Undo, redo, and toggle You can undo and redo zooming and moving. You can also activate or deactivate
zooming and moving the zoom. See the following table.

Cursor Toolbar1) Shortcut Key Purpose


Back To undo the most recent zoom or move action.

226
ControlDesk Instrument Handling May 2024
Time Plotter Handling

Cursor Toolbar1) Shortcut Key Purpose


Shift+Back To redo the most recent undone zoom or move action.

+ To activate or deactivate the zoom.

1) For information on the Cursor Toolbar, refer to Show Toolbar on page 715.

Related topics Basics

Basics of Handling the Time Plotter......................................................................................... 216

References

Navigation – Move Mode (Time Plotter/Index Plotter).............................................................. 680


Navigation – Rescale (Time Plotter/Index Plotter)..................................................................... 681
Navigation – Zoom Mode (Time Plotter/Index Plotter).............................................................. 681
Scroll Bar Properties (Time Plotter/Index Plotter)...................................................................... 527
Show Scroll Bar (Time Plotter/Index Plotter)............................................................................. 715
Show Toolbar......................................................................................................................... 715
Time Plotter............................................................................................................................ 384

How to Configure the Time Plotter

Objective You can change the Time Plotter settings, for example, the color of the signal,
even if the measurement is running.

Tutorial video
Specifying Plotter Settings in the Properties Pane

This video shows you how to specify plotter settings in the Properties pane.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/KkNA5

227
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Time Plotter properties The Time Plotter provides a number of properties on the Properties pane. Some
of them can also be set via the Time Plotter's context menu. Some examples are
listed below.

You can change settings for the axes of the Time Plotter, for example:
§ Scaling mode (Floating, Extended, Fixed)
§ Tic format (Standard, Exponential, Scientific, SIPrefix)
§ Minimum and maximum values of the axis, if Scaling mode is set to Fixed.

You can change settings for the curves, for example:


§ Line width for a curve (in pixels)
§ Point size for a curve (in pixels)

The changes can be made during a running measurement.

You can change various other settings sorted by different categories. Click a
property on the Properties pane and read the short information at the bottom
of the pane. Press F1 or click the header of the short information to get detailed
information on a specific property.

Method To configure the Time Plotter


1 From the context menu of the Time Plotter, select Instrument Properties.
ControlDesk activates the Properties pane and displays the properties of the
selected Time Plotter.

228
ControlDesk Instrument Handling May 2024
Time Plotter Handling

The listed properties depend on the element that is selected in the


instrument. In the Time Plotter, you can select the following elements:
§ X-axis
§ Y-axis
§ Signal symbol or legend row (multiple selection is possible)
2 Select the properties and configure them according to your needs.

Tip

§ Via the buttons below the title bar of the Properties pane, you can:
§ Expand or collapse categories and properties
§ Search and filter the pane content
§ On the Layouting ribbon, click Instruments – Assign Properties to
assign the property settings of shared properties from the currently
selected instrument to the next one you select.

Result The Time Plotter's settings have been changed.

Related topics Basics

Basics of Handling the Time Plotter......................................................................................... 216


Zooming and Moving the Chart (Time Plotter)........................................................................ 224

References

Time Plotter............................................................................................................................ 384

How to Display Curves with Mean, Minimum, and Maximum Values

Objective You can activate customized downsampling for the Time Plotter to display
specific curves, such as curves with mean, maximum, or minimum values.

Visualization downsampling The Time Plotter uses visualization downsampling to control the amount of
visualized data for the displayed signals. The measured data is downsampled by
defining a time interval. All measured data points in this downsampling interval
are represented by the visualized data points, such as the mean value or the
maximum value in the interval.

229
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Note

The settings for a visualization downsampling do not influence the amount


of measured or recorded data but only the visualization of the data in the
instrument (no DAQ downsampling).

The following table shows some examples:

Signal Description
Original signal

Visualization downsampling
§ Downsampling interval: 0.1 sec.
§ Minimum and maximum value in each interval

Visualization downsampling
§ Downsampling interval: 0.1 sec.
§ Mean value in each interval

Automatic downsampling The Time Plotter performs an automatic visualization downsampling to ensure a
high performance even if a large amount of data is measured. All measured data
points in the downsampling interval are represented by two signal values: the
minimum and the maximum value in the interval.

The Time Plotter computes an optimum time interval that matches the following
conditions:
§ The visualized signal looks like the original signal, irrespective of the reduction
of data points.
§ Extreme values are displayed.

230
ControlDesk Instrument Handling May 2024
Time Plotter Handling

Customized downsampling You can activate customized downsampling for a signal to set the time interval
manually and to display minimum, maximum, and mean values. See the
following examples.

Min/Max

Min

Max

Mean

Mean value curves and A special use case is to display signals with mean value curves and envelopes.
envelopes See the following example.

Method To display curves with mean, minimum, and maximum values


1 Right-click the chart area of the Time Plotter.

231
May 2024 ControlDesk Instrument Handling
Basics and Instructions

2 From the context menu, select Axes/Signals – Properties.


The Axes/Signals dialog opens.

3 In the axes and signals tree, select the signal you want to configure.
4 In the Properties list, select Custom downsampling.
The downsampling properties are now displayed.

5 Specify Display mode and Interval (in seconds) to configure the


downsampling settings according to the desired curve.
6 Click Close to confirm your settings and close the dialog.

Result You changed the visualization downsampling settings to display a curve with
mean, minimum, or maximum values.

Related topics References

Axes and Signals Properties (Time Plotter/Index Plotter)........................................................... 422

How to Specify a Trigger for the Time Plotter Visualization

Objective The Time Plotter visualization can be triggered. This is especially useful if
data acquisition of connected signals was already triggered on the hardware
(triggered measurement).

232
ControlDesk Instrument Handling May 2024
Time Plotter Handling

Video
Leading Raster

to specify the trigger


This video shows you how to select one measurement raster
settings for the Time Plotter display (leading raster).

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/uaceb

Triggering the Time Plotter In ControlDesk, you can trigger the visualization of Time Plotter data. You must
visualization specify a start and a stop trigger for the plotter visualization for this.

Tip

To trigger the plotter visualization, ControlDesk uses the same trigger types
as for triggered measurements. Thus, the platform and duration triggers
defined in the measurement configuration are used to start and stop the
plotter visualization.

If the Time Plotter visualization is triggered, the time axis does not show the
original time stamps of the running measurement, but starts with 0 when the
condition of the start trigger is met. When the condition of the stop trigger is
met, the Plotter visualization is frozen until the start trigger is met again. This is
like the stable visualization typical of a triggered oscilloscope.

By default, a plotter uses the trigger settings from the first connected variable
to display data. You can modify the trigger settings for a plotter visualization
manually.

Note

Triggering the plotter visualization does not affect the data stream to the
plotter, only the visualization of plotter data.

233
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Triggering the Plotter visualization allows you to display only that part of the
data stream that meets the trigger conditions. This can be useful if the data
flow of the connected signals is also triggered, that is, if data acquisition of the
connected signals is triggered on the hardware.

Triggered plotter The following illustrations show how the Time Plotter visualization changes
when triggered mode is enabled. In both cases the same triggers are activated
for the associated measurement raster, which means that parts of the signal
are transferred to the host PC only if they meet the trigger conditions of the
measurement raster.
§ If the Time Plotter visualization is not triggered (and Multi Capture History
and Auto Repeat are enabled for the triggered measurement raster), the
Time Plotter shows the incoming data stream for the signals continuously,
with the measurement time on the x-axis. Gaps are visible because the signal is
triggered on the hardware.

§ If the Time Plotter visualization is triggered (using the same trigger settings as
for the associated measurement raster), only that part of the data stream that
meets the trigger conditions is displayed. The measurement time on the x-axis
begins with 0 (if no delay is specified).

In the example, the DAQ info is shown on the right side above the x-axis.
The display is refreshed automatically (Auto Repeat) or manually (pressing the
trigger's Start button on the Measurement Configuration pane) according
to the trigger settings.

For more information on the triggering of measurement rasters, refer


to Configuring Triggered Measurement on dSPACE Platforms (ControlDesk
Measurement and Recording ).

234
ControlDesk Instrument Handling May 2024
Time Plotter Handling

Leading raster If the variables that are connected to the Time Plotter are associated with several
measurement rasters, you can select one measurement raster to specify the
trigger settings for the Time Plotter visualization. This raster becomes the leading
raster (indicated by in the Leading column of the Time Plotter legend). The
leading raster determines the time range that is visible in the Time Plotter.

If the first signal you connect to the Time Plotter is assigned to a measurement
raster that has trigger settings, this raster automatically becomes the leading
raster and the Time Plotter is set to triggered mode.

DAQ toolbar The Time Plotter can display a toolbar. Select the DAQ toolbar type to change
the visualization trigger settings more easily.

Autoset trigger Drawing mode


Trigger mode Interactive trigger Number of Show/hide
DAQ toolbar type Leading raster displayed DAQ info
periods

Show/hide toolbar

For details on the toolbar buttons, refer to Show Toolbar on page 715.

Method To specify a trigger for the Time Plotter visualization


1 If not already done, enable the triggered mode for the Time Plotter
visualization. From the context menu of the chart, select DAQ – Mode –
Trigger Mode.

235
May 2024 ControlDesk Instrument Handling
Basics and Instructions

2 From the context menu of the chart, select DAQ – Mode – Leading Raster
and select the raster that has the DAQ trigger settings you want to use for
the Time Plotter visualization.
The Time Plotter visualization is triggered using the trigger settings of the
selected raster.

You can check the trigger assignment to the Time Plotter via the DAQ
settings properties of the Time Plotter.

Result You have specified a start and a stop trigger for the Time Plotter visualization and
activated the triggered mode.

Related topics Basics

Configuring Triggered Measurement on dSPACE Platforms (ControlDesk


Measurement and Recording )

HowTos

How to Change Trigger Settings via the Time Plotter.............................................................. 236

References

DAQ - Available Raster (Time Plotter/Index Plotter).................................................................. 633


DAQ – Leading Raster (Time Plotter/Index Plotter)................................................................... 634
DAQ – Mode (Time Plotter/Index Plotter)................................................................................ 635
DAQ - Trigger (Time Plotter/Index Plotter)............................................................................... 637
DAQ Properties (Time Plotter/Index Plotter)............................................................................. 462

How to Change Trigger Settings via the Time Plotter

Objective You can change the trigger settings in the Measurement Configuration
directly via the Time Plotter.

236
ControlDesk Instrument Handling May 2024
Time Plotter Handling

Interactive Trigger If you activate Interactive Trigger, you can change trigger settings in the
Measurement Configuration via sliders displayed at the Time Plotter axes.

Autoset Trigger If you activate Autoset Trigger, ControlDesk analyzes the current measurement
to find optimum trigger settings for a periodic signal.

Precondition An Autoset Trigger analysis can be started for each signal in the chart, but
it can find trigger settings only if the signal is periodic. If the analysis is not
successful, the previous trigger settings are restored.

Possible methods There are two ways to change the trigger settings via the Time Plotter.
§ Automatically by analyzing the signal. Refer to Method 1.

Automatic Trigger Settings


This video shows you how to use a Time Plotter to configure trigger settings
automatically.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/AsE69

§ Interactively via sliders on the Time Plotter axes. Refer to Method 2.

Interactive Trigger Settings


This video shows you how to use a Time Plotter to configure trigger settings
interactively.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/HeRvs

Method 1 To change trigger settings via the Time Plotter automatically by analyzing
the signal
1 In the y-axes area, right-click the symbol of the signal you want to change
the trigger settings for.

237
May 2024 ControlDesk Instrument Handling
Basics and Instructions

2 From the context menu, select DAQ – Trigger – Autoset Trigger or click

the corresponding toolbar button: .


If no measurement is running, ControlDesk prompts you to start one.
ControlDesk analyzes the running measurement and displays progress
messages in the chart area.

Tip

In the instrument's toolbar, you can change the number of complete


periods to be displayed in the chart.

Method 2 To change trigger settings via the Time Plotter interactively


1 In the y-axes area, right-click the symbol of the signal you want to change
the trigger settings for.
2 From the context menu, select DAQ – Trigger – Interactive Trigger or click

the corresponding toolbar button: .


Three sliders are displayed on the Time Plotter axes.

§ On the y-axis, you can drag a slider to change the trigger value.
§ On the x-axis, you can drag two sliders to change the trigger delay and
the samples/duration settings.

Result You have changed the trigger settings in the Measurement Configuration via
the Time Plotter.

238
ControlDesk Instrument Handling May 2024
Time Plotter Handling

Autoset Trigger example The following illustrations show an example of a successful Autoset Trigger
analysis.
1. Before Autoset Trigger is started:

In the Measurement Configuration, the Duration Trigger value of the


active signal is set to 0.054 s, which results in incomplete representation of
the signal period in the chart.
2. Autoset Trigger is started:

The number of displayed signal periods is set to 1, as shown in the toolbar.


The analysis is successful and sets the Duration trigger value to about
0.098 seconds to display 1 complete signal period.
3. Now the number of displayed periods is set to 3.

The Duration Trigger value is set to 0.3 seconds to display 3 complete


periods.

Related topics Basics

Configuring Triggered Measurement on dSPACE Platforms (ControlDesk


Measurement and Recording )

239
May 2024 ControlDesk Instrument Handling
Basics and Instructions

HowTos

How to Specify a Trigger for the Time Plotter Visualization...................................................... 232

References

DAQ - Available Raster (Time Plotter/Index Plotter).................................................................. 633


DAQ – Leading Raster (Time Plotter/Index Plotter)................................................................... 634
DAQ – Mode (Time Plotter/Index Plotter)................................................................................ 635
DAQ - Trigger (Time Plotter/Index Plotter)............................................................................... 637
Time Plotter............................................................................................................................ 384

240
ControlDesk Instrument Handling May 2024
Variable Array Handling

Variable Array Handling


Introduction The Variable Array lets you calibrate and measure the values of scalar
parameters.

Where to go from here Information in this section

Basics of Handling the Variable Array..................................................... 241


The Variable Array provides customizable rows for variables to be
calibrated and measured.

How to Configure the Variable Array..................................................... 244


You can configure the Variable Array according to your needs.

How to Change Values with the Variable Array (Alphanumeric


Input Value Cell Type)............................................................................ 246
The Variable Array (Alphanumeric Input value cell type) lets you calibrate
the values of scalar parameters. You can also edit the content of ASCII
variables (strings).

How to Change Values with the Variable Array (Bitfield Editor


Value Cell Type)..................................................................................... 249
The Variable Array (Bitfield Editor value cell type) lets you calibrate
parameters as bit strings.

How to Visualize Variable States with the Variable Array


(Multistate LED Value Cell Type)............................................................. 251
You can visualize certain states, ranges, or thresholds of a variable with
colored LEDs via the Variable Array (Multistate LED value cell type).

Basics of Handling the Variable Array

Introduction The Variable Array provides customizable rows for variables to be calibrated and
measured.

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 ( )

241
May 2024 ControlDesk Instrument Handling
Basics and Instructions

§ Struct array ( )
§ Value ( )
§ Value block ( )

Each variable is displayed in a row of the instrument.

Title bar
Header

Instrument row

Selected
variable

Instrument column Instrument cell

The Variable Array provides different column and cell types. The combination of
both lets you specify what is displayed in the instrument cells and how you can
change a parameter value.

The Variable Array is divided into the following areas:

Title bar Displays the instrument name, the name of the selected variable
and the unit of the variable (if available).

Header Displays information on the selected variable.

Instrument row Each row in the Variable Array represents a variable.


Depending on the selected column and instrument cell type it displays
information on the variable or lets you display or calibrate the variable value.
If you place the same variable in a Variable Array several times, it is displayed in
several rows. Each row can be configured differently.

Instrument column Specifies the usage type of the instrument cells in the
column, for example which type of information can be displayed. You can add,
delete and configure the columns.
The first column of the Variable Array displays the variable type of the variables.

Symbol Description
Scalar parameters, including individual elements of a
value block.
Scalar measurement variables, including individual
elements of a measurement array and system
variables.

242
ControlDesk Instrument Handling May 2024
Variable Array Handling

The Indicator column displays the current state of the connected parameter.

Symbol Description
Proposed calibration
Proposed calibration is active, value has not been changed.

Proposed calibration is active, the value has been changed.

Tendency symbols (not available for platforms)


The working data set is active and the value of the variable in the working data
set is higher than the value in the reference data set.
The working data set is active and the value of the variable in the working data
set is lower than the value in the reference data set.
The working data set is active and the value of the variable in the working data
set is equal to the value in the reference data set.
The working data set is active and the value of the variable in the working data
set is unequal to the value in the reference data set. This applies only to ASCII
variables.
Reference symbols
The reference data set is active (not available for platforms).

The working data set is active, but the value of the reference data set is shown
in this row of the instrument. For platforms, the value of the initial data set is
shown (if available).

Instrument cell Displays information on a variable according to the


instrument column and instrument cell type.
The value cell provides several cell types for the displaying or calibrating of
variables values. Value cell types can be thought as small-sized instruments which
can be embedded in a Variable Array. You can choose the following cell types to
calibrate parameters in the Variable Array.

Cell Type Illustration Description


Alphanumeric To display the value of a numeric variable or
Display the text content of an ASCII variable.
Alphanumeric Input To edit and display the value of a numerical
parameter or the text content of an ASCII
variable.
Bar To display the value of variable via a bar
deflection.

Bitfield Editor To edit and display the value of a scalar


parameter as a bit string (always displayed as a
source value regardless of the selected display
mode).
LED To display the value of a variable as an LED
state.
Slider To edit and display the value of a numerical
parameter by a slide.

Push Button To set the variable's value to a predefined value


when you press the button.

243
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Cell Type Illustration Description


On/Off Button To set the variable's value to a predefined value
when you press the button (On value) and
when you release the button (Off).
Check Button To set the variable's value to a predefined value
when you activate the checkbox (On value)
and when you clear it (Off value), and to
display if one of the predefined values is the
current value of the connected variable (if not,
it is grayed).

Related topics Basics

Instruments and the Variable Types they can Visualize............................................................... 37

References

Variable Array......................................................................................................................... 389

How to Configure the Variable Array

Objective You can configure the Variable Array according to your needs.

Properties of the Variable You can configure the Variable Array via the Properties pane and via the context
Array menu.

The following table lists some examples:

Property Description
Via Properties Pane:
Name To change the name of the
instrument.
Size and Position To set the size and position of
the instrument.
Text/Numeric Output Font To specify the font of the
selected item.
Via Context Menu:
Cell – Change Type To change the cell type of a
value cell.
Columns – Customize To configure the columns of the
Variable Array.

244
ControlDesk Instrument Handling May 2024
Variable Array Handling

Property Description
Row – Highlighted – Enabled To highlight the currently
selected rows. Multiple selection
is possible.

Possible methods § To configure properties of the Variable Array via the Properties pane, refer to
Method 1 on page 245.
§ To configure specific instrument cells of the Variable Array, refer to Method 2
on page 246.

Method 1 To configure the Variable Array via the Properties pane


1 From the context menu of the instrument, select Instrument Properties.
ControlDesk activates the Properties pane and displays the properties of the
selected Variable Array.

Tip

The Variable Array allows multiple selection of rows.

245
May 2024 ControlDesk Instrument Handling
Basics and Instructions

2 Select the properties and configure them according to your needs.

Tip

§ You can use the buttons below the title bar to expand or collapse
categories and properties.

§ Click or select Edit - Assign Properties to assign the property


settings of shared properties from the currently selected instrument
to the next one you select.

Method 2 To configure the Variable Array via the context menu


1 From the context menu of the instrument cell, select a command that lets
you specify specific properties for cells, rows, or columns.
The available commands depend on the cell that is currently selected.

Tip

Multiple selection of rows is possible.

Result The Variable Array is configured.

Related topics Basics

Basics of Handling the Variable Array...................................................................................... 241

How to Change Values with the Variable Array (Alphanumeric Input Value
Cell Type)

Objective The Variable Array (Alphanumeric Input value cell type) lets you calibrate the
values of scalar parameters. You can also edit the content of ASCII variables
(strings).

Alphanumeric Input value cell You can visualize a scalar parameter in an Alphanumeric Input value cell of a
type Variable Array. If you visualize multiple parameters, each parameter is displayed
in a separate instrument row of a Variable Array. Information on the currently
selected parameter is displayed in the information header below the title bar.

246
ControlDesk Instrument Handling May 2024
Variable Array Handling

Variables using table conversion have a list displaying the strings of the table.

For information on variables using table conversion, refer to Basics on Variables


Using Conversion Tables (ControlDesk Variable Management ).

Range check You can activate a specific range check for an Alphanumeric Input value cell
via its context menu. If you enter a value outside of this range, the cell is
highlighted.

Restrictions You can change a parameter value only within its hard limits. A short beep
indicates that a value was not changed.

Preconditions A parameter must be assigned to the instrument. Refer to How to Connect


Variables and Framework Labels to Instruments (ControlDesk Layouting ).

The working page must be activated. Refer to How to Activate the Working or
Reference Page (ControlDesk Calibration and Data Set Management ).

Possible methods You can use different methods to change the values:
§ If you want to change the values via the Edit field of the instrument row, refer
to Method 1.
§ If you want to change values via the Adjust Value(s) dialog, refer to Method 2.

Method 1 To change values with the Variable Array (Alphanumeric Input value cell)
via the edit field of the instrument row
1 Click the edit field in an instrument row and enter a value, or select the
row and type the new value. If the variable has table conversion, select a
value from the list or enter a new value if this is possible. You can enter the
values in decimal, binary (preceded by 0b), or hexadecimal (preceded by 0x
or followed by h) format regardless of the selected display format (Bin, Dec,
Hex, or Physical).

247
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Tip

In the spin boxes, you can increase and decrease a value by dragging
the cursor. Click the line between the up and down arrows and drag
the cursor up or down (for an animated graphic, refer to dSPACE Help).

Tip

You can make the selection of strings from a list easier.


§ Press the first character of a list entry to jump to an entry that begins
with this character.
§ From the context menu of the Alphanumeric Input cell, select Display
Value(s) and activate Compu Tab Items Sorted to sort the table
entries alphabetically.

If you change a value via a spin button (or via PageUp/Down) small
increments are used. Press Ctrl when changing the value to use big
increments. To specify small and big increments, select Adjust values –
Increments from the row's context menu.
2 Press Enter to confirm your entry.

Method 2 To change values with the Variable Array (Alphanumeric Input value cell
type) via the Adjust Value(s) dialog
1 From the context menu of an instrument row, select Adjust Value(s) and
select an operation (Add, Multiply, Divide, Assign), or press +, *, /, or =.
A dialog to enter an operand opens.
2 Enter a value as the operand to change the variable value.

Result The parameter value is changed.

Related topics HowTos

How to Configure the Variable Array...................................................................................... 244

References

Variable Array......................................................................................................................... 389

248
ControlDesk Instrument Handling May 2024
Variable Array Handling

How to Change Values with the Variable Array (Bitfield Editor Value Cell Type)

Objective The Variable Array (Bitfield Editor value cell type) lets you calibrate parameters as
bit strings.

Bitfield Editor value cell type You can visualize a scalar parameter in bit format in a Bitfield Editor value cell of
a Variable Array. If you visualize multiple parameters, each parameter is displayed
in a separate instrument row of a Variable Array. Information on the currently
selected parameter is displayed in the information header below the title bar.

A Bitfield Editor shows the source value of a parameter as a bit string designed
like DIP switches. The upper row contains the bits with value 1, the lower row
contains the bits with value 0.

Restrictions You can change a parameter value only within its hard limits. A short beep
indicates that the value was not changed.

Preconditions A parameter must be assigned to the instrument. Refer to How to Connect


Variables and Framework Labels to Instruments (ControlDesk Layouting ).

The working page must be activated. Refer to How to Activate the Working or
Reference Page (ControlDesk Calibration and Data Set Management ).

Possible methods You can use different methods to change values in bit format:
§ If you want to open a dialog that lets you specify the bits to be toggled by
entering their numbers, see Method 1 on page 249.
§ If you want to toggle bits by clicking them with the mouse, see Method 2 on
page 250.
§ If you want to open a dialog that lets you use an operation to change a value,
see Method 3 on page 250.

Method 1 To change values with the Variable Array (Bitfield Editor value cell type)
via the Enter Bits to be Toggled dialog
1 From the context menu of the selected instrument row, click Display
Value(s) and select one of the source display modes.
2 From the context menu of the selected instrument row, click Adjust
Value(s) - Toggle Bits, or press F2, or enter a value.

249
May 2024 ControlDesk Instrument Handling
Basics and Instructions

The Enter Bits to be Toggled dialog opens.

3 Enter the numbers of the bits that you want to toggle.

Method 2 To change values with the Variable Array (Bitfield Editor value cell type)
using the mouse
1 Point to the bit you want to toggle.
A square around the selected bit appears.

2 Click the upper or lower bit button to toggle the selected bit.

Method 3 To change values with the Variable Array (Bitfield Editor value cell type)
via the Adjust Value(s) dialog
1 From the context menu of an instrument row, select Adjust Value(s) and
select an operation (Add, Multiply, Divide, Assign), or press +, *, /, or =.
A dialog to enter an operand opens.
2 Enter a value as the operand to change the variable value.

Result The value of the parameter is changed.

Related topics HowTos

How to Configure the Variable Array...................................................................................... 244

References

Variable Array......................................................................................................................... 389

250
ControlDesk Instrument Handling May 2024
Variable Array Handling

How to Visualize Variable States with the Variable Array (Multistate LED Value
Cell Type)

Objective You can visualize certain states, ranges, or thresholds of a variable with colored
LEDs via the Variable Array (Multistate LED value cell type).

Configuring checking order of The Multistate LED instrument checks an LED state list from bottom to top. If a
states value matches none of the state conditions, the LED is displayed in the color of
the default state.

Method To visualize variable states with the Variable Array (Multistate LED value
cell type)
1 From the context menu of the LED value cell, select Instrument Properties.
The Properties pane is activated.

2 Open the Selected Cells properties.

3 Click the Add symbol to add a state to the variable and define the color
and range for this state. The minimum and maximum value of a range can
be entered as source or as converted values.

Note

Click the bracket symbols in the Incl. min. and Incl. max. columns
to define precise minimum and maximum values for the range. For
example, if the Range max. value is set to 400 and ] is selected, the
value 400 is included in this range, otherwise it is excluded. Keep in
mind that the Multistate LED instrument checks an LED state list from
bottom to top.

4 Repeat step 2 to define more states of the selected variable.


5 Click Close.

251
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Result The LED is displayed in the specified color each time the variable value matches
the state condition. If the value matches none of the state conditions, the LED is
displayed in the color of the default state.

Related topics HowTos

How to Configure the Variable Array...................................................................................... 244

References

LED States Properties (Value Cell – Multistate LED).................................................................. 491


Variable Array......................................................................................................................... 389

252
ControlDesk Instrument Handling May 2024
XY Plotter Handling

XY Plotter Handling
Introduction The XY Plotter lets you display signals as functions of other signals.

Where to go from here Information in this section

Basics of Handling the XY Plotter........................................................... 253


The XY Plotter lets you visualize signals in relation to other signals.

Zooming and Moving the Chart (XY Plotter).......................................... 257


You can switch between different modes to zoom into the chart or move
the chart.

XY Plots................................................................................................. 259
The XY Plotter uses both axes as signal axes.

How to Configure the XY Plotter........................................................... 260


You can change the XY Plotter settings, for example, the color of the
signal, even if the measurement is running.

Basics of Handling the XY Plotter

Introduction The XY Plotter lets you visualize signals in relation to other signals.

XY Plotter Chart area Cursor info

Y-axis

Scale label

Axis label

Curve symbol X-axis Data cursor

253
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Selecting the optimum plotter ControlDesk provides the following plotter types:
type § Time Plotter
§ Index Plotter
§ XY Plotter

For information on selecting the optimum plotter type for your task, refer to
Choosing Between Time Plotter, Index Plotter, and XY Plotter on page 40.

Instrument elements
Displaying Cursors

This video gives you an overview of how to display plotter cursors.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/dyuhf

Specifying Plotter Signal Settings

This video shows you how to specify plotter signal properties.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/35acf

X-axis and y-axis The XY Plotter uses the x- and the y-axis as signal axes. You
must connect a signal to each axis to display a curve. The XY Plotter allows you
to display several curves in one chart.

Tip

§ To rescale an axis to the dimension needed to display all curves, double-


click it.
§ To rescale both axes, double-click the chart area.

Chart area Displays the XY plots of one or more curves. The curves can be
displayed in several styles and colors.

Data cursor and cursor info One or two cursors can be used to specify chart
positions. The positions of the cursors and the distance between them can be
displayed at the cursor info position.

254
ControlDesk Instrument Handling May 2024
XY Plotter Handling

Time cursor A time cursor can be used to specify a time position in the chart.

Curve symbol The curve symbol is split into two areas that represent the
connected variables and the status of the connection.

Symbol Description
No variable is connected.

Only the x-axis is connected to a variable.

Only the y-axis is connected to a variable.

Both axes are connected to a variable.

The axis-variable connection is invalid for at least one axis. For


example, the connected variables can have different raster settings.
Move the mouse pointer over the symbol to open a tooltip with
information on the reasons.

Connections You can place signals on the XY Plotter via drag & drop. The visualization of
signals in an XY Plotter depends on where you drop the signal. The destination is
highlighted.

Tutorial video

Sensitive Areas and Adding Signals


This video shows you how to connect signals to different sensitive areas of a
plotter.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/gK9av

Equal platform or device The two signals of a curve must be measured on


the same platform or device. If signals from different platforms or devices are

connected, the curve symbol indicates the invalid connection: .

Equal measurement raster settings The two signals of a curve must have
the same measurement raster settings. If signals with different raster settings are

connected, the curve symbol indicates the invalid connection: .

Equal length of measurement arrays You can connect one-dimensional


measurement arrays to the x- and y-axis of an XY Plotter if they have the
same length. If signals with a different length are connected, the curve symbol

indicates the invalid connection: .

255
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Connecting 1-dimensional measurement arrays allows you to display the


trajectory of a moving object in an XY Plotter, for example.

Connecting a signal to an x- or y-axis Drop the signal on the x- or y-axis. If


the axis is already connected, a new curve is added.

Connecting a signal to an existing curve Drop the signal on the desired


area of the curve symbol. If the axis is already connected the connected signal is
replaced.

Connectable variable types For an overview on the variable types you can connect to an instrument, refer to
Instruments and the Variable Types they can Visualize on page 37.

XY Plotter visualization The XY Plotter always shows the data of the current capture. Each new capture
replaces the data of the previous one. You do not have to switch between
continuous or triggered visualization.

Reducing the number of You can limit the number of displayed data points. This is particularly useful
displayed data points when you perform continuous (untriggered) measurements:
§ You can specify the length of the curve.
§ You can improve the performance if there is a large number of data points.

Reference signals You can connect signals from recordings to the XY Plotter and use them as
reference signals for the currently measured data.

Related topics Basics

Instruments and the Variable Types they can Visualize............................................................... 37


Zooming and Moving the Chart (Index Plotter)....................................................................... 124

256
ControlDesk Instrument Handling May 2024
XY Plotter Handling

HowTos

How to Configure the XY Plotter............................................................................................ 260

References

XY Plotter............................................................................................................................... 396

Videos

Comparing Time Plotter, Index Plotter, and XY Plotter (3:41) in dSPACE Help
Specifying Plotter Settings in the Properties Pane (2:41) in dSPACE Help

Zooming and Moving the Chart (XY Plotter)

Introduction You can switch between different modes to zoom into the chart or move the
chart.

Tutorial video
Zooming and Moving

This video shows you how to zoom into the chart area and how to move the
chart.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/hFuT2

Zoom mode The chart area and the axes can be set to zoom mode via context menu. The
mouse pointer shows you the active mode.

Mouse Pointer Description


Zoom mode: You can specify the zoom area.

257
May 2024 ControlDesk Instrument Handling
Basics and Instructions

Move mode The chart area and the axes can be set to move mode via context menu. The
mouse pointer shows the active mode.

Mouse Pointer Description


Move mode (chart area): You can move the
chart in the x‑axis and the y‑axis directions.
Move mode (x‑axis): You can move the chart in
the x‑axis direction.
Move mode (y‑axis): You can move the chart in
the y‑axis direction.

Zooming and moving the You can use various methods to zoom or move the chart. See the following
chart table.

Mouse Gesture1), 2) Shortcut Key Purpose


Move and zoom mode
– – O2) To show or hide a scroll bar below the x-axis.3)
To navigate through the measurement, drag the scroll box as shown
below.

To specify the zoom settings, drag the edges of the scroll box as shown
below (for an animated graphic, refer to dSPACE Help).

– – M To set the chart view to move mode.


– – Z To set the chart view to zoom mode.
– To rescale the chart.
§ Use the chart to rescale both axes.
§ Use an axis to rescale the selected axis.
Zoom mode
– – To zoom into the chart by dragging the mouse pointer.

– To zoom into the chart.


§ Use the chart area to zoom into both axes.
(Scroll wheel) § Use an axis to zoom into the selected axis.
– To zoom out.
§ Use the chart area to zoom out of both axes.
(Scroll wheel) § Use an axis to zoom out of the selected axis.
Move mode

258
ControlDesk Instrument Handling May 2024
XY Plotter Handling

Mouse Gesture1), 2) Shortcut Key Purpose


– To move the chart in any direction (available on the chart area).

– To move the chart horizontally (available on the x‑axis).

– To move the chart vertically (available on the y‑axis).

Ctrl – – To zoom the axis while you are in move mode (available on the x‑axis
+
and on the y‑axis).
1) If you are using a multi-touch capable display, you can use gestures to zoom or move
the chart.
2) Available only for Time Plotter and Index Plotter.
3) You must stop a running measurement to use the scroll bar. For information on the
scroll bar settings, refer to Scroll Bar Properties (Time Plotter/Index Plotter) on page 527.

Related topics Basics

Basics of Handling the XY Plotter............................................................................................ 253

References

Rescale................................................................................................................................... 696
Switch to Move Mode / Switch to Zoom Mode (XY Plotter)..................................................... 721
XY Plotter............................................................................................................................... 396

XY Plots

Introduction The XY Plotter uses both axes as signal axes.

XY plots The following illustrations show a time plot (XT plot) and an XY plot of the
signals x and y. In the XY plot the x-axis represents the value range of the
x-signal and the y-axis that of the y-signal. The sample points are numbered to
show the related points in time in the two illustrations.

259
May 2024 ControlDesk Instrument Handling
Basics and Instructions

x 4
3 5
1.0 2 6 XT plot
7
1
0.5 y
8

9
0.0
10

-0.5 11

12 13
14 15 x
-1.0
0 1 2 3 4 5 t

y
1.0
XY plot

1
0.5
2
15 3

0.0 14 4

13 5

-0.5 12 6

11 7
10 9 8
-1.0
-1.0 -0.9 -0.8 -0.7 -0.6 -0.5 -0.4 -0.3 -0.2 -0.1 0.0 0.1 0.2 0.3 0.4 0.5 0.6 0.7 0.8 0.9 1.0 x

The trajectory curve (XY plot) is defined by the starting point (1) and the end
point (15).

Related topics Basics

Basics of Handling the XY Plotter............................................................................................ 253

How to Configure the XY Plotter

Objective You can change the XY Plotter settings, for example, the color of the signal, even
if the measurement is running.

260
ControlDesk Instrument Handling May 2024
XY Plotter Handling

Tutorial video
Specifying Plotter Settings in the Properties Pane

This video shows you how to specify plotter settings in the Properties pane.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/eLfby

XY Plotter properties The XY Plotter provides a number of properties on the Properties pane which
you can also set via the XY Plotter's context menu. Some examples are listed
below.

You can change settings for the axes of the XY Plotter, for example:
§ Scaling mode (Floating, Extended, Fixed)
§ Tic format (Standard, Exponential, Engineering)
§ Minimum and maximum values of the axis, if Scaling mode is set to Fixed.

You can change settings for the curves, for example:


§ Line width for a curve (in pixels)
§ Point size for a curve (in pixels)

The changes can be made during a running measurement.

You can change various other settings sorted by different categories. Click a
property on the Properties pane and read the short information at the bottom
of the pane. Press F1 or click the header of the short information to get detailed
information on a specific property.

Method To configure the XY Plotter


1 From the context menu of the XY Plotter, select Instrument Properties.

261
May 2024 ControlDesk Instrument Handling
Basics and Instructions

ControlDesk activates the Properties pane and displays the properties of the
selected XY Plotter.

The listed properties depend on the element that is selected in the


instrument. In the XY Plotter, you can select the following elements:
§ X-axis
§ Y-axis
§ Chart
§ Curve (select the curve or the curve symbol)
2 Select the properties and configure them according to your needs.

Tip

§ Via the buttons below the title bar of the Properties pane, you can:
§ Expand or collapse categories and properties
§ Search and filter the pane content
§ On the Layouting ribbon, click Instruments – Assign Properties to
assign the property settings of shared properties from the currently
selected instrument to the next one you select.

Result The XY Plotter's settings have been changed.

262
ControlDesk Instrument Handling May 2024
XY Plotter Handling

Related topics Basics

Basics of Handling the XY Plotter............................................................................................ 253


Zooming and Moving the Chart (XY Plotter)........................................................................... 257

References

XY Plotter............................................................................................................................... 396

263
May 2024 ControlDesk Instrument Handling
Basics and Instructions

264
ControlDesk Instrument Handling May 2024
Reference Information

Reference Information

Where to go from here Information in this section

Instrument Descriptions......................................................................... 266

Instrument-Related Properties................................................................ 402

Instrument-Related Commands............................................................. 571

265
May 2024 ControlDesk Instrument Handling
Reference Information

Instrument Descriptions
Where to go from here Information in this section

Automotive Controls............................................................................. 267


The Automotive Controls category in the Instrument Selector
provides various gearshift levers and a steering wheel.

Avionics Instruments.............................................................................. 268


The Avionics Instruments category in the Instrument Selector
provides avionics instruments.

Browser Samples................................................................................... 276


The Browser Samples category in the Instrument Selector provides the
Map instrument.

Date and Time....................................................................................... 279


The Date and Time category in the Instrument Selector provides
instruments that let you display the host PC system time and/or date on a
layout in different formats.

FPGA Instruments.................................................................................. 280


The FPGA Instruments category in the Instrument Selector provides
the FPGA Scope instrument.

Gauges Automotive............................................................................... 295


The Gauges Automotive category in the Instrument Selector provides
gauges with common instrument symbols.

LEDs Automotive................................................................................... 296


The LEDs Automotive category in the Instrument Selector provides
LEDs with common instrument symbols.

Measurement........................................................................................ 298
The Measurement category in the Instrument Selector provides
various instruments with common instrument symbols for measurement
purposes.

Standard Instruments............................................................................ 300


The Standard Instruments category in the Instrument Selector
contains all the instruments of ControlDesk with their default properties
settings.

Stopwatches.......................................................................................... 399
The Stopwatches category in the Instrument Selector provides analog
and digital stopwatches with and without lap time function.

266
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Automotive Controls
Introduction The Automotive Controls category in the Instrument Selector provides
various gearshift levers and a steering wheel.

Automotive Controls Library

Introduction The instruments in this library are based on standard instruments. You can use
them as templates in your own projects and change them according to your
needs.

Instrument Name Representation


dSPACE Car sounds

dSPACE Gearstick automatic

dSPACE Gearstick 5H

dSPACE Gearstick 6H

dSPACE Steering wheel

267
May 2024 ControlDesk Instrument Handling
Reference Information

Avionics Instruments
Introduction The Avionics Instruments category in the Instrument Selector provides
avionics instruments.

Where to go from here Information in this section

Airspeed Indicator................................................................................. 268


To indicate the airspeed of a simulated aircraft.

Altimeter............................................................................................... 270
To indicate the altitude of a simulated aircraft.

Artificial Horizon.................................................................................... 272


To indicate a simulated aircraft's pitch and roll.

Heading Indicator.................................................................................. 275


To indicate the direction a simulated aircraft is headed in.

Airspeed Indicator

Illustration

Caption with BLOCK and VARIABLE macro

Visible neighbor

Magnifier Airspeed

Visible neighbor

Airspeed indicator scale with colored bands

Purpose To indicate the airspeed of a simulated aircraft.

Description The Airspeed Indicator displays the airspeed of a simulated aircraft. When the
airspeed of the aircraft changes, the Airspeed Indicator scale scrolls and the
magnifier shows the exact airspeed. You can mark speed ranges with colored
bands.

268
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Instrument properties The Airspeed Indicator provides the following properties:

Property Purpose
Active Property on page 415 To activate or deactivate the instrument.
Alignment Property on page 419 To configure the alignment.
Background Properties on page 433 To configure the background properties of the current instrument.
Bands Properties (Airspeed Indicator) on page 436 To configure the properties of the bands.
Border Properties on page 437 To configure the border settings of an instrument.
Captions/Operating Elements Properties on To add and remove captions and configure the properties of operating
page 443 elements.
Description Property on page 465 To specify a description for the instrument.
Magnifier Properties on page 494 To configure the properties of the magnifier.
Name Property on page 503 To specify the name of the selected instrument.
Scale Properties (Avionics) on page 525 To configure the properties of the scale.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
Size and Position Properties (Scale and Magnifier) To specify the relative size and position of the scale and magnifier inside the
on page 534 instrument.
Tooltip Property on page 560 To specify a tooltip for the instrument.
Use Custom Colors Property on page 561 To enable or disable custom color settings for the instrument.
Use Custom Fonts Property on page 562 To enable or disable global font settings for the instrument.
Variables Properties on page 562 To display and configure the variables that are connected to the instrument.

Related commands The Airspeed Indicator provides the following commands:

Command Purpose
Bitmask on page 595 To specify the bitmask for the currently selected variable.
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Connect as Main Variable / Connect Variable(s) on To connect the selected variable to the instrument as the main variable.
page 619
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Copy Value (Instruments) on page 629 To copy the value that is displayed in the instrument.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Dec (Source) on page 638 To display a value in dec (source) mode.
Delete (Instrument) on page 639 To delete the selected instruments.
Display Formats on page 647 To specify the display format for the selected variable.
Instrument Properties on page 666 To view and edit the properties of an instrument.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Physical (Converted) on page 689 To display a value in the instrument in physical (converted) mode.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.

269
May 2024 ControlDesk Instrument Handling
Reference Information

Command Purpose
Show Current/Reference on page 710 To specify whether to display the current value or the reference value in the
current instrument.
Variable(s) - Add on page 730 To connect a variable to an instrument.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.
Copy / Variables - Copy on page 626 To copy the selected variables to the Clipboard.
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.
Variables - Delete on page 734 To delete the selected variables.
Variables - Paste/Paste Variables on page 735 To paste variables from the Clipboard to an instrument.
Variable(s) - Select in Variables/Mappings Pane on To select and highlight variables in the Variables pane, or framework labels in
page 731 the Mappings pane.
Variable(s) Properties on page 732 To show the Properties dialog of a connected variable.

Altimeter

Illustration

Caption with BLOCK and VARIABLE macro

Visible neighbor

Magnifier

Visible neighbor

Altimeter scale

Purpose To indicate the altitude of a simulated aircraft.

Description The Altimeter displays the altitude of a simulated aircraft. When the altitude of
the aircraft changes, the altimeter scale scrolls and the magnifier shows the exact
altitude.

Instrument properties The Altimeter provides the following properties:

Property Purpose
Active Property on page 415 To activate or deactivate the instrument.
Alignment Property on page 419 To configure the alignment.

270
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Property Purpose
Background Properties on page 433 To configure the background properties of the current instrument.
Border Properties on page 437 To configure the border settings of an instrument.
Captions/Operating Elements Properties on To add and remove captions and configure the properties of operating
page 443 elements.
Description Property on page 465 To specify a description for the instrument.
Magnifier Properties on page 494 To configure the properties of the magnifier.
Name Property on page 503 To specify the name of the selected instrument.
Scale Properties (Avionics) on page 525 To configure the properties of the scale.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
Size and Position Properties (Scale and Magnifier) To specify the relative size and position of the scale and magnifier inside the
on page 534 instrument.
Tooltip Property on page 560 To specify a tooltip for the instrument.
Use Custom Colors Property on page 561 To enable or disable custom color settings for the instrument.
Use Custom Fonts Property on page 562 To enable or disable global font settings for the instrument.
Variables Properties on page 562 To display and configure the variables that are connected to the instrument.

Related commands The Altimeter provides the following commands:

Command Purpose
Bitmask on page 595 To specify the bitmask for the currently selected variable.
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Connect as Main Variable / Connect Variable(s) on To connect the selected variable to the instrument as the main variable.
page 619
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Copy Value (Instruments) on page 629 To copy the value that is displayed in the instrument.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Dec (Source) on page 638 To display a value in dec (source) mode.
Delete (Instrument) on page 639 To delete the selected instruments.
Display Formats on page 647 To specify the display format for the selected variable.
Instrument Properties on page 666 To view and edit the properties of an instrument.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Physical (Converted) on page 689 To display a value in the instrument in physical (converted) mode.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Show Current/Reference on page 710 To specify whether to display the current value or the reference value in the
current instrument.
Variable(s) - Add on page 730 To connect a variable to an instrument.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.
Copy / Variables - Copy on page 626 To copy the selected variables to the Clipboard.

271
May 2024 ControlDesk Instrument Handling
Reference Information

Command Purpose
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.
Variables - Delete on page 734 To delete the selected variables.
Variables - Paste/Paste Variables on page 735 To paste variables from the Clipboard to an instrument.
Variable(s) - Select in Variables/Mappings Pane on To select and highlight variables in the Variables pane, or framework labels in
page 731 the Mappings pane.
Variable(s) Properties on page 732 To show the Properties dialog of a connected variable.

Artificial Horizon

Illustration

Roll pointer Zero pointer

Upper sky

Roll scale

Lower sky

Horizon

Aircraft symbol Upper land

Pitch scale

Lower land

Purpose To indicate a simulated aircraft's pitch and roll.

Description The Artificial Horizon lets you display the rotation on both the lateral and the
longitudinal axis of a simulated aircraft to indicate the angle of the aircraft's
pitch and roll.

272
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Longitudinal

Lateral

Pitch
Roll

The principal elements of the Artificial Horizon are:


§ A horizon view showing the upper/lower land and upper/lower sky, separated
by a horizon line. The movement of the land and sky indicates the position of
the aircraft.
§ An Aircraft symbol.
§ A pitch scale and roll scale with a roll pointer. The pitch scale and the roll scale
rotate in synchronization with the aircraft’s movements.

Instrument properties The Artificial Horizon provides the following properties:

Property Purpose
Active Property on page 415 To activate or deactivate the instrument.
Aircraft Symbol Properties (Artificial Horizon) on To configure the properties of the aircraft symbol.
page 417
Border Properties on page 437 To configure the border settings of an instrument.
Center Point X Property on page 450 To configure the center point's position on the x-axis.
Center Point Y Property on page 450 To configure the center point's position on the y-axis.
Description Property on page 465 To specify a description for the instrument.
Horizon View Properties on page 477 To configure the properties of the Horizon view.
Name Property on page 503 To specify the name of the selected instrument.
Pitch Scale Properties on page 513 To configure the properties of the pitch scale.
Roll Scale Properties on page 518 To configure the properties of the roll scale.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
Tooltip Property on page 560 To specify a tooltip for the instrument.
Use Custom Colors Property on page 561 To enable or disable custom color settings for the instrument.
Use Custom Fonts Property on page 562 To enable or disable global font settings for the instrument.
Variables Properties on page 562 To display and configure the variables that are connected to the instrument.

273
May 2024 ControlDesk Instrument Handling
Reference Information

Related commands The Artificial Horizon provides the following commands:

Command Purpose
Bitmask on page 595 To specify the bitmask for the currently selected variable.
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Connect as Pitch on page 620 To connect the selected variable to the Artificial Horizon as the pitch variable.
Connect as Roll on page 620 To connect the selected variable to the Artificial Horizon as the roll variable.
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Copy Value (Instruments) on page 629 To copy the value that is displayed in the instrument.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Dec (Source) on page 638 To display a value in dec (source) mode.
Delete (Instrument) on page 639 To delete the selected instruments.
Display Formats on page 647 To specify the display format for the selected variable.
Instrument Properties on page 666 To view and edit the properties of an instrument.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Physical (Converted) on page 689 To display a value in the instrument in physical (converted) mode.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Show Current/Reference on page 710 To specify whether to display the current value or the reference value in the
current instrument.
Variable(s) - Add on page 730 To connect a variable to an instrument.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.
Copy / Variables - Copy on page 626 To copy the selected variables to the Clipboard.
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.
Variables - Delete on page 734 To delete the selected variables.
Variables - Paste/Paste Variables on page 735 To paste variables from the Clipboard to an instrument.
Variable(s) - Select in Variables/Mappings Pane on To select and highlight variables in the Variables pane, or framework labels in
page 731 the Mappings pane.
Variable(s) Properties on page 732 To show the Properties dialog of a connected variable.

Related topics Basics

Basics of Handling the Artificial Horizon.................................................................................. 103

274
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Heading Indicator

Illustration
Numeric display

Lubber line

Heading indicator scale

Purpose To indicate the direction a simulated aircraft is headed in.

Description The Heading Indicator indicates the heading direction. When the direction of the
simulated aircraft changes, the heading scale rotates and the indicator indicates
the current heading angle. The zero point of the scale is north. The scale
readings always represent the heading angle as "degrees divided by 10". For
example, 140° are represented as 14.

Instrument properties The Heading Indicator provides the following properties:

Property Purpose
Active Property on page 415 To activate or deactivate the instrument.
Background Properties on page 433 To configure the background properties of the current instrument.
Border Properties on page 437 To configure the border settings of an instrument.
Description Property on page 465 To specify a description for the instrument.
Lubber Line Properties on page 494 To configure the properties of the lubber line.
Name Property on page 503 To specify the name of the selected instrument.
Numeric Display Properties on page 505 To configure the properties of the numeric display.
Scale Properties (Avionics) on page 525 To configure the properties of the scale.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
Tooltip Property on page 560 To specify a tooltip for the instrument.
Use Custom Colors Property on page 561 To enable or disable custom color settings for the instrument.
Use Custom Fonts Property on page 562 To enable or disable global font settings for the instrument.
Variables Properties on page 562 To display and configure the variables that are connected to the instrument.

275
May 2024 ControlDesk Instrument Handling
Reference Information

Related commands The Heading Indicator provides the following commands:

Command Purpose
Bitmask on page 595 To specify the bitmask for the currently selected variable.
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Connect as Main Variable / Connect Variable(s) on To connect the selected variable to the instrument as the main variable.
page 619
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Copy Value (Instruments) on page 629 To copy the value that is displayed in the instrument.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Dec (Source) on page 638 To display a value in dec (source) mode.
Delete (Instrument) on page 639 To delete the selected instruments.
Display Formats on page 647 To specify the display format for the selected variable.
Instrument Properties on page 666 To view and edit the properties of an instrument.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Physical (Converted) on page 689 To display a value in the instrument in physical (converted) mode.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Show Current/Reference on page 710 To specify whether to display the current value or the reference value in the
current instrument.
Variable(s) - Add on page 730 To connect a variable to an instrument.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.
Copy / Variables - Copy on page 626 To copy the selected variables to the Clipboard.
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.
Variables - Delete on page 734 To delete the selected variables.
Variables - Paste/Paste Variables on page 735 To paste variables from the Clipboard to an instrument.
Variable(s) - Select in Variables/Mappings Pane on To select and highlight variables in the Variables pane, or framework labels in
page 731 the Mappings pane.
Variable(s) Properties on page 732 To show the Properties dialog of a connected variable.

Browser Samples
Introduction The Browser Samples category in the Instrument Selector provides the Map
instrument.

276
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Map

Illustration

Zoom Content area Marker Route

Purpose To visualize GNSS positioning data in a map.

Description The Map instrument can be used to display GNSS positioning data . This lets
you display the motion of a car in relation to the time stamps of recorded signals,
for example.

Note

The map data is provided by the OpenStreetMap® project. This dSPACE


software might show content of OpenStreetMap® during run time, i.e.,
open data licensed under the Open Data Commons Open Database License
(ODbL) by the OpenStreetMap Foundation (OSMF). If you want to use the
content in the public domain, e.g., an image that is derived from said data,
you must add a credit to OpenStreetMap and the Open Database License as
described on: http://www.openstreetmap.org/copyright/en.

Content area The map content area displays a specific map tile that is
specified by the map coordinates (latitude and longitude) and the selected zoom
value.

Zoom In combination with the map coordinates, the selected zoom specifies
the map tile to be displayed.

277
May 2024 ControlDesk Instrument Handling
Reference Information

Marker The marker that shows the position of the current latitude and
longitude values in the map. Latitude and longitude are connection nodes of the
map. You must connect appropriate measurement variables from a measurement
or recording to both connection nodes.

Route The route visualizes the course already traveled.

Map as customized Browser The Map instrument is a Browser instrument extended by custom properties.
instrument The instrument uses an instrument script to open a web map with map data
provided by the OpenStreetMap® project.

All necessary files, such as the web page and all the files it uses (images, CSS,
JavaScript, etc.) are stored in the file archive of the Map. The open-source Java
script library Leaflet (http://leafletjs.com/) is used to build the web map.

Connecting positioning data The Map instrument provides prepared


connection nodes for you to connect GNSS positioning data (latitude, longitude,
and heading). Refer to How to Visualize GNSS Positioning Data in a Map on
page 99.

Instrument properties The Map provides the following properties:

Property Purpose
Map Properties on page 495, i.e., the Default To configure the Map-specific properties.
View, Marker, Misc, and Route properties

If the Show default properties custom property is enabled in the Misc


category, the Map provides all available properties, including the default
properties of a Browser:

Property Purpose
Active Property on page 415 To activate or deactivate the instrument.
Border Properties on page 437 To configure the border settings of an instrument.
Browser Properties on page 438 To configure the Browser-specific properties.
Connection Nodes Properties on page 456 To configure connection nodes of the Browser.
Description Property on page 465 To specify a description for the instrument.
File Archive Properties on page 471 To specify files that are saved with the selected Browser instrument.
Map Properties on page 495 To configure the Map-specific properties.
Name Property on page 503 To specify the name of the selected instrument.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
Use Custom Fonts Property on page 562 To enable or disable global font settings for the instrument.
Variables Properties on page 562 To display and configure the variables that are connected to the instrument.

278
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Related commands The Browser provides the following commands:

Command Purpose
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Copy Value (Instruments) on page 629 To copy the value that is displayed in the instrument.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Delete (Instrument) on page 639 To delete the selected instruments.
Instrument Properties on page 666 To view and edit the properties of an instrument.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.
Variables - Delete on page 734 To delete the selected variables.
Variables - Paste/Paste Variables on page 735 To paste variables from the Clipboard to an instrument.
Variable(s) - Select in Variables/Mappings Pane on To select and highlight variables in the Variables pane, or framework labels in
page 731 the Mappings pane.

Related topics Basics

Basics on Handling the Browser................................................................................................ 97

HowTos

How to Configure the Browser................................................................................................. 99


How to Visualize GNSS Positioning Data in a Map.................................................................... 99

Date and Time


Introduction The Date and Time category in the Instrument Selector provides
instruments that let you display the host PC system time and/or date on a layout
in different formats.

279
May 2024 ControlDesk Instrument Handling
Reference Information

Date and Time Library

Introduction The Date and Time category in the Instrument Selector provides
instruments that let you display the host PC system time and/or date on a layout
in different formats.

Instrument Name Representation


Date DD.MM.YYYY HH:MM:SS

Date YYYY-MM-DD HH:MM:SS

Date DD.MM.YYYY HH:MM

Date DD.MM.YYYY

Date MM-DD-YYYY

Time HH:MM:SS

Time HH:MM

FPGA Instruments
Introduction The FPGA Instruments category in the Instrument Selector provides the FPGA
Scope instrument.

Where to go from here Information in this section

FPGA Scale ADC.................................................................................... 281


To scale or replace analog input signals of an FPGA application during
run time.

280
ControlDesk Instrument Handling May 2024
Instrument Descriptions

FPGA Scale DAC.................................................................................... 286


To scale or replace digital output signals of an FPGA application during
run time.

FPGA Scope........................................................................................... 290


To measure and display up to eight FPGA signals.

FPGA Scale ADC

Illustration

Purpose To scale or replace analog input signals of an FPGA application during run time.

Note

§ Instrument availability: The instrument is available in ControlDesk if you


have installed dSPACE ConfigurationDesk or dSPACE Real-Time Interface.
It is installed even without a license for dSPACE ConfigurationDesk or
dSPACE Real-Time Interface.
§ Precondition for working with the instrument: To use the instrument
for a specific FPGA application, you must have enabled the FPGA
test access and scaling before the FPGA application build process. For
instructions, refer to How to Enable FPGA Test Access and Scaling (FPGA
Programming Blockset Guide ) or Configuring FPGA Test Access and
Scaling (ConfigurationDesk I/O Function Implementation Guide ).

Description The FPGA Scale ADC instrument lets you edit scaling parameters and view
modified input signals of an FPGA application during run time. You can specify
a scaling offset, a scaling factor, saturation limits, and a replacement value. This
lets you to test and debug an FPGA application from a ControlDesk experiment
without having to rebuild the application.

Each instrument instance is related to one input channel of the FPGA application.

281
May 2024 ControlDesk Instrument Handling
Reference Information

The following illustration shows the FPGA Scale ADC instrument:

Intermediate Replacement Maximum Output


Input signal result switch saturation value signal

Scaling factor Input signal range


Scaling offset Encoding

Replacement value Minimum saturation value

The following table describes the variables:

Variable Description Unit


Input signal The signal entering the channel [V]
Output signal The signal exiting the channel [-]
Replacement switch and value If the replacement switch is turned on, the replacement value replaces the [-]
(FPGA test access) signal.
The replacement switch can be used to provide stimulus values to the
FPGA application to put it into operation or test it, for example.
Scaling factor The input signal is multiplied with the scaling factor. See Specifying the [1/V]
scaling factor and offset on page 283 for details.
Scaling offset The scaling offset is added to the input signal after multiplication with the [-]
scaling factor. See Specifying the scaling factor and offset on page 283 for
details.
Minimum/maximum The minimum and maximum saturation values replace the output signal if the [-]
saturation value modified signal exceeds these limits.

Putting the instrument into To put the FPGA Scale ADC instrument into operation, perform the following
operation steps:
1. Drag the FPGA Scale ADC instrument onto a layout.

282
ControlDesk Instrument Handling May 2024
Instrument Descriptions

2. In the instrument, click and select an input channel.


As a result, the instrument displays the input signal range and the resolution.

Note

When you select a channel, a number of calculated variables is


created if necessary. The variables correspond to the selected channel
and are required for internal calculations. An example is shown in the
illustration below:

Do not delete or modify the calculated variables. If necessary, you can


restore variables by deselecting and selecting a channel.

3. Go online. After going online, the currently set variable values are displayed.
4. You can now use the instrument. See below.

Specifying the scaling factor The scaling factor and offset edit fields of the instrument let you convert and
and offset optionally manipulate the input signal of the instrument before the signal is
forwarded to the FPGA application.

Specifying the scaling factor The following formula shows you how to
specify the scaling factor:
scaling factor = conversion factor · manipulation factor
§ The conversion factor converts the analog input signal (in [V]) to the scaling
used by the FPGA application.
The conversion factor depends on the scaling type configured in the
FPGA application.
§ mV scaling
§ bit scaling
The instrument displays the scaling type. The following illustration shows the
instrument displaying the mV scaling type as an example.

§ The manipulation factor lets you optionally manipulate the input signal.
A manipulation factor equal to 1 means to forward the input signal to the
FPGA application without manipulation.

283
May 2024 ControlDesk Instrument Handling
Reference Information

Examples The following table shows example conversion factors depending


on the scaling type:

Scaling Input Voltage Conversion Description


Type Range Factor
mV (any) 1000 Conversion from [V] to [mV]
14 bit 0 V ... 5 V 3277 Conversion from [V] to
(214/5)
-5 V... +5 V 1638 Conversion from [V] to
(214/10)
-10 V... +10 V 819 Conversion from [V] to
(214/20)
-30 V... +30 V 273 Conversion from [V] to
(214/60)
16 bit 0 V ... 5 V 13107 Conversion from [V] to
(216/5)
-5 V... +5 V 6554 Conversion from [V] to
(216/10)
-10 V... +10 V 3277 Conversion from [V] to
(216/20)
-30 V... +30 V 1092 Conversion from [V] to
(216/60)

Specifying the scaling offset The scaling offset must be specified according
to the scaling configured for the FPGA application, i.e., according to the mV or
bit scaling.

Instrument properties The instrument provides the following properties:

Property Purpose
Description Property on page 465 To specify a description for the instrument.
Name Property on page 503 To specify the name of the selected instrument.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
Tooltip Property on page 560 To specify a tooltip for the instrument.

Related commands The instrument provides the following commands:

Command Purpose
Adjust Value(s) on page 586 To enter a value as the operand to change the parameter value.
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Copy Value(s) on page 630 To copy the selected cells to the Clipboard.

284
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Command Purpose
Copy / Variables - Copy on page 626 To copy the selected variables to the Clipboard.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Delete (Instrument) on page 639 To delete the selected instruments.
Display Values on page 648 To select an option for displaying the values in the table cells of the Table
Editor's grid view.
Instrument Properties on page 666 To view and edit the properties of an instrument.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Ungroup on page 725 To revoke grouping the signals according to the entries of the selected
column.
Variable(s) - Add on page 730 To connect a variable to an instrument.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.
Configure Connection Assignment on page 617 To configure the connection assignment of the variable(s) in the selected
instrument(s).
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.
Variables - Delete on page 734 To delete the selected variables.
Variables - Paste/Paste Variables on page 735 To paste variables from the Clipboard to an instrument.
Variable(s) - Select in Variables/Mappings Pane on To select and highlight variables in the Variables pane, or framework labels in
page 731 the Mappings pane.

Related topics Basics

Basics on FPGA Test Access and Scaling (FPGA Programming Blockset Guide )
Configuring FPGA Test Access and Scaling (ConfigurationDesk I/O Function
Implementation Guide )
Configuring the Basic Functionality (FPGA) (ConfigurationDesk I/O Function
Implementation Guide )

References

FPGA Scale DAC..................................................................................................................... 286

285
May 2024 ControlDesk Instrument Handling
Reference Information

FPGA Scale DAC

Illustration

Purpose To scale or replace digital output signals of an FPGA application during run time.

Note

§ Instrument availability: The instrument is available in ControlDesk if you


have installed dSPACE ConfigurationDesk or dSPACE Real-Time Interface.
It is installed even without a license for dSPACE ConfigurationDesk or
dSPACE Real-Time Interface.
§ Precondition for working with the instrument: To use the instrument
for a specific FPGA application, you must have enabled the FPGA
test access and scaling before the FPGA application build process. For
instructions, refer to How to Enable FPGA Test Access and Scaling (FPGA
Programming Blockset Guide ) or Configuring FPGA Test Access and
Scaling (ConfigurationDesk I/O Function Implementation Guide ).

Description The FPGA Scale DAC instrument lets you edit scaling parameters and view
modified output signals of an FPGA application at run time. You can specify
a scaling offset, a scaling factor, saturation limits, and a replacement value. This
lets you test and debug an FPGA application from a ControlDesk experiment
without needing to rebuild.

Each instrument instance is related to one output channel of the


FPGA application.

The following illustration shows the FPGA Scale DAC instrument:

Replacement switch Maximum saturation value Output signal

Output signal range


Replacement value
Encoding
Scaling factor
Scaling offset

Minimum saturation value Checked Input signal

286
ControlDesk Instrument Handling May 2024
Instrument Descriptions

The following table describes the variables:

Variable Description Unit


Output signal The signal exiting the channel [V]
Replacement switch and The replacement switch, when [mV]
value (FPGA test access) turned on, replaces the signal with (mV scaling) or
the replacement value. resolution (bit
scaling)
Scaling factor The input signal is multiplied with [V/mV]
the scaling factor. See Specifying (mV scaling) or
the scaling factor and offset on [V]/resolution
page 288 for details. (bit scaling)
Scaling offset The scaling offset is added to the [V]
input signal after multiplication
with the scaling factor. See
Specifying the scaling factor and
offset on page 288 for details.
Minimum/maximum The minimum and maximum [V]
saturation value saturation values replace the
output signal if the modified signal
exceeds these limits.
Checked input signal The signal entering the channel
that has been checked against
saturation limits

Putting the instrument into To put the FPGA Scale DAC instrument into operation, perform the following
operation steps:
1. Drag the FPGA Scale DAC instrument onto a layout.

2. In the instrument, click and select an output channel.


As a result, the instrument displays the output signal range and the
resolution.

Note

When you select a channel, a number of calculated variables is


created if necessary. The variables correspond to the selected channel
and are required for internal calculations. An example is shown in the
illustration below:

Do not delete or modify the calculated variables. If necessary, you can


restore variables by deselecting and selecting a channel.

3. Go online. After going online, the currently set variable values are displayed.

287
May 2024 ControlDesk Instrument Handling
Reference Information

4. Modify the variable values according to your needs. For information on


variables, refer to Specifying the scaling factor and offset on page 288.

Specifying the scaling factor The scaling factor and offset edit fields of the instrument let you convert and
and offset optionally manipulate the input signal of the instrument before the signal is
forwarded to the FPGA application.

Specifying the scaling factor The following formula shows you how to
specify the scaling factor:
scaling factor = conversion factor · manipulation factor
§ The conversion factor converts the digital input signal to an analog output
voltage [V].
The conversion factor depends on the scaling type configured in the
FPGA application.
§ mV scaling
§ bit scaling
The instrument displays the scaling type. The following illustration shows the
instrument displaying the 14-bit scaling type as an example.

§ The manipulation factor lets you optionally manipulate the input signal.
A manipulation factor equal to 1 means to forward the digital FPGA signal to
the analog voltage output without manipulation.

Examples The following table shows example conversion factors depending


on the scaling type:

Scaling Output Voltage Conversion Description


Type Range Factor
mV (any) 0.001 Conversion from [mV] to [V]
14 bit 0 V ... 5 V 0.0003052 Conversion from 214 to
0 ... 5 [V]
-5 V... +5 V 0.0006103 Conversion from 214 to
-5 ... +5 [V]
-10 V... +10 V 0.0012207 Conversion from 214 to
-10 ... +10 [V]
-30 V... +30 V 0.0036621 Conversion from 214 to
-30 ... +30 [V]
16 bit 0 V ... 5 V 0.0000763 Conversion from 216 to
0 ... 5 [V]
-5 V... +5 V 0.0001526 Conversion from 216 to
-5 ... +5 [V]

288
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Scaling Output Voltage Conversion Description


Type Range Factor
-10 V... +10 V 0.0003052 Conversion from 216 to
-10 ... +10 [V]
-30 V... +30 V 0.0009156 Conversion from 216 to
-30 ... +30 [V]

Specifying the scaling offset The scaling offset must be specified in [V].

Instrument properties The instrument provides the following properties:

Property Purpose
Description Property on page 465 To specify a description for the instrument.
Name Property on page 503 To specify the name of the selected instrument.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
Tooltip Property on page 560 To specify a tooltip for the instrument.

Related commands The instrument provides the following commands:

Command Purpose
Adjust Value(s) on page 586 To enter a value as the operand to change the parameter value.
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Copy Value(s) on page 630 To copy the selected cells to the Clipboard.
Copy / Variables - Copy on page 626 To copy the selected variables to the Clipboard.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Delete (Instrument) on page 639 To delete the selected instruments.
Display Values on page 648 To select an option for displaying the values in the table cells of the Table
Editor's grid view.
Instrument Properties on page 666 To view and edit the properties of an instrument.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Ungroup on page 725 To revoke grouping the signals according to the entries of the selected
column.
Variable(s) - Add on page 730 To connect a variable to an instrument.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.
Configure Connection Assignment on page 617 To configure the connection assignment of the variable(s) in the selected
instrument(s).
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.

289
May 2024 ControlDesk Instrument Handling
Reference Information

Command Purpose
Variables - Delete on page 734 To delete the selected variables.
Variables - Paste/Paste Variables on page 735 To paste variables from the Clipboard to an instrument.
Variable(s) - Select in Variables/Mappings Pane on To select and highlight variables in the Variables pane, or framework labels in
page 731 the Mappings pane.

Related topics Basics

Basics on FPGA Test Access and Scaling (FPGA Programming Blockset Guide )
Configuring FPGA Test Access and Scaling (ConfigurationDesk I/O Function
Implementation Guide )
Configuring the Basic Functionality (FPGA) (ConfigurationDesk I/O Function
Implementation Guide )

References

FPGA Scale ADC..................................................................................................................... 281

FPGA Scope

Illustration

290
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Purpose To measure and display up to eight FPGA signals.

Note

Instrument availability: The instrument is available in ControlDesk if you


have installed dSPACE ConfigurationDesk or dSPACE Real-Time Interface. It
is installed even without a license for dSPACE ConfigurationDesk or dSPACE
Real-Time Interface.

Description The FPGA Scope instrument lets you access one FPGA Scope instance in the
real-time application. The instrument lets you measure up to eight FPGA signals
at runtime.

The measured signals are displayed in a Time Plotter, which is automatically


created and configured by the FPGA Scope instrument when you connect the
selected FPGA Scope instance. The FPGA Scope instrument lets you specify one
of multiple trigger events to start signal measurement. If the trigger event occurs,
the FPGA Scope measures a time sequence of the specified FPGA signals. As an
alternative, you can use the video mode to measure the FPGA signals without
triggering.

For an animated graphic, refer to dSPACE Help.

Status messages The header of the FPGA Scope instrument displays the
following status information:

Status Description
Message
Stopped The FPGA Scope instance is stopped.
Armed The FPGA Scope instance is running and waiting for a trigger
event to occur.
Recording The FPGA Scope instance is recording FPGA signal data in
the FPGA buffer.
Read The Signal data is transferred from the FPGA buffer to
ControlDesk.

Trigger mode Lets you select the trigger mode.

Mode Description
To stop measuring the FPGA signals.

To measure and display the FPGA signals each time the specified
trigger event occurs.

To measure and display the FPGA signals once when the specified
trigger event occurs.

To measure and display the FPGA signals continuously without


waiting for the trigger event.

291
May 2024 ControlDesk Instrument Handling
Reference Information

If Run is selected, the Manual trigger button lets you measure the FPGA signals
once without waiting for the trigger event.

Trigger settings Lets you specify the trigger event.


You can select a Trigger Source, a Trigger Option and specify a Threshold,
Trigger Delay, and Pulse Length.

Trigger source Available trigger sources are the 16 input signals and the
External Trigger input of the FPGA Scope block in the real-time model. In
addition to these 17 signals, there is also a manual trigger.
Select Manual Trigger if you only want to trigger manually with the Manual
trigger button. The Manual Trigger disables all other trigger conditions and
forces manual triggering only.

Trigger option

Symbol Description
Triggers on a rising edge of the threshold value.

Triggers on a falling edge of the threshold value.

Triggers on a rising and falling edge of the threshold value.

Triggers on a positive pulse (threshold) which is longer than the pulse


length.
Triggers on a positive pulse (threshold) which is shorter than the pulse
length.
Triggers on a negative pulse (threshold) which is longer than the pulse
length.
Triggers on a negative pulse (threshold) which is shorter than the
pulse length.

Visualization
§ The Visualized scope depth limits the number of signal values in a captured
time sequence. The highest time resolution to capture the FPGA signal is the
FPGA clock period. A new trigger event is not evaluated until all data values
have been captured and processed.
§ Use the Downsampling setting to downsample the signal capturing and to
capture a longer time sequence with a reduced time resolution.

Configuration The button lets you open the Connect to FPGA Scope
Instance dialog to select an FPGA Scope instance of the real-time application.

Click Connect to automatically configure the FPGA Scope for the selected
FPGA Scope instance. The required rasters are automatically added to the
Measurement Configuration. A related Time Plotter is also automatically created
and configured.

292
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Time Plotter The preconfigured Time Plotter lets you select and display up to
eight FPGA signals of the selected FPGA Scope instance.

For further details on the Time Plotter, refer to Time Plotter on page 384.

Tip

You can use the button at any time to restore the correct configuration
of the FPGA Scope and renew the Time Plotter.

Instrument properties The FPGA Scope provides the following properties:

Property Purpose
Background Properties on page 433 To configure the background properties of the current instrument.
Border Properties on page 437 To configure the border settings of an instrument.
Captions/Operating Elements Properties on To add and remove captions and configure the properties of operating
page 443 elements.
Description Property on page 465 To specify a description for the instrument.
Name Property on page 503 To specify the name of the selected instrument.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
Tooltip Property on page 560 To specify a tooltip for the instrument.
Use Custom Colors Property on page 561 To enable or disable custom color settings for the instrument.
Use Custom Fonts Property on page 562 To enable or disable global font settings for the instrument.
Variables Properties on page 562 To display and configure the variables that are connected to the instrument.

293
May 2024 ControlDesk Instrument Handling
Reference Information

Related commands The FPGA Scope provides the following commands:

Command Purpose
Adjust Value(s) on page 586 To enter a value as the operand to change the parameter value.
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Copy Value(s) on page 630 To copy the selected cells to the Clipboard.
Copy / Variables - Copy on page 626 To copy the selected variables to the Clipboard.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Delete (Instrument) on page 639 To delete the selected instruments.
Display Values on page 648 To select an option for displaying the values in the table cells of the Table
Editor's grid view.
Instrument Properties on page 666 To view and edit the properties of an instrument.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Ungroup on page 725 To revoke grouping the signals according to the entries of the selected
column.
Variable(s) - Add on page 730 To connect a variable to an instrument.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.
Configure Connection Assignment on page 617 To configure the connection assignment of the variable(s) in the selected
instrument(s).
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.
Variables - Delete on page 734 To delete the selected variables.
Variables - Paste/Paste Variables on page 735 To paste variables from the Clipboard to an instrument.
Variable(s) - Select in Variables/Mappings Pane on To select and highlight variables in the Variables pane, or framework labels in
page 731 the Mappings pane.

Related topics Basics

Configuring the Basic Functionality (FPGA) (ConfigurationDesk I/O Function


Implementation Guide )
Displaying FPGA Signals in ControlDesk (FPGA Programming Blockset Guide )
Measuring FPGA Signals (ControlDesk Measurement and Recording )

References

FPGA Scope (FPGA Programming Blockset - FPGA Interface Reference )

294
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Gauges Automotive
Introduction The Gauges Automotive category in the Instrument Selector provides gauges
with common instrument symbols.

Gauges Automotive Library

Introduction
The instruments in this library are based on the Gauge standard instrument. You
can use them as templates in your own experiments and change them according
to your needs.

Instrument Name Representation


dSPACE Speedometer (km/h) dark

dSPACE Speedometer (mph) dark

dSPACE Speedometer (km/h) light

dSPACE Speedometer (mph) light

dSPACE Oil Temp (C)

295
May 2024 ControlDesk Instrument Handling
Reference Information

Instrument Name Representation


dSPACE Oil Temp (F)

dSPACE Oil Pressure (Bar)

dSPACE Water Temp (C)

dSPACE Water Temp (F)

dSPACE Battery analog (Volt)

dSPACE Economy (l/100km)

dSPACE Fuel analog

dSPACE Revolutioncounter (RPM)

dSPACE Turbo Pressure (Bar)

LEDs Automotive
Introduction The LEDs Automotive category in the Instrument Selector provides LEDs with
common instrument symbols.

296
ControlDesk Instrument Handling May 2024
Instrument Descriptions

LEDs Automotive Library

Introduction The instruments in this library are based on the MultiState Display standard
instrument. You can use them as templates in your own projects and change
them according to your needs.

Tip

The instrument symbol is not the instrument's background picture but


belongs to the state properties (Properties - MulitiStateDisplay - States -
Interval properties - Picture). Each state is represented by its own picture.

Instrument Name Representation


dSPACE Right

dSPACE Left

dSPACE External Lights

dSPACE Full Light

dSPACE Fog Light

dSPACE Front Fog Light

dSPACE Check Lights

dSPACE City

dSPACE Heater

dSPACE Code

dSPACE Sidebag

dSPACE Seatbelt

dSPACE Manual Brake

dSPACE ABS

297
May 2024 ControlDesk Instrument Handling
Reference Information

Instrument Name Representation


dSPACE Steering

dSPACE Fuel Injection

dSPACE Gear Automatic

dSPACE Oil Pressure

dSPACE Temperature

dSPACE Electronic Alarm

dSPACE Airbag

dSPACE Battery

dSPACE Fuel Low

dSPACE Open Door

Measurement
Introduction The Measurement category in the Instrument Selector provides various
instruments with common instrument symbols for measurement purposes.

Measurement Library

Introduction The instruments in this library are based on standard instruments. You can use
them as templates in your own projects and change them according to your
needs.

298
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Instrument Name Representation


dSPACE Meter 0–500 V

dSPACE Meter 0–100 V

dSPACE Meter 0–15 V

dSPACE Meter (–5)–5 V

dSPACE Meter 0–1 V

dSPACE Meter 0–500 A

dSPACE Meter 0–100 A

dSPACE Meter 0–30 A

dSPACE Meter 0–10 A

dSPACE Meter 0–1 A

dSPACE Display mV Green

dSPACE Display mV Gray

299
May 2024 ControlDesk Instrument Handling
Reference Information

Instrument Name Representation


dSPACE Display mV Light Gray

dSPACE Display mA Green

dSPACE Display mA Gray

dSPACE Display mA Light Gray

dSPACE Bar Red Vertical

dSPACE Slider Inside Scale

dSPACE Slider 3 Color Scale

dSPACE Slider Red Bar Inside Scale

Standard Instruments
Introduction The Standard Instruments category in the Instrument Selector contains all the
instruments of ControlDesk with their default properties settings.

Where to go from here Information in this section

3-D Viewer............................................................................................ 303


To display items in a 3-D environment.

Animated Needle................................................................................... 307


To display the value of a connected variable by a needle deflection.

Bar........................................................................................................ 309
To display a numerical value as a bar deflection on a horizontal or vertical
scale.

300
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Browser................................................................................................. 312
To display web pages and other documents, such as PDF files.

Bus Instrument...................................................................................... 315


To visualize bus-specific contents such as CAN messages, LIN frames,
gateway configurations, and basic transmission options.

Check Button........................................................................................ 319


To set the value of the connected parameter to a predefined value when
you activate the check button (On value) and when you clear it (Off
value).

Diagnostics Instrument.......................................................................... 321


To communicate with the ECU via the diagnostic protocol using
diagnostic services, diagnostic jobs, and control primitives.

Display.................................................................................................. 324
To display the value of the connected variable numerically.

Fault Memory Instrument...................................................................... 326


To read, clear, and save the content of the ECU’s fault memory
(diagnostic trouble codes and corresponding environment data).

Frame.................................................................................................... 330
To add a background frame to a layout, for example, to visualize an
instrument group.

Gauge................................................................................................... 332
To display the value of the connected variable by a needle deflection on a
circular scale.

Hierarchy Array...................................................................................... 336


To display variables grouped into custom hierarchy levels using different
cell types for visualization.

Index Plotter.......................................................................................... 341


To display signals in relation to an index (index plots).

Invisible Switch...................................................................................... 346


To define an area on the layout that is sensitive to mouse operations.

Knob..................................................................................................... 347
To display and set the value of the connected variable by means of a
knob on a circular scale.

MultiState Display.................................................................................. 352


To display the value of a variable as an LED state and/or as a text
message.

Multiswitch........................................................................................... 354
To change variable values by clicking sensitive areas in the instrument
and to visualize different states, depending on the current value of the
connected variable.

Numeric Input....................................................................................... 357


To display and set the value of the connected variable numerically.

301
May 2024 ControlDesk Instrument Handling
Reference Information

On/Off Button....................................................................................... 359


To set the value of the connected parameter to a predefined value when
you press the button (On value) and when you release the button (Off
value).

Push Button........................................................................................... 361


To set the value of the connected parameter by push buttons.

Radio Button......................................................................................... 363


To display and set the value of the connected parameter by radio
buttons.

Selection Box......................................................................................... 366


To select a text-value entry and set the respective numerical value for the
connected variable.

Slider..................................................................................................... 368
To display and set the value of the connected variable by means of a slide
on a horizontal or vertical scale.

Sound Controller................................................................................... 372


To play simple sounds or complex sounds in relation to specific variable
values.

Static Text.............................................................................................. 374


To display explanations or inscriptions on the layout.

Steering Controller................................................................................ 375


To change variable values using a game controller device such as a
joystick or a steering wheel.

Table Editor........................................................................................... 379


To display and edit the values of variables with data types that can be
represented in tabular form, such as maps and curves . The Table
Editor can be connected with one or more variables.

Time Plotter........................................................................................... 384


To display signals in relation to time (time plots).

Variable Array........................................................................................ 389


To display and set the values of several connected variables.

XY Plotter.............................................................................................. 396
To display signals in relation to other signals (no relation to an index or
time).

302
ControlDesk Instrument Handling May 2024
Instrument Descriptions

3-D Viewer

Illustration

Purpose To display items in a 3-D environment.

Description The 3-D Viewer can be used to display items in a 3-D environment. The
properties of the items can be connected to variables.

Items Via the Items property you can add new items or change the
properties of existing items. By default, you can choose between the following
items:
§ Cuboid
§ Point Line

Working With Point Lines


This video shows you how to work with point lines.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/NGyrz

303
May 2024 ControlDesk Instrument Handling
Reference Information

§ Rectangle

Working with Rectangles and Pictures


This video shows you how to work with rectangles and pictures.

To watch this video, click the following link or scan the QR code:
https://www.dspace.com/dspace-help/3LnmF

§ Cuboid group
§ Rectangle group
§ Surface
If you have defined an item template, you can add an item according to the
template.

Templates You can define a new template of an item via the Create button
of the item's Template property. Via the instrument's Templates property you
can configure the properties of all existing templates. For more information, refer
to How to Work with Item Templates on page 86.

Variable connections You can connect variables to the properties of an


item. For example, you can relate the position of an item to the values of
measurement variables. For more information, refer to Overview of Possible
Variable Connections on page 67.

Cuboid group and rectangle group Cuboid groups and rectangle groups
allow you to create a large number of similar objects by connecting a one-
dimensional array of scalar variables to a property of the group item. For
example, you can create identical cuboids at different positions by connecting
each of the Position properties to a measurement array. The number of
displayed objects is equal to the length of the array. For more information, refer
to Basics of Group Items on page 89.

Distance tracking Via the Tracked distances property you can track the
distance between two items in the 3-D environment. The distance tracking is
visualized with a distance line connecting the items in the 3-D environment. You
cannot track the distance to a surface, a cuboid group or a rectangle group. For
more information, refer to How to Track the Distance Between Two Items on
page 83.

Camera You can specify the camera properties in the following ways:
§ Selecting a default camera angle.
§ Specifying the camera properties using the Properties pane.
§ Connecting scalar variables to the camera properties.
§ Specifying an item as a target to follow.

304
ControlDesk Instrument Handling May 2024
Instrument Descriptions

§ Using the mouse commands.

Mouse command Purpose


Hold the middle mouse button and move To move the camera position.
the pointer.
Hold the left mouse button and move the To rotate the camera.
pointer.
Turn the mouse wheel. To change the camera
distance.

X-axis, y-axis, and z-axis You can specify the properties of the axes in the
properties pane. The following mouse commands can be used to adjust the
minimum and maximum value of the axis:

Mouse command Purpose


Move the pointer over the axis. Then, To change the minimum and
hold the left mouse button and move the maximum value by the same
pointer. amount.
Move the pointer over the axis. Then, turn To change the difference between
the mouse wheel. the minimum and maximum
value.

Tip

You can enable the Fixed axis range property to disable the mouse
commands.

Instrument properties The 3-D Viewer provides the following properties:

Property Purpose
Active Property on page 415 To activate or deactivate the instrument.
Axes Properties (3-D Viewer) on page 427 To configure the properties of the selected axis.
Background Properties on page 433 To configure the background properties of the current instrument.
Border Properties on page 437 To configure the border settings of an instrument.
Camera Properties on page 442 To configure the camera properties.
Clip Content Property on page 451 To select whether items are clipped when they expand beyond the area
defined by the axes.
Description Property on page 465 To specify a description for the instrument.
Distance Tracking Properties on page 469 To configure the properties of the distance tracking elements.
Items and Templates Properties on page 481 To configure the properties of the selected item or template.
Name Property on page 503 To specify the name of the selected instrument.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533

305
May 2024 ControlDesk Instrument Handling
Reference Information

Property Purpose
Title Properties on page 559 To configure the title of the selected element to be displayed.
Tooltip Property on page 560 To specify a tooltip for the instrument.
Use Custom Colors Property on page 561 To enable or disable custom color settings for the instrument.
Use Custom Fonts Property on page 562 To enable or disable global font settings for the instrument.
Walls Properties on page 568 To configure the selected wall.

Related commands The 3-D Viewer provides the following commands:

Command Purpose
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Delete (Instrument) on page 639 To delete the selected instruments.
Instrument Properties on page 666 To view and edit the properties of an instrument.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Items on page 674 To add items and configure their properties.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.
Copy / Variables - Copy on page 626 To copy the selected variables to the Clipboard.
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.
Variables - Delete on page 734 To delete the selected variables.

Related topics Basics

Basics of Group Items............................................................................................................... 89


Basics of Handling the 3-D Viewer............................................................................................ 55
Overview of Possible Variable Connections............................................................................... 67

HowTos

How to Add an Item and Configure the Item Properties ........................................................... 79


How to Track the Distance Between Two Items......................................................................... 83
How to Work with Item Templates............................................................................................ 86

Videos

Adding Items and Connecting Variables (3:48) in dSPACE Help


Changing the Camera Distance via an Instrument Script (2:24) in dSPACE Help
Street Scene Demo (3:10) in dSPACE Help
Tracking Distances (2:23) in dSPACE Help
Working With Group Items (5:15) in dSPACE Help

306
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Animated Needle

Illustration
Head

Hub

Tail

Purpose To display the value of a connected variable by a needle deflection.

Description The Animated Needle can be used to display the value of the connected variable.
You can configure properties of the instrument via the Properties pane.

Needle The instrument consists of a needle with a head, a hub and a tail,
which you can configure individually. You can configure the radius and the
orientation of the needle by moving the start point, the end point and the
intermediate point of the needle's circumcircle. To move these points, you have
to enable the instrument's edit mode.
Intermediate point

Circumcircle
of the needle

Start point End point

The length and width values of the needle relate to the circumcircle's radius.

Instrument background The instrument background is transparent.

Instrument properties The Animated Needle provides the following properties:

Property Purpose
Active Property on page 415 To activate or deactivate the instrument.
Description Property on page 465 To specify a description for the instrument.
Edit Mode Property (Animated Needle) on To enable the configuration of the radius, position and the orientation of the
page 470 needle.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.

307
May 2024 ControlDesk Instrument Handling
Reference Information

Property Purpose
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Name Property on page 503 To specify the name of the selected instrument.
Needle Properties (Animated Needle) on page 503 To specify the needle-specific settings of the Animated Needle.
Range Properties (Animated Needle) on page 517 To specify a range for the variable value displayed in the selected instrument.
Tooltip Property on page 560 To specify a tooltip for the instrument.
Variables Properties on page 562 To display and configure the variables that are connected to the instrument.

Related commands The Animated Needle provides the following commands:

Command Purpose
Bitmask on page 595 To specify the bitmask for the currently selected variable.
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Connect as Main Variable / Connect Variable(s) on To connect the selected variable to the instrument as the main variable.
page 619
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Copy Value (Instruments) on page 629 To copy the value that is displayed in the instrument.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Dec (Source) on page 638 To display a value in dec (source) mode.
Delete (Instrument) on page 639 To delete the selected instruments.
Instrument Properties on page 666 To view and edit the properties of an instrument.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Physical (Converted) on page 689 To display a value in the instrument in physical (converted) mode.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Show Current/Reference on page 710 To specify whether to display the current value or the reference value in the
current instrument.
Variable(s) - Add on page 730 To connect a variable to an instrument.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.
Copy / Variables - Copy on page 626 To copy the selected variables to the Clipboard.
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.
Variables - Delete on page 734 To delete the selected variables.
Variables - Paste/Paste Variables on page 735 To paste variables from the Clipboard to an instrument.
Variable(s) - Select in Variables/Mappings Pane on To select and highlight variables in the Variables pane, or framework labels in
page 731 the Mappings pane.
Variable(s) Properties on page 732 To show the Properties dialog of a connected variable.

308
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Bar

Illustration Scale Caption

Label

Tic

Slidebar

Bar Band Indicator

Purpose To display a numerical value as a bar deflection on a horizontal or vertical scale.

Description The Bar can be used as a single instrument for displaying one numeric scalar
variable. You can configure properties of the instrument via the Properties pane.

Tip

Another way to display a bar deflection is to select the Bar value cell type in
a Variable Array. For details, refer to Variable Array on page 389.

Caption You can define caption elements, for example, the name and the
unit of the connected variable, and place them at various positions in the
instrument.

Scale area Displays the scale of the instrument. The scale consists of the
following parts, which can be configured individually:

Scale parts Description


Bands The bands define colored areas within the scale's value range. A
band has a start position (minimum value) and an end position
(maximum value).
Indicators The indicators mark the minimum or maximum value of the
measurement.
Labels The labels of the tics display the numerical values of the scale.
Tics The tics display the divisions of the scale. There are major tics and
minor tics.

By default, the scale is adjusted to the weak limits of the connected variable. You
can edit the range via the properties.
MajorTics MinorTics
Delta

Bar area Displays the value of the connected variable as a bar deflection in a
slidebar.

309
May 2024 ControlDesk Instrument Handling
Reference Information

You can configure, for example, the color, the size and position of the bar, or the
direction, style and orientation of the slidebar.

Operating element The operating element is an invisible frame, in which


the bar element (scale area and bar area) can be positioned. You can configure
the position of the bar element within the operating element via horizontal and
vertical position settings.

Views When you select an instrument, it is automatically highlighted. There


are also other views, as shown by the examples in the following table.

View Description
No-value view The instrument is not receiving valid values. For measurement variables,
you will find this view, for example, if you have not started a
measurement after loading an experiment. For parameters, you will find
this view, for example, if you added a variable description without an
initial data set but did not upload values from the ECU.

Automatic sizing ControlDesk provides the Automatic Sizing property to


adjust the scale of the instrument automatically, for example, when you change
the Min/Max values, resize the instrument, or resize the operating element. If the
instrument becomes too small or the value range becomes too large, the number
of tics and labels is reduced automatically or completely hidden.

Colors and fonts settings You can specify whether to use the global
ControlDesk colors and fonts settings for the selected instrument or configure
your own settings.

Overlay picture You can specify an overlay picture to cover a part of the background.

Instrument properties The Bar provides the following properties:

Property Purpose
Active Property on page 415 To activate or deactivate the instrument.
Automatic Sizing Property (Bar, Gauge, Knob, To enable or disable the automatic sizing function.
Slider) on page 421
Background Properties on page 433 To configure the background properties of the current instrument.

310
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Property Purpose
Bands Properties on page 433 To specify the properties of colored bands for the highlighting of value
ranges.
Border Properties on page 437 To configure the border settings of an instrument.
Captions/Operating Elements Properties on To add and remove captions and configure the properties of operating
page 443 elements.
Color Property on page 452 To specify the color of the selected item.
Description Property on page 465 To specify a description for the instrument.
Name Property on page 503 To specify the name of the selected instrument.
Origin Property on page 507 To specify the bar’s origin.
Overflow Warning Property on page 508 To enable or disable the overflow warning function.
Overlay Picture Properties on page 512 To configure the properties of a picture placed behind the scale and covering
a part of the instrument's background.
Scale Properties on page 522 To configure the scale properties of the selected instrument.
Range Properties on page 517 To configure the scale range properties of the selected instrument.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.
Segmented Property on page 528 To segment the bar according to the tics of the scale.
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
Slidebar Properties on page 535 To configure the properties of the slidebar.
Tooltip Property on page 560 To specify a tooltip for the instrument.
Use Custom Colors Property on page 561 To enable or disable custom color settings for the instrument.
Use Custom Fonts Property on page 562 To enable or disable global font settings for the instrument.
Variables Properties on page 562 To display and configure the variables that are connected to the instrument.

Related commands The Bar provides the following commands:

Command Purpose
Bitmask on page 595 To specify the bitmask for the currently selected variable.
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Connect as Main Variable / Connect Variable(s) on To connect the selected variable to the instrument as the main variable.
page 619
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Copy Value (Instruments) on page 629 To copy the value that is displayed in the instrument.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Dec (Source) on page 638 To display a value in dec (source) mode.
Delete (Instrument) on page 639 To delete the selected instruments.
Display Formats on page 647 To specify the display format for the selected variable.
Indicators - Reset Max on page 663 To reset the maximum indicator to the current value of the instrument.
Indicators - Reset Min on page 664 To reset the minimum indicator to the current value of the instrument.
Instrument Properties on page 666 To view and edit the properties of an instrument.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.

311
May 2024 ControlDesk Instrument Handling
Reference Information

Command Purpose
Physical (Converted) on page 689 To display a value in the instrument in physical (converted) mode.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Show Current/Reference on page 710 To specify whether to display the current value or the reference value in the
current instrument.
Variable(s) - Add on page 730 To connect a variable to an instrument.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.
Copy / Variables - Copy on page 626 To copy the selected variables to the Clipboard.
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.
Variables - Delete on page 734 To delete the selected variables.
Variables - Paste/Paste Variables on page 735 To paste variables from the Clipboard to an instrument.
Variable(s) - Select in Variables/Mappings Pane on To select and highlight variables in the Variables pane, or framework labels in
page 731 the Mappings pane.
Variable(s) Properties on page 732 To show the Properties dialog of a connected variable.

Browser

Illustration
Toolbar

Content area Address bar

Purpose To display web pages and other documents, such as PDF files.

Description The Browser can be used to display web pages and other content specified by
entering an URL in the address bar. You can hide the toolbar and the scrollbars to
make only the content area visible. Additionally, you can disable the navigation
links to fix the displayed content.

312
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Toolbar The toolbar contains the following buttons:

Button Description
To go to the previous page in the page history.
(Available only if you are not on the last page in the page history) To
go to the next page in the page history.
To refresh the displayed content.
To go to the start page. You can specify the URL of the start page via
the Browser properties.

These commands are also available from the context menu in the content area.

Address bar The address bar is part of the toolbar and displays the URL of
the currently displayed content. You can enter a new URL or use the Browser
properties to change the content.

Content area The content area displays the content that is specified by the
URL in the address bar.

Debugging Press F12 to open the DevTools window while the Browser is
selected. It gives you access to debugging tools for Javascript.
The following illustration shows the DevTools window:

Instrument properties The Browser provides the following properties:

Property Purpose
Active Property on page 415 To activate or deactivate the instrument.
Border Properties on page 437 To configure the border settings of an instrument.

313
May 2024 ControlDesk Instrument Handling
Reference Information

Property Purpose
Browser Properties on page 438 To configure the Browser-specific properties.
Connection Nodes Properties on page 456 To configure connection nodes of the Browser.
Description Property on page 465 To specify a description for the instrument.

Name Property on page 503 To specify the name of the selected instrument.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Variables Properties on page 562 To display and configure the variables that are connected to the instrument.

Related commands The Browser provides the following commands:

Command Purpose
Connection Nodes Properties on page 456 To configure connection nodes of the Browser.
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Copy Value (Instruments) on page 629 To copy the value that is displayed in the instrument.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Delete (Instrument) on page 639 To delete the selected instruments.
Instrument Properties on page 666 To view and edit the properties of an instrument.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.
Variables - Delete on page 734 To delete the selected variables.
Variables - Paste/Paste Variables on page 735 To paste variables from the Clipboard to an instrument.
Variable(s) - Select in Variables/Mappings Pane on To select and highlight variables in the Variables pane, or framework labels in
page 731 the Mappings pane.

Related topics Basics

Basics on Handling the Browser................................................................................................ 97

HowTos

How to Configure the Browser................................................................................................. 99

314
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Bus Instrument

Illustration The Bus Instrument can be configured for different purposes. The following
screenshot shows a TX Bus Instrument for the CAN bus as an example.

Purpose To visualize bus-specific contents such as CAN messages, LIN frames, gateway
configurations, and basic transmission options.

Description 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.
For bus communication modeled with the Bus Manager, the related Bus
Instruments are based on the Hierarchy Array .

315
May 2024 ControlDesk Instrument Handling
Reference Information

The Bus Navigator provides the following Bus Instrument types:

Bus Instrument Function Bus Types Refer to


Modeling Basis: Blockset
Gateway To specify whether or not frames are CAN Gateway Instrument for CAN
gatewayed between two CAN buses and to (Blockset) (ControlDesk Bus
change the specified gateway filters during Navigator )
run time.
RX To display information on an RX or TX/RX CAN RX Instrument for CAN (Blockset)
IPDU. (ControlDesk Bus Navigator )
LIN RX Instrument for LIN (Blockset)
(ControlDesk Bus Navigator )
TX To display, configure, and transmit a TX or CAN TX Instrument for CAN (Blockset)
TX/RX IPDU. (ControlDesk Bus Navigator )
LIN TX Instrument for LIN (Blockset)
(ControlDesk Bus Navigator )
TX status To specify whether TX PDUs of a CAN TX Status Instrument for
communication cluster are transmitted on the CAN (Blockset) (ControlDesk Bus
bus and to specify basic transmission options. Navigator )
Modeling Basis: Bus Manager
Global Layout To enable and disable the bus communication CAN Bus Configuration Instrument
of a bus configuration fully or partly in one LIN (Bus Manager) (ControlDesk Bus
step. Navigator )
Inspection To display information on an RX or TX/RX CAN Inspection Instrument for CAN
IPDU that has been configured for inspection (Bus Manager) (ControlDesk Bus
purposes. Navigator )
LIN Inspection Instrument for LIN
(Bus Manager) (ControlDesk Bus
Navigator )
Manipulation To change the settings of a TX or TX/RX IPDU CAN Manipulation Instrument for CAN
that has been configured for manipulation (Bus Manager) (ControlDesk Bus
purposes. Navigator )
LIN Manipulation Instrument for LIN
(Bus Manager) (ControlDesk Bus
Navigator )
RX To display information on an RX or TX/RX CAN RX Instrument for CAN (Bus Manager)
IPDU. (ControlDesk Bus Navigator )
LIN RX Instrument for LIN (Bus Manager)
(ControlDesk Bus Navigator )
TX To display, configure, and transmit a TX or CAN TX Instrument for CAN (Bus Manager)
TX/RX IPDU. (ControlDesk Bus Navigator )
LIN TX Instrument for LIN (Bus Manager)
(ControlDesk Bus Navigator )
TX status To specify whether TX PDUs of a CAN TX Status Instrument for CAN
communication cluster are transmitted on the (Bus Manager) (ControlDesk Bus
bus and to specify basic transmission options. Navigator )

316
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Bus Instrument Function Bus Types Refer to


LIN TX Status Instrument for LIN
(Bus Manager) (ControlDesk Bus
Navigator )
Compact Layout To display all supported features of CAN CAN Compact Bus Instrument (Bus
and LIN PDUs that were enabled in the Bus LIN Manager) (ControlDesk Bus
Manager in one compact layout. Navigator )
Bus Instruments Related to Bus Monitoring Devices
RX To display information on an RX or TX/RX Ethernet RX Instrument for Ethernet (Bus
IPDU. Monitoring Device) (ControlDesk Bus
Navigator )
CAN RX Instrument for CAN (Bus
Monitoring Device) (ControlDesk Bus
Navigator )
LIN RX Instrument for LIN (Bus
Monitoring Device) (ControlDesk Bus
Navigator )
TX To display, configure, and transmit a TX or CAN TX Instrument for CAN (Bus
TX/RX IPDU. Monitoring Device) (ControlDesk Bus
Navigator )

Instrument properties The instrument properties that are displayed in the Properties pane depend on
whether the bus communication was modeled with the Bus Manager or with an
RTI blockset.
§ For bus communication modeled with the Bus Manager, the Bus Instrument
is based on the Hierarchy Array instrument. Refer to Instrument properties on
page 338.
§ For bus communication modeled with an RTI blockset, refer to the following
table.

Property Purpose
Active Property on page 415 To activate or deactivate the instrument.
Description Property on page 465 To specify a description for the instrument.
Global Caption Enabled Property on page 473 To specify to display a global caption below the header.
Header Visible Property on page 477 To specify whether to display the header of the current instrument.
Name Property on page 503 To specify the name of the selected instrument.
Regions Properties on page 518 To enable or disable regions in a Bus Instrument.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Tab Pages Properties (Bus Instrument) on page 549 To specify the order and the labels of the instrument tabs.
Tooltip Property on page 560 To specify a tooltip for the instrument.

317
May 2024 ControlDesk Instrument Handling
Reference Information

Property Purpose
Use Custom Colors Property on page 561 To enable or disable custom color settings for the instrument.
Use Custom Header Settings Property on page 562 To enable or disable custom settings for the instrument header.

Related commands The available commands depend on whether the bus communication was
modeled with the Bus Manager or with an RTI blockset.
§ For bus communication modeled with the Bus Manager, the Bus Instrument
is based on the Hierarchy Array instrument. Refer to Related commands on
page 339.
§ For bus communication modeled with an RTI blockset, refer to the following
table.

Command Purpose
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Cell Properties on page 598 To specify properties of the selected cell.
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Copy Value (Instruments) on page 629 To copy the value that is displayed in the instrument.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Delete (Instrument) on page 639 To delete the selected instruments.
Instrument Properties on page 666 To view and edit the properties of an instrument.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Variable(s) - Add on page 730 To connect a variable to an instrument.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.
Copy / Variables - Copy on page 626 To copy the selected variables to the Clipboard.
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.
Variables - Delete on page 734 To delete the selected variables.
Variables - Paste/Paste Variables on page 735 To paste variables from the Clipboard to an instrument.
Variable(s) Properties on page 732 To show the Properties dialog of a connected variable.

Related topics Basics

Working with Bus Instruments (ControlDesk Bus Navigator )

References

Hierarchy Array....................................................................................................................... 336

318
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Check Button

Illustration
Caption

Check button

Check Button text

Purpose To set the value of the connected parameter to a predefined value when you
activate the check button (On value) and when you clear it (Off value).

Description The Check Button can be used as a single instrument for setting one numeric
scalar variable to a predefined value when you activate the check button (On
value) and when you clear it (Off value). You can configure properties of the
instrument via the Properties pane.

Caption You can define caption elements, for example, the name and the
unit of the connected variable, and place them at various positions in the
instrument.

Operating element The operating element is an invisible frame, which


includes the check button and the check button text. You can position the
operating element within the instrument.

Colors and fonts settings You can specify whether to use the global
ControlDesk colors and fonts settings for the selected instrument or configure
your own settings.

Instrument properties The Check Button provides the following properties:

Property Purpose
Active Property on page 415 To activate or deactivate the instrument.
Background Properties on page 433 To configure the background properties of the current instrument.
Border Properties on page 437 To configure the border settings of an instrument.
Captions/Operating Elements Properties on To add and remove captions and configure the properties of operating
page 443 elements.
Check Box Style Property on page 451 To specify whether to display a checkbox or a button in the instrument.
Description Property on page 465 To specify a description for the instrument.
Display Value Property on page 468 To specify whether the value of each button is displayed.
Name Property on page 503 To specify the name of the selected instrument.
Off-Value Property on page 505 To specify the Off value of the button.
On-Value Property on page 506 To specify the On value of the button.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.

319
May 2024 ControlDesk Instrument Handling
Reference Information

Property Purpose
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
Text Color Property on page 554 To specify the color of the selected item.
Text Font Property on page 555 To specify the font of the selected item.
Text Property (Check Button) on page 556 To specify the text displayed next to the checkbox.
Tooltip Property on page 560 To specify a tooltip for the instrument.
Use Custom Colors Property on page 561 To enable or disable custom color settings for the instrument.
Use Custom Fonts Property on page 562 To enable or disable global font settings for the instrument.
Variables Properties on page 562 To display and configure the variables that are connected to the instrument.
Word Wrap Property on page 568 To specify the word wrap property of text lines.

Related commands The Check Button provides the following commands:

Command Purpose
Adjust Value(s) on page 586 To enter a value as the operand to change the parameter value.
Bitmask on page 595 To specify the bitmask for the currently selected variable.
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Connect as Additional Write Variable(s) on To connect the selected variable to the instrument for calibration as an
page 618 additional write variable.
Connect as Main Variable / Connect Variable(s) on To connect the selected variable to the instrument as the main variable.
page 619
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Copy Value (Instruments) on page 629 To copy the value that is displayed in the instrument.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Dec (Source) on page 638 To display a value in dec (source) mode.
Delete (Instrument) on page 639 To delete the selected instruments.
Instrument Properties on page 666 To view and edit the properties of an instrument.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Physical (Converted) on page 689 To display a value in the instrument in physical (converted) mode.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Show Current/Reference on page 710 To specify whether to display the current value or the reference value in the
current instrument.
Variable(s) - Add on page 730 To connect a variable to an instrument.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.
Copy / Variables - Copy on page 626 To copy the selected variables to the Clipboard.
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.
Variables - Delete on page 734 To delete the selected variables.
Variables - Paste/Paste Variables on page 735 To paste variables from the Clipboard to an instrument.

320
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Command Purpose
Variable(s) - Select in Variables/Mappings Pane on To select and highlight variables in the Variables pane, or framework labels in
page 731 the Mappings pane.
Variable(s) Properties on page 732 To show the Properties dialog of a connected variable.

Diagnostics Instrument

Illustration

Request PDU field Parameter list

Title bar

Communication
object tree

Button area

Output field

Purpose To communicate with the ECU via the diagnostic protocol using diagnostic
services, diagnostic jobs, and control primitives.

Description The Diagnostics Instrument is divided into the following sections.

Title bar Displays the instrument name and the selected communication
object.

Communication object tree Displays all the diagnostic communication


objects (diagnostic services, diagnostic jobs, and control primitives) that are
available for the logical links, sorted alphabetically by their names in ascending
order. The service IDs can be displayed as prefixes to the names of the
communication objects.
You can select a flat or a hierarchical view of the communication objects.
§ In the flat view, the communication objects are arranged directly under the
logical link they belong to.

321
May 2024 ControlDesk Instrument Handling
Reference Information

§ In the hierarchical view, additional nodes are displayed for functional classes
of diagnostic services, ECU jobs, and control primitives. The diagnostic services
are arranged under the functional class they are assigned to. As a service can
be assigned to multiple functional classes, it can appear under more than one
node. A service that is not assigned to a functional class appears under the
'not assigned' node.
The following table shows the symbols that are used in the tree.

Symbol Meaning
Logical link (disconnected)

Logical link (connected)

Logical link (online calibration started)

Logical link (measuring)

Logical link (unplugged)

Diagnostic service

Diagnostic single-ECU job

Control primitive whose NoOperation flag is set


to FALSE
Control primitive whose NoOperation flag is set
to TRUE1)
Node for diagnostic services that are not assigned
to a functional class (hierarchical view)
Functional class for diagnostic services
(hierarchical view)
Node for diagnostic single-ECU jobs (hierarchical
view)
Node for control primitives (hierarchical view)

A red cross shows that a communication object


is not executable (here, for example, a diagnostic
service).
1) NoOperation = TRUE means that nothing is sent on the bus.

Parameter list Displays the parameters that are available for the selected
communication object. Depending on settings in the ODX database, the
parameter list can change at run time.

Request PDU field Displays the request PDU that results from the service
selection in the communication object tree and the parameter configuration
in the parameter list, or lets you edit the request PDU before the service is
executed.

Output field Displays the results (and intermediate results) of a


communication object call.

Button area Lets you execute instrument–related commands via buttons.


Refer to Related commands on page 323.

322
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Instrument properties The Diagnostics Instrument provides the following properties:

Property Purpose
Active Property on page 415 To activate or deactivate the instrument.
Description Property on page 465 To specify a description for the instrument.
Logical Links Properties on page 493 To display the logical links that are available in the instrument.
Name Property on page 503 To specify the name of the selected instrument.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
Output Properties on page 507 To configure the output properties of the Diagnostics Instrument.
Tooltip Property on page 560 To specify a tooltip for the instrument.
Tree View Properties on page 560 To configure the view properties of the communication object tree in the
Diagnostics Instrument.

Related commands The Diagnostics Instrument provides the following commands:

Command Purpose
Parameter – Assign Default Value(s) to Selected To assign default values to the parameters of a communication object.
Service on page 688
Cancel (Diagnostics Instrument) on page 596 To stop the execution of a diagnostic communication object.
Clear Display on page 601 To remove all entries from the instrument's output field.
Columns (Diagnostics Instrument) on page 613 To add a column to or remove it from the Diagnostics Instrument.
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Display Output – Clear Output on Execution on To specify whether to clear the output field before another communication
page 647 object is executed.
Copy (Diagnostics Instrument) on page 622 To copy the current selection or specific information belonging to the
element(s) currently selected in the Diagnostics Instrument to the Clipboard.
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Create XML Configuration on page 630 To create service configurations for handling fault memory entries based on
the parameter settings specified in the Diagnostics Instrument for use in
an XML configuration file. You can copy the service configurations to the
Clipboard or save them to a file.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Delete (Instrument) on page 639 To delete the currently selected instrument(s).
Display Output – Display Results Only on page 648 To specify whether to show only the results in the output field.
Execute / Execute Cyclically (Diagnostics To execute a diagnostic communication object.
Instrument) on page 651
Instrument Properties on page 666 To view and edit the properties of an instrument.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Save to File on page 702 To save the content of the instrument to a file.

323
May 2024 ControlDesk Instrument Handling
Reference Information

Command Purpose
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Tree Mode - Hierarchical View on page 725 To toggle between hierarchy view and flat view of the diagnostic
communication objects.

Related topics HowTos

How to Configure and Execute Diagnostic Communication Objects (ControlDesk


ECU Diagnostics )

Display

Illustration
Caption

Numeric display mode

Purpose To display the value of the connected variable numerically.

Description The Display can be used as a single instrument for displaying one numeric scalar
variable. You can configure properties of the instrument via the Properties pane.

Caption You can define caption elements, for example, the name and the
unit of the connected variable, and place them at various positions in the
instrument.

Instrument properties The Display provides the following properties:

Property Purpose
Active Property on page 415 To activate or deactivate the instrument.
Background Properties on page 433 To configure the background properties of the current instrument.
Border Properties on page 437 To configure the border settings of an instrument.
Captions/Operating Elements Properties on To add and remove captions and configure the properties of operating
page 443 elements.
Current Display Format Property on page 458 To open a dialog to specify the display format for the connected variable.
Description Property on page 465 To specify a description for the instrument.
Display Properties on page 467 To display the value of the connected variable numerically.
Name Property on page 503 To specify the name of the selected instrument.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.

324
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Property Purpose
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
Tooltip Property on page 560 To specify a tooltip for the instrument.
Use Custom Colors Property on page 561 To enable or disable custom color settings for the instrument.
Use Custom Fonts Property on page 562 To enable or disable global font settings for the instrument.
Variables Properties on page 562 To display and configure the variables that are connected to the instrument.

Related commands The Display provides the following commands:

Command Purpose
Bin (Source) on page 594 To display a value in bin (source) mode.
Bitmask on page 595 To specify the bitmask for the currently selected variable.
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Copy Value (Instruments) on page 629 To copy the value that is displayed in the instrument.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Dec (Source) on page 638 To display a value in dec (source) mode.
Delete (Instrument) on page 639 To delete the selected instruments.
Display Formats on page 647 To specify the display format for the selected variable.
Hex (Source) on page 657 To display a value in hex (source) mode.
Instrument Properties on page 666 To view and edit the properties of an instrument.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Physical (Converted) on page 689 To display a value in the instrument in physical (converted) mode.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Show Current/Reference on page 710 To specify whether to display the current value or the reference value in the
current instrument.
Variable(s) - Add on page 730 To connect a variable to an instrument.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.
Copy / Variables - Copy on page 626 To copy the selected variables to the Clipboard.
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.
Variables - Delete on page 734 To delete the selected variables.
Variables - Paste/Paste Variables on page 735 To paste variables from the Clipboard to an instrument.
Variable(s) - Select in Variables/Mappings Pane on To select and highlight variables in the Variables pane, or framework labels in
page 731 the Mappings pane.
Variable(s) Properties on page 732 To show the Properties dialog of a connected variable.

325
May 2024 ControlDesk Instrument Handling
Reference Information

Fault Memory Instrument

Illustration

Title bar

Logical Link table

Diagnostic Trouble Code


(DTC) table

Diagnostic Trouble Code Data


(DTC Data) table

Button area

Purpose To read, clear, and save the content of the ECU’s fault memory (diagnostic
trouble codes and corresponding environment data).

Description The Fault Memory Instrument is divided into the following sections.

Title bar Displays the instrument name.

Logical Link table Displays properties and settings of the logical links that
are activated in the Properties pane.
For each logical link, you can select the update rate and specify whether
environment data should be displayed. The following properties and settings are
available:

Properties/Settings Shortcut Description


Key
Status None Displays the connection status of the logical link, using the following symbols:

Disconnected

Connected

Online calibration started

Measuring

Unplugged

326
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Properties/Settings Shortcut Description


Key

Busy (Updating)
Logical Link None Displays the name of the logical link (long name or short name as specified on
the Diagnostics Management page of the ControlDesk Options dialog. Refer
to Diagnostics Management Page (ControlDesk ECU Diagnostics )).
Read Service Ctrl+I Displays the service used to read the fault memory or lets you select it for the
logical link. ControlDesk lets you select the read service to be used with the
current Fault Memory Instrument, if an XML configuration file containing several
services for reading the ECU's fault memory is included in the ODX diagnostics
database of the ECU Diagnostics device, or if no XML configuration file belongs
to the ODX diagnostics database but ControlDesk finds several services with
the appropriate classification in the ODX database. If no XML configuration
file belongs to the ODX diagnostics database and ControlDesk finds only one
appropriate service in the ODX database, the service is displayed and you cannot
change the setting.
#DTCs None Displays the number of diagnostic trouble codes that are available for the logical
link.
ReadDTCData Ctrl+R Lets you specify that environment data of a diagnostic trouble code is read and
displayed in the Diagnostic Trouble Code Data table. If disabled, only status
data is displayed. The ReadDTCData setting is synchronized in all Fault Memory
Instruments that reference the same logical link.
Update Rate [s] Ctrl+T Lets you select or enter an update rate for refreshing the information on the
logical link (in seconds). The update rate is synchronized in all Fault Memory
Instruments that reference the same logical link.
Last Update None Displays the time of the last update of the information on the logical link.

Diagnostic Trouble Code (DTC) table Lists the diagnostic trouble codes that
have been received for all the logical links in the instrument and displays their
properties.
The following properties and settings are available:

Properties/Settings Description
New Indicates whether the diagnostic trouble code has been added to the fault memory since the
latest update. The entry new! is displayed for a new DTC. Other DTCs have no entry in this
column.
In addition, new DTCs are displayed in bold letters.
Logical Link Displays the name of the logical link (long name or short name as specified on the Diagnostics
Management Page (ControlDesk ECU Diagnostics ) in the ControlDesk Options dialog).
DTC # Displays the number of the diagnostic trouble code.
Level Displays the DTC level.
Display DTC Displays the Display DTC value, if specified in the ODX. If the Display DTC value is not
available, the number of the DTC is displayed (same value as in the DTC # column).
Description Displays the description text of the DTC. If the ODX does not contain a description text for the
DTC, <DTC text not defined in ODX> is displayed.

Diagnostic Trouble Code Data (DTCData) table Displays the status and
environment data of the DTC that is selected in the diagnostic trouble code

327
May 2024 ControlDesk Instrument Handling
Reference Information

table. The table is empty if no DTC or more than one is selected. The following
properties and settings are available:

Properties/Settings Description
Parameter Displays the name of the parameter of the
DTC's status or environment data item.
Value Displays the value of the parameter.
Unit Displays the unit of the parameter if
available.

Button area Lets you execute instrument–related commands via buttons.


Refer to Related commands on page 329.

Note

To display and handle fault memory entries and environment data in


ControlDesk’s Fault Memory Instrument, the configuration of the service for
reading an ECU's fault memory must contain a response parameter of the
type DOP-DTC. For more information on conventions you have to observe,
refer to Conventions in Connection with ODX Databases (ControlDesk ECU
Diagnostics ) and Basics of the XML Configuration File (ControlDesk ECU
Diagnostics ).

Synchronized update The fault memory information is automatically synchronized for each logical link.
If you update the information on a logical link in one Fault Memory Instrument,
it is also updated in all other Fault Memory Instruments that reference the same
logical link and use the same read service. This means, multiple Fault Memory
Instruments are synchronized as long as the same read service is selected for
them.

If you do not want a Fault Memory Instrument to display updated information,


you can lock it. Refer to Lock Update on page 677.

Automatic bookmark ControlDesk can automatically set a bookmark during a measurement or


recording if the number of DTC entries for a logical link changes. These
bookmarks can then be visualized in a Time Plotter. Refer to Edit Bookmark
Settings (ControlDesk Measurement and Recording ). You can use the
diagnostic trouble code bookmarks as predefined trigger conditions.

DTC measurements ControlDesk supports DTC measurements. DTC measurements allow you to
display diagnostic trouble codes in ControlDesk instruments other than the
Fault Memory and the Diagnostics Instrument. You can use DTC measurements
as trigger variables. Compared with diagnostic trouble code bookmarks, DTC
measurements allow you to define more specific or individual DTC trigger
rules. DTC measurements and DTC bookmarks are not synchronized. Refer to
Performing DTC Measurements (ControlDesk ECU Diagnostics ).

328
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Instrument properties The Fault Memory Instrument provides the following properties:

Property Purpose
Description Property on page 465 To specify a description for the instrument.
Logical Links Properties on page 493 To display the logical links that are available in the instrument.
Name Property on page 503 To specify the name of the selected instrument.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
Tooltip Property on page 560 To specify a tooltip for the instrument.

Related commands The Fault Memory Instrument provides the following commands:

Command Purpose
Active Property on page 415 To activate or deactivate the instrument.
Clear All DTCs on page 6011) To delete all trouble code entries from the fault memory.
Clear Selected DTC on page 6021) To delete the selected trouble code entry from the fault memory.
Columns (Fault Memory Instrument) on page 614 To add a column to or remove it from the Fault Memory Instrument.
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Copy (Fault Memory Instrument) on page 624 To copy the current selection or specific information belonging to the
element(s) currently selected in the Fault Memory Instrument to the
Clipboard.
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Delete (Instrument) on page 639 To delete the currently selected instrument(s).
Instrument Properties on page 666 To view and edit the properties of an instrument.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Lock Update on page 677 To 'freeze' the instrument display.
Save to File on page 702 To save the content of the instrument to a file.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Update All LLs on page 7261) To update the information on all the logical links in the Fault Memory
Instrument(s).
Update Selected LLs on page 727 To update the information on the selected logical links in the Fault Memory
Instrument(s).
1) This command is available only if the ODX database contains the corresponding service
(according to the ControlDesk conventions) and it is supported by the ECU.

Related topics HowTos

How to Display Fault Memory Entries (ControlDesk ECU Diagnostics )

329
May 2024 ControlDesk Instrument Handling
Reference Information

Frame

Illustration Caption

Instruments placed
on the Frame

The illustration above shows an example of a Frame that groups two


instruments.

Purpose To add a background frame to a layout, for example, to visualize an instrument


group.

Description The Frame can be used to surround instruments on a layout and mark them
as a unit. The instrument consists of a border, captions and a background
(including color and image). You can configure properties of the instrument via
the Properties pane.

Caption You can define caption elements, for example, the name and the
unit of the connected variable, and place them at various positions in the
instrument.

Instrument properties The Frame provides the following properties:

Property Purpose
Active Property on page 415 To activate or deactivate the instrument.
Background Properties on page 433 To configure the background properties of the current instrument.
Border Properties on page 437 To configure the border settings of an instrument.
Captions/Operating Elements Properties on To add and remove captions and configure the properties of operating
page 443 elements.
Description Property on page 465 To specify a description for the instrument.
Name Property on page 503 To specify the name of the selected instrument.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
Tooltip Property on page 560 To specify a tooltip for the instrument.
Use Custom Colors Property on page 561 To enable or disable custom color settings for the instrument.

330
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Property Purpose
Use Custom Fonts Property on page 562 To enable or disable global font settings for the instrument.
Variables Properties on page 562 To display and configure the variables that are connected to the instrument.

Related commands The Frame provides the following commands:

Command Purpose
Bin (Source) on page 594 To display a value in bin (source) mode.
Bitmask on page 595 To specify the bitmask for the currently selected variable.
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Connect as Main Variable / Connect Variable(s) on To connect the selected variable to the instrument as the main variable.
page 619
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Copy Value (Instruments) on page 629 To copy the value that is displayed in the instrument.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Dec (Source) on page 638 To display a value in dec (source) mode.
Delete (Instrument) on page 639 To delete the selected instruments.
Hex (Source) on page 657 To display a value in hex (source) mode.
Instrument Properties on page 666 To view and edit the properties of an instrument.
Physical (Converted) on page 689 To display a value in the instrument in physical (converted) mode.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Show Current/Reference on page 710 To specify whether to display the current value or the reference value in the
current instrument.
Variable(s) - Add on page 730 To connect a variable to an instrument.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.
Copy / Variables - Copy on page 626 To copy the selected variables to the Clipboard.
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.
Variables - Delete on page 734 To delete the selected variables.
Variables - Paste/Paste Variables on page 735 To paste variables from the Clipboard to an instrument.
Variable(s) - Select in Variables/Mappings Pane on To select and highlight variables in the Variables pane, or framework labels in
page 731 the Mappings pane.
Variable(s) Properties on page 732 To show the Properties dialog of a connected variable.

331
May 2024 ControlDesk Instrument Handling
Reference Information

Gauge

Illustration
Caption Indicator

Scale Tic

Label

Band Needle

Purpose To display the value of the connected variable by a needle deflection on a circular
scale.

Description The Gauge can be used as a single instrument for displaying one measurement
variable. You can configure properties of the instrument via the Properties pane.

Caption You can define caption elements, for example, the name and the
unit of the connected variable, and place them at various positions in the
instrument.

Scale area Displays the scale of the instrument. The scale consists of the
following parts, which can be configured individually:

Scale parts Description


Bands The bands define colored areas within the scale's value range. A
band has a start position (minimum value) and an end position
(maximum value).
Indicators The indicators mark the minimum or maximum value of the
measurement.
Labels The labels of the tics display the numerical values of the scale.
Tics The tics display the divisions of the scale. There are major tics and
minor tics.

332
ControlDesk Instrument Handling May 2024
Instrument Descriptions

By default, the scale is adjusted to the weak limits of the connected variable. You
can edit the range via the properties.
MajorTics

MinorTics

Delta

Gauge area Displays the value of the connected variable via a Gauge with a
needle.
You can configure, for example, the color, size and style of the needle as well as
the start and stop angels of the gauge.

Operating element The operating element is an invisible frame, in which the


gauge element (scale area and gauge area) can be positioned. You can configure
the position of the gauge element within the operating element via horizontal
and vertical position settings.

Views When you select an instrument, it is automatically highlighted. There


are also other views, as shown by the examples in the following table.

View Description
No-value view The instrument is not receiving valid values. For
measurement variables, you will find this view, for example,
if you have not started a measurement after loading an
experiment. For parameters, you will find this view, for
example, if you added a variable description without an
initial data set but did not upload values from the ECU.

Automatic sizing ControlDesk provides the Automatic Sizing property to


adjust the scale of the instrument automatically, for example, when you change
the Min/Max values, resize the instrument, or resize the operating element. If the
instrument becomes too small or the value range becomes too large, the number
of tics and labels is reduced automatically or completely hidden.

Colors and fonts settings You can specify whether to use the global
ControlDesk colors and fonts settings for the selected instrument or configure
your own settings.

333
May 2024 ControlDesk Instrument Handling
Reference Information

Instrument properties The Gauge provides the following properties:

Property Purpose
Active Property on page 415 To activate or deactivate the instrument.
Angle Properties on page 420 To configure the start and stop angles of the circular scale.
Automatic Sizing Property (Bar, Gauge, Knob, To enable or disable the automatic sizing function.
Slider) on page 421
Background Properties on page 433 To configure the background properties of the current instrument.
Description Property on page 465 To specify a description for the instrument.
Bands Properties on page 433 To specify the properties of colored bands for the highlighting of value
ranges.
Border Properties on page 437 To configure the border settings of an instrument.
Captions/Operating Elements Properties on To add and remove captions and configure the properties of operating
page 443 elements.
Horizontal Hub Position Property on page 478 To move the hub horizontally inside the operating element.
Name Property on page 503 To specify the name of the selected instrument.
Needle Properties (Gauge) on page 504 To configure the properties of the needle.
Overflow Warning Property on page 508 To enable or disable the overflow warning function.
Radius Property on page 515 To specify the value for the radius of the instrument.
Scale Properties on page 522 To configure the scale properties of the selected instrument.
Range Properties on page 517 To configure the scale range properties of the selected instrument.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
Tooltip Property on page 560 To specify a tooltip for the instrument.
Use Custom Colors Property on page 561 To enable or disable custom color settings for the instrument.
Use Custom Fonts Property on page 562 To enable or disable global font settings for the instrument.
Variables Properties on page 562 To display and configure the variables that are connected to the instrument.
Vertical Hub Position Property on page 566 To move the hub vertically inside the operating element.

Related commands The Gauge provides the following commands:

Command Purpose
Bitmask on page 595 To specify the bitmask for the currently selected variable.
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Connect as Main Variable / Connect Variable(s) on To connect the selected variable to the instrument as the main variable.
page 619
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Copy Value (Instruments) on page 629 To copy the value that is displayed in the instrument.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Dec (Source) on page 638 To display a value in dec (source) mode.
Display Formats on page 647 To specify the display format for the selected variable.

334
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Command Purpose
Delete (Instrument) on page 639 To delete the selected instruments.
Physical (Converted) on page 689 To display a value in the instrument in physical (converted) mode.
Indicators - Reset Max on page 663 To reset the maximum indicator to the current value of the instrument.
Indicators - Reset Min on page 664 To reset the minimum indicator to the current value of the instrument.
Instrument Properties on page 666 To view and edit the properties of an instrument.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Show Current/Reference on page 710 To specify whether to display the current value or the reference value in the
current instrument.
Variable(s) - Add on page 730 To connect a variable to an instrument.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.
Copy / Variables - Copy on page 626 To copy the selected variables to the Clipboard.
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.
Variables - Delete on page 734 To delete the selected variables.
Variables - Paste/Paste Variables on page 735 To paste variables from the Clipboard to an instrument.
Variable(s) - Select in Variables/Mappings Pane on To select and highlight variables in the Variables pane, or framework labels in
page 731 the Mappings pane.
Variable(s) Properties on page 732 To show the Properties dialog of a connected variable.

Related topics HowTos

How to Configure the Gauge................................................................................................. 112

335
May 2024 ControlDesk Instrument Handling
Reference Information

Hierarchy Array

Illustration Tab bar

Header row
Row

Column Cell

Purpose To display variables grouped into custom hierarchy levels using different cell types
for visualization.

Description Tabs The Hierarchy Array instrument can consist of any number of tabs. You
can use the tab bar to switch between them.

Header rows You can use header rows to group variables in new hierarchy
levels.
The Indent property of a header row lets you specify the indent of all the rows
on subordinate levels to better visualize the hierarchy.
A header row can consist of several cells.

Rows Rows are subordinate to header rows and can contain any number of
cells representing variable values and descriptions.

Note

Header rows and rows are hidden until you add cells to them.

336
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Cells Each cell displays information according to its cell type, e.g., a variable
value.
The following table lists all available cell types.

Cell Type Illustration Description


Alphanumeric Input To edit and display the value of a scalar parameter or the text content
of an ASCII variable.
Bar To display the value of a scalar variable as a bar deflection.

Bitfield To edit and display the source value of a parameter as a bit string.

Check button To set the variable value to a predefined value when you select the
checkbox (On) and when you clear it (Off), and to display whether one
of the predefined values is the current value of the connected variable.
If this is not the case, the value is grayed out.
Display To display the value of a scalar variable or the text content of an ASCII
variable.
Icon To display an icon or other image.

Label To display label text.

Multistate LED To display the value of a variable as an LED state.

On/Off button To set the variable value to a predefined value when you press the
button (On) and when you release the button (Off).
Push button To set the variable to a predefined value when you press the button.

Selection box To select a text-value entry and set the respective numerical value for
the connected variable.
Slider To edit and display the value of a scalar parameter on a slide.

Tip

You can apply property settings to multiple cells at once.


For an animated graphic, refer to dSPACE Help.

Keyboard shortcuts The following table provides an overview of keyboard shortcuts for the Hierarchy
Array.

Keyboard Shortcut Purpose


PgUp/PgDown To write small increments/decrements directly to a
variable.
Ctrl + PgUp/PgDown To write large increments/decrements directly to a
variable.

337
May 2024 ControlDesk Instrument Handling
Reference Information

Keyboard Shortcut Purpose


Enter To expand/collapse the rows below the selected header
row.
Delete To delete the active tab.

Instrument properties The Hierarchy Array provides the following instrument properties:

Property Purpose
Active Property on page 415 To activate or deactivate the instrument.

Common
Name Property on page 503 To specify the name of the selected instrument.
Use Custom Colors Property on page 561 To specify the color of the selected item.
Use Custom Fonts Property on page 562 To enable or disable global font settings for the instrument.
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Description Property on page 465 To specify a description for the instrument.
Tooltip Property on page 560 To specify a tooltip for the instrument.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.
Border Properties on page 437 To configure the border settings of an instrument.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533

Hierarchy Array
Automatic Sizing Property (Hierarchy Array) on To enable or disable automatic sizing of instrument cells.
page 422
Text / Numeric Output Font Properties on page 553 To configure the font properties of the selected item.
Focus Color Property on page 472 To specify the color used to outline the selected cell.
Separator Color Property on page 533 To specify the color of the separators between lines and columns.
Tabs Properties (Hierarchy Array) on page 552 To open the Tabs dialog.
Tab Bar Properties on page 549 To specify properties of the tab bar.

Selected Tab
Name on page 552 To specify a name for the tab.
Rows Properties (Hierarchy Array) on page 521 To open the Rows dialog.
Active color on page 552 To specify the color of the active tab.
Active text color on page 552 To specify the text color of the active tab.
Active font on page 552 To specify the header font that is used when the tab is active, i.e., selected.
Inactive color on page 553 To specify the color of inactive tabs.
Inactive text color on page 553 To specify the text color of inactive tabs.
Inactive font on page 553 To specify the header font that is used when the tab is inactive.

Selected Column
Width Property (Hierarchy Array) on page 568 To specify the width of the selected column.

Selected Row
Height on page 522 To specify the height of the selected row.
Cells on page 522 To open the Cells dialog.

338
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Property Purpose

Selected Cell
Alignment/Text Alignment Property (Hierarchy To specify the alignment of the content of the selected cell.
Array) on page 419
Cell type on page 447 To select a type for the selected value cell.
Column span on page 448 To set the number of columns the selected cell spans.
Foreground color on page 448 To specify the foreground color of the selected cell.
Cell Properties on page 447 To specify the background color of the selected cell.
Variables Properties on page 562 To display and configure the variables that are connected to the instrument.
Button Cell Properties (Value Cell – Button) on To configure the button properties of the selected Check button, On/Off
page 438 button, or Push button cell.
Multistate LED Properties on page 500 To configure the properties of the selected Multistate LED cell.
Scale Range Properties (Value Cell – Bar/Slider) on To configure the scale range properties of the selected Bar or Slider cell.
page 526
Range Check Properties on page 516 To configure a range check for the value.
Icon Properties on page 479 To specify the properties of the selected icon cell.
Text Property (Hierarchy Array) on page 556 To specify the label of the selected Label cell.
Selection Box Cell Properties on page 531 To configure the properties of the selected Selection box cell.
Text Alignment Property on page 554 To specify the alignment of text in the selected Hierarchy Array cell.

Related commands The Hierarchy Array provides the following commands:

Command Purpose
Adjust Value(s) on page 586 To enter a value as the operand to change the parameter value.
Assign Recent Value on page 591 To display the most recent scalar values of a variable and to reset the variable
to one of them.
Bin (Source) on page 594 To display a value in bin (source) mode.
Bitmask on page 595 To specify the bitmask properties for the selected variable.
Cell - Change To on page 597 To change the type of the selected cell.
Cell - Delete on page 598 To delete the selected cell.
Collapse All on page 606 To collapse all rows in the instrument.
Collapse Subordinate Rows on page 606 To collapse only the subordinate rows below a header row.
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Compu Tab Items Sorted on page 616 To sort the string list of a value with verbal conversion (CompuVTab,
CompuVTabRange) alphabetically.
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Copy Value (Instruments) on page 629 To copy the value that is displayed in the instrument.
Copy / Variables - Copy on page 626 To copy the selected variables to the Clipboard.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Dec (Source) on page 638 To display a value in dec (source) mode.
Delete (Instrument) on page 639 To delete the selected instruments.
Display Formats on page 647 To specify the display format for the selected variable.
Expand All on page 652 To expand all rows in the instrument.
Expand Subordinate Rows on page 652 To expand only the subordinate rows below a header row.

339
May 2024 ControlDesk Instrument Handling
Reference Information

Command Purpose
Hex (Source) on page 657 To display a value in hex (source) mode.
Increments on page 662 To specify the increments for the selected variable.
Instrument Properties on page 666 To view and edit the properties of an instrument.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Optimize on page 683 To let ControlDesk specify the optimum width and/or heigth of the selected
instrument.
Physical (Converted) on page 689 To display a value in the instrument in physical (converted) mode.
Row - Cells on page 698 To open the Cells dialog.
Row - Delete on page 699 To delete the selected row.
Rows (refer to Rows Properties (Hierarchy Array) on To open the Rows dialog.
page 521)
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Select in Bus Navigator on page 705 To select the associated element in the Bus Navigator.
Show Current/Reference on page 710 To specify whether to display the current value or the reference value in the
current instrument.
Toggle Bits on page 723 To toggle selected bits of the connected variable.
Variable(s) - Add on page 730 To connect a variable to an instrument.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.
Copy / Variables - Copy on page 626 To copy the selected variables to the Clipboard.
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.
Variables - Delete on page 734 To delete the selected variables.
Variables - Paste/Paste Variables on page 735 To paste variables from the Clipboard to an instrument.
Variable(s) Properties on page 732 To show the Properties dialog of a connected variable.

Related topics HowTos

How to Configure the Hierarchy Array.................................................................................... 116

Videos

Handling the Hierarchy Array (4:15) in dSPACE Help

340
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Index Plotter

Illustration

Y-axis

Cursor
Chart area (Move mode)

DAQ info
Signal symbol
Show legend

X-axis Legend

Purpose To display signals in relation to an index (index plots).

Description Y-axis The Index Plotter uses the y-axis as a signal axis. You can add several
variables to one y-axis and create more than one y-axis in the y-axes area.

X-axis The Index Plotter uses the x-axis as an event axis that displays indices
for each captured sample. The Index Plotter is usually used for signals with
event-based rasters. If you select a time-based raster for a signal, the time-based
samples are interpreted as events.

Chart area Displays signals referring to several y-axes. The signals can be
displayed in several styles and colors.

Cursor in Move or Zoom mode If you move the pointer to the chart area,
the displayed cursor depends on the navigation mode. You can change the
navigation mode via the chart's context menu.

Cursor Navigation Mode Description


Zoom mode You can specify the zoom area with the pointer.

Move mode You can move the chart in the x-axis and the
y-axis directions.

For details, refer to Zooming and Moving the Chart (Index Plotter) on page 124

341
May 2024 ControlDesk Instrument Handling
Reference Information

Signal symbol The signal symbol shows the signal's color in the chart. You
can double-click it to show or hide the signal or right-click it to open the context
menu with various signal-related commands.
The signal symbol shows the status of the connection:

Symbol Description
No variable connected
Variable connected. Signal is displayed in the chart area.
The active signal has a white frame. In the chart, the active signal is
displayed in the foreground. Its properties are listed below selected
element in the properties list.
Variable connection invalid. Move the pointer over the symbol to
open a tooltip with information on the reasons.
Signal is disabled and not displayed in the chart area.

Data cursors Measured data can be analyzed using one or two data cursors.
The positions of the cursors and the distance between them can be displayed in
the Plotter:

The data cursors allow you to analyze the x‑ and y‑axis values as they were at
two points during a measurement.

DAQ info Information on the currently active data acquisition settings, such
as the selected DAQ mode, can be displayed.

Differences between Time Plotter, Index Plotter, and XY


Plotter ControlDesk offers three plotters types with different main purposes.
Knowing the differences helps you to select the appropriate type.
For details, refer to Choosing Between Time Plotter, Index Plotter, and XY Plotter
on page 40.

Instrument properties The Index Plotter provides the following properties:

Property Purpose
Advanced Settings Properties (Time Plotter/Index To configure advanced settings.
Plotter) on page 416
Axes and Signals Properties (Time Plotter/Index To configure the properties of the selected axis or signal.
Plotter) on page 422
Background Properties on page 433 To configure the background properties of the current instrument.
Border Properties on page 437 To configure the border settings of an instrument.
Custom Value Conversion Properties on page 461 To specify properties for converting a source value into a converted value and
vice versa. The variable conversion that you define here is assigned to the
instrument.

342
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Property Purpose
Conversion Table Settings Properties (Time (Available only if the connected variable is converted via verbal table
Plotter/Index Plotter) on page 457 conversion) To specify properties for connected variables with verbal
conversion tables.
Data Cursor Properties (Time Plotter/Index Plotter) To specify the properties of one or two cursors that are used to display the
on page 463 values of selected chart positions.
Delete (Y-Axis Time Plotter/Index Plotter) on To delete the selected y-axis.
page 639
Description Property on page 465 To specify a description for the instrument.
DAQ Properties (Time Plotter/Index Plotter) on To specify data acquisition settings for visualization in the Index Plotter or
page 462 Time Plotter. For example, you can enable a triggered display of plotter data.
Description Property on page 465 To specify a description for the instrument.
Grid Properties (Time Plotter/Index Plotter) on To configure the grid properties.
page 474
Legend Properties (Time Plotter/Index Plotter) on To specify the legend properties.
page 492
Name Property on page 503 To specify the name of the selected instrument.
Overlay Elements Properties (Time Plotter/Index To configure overlay elements that can be displayed in the plotter's chart.
Plotter) on page 508
Picture Properties on page 512 To specify whether to use an image (or animated GIF) for the selected
element and to specify its properties.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.
Scroll Bar Properties (Time Plotter/Index Plotter) on To specify the scroll bar properties.
page 527
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
Tooltip Property on page 560 To specify a tooltip for the instrument.
Use Custom Colors Property on page 561 To enable or disable custom color settings for the instrument.
Use Custom Fonts Property on page 562 To enable or disable global font settings for the instrument.
View Properties (Time Plotter/Index Plotter) on To configure the view of the axes.
page 566

Related commands The Index Plotter provides the following commands:

Command Purpose
Best Fit on page 593 To adjust the column width of the selected legend column automatically.
Best Fit (All Columns) on page 593 To adjust the column width of the selected legend column automatically.
Clear Sorting on page 603 To adjust the column width of the selected legend column automatically.
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Copy / Variables - Copy on page 626 To copy the selected variables to the Clipboard.
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Column Chooser (Time Plotter/Index Plotter) on To add/remove columns to/from the legend.
page 607
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.

343
May 2024 ControlDesk Instrument Handling
Reference Information

Command Purpose
DAQ - Available Raster (Time Plotter/Index Plotter) To select a measurement raster for a signal.
on page 633
DAQ – Leading Raster (Time Plotter/Index Plotter) To select one of the measurement rasters of the displayed signals as the
on page 634 leading raster for the plotter display. The list contains all the rasters that are
currently used.
DAQ – Mode (Time Plotter/Index Plotter) on To switch between triggered and untriggered display of plotter data.
page 635
DAQ - Trigger (Time Plotter/Index Plotter) on To switch between automatic and interactive setting of the signal's
page 637 measurement trigger.
Delete (Y-Axis Time Plotter/Index Plotter) on To delete the selected y-axis.
page 639
Delete (Instrument) on page 639 To delete the selected instruments.
Delete Signal (Time Plotter/Index Plotter) on To delete the selected signal.
page 644
Group by This Column on page 656 To group the signals in the legend according to the entries of the column.
Hide Expand Button on page 658 To hide the legend's expand button in the instrument.
Hide Search Panel on page 660 To hide the find panel. The find panel lets you filter the signals to be
displayed in the plotter by a search string.
Hide Group By Box on page 659 To hide the group by box. The group by box lets you group the signals in the
legend via drag & drop.
Filter Editor on page 654 To filter the signals that are displayed in a plotter by filter rules.
Instrument Properties on page 666 To view and edit the properties of an instrument.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Line Style (Time Plotter/Index Plotter) on page 676 To specify whether to connect the points of a line graphically by a straight
line.
Navigation – Enable/Disable Move Mode (Time To enable or disable the move mode. The move mode lets you move the
Plotter/Index Plotter) on page 679 displayed area of the axis via mouse pointer.
Navigation – Move Mode (Time Plotter/Index To move the displayed area of the chart via the pointer.
Plotter) on page 680
Navigation – Rescale (Time Plotter/Index Plotter) on To rescale one or all axes.
page 681
Navigation – Zoom Mode (Time Plotter/Index To zoom the displayed area of the chart via the pointer.
Plotter) on page 681
Point Style (Time Plotter/Index Plotter) on page 690 To select the style of the signal's points.
Remove This Column on page 693 To remove the selected column from the legend.
Rescale on page 696 To rescale one or both axes of a plot.
Save Displayed Data as New Measurement on To save the data that is displayed in a Time Plotter as a new measurement.
page 701
Scaling Mode on page 703 To select the scaling mode of the axis.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Show Bookmarks on page 708 To show or hide bookmark symbols at the x-axis.
Show Column Headers (Time Plotter/Index Plotter) To show/hide the column headers in the legend.
on page 709
Show Expand Button on page 711 To display the legend's expand button in the instrument.
Show Find Panel on page 711 To filter the signals to be displayed in the plotter by a search string.

344
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Command Purpose
Show Group By Panel on page 712 To group the signals in the legend via drag & drop.
Show Legend on page 713 To show/hide the legend.
Show Toolbar on page 715 To show/hide the instrument's toolbar.
Sort Ascending on page 718 To sort the rows of the legend alphabetically in ascending order by the
selected column.
Sort Descending on page 719 To sort the rows of the legend alphabetically in descending order by the
selected column.
Tic Format on page 722 To select the format used to label the axis tics.
Variable - Converted (Plotter Instruments) on To display the signal values in converted (physical) mode.
page 728
Variable - Delete Variable (Time Plotter/Index To delete the selected variable leaving an unconnected signal.
Plotter) on page 729
Variable - Source (Time Plotter/Index Plotter) on To display the signal values in source (dec) mode.
page 729
Variable(s) - Add on page 730 To connect a variable to an instrument.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.
Configure Connection Assignment on page 617 To configure the connection assignment of the variable(s) in the selected
instrument(s).
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.
Variables - Delete on page 734 To delete the selected variables.
Variables - Paste/Paste Variables on page 735 To paste variables from the Clipboard to an instrument.
Variable(s) - Select in Variables/Mappings Pane on To select and highlight variables in the Variables pane, or framework labels in
page 731 the Mappings pane.
Y-Axes View – Horizontal Stacked on page 735 To arrange the y-axes horizontally one below the other.
Y-Axes View – Rescale All Axes on page 736 To rescale all y-axes in one step.
Y-Axes View – Settings on page 737 To set the width of the y-axes to optimum, maximum, or fixed size.
Y-Axes View – Vertical Fixed on page 738 To align the y-axes vertically. All y-axes are visible.
Y-Axes View – Vertical Scroll on page 738 To align the y-axes vertically in a scroll area.

Related topics Basics

Choosing Between Time Plotter, Index Plotter, and XY Plotter................................................... 40


Index Plotter Handling............................................................................................................ 120

Videos

Comparing Time Plotter, Index Plotter, and XY Plotter (3:41) in dSPACE Help
Displaying Cursors (3:49) in dSPACE Help
Sensitive Areas and Adding Signals (3:57) in dSPACE Help
Specifying Plotter Settings in the Properties Pane (2:41) in dSPACE Help
Specifying Plotter Signal Settings (5:21) in dSPACE Help

345
May 2024 ControlDesk Instrument Handling
Reference Information

Invisible Switch

Illustration The Invisible Switch is an invisible instrument.

Purpose To define an area on the layout that is sensitive to mouse operations.

Description The Invisible Switch can be configured as an On/Off Button, as a Push Button
or as a Check Button, to set values to the connected variables in the same way
as the simulated Instrument. It can be positioned, for example, on a Frame with
a background picture. This allows you to create an instrument with a realistic
appearance. As with the other buttons of the ControlDesk instruments, you can
enter an Off and OnValue.

Instrument properties The Invisible Switch provides the following properties:

Property Purpose
Active Property on page 415 To activate or deactivate the instrument.
Description Property on page 465 To specify a description for the instrument.
Edit Mode Property (Invisible Switch) on page 470 To specify whether to display the area of the Invisible Switch.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
Name Property on page 503 To specify the name of the selected instrument.
Off-Value Property on page 505 To specify the Off value of the button.
On-Value Property on page 506 To specify the On value of the button.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Switch Mode Property on page 548 To select a button type which the Invisible Switch simulates.
Tooltip Property on page 560 To specify a tooltip for the instrument.
Variables Properties on page 562 To display and configure the variables that are connected to the instrument.

Related commands The Invisible Switch provides the following commands:

Command Purpose
Adjust Value(s) on page 586 To enter a value as the operand to change the parameter value.
Bitmask on page 595 To specify the bitmask for the currently selected variable.
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Connect as Additional Write Variable(s) on To connect the selected variable to the instrument for calibration as an
page 618 additional write variable.
Connect as Main Variable / Connect Variable(s) on To connect the selected variable to the instrument as the main variable.
page 619
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.

346
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Command Purpose
Copy Value (Instruments) on page 629 To copy the value that is displayed in the instrument.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Dec (Source) on page 638 To display a value in dec (source) mode.
Delete (Instrument) on page 639 To delete the selected instruments.
Instrument Properties on page 666 To view and edit the properties of an instrument.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Physical (Converted) on page 689 To display a value in the instrument in physical (converted) mode.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Show Current/Reference on page 710 To specify whether to display the current value or the reference value in the
current instrument.
Variable(s) - Add on page 730 To connect a variable to an instrument.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.
Copy / Variables - Copy on page 626 To copy the selected variables to the Clipboard.
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.
Variables - Delete on page 734 To delete the selected variables.
Variables - Paste/Paste Variables on page 735 To paste variables from the Clipboard to an instrument.
Variable(s) - Select in Variables/Mappings Pane on To select and highlight variables in the Variables pane, or framework labels in
page 731 the Mappings pane.
Variable(s) Properties on page 732 To show the Properties dialog of a connected variable.

Related topics HowTos

How to Use the Invisible Switch.............................................................................................. 141

Knob

Illustration
Caption

Knob
Indicator

Scale
Tic

Label

Mark Band

347
May 2024 ControlDesk Instrument Handling
Reference Information

Purpose To display and set the value of the connected variable by means of a knob on a
circular scale.

Description The Knob can be used as a single instrument for calibrating one parameter. You
can configure properties of the instrument via the Properties pane.

Caption You can define caption elements, for example, the name and the
unit of the connected variable, and place them at various positions in the
instrument.

Scale area Displays the scale of the instrument. The scale area consists of the
following parts, which can be configured individually:

Scale Parts Description


Bands The bands define colored areas within the scale's value range. A
band has a start position (minimum value) and an end position
(maximum value).
Indicators The indicators mark the minimum or maximum value of the
calibration.
Labels The labels of the tics display the numerical values of the scale.
Tics The tics display the divisions of the scale. There are major tics and
minor tics.

By default, the scale is adjusted to the weak limits of the connected variable. You
can edit the range via the properties.
MajorTics

MinorTics

Delta

Knob area Displays the value of the connected variable via a mark on a
Knob.
You can configure, for example, the color, size and style of the mark as well as
the start and stop angels of the Knob.

The Knob can be turned by mouse or Arrow Up/Down keys.


§ Arrow Up key increases the value (small increments).
§ Arrow Down key decreases the value (small increments).

348
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Tip

If the Ctrl key is pressed simultaneously, the value is increased/decreased in


larger steps (big increments). The value can be set to the scale’s start value
by pressing the Home key and to the scale’s stop value by the End key.

The instrument displays the value of the connected signal by turning the Knob’s
mark. If the value exceeds the stop value or falls below the start value of the
scale, the Knob’s mark stays at the beginning/end of the scale.

Operating element The operating element is an invisible frame, in which the


knob element (scale area and knob area) can be positioned. You can configure
the position of the knob element within the operating element via horizontal
and vertical position settings.

Views When you select an instrument, it is automatically highlighted. There


are also other views, as shown by the examples in the following table.

View Description
No-value view No-value
The instrument is not receiving valid values. For measurement
variables, you will find this view, for example, if you have
not started a measurement after loading an experiment. For
parameters, you will find this view, for example, if you added
a variable description without an initial data set but did not
upload values from the ECU.

Read-only view The connected variable is read-only and cannot be calibrated.


If the connected variable is read-only, the knob is illuminated
from the bottom, otherwise it is illuminated from the top.

Automatic sizing ControlDesk provides the Automatic Sizing property to


adjust the scale of the instrument automatically, for example, when you change
the Min/Max values, resize the instrument, or resize the operating element. If the
instrument becomes too small or the value range becomes too large, the number
of tics and labels is reduced automatically or completely hidden.

Colors and fonts settings You can specify whether to use the global
ControlDesk colors and fonts settings for the selected instrument or configure
your own settings.

349
May 2024 ControlDesk Instrument Handling
Reference Information

Instrument properties The Knob provides the following properties:

Property Purpose
Active Property on page 415 To activate or deactivate the instrument.
Angle Properties on page 420 To configure the start and stop angles of the circular scale.
Automatic Sizing Property (Bar, Gauge, Knob, To enable or disable the automatic sizing function.
Slider) on page 421
Background Properties on page 433 To configure the background properties of the current instrument.
Bands Properties on page 433 To specify the properties of colored bands for the highlighting of value
ranges.
Border Properties on page 437 To configure the border settings of an instrument.
Captions/Operating Elements Properties on To add and remove captions and configure the properties of operating
page 443 elements.
Color Property on page 452 To specify the color of the selected item.
Description Property on page 465 To specify a description for the instrument.
Display Formats Properties on page 465 To configure the display format for the display area.
Horizontal Hub Position Property on page 478 To move the hub horizontally inside the operating element.
Increments Properties on page 479 To configure the increments for the selected variable.
Mark Properties on page 497 To configure the properties of the mark.
Name Property on page 503 To specify the name of the selected instrument.
Overflow Warning Property on page 508 To enable or disable the overflow warning function.
Picture Properties on page 512 To specify whether to use an image (or animated GIF) for the selected
element and to specify its properties.
Radius Property on page 515 To specify the value for the radius of the instrument.
Range Check Properties on page 516 To configure a range check for the value.
Scale Properties on page 522 To configure the scale properties of the selected instrument.
Range Properties on page 517 To configure the scale range properties of the selected instrument.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
Tooltip Property on page 560 To specify a tooltip for the instrument.
Use Custom Colors Property on page 561 To enable or disable custom color settings for the instrument.
Use Custom Fonts Property on page 562 To enable or disable global font settings for the instrument.
Variables Properties on page 562 To display and configure the variables that are connected to the instrument.
Vertical Hub Position Property on page 566 To move the hub vertically inside the operating element.

Related commands The Knob provides the following commands:

Command Purpose
Adjust Value(s) on page 586 To enter a value as the operand to change the parameter value.
Assign Recent Value on page 591 To display the most recent scalar values of a variable and to reset the variable
to one of them.

350
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Command Purpose
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Connect as Additional Write Variable(s) on To connect the selected variable to the instrument for calibration as an
page 618 additional write variable.
Connect as Main Variable / Connect Variable(s) on To connect the selected variable to the instrument as the main variable.
page 619
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Copy Value (Instruments) on page 629 To copy the value that is displayed in the instrument.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Dec (Source) on page 638 To display a value in dec (source) mode.
Delete (Instrument) on page 639 To delete the selected instruments.
Display Formats on page 647 To specify the display format for the selected variable.
Increments on page 662 To specify the increments for the selected variable.
Indicators - Reset Max on page 663 To reset the maximum indicator to the current value of the instrument.
Indicators - Reset Min on page 664 To reset the minimum indicator to the current value of the instrument.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Physical (Converted) on page 689 To display a value in the instrument in physical (converted) mode.
Show Current/Reference on page 710 To specify whether to display the current value or the reference value in the
current instrument.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Toggle Bits on page 723 To toggle selected bits of the connected variable.
Variable(s) - Add on page 730 To connect a variable to an instrument.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.
Copy / Variables - Copy on page 626 To copy the selected variables to the Clipboard.
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.
Variables - Delete on page 734 To delete the selected variables.
Variables - Paste/Paste Variables on page 735 To paste variables from the Clipboard to an instrument.
Variable(s) - Select in Variables/Mappings Pane on To select and highlight variables in the Variables pane, or framework labels in
page 731 the Mappings pane.
Variable(s) Properties on page 732 To show the Properties dialog of a connected variable.

Related topics HowTos

How to Change Values with the Knob.................................................................................... 146


How to Configure the Knob................................................................................................... 145

351
May 2024 ControlDesk Instrument Handling
Reference Information

MultiState Display

Illustration
Caption

Message text

LED

Purpose To display the value of a variable as an LED state and/or as a text message.

Description The MultiState Display can be used to show different states in the value range of
a variable. For each state, you can define a colored LED and/or a text message
to be displayed when the value matches the state. You can also define an image
or an animated GIF and/or a sound for each state. The state related to the first
matching range is displayed.

You can configure properties of the instrument via the Properties pane.

LED and Message You can select four display modes for the MultiState
Display:
§ LED
§ Message
§ LED and Message
§ Custom
In LED, Message and LED and Message display mode, the specified settings of
the states in the instrument are the same. You can only specify the LED settings,
such as the style and color for the LED display mode and text settings for the
Message display mode. In LED and Message display mode, you can additionally
customize the positions and proportion of the LED and message to be displayed.

Tip

ControlDesk lets you enable LED blinking, which allows you to draw the
user's attention to the instrument when a certain state of the connected
variable is reached, for example.
You can enable blinking and specify the blinking color and interval for each
LED state individually.

In Custom display mode, you can mix all the available settings for each state
individually such as the combination of LED, message, picture and sound.

Caption You can define caption elements, for example, the name and the
unit of the connected variable, and place them at various positions in the
instrument.

352
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Colors and fonts settings You can specify whether to use the global
ControlDesk colors and fonts settings for the selected instrument or configure
your own settings.

Instrument properties The MultiState Display provides the following properties:

Property Purpose
Active Property on page 415 To activate or deactivate the instrument.
Description Property on page 465 To specify a description for the instrument.
Background Properties on page 433 To configure the background properties of the current instrument.
Border Properties on page 437 To configure the border settings of an instrument.
Captions/Operating Elements Properties on To add and remove captions and configure the properties of operating
page 443 elements.
Name Property on page 503 To specify the name of the selected instrument.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
States Properties on page 540 To add and remove states and configure their settings.
Tooltip Property on page 560 To specify a tooltip for the instrument.
MultiState Display Properties on page 498 To specify the MultiState Display-specific settings.
Use Custom Colors Property on page 561 To enable or disable custom color settings for the instrument.
Use Custom Fonts Property on page 562 To enable or disable global font settings for the instrument.
Variables Properties on page 562 To display and configure the variables that are connected to the instrument.

Related commands The MultiState Display provides the following commands:

Command Purpose
Bitmask on page 595 To specify the bitmask for the currently selected variable.
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Connect as Main Variable / Connect Variable(s) on To connect the selected variable to the instrument as the main variable.
page 619
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Copy Value (Instruments) on page 629 To copy the value that is displayed in the instrument.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Dec (Source) on page 638 To display a value in dec (source) mode.
Delete (Instrument) on page 639 To delete the selected instruments.
Instrument Properties on page 666 To view and edit the properties of an instrument.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Physical (Converted) on page 689 To display a value in the instrument in physical (converted) mode.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.

353
May 2024 ControlDesk Instrument Handling
Reference Information

Command Purpose
Show Current/Reference on page 710 To specify whether to display the current value or the reference value in the
current instrument.
States (refer to States Properties on page 540) To add and remove states and configure their settings.
Variable(s) - Add on page 730 To connect a variable to an instrument.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.
Copy / Variables - Copy on page 626 To copy the selected variables to the Clipboard.
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.
Variables - Delete on page 734 To delete the selected variables.
Variables - Paste/Paste Variables on page 735 To paste variables from the Clipboard to an instrument.
Variable(s) - Select in Variables/Mappings Pane on To select and highlight variables in the Variables pane, or framework labels in
page 731 the Mappings pane.
Variable(s) Properties on page 732 To show the Properties dialog of a connected variable.

Multiswitch

Illustration Edit mode disabled Edit mode enabled

Toolbox

Raster

State picture Sensitive area

Purpose To change variable values by clicking sensitive areas in the instrument and to
visualize different states, depending on the current value of the connected
variable.

Description The Multiswitch can be used to create complex instruments with areas that are
sensitive to mouse operations and background pictures that visualize different
states, depending on the value of the connected variable.

You can configure the instrument's properties via the Properties pane.

354
ControlDesk Instrument Handling May 2024
Instrument Descriptions

State picture You can use different background pictures (state pictures)
to visualize different states in the value range of the connected variable. For
example, the pictures can show different switch positions.

Sensitive area Sensitive areas react to mouse operations. You can define
sensitive areas for each state in the value range of the connected variable.
Predefined values are written to the connected variable if a sensitive area is
clicked or if it is released. Sensitive areas can therefore be configured like Push
buttons, On/Off buttons, or Check buttons, or they can be used to increase or
decrease the variable value.

Edit mode In the edit mode, the sensitive area(s) that are connected to a
state are visible and can be edited.

Raster Squares or segments of a circle can be used as rasters for defining of


sensitive areas. As an alternative, you can draw shapes with the mouse.

Toolbox Via the toolbox, you can easily change raster settings such as the
current raster type and the number of raster cells. You can also remove the
currently selected sensitive raster area.

Caption You can define caption elements, for example, the name and the
unit of the connected variable, and place them at various positions in the
instrument.

Colors and fonts settings You can specify whether to use the global
ControlDesk colors and fonts settings for the selected instrument or configure
your own settings.

Instrument properties The Multiswitch provides the following properties:

Property Purpose
Active Property on page 415 To activate or deactivate the instrument.
Background Properties on page 433 To configure the background properties of the current instrument.
Border Properties on page 437 To configure the border settings of an instrument.
Captions/Operating Elements Properties on To add and remove captions and configure the properties of operating
page 443 elements.
Description Property on page 465 To specify a description for the instrument.
Multiswitch Properties on page 500 To specify the Multiswitch-specific settings.
Name Property on page 503 To specify the name of the selected instrument.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
Tooltip Property on page 560 To specify a tooltip for the instrument.
Use Custom Colors Property on page 561 To enable or disable custom color settings for the instrument.
Use Custom Fonts Property on page 562 To enable or disable global font settings for the instrument.
Variables Properties on page 562 To display and configure the variables that are connected to the instrument.

355
May 2024 ControlDesk Instrument Handling
Reference Information

Related commands The Multiswitch provides the following commands:

Command Purpose
Bitmask on page 595 To specify the bitmask for the currently selected variable.
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Connect as Main Variable / Connect Variable(s) on To connect the selected variable to the instrument as the main variable.
page 619
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Copy Value (Instruments) on page 629 To copy the value that is displayed in the instrument.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Dec (Source) on page 638 To display a value in dec (source) mode.
Delete (Instrument) on page 639 To delete the selected instruments.
Instrument Properties on page 666 To view and edit the properties of an instrument.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Physical (Converted) on page 689 To display a value in the instrument in physical (converted) mode.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Show Current/Reference on page 710 To specify whether to display the current value or the reference value in the
current instrument.
Variable(s) - Add on page 730 To connect a variable to an instrument.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.
Copy / Variables - Copy on page 626 To copy the selected variables to the Clipboard.
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.
Variables - Delete on page 734 To delete the selected variables.
Variables - Paste/Paste Variables on page 735 To paste variables from the Clipboard to an instrument.
Variable(s) - Select in Variables/Mappings Pane on To select and highlight variables in the Variables pane, or framework labels in
page 731 the Mappings pane.
Variable(s) Properties on page 732 To show the Properties dialog of a connected variable.

Related topics Basics

Basics of Handling the Multiswitch......................................................................................... 148

356
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Numeric Input

Illustration
Caption

Spin button

Edit field

Purpose To display and set the value of the connected variable numerically.

Description The Numeric Input can be used as a single instrument for calibrating one scalar
parameter numerically. You can calibrate the parameter directly in the edit field
or by using the spin button. You can configure properties of the instrument via
the Properties pane.

Caption You can define caption elements, for example, the name and the
unit of the connected variable, and place them at various positions in the
instrument.

Instrument properties The Numeric Input provides the following properties:

Property Purpose
Active Property on page 415 To activate or deactivate the instrument.
Background Properties on page 433 To configure the background properties of the current instrument.
Border Properties on page 437 To configure the border settings of an instrument.
Captions/Operating Elements Properties on To add and remove captions and configure the properties of operating
page 443 elements.
Current Display Format Property on page 458 To open a dialog to specify the display format for the connected variable.
Description Property on page 465 To specify a description for the instrument.
Name Property on page 503 To specify the name of the selected instrument.
Range Check Properties on page 516 To configure a range check for the value.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.
Numeric Input Properties on page 505 To display and set the value of the connected variable numerically.
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Text Properties (Numeric Input) on page 555 To specify the text properties of the Numeric Input.
Tooltip Property on page 560 To specify a tooltip for the instrument.
Use Custom Colors Property on page 561 To enable or disable custom color settings for the instrument.
Use Custom Fonts Property on page 562 To enable or disable global font settings for the instrument.
Variables Properties on page 562 To display and configure the variables that are connected to the instrument.

357
May 2024 ControlDesk Instrument Handling
Reference Information

Related commands The Numeric Input provides the following commands:

Command Purpose
Adjust Value(s) on page 586 To enter a value as the operand to change the parameter value.
Bin (Source) on page 594 To display a value in bin (source) mode.
Bitmask on page 595 To specify the bitmask for the currently selected variable.
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Connect as Additional Write Variable(s) on To connect the selected variable to the instrument for calibration as an
page 618 additional write variable.
Connect as Main Variable / Connect Variable(s) on To connect the selected variable to the instrument as the main variable.
page 619
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Copy Value (Instruments) on page 629 To copy the value that is displayed in the instrument.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Dec (Source) on page 638 To display a value in dec (source) mode.
Delete (Instrument) on page 639 To delete the selected instruments.
Display Formats on page 647 To specify the display format for the selected variable.
Hex (Source) on page 657 To display a value in hex (source) mode.
Increments on page 662 To specify the increments for the selected variable.
Instrument Properties on page 666 To view and edit the properties of an instrument.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Physical (Converted) on page 689 To display a value in the instrument in physical (converted) mode.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Show Current/Reference on page 710 To specify whether to display the current value or the reference value in the
current instrument.
Variable(s) - Add on page 730 To connect a variable to an instrument.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.
Copy / Variables - Copy on page 626 To copy the selected variables to the Clipboard.
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.
Variables - Delete on page 734 To delete the selected variables.
Variables - Paste/Paste Variables on page 735 To paste variables from the Clipboard to an instrument.
Variable(s) - Select in Variables/Mappings Pane on To select and highlight variables in the Variables pane, or framework labels in
page 731 the Mappings pane.
Variable(s) Properties on page 732 To show the Properties dialog of a connected variable.

358
ControlDesk Instrument Handling May 2024
Instrument Descriptions

On/Off Button

Illustration
Caption

On/Off buttons

Purpose To set the value of the connected parameter to a predefined value when you
press the button (On value) and when you release the button (Off value).

Description The On/Off Button can be used to set one parameter to a predefined value when
you press the corresponding On/Off button (On value) and when you release it
(Off value).

Note

When you assign a variable with a computation table to this instrument,


one of the table entries must be specified as the Off value. For each of the
table entries, ControlDesk automatically creates an On/Off button.

You can configure properties of the instrument via the Properties pane.

Caption You can define caption elements, for example, the name and the
unit of the connected variable, and place them at various positions in the
instrument.

Operating element The operating element is an invisible frame, which


includes all buttons. You can position the operating element within the
instrument.

Colors and fonts settings You can specify whether to use the global
ControlDesk colors and fonts settings for the selected instrument or configure
your own settings.

Instrument properties The On/Off Button provides the following properties:

Property Purpose
Active Property on page 415 To activate or deactivate the instrument.
Background Properties on page 433 To configure the background properties of the current instrument.
Border Properties on page 437 To configure the border settings of an instrument.
Buttons Properties on page 441 To configure the buttons of the selected instrument.
Button Color Property on page 439 To specify the color of the selected button.
Button Style Property on page 440 To specify the appearance of the button.

359
May 2024 ControlDesk Instrument Handling
Reference Information

Property Purpose
Captions/Operating Elements Properties on To add and remove captions and configure the properties of operating
page 443 elements.
Description Property on page 465 To specify a description for the instrument.
Display Value Property on page 468 To specify whether the value of each button is displayed.
Name Property on page 503 To specify the name of the selected instrument.
Off-Value Property on page 505 To specify the Off value of the button.
Orientation Property on page 506 To specify the orientation of the buttons.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
Text Color Property on page 554 To specify the color of the selected item.
Text Font Property on page 555 To specify the font of the selected item.
Tooltip Property on page 560 To specify a tooltip for the instrument.
Use Custom Colors Property on page 561 To enable or disable custom color settings for the instrument.
Use Custom Fonts Property on page 562 To enable or disable global font settings for the instrument.
Variables Properties on page 562 To display and configure the variables that are connected to the instrument.

Related commands The On/Off Button provides the following commands:

Command Purpose
Adjust Value(s) on page 586 To enter a value as the operand to change the parameter value.
Bitmask on page 595 To specify the bitmask for the currently selected variable.
Buttons (refer to Buttons Properties on page 441) To configure the buttons of the selected instrument.
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Connect as Additional Write Variable(s) on To connect the selected variable to the instrument for calibration as an
page 618 additional write variable.
Connect as Main Variable / Connect Variable(s) on To connect the selected variable to the instrument as the main variable.
page 619
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Copy Value (Instruments) on page 629 To copy the value that is displayed in the instrument.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Dec (Source) on page 638 To display a value in dec (source) mode.
Delete (Instrument) on page 639 To delete the selected instruments.
Instrument Properties on page 666 To view and edit the properties of an instrument.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Physical (Converted) on page 689 To display a value in the instrument in physical (converted) mode.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Show Current/Reference on page 710 To specify whether to display the current value or the reference value in the
current instrument.
Variable(s) - Add on page 730 To connect a variable to an instrument.

360
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Command Purpose
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.
Copy / Variables - Copy on page 626 To copy the selected variables to the Clipboard.
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.
Variables - Delete on page 734 To delete the selected variables.
Variables - Paste/Paste Variables on page 735 To paste variables from the Clipboard to an instrument.
Variable(s) - Select in Variables/Mappings Pane on To select and highlight variables in the Variables pane, or framework labels in
page 731 the Mappings pane.
Variable(s) Properties on page 732 To show the Properties dialog of a connected variable.

Related topics Basics

Basics of Handling the On/Off Button..................................................................................... 156

Push Button

Illustration
Caption

Push buttons

Purpose To set the value of the connected parameter by push buttons.

Description The Push Button can be used to set one scalar parameter to a predefined value.
When you press one of the buttons, the corresponding predefined numerical
value is written to the parameter.

Note

When you assign a variable with a computation table to this instrument,


ControlDesk automatically creates one button for each table entry.

You can configure properties of the instrument via the Properties pane.

Caption You can define caption elements, for example, the name and the
unit of the connected variable, and place them at various positions in the
instrument.

361
May 2024 ControlDesk Instrument Handling
Reference Information

Operating element The operating element is an invisible frame, which


includes all buttons. You can position the operating element within the
instrument.

Colors and fonts settings You can specify whether to use the global
ControlDesk colors and fonts settings for the selected instrument or configure
your own settings.

Instrument properties The Push Button provides the following properties:

Property Purpose
Active Property on page 415 To activate or deactivate the instrument.
Background Properties on page 433 To configure the background properties of the current instrument.
Border Properties on page 437 To configure the border settings of an instrument.
Buttons Properties on page 441 To configure the buttons of the selected instrument.
Button Color Property on page 439 To specify the color of the selected button.
Button Style Property on page 440 To specify the appearance of the button.
Captions/Operating Elements Properties on To add and remove captions and configure the properties of operating
page 443 elements.
Description Property on page 465 To specify a description for the instrument.
Display Value Property on page 468 To specify whether the value of each button is displayed.
Name Property on page 503 To specify the name of the selected instrument.
Orientation Property on page 506 To specify the orientation of the buttons.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
Text Color Property on page 554 To specify the color of the selected item.
Text Font Property on page 555 To specify the font of the selected item.
Tooltip Property on page 560 To specify a tooltip for the instrument.
Use Custom Colors Property on page 561 To enable or disable custom color settings for the instrument.
Use Custom Fonts Property on page 562 To enable or disable global font settings for the instrument.
Variables Properties on page 562 To display and configure the variables that are connected to the instrument.

Related commands The Push Button provides the following commands:

Command Purpose
Adjust Value(s) on page 586 To enter a value as the operand to change the parameter value.
Bitmask on page 595 To specify the bitmask for the currently selected variable.
Buttons (refer to Buttons Properties on page 441) To configure the buttons of the selected instrument.
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Connect as Additional Write Variable(s) on To connect the selected variable to the instrument for calibration as an
page 618 additional write variable.

362
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Command Purpose
Connect as Main Variable / Connect Variable(s) on To connect the selected variable to the instrument as the main variable.
page 619
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Copy Value (Instruments) on page 629 To copy the value that is displayed in the instrument.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Dec (Source) on page 638 To display a value in dec (source) mode.
Delete (Instrument) on page 639 To delete the selected instruments.
Instrument Properties on page 666 To view and edit the properties of an instrument.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Physical (Converted) on page 689 To display a value in the instrument in physical (converted) mode.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Show Current/Reference on page 710 To specify whether to display the current value or the reference value in the
current instrument.
Variable(s) - Add on page 730 To connect a variable to an instrument.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.
Copy / Variables - Copy on page 626 To copy the selected variables to the Clipboard.
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.
Variables - Delete on page 734 To delete the selected variables.
Variables - Paste/Paste Variables on page 735 To paste variables from the Clipboard to an instrument.
Variable(s) - Select in Variables/Mappings Pane on To select and highlight variables in the Variables pane, or framework labels in
page 731 the Mappings pane.
Variable(s) Properties on page 732 To show the Properties dialog of a connected variable.

Radio Button

Illustration
Caption

Button

Purpose To display and set the value of the connected parameter by radio buttons.

363
May 2024 ControlDesk Instrument Handling
Reference Information

Description The Radio Button can be used to set one parameter to a predefined value. When
you select one of the buttons, the corresponding predefined numerical value
is written to the parameter. The Radio Button can also be used to display the
current value of the connected variable. When the value of the variable read
from the platform/device matches one of the predefined numerical values, the
corresponding button is checked.

Note

When you assign a variable with a computation table to this instrument,


ControlDesk automatically creates one button for each table entry.

You can configure properties of the instrument via the Properties pane.

Caption You can define caption elements, for example, the name and the
unit of the connected variable, and place them at various positions in the
instrument.

Operating element The operating element is an invisible frame which


includes all buttons. You can position the operating element within the
instrument.

Colors and fonts settings You can specify whether to use the global
ControlDesk colors and fonts settings for the selected instrument or configure
your own settings.

Instrument properties The Radio Button provides the following properties:

Property Purpose
Active Property on page 415 To activate or deactivate the instrument.
Background Properties on page 433 To configure the background properties of the current instrument.
Border Properties on page 437 To configure the border settings of an instrument.
Buttons Properties on page 441 To configure the buttons of the selected instrument.
Captions/Operating Elements Properties on To add and remove captions and configure the properties of operating
page 443 elements.
Display Value Property on page 468 To specify whether the value of each button is displayed.
Description Property on page 465 To specify a description for the instrument.
Name Property on page 503 To specify the name of the selected instrument.
Orientation Property on page 506 To specify the orientation of the buttons.
Radio Button Style Property on page 515 To specify the appearance of the buttons.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
Text Color Property on page 554 To specify the color of the selected item.
Text Font Property on page 555 To specify the font of the selected item.
Tooltip Property on page 560 To specify a tooltip for the instrument.
Use Custom Colors Property on page 561 To enable or disable custom color settings for the instrument.

364
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Property Purpose
Use Custom Fonts Property on page 562 To enable or disable global font settings for the instrument.
Variables Properties on page 562 To display and configure the variables that are connected to the instrument.

Related commands The Radio Button provides the following commands:

Command Purpose
Adjust Value(s) on page 586 To enter a value as the operand to change the parameter value.
Bitmask on page 595 To specify the bitmask for the currently selected variable.
Buttons (refer to Buttons Properties on page 441) To configure the buttons of the selected instrument.
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Connect as Additional Write Variable(s) on To connect the selected variable to the instrument for calibration as an
page 618 additional write variable.
Connect as Main Variable / Connect Variable(s) on To connect the selected variable to the instrument as the main variable.
page 619
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Copy Value (Instruments) on page 629 To copy the value that is displayed in the instrument.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Dec (Source) on page 638 To display a value in dec (source) mode.
Delete (Instrument) on page 639 To delete the selected instruments.
Instrument Properties on page 666 To view and edit the properties of an instrument.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Physical (Converted) on page 689 To display a value in the instrument in physical (converted) mode.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Show Current/Reference on page 710 To specify whether to display the current value or the reference value in the
current instrument.
Variable(s) - Add on page 730 To connect a variable to an instrument.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.
Copy / Variables - Copy on page 626 To copy the selected variables to the Clipboard.
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.
Variables - Delete on page 734 To delete the selected variables.
Variables - Paste/Paste Variables on page 735 To paste variables from the Clipboard to an instrument.
Variable(s) - Select in Variables/Mappings Pane on To select and highlight variables in the Variables pane, or framework labels in
page 731 the Mappings pane.
Variable(s) Properties on page 732 To show the Properties dialog of a connected variable.

365
May 2024 ControlDesk Instrument Handling
Reference Information

Selection Box

Illustration
Caption

List

Purpose To select a text-value entry and set the respective numerical value for the
connected variable.

Description The Selection Box can be used to set one parameter to a predefined value. Each
selection box item is associated with one text-value entry and a predefined value.
When you select one of the selection box items, the text entry is displayed and
the corresponding predefined value is written to the parameter. You can specify
the text (Off text) to be displayed when the parameter value does not match any
of the predefined values.

Note

When you assign a variable with a computation table to this instrument,


ControlDesk automatically creates one selection box item for each table
entry.

You can configure properties of the instrument via the Properties pane.

Caption You can define caption elements, for example, the name and the
unit of the connected variable, and place them at various positions in the
instrument.

Operating element The operating element is an invisible frame, which


includes the list. You can position the operating element within the instrument.

Colors and fonts settings You can specify whether to use the global
ControlDesk colors and fonts settings for the selected instrument or configure
your own settings.

Instrument properties The Selection Box provides the following properties:

Property Purpose
Active Property on page 415 To activate or deactivate the instrument.
Background Properties on page 433 To configure the background properties of the current instrument.
Border Properties on page 437 To configure the border settings of an instrument.
Captions/Operating Elements Properties on To add and remove captions and configure the properties of operating
page 443 elements.
Description Property on page 465 To specify a description for the instrument.
Name Property on page 503 To specify the name of the selected instrument.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.

366
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Property Purpose
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
Selection Box Properties on page 532 To specify the Selection Box-specific settings.
Tooltip Property on page 560 To specify a tooltip for the instrument.
Use Custom Colors Property on page 561 To enable or disable custom color settings for the instrument.
Use Custom Fonts Property on page 562 To enable or disable global font settings for the instrument.
Variables Properties on page 562 To display and configure the variables that are connected to the instrument.

Related commands The Selection Box provides the following commands:

Command Purpose
Bitmask on page 595 To specify the bitmask for the currently selected variable.
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Compu Tab Items Sorted on page 616 To sort the string list of a value with verbal conversion (CompuVTab,
CompuVTabRange) alphabetically.
Connect as Additional Write Variable(s) on To connect the selected variable to the instrument for calibration as an
page 618 additional write variable.
Connect as Main Variable / Connect Variable(s) on To connect the selected variable to the instrument as the main variable.
page 619
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Copy Value (Instruments) on page 629 To copy the value that is displayed in the instrument.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Dec (Source) on page 638 To display a value in dec (source) mode.
Delete (Instrument) on page 639 To delete the selected instruments.
Instrument Properties on page 666 To view and edit the properties of an instrument.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Show Current/Reference on page 710 To specify whether to display the current value or the reference value in the
current instrument.
Sort Items on page 720 To sort the list displayed in the selection box.
States (refer to States Properties on page 540) To add and remove states and configure their settings.
Toggle Bits on page 723 To toggle selected bits of the connected variable.
Variable(s) - Add on page 730 To connect a variable to an instrument.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.
Copy / Variables - Copy on page 626 To copy the selected variables to the Clipboard.
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.
Variables - Delete on page 734 To delete the selected variables.
Variables - Paste/Paste Variables on page 735 To paste variables from the Clipboard to an instrument.

367
May 2024 ControlDesk Instrument Handling
Reference Information

Command Purpose
Variable(s) - Select in Variables/Mappings Pane on To select and highlight variables in the Variables pane, or framework labels in
page 731 the Mappings pane.
Variable(s) Properties on page 732 To show the Properties dialog of a connected variable.

Related topics References

States Properties..................................................................................................................... 540

Slider

Illustration Scale Tic Caption

Label

Slidebar Indicator Slide Band

Purpose To display and set the value of the connected variable by means of a slide on a
horizontal or vertical scale.

Description The Slider can be used as a single instrument for calibrating one scalar
parameter. You can configure properties of the instrument via the Properties
pane.

Tip

Another way to calibrate a parameter by means of a slide is to select the


Slider value cell type in a Variable Array. For details, refer to Variable Array
on page 389.

Caption You can define caption elements, for example, the name and the
unit of the connected variable, and place them at various positions in the
instrument.

368
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Scale area Displays the scale of the instrument. The scale area consists of the
following parts, which can be configured individually:

Scale Parts Description


Bands The bands define colored areas within the scale's value range. A
band has a start position (minimum value) and an end position
(maximum value).
Indicators The indicators mark the minimum or maximum value of the
calibration.
Labels The labels of the tics display the numerical values of the scale.
Tics The tics display the divisions of the scale. There are major tics and
minor tics.

By default, the scale is adjusted to the weak limits of the connected variable. You
can edit the range via the properties.
MajorTics MinorTics
Delta

Slider area Displays the value of the connected variable via a slider.
The Slide can be moved by mouse or Arrow Up/Down keys.
§ Arrow Up key increases the value (small increments).
§ Arrow Down key decreases the value (small increments).

Tip

If the Ctrl key is pressed simultaneously, the value is increased/decreased in


larger steps (big increments). The value can be set to the scale’s start value
by pressing the Home key and to the scale’s stop value by pressing the End
key.

You can specify the size and position, color, shape and style of the Slider, for
example.

Operating Element The operating element is an invisible frame, in which the


slider element (scale area and slider area) can be positioned. You can configure
the position of the bar element within the operating element via horizontal and
vertical position settings.

Views When you select an instrument, it is automatically highlighted. There


are also other views, as shown by the examples in the following table.

View Description
No-value view The instrument is not receiving valid values. For measurement
variables, you will find this view, for example, if you have
not started a measurement after loading an experiment. For
parameters, you will find this view, for example, if you added
a variable description without an initial data set but did not
upload values from the ECU.

369
May 2024 ControlDesk Instrument Handling
Reference Information

View Description
Read-only view The connected variable is read-only and cannot be calibrated.

Automatic sizing ControlDesk provides the Automatic Sizing property to


adjust the scale of the instrument automatically, for example, when you change
the Min/Max values, resize the instrument, or resize the operating element. If the
instrument becomes too small or the value range becomes too large, the number
of tics and labels is reduced automatically or completely hidden.

Colors and fonts settings You can specify whether to use the global
ControlDesk colors and fonts settings for the selected instrument or configure
your own settings.

Instrument properties The Slider provides the following properties:

Property Purpose
Active Property on page 415 To activate or deactivate the instrument.
Automatic Sizing Property (Bar, Gauge, Knob, To enable or disable the automatic sizing function.
Slider) on page 421
Background Properties on page 433 To configure the background properties of the current instrument.
Bands Properties on page 433 To specify the properties of colored bands for the highlighting of value
ranges.
Border Properties on page 437 To configure the border settings of an instrument.
Captions/Operating Elements Properties on To add and remove captions and configure the properties of operating
page 443 elements.
Description Property on page 465 To specify a description for the instrument.
Display Formats Properties on page 465 To configure the display format for the display area.
Increments Properties on page 479 To configure the increments for the selected variable.
Name Property on page 503 To specify the name of the selected instrument.
Overflow Warning Property on page 508 To enable or disable the overflow warning function.
Range Check Properties on page 516 To configure a range check for the value.
Scale Properties on page 522 To configure the scale properties of the selected instrument.
Range Properties on page 517 To configure the scale range properties of the selected instrument.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
Slide Properties on page 535 To configure the properties of the slide of the Slider.
Slidebar Properties on page 535 To configure the properties of the slidebar.
Tooltip Property on page 560 To specify a tooltip for the instrument.
Use Custom Colors Property on page 561 To enable or disable custom color settings for the instrument.
Use Custom Fonts Property on page 562 To enable or disable global font settings for the instrument.
Variables Properties on page 562 To display and configure the variables that are connected to the instrument.

370
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Related commands The Slider provides the following commands:

Command Purpose
Adjust Value(s) on page 586 To enter a value as the operand to change the parameter value.
Assign Reference Value(s) on page 591 To set the values in the selected cells to the corresponding values of the
reference data set (reference values).
Bitmask on page 595 To specify the bitmask for the currently selected variable.
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Connect as Additional Write Variable(s) on To connect the selected variable to the instrument for calibration as an
page 618 additional write variable.
Connect as Main Variable / Connect Variable(s) on To connect the selected variable to the instrument as the main variable.
page 619
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Copy Value (Instruments) on page 629 To copy the value that is displayed in the instrument.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Dec (Source) on page 638 To display a value in dec (source) mode.
Delete (Instrument) on page 639 To delete the selected instruments.
Display Formats on page 647 To specify the display format for the selected variable.
Increments on page 662 To specify the increments for the selected variable.
Indicators - Reset Max on page 663 To reset the maximum indicator to the current value of the instrument.
Indicators - Reset Min on page 664 To reset the minimum indicator to the current value of the instrument.
Instrument Properties on page 666 To view and edit the properties of an instrument.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Physical (Converted) on page 689 To display a value in the instrument in physical (converted) mode.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Show Current/Reference on page 710 To specify whether to display the current value or the reference value in the
current instrument.
Variable(s) - Add on page 730 To connect a variable to an instrument.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.
Copy / Variables - Copy on page 626 To copy the selected variables to the Clipboard.
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.
Variables - Delete on page 734 To delete the selected variables.
Variables - Paste/Paste Variables on page 735 To paste variables from the Clipboard to an instrument.
Variable(s) - Select in Variables/Mappings Pane on To select and highlight variables in the Variables pane, or framework labels in
page 731 the Mappings pane.
Variable(s) Properties on page 732 To show the Properties dialog of a connected variable.

Related topics HowTos

How to Change Values with the Slider.................................................................................... 165


How to Configure the Slider................................................................................................... 164

371
May 2024 ControlDesk Instrument Handling
Reference Information

Sound Controller

Illustration

Purpose To play simple sounds or complex sounds in relation to specific variable values.

Description The Sound Controller can be used to play simple sounds or complex sounds in
relation to specific variable values.

Simple sound You can add one or more simple sounds to the Sound
Controller. Each simple sound can play a number of audio streams stored in
MP3 or WAV files. The sound output can be started/stopped via a button in
the instrument or via start/stop conditions in the instrument properties. You can
change the volume of simple sounds.

Complex sound You can add one or more complex sounds to the Sound
Controller. Each complex sound consists of one or more audio groups. Each
audio group can play a number of audio streams stored in MP3 or WAV files.
Each audio stream is assigned to a frequency value and each audio group is
assigned to a quality value. By changing the frequency and quality value of the
complex sound, you can specify the audio streams of an audio group and the
audio groups to be played together.
The sound output can be started/stopped via a button in the instrument or via
start/stop conditions in the instrument properties. You can change the volume,
the frequency value, and the quality value of the complex sound via sliders or via
the instrument properties.

Instrument properties The Sound Controller provides the following properties:

Property Purpose
Active Property on page 415 To activate or deactivate the instrument.
Background Properties on page 433 To configure the background properties of the current instrument.
Border Properties on page 437 To configure the border settings of an instrument.
Description Property on page 465 To specify a description for the instrument.
Name Property on page 503 To specify the name of the selected instrument.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
Sound Controller Properties on page 537 To specify the Sound Controller-specific properties.

372
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Property Purpose
Tooltip Property on page 560 To specify a tooltip for the instrument.
Use Custom Colors Property on page 561 To enable or disable custom color settings for the instrument.
Use Custom Fonts Property on page 562 To enable or disable global font settings for the instrument.

Related commands The Sound Controller provides the following commands:

Command Purpose
Configure (refer to Sound Controller Properties on To specify the Sound Controller-specific properties.
page 537)
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Delete (Instrument) on page 639 To delete the selected instruments.
Instrument Properties on page 666 To view and edit the properties of an instrument.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.
Variables - Delete on page 734 To delete the selected variables.
Variables - Paste/Paste Variables on page 735 To paste variables from the Clipboard to an instrument.
Variable(s) - Select in Variables/Mappings Pane on To select and highlight variables in the Variables pane, or framework labels in
page 731 the Mappings pane.

Related topics Basics

Basics on Handling the Sound Controller................................................................................ 167

HowTos

How to Configure the Sound Controller................................................................................. 168


How to Generate a Complex Sound with the Sound Controller.............................................. 170

References

Automotive Controls Library................................................................................................... 267

373
May 2024 ControlDesk Instrument Handling
Reference Information

Static Text

Illustration
Text label

Purpose To display explanations or inscriptions on the layout.

Description The Static Text instrument can be used to add descriptive text to a layout. You
cannot connect variables to the instrument. You can configure its properties,
such as the angle of the displayed text, via the Properties pane.

You can enable the Quick Input Enable property to enter text in the instrument
directly. To enter multi-line text, press Ctrl+Enter at the end of a line or enable
the word‑wrapping option. This wraps the text automatically if it does not fit into
one line.

Instrument properties The Static Text provides the following properties:

Property Purpose
Active Property on page 415 To activate or deactivate the instrument.
Background Properties on page 433 To configure the background properties of the current instrument.
Border Properties on page 437 To configure the border settings of an instrument.
Description Property on page 465 To specify a description for the instrument.
Name Property on page 503 To specify the name of the selected instrument.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
Static Text Properties on page 543 To configure the Static Text-specific settings.
Tooltip Property on page 560 To specify a tooltip for the instrument.
Use Custom Colors Property on page 561 To enable or disable custom color settings for the instrument.
Use Custom Fonts Property on page 562 To enable or disable global font settings for the instrument.

374
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Related commands The Static Text provides the following commands:

Command Purpose
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Delete (Instrument) on page 639 To delete the selected instruments.
Instrument Properties on page 666 To view and edit the properties of an instrument.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.

Steering Controller

Illustration

Title bar

Tab Force-feedback effects

X-axis full range

X-axis negative split X-axis positive split

Buttons

Point-of-view switch

Purpose To change variable values using a game controller device such as a joystick or a
steering wheel.

375
May 2024 ControlDesk Instrument Handling
Reference Information

Description The Steering Controller is the graphical representation of a connected game


controller device.

Supported game controller devices The Steering Controller supports any


game controller device that is connected to a USB port of the host PC, and that
is supported by the Microsoft DirectInput API.
You can connect more than one game controller device to the same instrument.
There is one instrument tab for each device.

Instrument features The Steering Controller has the following functions:


§ It displays all the axes, buttons, and point of view switches available on the
game controller device.
§ It displays the positions of the axes and the states of the buttons and point of
view switches.
§ It can write numeric values to the variables connected to the axes, buttons,
and point of view switches of the game controller device.
§ If the game controller device supports force feedback features, you can add
effect elements and configure constant, periodic, and condition effects.

Connecting instrument axes You can connect variables to each axis of the Steering Controller in three
different forms: full range, positive split, and negative split.

Full range The whole range of the Steering Controller’s axis is evaluated to
set the value.

Positive split Only the positive split of the axis is evaluated to set the value.
The positive split is normally defined as follows:
§ Right turn of the wheel
§ Pedal unit’s brake pedal
§ Joystick right
§ Joystick backward

Negative split Only the negative split of the axis is evaluated to set the value.
The negative split is normally defined as follows:
§ Left turn of the wheel
§ Pedal unit’s gas pedal
§ Joystick left
§ Joystick forward
If you want to connect a variable to a particular axis in a particular form, you
have to drag it to the appropriate slider.

376
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Connecting instrument You can connect variables to each button of the Steering Controller using the
buttons button as an On/Off button, Push button, or Increment button:

Connection Mode Description


Push Button The button writes a value to the connected variable when pressed.
On/Off Button If you press the button, the instrument writes the on-value to the
connected variable. If you release the button, the instrument writes the
off-value to the connected variable.
Increment Button The instrument increments the variable value each time the button is
pressed, up to the specified maximum value.

Connecting point of view You can connect a variable to a point of view switch and specify a value to be
switches written to the variable when the switch is turned to a particular position. The
switch position reacts as an On/Off button or Push button depending on the
Write center value property:

Write Mode Description


On/Off Button If Write center value is enabled, the point of view switch positions
react as On/Off buttons, with the center position as the off position.
Push Button If Write center value is disabled, the point of view switch positions
react as Push buttons and the center position is ignored.

Instrument properties You can configure properties of the instrument via the Properties pane.

The Steering Controller provides the following properties:

Property Purpose
Active Property on page 415 To activate or deactivate the instrument.
Background Properties on page 433 To configure the background properties of the current instrument.
Border Properties on page 437 To configure the border settings of an instrument.
Captions/Operating Elements Properties on To add and remove captions and configure the properties of operating
page 443 elements.
Description Property on page 465 To specify a description for the instrument.
Name Property on page 503 To specify the name of the selected instrument.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
Steering Controller Properties on page 543 To specify the Steering Controller-specific properties.
Tooltip Property on page 560 To specify a tooltip for the instrument.
Use Custom Colors Property on page 561 To enable or disable custom color settings for the instrument.
Use Custom Fonts Property on page 562 To enable or disable global font settings for the instrument.
Variables Properties on page 562 To display and configure the variables that are connected to the instrument.

377
May 2024 ControlDesk Instrument Handling
Reference Information

Related commands The Steering Controller provides the following commands:

Command Purpose
Adjust Value(s) on page 586 To enter a value as the operand to change the parameter value.
Assign Recent Value on page 591 To display the most recent scalar values of a variable and to reset the variable
to one of them.
Assign Reference Value(s) on page 591 To set the values in the selected cells to the corresponding values of the
reference data set (reference values).
Bitmask on page 595 To specify the bitmask for the currently selected variable.
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Connect as Main Variable / Connect Variable(s) on To connect the selected variable to the instrument as the main variable.
page 619
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Dec (Source) on page 638 To display a value in dec (source) mode.
Delete Disconnected Tabs on page 643 To delete all tabbed pages without a connected controller device from a
Steering Controller.
Delete (Instrument) on page 639 To delete the selected instruments.
Display Formats on page 647 To specify the display format for the selected variable.
Instrument Properties on page 666 To view and edit the properties of an instrument.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Physical (Converted) on page 689 To display a value in the instrument in physical (converted) mode.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Show Current/Reference on page 710 To specify whether to display the current value or the reference value in the
current instrument.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.
Copy / Variables - Copy on page 626 To copy the selected variables to the Clipboard.
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.
Variables - Delete on page 734 To delete the selected variables.
Variables - Paste/Paste Variables on page 735 To paste variables from the Clipboard to an instrument.
Variable(s) - Select in Variables/Mappings Pane on To select and highlight variables in the Variables pane, or framework labels in
page 731 the Mappings pane.
Variable(s) Properties on page 732 To show the Properties dialog of a connected variable.

Related topics Basics

Basics of Handling the Steering Controller.............................................................................. 175

378
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Table Editor

Illustration 3-D view Working point

Tab

2-D view

Axis points

Grid view

Function value Data axis X-axis Edit point Y-axis

Purpose To display and edit the values of variables with data types that can be
represented in tabular form, such as maps and curves . The Table Editor can
be connected with one or more variables.

Description The Table Editor has the following functions:


§ It can read/write table data from/to a parameter.
§ It can display the values of a measurement array.
§ The table dimension is one-, two-, or n-dimensional, depending on the
connected variables.
§ The Table Editor can display the table data in a 2-D or 3-D view.
§ The current table data can be changed. All changes to a value in one view are
made simultaneously in the other views.
§ If common axes are used, you get a warning if you try to change their values.

Terms The following table shows the different terms that are used.

Term Description
Input values Original (measured) values of the input quantities x and y. In case of n‑D look‑up tables, z
values are measured for each additional dimension.
Axis points Values in the first row and first column of the table.
Data points XY coordinates which define the point of intersection.
Function value The value at a data point.
Working point The working point represents the resulting input value of all current input values of a look-up
table combined. To get the input values for a working point, you must connect variables as

379
May 2024 ControlDesk Instrument Handling
Reference Information

Term Description
input quantities to all axes of the Table Editor. Depending on the dimensions of the look-up
table, you must connect one, two, or more input quantities.
The working point is marked by a green dot in the 2-D and 3-D views and by a green table
cell frame in the grid view (up to 4 cells when interpolation is needed). If the working point is
outside of the visible area, the table cell 0/0 is colored red.
For special use cases, you can create multiple working points for one look-up table by
connecting measurement arrays or value blocks as input quantities. This allows you to use
different array elements as input values and change the working points in your measurements
or recordings, for example. Refer to Working Points Properties (Multiple Working Points) on
page 569.
Edit point The edit point represents the currently selected data point (table cell). It is marked by a red dot
in the 2-D and 3-D views and by a gray background in the grid view. In the 2-D and 3-D view,
it can be moved via the mouse. Multiple selection is possible.
Output value The value that is taken for the output. Corresponds to the function value if the input values
are exactly on the axis points. In this case the working point lies exactly on one data point.
Otherwise, it is an interpolation between the function values of the data points that enclose
the working point.

Symbols and colors of the Table Editor Symbols next to the value and
colors give information on the current state of the parameter.

Symbol / Colors Description

Proposed calibration
Proposed calibration is active, value has been changed.

Proposed calibration is active, value has not been changed.

Tendency colors (not available for platforms)


Color: green The working page is active and the value of the variable
in the working data set is higher than the value in the
reference data set.
Color: black The working page is active and the value of the variable in
the working data set is equal to the value in the reference
data set.
Color: red The working page is active and the value of the variable in
the working data set is lower than the value in the reference
data set.

By default, the edit point is marked by a gray background. The working point is
marked by a green table cell frame.

Views of the Table Editor The Table Editor provides the following views:

2-D view Displays the values in the table as a 2-dimensional chart. By default,
the edit point is displayed as a red dot and the working point as a green dot.
The 2-D view is not available for variables that use conversion tables (with the
exception of verbal conversion tables).
If the data can be displayed in a 3-D view, the 2-D view displays a projection of
it. You can configure the number of panes that are shown.

380
ControlDesk Instrument Handling May 2024
Instrument Descriptions

3-D view Displays the values in the table as a 3-dimensional chart. By default,
the edit point is displayed as a red dot and the working point as a green dot.
The 3-D view is only available if variables are connected that can be displayed
in a 3-dimensional chart. The 3-D view is not available for variables that use
conversion tables (with the exception of verbal conversion tables).

Grid view/numerical view Displays a table with the values of the connected
variables. The axis points (x-axis for a curve, x- and y-axis for a map) are shown in
the first row and the first column of the table. The assigned function values are
shown at the intersections between rows and columns (data points).

Computation methods and The following table shows the available conversion methods for x- and y-axis
conversion modes points and for function values, depending on the computation method.

Computation Method Source Mode Converted Mode


Computation formula ✓ ✓
Tabular conversion with interpolation ✓ ✓
Tabular conversion without interpolation ✓ ✓
Verbal conversion ✓ ✓
Verbal conversion range ✓ ✓

The following example shows the x- and y-axes of a Table Editor in source and in
converted mode:
§ Values in source mode:

381
May 2024 ControlDesk Instrument Handling
Reference Information

§ Values in converted mode:

Instrument properties The Table Editor provides the following properties:

Property Purpose
2-D View Properties on page 411 To configure the 2-D view properties of the Table Editor.
3-D View Properties on page 412 To configure the 3-D view properties of the Table Editor.
Active Property on page 415 To activate or deactivate the instrument.
Axes Properties (Table Editor) on page 429 To configure the properties of the axes in the Table Editor.
Border Properties on page 437 To configure the border settings of an instrument.
Description Property on page 465 To specify a description for the instrument.
Edit Points Properties on page 471 To specify the properties of the edit points in the Table Editor.
Grid View Properties on page 474 To configure the grid view properties of the Table Editor.
Name Property on page 503 To specify the name of the selected instrument.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
Tab Properties (Table Editor) on page 550 To configure the properties of the selected instrument tab.
Tabbed Pages Properties (Table Editor) on page 551 To configure the properties of the instrument tabs.
Tooltip Property on page 560 To specify a tooltip for the instrument.
Use Custom Colors Property on page 561 To enable or disable custom color settings for the instrument.
Working Point Properties on page 569 To configure the properties of the working point.
Working Points Properties (Multiple Working Opens a dialog for you to configure the properties of multiple working
Points) on page 569 points.

382
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Related commands The Table Editor provides the following commands:

Command Purpose
2-D View on page 582 To configure display options of the 2‑D view.
3-D View on page 584 To configure display options of the 3-D view.
Adjust Value(s) on page 586 To enter a value as the operand to change the parameter value.
Assign Reference Value(s) on page 591 To set the values in the selected cells to the corresponding values of the
reference data set (reference values).
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Copy Value(s) on page 630 To copy the selected cells to the Clipboard.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Delete (Instrument) on page 639 To delete the selected instruments.
Delete Active Tab on page 640 To delete the currently active tab in the Table Editor.
Delete Axis Point(s) on page 641 To delete the selected axis points.
Display Values on page 648 To select an option for displaying the values in the table cells of the Table
Editor's grid view.
Export Value(s) on page 653 To export the values of the variable that is currently displayed in the Table
Editor.
Grid View on page 656 To configure display options of the grid view.
Import Value(s) on page 661 To import table values.
Insert Axis Point(s) on page 664 To define new axis points on the x- or y-axis.
Instrument Properties on page 666 To view and edit the properties of an instrument.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Paste Value(s) on page 688 To insert copied values into the table.
Rescale Data Axis on page 696 To adjust the size of the 2-D view to the range of the data axis values.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Variable(s) - Add on page 730 To connect a variable to an instrument.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.
Configure Connection Assignment on page 617 To configure the connection assignment of the variable(s) in the selected
instrument(s).
Copy / Variables - Copy on page 626 To copy the selected variables to the Clipboard.
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.
Variables - Delete on page 734 To delete the selected variables.
Variables - Paste/Paste Variables on page 735 To paste variables from the Clipboard to an instrument.
Variable(s) Properties on page 732 To show the Properties dialog of a connected variable.

Related topics Basics

Basics of Handling the Table Editor......................................................................................... 188

383
May 2024 ControlDesk Instrument Handling
Reference Information

HowTos

How to Change Function Values in the Table Editor................................................................ 203


How to Configure the Table Editor.......................................................................................... 199
How to Export and Import Values........................................................................................... 214
How to Insert or Delete Axis Points......................................................................................... 209

Videos

2-D View (4:21) in dSPACE Help


3-D View (3:20) in dSPACE Help
Changing Axis Points and Exporting Table Data (4:20) in dSPACE Help
Changing Function Values (4:15) in dSPACE Help
Connecting Variables via Multiple Connection (3:11) in dSPACE Help
Connecting Variables via Single Connection (2:12) in dSPACE Help
Grid View and Tabbed Pages (4:00) in dSPACE Help
Overview of the Instrument (3:06) in dSPACE Help

Time Plotter

Illustration

Toolbar

Y-axis Data cursor info

Data cursor
Chart area

Cursor (move mode)

DAQ info
Signal symbol
Show legend

X-axis Legend

Purpose To display signals in relation to time (time plots).

Description Toolbar Via the toolbar, you can easily change frequently used DAQ and
cursor settings.

Y-axis The Time Plotter uses the y-axis as a signal axis. You can add several
variables to one y-axis and create more than one y-axis in the y-axis area.

384
ControlDesk Instrument Handling May 2024
Instrument Descriptions

X-axis The Time Plotter uses the x-axis as a time axis.

Chart area Displays signals referring to several y-axes. The signals can be
displayed in several styles and colors.

Cursor in Move or Zoom mode If you move the pointer to the chart area,
the displayed cursor depends on the navigation mode. You can change the
navigation mode via the chart's context menu.

Cursor Navigation Mode Description


Zoom mode You can specify the zoom area with the pointer.

Move mode You can move the chart in the x-axis and the
y-axis directions.

For details, refer to Zooming and Moving the Chart (Time Plotter) on page 224.

Data cursor and cursor info One or two cursors can be used to specify chart
positions. The positions of the cursors and the distance between them can be
displayed at the cursor info position.

Signal symbol The signal symbol shows the signal's color in the chart. You
can double-click it to show or hide the signal or right-click it to open the context
menu with various signal-related commands.
The signal symbol shows the status of the connection:

Symbol Description
No variable connected
Variable connected. Signal is displayed in the chart area.
The active signal has a white frame. In the chart, the active signal is
displayed in the foreground. Its properties are listed below selected
element in the properties list.
Variable connection invalid. Move the pointer over the symbol to
open a tooltip with information on the reasons.
Signal is disabled and not displayed in the chart area.

Plotter cursors Measured data can be analyzed using several cursors. The
positions of the cursors and the distance between them can be displayed in the
Plotter:

Time cursor The Time cursor allows you to navigate in a measurement by


moving the cursor within the plot area currently displayed.

Data cursors The data cursors allow you to analyze the x‑ and y‑axis values as
they were at two points in time during a measurement.

385
May 2024 ControlDesk Instrument Handling
Reference Information

DAQ info Information on the currently active data acquisition settings, such
as the selected DAQ mode, can be displayed.

Legend Lists all the variables that are connected to the Plotter and displays
information on them.

Differences between Time Plotter, Index Plotter, and XY


Plotter ControlDesk offers three plotters types with different main purposes.
Knowing the differences helps you to select the appropriate type.
For details, refer to Choosing Between Time Plotter, Index Plotter, and XY Plotter
on page 40.

Instrument properties The Time Plotter provides the following properties:

Property Purpose
Advanced Settings Properties (Time Plotter/Index To configure advanced settings.
Plotter) on page 416
Axes and Signals Properties (Time Plotter/Index To configure the properties of the selected axis or signal.
Plotter) on page 422
Background Properties on page 433 To configure the background properties of the current instrument.
Border Properties on page 437 To configure the border settings of an instrument.
Code Editor Dialog on page 604 To assign Python code to an event of the selected instrument or layout.
Conversion Table Settings Properties (Time (Available only if the connected variable is converted via verbal table
Plotter/Index Plotter) on page 457 conversion) To specify properties for connected variables with verbal
conversion tables.
Custom Value Conversion Properties on page 461 To specify properties for converting a source value into a converted value and
vice versa. The variable conversion that you define here is assigned to the
instrument.
Data Cursor Properties (Time Plotter/Index Plotter) To specify the properties of one or two cursors that are used to display the
on page 463 values of selected chart positions.
DAQ Properties (Time Plotter/Index Plotter) on To specify data acquisition settings for visualization in the Index Plotter or
page 462 Time Plotter. For example, you can enable a triggered display of plotter data.
Description Property on page 465 To specify a description for the instrument.
Grid Properties (Time Plotter/Index Plotter) on To configure the grid properties.
page 474
Legend Properties (Time Plotter/Index Plotter) on To specify the legend properties.
page 492
Name Property on page 503 To specify the name of the selected instrument.
Overlay Elements Properties (Time Plotter/Index To configure overlay elements that can be displayed in the plotter's chart.
Plotter) on page 508
Picture Properties on page 512 To specify whether to use an image (or animated GIF) for the selected
element and to specify its properties.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.
Scroll Bar Properties (Time Plotter/Index Plotter) on To specify the scroll bar properties.
page 527
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533

386
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Property Purpose
Time Cursor Properties on page 558 To specify the properties of the time cursor.
Toolbar Properties (Time Plotter/Index Plotter) on To specify the properties of the instrument's toolbar.
page 559
Tooltip Property on page 560 To specify a tooltip for the instrument.
Use Custom Colors Property on page 561 To enable or disable custom color settings for the instrument.
Use Custom Fonts Property on page 562 To enable or disable global font settings for the instrument.
Variables Properties on page 562 To display and configure the variables that are connected to the instrument.
View Properties (Time Plotter/Index Plotter) on To configure the view of the axes.
page 566

Related commands The Time Plotter provides the following commands:

Command Purpose
Best Fit on page 593 To adjust the column width of the selected legend column automatically.
Best Fit (All Columns) on page 593 To adjust the column width of all legend columns automatically.
Clear Sorting on page 603 To clear the alphabetical sorting of the legend rows.
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Copy / Variables - Copy on page 626 To copy the selected variables to the Clipboard.
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Column Chooser (Time Plotter/Index Plotter) on To add/remove columns to/from the legend.
page 607
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
DAQ - Available Raster (Time Plotter/Index Plotter) To select a measurement raster for a signal.
on page 633
DAQ – Leading Raster (Time Plotter/Index Plotter) To select one of the measurement rasters of the displayed signals as the
on page 634 leading raster for the plotter display. The list contains all the rasters that are
currently used.
DAQ – Mode (Time Plotter/Index Plotter) on To switch between triggered and untriggered display of plotter data.
page 635
DAQ - Trigger (Time Plotter/Index Plotter) on To switch between automatic and interactive setting of the signal's
page 637 measurement trigger.
Delete (Y-Axis Time Plotter/Index Plotter) on To delete the selected y-axis.
page 639
Delete (Instrument) on page 639 To delete the selected instruments.
Delete Signal (Time Plotter/Index Plotter) on To delete the selected signal.
page 644
Group by This Column on page 656 To group the signals in the legend according to the entries of the column.
Hide Expand Button on page 658 To hide the legend's expand button in the instrument.
Hide Search Panel on page 660 To hide the find panel. The find panel lets you filter the signals to be
displayed in the plotter by a search string.
Hide Group By Box on page 659 To hide the group by box. The group by box lets you group the signals in the
legend via drag & drop.
Filter Editor on page 654 To filter the signals that are displayed in a plotter by filter rules.
Instrument Properties on page 666 To view and edit the properties of an instrument.

387
May 2024 ControlDesk Instrument Handling
Reference Information

Command Purpose
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Line Style (Time Plotter/Index Plotter) on page 676 To specify whether to connect the points of a line graphically by a straight
line.
Navigation – Enable/Disable Move Mode (Time To enable or disable the move mode. The move mode lets you move the
Plotter/Index Plotter) on page 679 displayed area of the axis via mouse pointer.
Navigation – Move Mode (Time Plotter/Index To move the displayed area of the chart via the pointer.
Plotter) on page 680
Navigation – Rescale (Time Plotter/Index Plotter) on To rescale one or all axes.
page 681
Navigation – Zoom Mode (Time Plotter/Index To zoom the displayed area of the chart via the pointer.
Plotter) on page 681
Point Style (Time Plotter/Index Plotter) on page 690 To select the style of the signal's points.
Remove This Column on page 693 To remove the selected column from the legend.
Rescale on page 696 To rescale one or both axes of a plot.
Save Displayed Data as New Measurement on To save the data that is displayed in a Time Plotter as a new measurement.
page 701
Scaling Mode on page 703 To select the scaling mode of the axis.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Show Bookmarks on page 708 To show or hide bookmark symbols at the x-axis.
Show Column Headers (Time Plotter/Index Plotter) To show/hide the column headers in the legend.
on page 709
Show Expand Button on page 711 To display the legend's expand button in the instrument.
Show Find Panel on page 711 To filter the signals to be displayed in the plotter by a search string.
Show Group By Panel on page 712 To group the signals in the legend via drag & drop.
Show Legend on page 713 To show/hide the legend.
Show Toolbar on page 715 To show/hide the instrument's toolbar.
Sort Ascending on page 718 To sort the rows of the legend alphabetically in ascending order by the
selected column.
Sort Descending on page 719 To sort the rows of the legend alphabetically in descending order by the
selected column.
Tic Format on page 722 To select the format used to label the axis tics.
Variable - Converted (Plotter Instruments) on To display the signal values in converted (physical) mode.
page 728
Variable - Delete Variable (Time Plotter/Index To delete the selected variable leaving an unconnected signal.
Plotter) on page 729
Variable - Source (Time Plotter/Index Plotter) on To display the signal values in source (dec) mode.
page 729
Variable(s) - Add on page 730 To connect a variable to an instrument.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.
Configure Connection Assignment on page 617 To configure the connection assignment of the variable(s) in the selected
instrument(s).
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.
Variables - Delete on page 734 To delete the selected variables.
Variables - Paste/Paste Variables on page 735 To paste variables from the Clipboard to an instrument.

388
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Command Purpose
Variable(s) - Select in Variables/Mappings Pane on To select and highlight variables in the Variables pane, or framework labels in
page 731 the Mappings pane.
Y-Axes View – Horizontal Stacked on page 735 To arrange the y-axes horizontally one below the other.
Y-Axes View – Rescale All Axes on page 736 To rescale all y-axes in one step.
Y-Axes View – Settings on page 737 To set the width of the y-axes to optimum, maximum, or fixed size.
Y-Axes View – Vertical Fixed on page 738 To align the y-axes vertically. All y-axes are visible.
Y-Axes View – Vertical Scroll on page 738 To align the y-axes vertically in a scroll area.

Related topics Basics

Choosing Between Time Plotter, Index Plotter, and XY Plotter................................................... 40


Time Plotter Handling............................................................................................................. 216

Videos

Comparing Time Plotter, Index Plotter, and XY Plotter (3:41) in dSPACE Help
Displaying Cursors (3:49) in dSPACE Help
Sensitive Areas and Adding Signals (3:57) in dSPACE Help
Specifying Plotter Settings in the Properties Pane (2:41) in dSPACE Help
Specifying Plotter Signal Settings (5:21) in dSPACE Help

Variable Array

Illustration

Title bar
Header

Instrument row

Selected
variable

Instrument column Instrument cell

Purpose To display and set the values of several connected variables.

Description Title bar Displays the instrument name, the name of the selected variable
and the unit of the variable (if available).

389
May 2024 ControlDesk Instrument Handling
Reference Information

Header Displays information on the selected variable.

Instrument rows Each row in the Variable Array represents a connected


variable. Depending on the selected column and instrument cell type, it displays
information on the variable or lets you display or calibrate the variable value. If
you place the same variable in a Variable Array several times, it is displayed in
several rows. Each row can be configured differently.

Instrument columns Each instrument column in the Variable Array specifies


the type of information that can be displayed in the column. You can add, delete
and configure the columns.

Instrument cells Each instrument cell in the Variable Array displays


information on a variable according to the instrument column and instrument
cell type.

Value cells A value cell is a special instrument cell. It provides several cell
types for displaying and/or calibrating variable values in the value columns. The
table below lists the available value cell types:

Value Cell Type Illustration Description


Alphanumeric To edit and display the value of a scalar
Input parameter or the text content of an
ASCII variable.
Bar To display the value of a scalar variable
via a bar deflection.

Bitfield To edit and display the source value of a


parameter as a bit string.
Check Button To set the variable's value to a
predefined value when you activate the
checkbox (On value) and when you
clear it (Off value), and to display if one
of the predefined values is the current
value of the connected variable (if not,
it is grayed).
Display To display the value of a scalar variable
or the text content of an ASCII variable.
Multistate LED To display the value of a variable as an
LED state.
On/Off Button To set the variable's value to a
predefined value when you press the
button (On value) and when you
release the button (Off value).
Push Button To set the variable's value to a
predefined value when you press the
button.
Slider To edit and display the value of a scalar
parameter by a slide.

390
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Indicator cells The Indicator column displays the current state of the
connected parameter.

Symbol Description
Proposed calibration
Proposed calibration is active, value has not been changed.

Proposed calibration is active, the value has been changed.

Tendency symbols (not available for platforms)


The working data set is active and the value of the variable in the working data
set is higher than the value in the reference data set.
The working data set is active and the value of the variable in the working data
set is lower than the value in the reference data set.
The working data set is active and the value of the variable in the working data
set is equal to the value in the reference data set.
The working data set is active and the value of the variable in the working data
set is unequal to the value in the reference data set. This applies only to ASCII
variables.
Reference symbols
The reference data set is active (not available for platforms).

The working data set is active, but the value of the reference data set is shown
in this row of the instrument. For platforms, the value of the initial data set is
shown (if available).

Icon cells The first column of the Variable Array displays the variable type of
the variables.

Symbol Description
Scalar parameters, including individual elements of a
value block.
Scalar measurement variables, including individual
elements of a measurement array and system
variables.

Cells in other columns The following table shows possible cell types in other
columns:

Column Type Description


Indicator Displays the status of the connected variables.
Label Displays the label of the column.
Min/Max Displays the maximum or minimum of the measured value.
Range Check Displays above and below symbols according to your range
check configuration.

Views When you select an instrument row in a Variable Array, it is


automatically highlighted. There are also other views, as shown by the examples
in the following table.

391
May 2024 ControlDesk Instrument Handling
Reference Information

View Description
Not writable view The variable of the instrument row is not
writable. You cannot change its value. You will
find this view if the reference data set is active
or a measurement variable is assigned to a value
cell.
No-value view The instrument is not receiving valid values.
For measurement variables, you will find this
view, for example, if you have not started a
measurement after loading an experiment. For
parameters, you will find this view, for example,
if you added a variable description without an
initial data set but did not upload values from
the ECU.
Preselected view The variable of the instrument row is
preselected. You can preselect a row only by
using the shortcut keys Ctrl+↑ or Ctrl+↓.
Pressing Ctrl+Space selects the row. You can
select several rows at a time in this way. This
functionality corresponds to selecting rows by
using the mouse and pressing Ctrl.

Supported computation methods and conversion modes In the following


table, you can see which computation methods are supported by the
Alphanumeric Input and which conversion modes are available for them.

Computation Method Source Converted


Mode Mode
Computation method ✓ ✓
Tabular conversion with interpolation ✓ ✓
Tabular conversion without interpolation ✓ ✓
Verbal conversion ✓ ✓
Verbal conversion range ✓ ✓

Moving rows via drag & drop You can move rows of a Variable Array via
drag & drop. You can select one or more rows and drop them to any position of
the same or another Variable Array.
Refer to the following illustration:

Changing values There are different ways to change values in a Variable Array. According to the
selected value cell type, there are special operations for changing the value of

392
ControlDesk Instrument Handling May 2024
Instrument Descriptions

the connected parameter. The following general operations apply to most value
cell types.
§ You can change a single value using Adjust Value(s) from the context menu
of a parameter. Select an operation (Add, Multiply, Divide, Assign), or
press +,*,/, or =. In the dialog that opens, enter a value as the operand to
change the variable value.
§ You can select an Alphanumeric input cell and press F2 to change the value.
The changed value is written to the variable when you press Enter.
§ You can select a parameter and use the PgUp and PgDown buttons to change
the value (small increments). In this case the value is written to the variable
without pressing Enter. If you simultaneously press the Ctrl key you change
the value using big increments.
§ If the instrument row that has the input focus contains a cell type that allows
direct input (such as an Alphanumeric Input cell), you can enter a value directly
without selecting the value cell. If the instrument row contains more than one
direct input cell (and the selected cell is not a direct input cell itself), the value
is entered in the next direct input value cell to the right.
§ If you want to change the values of more than one parameter in the same
way (same operator and operand), you can select multiple rows by holding the
Shift or the Ctrl key.

Instrument properties The Variable Array provides the following properties:

Property Purpose
Active Property on page 415 To activate or deactivate the instrument.
Border Properties on page 437 To configure the border settings of an instrument.
Selected Cells Properties (Variable Array - Value To specify the properties of the selected cells.
Cell) on page 529
Cell Type Property (Variable Array) on page 449 To select a type for the selected value cell.
Column Header Height Property on page 453 To specify the height of the first row of the Variable Array.
Current Display Format Property on page 458 To open a dialog to specify the display format for the connected variable.
Custom Header Text Property (Variable Array) on To specify a custom text for the instrument header.
page 460
Description Property on page 465 To specify a description for the instrument.
Display Variable Information Property on page 468 To specify whether to display information about the variable in the
instrument header.
Display Formats Properties on page 465 To configure the display format for the display area.
Header Visible Property on page 477 To specify whether to display the header of the current instrument.
Increments Properties on page 479 To configure the increments for the selected variable.
Label Properties (Label Cell) on page 488 To configure the label which is displayed in the label cell.
LED States Properties (Value Cell – Multistate LED) To configure the LED properties of the selected Multistate LED cell.
on page 491
Min/Max Property on page 497 To display the maximum or minimum of the measured value.
Name Property on page 503 To specify the name of the selected instrument.
Button Cell Properties (Value Cell – Button) on To configure the button properties of the selected Check button, On/Off
page 438 button, or Push button cell.
Quick Sort Property on page 514 To sort the instrument rows of the Variable Array.

393
May 2024 ControlDesk Instrument Handling
Reference Information

Property Purpose
Range Check Properties on page 516 To configure a range check for the value.
Row Header Width Property on page 520 To specify the width of the first column of the Variable Array.
Rows Properties on page 520 To configure the properties of the rows in the Variable Array.
Scale Range Properties (Value Cell – Bar/Slider) on To configure the scale range properties of the selected Bar or Slider cell.
page 526
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.
Selected Column Properties on page 529 To configure the properties of the selected column of the Variable Array.
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
Text / Numeric Output Font Properties on page 553 To configure the font properties of the selected item.
Tooltip Property on page 560 To specify a tooltip for the instrument.
Use Custom Colors Property on page 561 To specify the color of the selected item.
Use Custom Fonts Property on page 562 To enable or disable global font settings for the instrument.
Use Custom Header Settings Property on page 562 To enable or disable custom settings for the instrument header.

Related commands The Variable Array provides the following commands:

Command Purpose
Adjust Value(s) on page 586 To enter a value as the operand to change the parameter value.
Append Variable on page 589 To append a row with the selected variable to the currently selected row in
the Variable Array.
Assign Recent Value on page 591 To display the most recent scalar values of a variable and to reset the variable
to one of them.
Bin (Source) on page 594 To display a value in bin (source) mode.
Bitmask on page 595 To specify the bitmask properties for the selected variable.
Cell Properties on page 598 To specify properties of the selected cell.
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Connect as Additional Write Variable(s) on To connect the selected variable to the instrument for calibration as an
page 618 additional write variable.
Connect as Main Variable / Connect Variable(s) on To connect the selected variable to the instrument as the main variable.
page 619
Columns - Insert on page 611 To add a column to the Variable Array.
Columns - Customize on page 609 To configure the columns of the Variable Array.
Columns - Delete on page 611 To delete the selected column.
Compu Tab Items Sorted on page 616 To sort the string list of a value with verbal conversion (CompuVTab,
CompuVTabRange) alphabetically.
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Copy Value (Instruments) on page 629 To copy the value that is displayed in the instrument.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Dec (Source) on page 638 To display a value in dec (source) mode.
Delete (Instrument) on page 639 To delete the selected instruments.
Display Formats on page 647 To specify the display format for the selected variable.

394
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Command Purpose
Hex (Source) on page 657 To display a value in hex (source) mode.
Increments on page 662 To specify the increments for the selected variable.
Insert Before on page 665 To insert a row with the selected variable before the currently selected row in
the Variable Array.
Instrument Properties on page 666 To view and edit the properties of an instrument.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Label on page 674 To specify the properties of the label cell.
Maximize Column Width on page 678 To maximize the width of the selected column.
On/Off Values / On Value on page 682 To specify the properties of the following buttons: Check button, On/Off
button, Push button.
Optimize on page 683 To let ControlDesk specify the optimum width and/or heigth of the selected
instrument.
Physical (Converted) on page 689 To display a value in the instrument in physical (converted) mode.
Replace Variable on page 695 To replace the connected main variable of the selected row in the Variable
Array.
Row - Delete on page 699 To delete the selected row.
Row - Highlighted - Color on page 700 To specify the highlight color of the currently selected row.
Row - Highlighted - Enabled on page 700 To highlight the currently selected row.
Rows Properties on page 520 To configure the properties of the rows in the Variable Array.
Scale Range on page 703 To specify the scale range properties of the Bar or Slider Cell.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Show Current/Reference on page 710 To specify whether to display the current value or the reference value in the
current instrument.
Toggle Bits on page 723 To toggle selected bits of the connected variable.
Variable(s) - Add on page 730 To connect a variable to an instrument.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.
Copy / Variables - Copy on page 626 To copy the selected variables to the Clipboard.
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.
Variables - Delete on page 734 To delete the selected variables.
Variables - Paste/Paste Variables on page 735 To paste variables from the Clipboard to an instrument.
Variable(s) Properties on page 732 To show the Properties dialog of a connected variable.

Related topics HowTos

How to Change Values with the Variable Array (Alphanumeric Input Value Cell Type)............. 246
How to Change Values with the Variable Array (Bitfield Editor Value Cell Type)....................... 249
How to Configure the Variable Array...................................................................................... 244
How to Visualize Variable States with the Variable Array (Multistate LED Value Cell
Type)...................................................................................................................................... 251

395
May 2024 ControlDesk Instrument Handling
Reference Information

XY Plotter

Illustration Chart area Cursor info

Y-axis

Scale label

Axis label

Curve symbol X-axis Data cursor

Purpose To display signals in relation to other signals (no relation to an index or time).

Description X-axis and y-axis The XY Plotter uses the x- and the y-axis as signal axes. You
must connect a signal to each axis to display a curve. The XY Plotter allows you
to display several curves in one chart.

Tip

§ To rescale an axis to the dimension needed to display all curves, double-


click it.
§ To rescale both axes, double-click the chart area.

Chart area Displays the XY plots of one or more curves. The curves can be
displayed in several styles and colors.

Cursor in Move or Zoom mode If you move the pointer to the chart area,
the displayed cursor depends on the navigation mode. You can change the
navigation mode via the chart's context menu.

Cursor Navigation Mode Description


Zoom mode You can specify the zoom area with the pointer.

Move mode You can move the chart in the x-axis and the
y-axis directions.

396
ControlDesk Instrument Handling May 2024
Instrument Descriptions

For details, refer to Zooming and Moving the Chart (XY Plotter) on page 257.

Data cursor and cursor info One or two cursors can be used to specify chart
positions. The positions of the cursors and the distance between them can be
displayed at the cursor info position.

Curve symbol The curve symbol is split into two areas that represent the
connected variables and the status of the connection.

Symbol Description
No variable is connected.

Only the x-axis is connected to a variable.

Only the y-axis is connected to a variable.

Both axes are connected to a variable.

The axis-variable connection is invalid for at least one axis. For


example, the connected variables can have different raster settings.
Move the mouse pointer over the symbol to open a tooltip with
information on the reasons.

Differences between Time Plotter, Index Plotter, and XY


Plotter ControlDesk offers three plotters types with different main purposes.
Knowing the differences helps you to select the appropriate type.
For details, refer to Choosing Between Time Plotter, Index Plotter, and XY Plotter
on page 40.

Connections You can place signals on the XY Plotter via drag & drop.

Instrument properties The XY Plotter provides the following properties:

Property Purpose
Axis Properties (XY Plotter) on page 431 To configure the properties of the axes in the XY Plotter.
Axis Color Property (XY Plotter) on page 431 To select a color for axis and grid elements.
Active Property on page 415 To activate or deactivate the instrument.
Background Properties on page 433 To configure the background properties of the current instrument.
Border Properties on page 437 To configure the border settings of an instrument.
Curves Properties (XY Plotter) on page 459 To configure the properties of the curves in the XY Plotter.
Custom Value Conversion Properties on page 461 To specify properties for converting a source value into a converted value and
vice versa. The variable conversion that you define here is assigned to the
instrument.
Data Cursor Properties (XY Plotter) on page 464 To specify the properties of one or two cursors that are used to display the
values of selected chart positions.
Description Property on page 465 To specify a description for the instrument.
Grid Enabled Property (XY Plotter) on page 473 To show or hide a grid in the chart area of the XY Plotter.
Grid Minor Tics Property (XY Plotter) on page 474 To specify the number of auxiliary lines in the grid.
Name Property on page 503 To specify the name of the selected instrument.

397
May 2024 ControlDesk Instrument Handling
Reference Information

Property Purpose
Picture Properties on page 512 To specify whether to use an image (or animated GIF) for the selected
element and to specify its properties.
Script Property on page 527 To extend the functionality of an instrument or layout by adding Python code
to it.
Selected Element(s) Property on page 530 To specify the properties of the elements that are currently selected in the
instrument.
Layout Settings Properties (XY Plotter) on page 490 To configure chart and grid settings of the XY Plotter.
Selection Border Style Property on page 531 To select a style for the selection border of the current instrument.
Size and Position Properties (Instrument) on To configure the size and position of an instrument.
page 533
Time Cursor Properties on page 558 To specify the properties of the time cursor.
Tooltip Property on page 560 To specify a tooltip for the instrument.

Related commands The XY Plotter provides the following commands:

Command Purpose
Available Raster (XY Plotter) on page 592 To select a measurement raster for the curve.
Configure Events (ControlDesk Automation ) To link Python code to a specific event in ControlDesk.
Copy (Instrument) on page 626 To copy the selected instruments to the Clipboard.
Copy / Variables - Copy on page 626 To copy the selected variables to the Clipboard.
Curves Properties (XY Plotter) on page 459 To configure the properties of the curves in the XY Plotter.
Cut (Instrument) on page 633 To cut the selected instruments to the Clipboard.
Delete Curve (XY Plotter) on page 642 To delete the selected curve.
Delete (Instrument) on page 639 To delete the selected instruments.
Enable Move Mode (XY Plotter) on page 650 To move the displayed area of the axis via mouse pointer.
Instrument Properties on page 666 To view and edit the properties of an instrument.
Instrument Script on page 667 To extend the functionality of an instrument by adding Python code to it.
Line Style (XY Plotter) on page 676 To specify whether to connect the points of a line graphically by a straight
line.
Point Style (XY Plotter) on page 691 To select the style of the curve's points.
Rescale on page 696 To rescale one or both axes of a plot.
Scaling Mode on page 703 To select the scaling mode of the axis.
Select in Instrument Navigator on page 705 To change the focus to the associated instrument node in the Instrument
Navigator.
Switch to Move Mode / Switch to Zoom Mode (XY To zoom or move the displayed area of the chart via mouse pointer.
Plotter) on page 721
Switch Variable (XY Plotter) on page 721 To interchange the variables that are connected to the x- and y-axis.
Tic Format on page 722 To select the format used to label the axis tics.
Variable - Converted (Plotter Instruments) on To display the signal values in converted (physical) mode.
page 728
Variable - Source (Time Plotter/Index Plotter) on To display the signal values in source (dec) mode.
page 729
Variable(s) - Add on page 730 To connect a variable to an instrument.
Change To/Variables - Change To on page 600 To connect the variables to a different instrument.

398
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Command Purpose
Configure Connection Assignment on page 617 To configure the connection assignment of the variable(s) in the selected
instrument(s).
Variables – Copy to Instrument on page 733 To add a new instrument to the layout and copy the selected variables to it.
Variables - Cut on page 733 To cut the selected variables in the current instrument.
Variables - Delete on page 734 To delete the selected variables.
Variables - Paste/Paste Variables on page 735 To paste variables from the Clipboard to an instrument.
Variable(s) - Select in Variables/Mappings Pane on To select and highlight variables in the Variables pane, or framework labels in
page 731 the Mappings pane.

Related topics Basics

Choosing Between Time Plotter, Index Plotter, and XY Plotter................................................... 40


XY Plotter Handling................................................................................................................ 253

Videos

Comparing Time Plotter, Index Plotter, and XY Plotter (3:41) in dSPACE Help
Displaying Cursors (3:49) in dSPACE Help
Sensitive Areas and Adding Signals (3:57) in dSPACE Help
Specifying Plotter Settings in the Properties Pane (2:41) in dSPACE Help
Specifying Plotter Signal Settings (5:21) in dSPACE Help

Stopwatches
Introduction The Stopwatches category in the Instrument Selector provides analog and
digital stopwatches with and without lap time function.

Stopwatches

Introduction The Stopwatches category in the Instrument Selector provides analog and
digital stopwatches with and without lap time function.

399
May 2024 ControlDesk Instrument Handling
Reference Information

See the following illustration (for an animated graphic, refer to dSPACE Help).

The functionality of the stopwatches, such as starting, stopping, or displaying lap


times, is added to them via instrument scripts .

Each stopwatch consists of an instrument group that contains different


instruments. Each single instrument can contain one instrument script. The
instrument scripts of the single instruments interact and create the functionality
of the stopwatch.

You can use the stopwatches as templates in your own experiments and change
them according to your needs.

For details on creating a stopwatch, refer to Example of Adding a Python Script


to an Instrument (ControlDesk Customization ).

Available stopwatches The following table provides an overview of the available stopwatches:

Instrument Name Representation


Analog Stopwatch - Large

Analog Stopwatch with Laps - Large

Analog Stopwatch - Medium

400
ControlDesk Instrument Handling May 2024
Instrument Descriptions

Instrument Name Representation


Analog Stopwatch with Laps - Medium

Analog Stopwatch - Small

Digital Stopwatch

Digital Stopwatch with Laps

Digital Stopwatch - Scalable

Related topics Examples

Example of Adding a Python Script to an Instrument (ControlDesk


Customization )

Videos

Stopwatches (4:06) in dSPACE Help

401
May 2024 ControlDesk Instrument Handling
Reference Information

Instrument-Related Properties
Introduction Note

In the operator mode, none of the properties related to instruments can be


changed. All the properties are read-only.

You can configure the properties by means of the Properties pane.

Where to go from here Information in this section

2-D View Properties............................................................................... 411


To configure the 2-D view properties of the Table Editor.

3-D View Properties............................................................................... 412


To configure the 3-D view properties of the Table Editor.

Active Property...................................................................................... 415


To activate or deactivate the instrument.

Additional Write Variables Properties..................................................... 415


Displays the number of connected additional write variables and lets you
open a dialog for more information on them. You can also disconnect
additional write variables via the dialog.

Advanced Settings Properties (Time Plotter/Index Plotter)....................... 416


To configure advanced settings.

Aircraft Symbol Properties (Artificial Horizon)......................................... 417


To configure the properties of the aircraft symbol.

Aircraft Symbol Properties (Heading Indicator)....................................... 418


To configure the properties of the aircraft symbol.

Alignment Property............................................................................... 419


To configure the alignment.

Alignment/Text Alignment Property (Hierarchy Array)............................. 419


To specify the alignment of the content of the selected cell.

Alternating Row Colors Properties......................................................... 419


To specify alternating row colors for a Variable Array.

Angle Properties.................................................................................... 420


To configure the start and stop angles of the circular scale.

Automatic Sizing Property (Bar, Gauge, Knob, Slider)............................. 421


To enable or disable the automatic sizing function.

Automatic Sizing Property (Hierarchy Array)........................................... 422


To enable or disable automatic sizing of instrument cells.

Axes and Signals Properties (Time Plotter/Index Plotter).......................... 422


To configure the properties of the selected axis or signal.

402
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Axes Properties (3-D Viewer).................................................................. 427


To configure the properties of the selected axis.

Axes Properties (Table Editor)................................................................. 429


To configure the properties of the axes in the Table Editor.

Axis Color Property (XY Plotter)............................................................. 431


To select a color for axis and grid elements.

Axis Properties (XY Plotter).................................................................... 431


To configure the properties of the axes in the XY Plotter.

Background Properties........................................................................... 433


To configure the background properties of the current instrument.

Bands Properties.................................................................................... 433


To specify the properties of colored bands for the highlighting of value
ranges.

Bands Properties (Airspeed Indicator)..................................................... 436


To configure the properties of the bands.

Bitmask Properties................................................................................. 436


To specify the bitmask properties for the selected variable.

Border Properties................................................................................... 437


To configure the border settings of an instrument.

Browser Properties................................................................................. 438


To configure the Browser-specific properties.

Button Cell Properties (Value Cell – Button)........................................... 438


To configure the button properties of the selected Check button, On/Off
button, or Push button cell.

Button Color Property............................................................................ 439


To specify the color of the selected button.

Button Style Property............................................................................. 440


To specify the appearance of the button.

Button Style Settings Properties (Check Button)..................................... 440


(Available only if Check box style is set to Button) To configure the
button style.

Buttons Properties................................................................................. 441


To configure the buttons of the selected instrument.

Camera Properties................................................................................. 442


To configure the camera properties.

Captions/Operating Elements Properties................................................ 443


To add and remove captions and configure the properties of operating
elements.

Cell Properties....................................................................................... 447


To specify cell properties.

Cell Properties (Bus Instrument)............................................................. 448


To specify the properties of the selected cells.

403
May 2024 ControlDesk Instrument Handling
Reference Information

Cell Type Property (Variable Array)......................................................... 449


To select a type for the selected value cell.

Center Point X Property......................................................................... 450


To configure the center point's position on the x-axis.

Center Point Y Property......................................................................... 450


To configure the center point's position on the y-axis.

Check Box Style Property....................................................................... 451


To specify whether to display a checkbox or a button in the instrument.

Clip Content Property............................................................................ 451


To select whether items are clipped when they expand beyond the area
defined by the axes.

Color Property....................................................................................... 452


To specify the color of the selected item.

Colors Properties (Time Plotter/Index Plotter).......................................... 453


(Only available if Color style is set to a multicolor setting) To specify a
color range for the signal.

Column Header Height Property............................................................ 453


To specify the height of the first row of the Variable Array.

Connection Assignment Properties........................................................ 454


To specify the assignment of variables to an instrument or an instrument
group.

Connection Nodes Properties................................................................. 456


To configure connection nodes of the Browser.

Conversion Table Settings Properties (Time Plotter/Index Plotter)............ 457


(Available only if the connected variable is converted via verbal table
conversion) To specify properties for connected variables with verbal
conversion tables.

Current Display Format Property............................................................ 458


To open a dialog to specify the display format for the connected variable.

Curves Properties (XY Plotter)................................................................ 459


To configure the properties of the curves in the XY Plotter.

Custom Header Text Property (Variable Array)........................................ 460


To specify a custom text for the instrument header.

Custom Value Conversion Properties..................................................... 461


To specify properties for converting a source value into a converted value
and vice versa. The variable conversion that you define here is assigned
to the instrument.

DAQ Properties (Time Plotter/Index Plotter)............................................ 462


To specify data acquisition settings for visualization in the Index Plotter or
Time Plotter. For example, you can enable a triggered display of plotter
data.

404
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Data Cursor Properties (Time Plotter/Index Plotter)................................. 463


To specify the properties of one or two cursors that are used to display
the values of selected chart positions.

Data Cursor Properties (XY Plotter)........................................................ 464


To specify the properties of one or two cursors that are used to display
the values of selected chart positions.

Description Property.............................................................................. 465


To specify a description for the instrument.

Display Formats Properties..................................................................... 465


To configure the display format for the display area.

Display Properties.................................................................................. 467


To display the value of the connected variable numerically.

Display Value Property........................................................................... 468


To specify whether the value of each button is displayed.

Display Variable Information Property.................................................... 468


To specify whether to display information about the variable in the
instrument header.

Distance Tracking Properties.................................................................. 469


To configure the properties of the distance tracking elements.

Edit Mode Property (Animated Needle).................................................. 470


To enable the configuration of the radius, position and the orientation of
the needle.

Edit Mode Property (Invisible Switch)..................................................... 470


To specify whether to display the area of the Invisible Switch.

Edit Points Properties............................................................................. 471


To specify the properties of the edit points in the Table Editor.

File Archive Properties............................................................................ 471


To specify files that are saved with the selected Browser instrument.

Focus Border Visible Property................................................................. 472


To specify whether the currently selected button is marked by a dotted
frame.

Focus Color Property............................................................................. 472


To specify the color used to outline the selected cell.

Global Caption Enabled Property........................................................... 473


To specify to display a global caption below the header.

Grid Enabled Property (XY Plotter)......................................................... 473


To show or hide a grid in the chart area of the XY Plotter.

Grid Minor Tics Property (XY Plotter)...................................................... 474


To specify the number of auxiliary lines in the grid.

Grid Properties (Time Plotter/Index Plotter)............................................. 474


To configure the grid properties.

405
May 2024 ControlDesk Instrument Handling
Reference Information

Grid View Properties.............................................................................. 474


To configure the grid view properties of the Table Editor.

Header Property (Variable Array)............................................................ 476


To specify the header settings.

Header Visible Property.......................................................................... 477


To specify whether to display the header of the current instrument.

Horizon View Properties........................................................................ 477


To configure the properties of the Horizon view.

Horizontal Hub Position Property........................................................... 478


To move the hub horizontally inside the operating element.

Icon Properties....................................................................................... 479


To specify the properties of the selected icon cell.

Increments Properties............................................................................ 479


To configure the increments for the selected variable.

Items and Templates Properties.............................................................. 481


To configure the properties of the selected item or template.

Items Properties..................................................................................... 487


To add and remove Selection box items and configure their settings.

Label Properties (Label Cell)................................................................... 488


To configure the label which is displayed in the label cell.

Layout Settings Properties (XY Plotter)................................................... 490


To configure chart and grid settings of the XY Plotter.

LED States Properties (Value Cell – Multistate LED)................................. 491


To configure the LED properties of the selected Multistate LED cell.

Legend Properties (Time Plotter/Index Plotter)........................................ 492


To specify the legend properties.

Logical Links Properties.......................................................................... 493


To display the logical links that are available in the instrument.

Lubber Line Properties........................................................................... 494


To configure the properties of the lubber line.

Magnifier Properties.............................................................................. 494


To configure the properties of the magnifier.

Map Properties...................................................................................... 495


To configure the Map-specific properties.

Mark Properties..................................................................................... 497


To configure the properties of the mark.

Min/Max Property.................................................................................. 497


To display the maximum or minimum of the measured value.

MultiState Display Properties................................................................. 498


To specify the MultiState Display-specific settings.

406
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Multistate LED Properties....................................................................... 500


To configure the properties of the selected Multistate LED cell.

Multiswitch Properties........................................................................... 500


To specify the Multiswitch-specific settings.

Name Property...................................................................................... 503


To specify the name of the selected instrument.

Needle Properties (Animated Needle)..................................................... 503


To specify the needle-specific settings of the Animated Needle.

Needle Properties (Gauge)..................................................................... 504


To configure the properties of the needle.

Numeric Display Properties.................................................................... 505


To configure the properties of the numeric display.

Numeric Input Properties....................................................................... 505


To display and set the value of the connected variable numerically.

Off-Value Property................................................................................. 505


To specify the Off value of the button.

On-Value Property................................................................................. 506


To specify the On value of the button.

Orientation Property.............................................................................. 506


To specify the orientation of the buttons.

Origin Property...................................................................................... 507


To specify the bar’s origin.

Output Properties.................................................................................. 507


To configure the output properties of the Diagnostics Instrument.

Overflow Warning Property................................................................... 508


To enable or disable the overflow warning function.

Overlay Elements Properties (Time Plotter/Index Plotter)......................... 508


To configure overlay elements that can be displayed in the plotter's chart.

Overlay Picture Properties...................................................................... 512


To configure the properties of a picture placed behind the scale and
covering a part of the instrument's background.

Picture Properties................................................................................... 512


To specify whether to use an image (or animated GIF) for the selected
element and to specify its properties.

Pitch Scale Properties............................................................................. 513


To configure the properties of the pitch scale.

Quick Sort Property............................................................................... 514


To sort the instrument rows of the Variable Array.

Radio Button Style Property................................................................... 515


To specify the appearance of the buttons.

407
May 2024 ControlDesk Instrument Handling
Reference Information

Radius Property..................................................................................... 515


To specify the value for the radius of the instrument.

Range Check Properties......................................................................... 516


To configure a range check for the value.

Range Properties................................................................................... 517


To configure the scale range properties of the selected instrument.

Range Properties (Animated Needle)...................................................... 517


To specify a range for the variable value displayed in the selected
instrument.

Regions Properties................................................................................. 518


To enable or disable regions in a Bus Instrument.

Roll Scale Properties............................................................................... 518


To configure the properties of the roll scale.

Row Header Width Property.................................................................. 520


To specify the width of the first column of the Variable Array.

Rows Properties..................................................................................... 520


To configure the properties of the rows in the Variable Array.

Rows Properties (Hierarchy Array).......................................................... 521


To specify the properties of header rows and rows in the Hierarchy Array.

Scale Properties..................................................................................... 522


To configure the scale properties of the selected instrument.

Scale Properties (Avionics)...................................................................... 525


To configure the properties of the scale.

Scale Range Properties (Value Cell – Bar/Slider)...................................... 526


To configure the scale range properties of the selected Bar or Slider cell.

Script Property....................................................................................... 527


To extend the functionality of an instrument or layout by adding Python
code to it.

Scroll Bar Properties (Time Plotter/Index Plotter)..................................... 527


To specify the scroll bar properties.

Segmented Property.............................................................................. 528


To segment the bar according to the tics of the scale.

Selected Cells Properties (Variable Array - Value Cell)............................. 529


To specify the properties of the selected cells.

Selected Column Properties................................................................... 529


To configure the properties of the selected column of the Variable Array.

Selected Element(s) Property.................................................................. 530


To specify the properties of the elements that are currently selected in the
instrument.

Selected Variables Property.................................................................... 531


To specify the properties of the variables that are currently selected in the
instrument.

408
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Selection Border Style Property.............................................................. 531


To select a style for the selection border of the current instrument.

Selection Box Cell Properties.................................................................. 531


To configure the properties of the selected Selection box cell.

Selection Box Properties......................................................................... 532


To specify the Selection Box-specific settings.

Separator Color Property....................................................................... 533


To specify the color of the separators between lines and columns.

Size and Position Properties (Instrument)................................................ 533


To configure the size and position of an instrument.

Size and Position Properties (Scale and Magnifier).................................. 534


To specify the relative size and position of the scale and magnifier inside
the instrument.

Slide Properties...................................................................................... 535


To configure the properties of the slide of the Slider.

Slidebar Properties................................................................................. 535


To configure the properties of the slidebar.

Sound Controller Properties................................................................... 537


To specify the Sound Controller-specific properties.

States Properties.................................................................................... 540


To add and remove states and configure their settings.

Static Text Properties.............................................................................. 543


To configure the Static Text-specific settings.

Steering Controller Properties................................................................ 543


To specify the Steering Controller-specific properties.

Switch Mode Property........................................................................... 548


To select a button type which the Invisible Switch simulates.

Tab Bar Properties.................................................................................. 549


To configure the tab bar of the Hierarchy Array.

Tab Pages Properties (Bus Instrument).................................................... 549


To specify the order and the labels of the instrument tabs.

Tab Properties (Table Editor)................................................................... 550


To configure the properties of the selected instrument tab.

Tabbed Pages Properties (Table Editor)................................................... 551


To configure the properties of the instrument tabs.

Tabs Properties (Hierarchy Array)............................................................ 552


To configure the tabs of the Hierarchy Array.

Text / Numeric Output Font Properties................................................... 553


To configure the font properties of the selected item.

Text Alignment Property........................................................................ 554


To specify the alignment of text in the selected Hierarchy Array cell.

409
May 2024 ControlDesk Instrument Handling
Reference Information

Text Color Property................................................................................ 554


To specify the color of the selected item.

Text Font Property.................................................................................. 555


To specify the font of the selected item.

Text Properties (Numeric Input).............................................................. 555


To specify the text properties of the Numeric Input.

Text Property (Check Button)................................................................. 556


To specify the text displayed next to the checkbox.

Text Property (Hierarchy Array)............................................................... 556


To specify the label of the selected Label cell.

Time Cursor Properties.......................................................................... 558


To specify the properties of the time cursor.

Title Properties....................................................................................... 559


To configure the title of the selected element to be displayed.

Toolbar Properties (Time Plotter/Index Plotter)........................................ 559


To specify the properties of the instrument's toolbar.

Tooltip Property..................................................................................... 560


To specify a tooltip for the instrument.

Tree View Properties.............................................................................. 560


To configure the view properties of the communication object tree in the
Diagnostics Instrument.

Use Custom Colors Property.................................................................. 561


To enable or disable custom color settings for the instrument.

Use Custom Fonts Property.................................................................... 562


To enable or disable global font settings for the instrument.

Use Custom Header Settings Property.................................................... 562


To enable or disable custom settings for the instrument header.

Variables Properties............................................................................... 562


To display and configure the variables that are connected to the
instrument.

Variables Properties (Z-Axis)................................................................... 565


To add and delete z-axes to or from a Table Editor and to specify the
properties of the variables that are connected to them.

Vertical Hub Position Property................................................................ 566


To move the hub vertically inside the operating element.

View Properties (Time Plotter/Index Plotter)............................................ 566


To configure the view of the axes.

Walls Properties..................................................................................... 568


To configure the selected wall.

Width Property (Hierarchy Array)............................................................ 568


To specify the width of the selected column in the Hierarchy Array.

410
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Word Wrap Property..................................................................... ........ 568


To specify the word wrap property of text lines.

Working Point Properties....................................................................... 569


To configure the properties of the working point.

Working Points Properties (Multiple Working Points).............................. 569


Opens a dialog for you to configure the properties of multiple working
points.

2-D View Properties

Purpose To configure the 2-D view properties of the Table Editor.

Background properties Lets you specify the background properties of the 2-D view.

Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

Picture properties Lets you specify whether to use an image for the
background and configure its properties. Refer to Picture Properties on page 512.

Data lines properties Lets you specify the properties of the data lines.

Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

Width Lets you specify the width of the data lines in pixels.

Data points properties Lets you specify the properties of the data points.

Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

Point size Lets you specify the size of the data points in pixels.

Point style Lets you specify the style of the data points.

Grid properties Lets you specify the properties of the grid.

Background color Opens a dialog for you to select a color or enter values to
set one. For more information on the dialog settings, refer to Color Property on
page 452.

Line color Opens a dialog for you to select a color or enter values to set
one. For more information on the dialog settings, refer to Color Property on
page 452.

411
May 2024 ControlDesk Instrument Handling
Reference Information

Lines visible Lets you specify whether the grid lines are displayed.

Number of visible panes Number of visible panes Lets you specify the number of panes that are
property displayed.

Projection type property Projection type Lets you specify whether the x-axis or the y-axis is used to
display the function values in the 2-D view (xz or yz projection).

Text font property Text font Opens a dialog where you can specify a font. If the element
uses the general font settings from the Instruments page of the ControlDesk
Options dialog, select Use custom font settings to make the font settings in
the dialog available.

Use all values for data axis Use all values for data axis scaling Lets you specify whether the same data
scaling property axis scaling is used for all existing panes.

Visible property Visible Lets you specify whether the 2-D view is displayed.

Related instruments These properties are available for the following instruments:
§ Table Editor on page 379

Related topics HowTos

How to Set Up a View of the Table Editor............................................................................... 211

References

3-D View Properties................................................................................................................ 412


Grid View Properties............................................................................................................... 474

3-D View Properties

Purpose To configure the 3-D view properties of the Table Editor.

Axes color property Axes Color Opens a dialog for you to select a color or enter values to set
one. For more information on the dialog settings, refer to Color Property on
page 452.

412
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Background properties Lets you specify the background properties of the 3-D view.

Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

Picture properties Lets you specify whether to use an image for the
background and configure its properties. Refer to Picture Properties on page 512.

Camera properties Lets you specify the view of the chart in terms of camera positions and settings.

Camera type Lets you select a camera type.

Camera Type Description


Orthographic The scaling of objects is always the same, no matter how far
away they are.
Perspective Objects in the distance appear smaller.

X-rotation Lets you rotate the view around the x-axis. For an overview of
mouse and shortcut keys, refer to How to Set Up a View of the Table Editor on
page 211.

X-translation Lets you move the camera along the x-axis. This is particularly
useful if you zoomed into the chart.

Y-rotation Lets you rotate the view around the y-axis.

Y-translation Lets you move the view along the y-axis. This is particularly
useful if you zoomed into the chart.

Z-rotation Lets you rotate the view around the z-axis.

Zoom Lets you zoom the chart.

Tip

Rotation, translation, and zoom: For an overview of mouse shortcuts and


shortcut keys, refer to How to Set Up a View of the Table Editor on
page 211.

Chart type property Chart type Lets you select a chart type.

Chart Type Description


Bar The function values are displayed as a collection of bars.
ScatterPlot The function values are displayed as a collection of points.
Surface The function values are displayed as a smooth surface.

413
May 2024 ControlDesk Instrument Handling
Reference Information

Grid properties Lets you specify the properties of the grid.

Background color Opens a dialog for you to select a color or enter values to
set one. For more information on the dialog settings, refer to Color Property on
page 452.

Line color Opens a dialog for you to select a color or enter values to set
one. For more information on the dialog settings, refer to Color Property on
page 452.

Lines visible Lets you specify whether the grid lines are displayed.

Point size property Point size Lets you specify the size of the data points in pixels.

Surface properties Lets you specify the properties of the chart's surface.

Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

Line color Opens a dialog for you to select a color or enter values to set
one. For more information on the dialog settings, refer to Color Property on
page 452.

Lines visible Lets you specify whether to display lines on the surface of the
3-D data points.

Text font property Text font Opens a dialog where you can specify a font. If the element
uses the general font settings from the Instruments page of the ControlDesk
Options dialog, select Use custom font settings to make the font settings in
the dialog available.

Visible property Visible Lets you specify whether the 3-D view is displayed.

Related instruments These properties are available for the following instruments:
§ Table Editor on page 379

Related topics HowTos

How to Set Up a View of the Table Editor............................................................................... 211

References

2-D View Properties................................................................................................................ 411


Grid View Properties............................................................................................................... 474

414
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Active Property

Purpose To activate or deactivate the instrument.

Property Active Lets you activate or deactivate the instrument. If deactivated, the
instrument cannot be used and all the properties are read-only. If activated, the
instrument is enabled and you can configure its properties.

Related instruments This property is available for various instruments.

Additional Write Variables Properties

Purpose (Available only for instruments that can be used for calibration) Displays the
number of connected additional write variables and lets you open a dialog for
more information on them.

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.

Variables list All additional write variables are listed on the left side of the dialog. Select a
variable to display its properties.

You can use the following buttons to configure the list.

Button Description
Deletes the selected variable.

You can add additional write variables via the context menu of the instrument.
Refer to How to Write the Same Value to Several Parameters (ControlDesk
Calibration and Data Set Management ).

Toolbar A toolbar is displayed above the property list. The buttons let you configure the
view of the list or search for items in the list, for example.

For more details on the toolbar buttons, refer to Toolbar buttons (ControlDesk
User Interface Handling ).

Properties Displays information on the selected additional write variable.

415
May 2024 ControlDesk Instrument Handling
Reference Information

Origin Connection path Displays the path of the variable that was originally
connected to the instrument. This lets you identify the originally connected
variable if it was replaced by the variable it references.

Path Displays the path of the variable in the corresponding variable


description.

Platform/Device name Displays the name of the platform/device that the


variable belongs to.

Variable name Displays the name of the connected variable.

Write support active Displays whether the of the main variable can be
written to the additional write variable. You can change the write support via
the instrument's Write mode property.

Related instruments These properties are available for instruments that can be used for calibration.

Related topics HowTos

How to Write the Same Value to Several Parameters (ControlDesk Calibration and
Data Set Management )

Advanced Settings Properties (Time Plotter/Index Plotter)

Purpose To configure advanced settings.

Autoset trigger properties Maximum number of analyzed data points Lets you specify the maximum
number of analyzed data points for the Autoset trigger function. If Autoset
trigger is activated but the current trigger settings do not provide enough
data points for analyzing, the duration is enlarged to the maximum number of
analyzed data points.
Autoset trigger configures the triggers and display area automatically to
optimize the visualization of a periodic signal.

Number of displayed periods Lets you specify the number of periods to


display in the Index Plotter if Autoset trigger is activated for a periodic signal.
You can activate Autoset trigger via the context menu of a signal. ControlDesk
then analyses the signal to set the trigger settings in the measurement
configuration automatically.

Axes properties Autoscroll to active axis Lets you specify to scroll the y-axes area to the axis
of the currently active signal, if Axes mode is set to Scroll view. Select a signal
in the legend to make it the active signal.

416
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Hide axis if no signal is enabled Lets you specify to hide a y-axis if all the
signals connected to it are disabled. Double-click a signal in the legend to enable
or disable it.

Connections properties Connect unconnected signals Lets you specify to connect new variables to
an unconnected signal, if one is available. Usually ControlDesk creates a new
axis and a new signal for each new variable. If Connect unconnected signals is
activated, unconnected signals are used first.

Number of signals per axis Lets you specify the number of signals that can
be placed on one axis.

Signals properties Fast drawing mode Lets you specify to append only new points to the signal
line.

Use custom settings for new signals Lets you enable or disable the custom
settings for new signals.

Color for new signals (Available only if Use custom settings for new
signals is enabled) Lets you select a color for new signals that are connected
to the plotter.

Point style for new signals (Available only if Use custom settings for
new signals is enabled) Lets you select a point style for new signals that are
connected to the plotter.

Point size for new signals (Available only if Use custom settings for new
signals is enabled) Lets you select a point size for new signals that are connected
to the plotter.

Related instruments These properties are available for the following instruments:
§ Index Plotter on page 341
§ Time Plotter on page 384

Aircraft Symbol Properties (Artificial Horizon)

Purpose To configure the properties of the aircraft symbol.

Description The aircraft symbol represents the position of the airplane in the Horizon view.

Properties Bottom color Opens a dialog for you to select a color or enter values to
set one. For more information on the dialog settings, refer to Color Property on
page 452.

417
May 2024 ControlDesk Instrument Handling
Reference Information

Height Lets you specify the height of the aircraft symbol.

Top color Opens a dialog for you to select a color or enter values to set
one. For more information on the dialog settings, refer to Color Property on
page 452.

Visible Lets you specify whether the aircraft symbol is displayed.

Width Lets you specify the width of the aircraft symbol.

Related instruments These properties are available for the following instrument:
§ Artificial Horizon on page 272

Related topics Basics

Avionics Instruments............................................................................................................... 268

HowTos

How to Configure the Artificial Horizon.................................................................................. 108

Aircraft Symbol Properties (Heading Indicator)

Purpose To configure the properties of the aircraft symbol.

Description The aircraft symbol represents the direction of the airplane in the heading
indicator scale.

Properties Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

Size Lets you specify the size of the aircraft symbol.

Visible Lets you specify to display the aircraft symbol.

Related instruments These properties are available for the following instrument:
§ Heading Indicator on page 275

Related topics Basics

Avionics Instruments............................................................................................................... 268

418
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Alignment Property

Purpose To configure the alignment.

Property Alignment Lets you place the scale to the right or to the left.

Related instruments This property is available for the following instruments:


§ Airspeed Indicator on page 268
§ Altimeter on page 270

Related topics Basics

Avionics Instruments............................................................................................................... 268

Alignment/Text Alignment Property (Hierarchy Array)

Purpose To specify the alignment of the content of the selected cell.

Property Alignment/Text alignment Lets you select one of nine options to align the
cell content. Each position is represented by a radio button.

Related instruments This property is available for the following instrument:


§ Hierarchy Array on page 336

Related topics Basics

Basics of Handling the Hierarchy Array.................................................................................... 114

Alternating Row Colors Properties

Purpose To specify alternating row colors for a Variable Array.

419
May 2024 ControlDesk Instrument Handling
Reference Information

Properties Enabled Lets you enable or disable alternating row colors for the Variable
Array.

First background color Lets you specify the background color for the first
and all odd rows.

First foreground color Lets you specify the foreground color for the first and
all odd rows.

Second background color Lets you specify the background color for the
second and all even rows.

Second foreground color Lets you specify the foreground color for the
second and all even rows.

Related instruments These properties are available for the following instrument:
§ Variable Array on page 389

Related topics HowTos

How to Configure the Variable Array...................................................................................... 244

Angle Properties

Purpose To configure the start and stop angles of the circular scale.

Description

α start α stop
(= –120°/240°) (= 120°)

420
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Properties Start angle Lets you specify the angle for the starting point of the circular
scale. The origin of this kind of coordinate system is the 12:00 position. If you
enter negative values, the point moves counterclockwise, otherwise clockwise.
For a gauge, ControlDesk converts each entered value into a positive value
between 0° and 359°. A knob handles values less than 0 by displaying a new
scale level, if necessary.

Stop angle Lets you specify the angle for the end point of the circular scale.
The origin of this kind of coordinate system is the 12:00 position. If you enter
negative values, the point moves counterclockwise, otherwise clockwise. For a
gauge, ControlDesk converts each entered value into a positive value between 0°
and 359°. A knob handles values greater than 359° by displaying the next scale
level, if necessary.

Related instruments These properties are available for the following instruments:
§ Gauge on page 332
§ Knob on page 347

Related topics HowTos

How to Configure the Gauge................................................................................................. 112


How to Configure the Knob................................................................................................... 145

Automatic Sizing Property (Bar, Gauge, Knob, Slider)

Purpose To enable or disable the automatic sizing function.

Property Automatic sizing Lets you specify whether the sizes, positions, and number
of elements in the selected instrument are changed automatically if you change
the size of the instrument or the operating element. The scale is also adjusted
automatically. If the checkbox is selected, the entries for manual sizing are
disabled.

Related instruments This property is available for the following instruments:


§ Bar on page 309
§ Gauge on page 332
§ Knob on page 347
§ Slider on page 368

421
May 2024 ControlDesk Instrument Handling
Reference Information

Related topics Basics

Basics of Handling the Gauge................................................................................................. 110


Basics of Handling the Knob................................................................................................... 143
Basics of Handling the Slider................................................................................................... 162

Automatic Sizing Property (Hierarchy Array)

Purpose To enable or disable automatic sizing of instrument cells.

Property Automatic sizing Lets you enable or disable automatic sizing of instrument
cell. If enabled, the width and height of the cells are automatically adjusted
according to their content. Automatic sizing is disabled automatically if the size
of any cell or the tab bar is modified manually, via tool automation, or via the
Properties pane.

Related instruments This property is available for the following instrument:


§ Hierarchy Array on page 336

Related topics Basics

Basics of Handling the Hierarchy Array.................................................................................... 114

References

Hierarchy Array....................................................................................................................... 336

Axes and Signals Properties (Time Plotter/Index Plotter)

Purpose To configure the properties of the selected axis or signal.

Axes/Signals property Lets you open the Axes/Signals dialog. The defined axes and signals are listed
on the left side of the dialog. Select an axis or signal to specify its properties.

422
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

You can use the following buttons to configure the list.

Button Description
Add Adds a new axis or signal to the list. Select the element to be added
in the drop-down list.
Moves the selected element to the top.

Moves the selected element to the bottom.

Deletes the selected element.

Toolbar A toolbar is displayed above the property list. The buttons let you configure the
view of the list or search for items in the list, for example.

For more details on the toolbar buttons, refer to Toolbar buttons (ControlDesk
User Interface Handling ).

Axes properties Annotation font Opens a dialog for you to select the font of the axis label.
Activate Use custom fonts in the dialog to switch from the default font to the
selected font.

Background color Opens a dialog for you to select a color or enter values to
set one. For more information on the dialog settings, refer to Color Property on
page 452.

Foreground color Opens a dialog for you to select a color or enter values to
set one. For more information on the dialog settings, refer to Color Property on
page 452.

Label (x-axis) Lets you enter a label for the x-axis.

Label (y-axis) Lets you enter a label for the axis. A number of macros are
available in the Macros list, for example:
§ Variable Name, to display the name of the connected variable beside the y-axis
{%VARIABLE%}.
§ Variable Unit, to display the unit of the signal {%UNIT%}.

Label alignment Lets you specify the position of the axis label.

Label font Opens a dialog for you to select the font of the axis label. Activate
Use custom fonts in the dialog to switch from the default font to the selected
font.

Scale label suffix Lets you specify a suffix for each axis label.

Synchronization enabled Lets you activate the synchronization of time,


zoom and move settings of the x-axis in continuous visualization mode. All
synchronized time plotters share the same time range.

423
May 2024 ControlDesk Instrument Handling
Reference Information

Length (Available only for x-axis in continuous mode) Lets you specify the
number of data points that are visible at the x-axis.

Tip

You can specify the length using the scroll wheel of the mouse. Or press
CTRL and the left mouse button and drag the pointer along the x-axis.

Maximum Lets you specify the maximum value of the selected axis.

Minimum Lets you specify the minimum value of the selected axis.

Minimum scrolling (x-axis) Lets you specify the scroll area of the x-axis (in
percent) relative to the entire display area of the plotter.

Name Lets you specify the name of the selected axis.

Scaling mode (Available only for the y-axis) Lets you select the scaling mode
of the axis.

Scaling Description
Mode
Floating The axis range is automatically adjusted. It always shows the
current range of the available data. It can grow and shrink
during the measurement. If you change the axis range during
measurement the automatic scaling is stopped. To start it
again you have to rescale the signal axis, for example, by
double‑clicking it.
Extended The axis range is automatically adjusted. It always shows all the
available data points. It can only grow during measurement. If
you change the axis range during measurement the automatic
scaling is stopped. To start it again you have to rescale the signal
axis, for example, by double‑clicking it.
Fixed The dimensions of the signal axis are set to the values in the
Minimum and Maximum edit fields. These limits are kept
independently of data curves. You can change the axis range
during measurement.

Tic format Lets you select the data format used to display the axis.

Tic Format Description


Standard The values on the axis are shown without an exponent.
Exponential The values on the axis are shown in exponential format.
Scientific The values on the axis are shown in exponential format. The
exponent is always an integer multiple of 3.
SIPrefix The values on the axis are shown with unit prefixes: m (milli), k
(kilo), etc.
Hours (Available only for a Time Plotter) The values on the x-axis are
shown as hours in the format hh:mm:ss.

424
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Signal properties Area line color (Available only if Line style is set to Area or Area staircase)
Lets you specify the color of the area line.

Base line (Available only if Line style is set to Area or Area staircase) Lets
you specify the base line of the area. The area between the base line and the
area line is filled with the selected signal colors.

Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

Colors (Available only if Color style is set to Multicolor or Multicolor


interpolation) Opens the Colors dialog for you to specify a color range for
the signal. Refer to Colors Properties (Time Plotter/Index Plotter) on page 453.

Color style Lets you select if and how the points of the signal should be
graphically connected:

List Entries Description


Solid You can specify one color for the signal via the Color
property.
Multicolor You can specify color ranges for the signal via the Colors
property.
Multicolor You can specify color ranges with smooth color
interpolation transitions for the signal via the Colors property.

Custom Downsampling Lets you enable the downsampling settings of signal


visualization in the instrument's display area. You specify the downsampling
settings via the signal's Display mode and Interval properties.

Note

The downsampling settings apply to signal visualization in the instrument


(visualization downsampling). They enhance the performance of the
instrument by reducing the amount of data to be visualized.
The settings do not influence the amount of measured or recorded
data, only the visualization of the data in the instrument (no DAQ
downsampling).

Display mode Lets you select the downsampling mode that is used to display
the signal.

List Entries Description


Max The maximum value of the values in the downsampling interval is
displayed.
Mean The mean value of the values in the downsampling interval is
displayed.
Min The minimum value of the values in the downsampling interval is
displayed.
Min/Max The minimum and the maximum value of the values in the
downsampling interval are displayed.

425
May 2024 ControlDesk Instrument Handling
Reference Information

If you want to enable or disable downsampling, use the signal's Custom


downsampling property.

Enabled Lets you specify to display a signal in the plot. If a signal is disabled it
is ignored when the y-axis is scaled.

Hide points if too close Lets you specify to hide signal points if the settings
for the point style and point size cause the signal points to overlap.

Note

§ If a signal is assigned to the OnChange measurement raster, signal points


cannot be hidden.
§ If a signal is assigned to an event raster, the minimum sampling period
must be set to an appropriate value. Signal points might overlap if the
minimum sampling period is too long, or they might be hidden too
early if it is too short.

Index offset (Available for recorded data only) Lets you specify an offset
value for the index.

Interval Lets you specify the length of the downsampling interval (Time
Plotter: time interval in seconds, Index Plotter: number of data points). If
you want to enable or disable downsampling, use the signal's Custom
downsampling property.

Line width Lets you select the width of the signal's line in pixels.

Line style Lets you select if and how the points of the signal should be
graphically connected:

List Entries Description


None Data points are not graphically connected.
Direct Data points are connected by a direct line. This is the default
setting for measurement variables.
Staircase Data points are connected by a staircase line.
Area Data points are connected by a direct area line. The area
between the base line and the area line is filled with the signal
colors.
§ Via Base line, you can change the position of the base line.
§ Via Area line color, you can select a contrasting color for the
area line.
Area Data points are connected by a staircase area line. The area
Staircase between the base line and the area line is filled with the signal
colors.
§ Via Base line, you can change the position of the base line.
§ Via Area line color, you can select a contrasting color for the
area line.

426
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Name Lets you specify the name of the signal.

Point size Lets you select the size of the signal's points in pixels.

Point style Lets you select the style of the signal’s points. If you select user
defined, you can select an image via the Point style image property.

Point style image (Available only if Point style is set to user defined) Lets
you select an image for the signal's points.

Smooth mode enabled Lets you smooth the signal visualization.

Time offset (Available only for recorded data) Lets you specify an offset value
for the time.

Visibility properties To configure the visibility of axis elements.

Label visible Lets you show/hide the axis label (annotation).

Scale visible Lets you show/hide the axis scale.

Scale label visible Lets you show/hide the scale label.

Signal symbol visible (Available only for y-axis) Lets you show/hide the signal
symbol.

Related instruments These properties are available for the following instruments:
§ Index Plotter on page 341
§ Time Plotter on page 384

Axes Properties (3-D Viewer)

Purpose To configure the properties of the selected axis.

Coordinate system property Lets you select one of the following coordinate systems for the instrument:

Coordinate System Description


Left-handed (y‑axis up) § x pointing to the right
§ y pointing upwards
§ z pointing backwards
Right-handed (z‑axis § x pointing backwards
up) § y pointing to the left
§ z pointing upwards
This coordinate system complies with the automotive
coordinate system according to the DIN 70000
standard.

427
May 2024 ControlDesk Instrument Handling
Reference Information

Note

Select the instrument coordinate system before you specify other instrument
properties. Otherwise, you might have to modify these properties
afterwards.

Axis properties Visible Lets you specify whether the axis is displayed.

Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

Title Lets you configure a title for the axis to be displayed. Refer to Title
Properties on page 559.

Length Lets you specify the length of the axis.

Maximum Lets you specify the maximum value of the axis.

Minimum Lets you specify the minimum value of the axis.

Synchronization mode Lets you specify how the minimum and maximum
values of the selected axis change, when the axis range of another axis is
modified.

Synchronization Purpose
mode
Disabled The minimum and maximum values of the axis do not
change.
Keep minimum Only the maximum value changes in order to match
the proportion of the modified axis.
Keep maximum Only the minimum value changes in order to match
the proportion of the modified axis.
Proportional Both minimum and maximum value change in order
to match the proportion of the modified axis.

Fixed axis range Lets you specify whether the minimum and maximum
values of the axis are fixed. If the axis range is fixed, you cannot use mouse
commands to change the minimum and maximum values of the axis.

Note

Enabling the Synchronization mode can result in a change of the


minimum and maximum value of the axis even if the Fixed axis range
property is enabled.

Reverse direction Lets you specify whether the axis direction is reversed.

Tic color Opens a dialog for you to select a color or enter values to set
one. For more information on the dialog settings, refer to Color Property on
page 452.

428
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Major tics properties To configure the properties of the major tics.

Delta Lets you specify the delta between two major tics.

Note

The actual number of displayed major tics can vary depending on the
camera settings.

Length Lets you specify the length of the major tics.

Minor tics properties To configure the properties of the minor tics.

Count Lets you specify the number of minor tics between two major tics.

Length Lets you specify the length of the minor tics.

Related instruments These properties are available for the following instruments:
§ 3-D Viewer on page 303

Related topics Basics

Basics of Handling the 3-D Viewer............................................................................................ 55


Selecting the Coordinate System.............................................................................................. 62

HowTos

How to Add an Item and Configure the Item Properties ........................................................... 79

References

3-D Viewer............................................................................................................................. 303

Axes Properties (Table Editor)

Purpose To configure the properties of the axes in the Table Editor.

Alert axis monotony violation Alert axis monotony violation Lets you specify whether ControlDesk
property displays a warning if you change an axis value and the entered value violates
the axis monotony.
§ If enabled, ControlDesk opens the Axis Monotony Violation dialog, which
lets you decide whether to write the value. If you accept to write the value, the

429
May 2024 ControlDesk Instrument Handling
Reference Information

Table Editor no longer displays a chart (either 2-D or 3-D) but tells you which
axis is inconsistent.
§ If disabled, the value is written without a warning. The Table Editor displays
only 2-D charts. Instead of a 3-D chart, a text stating which axis is inconsistent
is displayed.

Interpolation mode property Interpolation mode Lets you specify whether the function values should
be interpolated when you change an axis point. If you choose Ask user,
ControlDesk opens the Interpolation dialog each time you change an axis
point. The dialog lets you decide whether to interpolate the function values.

Axis Properties Lets you specify the properties of the selected axis.

Label (Available for x-axis, y-axis, z-axis, and data axis) Lets you enter the
label for each axis in the edit field. The following table shows special macros that
you can use for labeling.

Macro Text Axis Label


{%VARIABLE%} Name of the variable
{%VARIABLE_X-AXIS%} Name of the variable connected to the x-axis.
{%VARIABLE_Y-AXIS%} Name of the variable connected to the y-axis.
{%VARIABLE_WPOINTX%} Name of the working point variable for the x‑axis.
{%VARIABLE_WPOINTY%} Name of the working point variable for the y‑axis.
{%UNIT_WPOINTX%} Unit of the working point variable for the x‑axis.
{%UNIT_WPOINTY%} Unit of the working point variable for the y‑axis.
{%UNIT_FUNC%} Unit of the variable connected to the data axis.
{%UNIT_X-AXIS%} Unit of the variable connected to the x-axis.
{%UNIT_Y-AXIS%} Unit of the variable connected to the y-axis.
{%XAXIS_DEFAULTLABEL%} Name and unit of the working point variable for the x-axis, if a
working point is defined. Otherwise, 'X-Axis'.
{%YAXIS_DEFAULTLABEL%} Name and unit of the working point variable for the y-axis, if a
working point is defined. Otherwise, 'Y-Axis'.

Label visible (Available for x-axis, y-axis, z-axis, and data axis) Lets you specify
whether the labels of the axis are displayed.

Max. (Available only if the scaling mode of the data axis is set to Fixed) Lets
you specify the maximum value of the data axis in the 2‑D and 3‑D views.

Min. (Available only if the scaling mode of the data axis is set to Fixed) Lets
you specify the minimum value of the data axis in the 2‑D and 3‑D views.

Scaling mode Lets you select the scaling mode of the data axis in the 2‑D
and 3‑D views.

Mode Description
Floating The range of the data axis always shows the current
range of the function values. The axis range increases
and decreases when the function values are changed.

430
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Mode Description
Extended The range of the data axis shows the range of the
function values. The axis range can only increase.
Fixed The range of the data axis is set to the values of the
Min and Max properties. These limits are kept no
matter what the current range of the function values
is.

Related instruments These properties are available for the following instrument:
§ Table Editor on page 379

Related topics HowTos

How to Connect Multidimensional Table Data to the Table Editor........................................... 196

Axis Color Property (XY Plotter)

Purpose To select a color for axis and grid elements.

Axis Color Property Axis Color Opens a dialog for you to select a color or enter values to set
one. For more information on the dialog settings, refer to Color Property on
page 452.

Related instruments This property is available for the following instrument:


§ XY Plotter on page 396

Axis Properties (XY Plotter)

Purpose To configure the properties of the axes in the XY Plotter.

Axes property Axes Lets you open the Axes dialog. The axes are listed on the left side of
the dialog. Select an axis to specify its properties. The buttons in the dialog are
disabled, since you cannot change the axes list of an XY Plotter.

431
May 2024 ControlDesk Instrument Handling
Reference Information

Toolbar A toolbar is displayed above the property list. The buttons let you configure the
view of the list or search for items in the list, for example.

For more details on the toolbar buttons, refer to Toolbar buttons (ControlDesk
User Interface Handling ).

Selected axis properties To configure the properties of the selected axis.

Annotation font (Available only if Use custom fonts is enabled) Lets you
select the font of the axis label.

Label Lets you specify the label of the selected axis. You can use the
following macros.

Macro Description
{%BLOCK%} Block name of the variable
{%DATATYPE%} Data type of the variable
{%DEVICE%} Name of the connected platform/device
{%PATH%} Path of the variable
{%UNIT%} Unit of the variable
{%VARIABLE%} Name of the variable

Label font (Available only if Use custom fonts is enabled) Lets you select the
font of the scale labels.

Maximum Lets you specify the maximum value of the axis for the Fixed
scaling mode. In the Floating or Extended scaling mode the current maximum
is displayed.

Minimum Lets you specify the minimum value of the axis.

Name Displays the name of the selected axis.

Scaling mode Lets you select the scaling mode of the axis.

Scaling Description
Mode
Floating The axis range always shows the current range of the displayed
data. It can grow and shrink during measurement.
Extended The axis range always shows the current range of the displayed
(Default data. It can only grow during measurement. To rescale a signal
mode) axis to display the currently available curves, double‑click it.
Fixed The dimensions of the signal axis are set to the values of
the Minimum and Maximum axis properties. These limits are
kept independently of data curves.

432
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Tic format

Tic Format Description


Standard The values on the axis are shown without an exponent.
(Default format)
Exponential The values on the axis are shown in exponential format.
Scientific The values on the axis are shown in exponential format. The
exponent is always an integer multiple of 3.

Related instruments These properties are available for the following instrument:
§ XY Plotter on page 396

Background Properties

Purpose To configure the background properties of the current instrument.

Description You can set the background color, the transparency property, or a background
image.

Color property Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

Picture properties To specify whether to use an image/animated GIF for the instrument's
background and to specify its properties. Refer to Picture Properties on page 512.

Transparent property Transparent / Background transparent Lets you specify whether to make
the instrument background transparent. If enabled, you can see (and click) other
instruments or the layout under the transparent instrument. Background color
settings are disabled.

Related instruments These properties are available for various instruments.

Bands Properties

Purpose To specify the properties of colored bands for the highlighting of value ranges.

433
May 2024 ControlDesk Instrument Handling
Reference Information

Description You can highlight value ranges with colored bands.

Bands list On the left side of the dialog, the defined bands are listed. Select a band to
specify its properties.

You can use the following buttons to configure the list.

Button Description
Add Adds a new band to the top of the list.
Moves the selected band to the top (foreground). If
bands overlap each other, the one nearest the top
covers the other.
Moves the selected band to the bottom
(background). If bands overlap each other, the one
nearest the top covers the other.
Deletes the selected band.

Properties Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

Max. value (Available only if the Fill to Origin display mode is not selected)
Lets you specify the maximum (end) value of the selected band. Depending on
the selected mode, you specify either a percentage or an absolute value. For
absolute values, you can toggle between source or converted format. Click the
icon next to the edit field to specify the value in source format ( icon) or in
converted format ( icon).

Min. value (Available only if the Fill to Origin display mode is not selected)
Lets you specify the minimum (start) value of the selected band. Depending on
the selected mode, you specify the value either as a percentage or an absolute
value. For absolute values, you can toggle between source or converted format.
Click the icon next to the edit field to specify the value in source format ( icon)
or in converted format ( icon).

Mode The list entries define the display mode of the selected band. The
following modes are available:

List Entries Description


Fill to Origin To fill the band from the origin to the current
value. Enables the Origin edit field, where you
can specify a value for the origin of the band.
Percentual To define a band between the Min and Max
values as a percentage of the scale. The band
is displayed in relation to the scale (beginning,
center, or end). If you change the scale’s value
range, the band’s range is automatically adjusted.
It is always displayed completely.

434
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

List Entries Description


Absolute To define a band between the Min and Max
values in absolute values of the scale. The band
remains at the same value range inside the scale.
If you modify the scale’s value range, the band
might then be displayed incompletely.

Origin (Available only if the Fill to Origin display mode is selected) Lets you
specify the point of origin for the selected band.

Position Lets you select the position of the band:

List Entries Description


Behind Minor Tics Displays the band behind the minor tics.
Behind Major Tics Displays the band behind the major tics.
Behind labels Displays the band behind the labels.
Behind scale Displays the band behind the scale.
Inside instrument Displays the band inside the circle/slidebar.
Custom Displays the band between the Relative start
position and the Relative end position (see
below).

Relative end position (Available only if the Custom band position is


selected) Lets you specify the end position of the band as a percent value in
relation to the center of the circle scale or slidebar.

Relative start position (Available only if the Custom band position is


selected) Lets you specify the start position of the band as percent value relative
to the center of the circlescale or slidebar.

Visible Lets you specify whether the selected band is visible.

Related instruments These properties are available for the following instruments:
§ Bar on page 309
§ Gauge on page 332
§ Slider on page 368
§ Knob on page 347

Related topics Basics

Basics of Handling the Gauge................................................................................................. 110


Basics of Handling the Knob................................................................................................... 143
Basics of Handling the Slider................................................................................................... 162

435
May 2024 ControlDesk Instrument Handling
Reference Information

Bands Properties (Airspeed Indicator)

Purpose To configure the properties of the bands.

Description You can mark different speed ranges with differently colored bands.

Properties Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

End position Lets you specify the end position of the selected band.

End value Lets you specify the end value of the selected band.

Start position Lets you specify the start position of the selected band.

Start value Lets you specify the start value of the selected band.

Visible Lets you specify whether the selected band is displayed.

Related instruments These properties are available for the following instrument:
§ Airspeed Indicator on page 268

Related topics Basics

Avionics Instruments............................................................................................................... 268

Bitmask Properties

Purpose To specify the bitmask properties for the selected variable.

Properties Enabled (Applicable only if the connected variable is in source mode) Lets
you enable a bitmask for the currently selected variable. A bitmask specifies
which bits of a variable are to be read.

Number of bits (Available only if the connected variable is in source mode)


Lets you specify the bitmask width by entering a number of contiguous 1-bits.

Start bit (Available only if the connected variable is in source mode) Lets you
specify the start bit of the bitmask. You can select a bit offset for the bitmask,
counting from the right side of the bitmask.

436
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Example The following example shows the result of different bitmask settings:

Data Type No. of Bits Start Bit Bitmask Hex


8-bit 4 0 00001111 F
8-bit 4 2 00111100 3C
16-bit 5 5 0000001111100000 3E0

Bitmasks are always interpreted as unsigned, even if the data type of the variable
is a signed one.

Related instruments These properties are available for the following instruments:
§ Bar on page 309
§ Gauge on page 332
§ Variable Array on page 389

Border Properties

Purpose To configure the border settings of an instrument.

Properties Auto hide Lets you specify whether to hide the borders of small instruments
(smaller than 20 x 20 pixels).

Bevel width Lets you change the width of the border bevels in pixels.

Border width Lets you change the width of the border in pixels.

Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

Enabled Lets you specify whether a border is displayed.

Inner bevel style Lets you select the style of the inner border bevel:

Style Description
None To switch off the inner bevel.
Raised To raise the instrument from the background.
Sunken To sink the instrument into the background.

Outer bevel style Lets you select the style of the outer border bevel:

Style Description
None To switch off the outer bevel.
Raised To raise the instrument from the background.
Sunken To sink the instrument into the background.

437
May 2024 ControlDesk Instrument Handling
Reference Information

Related instruments These properties are available for various instruments.

Browser Properties

Purpose To configure the Browser-specific properties.

Properties Navigation allowed Lets you enable or disable the navigation links on a
displayed page.

Scroll bar visible Lets you specify to display a vertical and/or horizontal scroll
bar if the content of a page is not fully visible in the Browser.

Start URL Lets you specify the page to display when you click the Browser's
home button or open the Browser's layout. Click the Browse button to select a
page from the file system. If a start file is specified for the Browser's file archive,
it is referenced here.

Toolbar visible Lets you specify to display the Browser's toolbar.

URL Displays the URL of the page that is currently displayed in the Browser.
You can enter another URL to change the displayed page. Click the Browse
button to select a page from the file system.

Related instruments These properties are available for the following instrument:
§ Browser on page 312

Related topics Basics

Basics on Handling the Browser................................................................................................ 97

Button Cell Properties (Value Cell – Button)

Purpose To configure the button properties of the selected Check button, On/Off button,
or Push button cell.

Properties Display value Lets you specify whether to display the current value of the
selected variable. When enabled, the value of the variable is displayed in round
brackets behind the button label.

438
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Off value Lets you specify the value to be set when you release/clear the
button. Click the icon next to the edit field to specify the value in source format
( icon) or in converted format ( icon).

On value Lets you specify the value to be set when the button is
pressed/selected. Click the icon next to the edit field to specify the value in
source format ( icon) or in converted format ( icon).

Button text/Text Lets you specify the text for the button label.

Value Lets you specify the value to be set when you press the Push button.
Click the icon next to the edit field to specify the value in source format ( icon)
or in converted format ( icon).

Related instruments These properties are available for the following instrument:
§ Hierarchy Array on page 336
§ Variable Array on page 389

Related topics Basics

Basics of Handling the Hierarchy Array.................................................................................... 114


Basics of Handling the Variable Array...................................................................................... 241

Button Color Property

Purpose To specify the color of the selected button.

Property Button color Lets you specify a default color for the buttons of the selected
instrument. If you want to customize the color of a single button, select Use
custom style via the Buttons properties. For details on the dialog settings, refer
to Color Property on page 452.

Related instruments This property is available for the following instruments:


§ On/Off Button on page 359
§ Push Button on page 361

Related topics Basics

Basics of Handling the On/Off Button..................................................................................... 156

439
May 2024 ControlDesk Instrument Handling
Reference Information

Button Style Property

Purpose To specify the appearance of the button.

Property Button style Lets you specify the appearance of the button.

Related instruments This property is available for the following instruments:


§ On/Off Button on page 359
§ Push Button on page 361

Related topics Basics

Basics of Handling the On/Off Button..................................................................................... 156

Button Style Settings Properties (Check Button)

Purpose (Available only if Check box style is set to Button) To configure the button style.

Description To configure the button style.

Button Style Settings Button style Lets you specify the appearance of a button.
Properties

State settings Color Lets you specify a button color for each button state. For details on the
dialog settings, refer to Color Property on page 452.

Off-State settings Lets you specify the button settings for a released button.

On-State settings Lets you specify the button settings for a pressed button.

Picture Lets you specify whether to use an image or animated GIF for a
specific button state and lets you specify its properties. For details, refer to
Picture Properties on page 512.

Text Lets you specify a button text for each button state.

Text color Lets you specify a text color for each button state. For details on
the dialog settings, refer to Color Property on page 452.

Undefined-State settings Lets you specify the button settings for a button
in an undefined state.

440
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Related instruments These properties are available for the following instrument:
§ Check Button on page 319

Buttons Properties

Purpose To configure the buttons of the selected instrument.

Buttons list On the left side of the dialog all defined instrument buttons are listed.

You can use the following dialog buttons to configure the list.

Button Description
Add Adds a new button to the bottom of the list.
Moves the selected button to the top.

Moves the selected button to the bottom.

Deletes the selected button.

Button properties Text Lets you specify the text displayed on the selected button or behind the
button.

Text on right side (Available only for Radio buttons) Lets you position the
text on the right side of the button. If the checkbox is cleared, the text is
positioned on the left side of the button.

Value Lets you specify the value to be written to the connected variable when
you press the button. Click the icon next to the edit field to specify the value in
source format ( icon) or in converted format ( icon).

Word wrap Lets you specify to break text lines of the selected button
automatically. If the button text does not fit into one line, it is wrapped to
the next line. If the selected font is too large for the amount of text and the
instrument size, the button text is not displayed completely.

Use custom style Lets you specify custom style properties for the selected
button.

Style/ Checked state style/ Color (Available only if Use custom style is selected) Lets you specify the
Unchecked state style color of the button. For details on the dialog settings, refer to Color Property on
properties page 452.

Text color (Available only if Use custom style is selected) Lets you specify the
color of the text. For details on the dialog settings, refer to Color Property on
page 452.

441
May 2024 ControlDesk Instrument Handling
Reference Information

Picture (Available only if Use custom style is selected) Lets you specify
whether to use an image or animated GIF for the button (for each state of a
radio button) and to specify its properties. For details on the dialog settings, refer
to Picture Properties on page 512.

Related instruments These properties are available for the following instruments:
§ On/Off Button on page 359
§ Push Button on page 361
§ Radio Button on page 363

Related topics Basics

Basics of Handling the On/Off Button..................................................................................... 156

References

On/Off Button........................................................................................................................ 359


Push Button............................................................................................................................ 361
Radio Button.......................................................................................................................... 363

Camera Properties

Purpose To configure the camera properties.

Properties Distance Lets you specify the distance between the camera position and
the displayed items. If you connect a variable with this property, the variable
properties are displayed instead. You can specify some of the variable properties.

Rotation Lets you rotate the camera around the selected axis.

X rotation Lets you rotate the camera around the x-axis. If you connect a
variable with this property, the variable properties are displayed instead. You can
specify some of the variable properties.

Y rotation Lets you rotate the camera around the y-axis. If you connect a
variable with this property, the variable properties are displayed instead. You can
specify some of the variable properties.

Z rotation Lets you rotate the camera around the z-axis. If you connect a
variable with this property, the variable properties are displayed instead. You can
specify some of the variable properties.

Position Lets you move the center of the frame along the selected axis.

X position Lets you move the center of the frame along the x-axis. If you
connect a variable with this property, the variable properties are displayed
instead. You can specify some of the variable properties.

442
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Y position Lets you move the center of the frame along the y-axis. If you
connect a variable with this property, the variable properties are displayed
instead. You can specify some of the variable properties.

Z position Lets you move the center of the frame along the z-axis. If you
connect a variable with this property, the variable properties are displayed
instead. You can specify some of the variable properties.

Angle Lets you select a camera angle from a set of default settings.

Fixed camera Lets you specify whether the camera properties can be
changed using the mouse commands.

Mouse command Purpose


Hold the middle mouse button and move To move the center of the frame.
the pointer.
Hold the left mouse button and move the To rotate the camera.
pointer.
Turn the mouse wheel. To change the camera distance.

Orthographic Lets you specify whether to display the 3-D environment as an


orthographic projection.

Target (Available only if no variable is connected to the camera position


properties) Lets you specify an item for the camera to follow. The distance and
rotation relative to the item remains constant.

Related instruments These properties are available for the following instruments:
§ 3-D Viewer on page 303

Related topics Basics

Basics of Handling the 3-D Viewer............................................................................................ 55

References

3-D Viewer............................................................................................................................. 303

Captions/Operating Elements Properties

Purpose To add and remove captions and configure the properties of operating elements.

Description A caption is a text frame on the instrument’s background. Captions are used as
describing elements for an instrument. You can insert macro variables into the
caption text, for example, to display the name or the value of a variable.

443
May 2024 ControlDesk Instrument Handling
Reference Information

An instrument usually has one operating element, such as a slidebar, that


displays the variable value and, if writable, lets you change it.

Captions and operating On the left side of the dialog, the operating element and all defined captions are
elements list listed. Select an element to specify its properties.

You can use the following buttons to configure the list.

Button Description
Add Adds a new caption element to the top of the list.
Moves the selected element to the top (foreground).
If operating elements overlap each other, the one
nearest the top covers the other.
Moves the selected element to the bottom
(background). If elements overlap each other, the one
nearest the top covers the other.
Deletes the selected caption. The operating element
cannot be deleted.

Size and position view In the middle of the dialog, you can change the size and position properties of
captions and operating elements graphically by dragging them with the pointer.

You can use the following buttons:

Button Description
Moves the operating element to the top of the
instrument and places the caption(s) below it.
Moves the operating element to the right side of the
instrument and places the caption(s) to the left of it.
Moves the operating element to the left side of the
instrument and places the caption(s) to the right of it.
Moves the operating element to the bottom of the
instrument and places the caption(s) above it.
Enables or disables the snapping function of the
element frames. If snapping is enabled, a frame
can snap to another frame and you can drag them
together.

Caption properties Alignment Lets you select one of the nine options to align the caption text
inside the caption frame. Each position is represented by a button.

Automatic sizing Lets you specify whether the font size of the selected
caption is adjusted automatically when the caption’s frame is resized or the
caption’s text is changed. If this checkbox is cleared, the font size will remain
unchanged and not all of the text might be displayed when the caption’s frame
size is reduced.

444
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

Font Lets you specify the font for the selected caption. If the element uses
the general font settings from the ControlDesk Options dialog, select Use
custom font settings to make the font settings in the dialog available.

Text Lets you specify the default text for the caption of the selected
instrument. You can use macros for the caption text.

Macro Description
{%BLOCK%} Block name of the variable
{%CONBLOCK%} § If a variable was initially connected to the instrument, the macro
returns the block name of the variable.
§ If a framework label was initially connected to the instrument, the
macro returns nothing.
{%CONNECTION%} § If a variable was initially connected to the instrument, the macro
returns the name of the variable.
§ If a framework label was initially connected to the instrument, the
macro returns the name (ID) of the framework label .
{%CONUNIT%} § If a variable was initially connected to the instrument, the macro
returns the unit of the variable.
§ If a framework label was initially connected to the instrument, the
macro returns the unit of the framework label .
{%DATATYPE%} Data type of the variable
{%DESCRIPTION%} Description text of the variable (from the variable description file)
{%DEVICE%} Name of the connected platform/device
{%DISPLAYMODE%} Display mode of the variable
{%INDEX%} Index position of a variable in a measurement array or value block.
{%INSTRUMENT%} Name of the instrument
{%INSTRUMENTDESCRIPTION%} Description text of the instrument (from the instrument properties)
{%MAXHARDLIMIT%} Maximum hard limit of the variable
{%MAXVALUE%} Maximum of the measured value
{%MAXWEAKLIMIT%} Maximum weak limit of the variable
{%MINHARDLIMIT%} Minimum hard limit of the variable
{%MINVALUE%} Minimum of the measured value
{%MINWEAKLIMIT%} Minimum weak limit of the variable
{%MODE%} Conversion mode of the variable
{%ORIGINPATH%} Path of the variable that was originally connected to the instrument. Lets
you identify the originally connected variable if it was replaced by the
variable it references.
{%PATH%} Path of the variable.
You can use indices to filter slash-separated parts of the path. For
example:
§ {%PATH[0]%} extracts the first part of the path up to the first slash.
§ {%PATH[-2]%} extracts the second-last part of the path.
{%READONLY%} Variable is read-only (ro) or not
{%STRUCT%} Name of the variable together with the relevant parts of the struct (if the
variable is part of a struct). The struct parts are separated by a dot, for
example: MyStruct.MySubstruct.MyParameter.

445
May 2024 ControlDesk Instrument Handling
Reference Information

Macro Description
You can use indices to filter parts of the struct. For example:
§ {%STRUCT[0]%} extracts the first part of the struct up to the first dot.
§ {%STRUCT[-2]%} extracts the second-last part of the struct.
{%UNIT%} Unit of the variable
{%UNIT%}{%DISPLAYMODESOURCE%} Unit and display mode of the variable
{%VALUE%} Value of the variable
{%VARIABLE%} Name of the variable

To modify the display of numeric values, you can use Printf expressions.
Put the Printf expression in angle brackets and insert it after the first % character
of a macro as shown in the following example:
{%<%.2f>VALUE%}
In this example, the <%.2f> expression modifies the {%VALUE%} macro so that
decimal floating point numbers with 2 digits are displayed.
The following table shows the supported Printf expressions:

Printf Expression Description


%d Decimal integer
%i Decimal integer
%u Unsigned integer
%o Octal integer
%x, %X Hexadecimal integer
%b Binary integer
%f Floating point
%e, %E Exponential floating point
%g, %G Floating point of the formats %f or %e

Size and position properties Lets you configure the position of the operating element or caption (if available).

Height Lets you specify the height of the selected element (as a percentage
of the instrument height). If you enter a value that is too large in relation to the
y-position of the element, it is reduced to the maximum value.

Width Lets you specify the width of the selected element (as a percentage
of the instrument width). If you enter a value that is too large in relation to the
x-position of the element, it is reduced to the maximum value.

X Lets you specify the horizontal position of the left frame of the selected
element (as a percentage of the instrument width). If you enter a value that is
too large in relation to the width of the element, it is reduced to the maximum
value.

Y Lets you specify the vertical position of the upper frame of the selected
element (as a percentage of the instrument height). If you enter a value that is
too large in relation to the height of the element, it is reduced to the maximum
value.

446
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Related instruments These properties are available for various instruments.

Cell Properties

Purpose To specify cell properties.

Cells list The defined cells are listed on the left-hand side of the dialog. Select a cell to
specify its properties.

You can use the following buttons to configure the list.

Button Description
Add Adds a new cell to the list.
Moves the selected element up in the list.

Moves the selected element down in the list.

Deletes the selected element.

Toolbar A toolbar is displayed above the property list. The buttons let you configure the
view of the list or search for items in the list, for example.

For more details on the toolbar buttons, refer to Toolbar buttons (ControlDesk
User Interface Handling ).

Misc To configure the properties of the selected cells. In addition to cell-type-specific


settings, you can specify the following properties:

Cell type Lets you select the cell type.


The following cell types are available:

Cell Type Illustration Description


Alphanumeric Input To edit and display the value of a scalar parameter or the text content
of an ASCII variable.
Bar To display the value of a scalar variable as a bar deflection.

Bitfield To edit and display the source value of a parameter as a bit string.

Check button To set the variable value to a predefined value when you select the
checkbox (On) and when you clear it (Off), and to display whether one

447
May 2024 ControlDesk Instrument Handling
Reference Information

Cell Type Illustration Description


of the predefined values is the current value of the connected variable.
If this is not the case, the value is grayed out.
Display To display the value of a scalar variable or the text content of an ASCII
variable.
Icon To display an icon or other image.

Label To display label text.

Multistate LED To display the value of a variable as an LED state.

On/Off button To set the variable value to a predefined value when you press the
button (On) and when you release the button (Off).
Push button To set the variable to a predefined value when you press the button.

Selection box To select a text-value entry and set the respective numerical value for
the connected variable.
Slider To edit and display the value of a scalar parameter on a slide.

Column span Lets you specify how many columns the cell spans.

Foreground color Lets you specify the foreground color, i.e., text color of the
selected cell.
Refer to Color Property on page 452.

Background color Lets you specify the background color of the selected cell.
Refer to Color Property on page 452.

Variable To configure the variable that is connected to the cell.


Refer to Variables Properties on page 562.

Related instruments These properties are available for the following instrument:
§ Hierarchy Array on page 336

Related topics Basics

Basics of Handling the Hierarchy Array.................................................................................... 114

Cell Properties (Bus Instrument)

Purpose To specify the properties of the selected cells.

448
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Property Cell properties Opens a dialog to specify the properties of the selected cell.
You can change the cell type and configure properties accordingly.

Related instruments These properties are available for the following instrument:
§ Bus Instrument on page 315

Related topics HowTos

How to Configure a Bus Instrument (ControlDesk Bus Navigator )

Cell Type Property (Variable Array)

Purpose To select a type for the selected value cell.

Property Cell type Lets you select a type for the selected value cell.
The following cell types are available:

Value Cell Type Illustration Description


Alphanumeric To edit and display the value of a scalar
Input parameter or the text content of an
ASCII variable.
Bar To display the value of a scalar variable
via a bar deflection.

Bitfield To edit and display the source value of a


parameter as a bit string.
Check Button To set the variable's value to a
predefined value when you activate the
checkbox (On value) and when you
clear it (Off value), and to display if one
of the predefined values is the current
value of the connected variable (if not,
it is grayed).
Display To display the value of a scalar variable
or the text content of an ASCII variable.
Multistate LED To display the value of a variable as an
LED state.
On/Off Button To set the variable's value to a
predefined value when you press the
button (On value) and when you
release the button (Off value).

449
May 2024 ControlDesk Instrument Handling
Reference Information

Value Cell Type Illustration Description


Push Button To set the variable's value to a
predefined value when you press the
button.
Slider To edit and display the value of a scalar
parameter by a slide.

Related instruments This property is available for the following instrument:


§ Variable Array on page 389

Related topics Basics

Basics of Handling the Variable Array...................................................................................... 241

Center Point X Property

Purpose To configure the center point's position on the x-axis.

Description The elements of the Artificial Horizon align themselves in relation to the center
point. The center point X value specifies the center point's position to the left or
right in the instrument.

Property Center point X Lets you specify the center point's position on the x-axis .The
position on the x-axis can be adjusted within the instrument, the instrument
itself is not repositioned on the layout. The valid values are between 0% and
100%, with 0% as the position on the left border and 100% as the position on
the right border.

Related instruments This property is available for the following instrument:


§ Artificial Horizon on page 272

Center Point Y Property

Purpose To configure the center point's position on the y-axis.

450
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Description The elements of the Artificial Horizon align themselves in relation to the center
point. The center point Y value specifies the center point's position to the top or
to the bottom in the instrument.

Property Center point Y Lets you specify the center point's position on the y-axis.
The position on the y-axis can be adjusted within the instrument, the instrument
itself is not repositioned on the layout. The valid values are between 0% and
100%, with 0% as the position on the top border and 100% as the position on
the bottom border.

Related instruments This property is available for the following instrument:


§ Artificial Horizon on page 272

Check Box Style Property

Purpose To specify whether to display a checkbox or a button in the instrument.

Properties Check box style Lets you specify whether to display a checkbox or a button
in the instrument.

Related instruments This property is available for the following instrument:


§ Check Button on page 319

Clip Content Property

Purpose To select whether items are clipped when they expand beyond the area defined
by the axes.

Property Clip content Lets you select whether items are clipped when they expand
beyond the area defined by the axes.

Related instruments These properties are available for the following instruments:
§ 3-D Viewer on page 303

451
May 2024 ControlDesk Instrument Handling
Reference Information

Related topics References

3-D Viewer............................................................................................................................. 303

Color Property

Purpose To specify the color of the selected item.

Property Color Opens a dialog where you can select a color or enter values to define
one. You can also drag the pipette symbol to pick a color from anywhere on the
screen.
If the element uses the general color settings from the ControlDesk Options
dialog, to make the color settings in the dialog available.
To make the color settings of the ControlDesk Options dialog available in this
dialog, select Use custom color settings.
If available, you can use the Alpha value to specify the transparency of the
element. Decrease the value to increase the transparency.
If available, you can use the color gradient to specify smooth color transitions.
Click the +-button to add a mark to the gradient, select a color for the mark,
and drag the mark to the desired position. To delete a mark, select it and press
Delete.

Related instruments This property is available for various instruments.

452
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Colors Properties (Time Plotter/Index Plotter)

Purpose (Only available if Color style is set to a multicolor setting) To specify a color
range for the signal.

Colors list All the defined colors are listed on the left side of the dialog.

You can use the following dialog buttons to configure the list.

Button Description
Add Adds a new color to the bottom of the list.
Deletes the selected color.

Toolbar A toolbar is displayed above the property list. The buttons let you configure the
view of the list or search for items in the list, for example.

For more details on the toolbar buttons, refer to Toolbar buttons (ControlDesk
User Interface Handling ).

Properties Axis max. value Displays the maximum value of the axis.

Axis min. value Displays the minimum value of the axis.

Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

Value Lets you specify the start value for the selected color. The color is set
for all values above this start value up to the start value of the next color or, if no
further color is defined, up to the maximum. If only one color is defined in the
list, the signal gets that color and the value setting is ignored.

Related instruments These properties are available for the following instruments:
§ Index Plotter on page 341
§ Time Plotter on page 384

Column Header Height Property

Purpose To specify the height of the first row of the Variable Array.

453
May 2024 ControlDesk Instrument Handling
Reference Information

Property Column header height Lets you specify the height of the first row of the
Variable Array.

Related instruments This property is available for the following instrument:


§ Variable Array on page 389

Related topics Basics

Basics of Handling the Variable Array...................................................................................... 241

Connection Assignment Properties

Purpose To specify the assignment of variables to an instrument or an instrument group.

Properties Enabled Lets you enable the connection assignment, i.e., the assignment
of variables to an instrument or instrument group. This allows you to create
tailor-made instrument groups for a struct or a block group, for example.
If you create an instrument group that exactly matches to the single variables
of a struct or a block group, you can connect all the variables in one step by
dragging the struct or block group onto the instrument group.
If the struct or block group offers improper variables, the matching variables are
connected and the improper variables are ignored.

Mode (Only available if Connection assignment is enabled) Lets you specify


whether to select the variable to connect by the ending of the variable path, by
a regular expression, or by a substring contained in the URI. This allows you to
use relative paths for the connection of variables to instruments, for example,
to connect variables of a block group or a struct to a customized instrument
group. Searching for a substring contained in the URI also allows you to connect
framework labels to instruments regardless of whether the variable mappings
between framework labels and model variables are resolvable or not.

Path ends with (Only available if the connection assignment mode is set to
by Path) Lets you specify the variable to connect by the ending of the variable
path. The first currently unconnected variable that matches the specified ending
is connected.

Regular expression (Only available if the connection assignment mode is set


to by Regular expression). Lets you specify the variable to connect via a regular
expression. The first currently unconnected variable that matches the regular
expression is connected.

454
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

The following table gives you an overview of regular expressions you can use.

Regular Purpose Example


Expression
. Matches any single character. ho.se matches horse and house.
\< Matches the start of a word. \<art matches artist but not start.
\> Matches the end of a word. \>art matches start but not artist.
[...] Matches a single character that is contained within the a[ur]t matches auto or artist but not
brackets. For example, [abc] matches "a", "b", or "c". alternate.
[a-z] specifies a range which matches any lowercase
letter from "a" to "z".
[^...] Matches a single character that is not contained within a[^ur]t matches alternative but not
the brackets. For example, [^abc] matches any character automobile or artist.
other than "a", "b", or "c". [^a-z] matches any single
character that is not a lowercase letter from "a" to "z".
^ Matches the start of a line. ^dig matches digit at the start of a
line.
$ Matches the end of a line. git$ matches digit at the end of a
line.
* Matches the preceding character zero or more times. di*git matches dgit, digit, diigit,
diiigit, etc.
+ Matches the preceding character one or more times. di+git matches digit, diigit, diiigit,
etc.
\x Allows you to use a character x that would otherwise 2\+2<5 matches 2+2<5.
have a special meaning.

URI contains (Only available if the connection assignment mode is set to "by
URI"). Lets you specify the variable to connect by a substring contained in the
URI. The first currently unconnected variable that matches the specified substring
is connected.

Related instruments This property is available for various instruments.

Related topics HowTos

How to Customize the Connection Assignment of Variables and Framework Labels


to Instruments (ControlDesk Layouting )

455
May 2024 ControlDesk Instrument Handling
Reference Information

Connection Nodes Properties

Purpose To configure connection nodes of the Browser.

A connection node lets you connect a variable to the Browser by dragging it


onto the instrument.

Connection nodes list Lets you open the Connection Nodes dialog. The defined nodes are listed on
the left side of the dialog. Select a node to specify its properties.

You can use the following buttons to configure the list.

Button Description
Add Adds a new connection node to the list.
Moves the selected element to the top.

Moves the selected element to the bottom.

Deletes the selected element.

Toolbar A toolbar is displayed above the property list. The buttons let you configure the
view of the list or search for items in the list, for example.

For more details on the toolbar buttons, refer to Toolbar buttons (ControlDesk
User Interface Handling ).

Connection Info properties To configure the properties of the selected connection node.

Unique Name Lets you specify a name for the connection node. The name
must be unique within the list of connection nodes.

Variable properties To configure the properties of the variable that is associated with the selected
connection node.

For details on the properties, refer to Variables Properties on page 562.

Related instruments These properties are available for the following instrument:
§ Browser on page 312

456
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Related topics Basics

Basics on Handling the Browser................................................................................................ 97

References

Browser.................................................................................................................................. 312

Conversion Table Settings Properties (Time Plotter/Index Plotter)

Purpose (Available only if the connected variable is converted via verbal table conversion)
To specify properties for connected variables with verbal conversion tables.

The converted values of variables with verbal conversion tables are displayed in
the Time Plotter and the Index Plotter as text labels on the y-axis.

You can specify the following properties.

Properties Default value position Lets you specify the position of the default value on
the y-axis.

Display labels in signal color Lets you display the converted values (text
labels) in the signal color.

Scale range style (Available only if the connected variable is converted via
a scale range table) Lets you specify whether scale range areas are displayed as
colored stripes in the whole plot or as colored marks near the y-axis.

457
May 2024 ControlDesk Instrument Handling
Reference Information

The following illustrations show the result of both options in a Time plotter
together with the related computation table and the variable property settings.
§ Scale range style = Plot:

§ Scale range style = Axis:

Related instruments These properties are available for the following instruments:
§ Index Plotter on page 341
§ Time Plotter on page 384

Related topics Basics

Basics of Handling the Index Plotter........................................................................................ 120


Basics of Handling the Time Plotter......................................................................................... 216

Current Display Format Property

Purpose To open a dialog to specify the display format for the connected variable.

Property Current display format Lets you open a dialog to specify the display format
for the connected variable. You can either use the settings of the variable
description ("Use variable settings" enabled) or customize the display format

458
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

("Use variable settings" disabled). In the latter case, you can specify the format,
width, precision, and display sign.

Related instruments This property is available for the following instruments:


§ Display on page 324
§ Numeric Input on page 357
§ Variable Array on page 389

Curves Properties (XY Plotter)

Purpose To configure the properties of the curves in the XY Plotter.

Curves property Lets you open the Curves dialog. The defined curves are listed on the left side of
the dialog. Select a curve to specify its properties.

You can use the following buttons to configure the list.

Button Description
Add Adds a new curve to the list.
Moves the selected element to the top.

Moves the selected element to the bottom.

Deletes the selected element.

Toolbar A toolbar is displayed above the property list. The buttons let you configure the
view of the list or search for items in the list, for example.

For more details on the toolbar buttons, refer to Toolbar buttons (ControlDesk
User Interface Handling ).

Selected curve properties To configure the properties of the selected curve.

Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

Enabled Lets you specify to display the selected curve in the chart.

Limit data points Lets you limit the data points that are displayed for a curve
to the Number of displayed data points.

459
May 2024 ControlDesk Instrument Handling
Reference Information

Line style Lets you select whether to connect the data points of the curve
graphically:

List Entries Description


None Data points are not graphically connected.
Direct Data points are connected by a direct line.

Line width Lets you select the width of the curve's line in the range 1…50
pixels.

Name Lets you specify the name of the curve.

Number of displayed data points (Available only if Limit data points is


enabled) Lets you specify how many of the last measured data points to display
for the curve.

Point style Lets you select the style of the curve’s points.

Point size Lets you select the size of the curve’s points in the range 1…150
pixels.

Smooth mode enabled Lets you smooth the staircase effect in the signal
visualization.

X variable/Y variable To display information on the connected variable.


properties
Platform Displays the platform/device the selected variable is assigned to.

Raster Displays the measurement raster the selected variable is assigned to.

Related instruments These properties are available for the following instrument:
§ XY Plotter on page 396

Custom Header Text Property (Variable Array)

Purpose To specify a custom text for the instrument header.

Property Custom Header Text Lets you specify a custom text for the instrument
header. If you specify no custom text, the instrument name is used for the
instrument header.
Specifying custom text is useful to split a group of variables across multiple
Variable Arrays and use the group name for all the instruments.

Related instruments This property is available for the following instrument:


§ Variable Array on page 389

460
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Related topics Basics

Basics of Handling the Variable Array...................................................................................... 241

Custom Value Conversion Properties

Purpose To specify properties for converting a source value into a converted value and
vice versa. The variable conversion that you define here is assigned to the
instrument.

Properties Backward function Lets you specify an inverse conversion function.


You can use the operators and functions that are specified in version 1.7 of
the ASAM MCD-2 MC standard in connection with the FORMULA keyword,
such as basic operations (+, -, *, /), binary operations (>>,<<,…), or various
functions (sin(x), cos(x), tan(x), exp(x), log(x), log10(x), sqrt(x),
abs(x), pow(x1,x2), ….).
Before a bitwise operation is executed, the operands are converted to integer
values. The result is passed as a double value.
Before a logical operation is executed, the operands are convert to bool values
(0.0 is false, other values are true). The result is passed as a double value
(true is 1.0, false is 0.0).
ControlDesk derives the inverse forward function if the original function has the
format (a*x+b)/(c*x+d) for any a, b, c, d.

Enabled Lets you enable the conversion settings defined via the instrument.

Forward function Lets you specify a function to convert the source value of
the selected variable.
You can use the operators and functions that are specified in version 1.7 of
the ASAM MCD-2 MC standard in connection with the FORMULA keyword,
such as basic operations (+, -, *, /), binary operations (>>,<<,…), or various
functions (sin(x), cos(x), tan(x), exp(x), log(x), log10(x), sqrt(x),
abs(x), pow(x1,x2), ….).
Before a bitwise operation is executed, the operands are converted to integer
values. The result is passed as a double value.
Before a logical operation is executed, the operands are convert to bool values
(0.0 is false, other values are true). The result is passed as a double value
(true is 1.0, false is 0.0).
ControlDesk derives the inverse backward function if the original function has
the format (a*x+b)/(c*x+d) for any a, b, c, d.

Unit converted Lets you specify the unit of the converted value.

Unit source Lets you specify the unit of the source value.

461
May 2024 ControlDesk Instrument Handling
Reference Information

Related instruments These properties are available for various instruments.

DAQ Properties (Time Plotter/Index Plotter)

Purpose To specify data acquisition settings for visualization in the Index Plotter or Time
Plotter. For example, you can enable a triggered display of plotter data.

Properties Mode Lets you switch between triggered and untriggered display of plotter
data.

Mode Description
Trigger mode Lets you enable the triggered display of plotter
data. The plotter uses the trigger settings of
the leading measurement raster for its display
settings.
Only signals with a triggered measurement are
displayed. Continuously measured signals show a
warning symbol in their icons.
The displayed x-axis area starts with the delay of
the start trigger. The number of displayed data
points depends on the selected trigger:
§ Sample count trigger: sample count value (x-
axis scaling is set to fixed mode)
§ Duration trigger: number of samples measured
in the specified duration (x-axis scaling is set to
fixed mode)
§ Platform trigger: number of samples measured
until the stop trigger is reached (x-axis scaling is
set to extended mode)
Continuous Lets you enable the untriggered display of
mode plotter data. The plotter displays the data stream
continuously.
Only continuously measured signals are displayed.
Signals with a triggered measurement show a
warning symbol in their icons.

Drawing mode (Available only if DAQ mode is set to Trigger mode) Lets
you specify when to plot the signal trace.

Mode Description
On new value The signal trace is drawn each time a new data
value is available.
On new capture The signal trace is drawn when a triggered
capture is complete. If the data values arrive

462
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Mode Description
at random intervals, you can use this mode to
prevent the displayed signal from flickering.

Follow leading raster (Available only if DAQ mode is set to Trigger


mode) Lets you specify to change the plotter's DAQ mode automatically if the
leading raster is switched between triggered and continuous measurement in the
measurement configuration.

Show DAQ mode Lets you display the name of the plotter's DAQ mode in
the info area of the instrument.

Show info Lets you display plotter DAQ information in the instrument.

Show leading raster Lets you display the name of the leading raster in the
info area of the instrument.

Show start trigger time Lets you display the start trigger time in the info
area of the instrument.

Start trigger Displays the name of the start trigger if one is activated for the
measurement raster.

Stop trigger Displays the name of the stop trigger if one is activated for the
measurement raster.

Tip

Via the instrument's toolbar, you can easily change frequently used DAQ
settings. Refer to Show Toolbar on page 715.

Related instruments These properties are available for the following instruments:
§ Index Plotter on page 341
§ Time Plotter on page 384

Data Cursor Properties (Time Plotter/Index Plotter)

Purpose To specify the properties of one or two cursors that are used to display the values
of selected chart positions.

Properties Cursor info position Lets you select whether to display the cursor
information at a fixed position in the chart or let it follow the cursor inside
the chart or on the axes.

Decimal places (Available only if Use custom precision is enabled) Lets you
specify the number of displayed decimal places of the cursor values. If a value
has more than the selected number of decimal places, the last displayed digit is
rounded.

463
May 2024 ControlDesk Instrument Handling
Reference Information

Display info header Lets you display a header in the cursor information
when you enable a delta cursor.

Enabled Lets you show/hide the data cursors.

Keep always visible Lets you specify to keep the cursors inside the chart
area, for example, when you move a chart or zoom into it.

Mode Lets you select the data cursor mode.

Mode Description
Single Displays one cursor to specify a position in the chart. The x- and y-
values of the cursor position are displayed at the cursor info position.
Delta Displays two cursors to specify two independent positions in the chart.
The x- and y-values of the two cursor positions and the differences
between them are displayed at the cursor info position.

Show connection name Lets you specify whether to display the name of
the connected variable in the data cursor tooltip. The name is displayed only if
'Cursor info position' is set to 'Follow cursor' and 'Stick on curve' is enabled.

Stick on curve Lets you specify to move the data cursor on the data points of
the signal next to the mouse pointer.

Type Lets you select the data cursor type.

Use custom precision Lets you enable or disable the configuration of the
number of decimal places of the cursor values.

Tip

Via the instrument's toolbar, you can easily change frequently used data
cursor settings. Refer to Show Toolbar on page 715.

Related instruments These properties are available for the following instruments:
§ Index Plotter on page 341
§ Time Plotter on page 384

Data Cursor Properties (XY Plotter)

Purpose To specify the properties of one or two cursors that are used to display the values
of selected chart positions.

Properties Cursor info position (Available only if Single cursor or Delta cursor is
enabled) Lets you select whether the cursor information is displayed at a fixed
position in the chart or follows the cursor.

464
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Delta cursor Lets you enable two cursors to specify two independent
positions in the chart. The x- and y-values of the two cursor positions and the
difference between them are displayed at the cursor info position. A single
cursor is disabled when you enable a delta cursor.

Display info header Lets you display a header in the cursor information
when you enable a delta cursor.

Keep always visible (Available only if Single cursor or Delta cursor is


enabled) Lets you specify to keep the cursors inside the chart area, for example,
when you move a chart or zoom into it.

Single cursor Lets you enable a single cursor to specify a position in the
chart. The x- and y-values of the cursor position are displayed at the cursor info
position. A delta cursor is disabled when you enable a single cursor.

Stick on curve (Available only if Single cursor or Delta cursor is enabled)


Lets you specify to move the data cursor on the data points of the signal next to
the mouse pointer.

Related instruments These properties are available for the following instrument:
§ XY Plotter on page 396

Description Property

Purpose To specify a description for the instrument.

Property Description Lets you specify a description for the instrument. Click the down
arrow to enter more than one line.

Related instruments This property is available for various instruments.

Display Formats Properties

Purpose To configure the display format for the display area.

Display formats properties Lets you specify the display format of the display area.

Converted Lets you specify the settings for the converted display format of
numerical data.

465
May 2024 ControlDesk Instrument Handling
Reference Information

Display sign Lets you specify whether to add a prefix to the output value
with a sign (+ or -).

Format Lets you select one of the following decimal formats.

Decimal Format Description


Engineering To display decimal values as exponential
values. The exponent is always an integer
multiple of 3.
Exponential To display decimal values as exponential
values.
Float To display decimal values as floating point
values.
General To display decimal values as general values.
Octal To display decimal values as octal values.
Signed Integer To display decimal values as signed integer
values.
Unsigned Integer To display decimal values as unsigned integer
values.

Precision (Available only if Use precision is enabled) Lets you specify the
number of displayed fractional digits. If a value has more than the selected
number of fractional digits, the last displayed digit is rounded. If the length of
an integer is less than the selected number of fractional digits, leading zeros are
added.

Source Bin Lets you specify the settings of the selected binary display format.

Source Dec Lets you specify the settings of the selected decimal display
format.

Source Hex Lets you specify the settings of the selected hexadecimal display
format.

Use precision Lets you enable or disable the configuration of the number of
displayed fractional digits.

Use variable's settings Lets you specify whether to use the settings of the
variable description.

Use width Lets you specify whether to apply the specified width.

Width Lets you specify the minimum number of characters to be displayed. If


the number of characters for the value is less than the specified width, blanks are
added to the left of the value.

Related instruments These properties are available for the following instruments:
§ Display on page 324
§ Table Editor on page 379
§ Variable Array on page 389

466
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Display Properties

Purpose To display the value of the connected variable numerically.

Mode property Mode Lets you specify whether to display the digits in numeric or segmented
display mode.

Numeric display properties To specify the settings for the numeric display mode.

Alignment Lets you select one of nine options to align the digits in the
instrument. Each position is represented by a radio button. The center of the
instrument is the default position.

Automatic sizing Lets you enable or disable the autosize function. If the
checkbox is cleared you can specify the font size via the Font button. The digits
might not be readable if the font size is too big or too small for the size of the
instrument.

Font Lets you specify a font for the digits. If the element uses the general
font settings from the ControlDesk Options dialog, select Use custom font
settings to make the font settings in the dialog available.

Text color Opens a dialog for you to select a color or enter values to set
one. For more information on the dialog settings, refer to Color Property on
page 452.

Segmented display properties To specify the settings for the segmented display mode.

Digit count Lets you enter the total count of digits that can be used to
display a value. The default value is 8.

Off segments visible Lets you enable or disable displaying the digit segments
currently not used.

Off color Opens a dialog for you to select a color or enter values to set
one. For more information on the dialog settings, refer to Color Property on
page 452.

On color Opens a dialog for you to select a color or enter values to set
one. For more information on the dialog settings, refer to Color Property on
page 452.

Related instruments These properties are available for the following instrument:
§ Display on page 324

467
May 2024 ControlDesk Instrument Handling
Reference Information

Display Value Property

Purpose To specify whether the value of each button is displayed.

Property Display value Lets you specify whether to display the predefined value,
which is set to the parameter when the corresponding button is selected. If
enabled, the value is displayed in brackets after the button text.

Related instruments This property is available for the following instruments:


§ Check Button on page 319
§ On/Off Button on page 359
§ Push Button on page 361
§ Radio Button on page 363

Related topics Basics

Basics of Handling the On/Off Button..................................................................................... 156

Display Variable Information Property

Purpose To specify whether to display information about the variable in the instrument
header.

Property Display variable information (Available only if "Use global visibility settings
for header" is disabled) Lets you specify whether information about the selected
variable is displayed in the instrument header. What information is displayed
depends on the variable type.

Related instruments This property is available for the following instruments:


§ Variable Array on page 389

Related topics Basics

Basics of Handling the Variable Array...................................................................................... 241

468
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Distance Tracking Properties

Purpose To configure the properties of the distance tracking elements.

Tracked distances property Lets you open the Tracked distances dialog. The defined distance tracking
elements are listed. Select a distance tracking element to specify its properties.

Toolbar A toolbar is displayed above the property list. The buttons let you configure the
view of the list or search for items in the list, for example.

For more details on the toolbar buttons, refer to Toolbar buttons (ControlDesk
User Interface Handling ).

Distance tracking properties To configure the properties of the selected distance tracking element.

Name Lets you specify the name of the distance tracking element.

First Item Lets you select the item whose distance to the second item will be
tracked.

Second Item Lets you select the item whose distance to the first item will be
tracked.

Visible Lets you specify whether the distance tracking element is displayed.

Distance line properties To configure the distance line.

Label color Opens a dialog for you to select a color or enter values to set
one. For more information on the dialog settings, refer to Color Property on
page 452.

Line color Opens a dialog for you to select a color or enter values to set
one. For more information on the dialog settings, refer to Color Property on
page 452.

Line width Lets you specify the line width of the distance line.

Related instruments These properties are available for the following instruments:
§ 3-D Viewer on page 303

Related topics Basics

Basics of Handling the 3-D Viewer............................................................................................ 55

469
May 2024 ControlDesk Instrument Handling
Reference Information

HowTos

How to Track the Distance Between Two Items......................................................................... 83

References

3-D Viewer............................................................................................................................. 303

Videos

Tracking Distances (2:23) in dSPACE Help

Edit Mode Property (Animated Needle)

Purpose To enable the configuration of the radius, position and the orientation of the
needle.

Property Edit mode Lets you display the start point, the end point and the
intermediate point of the needle's circumcircle. You can move these points to
configure the radius and the orientation of the needle.
Intermediate point

Circumcircle
of the needle

Start point End point

Related instruments This property is available for the following instrument:


§ Animated Needle on page 307

Edit Mode Property (Invisible Switch)

Purpose To specify whether to display the area of the Invisible Switch.

470
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Property Edit mode Lets you enable or disable the display of the Invisible Switch area.
Since the instrument is transparent, you can enable this property when you
configure or position the instrument.

Related instruments This property is available for the following instrument:


§ Invisible Switch on page 346

Edit Points Properties

Purpose To specify the properties of the edit points in the Table Editor.

Edit points properties Lets you specify the properties of the edit points.

Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

Visible Lets you specify whether the edit points are displayed.

Related instruments These properties are available for the following instruments:
§ Table Editor on page 379

Related topics Basics

Basics of Handling the Table Editor......................................................................................... 188

File Archive Properties

Purpose To specify files that are saved with the selected Browser instrument.

Properties Clear Lets you delete all the files in the Browser's file archive.

Export Lets you export all the files in the Browser's file archive to a folder in
the file system.

Import Lets you select a folder in the file system to import all the folder's files
to the Browser's file archive.

Shared archive Lets you specify to share the Browser's file archive with other
Browser instruments. If ControlDesk loads a Browser with a file archive, the files

471
May 2024 ControlDesk Instrument Handling
Reference Information

of the archive are copied to a temporary folder. If Shared archive is activated,


Browsers with the same file archive use the same temporary folder. If it is
deactivated, the Browser creates its own temporary folder whether or not the
files are identical.

Start File Lets you select a file from the Browser's archive. The file is displayed
when the Browser instrument is initialized.

Related instruments These properties are available for the following instrument:
§ Browser on page 312

Related topics Basics

Basics on Handling the Browser................................................................................................ 97

Focus Border Visible Property

Purpose To specify whether the currently selected button is marked by a dotted frame.

Property Focus border visible Lets you specify whether the currently selected button
is marked by a dotted frame.

Related instruments This property is available for the following instruments:


§ On/Off Button on page 359
§ Push Button on page 361
§ Radio Button on page 363

Related topics Basics

Basics of Handling the On/Off Button..................................................................................... 156

Focus Color Property

Purpose To specify the color used to outline the selected cell.

472
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Property Focus color Opens a dialog for you to select a color or enter values to set
one. For more information on the dialog settings, refer to Color Property on
page 452.

Related instruments This property is available for the following instrument:


§ Hierarchy Array on page 336

Related topics Basics

Basics of Handling the Hierarchy Array.................................................................................... 114

Global Caption Enabled Property

Purpose To specify to display a global caption below the header.

Property Global caption enabled Lets you specify to display a global caption below
the header.

Related instruments This property is available for the following instrument:


§ Bus Instrument on page 315

Grid Enabled Property (XY Plotter)

Property To show or hide a grid in the chart area of the XY Plotter.

Grid enabled Lets you specify whether a grid is displayed.

Related instruments This property is available for the following instrument:


§ XY Plotter on page 396

Related topics Basics

Basics of Handling the XY Plotter............................................................................................ 253

473
May 2024 ControlDesk Instrument Handling
Reference Information

Grid Minor Tics Property (XY Plotter)

Property To specify the number of auxiliary lines in the grid.

Grid Minor Tics Lets you specify the number of auxiliary lines in the grid,
from 0…4 minor tics.

Related instruments This property is available for the following instrument:


§ XY Plotter on page 396

Related topics Basics

Basics of Handling the XY Plotter............................................................................................ 253

Grid Properties (Time Plotter/Index Plotter)

Purpose To configure the grid properties.

Properties Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

Enabled Lets you show/hide a grid in the instrument.

Minor tics Lets you specify the number of minor tics between two major tics.

Related instruments These properties are available for the following instruments:
§ Index Plotter on page 341
§ Time Plotter on page 384

Grid View Properties

Purpose To configure the grid view properties of the Table Editor.

Auto column width property Auto column width Lets you specify whether the column width is set
automatically. If disabled, you can specify the value manually via the Column
width property.

474
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Background properties Lets you specify the background properties of the 3-D view.

Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

Picture properties Lets you specify whether to use an image (or animated
GIF) for the background and configure its properties. Refer to Picture Properties
on page 512.

Column width property Column width (Available only if Auto column width is disabled) Lets you
specify the column width in pixels.

Numeric output font property Numeric output font Opens a dialog where you can specify a font. If the
element uses the general font settings from the Instruments page of the
ControlDesk Options dialog, select Use custom font settings to make the
font settings in the dialog available.

Selection color property Selection Color Opens a dialog for you to select a color or enter values to
set one. For more information on the dialog settings, refer to Color Property on
page 452.

Text display mode property Text display mode Lets you specify the display mode. ControlDesk provides
the following display modes.

Value Display Mode Description


Current Lets you display the current values of the
axis points and function values in the
table cells.
Current + reference Lets you display the current values and
value the reference values of the axis points
and function values in the table cells.
Current + address Lets you display the current values and
the addresses of the axis points and
function values in the table cells.

Text font property Text font Opens a dialog where you can specify a font. If the element
uses the general font settings from the Instruments page of the ControlDesk
Options dialog, select Use custom font settings to make the font settings in
the dialog available.

Visible property Visible Lets you specify whether the grid view of the Table Editor is displayed.

475
May 2024 ControlDesk Instrument Handling
Reference Information

X-axis orientation property X-axis orientation Lets you specify the orientation of the x-axis.

Orientation Description
Horizontal To display the axis points of the x-axis horizontally
(in the columns of the first row) and the axis points
of the y-axis vertically (in the rows of the first
column).
Vertical To display the axis points of the x-axis vertically (in
the rows of the first column) and the axis points of
the y-axis horizontally (in the columns of the first
row).

Z-axes visible property Z-axes visible Lets you specify whether the z-axes of the Table Editor are
displayed in the grid view.

Related instruments These properties are available for the following instruments:
§ Table Editor on page 379

Related topics HowTos

How to Set Up a View of the Table Editor............................................................................... 211

References

2-D View Properties................................................................................................................ 411


3-D View Properties................................................................................................................ 412

Header Property (Variable Array)

Purpose To specify the header settings.

Property Header Lets you specify the instrument header settings. If you select Use
global settings, the settings on the Instruments page of the ControlDesk
Options dialog are used.

Related instruments This property is available for the following instrument:


§ Variable Array on page 389

476
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Related topics Basics

Basics of Handling the Variable Array...................................................................................... 241

Header Visible Property

Purpose To specify whether to display the header of the current instrument.

Property Header visible (Available only if "Use custom header settings" is enabled)
Lets you specify whether to display the header of the current instrument. The
header shows the name of the instrument and the variable information of the
currently selected variable.

Related instruments This property is available for the following instrument:


§ Bus Instrument on page 315

Related topics References

Instruments Page.................................................................................................................... 672

Horizon View Properties

Purpose To configure the properties of the Horizon view.

Description The Horizon view consists of a land display, a sky display, and a horizon line.

Properties Horizon line color Opens a dialog for you to select a color or enter values to
set one. For more information on the dialog settings, refer to Color Property on
page 452.

Horizon line width Lets you specify the horizon line width.

Lower land color Opens a dialog for you to select a color or enter values to
set one. For more information on the dialog settings, refer to Color Property on
page 452.

477
May 2024 ControlDesk Instrument Handling
Reference Information

Lower sky color Opens a dialog for you to select a color or enter values to
set one. For more information on the dialog settings, refer to Color Property on
page 452.

Upper land color Opens a dialog for you to select a color or enter values to
set one. For more information on the dialog settings, refer to Color Property on
page 452.

Upper sky color Opens a dialog for you to select a color or enter values to
set one. For more information on the dialog settings, refer to Color Property on
page 452.

Visible Lets you specify whether the Horizon view is displayed.

Related instruments These properties are available for the following instrument:
§ Artificial Horizon on page 272

Related topics Basics

Basics of Handling the Artificial Horizon.................................................................................. 103

Horizontal Hub Position Property

Purpose To move the hub horizontally inside the operating element.

Property Horizontal hub position (Available only if "Automatic Sizing" is disabled)


Lets you move the hub horizontally inside the operating element. Enter the
horizontal position of the hub (in pixels) relative to the center of the operating
element. 0 means the hub is placed in the middle of the operating element.
Positive values move the hub to the right, negative values to the left.

Related instruments This property is available for the following instruments:


§ Gauge on page 332
§ Knob on page 347

Related topics Basics

Basics of Handling the Gauge................................................................................................. 110


Basics of Handling the Knob................................................................................................... 143

478
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Icon Properties

Purpose To specify the properties of the selected icon cell.

Properties Embedded Lets you specify whether to save only the reference path to the
image file or to embed the file in the project. If an image has been embedded
and you extract it, ControlDesk stores the image in the .\Experiment
Layouts\Files folder of the project.

Tip

To access an embedded image, for example, to copy it, disable Embedded


and use the path displayed in Path.

Path Lets you enter a path and file name of an image to display or select one
via the Browse button.

Related instruments These properties are available for the following instrument:
§ Hierarchy Array on page 336

Related topics Basics

Basics of Handling the Hierarchy Array.................................................................................... 114

Increments Properties

Purpose To configure the increments for the selected variable.

Increments properties Lets you specify increment properties for the variable. Numeric Input only: Lets
you open a dialog to specify whether the increment value is added to (Additive)
or multiplied by (Multiplicative) the current variable value. You can specify the
increment as a fixed value or in percent format in both cases.

You can use the following keyboard shortcuts to apply increment values:

Shortcut Key Description


Page Up/Page Down Lets you apply a small increment.
Ctrl + Page Up/Page Down Lets you apply a big increment.

For instruments with a scale, snapping to tics must be disabled.

479
May 2024 ControlDesk Instrument Handling
Reference Information

Big increment (Available only for the Numeric Input and if Increments -
Mode is set to a multiplying mode) Lets you specify the value for the big
increment.

Big increments (Availability depends on the selected instrument and the


settings of Use custom increments or Mode) Lets you specify the value for
the big increment. Click the icon next to the edit field to specify the value in
source format ( icon) or in converted format ( icon).

Mode (Available only for the Numeric Input) Lets you specify the increments
mode.

Mode Description
Use variable settings The user defined increment settings are disabled.
The big and small increments are set according to
the connected variable. Usually, a source value of 10
is used for big increments and a source value of 1 for
small increments.
Additive – fixed The increment value is added to the variable value.
Additive – percentage The increment value is defined as percentage value
and is added to or subtracted from the variable
value.
Multiplying – fixed The variable value is multiplied with or divided by the
increment value.
Multiplying – The increment value is defined as percentage value
percentage of the variable value and the variable value is
multiplied with or divided by it.

Percent big (Availability depends on the selected instrument and the settings
of Use custom increments or Mode) Lets you specify the value for the big
increment in percent format.

Percent small (Availability depends on the selected instrument and the


settings of Use custom increments or Mode) Lets you specify the value for
the small increment in percent format.

Small increment (Available only for the Numeric Input and if Increments -
Mode is set to a multiplying or percentage mode) Lets you specify the value for
the small increment (Shortcut key: Ctrl + Page Up/Page Down).

Small increments (Availability depends on the selected instrument and the


settings of Use custom increments or Mode) Lets you specify the value for the
small increment. Click the icon next to the edit field to specify the value in source
format ( icon) or in converted format ( icon).

Use custom increments (Availability depends on the instrument) Lets you


specify whether custom increments are used.

Related instruments These properties are available for the following instruments:
§ Knob on page 347
§ Numeric Input on page 357

480
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

§ Slider on page 368


§ Variable Array on page 389

Items and Templates Properties

Purpose To configure the properties of the selected item or template.

Items property Lets you open the Items dialog. All items, such as cuboids, point lines, and
rectangles, are listed. Select an item to specify its properties.

Templates property Lets you open the Templates dialog. The defined templates are listed. Select a
template to specify its properties.

Toolbar (Items and Templates A toolbar is displayed above the property list. The buttons let you configure the
dialog) view of the list or search for items in the list, for example.

For more details on the toolbar buttons, refer to Toolbar buttons (ControlDesk
User Interface Handling ).

Common properties Template (Not available in the Templates dialog) Lets you create a template
with the same properties as the selected item.

Name Lets you specify the name of the selected item.

Visible Lets you specify whether the selected item is displayed. If you connect
a variable with this property, the variable properties are displayed instead. You
can specify some of the variable properties.

Match value Lets you specify the value of the connected variable for which
the item is displayed. The item is displayed only if the value of the variable is
equal to the Match value.

Variable Lets you specify the properties of the variable connected to the
Visible property.

Color Opens a dialog for you to select a color or enter values to define
one. For more information on the dialog settings, refer to Color Property on
page 452. If you connect a variable with this property, the variable properties are
displayed instead. You can specify some of the variable properties.

Position properties Lets you specify the position of the selected element
along the selected axis. If you connect variables with these properties, the
variable properties are displayed instead. You can specify some of the variable
properties.

481
May 2024 ControlDesk Instrument Handling
Reference Information

Position x Lets you specify the position of the selected element along the
x-axis. If you connect a variable with this property, the variable properties are
displayed instead. You can specify some of the variable properties.

Position y Lets you specify the position of the selected element along the
y-axis. If you connect a variable with this property, the variable properties are
displayed instead. You can specify some of the variable properties.

Position z Lets you specify the position of the selected element along the
z-axis. If you connect a variable with this property, the variable properties are
displayed instead. You can specify some of the variable properties.

Rotation properties Lets you specify the rotation of the selected element
around the selected axis. If you connect variables with these properties, the
variable properties are displayed instead. You can specify some of the variable
properties.

Rotation x Lets you specify the rotation of the selected element around the
x-axis. If you connect a variable with this property, the variable properties are
displayed instead. You can specify some of the variable properties.

Rotation y Lets you specify the rotation of the selected element around the
y-axis. If you connect a variable with this property, the variable properties are
displayed instead. You can specify some of the variable properties.

Rotation z Lets you specify the rotation of the selected element around the
z-axis. If you connect a variable with this property, the variable properties are
displayed instead. You can specify some of the variable properties.

Label properties To configure the label of the item.

Visible Lets you specify whether the label is displayed.

Text Lets you enter the label in the edit field. You can use macros from the list
to insert dynamic label parts received from the connected variable, for example,
a speed value.

Macro Description
{%BLOCK%} Block name of the variable
{%DATATYPE%} Data type of the variable
{%DEVICE%} Name of the connected platform/device
{%DISPLAYMODE%} Display mode of the variable
{%INDEX%} Index position of a variable in a measurement array or value block.
{%MODE%} Conversion mode of the variable
{%ORIGINPATH%} Path of the variable that was originally connected to the instrument. Lets
you identify the originally connected variable if it was replaced by the
variable it references.
{%PATH%} Path of the variable.
You can use indices to filter slash-separated parts of the path. For
example:
§ {%PATH[0]%} extracts the first part of the path up to the first slash.
§ {%PATH[-2]%} extracts the second-last part of the path.
{%READONLY%} Variable is read-only (ro) or not

482
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Macro Description
{%VALUE%} Value of the variable
{%VARIABLE%} Name of the variable

To modify the display of numeric values, you can use Printf expressions.
Put the Printf expression in angle brackets and insert it after the first % character
of a macro as shown in the following example:
{%<%.2f>VALUE%}
In this example, the <%.2f> expression modifies the {%VALUE%} macro so that
decimal floating point numbers with 2 digits are displayed.
The following table shows the supported Printf expressions:

Printf Expression Description


%d Decimal integer
%i Decimal integer
%u Unsigned integer
%o Octal integer
%x, %X Hexadecimal integer
%b Binary integer
%f Floating point
%e, %E Exponential floating point
%g, %G Floating point of the formats %f or %e

Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

Cuboid and cuboid group The following properties are available for cuboids and cuboid groups.
properties
Size properties Lets you specify the size of the selected cuboid along
the selected axis. If you connect variables with these properties, the variable
properties are displayed instead. You can specify some of the variable properties.

Size x Lets you specify the size of the selected element along the x-axis. If
you connect a variable with this property, the variable properties are displayed
instead. You can specify some of the variable properties.

Size y Lets you specify the size of the selected element along the y-axis. If
you connect a variable with this property, the variable properties are displayed
instead. You can specify some of the variable properties.

Size z Lets you specify the size of the selected element along the z-axis. If
you connect a variable with this property, the variable properties are displayed
instead. You can specify some of the variable properties.

Point line properties Line style properties Lets you configure the style of the line connecting the
points.

Visible Lets you specify whether the line connecting the points are displayed.

Width Lets you specify the width of the line connecting the points.

483
May 2024 ControlDesk Instrument Handling
Reference Information

Color Opens a dialog for you to select a color or enter values to define
one. For more information on the dialog settings, refer to Color Property on
page 452. If you connect a variable with this property, the variable properties are
displayed instead. You can specify some of the variable properties.

Render style Lets you select the render style of the line connecting the
points.

Render Description
Style
Normal The width of the line is determined by the value of the Width
property.
Hairline A very thin line is displayed. If Hairline is chosen, the Width
property will not affect the actual width of the line.

Tip

Choosing Hairline can improve the performance of the


instrument.

Pattern Lets you specify the pattern of the line connecting the points.

Pattern Style Description


Solid A solid line is displayed. The Pattern scale property does not
affect a solid line.
Dot A dotted line is displayed.
Small dot A dotted line using smaller dots is displayed.
Dash A dashed line is displayed.
Dash dot A dash dot line is displayed.

Pattern scale Lets you specify the size of the selected pattern. This property
does not affect a solid line.

Point style properties Lets you configure the style of the points.

Visible Lets you specify whether the points are displayed.

Size Lets you specify the size of the points.

Color Opens a dialog for you to select a color or enter values to define
one. For more information on the dialog settings, refer to Color Property on
page 452. If you connect a variable with this property, the variable properties are
displayed instead. You can specify some of the variable properties.

Points properties Lets you specify the positions of existing points. You can
add new points and delete existing points via buttons.

Button Purpose
Lets you add a new point.
Lets you delete an existing point.

If you connect one or more variables with the positions of the points, you can
specify the properties of the variables instead.

484
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

X-Positions Variable Lets you specify the properties of the variable


connected to the X-positions of the points.

Y-Positions Variable Lets you specify the properties of the variable


connected to the Y-positions of the points.

Z-Positions Variable Lets you specify the properties of the variable


connected to the Z-positions of the points.

Rectangle and rectangle The following properties are available for rectangles and rectangle groups.
group properties
Size properties Lets you specify the size of the selected rectangle. Depending
on the axis pair (XY, XZ, or YZ) that is selected at the Axes property, you can
specify the size of the rectangle along the x-axis, the y-axis, or the z-axis. If
you connect variables with these properties, the variable properties are displayed
instead. You can specify some of the variable properties.

Axes Lets you select one of the following axis pairs to specify the rectangle
alignment:

Axes Description
XY The rectangle is aligned in the XY plane.
XZ The rectangle is aligned in the XZ plane.
YZ The rectangle is aligned in the YZ plane.

Size x (Available only if the rectangle is aligned in the XY or XZ plane) Lets


you specify the size of the selected element along the x-axis. If you connect a
variable with this property, the variable properties are displayed instead. You can
specify some of the variable properties.

Size y (Available only if the rectangle is aligned in the XY or YZ plane) Lets


you specify the size of the selected element along the y-axis. If you connect a
variable with this property, the variable properties are displayed instead. You can
specify some of the variable properties.

Size z (Available only if the rectangle is aligned in the XZ or YZ plane) Lets you
specify the size of the selected element along the z-axis. If you connect a variable
with this property, the variable properties are displayed instead. You can specify
some of the variable properties.

Picture properties Lets you configure a picture to be shown on the surface


of the rectangle. Refer to Picture Properties on page 512.

Surface properties The following properties are available for surfaces.

Wireframe properties Lets you configure the wireframe.

Visible Lets you specify whether the wireframe lines are displayed.

Color Opens a dialog for you to select a color or enter values to define
one. For more information on the dialog settings, refer to Color Property on
page 452. If you connect a variable with this property, the variable properties are
displayed instead. You can specify some of the variable properties.

485
May 2024 ControlDesk Instrument Handling
Reference Information

Width Lets you specify the width of the wireframe lines.

Rendering style Lets you select the render style of the wireframe lines.

Render Description
Style
Normal The width of the wireframe lines is determined by the value of
the Width property.
Hairline Very thin lines are displayed. If Hairline is chosen, the Width
property will not affect the actual width of the lines.

Tip

Choosing Hairline can improve the performance of the


instrument.

Function value variable Lets you specify the properties of the variable that is
connected to the function values of the surface.

x-axis variable Lets you specify the properties of the variable connected to
the x-axis of the surface.

y-axis variable Lets you specify the properties of the variable connected to
the y-axis of the surface.

z-axis variable Lets you specify the properties of the variable connected to
the z-axis of the surface.

Related instruments These properties are available for the following instruments:
§ 3-D Viewer on page 303

Related topics Basics

Basics of Handling the 3-D Viewer............................................................................................ 55


Basics of Surfaces..................................................................................................................... 90
Overview of Possible Variable Connections............................................................................... 67

HowTos

How to Add an Item and Configure the Item Properties ........................................................... 79

References

3-D Viewer............................................................................................................................. 303

486
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Items Properties

Purpose To add and remove Selection box items and configure their settings.

Items list On the left-hand side of the dialog, all defined items are listed.

Select an item to specify its properties.

You can use the following buttons to configure the list.

Button Description
Add Adds a new item to the list.
Moves the selected item up in the list.

Moves the selected item down in the list.

Deletes the selected item.

While a simulation is running, the items are checked beginning at the top of the
list until the first match is reached.

Toolbar A toolbar is displayed above the property list. The buttons let you configure the
view of the list or search for items in the list, for example.

For more details on the toolbar buttons, refer to Toolbar buttons (ControlDesk
User Interface Handling ).

Text and value properties Text Lets you specify the text of the Selection Box item to be displayed.

Value Lets you specify the value to be written to the connected variable when
you select the item. Click the icon next to the edit field to specify the value in
source format ( icon) or in converted format ( icon).

Range properties Include maximum Lets you specify whether to include the maximum limit in
the range.

Include minimum Lets you specify whether to include the minimum limit in
the range.

Maximum Lets you enter the maximum limit of the range for the selected
item. Click the icon next to the edit field to specify the value in source format
( icon) or in converted format ( icon).

Minimum Lets you enter the minimum limit of the range for the selected
item. Click the icon next to the edit field to specify the value in source format
( icon) or in converted format ( icon).

487
May 2024 ControlDesk Instrument Handling
Reference Information

Range enabled Lets you enable or disable the use of ranges. If enabled,
the selection box cell displays the item that corresponds to the value of the
connected variable with regard to the specified value ranges.

Related instruments These properties are available for the following instrument:
§ Hierarchy Array on page 336

Related topics Basics

Basics of Handling the Hierarchy Array.................................................................................... 114

Label Properties (Label Cell)

Purpose To configure the label which is displayed in the label cell.

Properties Display string Displays the currently specified string of the label. You can edit
the string in the Label field.

Label Lets you enter the label in the edit field. You can use macros from the
list.

Macro Description
{%BLOCK%} Block name of the variable
{%CONBLOCK%} § If a variable was initially connected to the instrument, the macro
returns the block name of the variable.
§ If a framework label was initially connected to the instrument, the
macro returns nothing.
{%CONNECTION%} § If a variable was initially connected to the instrument, the macro
returns the name of the variable.
§ If a framework label was initially connected to the instrument, the
macro returns the name (ID) of the framework label .
{%CONUNIT%} § If a variable was initially connected to the instrument, the macro
returns the unit of the variable.
§ If a framework label was initially connected to the instrument, the
macro returns the unit of the framework label .
{%DATATYPE%} Data type of the variable
{%DESCRIPTION%} Description text of the variable (from the variable description file)
{%DEVICE%} Name of the connected platform/device
{%DISPLAYMODE%} Display mode of the variable
{%INDEX%} Index position of a variable in a measurement array or value block.
{%INSTRUMENT%} Name of the instrument
{%INSTRUMENTDESCRIPTION%} Description text of the instrument (from the instrument properties)
{%MAXHARDLIMIT%} Maximum hard limit of the variable

488
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Macro Description
{%MAXVALUE%} Maximum of the measured value
{%MAXWEAKLIMIT%} Maximum weak limit of the variable
{%MINHARDLIMIT%} Minimum hard limit of the variable
{%MINVALUE%} Minimum of the measured value
{%MINWEAKLIMIT%} Minimum weak limit of the variable
{%MODE%} Conversion mode of the variable
{%ORIGINPATH%} Path of the variable that was originally connected to the instrument. Lets
you identify the originally connected variable if it was replaced by the
variable it references.
{%PATH%} Path of the variable.
You can use indices to filter slash-separated parts of the path. For
example:
§ {%PATH[0]%} extracts the first part of the path up to the first slash.
§ {%PATH[-2]%} extracts the second-last part of the path.
{%READONLY%} Variable is read-only (ro) or not
{%STRUCT%} Name of the variable together with the relevant parts of the struct (if the
variable is part of a struct). The struct parts are separated by a dot, for
example: MyStruct.MySubstruct.MyParameter.
You can use indices to filter parts of the struct. For example:
§ {%STRUCT[0]%} extracts the first part of the struct up to the first dot.
§ {%STRUCT[-2]%} extracts the second-last part of the struct.
{%UNIT%} Unit of the variable
{%UNIT%}{%DISPLAYMODESOURCE%} Unit and display mode of the variable
{%VALUE%} Value of the variable
{%VARIABLE%} Name of the variable

To modify the display of numeric values, you can use Printf expressions.
Put the Printf expression in angle brackets and insert it after the first % character
of a macro as shown in the following example:
{%<%.2f>VALUE%}
In this example, the <%.2f> expression modifies the {%VALUE%} macro so that
decimal floating point numbers with 2 digits are displayed.
The following table shows the supported Printf expressions:

Printf Expression Description


%d Decimal integer
%i Decimal integer
%u Unsigned integer
%o Octal integer
%x, %X Hexadecimal integer
%b Binary integer
%f Floating point
%e, %E Exponential floating point
%g, %G Floating point of the formats %f or %e

489
May 2024 ControlDesk Instrument Handling
Reference Information

Related instruments These properties are available for the following instrument:
§ Variable Array on page 389

Related topics Basics

Basics of Handling the Variable Array...................................................................................... 241

Layout Settings Properties (XY Plotter)

Purpose To configure chart and grid settings of the XY Plotter.

Name property Name Displays the name of the selected element.

Layout settings properties To specify the properties of the chart.

Auto hide elements Lets you specify to automatically hide chart elements
such as scale labels if the available space becomes too small.

Curve symbol position Lets you select where to display the curve symbols:

Position Description
Axis To display the curve symbols at bottom left.
Legend To display the curve symbols at top right.

Curve symbol visible (Available only if Auto hide elements is disabled) Lets
you specify to display the curve symbols.

Show scale (Available only if Auto hide elements is disabled) Lets you
specify to display the axis scales.

Show scale labels (Available only if Auto hide elements is disabled) Lets
you specify to display the labels of the axis scales.

Show axis label (Available only if Auto hide elements is disabled) Lets you
specify to display the labels of the axes.

Related instruments These properties are available for the following instrument:
§ XY Plotter on page 396

Related topics Basics

Basics of Handling the XY Plotter............................................................................................ 253

490
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

LED States Properties (Value Cell – Multistate LED)

Purpose To configure the LED properties of the selected Multistate LED cell.

LED states list The defined LED states are listed on the left side of the dialog. Select an LED
state to specify its properties.

You can use the following buttons to configure the list.

Button Description
Add Adds a new LED state to the list.
Moves the selected element to the top.

Moves the selected element to the bottom.

Deletes the selected element.

Toolbar A toolbar is displayed above the property list. The buttons let you configure the
view of the list or search for items in the list, for example.

For more details on the toolbar buttons, refer to Toolbar buttons (ControlDesk
User Interface Handling ).

Default state properties Lets you specify the properties of the LED value cell in default state.

Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

Text visible/Show text Lets you enable the text display in the value cell for
LEDs in default state.

Text (Available only if "Show text" is enabled) Lets you enter the text to be
displayed for LEDs in default states.

LED state properties LED - Blinking color Lets you specify the LED blinking color for the selected
state.

LED - Blinking enabled Lets you enable LED blinking for the selected state.

LED - Blinking interval Lets you specify the blinking interval for the selected
state in milliseconds.

Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

491
May 2024 ControlDesk Instrument Handling
Reference Information

Incl. max. Lets you specify whether to include the maximum limit in the
range. Select ] to include it or ) to exclude it. Keep in mind that the LED
instrument checks an LED state list from bottom to top.

Incl. min. Lets you specify whether to include the minimum limit in the range.
Select [ to include it or ( to exclude it. Keep in mind that the LED instrument
checks an LED state list from bottom to top.

Maximum/Range max. Lets you enter the maximum limit of the range for
the selected LED state. Click the icon next to the edit field to specify the value in
source format ( icon) or in converted format ( icon).

Minimum/Range min. Lets you enter the minimum limit of the range for the
selected LED state. Click the icon next to the edit field to specify the value in
source format ( icon) or in converted format ( icon).

Text visible/Show text Lets you enable the text display in the value cell for
the LED object.

Text (Available only if "Show text" is enabled) Lets you enter the text to be
displayed for the LED object.

Related instruments These properties are available for the following instrument:
§ Variable Array on page 389
§ Hierarchy Array on page 336

Related topics Basics

Basics of Handling the Hierarchy Array.................................................................................... 114


Basics of Handling the Variable Array...................................................................................... 241

Legend Properties (Time Plotter/Index Plotter)

Purpose To specify the legend properties.

Properties Enabled Lets you show/hide the legend.

Extend Lets you specify the extent of the legend in pixels.

Position Lets you specify the position of the legend.

Tip

You can also double-click the splitter between chart and legend to switch to
the next position.

492
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Show expand button Lets you show/hide the expand button in the
instrument. The expand button lets you show or hide the legend.

Related instruments These properties are available for the following instruments:
§ Index Plotter on page 341
§ Time Plotter on page 384

Logical Links Properties

Purpose To display the logical links that are available in the instrument.

Properties Configure Read Services (Available only for the Fault Memory Instrument)
Opens the Configure Read Services dialog, which lets you select the services to
be used for reading the environment data, clearing single fault memory entries
and clearing all fault memory entries. If no service is available, the button is
disabled.

Enabled Lets you specify whether a logical link is available for the instrument.

Logical links Displays all the available logical links. These are the logical
links that are selected in the active ODX database configuration of the ECU
Diagnostics device.

Configure Read Services List of services Displays or lets you select the services to be used to read the
dialog environment data, clear single fault memory entries and clear all fault memory
entries for the currently selected logical link. The services are always specified
in combination with the service used to read the fault memory. This means
that the Read service selected in the Fault Memory Instrument for the logical
link actually stands for a combination of services for reading the fault memory,
reading environment data, clearing single fault memory entries and clearing all
memory as specified in this configuration dialog.
All the services available for a logical link are displayed in a hierarchy tree,
grouped by the ControlDesk functions (reading environment data, clearing single
fault memory entries, clearing all fault memory entries). Each of the available
services for reading the fault memory is displayed as a top‑level element.
If the file list in the Select ODX Files dialog specified during configuration
of an ECU Diagnostics device contains an XML configuration file, all the
services defined in the configuration file are displayed in the tree and are
available for selection. If the file list in the Select ODX Files dialog specified
during configuration of an ECU Diagnostics device does not contain an XML
configuration file, ControlDesk uses the default service configuration for each
function (see Conventions in Connection with ODX Databases (ControlDesk ECU
Diagnostics )). If several services with appropriate classification are defined for
a function in the ODX database, ControlDesk displays all these services in the
tree for selection.

493
May 2024 ControlDesk Instrument Handling
Reference Information

For further information on diagnostic services and the XML configuration file,
refer to Basics of the XML Configuration File (ControlDesk ECU Diagnostics ).

Related instruments These properties are available for the following instruments:
§ Diagnostics Instrument on page 321
§ Fault Memory Instrument on page 326

Lubber Line Properties

Purpose To configure the properties of the lubber line.

Description The lubber line is displayed on the twelve o'clock position of the heading
indicator's scale.

Properties Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

Height Lets you specify the height of the lubber line.

Visible Lets you specify whether the lubber line is displayed.

Width Lets you specify the width of the lubber line.

Related instruments These properties are available for the following instrument:
§ Heading Indicator on page 275

Magnifier Properties

Purpose To configure the properties of the magnifier.

Description The magnifier displays the current value of the instrument.

Properties Background color Opens a dialog for you to select a color or enter values to
set one. For more information on the dialog settings, refer to Color Property on
page 452.

494
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Font Lets you specify the font of the text.

Minimum number of digits Lets you specify the minimum number of digits
that will be displayed.

Number of visible neighbors Lets you specify how many of the neighboring
digits are displayed.

Show leading zeros Lets you specify whether leading zeros are displayed.

Text color Opens a dialog for you to select a color or enter values to set
one. For more information on the dialog settings, refer to Color Property on
page 452.

Visible Lets you specify whether the magnifier is displayed.

Related instruments These properties are available for the following instruments:
§ Airspeed Indicator on page 268
§ Altimeter on page 270

Map Properties

Purpose To configure the Map-specific properties.

Map instrument The Map instrument is a custom instrument based on the


Browser instrument. In addition to the standard Browser properties, it has
a number of custom properties. The custom properties are described in the
following.

Default View Enabled Lets you specify whether the map should zoom into the default view
coordinates after loading.

Latitude The latitude value of the default view.

Longitude The longitude value of the default view.

Set current view Sets the current position and zoom level as the default
view.

Zoom The zoom level of the default view.

Marker Embedded Lets you specify whether to save the image file in the instrument.

Enabled Lets you specify whether to display a marker at the current position.

Icon Lets you specify an image file that will be used as the marker.

495
May 2024 ControlDesk Instrument Handling
Reference Information

Misc Map source Lets you specify the source of the map tiles used to display the
map.

Map Source Description


OpenStreetMap The map tiles are loaded from a web server. Internet access is
required.
Offline tiles The map tiles are loaded from a folder. If selected, the Tile
folder property is displayed for you to specify the folder path.

On update Lets you specify how to update the displayed map view when the
vehicle position is changed.

Map View Description


Expand view if out The map zooms out when the current vehicle position
of bounds moves outside the bounds of the displayed map. This
way, the complete route is always visible on the map.
Center view if out of The map is centered on the vehicle position if it moves
bounds outside the bounds of the displayed map.
Always center view The map always stays centered on the current position.

Show default properties Lets you specify whether to display the default
properties of the Browser instrument in the property grid.

Tile folder (Available only if Map source is set to Offline tiles) Lets you
specify a folder containing map tiles used to display the map.
The map tiles must have the PNG format and be stored in the following folder:
<tile folder>\<z>\<x>\<y>.png, where <tile folder> is your specified
tile folder, <z> is the zoom level, <x> is the tile's x coordinate and <y> is the
tile's y coordinate.

Route Color Lets you specify the color used to display the route.

Enabled Lets you specify to display a route on the map.

Maximum waypoints Lets you specify the maximum number of waypoints in


the displayed route.

Note

Increasing this value might affect performance.

Opacity Lets you specify the opacity of the displayed route. Valid values are
10 … 100.

Style Lets you specify whether to display the route as a solid or dashed line.

Width Lets you specify the width of the displayed route in pixels.

Related instruments These properties are available for the following instrument:
§ Map on page 277

496
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Related topics HowTos

How to Visualize GNSS Positioning Data in a Map.................................................................... 99

References

Map....................................................................................................................................... 277

Mark Properties

Purpose To configure the properties of the mark.

Properties Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

Size Lets you select either Very Small, Small, Large or Very Large from the list
to specify the size of the mark.

Snap Lets you specify whether to enable snapping. If enabled, the marker of
the Knob snaps to the tics when you change the value. If you use the Knob for
displaying data only, this setting is not relevant.

Style Lets you select either Line, Point, or Triangle from a list to specify the
shape of the marker.

Visible Lets you specify whether the mark is visible in the instrument.

Related instruments These properties are available for the following instrument:
§ Knob on page 347

Related topics Basics

Basics of Handling the Knob................................................................................................... 143

Min/Max Property

Purpose To display the maximum or minimum of the measured value.

497
May 2024 ControlDesk Instrument Handling
Reference Information

Property Min./Max. Lets you display the maximum or minimum of the measured value.
Click the "Reset" button to reset the maximum and minimum value.

Related instruments This property is available for the following instrument:


§ Variable Array on page 389

Related topics Basics

Basics of Handling the Variable Array...................................................................................... 241

MultiState Display Properties

Purpose To specify the MultiState Display-specific settings.

Properties Export Lets you enter the name of the CSV file to which the states are saved.

Default LED color (Available only for LED or LED and Message display
mode) Lets you specify the default LED color.

Default state (Available only for the Custom display mode) Lets you specify
the custom display setting for the default state. Click the Browse button to
specify the settings. Refer to States Properties on page 540.

Default text (Available only for Message or LED and Message display
mode) Lets you specify the default message to be displayed.

Display mode Lets you select a display mode. The following options are
available:
§ LED
§ Message
§ LED and Message
§ Custom

Import Lets you select a CSV file from which the states are imported.

Note

The data from the file is used to create the states. Existing states in the
states list are deleted.

Global settings properties Lets you specify the global settings of the MultiState Display.

498
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

LED settings Lets you specify the global LED settings.

LED settings - Frame color Opens a dialog for you to select a color or enter
values to set one. For more information on the dialog settings, refer to Color
Property on page 452.

LED settings - Frame style Lets you select the appearance style of the
current LED’s border.

Setting Description
None To display the LED without a border.
Simple To display the LED with a flat border.
Sunken To display the LED as sunken.
Raised To display the LED as raised.

LED settings - Reflection visible Lets you enable or disable the reflection
effect on the LED.

LED settings - Style Lets you select one of the LED styles. You can choose:
§ Ellipse
§ Circle
§ Rectangle
§ Square

Text / LED Alignment (Available only for the LED and Message or Custom
display mode) Lets you customize the positions and proportion of the LED and
message to be displayed. Click the drop-down arrow to open a dialog, in which
you can select a position of the LED and message and change their proportion
via a slider.

Text settings Lets you specify the global text settings.

Text settings - Alignment Lets you select one of the nine options to align
the text inside the edit field. Each position is represented by a button.

Text settings - Display value Lets you specify whether the variable value of
each button is displayed. If enabled, the value is displayed in brackets behind the
button text.

Text settings - Font Opens a dialog for you to specify a font for the message
text. If the element uses the general font settings from the ControlDesk
Options dialog, select Use custom font settings to make the font settings
in the dialog available.

Text settings - Word wrap Lets you specify whether to break text lines of
the message automatically. If the message text does not fit into one line, it is
wrapped to the next line. If the selected font is too large for the amount of text
and the instrument size, the text is not displayed completely.

Related instruments These properties are available for the following instrument:
§ MultiState Display on page 352

499
May 2024 ControlDesk Instrument Handling
Reference Information

Multistate LED Properties

Purpose To configure the properties of the selected Multistate LED cell.

Properties States Lets you add and remove states and configure their settings
Refer to LED States Properties (Value Cell – Multistate LED) on page 491.

Style Lets you specify the style of the selected Multistate LED cell.
The following styles are available:
§ Circle
§ Ellipse
§ Rectangle
§ Square

Related instruments These properties are available for the following instrument:
§ Hierarchy Array on page 336

Related topics Basics

Basics of Handling the Hierarchy Array.................................................................................... 114

Multiswitch Properties

Purpose To specify the Multiswitch-specific settings.

Properties Current raster type Lets you select a raster type.

Write Mode Description


Free Paint The sensitive areas are defined by drawing them
with the mouse.
Circle The sensitive areas are defined by selecting segments
of a circle.
Square The sensitive areas are defined by selecting squares.

You can specify the properties of the selected raster, such as the number of
squares or the color of the selection, via the Raster properties.

Default state picture Lets you specify the settings for a background
picture/animated GIF that is displayed if the value of the connected variable does
not match any of the ranges of the different states.

500
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Edit mode Lets you specify whether the sensitive areas are displayed and can
be edited.

Focus border visible Lets you specify whether the currently selected sensitive
area is marked by a dotted frame.

Interval (Available only if "Increase/Decrease mode" is selected under "Push


mode") Lets you specify the update rate of the increment value in ms. If you
enter 100, for example, the increment value is written every 100 milliseconds if
you keep the mouse button pressed.

Off-value (Available only if "On/Off mode" or "Check mode" is selected


under "Push mode") Lets you specify the value that is written when the sensitive
area is not activated (released or cleared).

Push mode Lets you specify how the sensitive areas react when they are
clicked.

Write Mode Description


Push button The value of the connected parameter is set to
a predefined value when you click a sensitive
area.
On/Off mode The value of the connected parameter is set to
a predefined value when you click a sensitive
area (On value) and to another predefined
value when you release it (Off value).
Check mode The value of the connected parameter is
set to a predefined value when you activate
a sensitive area (On value) and to another
predefined value when you clear it (Off value).
Increase/Decrease The value of the connected parameter is
mode incremented/decremented by a predefined
value when you click the area. You can define
a big increment that is used if you hold the
mouse button down.

Show borders Lets you specify the type of borders that are displayed when
the instrument is selected. If cleared, only small borders are displayed.

Toolbox expanded Lets you specify whether a toolbox is displayed in the


instrument in the Edit mode. Via the toolbox you can easily change raster
settings such as the current raster type and the number of raster cells. You can
also remove the currently selected sensitive raster area.

Tip

You can also open (and close) the toolbox by clicking the arrow button that
appears when you move the mouse pointer to the top left corner of the
instrument.

Raster properties Lets you specify the properties of the raster you have selected under "Current
raster type" for defining the sensitive areas.

501
May 2024 ControlDesk Instrument Handling
Reference Information

Columns (Available only if "Square" is selected under "Current raster type")


Lets you specify the number of columns of the raster.

Rows (Available only if "Square" is selected under "Current raster type") Lets
you specify the number of rows of the raster.

Selection color Lets you select the color for the currently selected sensitive
area when the Edit mode of the Multiswitch is enabled.

Angle (Available only if "Circle" is selected under "Current raster type") Lets
you specify the angle of the segments of the circle.

Start angle (Available only if "Circle" is selected under "Current raster type")
Lets you specify the start angle of the segments of the circle.

States Properties Lets you specify the properties of a sensitive area's state. You can add, delete,
and sort states via buttons.

Big incr. (Available only if "Increase/Decrease mode" is selected under "Push


mode") Lets you specify the value of the big increment. Click the icon next to
the edit field to specify the value in source format ( icon) or in converted format
( icon).

Incl. max. Lets you specify whether to include the maximum limit in the
range.

Incl. min. Lets you specify whether to include the minimum limit in the range

Maximum Lets you enter the maximum limit of the range for the selected
state. Click the icon next to the edit field to specify the value in source format
( icon) or in converted format ( icon).

Minimum Lets you enter the minimum limit of the range for the selected
state. Click the icon next to the edit field to specify the value in source format
( icon) or in converted format ( icon).

Picture path Lets you enter a path and file name for the background
image/animated GIF or select one via the Browse button. The image/animated
GIF is displayed as long as the value of the variable that is connected to the
instrument matches the defined range of the state.

Settings Lets you specify further properties of a state.

Small incr. (Available only if "Increase/Decrease mode" is selected under


"Push mode") Lets you specify the value of the small increment. Click the
icon next to the edit field to specify the value in source format ( icon) or in
converted format ( icon).

State Picture To configure the settings of the picture/animated GIF that is


displayed as long as the value of the variable that is connected to the instrument
matches the defined range of the state.

State Pressed Picture To configure the settings of a picture/animated GIF


that is displayed when the sensitive area of the state is clicked.

Write value Lets you enter the value that is written to the connected variable
when a sensitive area of this state is clicked. Click the icon next to the edit field
to specify the value in source format ( icon) or in converted format ( icon).

502
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Related instruments These properties are available for the following instrument:
§ Multiswitch on page 354

Related topics Basics

Basics of Handling the Multiswitch......................................................................................... 148

Name Property

Purpose To specify the name of the selected instrument.

Property Name Lets you enter a name for the selected instrument. The names of the
instruments on a layout must be unique.

Related instruments This property is available for various instruments.

Needle Properties (Animated Needle)

Purpose To specify the needle-specific settings of the Animated Needle.

Description You can specify the needle's head, hub and tail, and the pivot width.

Head

Hub

Tail

Head/ Tail properties Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

Length Lets you specify the length of the head/tail (in per cent of the radius
of the needle's circumcircle).

Width Lets you specify the width of the head/tail (in per cent of the radius of
the needle's circumcircle).

503
May 2024 ControlDesk Instrument Handling
Reference Information

Hub properties Visible Lets you specify whether the needle's hub is visible.

Radius Lets you specify the radius of the hub (in per cent of the radius of the
needle's circumcircle).

Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

Position Lets you specify whether the needle's hub is positioned above or
below the needle's head and tail.

Pivot width property Pivot width Lets you enter the width of the needle's pivot (in per cent of the
radius of the needle's circumcircle).

Related instruments These properties are available for the following instrument:
§ Animated Needle on page 307

Needle Properties (Gauge)

Purpose To configure the properties of the needle.

Properties Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

Picture Lets you specify whether to use an image/animated GIF for the needle
and specify its properties. Refer to Picture Properties on page 512.

Size Lets you select the size of the needle from the list.

Style Lets you select a style from a list to specify the shape of the needle. You
can select a pointer, triangle, or an arrow.

Visible Lets you specify whether the needle is displayed. Regardless of this
setting the needle is displayed only if the instrument is receiving a valid value.

Related instruments These properties are available for the following instrument:
§ Gauge on page 332

Related topics Basics

Basics of Handling the Gauge................................................................................................. 110

504
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Numeric Display Properties

Purpose To configure the properties of the numeric display.

Description The numeric display shows the current value of the heading indicator
numerically.

Properties Background color Opens a dialog for you to select a color or enter values to
set one. For more information on the dialog settings, refer to Color Property on
page 452.

Show leading zeros Lets you specify whether leading zeros are displayed.

Font Lets you specify the font of the text.

Text color Opens a dialog for you to select a color or enter values to set
one. For more information on the dialog settings, refer to Color Property on
page 452.

Visible Lets you specify whether the numeric display is displayed.

Related instruments These properties are available for the following instrument:
§ Heading Indicator on page 275

Numeric Input Properties

Purpose To display and set the value of the connected variable numerically.

Properties Show spin button Lets you enable or disable the display of the spin button.

Related instruments These properties are available for the following instrument:
§ Numeric Input on page 357

Off-Value Property

Purpose To specify the Off value of the button.

505
May 2024 ControlDesk Instrument Handling
Reference Information

Property Off-value Lets you specify the value to be written to the connected variable
when you clear or release the button. Click the icon next to the edit field to
specify the value in source format ( icon) or in converted format ( icon).
When you assign a variable with a computation table to an On/Off Button
instrument, one of the table entries must be specified as the off-value.

Related instruments This property is available for the following instruments:


§ Check Button on page 319
§ On/Off Button on page 359
§ Invisible Switch on page 346

Related topics Basics

Basics of Handling the On/Off Button..................................................................................... 156

On-Value Property

Purpose To specify the On value of the button.

Property On-value Lets you specify the value to be written to the connected variable
when you select or press the button. Click the icon next to the edit field to
specify the value in source format ( icon) or in converted format ( icon).

Related instruments This property is available for the following instruments:


§ Check Button on page 319
§ Invisible Switch on page 346

Orientation Property

Purpose To specify the orientation of the buttons.

Property Orientation Lets you specify whether to position the buttons horizontally or
vertically.

506
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Related instruments This property is available for the following instruments:


§ On/Off Button on page 359
§ Push Button on page 361
§ Radio Button on page 363

Related topics Basics

Basics of Handling the On/Off Button..................................................................................... 156

Origin Property

Purpose To specify the bar’s origin.

Property Origin Lets you specify the starting point of the bar.

Related instruments This property is available for the following instrument:


§ Bar on page 309

Output Properties

Purpose To configure the output properties of the Diagnostics Instrument.

Properties Clear output on execution Lets you specify whether to clear the output
field before another communication object is executed. If disabled, the
information in the output field is not cleared but extended by adding the new
information at the end.

Display results only Lets you specify whether to show only the results in the
output field.

Related instruments These properties are available for the following instrument:
§ Diagnostics Instrument on page 321

507
May 2024 ControlDesk Instrument Handling
Reference Information

Overflow Warning Property

Purpose To enable or disable the overflow warning function.

Property Overflow warning Lets you specify whether the overflow warning is
enabled. If enabled, the overflow warning occurs when the value does not
match the predefined range. Arrows are displayed below the start and end
points of the numerical scale to indicate whether the value is too large or too
small to be displayed.

Related instruments This property is available for the following instruments:


§ Bar on page 309
§ Gauge on page 332
§ Slider on page 368
§ Knob on page 347

Related topics Basics

Basics of Handling the Gauge................................................................................................. 110


Basics of Handling the Knob................................................................................................... 143
Basics of Handling the Slider................................................................................................... 162

Overlay Elements Properties (Time Plotter/Index Plotter)

Purpose To configure overlay elements that can be displayed in the plotter's chart.

Overlay elements property Lets you open the Overlay Elements dialog. The defined overlay elements are
listed on the left border of the dialog. Select an overlay element to specify its
properties.

Overlay elements can be text elements, pictures, colored rectangles, etc.

You can use the following buttons to configure the list.

Button Description
Add Adds a new overlay element to the list.
Moves the selected element to the top.

508
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Button Description
Moves the selected element to the bottom.

Deletes the selected element.

Overlay element properties Dock type Lets you select how to specify the size and position of the overlay
element. The selection affects the properties that are available in the element's
Size and Position category. Refer to Size and position properties on page 510.

Dock Description
Type
Axes Lets you specify the element's size and position by assigning axis
values to each side of the element.
The position values refer to the coordinate system of the chart, i.e.,
the overlay element moves with the chart.
Point Lets you specify the element's size and position by assigning axis
<corner> values to one selected corner (TopLeft, TopRight, BottomLeft,
BottomRight). The selected corner serves as the the zero point for
the width and the height settings.
The position values refer to the coordinate system of the chart, i.e.,
the overlay element moves with the chart.
None Lets you specify the element's size and position by assigning
position values to the top left corner of the element. The top
left corner serves as the zero point for the width and the height
settings.
The position values refer to the coordinate system of the plotter
instrument itself, not to the coordinate system of the chart, i.e.,
the overlay element does not move with the chart. With x = 0 and
y = 0, the top left corner of the overlay element is positioned at
the top left corner of the plotter.

Tip

If the overlay element is invisible, check whether it is covered


by the plotter's legend or its y-axis area.

Selectable Lets you specify whether the overlay element can be selected and
moved with the mouse pointer.

Visible Lets you display the overlay element in the plotter's chart area.

Background properties To specify background properties of the overlay element, such as color and
picture properties.

Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

509
May 2024 ControlDesk Instrument Handling
Reference Information

Picture Lets you specify background picture properties of the overlay


element.

Picture – Path (Available only if Visible is enabled) Lets you enter a path and
file name for the image or select one via the Browse button.

Picture – Transparency (Available only if Visible is enabled) Lets you specify


the transparency value of the picture (0 = full transparency, 255 = no
transparency).

Tip

If the picture is not visible, check the transparency setting of the


background color. The picture might be invisible if the element's
background color is not not sufficiently transparent.

Picture – Visible Lets you specify whether an image is displayed. If enabled,


you can specify the picture’s file name and transparency.

Border properties To specify the border properties of the overlay element.

Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

Enabled Lets you specify whether a border is displayed for the overlay
element.

Caption properties To specify the caption properties of the overlay element.

Alignment Lets you specify where to place the caption of the overlay
element.

Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

Font Opens a dialog for you to specify a font. If the element uses the general
font settings from the ControlDesk Options dialog, select Use custom font
settings to make the font settings in the dialog available.

Text Lets you specify the text of the element's caption.

Size and position properties To specify the size and position properties of the overlay element.

Auto size to caption Lets you specify to automatically adjust the element
size to the caption.

X-axis maximum value (Available only if Dock type is set to Axis and Auto
size to caption is disabled) Lets you specify the position of the right border of
the overlay element. The axis value refers to the coordinate system of the chart,
i.e., the overlay element moves with the chart.

X-axis minimum value (Available only if Dock type is set to Axis. and Auto
size to caption is disabled) Lets you specify the position of the left border of the

510
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

overlay element. The axis value refers to the coordinate system of the chart, i.e.,
the overlay element moves with the chart.

Y-axis maximum value (Available only if Dock type is set to Axis) Lets you
specify the position of the upper border of the overlay element. The axis value
refers to the coordinate system of the chart, i.e., the overlay element moves with
the chart.

Y-axis minimum value (Available only if Dock type is set to Axis and Auto
size to caption is disabled.) Lets you specify the position of the lower border of
the overlay element. The axis value refers to the coordinate system of the chart,
i.e., the overlay element moves with the chart.

X-axis value (Available only if Dock type is set to one of the Point <corner>
values). Lets you specify the selected corner (TopLeft, TopRight, BottomLeft,
BottomRight) as the zero point for the width and the height of the overlay
element. The position values belong to the coordinate system of the chart, i.e.,
the overlay element moves with the chart. If the overlay element is invisible,
check whether it is covered by the plotter's legend or the y-axis area.

Y-axis value (Available only if Dock type is set to one of the Point <corner>
values). Lets you specify the selected corner (TopLeft, TopRight, BottomLeft,
BottomRight) as the zero point for the width and the height of the overlay
element. The position values belong to the coordinate system of the chart, i.e.,
the overlay element moves with the chart. If the overlay element is invisible,
check whether it is covered by the plotter's legend or the y-axis area.

Height (Available only if Dock type is set to None or to one of the


Point <corner> values and Auto size to caption is disabled) Lets you specify
the height of the overlay element.

Width (Available only if Dock type is set to None or to one of the


Point <corner> values and Auto size to caption is disabled) Lets you specify
the width of the overlay element.

X (Available only if Dock type is set to None). Lets you specify the x-value of
the top left corner as the zero point for the width and the height of the overlay
element. The x-value belongs to the coordinate system of the plotter instrument
itself, not to the coordinate system of the chart, i.e., the overlay element does
not move with the chart. With x = 0 and y = 0, the top left corner of the overlay
element is positioned at the top left corner of the plotter. If the overlay element
is invisible, check whether it is covered by the plotter's legend or the y-axes area.

Y (Available only if Dock type is set to None). Lets you specify the top left
corner as the zero point for the width and the height of the overlay element. The
y-value belongs to the coordinate system of the plotter instrument itself, not to
the coordinate system of the chart, i.e., the overlay element does not move with
the chart. With x = 0 and y = 0, the top left corner of the overlay element is
positioned at the top left corner of the plotter. If the overlay element is invisible,
check whether it is covered by the plotter's legend or the y-axes area.

Related instruments These properties are available for the following instruments:
§ Index Plotter on page 341
§ Time Plotter on page 384

511
May 2024 ControlDesk Instrument Handling
Reference Information

Related topics Basics

Basics of Handling the Index Plotter........................................................................................ 120


Basics of Handling the Time Plotter......................................................................................... 216

Overlay Picture Properties

Purpose To configure the properties of a picture placed behind the scale and covering a
part of the instrument's background.

Properties For details on the available properties of an overlay picture, refer to Picture
Properties on page 512.

Related instruments These properties are available for the following instrument:
§ Bar on page 309

Picture Properties

Purpose To specify whether to use a picture for the selected element and to specify its
properties. Depending on the selected instrument or instrument element, you
can also use an animated GIF.

Properties Alpha (Available only if Visible is enabled. Availability depends on the


selected instrument or instrument element) Lets you specify the transparency
of the picture. Decrease the value to increase the transparency.

Embedded (Available only if Visible is enabled) Lets you specify whether to


save only the reference path to the picture or to embed the whole picture in the
project file. If a picture has been embedded and you remove the embedding,
ControlDesk stores the picture in the Files folder, which is a subfolder of the
Experiment Layouts folder.

Tip

To access an embedded picture, for example to copy it, disable Embedded


and use the path displayed in Picture path or Path.

Picture path/Path (Available only if Visible is enabled) Lets you enter a path
and file name for the picture/animated GIF or select one via the Browse button.

512
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Style (Available only if Visible is enabled. Availability depends on the selected


instrument or instrument element) Lets you select a picture style:
§ Single
Lets you keep the original size of the picture.
§ Stretched
Lets you fit the picture to the size of the element’s visible area.
§ Proportional
Lets you shrink or expand the picture so that it fits into the element’s visible
area undistorted.
§ Tiled
Lets you keep the original size of the picture and arrange it in the element’s
visible area multiple times.

Visible Lets you specify whether a picture or animated GIF is displayed. If


enabled, you can specify the picture’s properties.

Tip

When you make a background picture visible, you can adjust the instrument
size to the size of the background picture by selecting Resize to Image in
the instrument's context menu.

Related instruments These properties are available for various instruments.

Pitch Scale Properties

Purpose To configure the properties of the pitch scale.

Description The pitch value specifies the orientation of an aircraft with the angle of the pitch
axis. A positive value means the aircraft is moving up. A negative value means
the aircraft is moving down.
Major tic
Minor tic

Visible interval length

Count value of minor tics

513
May 2024 ControlDesk Instrument Handling
Reference Information

Properties Color of labels Opens a dialog for you to select a color or enter values to
set one. For more information on the dialog settings, refer to Color Property on
page 452.

Color of tics Opens a dialog for you to select a color or enter values to set
one. For more information on the dialog settings, refer to Color Property on
page 452.

Font Lets you select a font for the tics.

Height Lets you specify the height of the pitch scale.

Major tics Lets you specify the properties of the major tics.

Major tics - Length Lets you specify the length of the major tics in pixels.

Major tics - Width Lets you specify the width of the major tics in pixels.

Minor tics Lets you specify the properties of the minor tics.

Minor tics - Count Lets you specify the number of minor tics between two
major tics on the pitch scale.

Minor tics - Length Lets you specify the length of the minor tics in pixels.

Minor tics - Width Lets you specify the width of the minor tics in pixels.

Visible Lets you specify whether the scale is displayed.

Visible interval length Lets you specify the visible interval length of the pitch
scale.

Related instruments These properties are available for the following instrument:
§ Artificial Horizon on page 272

Related topics Basics

Basics of Handling the Artificial Horizon.................................................................................. 103

Quick Sort Property

Purpose To sort the instrument rows of the Variable Array.

Property Quick sort Lets you sort the instrument rows of the Variable Array by clicking
the column headers.

514
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Related instruments This property is available for the following instrument:


§ Variable Array on page 389

Related topics Basics

Basics of Handling the Variable Array...................................................................................... 241

Radio Button Style Property

Purpose To specify the appearance of the buttons.

Property Radio button style Lets you specify the appearance of the buttons.

Related instruments This property is available for the following instrument:


§ Radio Button on page 363

Radius Property

Purpose To specify the value for the radius of the instrument.

Property Radius (Available only if Automatic Sizing is disabled) Lets you specify the
radius of the knob or gauge.

Related instruments This property is available for the following instruments:


§ Gauge on page 332
§ Knob on page 347

Related topics Basics

Basics of Handling the Gauge................................................................................................. 110


Basics of Handling the Knob................................................................................................... 143

515
May 2024 ControlDesk Instrument Handling
Reference Information

Range Check Properties

Purpose To configure a range check for the value.

Range check properties Range check mode Lets you select a check mode to check whether the value
is within a predefined range. The following modes are available:

List Entries Description


Enabled Enables the range check. When you change
the value, the write operation to the connected
variable is only executed if the value is within the
predefined range. If you try to write an invalid
value, an acoustic signal indicates that the value
cannot be written.
Disabled Disables the range check. The range limitations are
not relevant for reading and writing values.
Warning Enables the range check for warnings. The
instrument can write invalid values, but this causes
a warning. All invalid values of the connected
variable are indicated by a red section.

Range max. (Available only if "Use variable range" is disabled) Lets you enter
the maximum value to specify the upper range limit of the variable. Click the
icon next to the edit field to specify the value in source format ( icon) or in
converted format ( icon).

Range min. (Available only if "Use variable range" is disabled) Lets you enter
the minimum value to specify the lower range limit of the variable. Click the
icon next to the edit field to specify the value in source format ( icon) or in
converted format ( icon).

Use variable range Lets you disable the user-defined variable range. If the
checkbox is selected, the range of the variable description file (weak limits) is
used and you cannot define a user-specific range. The edit fields for specifying
the check mode and range are disabled.

Related instruments These properties are available for the following instruments:
§ Knob on page 347
§ Numeric Input on page 357
§ Slider on page 368
§ Variable Array on page 389
§ Hierarchy Array on page 336

516
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Related topics Basics

Basics of Handling the Hierarchy Array.................................................................................... 114


Basics of Handling the Knob................................................................................................... 143
Basics of Handling the Slider................................................................................................... 162
Basics of Handling the Variable Array...................................................................................... 241

Range Properties

Purpose To configure the scale range properties of the selected instrument.

Properties Maximum range (Available only if "Use variable range" is disabled) Lets you
specify the maximum of the scale. Click the icon next to the edit field to specify
the value in source format ( icon) or in converted format ( icon).

Minimum range (Available only if "Use variable range" is disabled) Lets you
specify the minimum of the scale. Click the icon next to the edit field to specify
the value in source format ( icon) or in converted format ( icon).

Use variable range Lets you specify whether to use the variable's weak limits
in the variable description for the instrument's scale.

Related instruments These properties are available for the following instruments:
§ Bar on page 309
§ Gauge on page 332
§ Slider on page 368
§ Knob on page 347

Related topics Basics

Basics of Handling the Gauge................................................................................................. 110


Basics of Handling the Knob................................................................................................... 143
Basics of Handling the Slider................................................................................................... 162

Range Properties (Animated Needle)

Purpose To specify a range for the variable value displayed in the selected instrument.

517
May 2024 ControlDesk Instrument Handling
Reference Information

Properties Maximum range (Available only if "Use variable range" is disabled) Lets you
specify the maximum of the needle's scale. Click the icon next to the edit field to
specify the value in source format ( icon) or in converted format ( icon).

Minimum range (Available only if "Use variable range" is disabled) Lets you
specify the minimum of the needle's scale. Click the icon next to the edit field to
specify the value in source format ( icon) or in converted format ( icon).

Use variable range Lets you disable the user-defined variable range. If the
checkbox is selected, the range of the variable description file (weak limits) is
used and you cannot define a user-specific range. The edit fields for specifying
the range are disabled.

Related instruments These properties are available for the following instrument:
§ Animated Needle on page 307

Regions Properties

Purpose To enable or disable regions in a Bus Instrument.

Properties Enable Region Captions Lets you specify whether to display a region in an
instrument. The available regions depend on the type of instrument.

Related instruments These properties are available for the following instrument:
§ Bus Instrument on page 315

Related topics HowTos

How to Configure a Bus Instrument (ControlDesk Bus Navigator )

Roll Scale Properties

Purpose To configure the properties of the roll scale.

Description The roll value specifies the orientation of an aircraft with the angle of the roll
axis. A positive value means the aircraft is turning right. A negative value means
the aircraft is turning left.

518
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Properties Color of tics Opens a dialog for you to select a color or enter values to set
one. For more information on the dialog settings, refer to Color Property on
page 452.

Major tics Lets you specify the properties of the major tics.

Major tics - Delta Lets you specify the delta between two major tics. The
delta value influences the number of tics, so it should not be too small.

Major tics - Length Lets you specify the length of the major tics in pixels.

Major tics - Width Lets you specify the width of the major tics in pixels.

Maximal roll value Lets you specify the maximal roll value. A value between
0 and 90 is valid. If the input value is not between 0 and 90, the value is
automatically limited to 90.

Minor tics Lets you specify the properties of the minor tics.

Minor tics - Count Lets you specify a value to configure the count of minor
tics between two major tics.

Minor tics - Length Lets you specify the length of the minor tics in pixels.

Minor tics - Width Lets you specify the width of the minor tics in pixels.

Pitch scale distance Lets you specify the distance of the roll scale to the pitch
scale.

Roll pointer Lets you specify the properties of the roll pointer.

Roll pointer - Color Opens a dialog for you to select a color or enter values
to set one. For more information on the dialog settings, refer to Color Property
on page 452.

Roll pointer - Height Lets you specify the height of the roll pointer.

Roll pointer - Width Lets you specify the width of the roll pointer.

Visible Lets you specify whether the scale is displayed.

Zero pointer Lets you specify the properties of the zero pointer.

Zero pointer - Color Opens a dialog for you to select a color or enter values
to set one. For more information on the dialog settings, refer to Color Property
on page 452.

Zero pointer - Height Lets you specify the height of the zero pointer.

Zero pointer - Width Lets you specify the width of the zero pointer.

Related instruments These properties are available for the following instrument:
§ Artificial Horizon on page 272

Related topics Basics

Basics of Handling the Artificial Horizon.................................................................................. 103

519
May 2024 ControlDesk Instrument Handling
Reference Information

Row Header Width Property

Purpose To specify the width of the first column of the Variable Array.

Property Row header width Lets you specify the width of the first column of the
Variable Array. The first column cannot be deleted and is always shown.

Related instruments This property is available for the following instrument:


§ Variable Array on page 389

Related topics Basics

Basics of Handling the Variable Array...................................................................................... 241

Rows Properties

Purpose To configure the properties of the rows in the Variable Array.

Rows list Lets you open the Rows dialog. The defined rows are listed on the left side of
the dialog. Select a row to specify its properties.

You can use the following buttons to configure the list.

Button Description
Add Adds a new row to the list.
Moves the selected element to the top.

Moves the selected element to the bottom.

Deletes the selected element.

Toolbar A toolbar is displayed above the property list. The buttons let you configure the
view of the list or search for items in the list, for example.

For more details on the toolbar buttons, refer to Toolbar buttons (ControlDesk
User Interface Handling ).

520
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Selected rows properties To configure the properties of the selected rows.

Background color Opens a dialog for you to select a color or enter values to
set one. For more information on the dialog settings, refer to Color Property on
page 452.

Foreground color Opens a dialog for you to select a color or enter values to
set one. For more information on the dialog settings, refer to Color Property on
page 452.

Selected variables To display and configure the variables that are connected to the instrument.For
details, refer to Variables Properties on page 562.

Related instruments These properties are available for the following instrument:
§ Variable Array on page 389

Related topics Basics

Basics of Handling the Variable Array...................................................................................... 241

Rows Properties (Hierarchy Array)

Purpose To specify the properties of header rows and rows in the Hierarchy Array.

Rows list The defined rows are listed on the left-hand side of the dialog. Select a row to
specify its properties.

You can use the following buttons to configure the list.

Button Description
Add Adds a new row to the list.
Moves the selected element up in the list.

Moves the selected element down in the list.

Deletes the selected element.

521
May 2024 ControlDesk Instrument Handling
Reference Information

Toolbar A toolbar is displayed above the property list. The buttons let you configure the
view of the list or search for items in the list, for example.

For more details on the toolbar buttons, refer to Toolbar buttons (ControlDesk
User Interface Handling ).

Selected rows properties To configure the properties of the selected rows.

Height Lets you specify the height of the selected rows.

Cells Lets you add cells to the selected rows.


Refer to Cell Properties on page 447.

Indent (Only for header rows) Lets you specify the indent of the subordinate
rows.

Rows (Only for header rows) Lets you add rows below the selected header
row.

Related instruments These properties are available for the following instrument:
§ Hierarchy Array on page 336

Related topics Basics

Basics of Handling the Hierarchy Array.................................................................................... 114

Scale Properties

Purpose To configure the scale properties of the selected instrument.

Properties Direction Lets you select the direction of the scale:

Direction Description
Forward To display the scale from left to right, bottom to
top, or clockwise.
Backward To display the scale from right to left, top to
bottom, or counter clockwise.

Position Lets you select the position of the tics.

Position offset (for Bar and Slider) (Available only if Automatic Sizing is
disabled.) Lets you specify the offset between slidebar center and scale.

522
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Radius property (for Gauge and Knob) (Available only if Automatic


Sizing is disabled) Lets you specify the distance between the hub position and
the scale. You can move the scale inside the operating element by changing its
horizontal or vertical hub position.

Visible Lets you specify whether the scale is displayed. If the checkbox is
cleared, all entries for the scale and tics are disabled.

Indicators properties To configure the properties of the minimum and maximum indicators of the
instrument. Indicators are used to display the absolute minimum and maximum
of a value as colored marks on the scale.

If you change the conversion mode, scale values and indicator values are
recalculated to keep the positions of the indicators.

Maximum Lets you configure the properties of the maximum indicator.

Minimum Lets you configure the properties of the minimum indicator.

You can specify the following properties for the minimum and maximum
indicators:

Enabled Lets you specify whether the minimum indicator is enabled. The
minimum indicator must be enabled to change its settings.

Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

Style Lets you select a style from a list to specify the shape of the indicator as
a line, triangle, or pointer.

Value Lets you reset the indicator to the current value of the instrument.

Tip

The indicators can also be reset via the instrument’s context menu and
keyboard. To reset their values via keyboard, press R (Min-Indicator) or
Shift+R (Max-Indicator).

Labels properties To configure the label properties.

Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

Font (Available only if "Use custom fonts" is enabled) Lets you select a font
for the tics.

Label rotation Lets you specify whether the labels are displayed horizontally
or rotated (with the bottom to the center point of the circular scale).

Offset Lets you specify the distance between the tics and their labels (0-500,
default: 3).

Use exponents Lets you specify whether the label numbers are displayed in
exponential notation.

523
May 2024 ControlDesk Instrument Handling
Reference Information

Visible Lets you specify whether the major tics of the scale are labeled. If the
checkbox is cleared, all entries for the labels are disabled.

Tics properties To specify tics properties.

Visible Lets you specify whether the tics of the scale are displayed. If the
checkbox is cleared, all of the settings for tics are disabled.

Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

Offset Lets you specify the distance between the tics and the
slidebar/needle/knob (0...500, default: 3).

Note

If you have enabled the "Automatic Sizing" option, the part of the
instrument including the tics is automatically fitted into its operating
element. If the "Automatic Sizing" option is disabled, the size of the
operating element’s contents remains the same. If you enlarge the tics'
offset, the tics are shifted to the border of the operating element and might
be displayed incompletely.

Major Lets you specify the properties of the major tics.

Major – Length Lets you specify the length of the major tics in pixels.

Major – Width Lets you specify the width of the major tics in pixels.

Major – Minimum (Available only if "Automatic Sizing" is disabled) Lets you


specify the start value for the major tics of the scale. This value defines the
number of the start tic. The scale is recalculated according to the delta entered.

Major – Maximum (Available only if "Automatic Sizing" is disabled) Lets you


specify the end value for the major tics of the scale. This value defines the upper
limit of the major tics scale.

Major – Delta (Available only if "Automatic Sizing" is disabled) Lets you


specify the delta between two major tics. The delta value influences the number
of tics, so it should not be too small.

Minor Lets you specify the properties of the minor tics.

Minor – Length Lets you specify the length of the minor tics in pixels.

Minor – Width Lets you specify the width of the minor tics in pixels.

Minor – Count (Available only if "Automatic Sizing" is disabled) Lets you


specify a value in the range 0 - 500 to configure the count of minor tics between
two major tics.

Related instruments These properties are available for the following instruments:
§ Bar on page 309
§ Gauge on page 332

524
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

§ Slider on page 368


§ Knob on page 347

Related topics Basics

Basics of Handling the Gauge................................................................................................. 110


Basics of Handling the Knob................................................................................................... 143
Basics of Handling the Slider................................................................................................... 162

Scale Properties (Avionics)

Purpose To configure the properties of the scale.

Description The available properties of the scale depend on the selected avionics instrument.
Minor tic

Major tic

Visible interval length Delta value

Colored band

The scale of the Heading Indicator is circular. It turns so that the direction the
aircraft is headed in is always on the twelve o'clock position.

Major tic

Minor tic

Properties Bands To configure the properties of the bands. Refer to Bands Properties
(Airspeed Indicator) on page 436.

525
May 2024 ControlDesk Instrument Handling
Reference Information

Color of labels Opens a dialog for you to select a color or enter values to
set one. For more information on the dialog settings, refer to Color Property on
page 452.

Color of tics Opens a dialog for you to select a color or enter values to set
one. For more information on the dialog settings, refer to Color Property on
page 452.

Font Lets you select a font for the tics.

Major tics Lets you specify the properties of the major tics.

Major tics - Delta Lets you specify the delta between two major tics. The
delta value influences the number of tics, so it should not be too small.

Major tics - Length Lets you specify the length of the major tics in pixels.

Major tics - Width Lets you specify the width of the major tics in pixels.

Minor tics Lets you specify the properties of the minor tics.

Minor tics– Count Lets you specify a value to configure the count of minor
tics between two major tics.

Minor tics - Length Lets you specify the length of the minor tics in pixels.

Minor tics - Width Lets you specify the width of the minor tics in pixels.

Radius Displays the radius of the heading indicator's scale.

Visible Lets you specify whether the scale is displayed.

Visible interval length Lets you specify the length of the displayed interval.

Related instruments These properties are available for the following instruments:
§ Airspeed Indicator on page 268
§ Altimeter on page 270
§ Heading Indicator on page 275

Scale Range Properties (Value Cell – Bar/Slider)

Purpose To configure the scale range properties of the selected Bar or Slider cell.

Properties Max. Lets you specify the maximum of the linear scale in the selected value
cell. Click the icon next to the edit field to specify the value in source format
( icon) or in converted format ( icon).

Min. Lets you specify the minimum of the linear scale in the selected value
cell. Click the icon next to the edit field to specify the value in source format
( icon) or in converted format ( icon).

526
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Use variable range Lets you specify whether the variable's weak limits in the
variable description are used for the linear scale in the selected value cell.

Related instruments These properties are available the following instrument:


§ Hierarchy Array on page 336
§ Variable Array on page 389

Related topics Basics

Basics of Handling the Hierarchy Array.................................................................................... 114


Basics of Handling the Variable Array...................................................................................... 241

Script Property

Purpose To extend the functionality of an instrument or layout by adding Python code to


it.

Property Script Lets you assign Python code to an event of the selected instrument,
instrument page, or layout. The Code Editor dialog is opened, containing
appropriate event handler templates for the element. Refer to Code Editor
Dialog on page 604.

Related instruments This property is available for various instruments.

Related topics Basics

Adding a Python Script to an Instrument or Layout (ControlDesk Customization )

Scroll Bar Properties (Time Plotter/Index Plotter)

Purpose To specify the scroll bar properties.

527
May 2024 ControlDesk Instrument Handling
Reference Information

Properties Height Lets you specify the scroll bar's height in pixels.

Enabled Lets you show or hide the plotter's scroll bar. You must stop a
running measurement to use the scroll bar.
§ Drag the scroll box to navigate through the measurement.

§ Drag the edges of the scroll box to change the zoom settings.

Preview signal visible Lets you show or hide the measured signal as a
preview in the scroll bar.

Related instruments These properties are available for the following instruments:
§ Index Plotter on page 341
§ Time Plotter on page 384

Related topics Basics

Zooming and Moving the Chart (Index Plotter)....................................................................... 124


Zooming and Moving the Chart (Time Plotter)........................................................................ 224

References

Preview Signal Visible............................................................................................................. 692


Show Scroll Bar (Time Plotter/Index Plotter)............................................................................. 715

Segmented Property

Purpose To segment the bar according to the tics of the scale.

Property Segmented Lets you specify that the bar will be segmented according to the
tics of the scale.

Related instruments This property is available for the following instrument:


§ Bar on page 309

528
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Selected Cells Properties (Variable Array - Value Cell)

Purpose To specify the properties of the selected cells.

Property Cell properties Lets you specify the properties of the selected cells. The
displayed properties depend on the selected cell type.

Related instruments These properties are available for the following instrument:
§ Variable Array on page 389

Related topics Basics

Basics of Handling the Variable Array...................................................................................... 241

Selected Column Properties

Purpose To configure the properties of the selected column of the Variable Array.

Properties Column header text Lets you specify the text to be displayed in the header
of the current column.

Default label cell text Lets you specify the default text to be displayed in the
cells of the current column. You can use macros for the label text.

Macro Description
{%BLOCK%} Block name of the variable
{%DATATYPE%} Data type of the variable
{%DEVICE%} Name of the connected platform/device
{%DESCRIPTION%} Description text of the variable, if specified
in the variable description file
{%DISPLAYMODE%} Display mode of the variable
{%MODE%} Conversion mode of the variable
{%PATH%} Path of the variable
{%UNIT%} Unit of the variable
{%UNIT%}{%DISPLAYMODESOURCE%} Unit and display mode of the variable
{%VALUE%} Value of the variable
{%VARIABLE%} Name of the variable

529
May 2024 ControlDesk Instrument Handling
Reference Information

Text abbreviation rule Lets you select a rule to abbreviate text if it is too
long to be displayed in the cell.

Rule Description
Leave text unchanged The text is truncated at the right end.
Show text from left The text is truncated at the right end. An ellipsis (...)
indicates the truncation.
Show text from right The text is truncated at the left end. An ellipsis (...)
indicates the truncation.
Truncate text in the The text is truncated in the middle. An ellipsis (...)
middle indicates the truncation.

Width Lets you specify the width of the selected column in the Variable
Array.

Related instruments These properties are available for the following instrument:
§ Variable Array on page 389

Related topics Basics

Basics of Handling the Variable Array...................................................................................... 241

Selected Element(s) Property

Purpose To specify the properties of the elements that are currently selected in the
instrument.

Related instruments This property is available for the following instruments:


§ Index Plotter on page 341
§ Time Plotter on page 384
§ XY Plotter on page 396

Related topics Basics

Basics of Handling the Index Plotter........................................................................................ 120


Basics of Handling the Time Plotter......................................................................................... 216
Basics of Handling the XY Plotter............................................................................................ 253

530
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Selected Variables Property

Purpose To specify the properties of the variables that are currently selected in the
instrument.

Related instruments This property is available for the following instruments:


§ Variable Array on page 389

Related topics Basics

Basics of Handling the Variable Array...................................................................................... 241

Selection Border Style Property

Purpose To select a style for the selection border of the current instrument.

Property Selection Border Style Lets you select a style for the selection border of the
current instrument. You can change the global setting for the selection border
style on the Instruments page of the ControlDesk Options dialog.

Related instruments This property is available for various instruments.

Selection Box Cell Properties

Purpose To configure the properties of the selected Selection box cell.

Properties Items To add and remove Selection box items and configure their settings.
Refer to Items Properties on page 487.

Display value Lets you specify whether to display the predefined value, to
which the parameter is set when the corresponding drop-down list entry is
selected. If enabled, the value is displayed in brackets behind the text of the list
entry.

Off text Lets you specify the text to be displayed when no Selection box item
is selected.

531
May 2024 ControlDesk Instrument Handling
Reference Information

Related instruments These properties are available for the following instrument:
§ Hierarchy Array on page 336

Related topics Basics

Basics of Handling the Hierarchy Array.................................................................................... 114

Selection Box Properties

Purpose To specify the Selection Box-specific settings.

Properties Combobox color Opens a dialog for you to select a color or enter values to
set one. For more information on the dialog settings, refer to Color Property on
page 452.

Display value Lets you specify whether to display the predefined value,
which is set to the parameter when the corresponding drop-down list entry is
selected. If enabled, the value is displayed in brackets behind the text of the list
entry.

Export configuration Lets you enter the name of the CSV file to which the
text-value entries are saved.

Font (Available only if "Use custom fonts" is enabled) Lets you select the font
for the Selection Box text via the Font dialog.

Import configuration Lets you select a CSV file from which the text-value
entries are imported.

Note

The data from the file is used to create the text-value entries. Existing
entries in the Text ID list are deleted. After importing the text-value entries,
you can add or remove them to or from the list.

Incremental search Lets you specify to use incremental search when you
select a text. Depending on the text you already typed, the first matching
Selection Box list entry is preselected and can be accepted by pressing Enter.
Incremental search moves from the top to the bottom through the list entries
according to the Sort mode you have selected. The currently preselected list
entry is highlighted.

Off-text Lets you specify the text to be displayed when no Selection Box item
is selected.

532
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Sort mode Lets you select whether the Selection Box list entries are sorted
ascending or descending by text or value. If you select Manual you can specify
the sorting via the States properties, see States Properties on page 540.

Text color Opens a dialog for you to select a color or enter values to set
one. For more information on the dialog settings, refer to Color Property on
page 452.

Transparent Lets you specify whether to set the background of the Selection
Box transparent.

Related instruments These properties are available for the following instrument:
§ Selection Box on page 366

Separator Color Property

Purpose To specify the color of the separators between lines and columns.

Property Separator Color Opens a dialog for you to select a color or enter values to
set one. For more information on the dialog settings, refer to Color Property on
page 452.

Related instruments This property is available for the following instrument:


§ Variable Array on page 389
§ Hierarchy Array on page 336

Related topics Basics

Basics of Handling the Hierarchy Array.................................................................................... 114


Basics of Handling the Variable Array...................................................................................... 241

Size and Position Properties (Instrument)

Purpose To configure the size and position of an instrument.

Description These are the basic properties of any instrument. You can enter the size of an
instrument and its position inside the layout numerically.

533
May 2024 ControlDesk Instrument Handling
Reference Information

Properties Height Lets you specify the height of the instrument in pixels.

Width Lets you specify the width of the instrument in pixels.

X Lets you specify the distance of the left margin of the instrument from the
left margin of the layout in pixels.

Y Lets you specify the distance of the top margin of the instrument from the
top margin of the layout in pixels.

Related instruments These properties are available for various instruments.

Size and Position Properties (Scale and Magnifier)

Purpose To specify the relative size and position of the scale and magnifier inside the
instrument.

Properties Height Lets you specify the height of the scale and magnifier (as a
percentage of the instrument height). If you enter a value that is too large in
relation to the y position, it is reduced to the maximum value.

Width Lets you specify the width of the scale and magnifier (as a percentage
of the instrument width). If you enter a value that is too large in relation to the x
position, it is reduced to the maximum value.

X Lets you specify the horizontal position of the left frame of the scale and
magnifier (as a percentage of the instrument width). If you enter a value that is
too large in relation to the width, it is reduced to the maximum value.

Y Lets you specify the vertical position of the upper frame of the scale and
magnifier (as a percentage of the instrument height). If you enter a value that is
too large in relation to the height, it is reduced to the maximum value.

Related instruments This property is available for the following instruments:


§ Airspeed Indicator on page 268
§ Altimeter on page 270

Related topics Basics

Avionics Instruments............................................................................................................... 268

534
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Slide Properties

Purpose To configure the properties of the slide of the Slider.

Properties Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

Height (Available only if "Slider - Automatic Sizing" is disabled) Lets you


enter a height for the slide.

Picture Lets you specify whether to use an image/animated GIF for the slide
and specify its properties. Refer to Picture Properties on page 512.

Shape Lets you select a shape for the slide from a list. You can choose
Rectangle, Pointer, Triangle, or Oval.

Size (Available only if "Slider - Automatic Sizing" is enabled) Lets you select
the size of the slide from a list. You can choose Very Small, Small, Large, or
Very Large.

Snap enabled Lets you specify whether the slider movement is snapped
to the tics of the scale. If the checkbox is cleared, the slide can be moved
continuously.

Style Lets you select a style for the slide from a list. You can choose Raised or
Flat.

Width (Available only if "Slider - Automatic Sizing" is disabled) Lets you enter
a width for the slide.

Related instruments These properties are available for the following instrument:
§ Slider on page 368

Related topics Basics

Basics of Handling the Slider................................................................................................... 162

Slidebar Properties

Purpose To configure the properties of the slidebar.

Properties Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

535
May 2024 ControlDesk Instrument Handling
Reference Information

Horizontal center position (Available only if "Slider - Automatic Sizing" is


disabled) Lets you shift the slidebar (tics, bands, and slide) horizontally inside the
operating element. Enter the horizontal position of the slidebar (in pixels) relative
to the center of the Slider´s operating element.

Height (Available only if "Slider - Automatic Sizing" is disabled) Lets you


specify the height (in pixels) of the slidebar.

Orientation Lets you select the orientation of the slidebar:

Orientation Description
Horizontal To display the slidebar horizontally with the
specified scale position.
Vertical To display the slidebar vertically with the specified
scale position.

Style Lets you select a style from the list. You can select Sunken, Raised,
Flat, or None.

Note

§ If you select None for the slidebar’s style, no slidebar is displayed.


§ If you have selected the Slider - Automatic Sizing option, the slidebar
is fitted automatically into its operating element. The size changes
automatically if you resize the instrument or the operating element. Thus
the following edit fields for setting the size and position of the slidebar
are disabled if the Auto Sizing option is selected.

Vertical center position (Available only if "Slider - Automatic Sizing" is


disabled) Lets you shift the slidebar (tics, bands, and slide) vertically inside the
operating element. Enter the vertical position of the slidebar (in pixels) relative to
the center of the Slider´s operating element.

Width (Available only if "Slider - Automatic Sizing" is disabled) Lets you


specify the width (in pixels) of the slidebar.

Related instruments These properties are available for the following instruments:
§ Bar on page 309
§ Slider on page 368

Related topics Basics

Basics of Handling the Slider................................................................................................... 162

536
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Sound Controller Properties

Purpose To specify the Sound Controller-specific properties.

Configure property Configure Lets you open the Configure dialog of the selected Sound
Controller.

Sound elements list All the defined sound elements are listed on the left side of the Configure
dialog. Select an element to specify its properties.

You can use the following buttons to configure the list.

Button Description
Add Adds a new sound element to the list.
The list on the left lets you select the element to
be added. The types of the elements in the list and
the places where they are added depend on the
sound element that is currently selected in the sound
elements list.
Moves the selected item up in the list.

Moves the selected item down in the list.

Deletes the selected element.

Toolbar A toolbar is displayed above the property list. The buttons let you configure the
view of the list or search for items in the list, for example.

For more details on the toolbar buttons, refer to Toolbar buttons (ControlDesk
User Interface Handling ).

Audio group properties Description Lets you specify the description for the audio group. The
description is displayed in the instrument.

Name Lets you specify the name of the audio group.

Quality value Lets you specify a quality value for the audio group. If the
quality value of the instrument's quality control is set to the quality value of the
audio group, the audio group is played. If it is set between the quality values of
two audio groups, the Sound Controller interpolates between the audio groups
with regard to volume. This allows you, for example, to play different engine
sounds in relation to the loads on the engine and to interpolate between them.

537
May 2024 ControlDesk Instrument Handling
Reference Information

Sound properties Continue from stop position Lets you specify to play the sound from the
position it was previously stopped at. If this option is cleared, the sound will
always be played from the beginning.

Description Lets you specify a description for the sound. The description is
visible in the instrument.

Frequency control Lets you specify the properties of the instrument's


frequency control. If the frequency value of the instrument's frequency control
is set to the frequency of the audio stream, it is played. If it is set between the
frequencies of two audio streams, the Sound Controller interpolates between
the audio streams with regard to frequency and volume. This allows you, for
example, to play different engine sounds in relation to the engine speed and to
interpolate between them.

Frequency control - Maximum frequency value Lets you specify the


maximum value the sound's frequency can be set to. Set the maximum
frequency higher than the minimum frequency to specify a proper frequency
range.

Frequency control - Minimum frequency value Lets you specify the


minimum value the sound's frequency can be set to. Set the minimum frequency
lower than the maximum frequency to specify a proper frequency range.

Frequency control - Variable Lets you specify the properties of a connected


frequency variable.

Name Lets you specify the name of the sound. The name is visible in the
instrument.

Repeat continuous Lets you specify to play the sound in an endless loop
until you explicitly stop it.

Quality control Lets you specify the properties of the instrument's quality
control. If the quality value of the instrument's quality control is set to the quality
value of the audio group, the audio group is played. If it is set between the
quality values of two audio groups, the Sound Controller interpolates between
the audio groups with regard to volume. This allows you, for example, to play
different engine sounds in relation to the loads on the engine and to interpolate
between them.

Quality control - Maximum quality value Lets you specify the maximum
value the sound's quality can be set to. Set the maximum quality higher than the
minimum quality to specify a proper quality range.

Quality control - Minimum quality value Lets you specify the minimum
value the sound's quality can be set to. Set the minimum quality lower than the
maximum quality to specify a proper quality range.

Quality control - Variable Lets you specify the properties of a connected


quality variable.

Volume control Lets you specify the properties of the instrument's volume
control.

Volume control - Maximum volume Lets you specify the maximum value
the sound can be set to. The maximum volume can be set from 0 to 2^24.

538
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Set the maximum volume higher than the minimum volume to specify a proper
volume range.

Volume control - Minimum volume Lets you specify the minimum value
the sound can be set to. The minimum volume can be set from 0 to 2^24.
Set the minimum volume lower than the maximum volume to specify a proper
volume range.

Volume control - Variable Lets you specify the properties of a connected


volume variable.

Start/stop condition Lets you specify the start and stop conditions of the selected sound.
properties
Condition type (start/stop condition) Lets you select one of the following
condition types for starting/stopping the sound output:

Condition Type Description


Disabled Disables the start or stop condition
for the selected sound.
POS EDGE Returns 'true' if the value of the
connected variable changes from
a value lower than the specified
condition value to a value greater
than or equal to the specified
condition value.
NEG EDGE Returns 'true' if the value of the
connected variable changes from
a value higher than the specified
condition value to a value less than
or equal to the specified condition
value.
Operator (==, !=, < , > , ...) Compares the value of the
connected variable with the specified
condition value. Returns 'true' if the
condition specified by the selected
operator is met.
Changed Returns 'true' each time the value of
the connected variable has changed.

Start condition Lets you specify the start condition of the sound.

Stop condition Lets you specify the stop condition of the sound.

Condition Value Lets you specify the condition value. The condition value is
compared to the value of the connected variable (start/stop condition) to trigger
the sound output.

Variable (start/stop condition) Lets you specify the properties of the


connected variable. The value of the connected variable is compared to the
specified condition value to trigger the sound output.

539
May 2024 ControlDesk Instrument Handling
Reference Information

Wave properties Frequency value Lets you specify a frequency value for the audio stream. If
the frequency value of the instrument's frequency control is set to the frequency
of the audio stream, it is played. If it is set between the frequencies of two audio
streams, the Sound Controller interpolates between the audio streams with
regard to frequency and volume. This allows you, for example, to play different
engine sounds in relation to the engine speed and to interpolate between them.

Name Displays the name of the MP3 or WAV file that contains the audio
stream.

Related instruments These properties are available for the following instrument:
§ Sound Controller on page 372

Related topics Basics

Basics on Handling the Sound Controller................................................................................ 167

References

Sound Controller.................................................................................................................... 372

States Properties

Purpose To add and remove states and configure their settings.

States list On the left side of the dialog all defined states are listed. The states are checked
beginning at the top of the list until the first match is reached. Select a state to
specify its properties.

You can use the following buttons to configure the list.

Button Description
Add Adds a new state to the bottom of the list.
Moves the selected state up in the list.

Moves the selected state to the bottom of the list.

Deletes the selected state.

MultiState Display - States Lets you specify the properties for the selected states.
properties
LED Lets you specify the LED display settings of the selected state.

540
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

LED - Color (Available only for the LED, LED and Message, or Custom
display mode) Lets you specify the LED color of the selected state.

LED - Enabled (Available only for the Custom display mode) Lets you enable
or disable the LED display for the selected state.

LED - Blinking color Lets you specify the LED blinking color for the selected
state.

LED - Blinking enabled Lets you enable LED blinking for the selected state.

LED - Blinking interval Lets you specify the blinking interval for the selected
state in milliseconds.

Message Lets you specify the message display settings of the selected state.

Message - Color (Available only for the Message, LED and Message, or
Custom display mode) Lets you specify the text color of the selected state. Click
and choose a predefined color from the box or click "..." to open a standard
Windows Color dialog.

Message - Enabled (Available only for the Custom display mode) Lets you
enable or disable the message display for the selected state.

Message - Text (Available only for the Message, LED and Message, or
Custom display mode) Lets you specify the message to be displayed for the
selected state.

Picture Lets you specify the picture display settings of the selected state.

Picture - Alignment (Available only for the Custom display mode) Lets you
select one of nine options to align the picture in the instrument. Each position is
represented by a button. The center of the instrument is the default position.

Picture - Embedded Lets you specify whether to save only the reference path
to the picture or to embed the whole picture in the project file. If a picture has
been embedded and you remove the embedding, ControlDesk stores the picture
in a temporary folder.
(Available only for the Custom display mode) Lets you specify whether to save
only the reference path to the picture or to embed the whole picture in the
project file. If a picture has been embedded and you remove the embedding,
ControlDesk stores the picture in a temporary folder.

Picture - Enabled (Available only for the Custom display mode) Lets you
enable or disable the picture display for the selected state.

Picture - Path (Available only for the Custom display mode) Lets you enter
the path and file name of a picture/animated GIF or select one via the Browse
button.

Picture - Style (Available only for the Custom display mode) Lets you select a
picture style:
§ Single
Lets you keep the original size of the image.
§ Stretched
Lets you fit the image to the size of the instrument’s visible area.

541
May 2024 ControlDesk Instrument Handling
Reference Information

§ Proportional
Lets you shrink or expand the image so that it fits into the instrument’s visible
area undistorted.
§ Tiled
Lets you keep the original size of the image and arrange it multiple times in
the instrument’s visible area.

Range Lets you specify the picture display settings of the selected state.

Range - Incl. max. Lets you specify whether to include the maximum limit in
the range.

Range - Incl. min. Lets you specify whether to include the minimum limit in
the range.

Range - Maximum Lets you enter the maximum limit of the range for the
selected LED state. Click the icon next to the edit field to specify the value in
source format ( icon) or in converted format ( icon).

Range - Minimum Lets you enter the minimum limit of the range for the
selected LED state. Click the icon next to the edit field to specify the value in
source format ( icon) or in converted format ( icon).

Sound Lets you specify the sound settings of the selected state.

Sound - Embedded Lets you specify whether to save only the reference path
to the sound file or to embed the sound in the project file. If a sound has been
embedded and you remove the embedding, ControlDesk checks whether the
sound file can be found on the reference path. If not, ControlDesk tries to create
the sound file there.

Sound - Enabled Lets you enable or disable the sound effect for the selected
state.

Sound - Path Lets you enter a path and file name of the sound file (WAV or
MP3) or select one via the Browse button.

Sound - Play continuous Lets you specify whether to play the sound
continually.

Selection Box - States Text Lets you specify the text of the Selection Box item to be displayed.
properties
Value Lets you specify the value to be written to the connected variable when
you select the item. Click the icon next to the edit field to specify the value in
source format ( icon) or in converted format ( icon).

Related instruments These properties are available for the following instruments:
§ MultiState Display on page 352
§ Selection Box on page 366

542
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Static Text Properties

Purpose To configure the Static Text-specific settings.

Properties Automatic sizing Lets you specify whether the font size of the static text is
adjusted automatically so that the text always fits in the display area.
If this checkbox is cleared:
§ You can specify the font size via the Text font option. Depending on the size
of the font and instrument, not all of the text can be displayed.
§ You can use the Word wrap option.

Quick input enabled Lets you specify whether the static text can be entered
directly by clicking the instrument in the layout.

Text alignment Lets you select one of the nine options to align the text
inside the Static Text. Each position is represented by a button.

Text angle Lets you specify the angle at which the text is displayed.

Text color Opens a dialog for you to select a color or enter values to set
one. For more information on the dialog settings, refer to Color Property on
page 452.

Text font Lets you specify a font for the text. If the element uses the general
font settings from the ControlDesk Options dialog, select Use custom font
settings to make the font settings in the dialog available.

Value Lets you specify the text to be displayed in the Static Text.

Word wrap (Available only if "Automatic sizing" is disabled) Lets you specify
whether to break lines automatically. If the entered text does not fit into one
line, it is wrapped to the next line. If the selected font is too large for the
amount of text and the instrument size, the text is not displayed completely in
the instrument.

Related instruments These properties are available for the following instrument:
§ Static Text on page 374

Steering Controller Properties

Purpose To specify the Steering Controller-specific properties.

Steering Controller Properties Configure device Lets you open the Game Controllers dialog to configure
the connected controller device.

543
May 2024 ControlDesk Instrument Handling
Reference Information

Name Displays the name of the controller device connected to the Steering
Controller instrument.

Instance GUID Displays the Instance GUID (global unit identifier) string.

Product GUID Displays the Product GUID (global unit identifier) string.

Update frequency Lets you specify the time interval at which the state of the
controller device is updated in the instrument.

Axes and buttons properties / To specify the properties of the selected element. Which properties are displayed
Selected element(s) properties depends on the selected element. If multiple elements are selected, their
common properties are displayed.

Center Lets you specify the value of the center position of the selected axis.
Click the icon next to the edit field to specify the value in source format ( icon)
or in converted format ( icon).

Deadzone Lets you specify a range around the center position in which
motion of the device does not change the variable value. The specified value
describes the dead zone as a percentage of the axis range.

Increment button You can press an increment button to increase/decrease a


parameter value by a predefined value.

Limit Lets you specify the maximum value that can be set via the selected
increment button. Click the icon next to the edit field to specify the value in
source format ( icon) or in converted format ( icon).

Maximum Lets you specify the maximum value of the range of the selected
axis element. Click the icon next to the edit field to specify the value in source
format ( icon) or in converted format ( icon).

Minimum Lets you specify the minimum value of the range of the selected
axis element. Click the icon next to the edit field to specify the value in source
format ( icon) or in converted format ( icon).

Name Displays the name of the selected element.

Off value Lets you specify the value that is written to the connected variable
when the button is released. Click the icon next to the edit field to specify the
value in source format ( icon) or in converted format ( icon).

On/Off button You can press an On/Off button to set a parameter to a


predefined value (On value) and release the button to set the parameter to
another value (Off value).

On value Lets you specify the value that is written to the connected variable
while you hold the button down. Click the icon next to the edit field to specify
the value in source format ( icon) or in converted format ( icon).

Push button A push button can be used to set one scalar parameter to a
predefined value. When you press one of the buttons, the predefined numerical
value is written to the parameter.

Push value Lets you specify the value that is written to the connected
variable when you press the button. Click the icon next to the edit field to specify
the value in source format ( icon) or in converted format ( icon).

544
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Saturation zone Lets you specify a range above the maximum and below
the minimum value where an additional movement of the device does not
change the variable value. The specified value specifies the saturation zone as
a percentage of the axis range.

Step size Lets you specify the increment value that is added to or subtracted
from the variable value when you press the button. Click the icon next to the
edit field to specify the value in source format ( icon) or in converted format
( icon).

Variables To specify properties of the connected variable.

Write center value Lets you specify whether to use the Center value as Off
value.
§ If enabled, the Point of view switch positions react as On/Off buttons, with the
center position as the off position.
§ If disabled, the Point of view switch positions react as Push buttons and the
center position is ignored.

Point of view switch position (Center) Lets you specify the value that is
written to the connected variable when you press the point of view switch to this
position. Click the icon next to the edit field to specify the value in source format
( icon) or in converted format ( icon).

Point of view switch position (North, North east, East, ...) Lets you specify
the value that is written to the connected variable when you press the point of
view switch to this position. Click the icon next to the edit field to specify the
value in source format ( icon) or in converted format ( icon).
If "Write center value" is enabled, the Point of view switch position reacts as an
On/Off button with the center value as the off value, otherwise as a Push button.

Effect properties Lets you specify the properties of the selected effect.

Condition type (condition effect) Lets you select one of the following
condition effect types:

Condition Type Description


Damper Adds a damper effect. This increases in
proportion to the velocity of movement along
an axis, for example, when something is
dragged through water.
Friction Adds a friction effect. This represents resistance
to movement along an axis, for example, when
a mass is pushed over a rough surface.
Inertia Adds an inertia effect. This increases in
proportion to the acceleration of movement
along an axis, for example, when a mass is
pushed on wheels.
Spring Adds a spring effect. This increases in
proportion to the distance from a defined
neutral point.

545
May 2024 ControlDesk Instrument Handling
Reference Information

Deadzone Lets you specify a range around the offset of an axis in which the
condition is not active, stated as a percentage of the axis range. If you want to
change the property value at run time, you can connect a variable to the effect
element in the instrument.

Deadzone variable (Available only if a deadzone variable is connected to the


effect) Lets you specify properties for the connected variable.

Direction Lets you specify the direction of the force in degrees. If you want to
change the property value at run time, you can connect a variable to the effect
element in the instrument.

Direction variable (Available only if a direction variable is connected to the


effect) Lets you specify properties for the connected variable.

Fade Lets you configure fade-in and fade-out settings.

Fade – Enabled Lets you enable or disable the fading settings for the effect.

Fade-in duration Lets you specify the fade-in duration in ms.

Fade-in force Lets you specify the force the fade in starts with as a
percentage of the current effect force.

Fade-out duration Lets you specify the fade-out duration in ms.

Fade-out force Lets you specify the force the fade out ends with as a
percentage of the current effect force.

Force Lets you specify the strength of the force, for example, to adjust it to a
specific device.

Force variable (Available only if a force variable is connected to the effect)


Lets you specify properties for the connected variable.

Horizontal offset Lets you specify a horizontal offset value to move the zero
point of the effect along the horizontal axis. The zero point of a spring effect is
the point at which the spring is at rest. For the damper effect it is the highest
value without damping. Offset values are normally not used for friction or inertia
effects. If you want to change the property value at run time, you can connect a
variable to the effect element in the instrument.

Horizontal offset variable (Available only if a horizontal offset variable is


connected to the effect) Lets you specify properties for the connected variable.

Offset Lets you specify an offset value to move the zero point of the effect
along the axis. The zero point of a spring effect is the point at which the spring
is at rest. For the damper effect it is the highest value without damping. Offset
values are normally not used for friction or inertia effects. If you want to change
the property value at run time, you can connect a variable to the effect element
in the instrument.

Offset variable (Available only if an offset variable is connected to the effect)


Lets you specify properties for the connected variable.

Period Lets you specify the cycle time in ms. If you want to change the
property value at run time, you can connect a variable to the effect element in
the instrument.

546
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Period variable (Available only if a period variable is connected to the effect)


Lets you specify properties for the connected variable.

Name Lets you specify the name of the selected effect.

Saturation Lets you specify a cut-off value for the force output from which
any additional movement (spring effect) or acceleration (damper effect) no
longer increases the force output. The saturation value is a percentage of the
force value specified for the effect and can be set only for spring and damper
effects. If you want to change the property value at run time, you can connect a
variable to the effect element in the instrument.
For example, if you specify a force value of 100%, an offset value of 0% and a
saturation value of 50% for a spring effect on a joystick's x-axis, the force output
increases until you have moved the stick halfway to the left or right. After that
point it remains the same.
The advantage of using a saturation value in contrast to reducing the force value
in general is that the force output is not reduced until the cut off is reached.
Setting the force value to 50% would reduce the force output over the whole
axis range.

Saturation variable (Available only if a saturation variable is connected to


the effect) Lets you specify properties for the connected variable.

Vertical offset Lets you specify a vertical offset value to move the zero point
of the effect along the vertical axis. The zero point of a spring effect is the
point at which the spring is at rest. For the damper effect it is the highest
value without damping. Offset values are normally not used for friction or inertia
effects. If you want to change the property value at run time, you can connect a
variable to the effect element in the instrument.

Vertical offset variable (Available only if a vertical offset variable is


connected to the effect) Lets you specify properties for the connected variable.

Wave type Lets you select the wave type of the periodic effect.

Start and Stop Condition Lets you specify the properties and the start and stop conditions of the selected
properties effect.

Condition type (start/stop condition) Lets you select one of the following
condition types for starting/stopping the force output:

Condition Type Description


Disabled Disables the start or stop condition
for the selected effect.
POS EDGE Returns "true" if the value of the
connected variable changes from
a value lower than the specified
condition value to a value greater
than or equal to the specified
condition value.
NEG EDGE Returns "true" if the value of the
connected variable changes from
a value higher than the specified

547
May 2024 ControlDesk Instrument Handling
Reference Information

Condition Type Description


condition value to a value less than
or equal to the specified condition
value.
Operator (==, !=, < , > , ...) Compares the value of the
connected variable with the specified
condition value. Returns "true"
if the condition specified by the
selected operator is met.
Changed Returns "true" each time the value
of the connected variable has
changed.

Delay Lets you specify a delay time for the force output in ms.

Duration Lets you specify the duration of the force output in ms.

Force restart Lets you specify to restart the force output each time the
condition is met again.

Start condition Lets you specify the start conditions of the selected effect.

Stop condition Lets you specify the stop conditions of the selected effect.

Value Lets you specify the condition value. The condition value is compared
to the value of the connected variable (start/stop condition) to trigger the force
output. Click the icon next to the edit field to specify the value in source format
( icon) or in converted format ( icon).

Variable (start/stop condition) Lets you specify properties of the connected


variable. The value of the connected variable is compared to the specified
condition value to trigger the force output.

Related instruments These properties are available for the following instrument:
§ Steering Controller on page 375

Related topics Basics

Basics of Handling the Steering Controller.............................................................................. 175

Switch Mode Property

Purpose To select a button type which the Invisible Switch simulates.

548
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Property Switch mode Lets you select a button type which the Invisible Switch
simulates. The available options are On/Off Button, Push Button and Check
Button.

Related instruments This property is available for the following instruments:


§ Invisible Switch on page 346

Tab Bar Properties

Purpose To configure the tab bar of the Hierarchy Array.

Properties Visible Lets you specify whether the tab bar is visible.

Alignment Lets you specify on which side of the instrument the tab bar is
displayed.

Height Lets you specify the height of the tab bar in pixels.

Related instruments These properties are available for the following instrument:
§ Hierarchy Array on page 336

Related topics Basics

Basics of Handling the Hierarchy Array.................................................................................... 114

Tab Pages Properties (Bus Instrument)

Purpose To specify the order and the labels of the instrument tabs.

Properties Sort mode Lets you specify the sort mode of the tabs of the instrument.
Select Manual to sort the tabs manually via the Move Up and Move Down
buttons.

Sort order Displays the name of an instrument tab. If Sort mode is set to
Manual, you can use the arrow buttons to move a tab up (to the left) or down
(to the right) in the order of the tabs.

549
May 2024 ControlDesk Instrument Handling
Reference Information

Macro / Tab name Lets you specify the label of the selected tab by selecting
a macro from a list (and/or entering text directly).

Related instruments These properties are available for the following instruments:
§ Bus Instrument on page 315

Related topics HowTos

How to Configure a Bus Instrument (ControlDesk Bus Navigator )

Tab Properties (Table Editor)

Purpose To configure the properties of the selected instrument tab.

Properties Active color Opens a dialog for you to select a color or enter values to set
one. For more information on the dialog settings, refer to Color Property on
page 452.

Active text color Opens a dialog for you to select a color or enter values to
set one. For more information on the dialog settings, refer to Color Property on
page 452.

Icon visible Lets you specify to show or hide the variable icon in the tab.

Inactive color Opens a dialog for you to select a color or enter values to
set one. For more information on the dialog settings, refer to Color Property on
page 452.

Inactive text color Opens a dialog for you to select a color or enter values to
set one. For more information on the dialog settings, refer to Color Property on
page 452.

Text Lets you specify the label of the selected tab by selecting a macro from a
list (and/or entering text directly).

Related instruments These properties are available for the following instruments:
§ Table Editor on page 379

Related topics Basics

Basics of Handling the Table Editor......................................................................................... 188

550
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Tabbed Pages Properties (Table Editor)

Purpose To configure the properties of the instrument tabs.

Properties Automatic tab sizing Lets you specify whether the size of the tabs is
adjusted automatically or manually via the Tab size property.

Position Lets you specify the position of the tabs.

Sort mode Lets you specify the sort mode of the tabs of the instrument.
Select Manual to drag the tabs to the desired positions.

Splitter synchronization Lets you synchronize the splitter positions on all


instrument pages.

Tab size (Available only if Automatic tab sizing is disabled) Lets you specify
the size of the tabs in pixels.

Tabs Lets you open the Tabs dialog to configure the tabs and the properties
of the instrument pages.
On the left side of the dialog, all defined instrument tabs are listed. You can use
the following dialog buttons to configure the list.

Button Description
Add Adds a new tab to the bottom of the list.
Moves the selected tab to the top.

Moves the selected tab to the bottom.

Deletes the selected tab.

Text font Opens a dialog where you can specify a font. If the element
uses the general font settings from the Instruments page of the ControlDesk
Options dialog, select Use custom font settings to make the font settings in
the dialog available.

Visible Lets you specify whether the tabs are displayed.

Related instruments These properties are available for the following instruments:
§ Table Editor on page 379

Related topics Basics

Basics of Handling the Table Editor......................................................................................... 188

551
May 2024 ControlDesk Instrument Handling
Reference Information

Tabs Properties (Hierarchy Array)

Purpose To configure the tabs of the Hierarchy Array.

Tabs list The defined tabs are listed on the left side of the dialog. Select a tab to specify its
properties.

You can use the following buttons to configure the list.

Button Description
Add Adds a new tab to the list.
Moves the selected element up in the list.

Moves the selected element down in the list.

Deletes the selected element.

Toolbar A toolbar is displayed above the property list. The buttons let you configure the
view of the list or search for items in the list, for example.

For more details on the toolbar buttons, refer to Toolbar buttons (ControlDesk
User Interface Handling ).

Appearance Name To specify a name for the selected tab.

Misc To configure tab properties and add rows.

Rows To add rows to the selected tab.


Refer to Rows Properties (Hierarchy Array) on page 521.

Active color To specify the color of an active tab.


Opens a dialog for you to select a color or enter values to define one. For more
information on the dialog settings, refer to Color Property on page 452.

Active text color To specify the text color of an active tab.


Opens a dialog for you to select a color or enter values to define one. For more
information on the dialog settings, refer to Color Property on page 452.

Active font To specify the header font that is used when the tab is active.
Opens a dialog for you to specify the font settings. In the dialog, select the
Use custom font settings checkbox to activate the settings. Otherwise, the
settings specified on the Instruments page of the ControlDesk Options dialog
are used.

552
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Inactive color To specify the color of an inactive tab.


Opens a dialog for you to select a color or enter values to define one. For more
information on the dialog settings, refer to Color Property on page 452.

Inactive font To specify the header font that is used when the tab is inactive.
Opens a dialog for you to specify the font settings. In the dialog, select the
Use custom font settings checkbox to activate the settings. Otherwise, the
settings specified on the Instruments page of the ControlDesk Options dialog
are used.

Inactive text color To specify the text color of an inactive tab.


Opens a dialog for you to select a color or enter values to define one. For more
information on the dialog settings, refer to Color Property on page 452.

Related instruments These properties are available for the following instrument:
§ Hierarchy Array on page 336

Related topics Basics

Basics of Handling the Hierarchy Array.................................................................................... 114

Text / Numeric Output Font Properties

Purpose To configure the font properties of the selected item.

Properties Text font Lets you specify the font that is used for text output. In
the dialog, select the Use custom font settings checkbox to activate
the settings. Otherwise, the settings specified on the Instruments page of
the ControlDesk Options dialog are used. For more information, refer to
Instruments Page on page 672.

Numeric output font Lets you specify the font that is used for numeric
output. In the dialog, select the Use custom font settings checkbox to activate
the settings. Otherwise, the settings specified on the Instruments page of
the ControlDesk Options dialog are used. For more information, refer to
Instruments Page on page 672.

Related instruments These properties are available for the following instruments:
§ Variable Array on page 389
§ Hierarchy Array on page 336

553
May 2024 ControlDesk Instrument Handling
Reference Information

Related topics Basics

Basics of Handling the Hierarchy Array.................................................................................... 114


Basics of Handling the Variable Array...................................................................................... 241

Text Alignment Property

Purpose To specify the alignment of text in the selected Hierarchy Array cell.

Property Text alignment Lets you select one of nine options to align the digits in the
instrument. Each position is represented by a radio button. The center of the
instrument is the default position.

Related instruments This property is available for the following instrument:


§ Hierarchy Array on page 336

Related topics Basics

Basics of Handling the Hierarchy Array.................................................................................... 114

Text Color Property

Purpose To specify the color of the selected item.

Property Text color / Color Opens a dialog for you to select a color or enter values to
set one. For more information on the dialog settings, refer to Color Property on
page 452.

Related instruments This property is available for the following instruments:


§ Check Button on page 319
§ On/Off Button on page 359
§ Push Button on page 361
§ Radio Button on page 363

554
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Related topics Basics

Basics of Handling the On/Off Button..................................................................................... 156

Text Font Property

Purpose To specify the font of the selected item.

Property Text font / Font Opens a dialog where you can specify a font. If the element
uses the general font settings from the ControlDesk Options dialog, select Use
custom font settings to make the font settings in the dialog available.

Related instruments This property is available for various instruments.

Text Properties (Numeric Input)

Purpose To specify the text properties of the Numeric Input.

Properties Text alignment Lets you select one of the nine options to align the text
inside the edit field. Each position is represented by a button.

Text color Opens a dialog for you to select a color or enter values to set
one. For more information on the dialog settings, refer to Color Property on
page 452.

Text font Opens a dialog where you can specify a font for the input text.
If the element uses the general font settings from the ControlDesk Options
dialog, select Use custom font settings to make the font settings in the dialog
available.

Textbox color Opens a dialog for you to select a color or enter values to
set one. For more information on the dialog settings, refer to Color Property on
page 452.

Textbox style (Available only if "Use custom colors" is enabled) Lets you
select a background color for the edit field. You can choose one of the following
options:
§ Transparent
§ Use System Color
§ Use Custom Color

555
May 2024 ControlDesk Instrument Handling
Reference Information

Related instruments These properties are available for the following instrument:
§ Numeric Input on page 357

Text Property (Check Button)

Purpose To specify the text displayed next to the checkbox.

Properties Text Lets you specify the text next to the checkbox.

Related instruments This property is available for the following instrument:


§ Check Button on page 319

Text Property (Hierarchy Array)

Purpose To specify the label of the selected Label cell.

Property Text Lets you specify a text for the label.


Lets you enter the label text in the edit field. You can use macros from the list.

Macro Description
{%BLOCK%} Block name of the variable
{%CONBLOCK%} § If a variable was initially connected to the instrument, the macro
returns the block name of the variable.
§ If a framework label was initially connected to the instrument, the
macro returns nothing.
{%CONNECTION%} § If a variable was initially connected to the instrument, the macro
returns the name of the variable.
§ If a framework label was initially connected to the instrument, the
macro returns the name (ID) of the framework label .
{%CONUNIT%} § If a variable was initially connected to the instrument, the macro
returns the unit of the variable.
§ If a framework label was initially connected to the instrument, the
macro returns the unit of the framework label .
{%DATATYPE%} Data type of the variable
{%DESCRIPTION%} Description text of the variable (from the variable description file)
{%DEVICE%} Name of the connected platform/device
{%DISPLAYMODE%} Display mode of the variable
{%INDEX%} Index position of a variable in a measurement array or value block.

556
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Macro Description
{%INSTRUMENT%} Name of the instrument
{%INSTRUMENTDESCRIPTION%} Description text of the instrument (from the instrument properties)
{%MAXHARDLIMIT%} Maximum hard limit of the variable
{%MAXVALUE%} Maximum of the measured value
{%MAXWEAKLIMIT%} Maximum weak limit of the variable
{%MINHARDLIMIT%} Minimum hard limit of the variable
{%MINVALUE%} Minimum of the measured value
{%MINWEAKLIMIT%} Minimum weak limit of the variable
{%MODE%} Conversion mode of the variable
{%ORIGINPATH%} Path of the variable that was originally connected to the instrument. Lets
you identify the originally connected variable if it was replaced by the
variable it references.
{%PATH%} Path of the variable.
You can use indices to filter slash-separated parts of the path. For
example:
§ {%PATH[0]%} extracts the first part of the path up to the first slash.
§ {%PATH[-2]%} extracts the second-last part of the path.
{%READONLY%} Variable is read-only (ro) or not
{%STRUCT%} Name of the variable together with the relevant parts of the struct (if the
variable is part of a struct). The struct parts are separated by a dot, for
example: MyStruct.MySubstruct.MyParameter.
You can use indices to filter parts of the struct. For example:
§ {%STRUCT[0]%} extracts the first part of the struct up to the first dot.
§ {%STRUCT[-2]%} extracts the second-last part of the struct.
{%UNIT%} Unit of the variable
{%UNIT%}{%DISPLAYMODESOURCE%} Unit and display mode of the variable
{%VALUE%} Value of the variable
{%VARIABLE%} Name of the variable

To modify the display of numeric values, you can use Printf expressions.
Put the Printf expression in angle brackets and insert it after the first % character
of a macro as shown in the following example:
{%<%.2f>VALUE%}
In this example, the <%.2f> expression modifies the {%VALUE%} macro so that
decimal floating point numbers with 2 digits are displayed.
The following table shows the supported Printf expressions:

Printf Expression Description


%d Decimal integer
%i Decimal integer
%u Unsigned integer
%o Octal integer
%x, %X Hexadecimal integer
%b Binary integer
%f Floating point

557
May 2024 ControlDesk Instrument Handling
Reference Information

Printf Expression Description


%e, %E Exponential floating point
%g, %G Floating point of the formats %f or %e

Related instruments These properties are available for the following instrument:
§ Hierarchy Array on page 336

Related topics Basics

Basics of Handling the Hierarchy Array.................................................................................... 114

Time Cursor Properties

Purpose To specify the properties of the time cursor.

Properties The type of selected plotter determines which time cursor properties are
available.

Decimal places (Available only if Use custom precision is enabled) Lets you
specify the number of decimal places that are displayed for the cursor value. If
a value has more than the selected number of decimal places, the last displayed
digit is rounded.

Enabled Lets you show/hide the time cursor. To use the time cursor during a
running measurement, pause the visualization by moving or zooming the chart.

Keep always visible Lets you specify to keep the cursor inside the chart area.
For example, when you move a chart or zoom into it.

Show connection name Lets you specify whether to display the name of the
connected variable in the time cursor tooltip.

Show time info Lets you activate a tooltip that displays the position of the
time cursor (in seconds).

Show tooltip Lets you activate a tooltip that displays the signal value at the
position of the time cursor.

Stick on curve Lets you specify to move the time cursor on the data points of
the signal next to the mouse pointer.

Time Lets you specify the position of the time cursor (in seconds).

Use custom precision Lets you enable or disable the configuration of the
number of decimal places of the cursor value.

558
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Tip

Via the instrument's toolbar, you can easily change frequently used time
cursor settings. Refer to Show Toolbar on page 715.

Related instruments These properties are available for the following instruments:
§ Time Plotter on page 384
§ XY Plotter on page 396

Title Properties

Purpose To configure the title of the selected element to be displayed.

Properties Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

Font Opens a dialog where you can specify a font. If the element uses the
general font settings from the ControlDesk Options dialog, select Use custom
font settings to make the font settings in the dialog available.

Text Lets you enter a title to be displayed.

Related instruments These properties are available for the following instruments:
§ 3-D Viewer on page 303

Related topics References

3-D Viewer............................................................................................................................. 303

Toolbar Properties (Time Plotter/Index Plotter)

Purpose To specify the properties of the instrument's toolbar.

Properties Toolbar visible Lets you show/hide the instrument's toolbar.

Show expand button Lets you show/hide a button in the instrument's left
upper corner that lets you show/hide the instrument's toolbar via the pointer.

559
May 2024 ControlDesk Instrument Handling
Reference Information

Type Lets you select the toolbar to be displayed.

Related instruments These properties are available for the following instruments:
§ Index Plotter on page 341
§ Time Plotter on page 384

Related topics References

Show Toolbar......................................................................................................................... 715

Tooltip Property

Purpose To specify a tooltip for the instrument.

Property Tooltip Lets you specify a tooltip for the instrument. Click the down arrow
to enter more than one line or to use macros. The tooltip is displayed when you
move the mouse pointer over the instrument.
You can use the following macros for the text:

Macro Description
{%INSTRUMENT%} Name of the instrument
{%DESCRIPTION%} Description text of the instrument, if specified in the
instrument properties

Related instruments This property is available for various instruments.

Tree View Properties

Purpose To configure the view properties of the communication object tree in the
Diagnostics Instrument.

Properties Display service IDs Lets you specify to display the service ID together
with the name of a diagnostic communication object. With this checkbox
selected, the name of a diagnostic service or control primitive is prefixed by
the corresponding service ID (displayed as a hexadecimal value preceded by

560
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

$), and the service ID is taken into account in the sorting of the diagnostic
communication objects.

Hierarchy mode Lets you specify whether the diagnostic communication


objects are displayed in a hierarchy view. In the hierarchical view, additional
nodes are displayed for functional classes of diagnostic services, for ECU jobs,
and for control primitives. If disabled, the diagnostic communication objects are
displayed as a flat list.

Show control primitives Lets you specify whether control primitives are
displayed in the instrument. If the checkbox is selected, the following control
primitives are displayed:
§ StartComm
§ StopComm
§ VariantIdentification
§ ProtocolParameterSet
For further information on dynamic configuration of communication parameters
(COMPARAMs) via control primitives, refer to Conventions in Connection with ODX
Databases (ControlDesk ECU Diagnostics ).

Show jobs Lets you specify whether diagnostic jobs are displayed in the
instrument.

Show services Lets you specify whether diagnostic services are displayed in
the instrument.

Related instruments These properties are available for the following instruments:
§ Diagnostics Instrument on page 321

Use Custom Colors Property

Purpose To enable or disable custom color settings for the instrument.

Property Use custom colors Lets you specify whether the color settings on the
Instruments page of the ControlDesk Options dialog are used for the
instrument.

Related instruments This property is available for various instruments.

Related topics References

Instruments Page.................................................................................................................... 672

561
May 2024 ControlDesk Instrument Handling
Reference Information

Use Custom Fonts Property

Purpose To enable or disable global font settings for the instrument.

Property Use custom fonts Lets you specify whether the fonts settings on the
Instruments page of the ControlDesk Options dialog are used for the
instrument.

Related instruments This property is available for various instruments.

Related topics References

Instruments Page.................................................................................................................... 672

Use Custom Header Settings Property

Purpose To enable or disable custom settings for the instrument header.

Property Use custom header settings Lets you specify whether to use the visibility
settings on the Instruments page of the ControlDesk Options dialog for the
instrument header.

Related instruments This property is available for the following instrument:


§ Bus Instrument on page 315

Related topics References

Instruments Page.................................................................................................................... 672

Variables Properties

Purpose To display and configure the variables that are connected to the instrument.

562
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Properties Bit mask properties To specify the bitmask properties for the selected
variable. For details, refer to Bitmask Properties on page 436.

Connection assignment To specify the assignment of variables to an


instrument or an instrument group. For details, refer to Connection Assignment
Properties on page 454.

Connection nodes To configure connection nodes of the Browser. For


details, refer to Connection Nodes Properties on page 456.

Conversion Table Settings Properties (Available only if a variable is


connected to a Time Plotter or Index Plotter and converted via verbal table
conversion) To specify properties for connected variables with verbal conversion
tables. For more information, refer to Conversion Table Settings Properties (Time
Plotter/Index Plotter) on page 457.

Custom value conversion properties To specify properties for converting a


source value into a converted value and vice versa. The variable conversion that
you define here is assigned to the instrument. For details, refer to Custom Value
Conversion Properties on page 461.

Data Source Lets you specify whether to display the current value or the
reference value (if available). This property changes only the display setting of
the value, it does not switch the data set. It lets you show the parameter’s value
of the reference data set (for platforms: the initial value read from the SDF file)
although the working data set is activated.

Display Formats (Available only for Display, Numeric Input, Table Editor and
Variable Array) Lets you open a dialog to specify the display format properties.
Refer to Display Formats Properties on page 465.

Display mode Lets you select the variable's display mode from a list of
available modes. For a parameter or writable variable, you can enter the value in
any supported numeric format (DEC, HEX, or BIN) independently of the currently
selected display mode. A hexadecimal value must be prefixed by 0x or followed
by h. A binary value must be prefixed by 0b. Use the Display formats properties
to specify details for a specific format.

Function values Lets you specify the properties of the variable that is
connected to the function values of a Table Editor.

Increments (Available only for Knob, Slider, Numeric Input, Table Editor
and Variable Array) Lets you specify increment properties. Refer to Increments
Properties on page 479.

Input quantity x Lets you specify the properties of the variable that is used
as the x-axis input quantity of a Table Editor.

Input quantity y Lets you specify the properties of the variable that is used
as the y-axis input quantity of a Table Editor.

Mapping name Displays the name of the connected framework label . For
more information, refer to Basics on Variable Mappings (ControlDesk Variable
Management ).

563
May 2024 ControlDesk Instrument Handling
Reference Information

Origin Connection path Displays the path of the variable that was originally
connected to the instrument. This lets you identify the originally connected
variable if it was replaced by the variable it references.

Path Displays the path of the variable in the corresponding variable


description.

Pitch variable (Available only for the pitch scale in the Artificial Horizon) Lets
you specify the properties for the pitch variable.

Platform/Device name Displays the name of the platform/device that the


variable belongs to.

Raster (Available only for a plotter) Displays the raster.

Roll variable (Available only for the roll scale in the Artificial Horizon) Lets
you specify the properties for the roll variable.

Smooth animation (Available only for instruments with a scale and for
the Animated Needle) Lets you specify to animate the movement of a needle
smoothly. If disabled, the needle jumps directly from one value to the next,
which might appear unrealistic if the displayed variable values differ too much.

Uniform Resource Identifier Displays the uniform resource identifier (URI) of


the connected variable.
For more information on the URI format, refer to Variables Page (ControlDesk
Variable Management ).

Value changed method (Available only for a Browser) Lets you specify the
method to be executed when a connected variable changes its value. To connect
variables to a Browser you must add connection nodes to the Browser. Refer to
Connection Nodes Properties on page 456.

Variable name Displays the name of the connected variable.

Write mode (Available only for instruments that can be used for calibration)
Lets you select the write mode for the instrument.

Write Mode Description


Automatic The write mode depends on the main variable. If the main variable
is read-only, the instrument is read-only. If the main variable is
writable, the instrument is writable.
Read-only The instrument is read-only, even if the main variable is writable. If
an additional write connection exists the value is not written to it.
Writable The instrument is writable, even if the main variable is read-only. If
an additional write connection exists the value is written to it.

X-axis Lets you specify the properties of the variable that is connected to the
x-axis of a Table Editor. The variable provides the axis values.

Y-axis Lets you specify the properties of the variable that is connected to the
y-axis of a Table Editor. The variable provides the axis values.

Z-axis Opens a dialog for you to add and delete z-axes to or from a Table
Editor and to specify the properties of the variables that are connected to them.
Refer to Variables Properties (Z-Axis) on page 565.

564
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Related instruments These properties are available for various instruments.

Related topics HowTos

How to Write the Same Value to Several Parameters (ControlDesk Calibration and
Data Set Management )

References

Connect as Additional Write Variable(s).................................................................................. 618

Variables Properties (Z-Axis)

Purpose To add and delete z-axes to or from a Table Editor and to specify the properties
of the variables that are connected to them.

Z-axes property Lets you open the Z‑Axes dialog. The defined z‑axes are listed on the left side
of the dialog together with the connected variables for axis values and input
quantities. Select a z‑axis to specify the properties of the connected variables.

You can use the following buttons to configure the list.

Button Description
Add Adds a new z‑axis to the list.
Moves the selected element to the top.

Moves the selected element to the bottom.

Deletes the selected element.

Toolbar A toolbar is displayed above the property list. The buttons let you configure the
view of the list or search for items in the list, for example.

For more details on the toolbar buttons, refer to Toolbar buttons (ControlDesk
User Interface Handling ).

Properties For information on the displayed variable properties, refer to Variables Properties
on page 562.

565
May 2024 ControlDesk Instrument Handling
Reference Information

Related instruments These properties are available for the following instruments:
§ Table Editor on page 379

Related topics Basics

Basics of Handling the Table Editor......................................................................................... 188

Vertical Hub Position Property

Purpose To move the hub vertically inside the operating element.

Property Vertical hub position (Available only if "Automatic Sizing" is disabled) Lets
you move the hub vertically inside the operating element. Enter the vertical
position of the hub (in pixels) relative to the center of the operating element. 0
means the hub is placed in the middle of the operating element. Positive values
move the hub up, negative values down.

Related instruments This property is available for the following instruments:


§ Gauge on page 332
§ Knob on page 347

Related topics Basics

Basics of Handling the Gauge................................................................................................. 110


Basics of Handling the Knob................................................................................................... 143

View Properties (Time Plotter/Index Plotter)

Purpose To configure the view of the axes.

Properties Auto hide elements Lets you specify to hide the y-axes and the x-axis, if the
size of the instrument is reduced below a certain limit.

566
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Axis mode Lets you select the axes mode of the y-axes area.

Axes Mode Description


Scroll view The y-axes are aligned vertically in a scroll area. One (default)
or more y-axes are visible as default. The Axis width mode is
set to Fixed.
Complete view The y-axes are aligned vertically. All y-axes are visible. The Axis
width mode can be set to Fixed, Floating, or Maximum.
Stacked view The y-axes are arranged horizontally one below the other. The
Axis width mode can be set to Fixed or Floating.

Axis width mode Lets you specify the width mode of the y-axes. The
available modes depend on the selected Axis mode.

Width Mode Description


Fixed The width of the y-axes area is set to the value in the Axis
width edit field.
Floating The width of the y-axes area is set automatically. All y-axes are
completely visible. Each y-axis has its optimum width.
Maximum The width of the y-axes area is set automatically. All y-axes are
completely visible. The width of the widest y-axis is set for each.

Bookmarks visible (Available only for a Time Plotter) Displays bookmark


symbols at the x-axis. The time position of a bookmark is marked either
by a triangle (manual bookmark) or a rhombus (automatic bookmark). In
measurement data files, bookmarks that belong to the same recording have the
same color. Move the pointer onto the symbol to display more information on
the bookmark.
For more information, refer to Basics on Bookmarks (ControlDesk Measurement
and Recording ).

Highlight active signal Lets you highlight the active signal.

Overlap symbols and labels Lets you specify to use the same y-axis space
for symbols and labels and to allow overlapping if necessary.

Label orientation Lets you display the y-axes labels horizontally or vertically.

X-Axis visible Lets you show/hide the x-axis area.

Y-Axes visible Lets you show/hide the y-axes area.

Y-Axes width (Available only if Axes width mode is set to Fixed) Lets you
specify the width of the axis area in pixels.

Related instruments These properties are available for the following instruments:
§ Index Plotter on page 341
§ Time Plotter on page 384

567
May 2024 ControlDesk Instrument Handling
Reference Information

Walls Properties

Purpose To configure the selected wall.

Properties Visible Lets you specify whether a wall is displayed.

Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

Related instruments These properties are available for the following instruments:
§ 3-D Viewer on page 303

Related topics References

3-D Viewer............................................................................................................................. 303

Width Property (Hierarchy Array)

Purpose To specify the width of the selected column in the Hierarchy Array.

Property Width Lets you change the width of the selected column in the Hierarchy
Array.

Related instruments These properties are available for the following instrument:
§ Hierarchy Array on page 336

Related topics Basics

Basics of Handling the Hierarchy Array.................................................................................... 114

Word Wrap Property

Purpose To specify the word wrap property of text lines.

568
ControlDesk Instrument Handling May 2024
Instrument-Related Properties

Buttons Properties Word wrap Lets you specify whether to break text lines of the selected
button automatically. If the button text does not fit into one line, it is wrapped
to the next line. If the selected font is too large for the amount of text and the
instrument size, the button text is not displayed completely.

Related instruments This property is available for the following instruments:


§ Check Button on page 319

Working Point Properties

Purpose To configure the properties of the working point.

Properties Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

Visible Lets you specify whether the working point is visible.

Related instruments These properties are available for the following instruments:
§ Table Editor on page 379

Related topics Basics

Basics of Handling the Table Editor......................................................................................... 188

Working Points Properties (Multiple Working Points)

Purpose Opens a dialog for you to configure the properties of multiple working points.

Description If you connect a measurement array or a value block to an axis of a Table Editor,
you can specify which of the array elements are to be used as input quantities
and configure their properties.

Working points list On the left side of the dialog, the defined working points are listed. Select a
working point to specify its properties.

569
May 2024 ControlDesk Instrument Handling
Reference Information

You can use the following buttons to configure the list.

Button Description
Add Adds a new working point to the bottom of the list.
Moves the selected working point to the top
(background). If working points overlap each other
in one of the Table Editor views, the one nearest the
bottom covers the other.
Moves the selected working point to the bottom
(foreground). If working points overlap each other in
one of the Table Editor views, the one nearest the
bottom covers the other.
Deletes the selected working point.

Toolbar A toolbar is displayed above the property list. The buttons let you configure the
view of the list or search for items in the list, for example.

For more details on the toolbar buttons, refer to Toolbar buttons (ControlDesk
User Interface Handling ).

Properties Color Opens a dialog for you to select a color or enter values to set one. For
more information on the dialog settings, refer to Color Property on page 452.

X-Index Lets you specify the x-index of the working point.

Y-Index Lets you specify the y-index of the working point.

Z0-Index Lets you specify the z0-index of the working point.

Z1-Index Lets you specify the z1-index of the working point.

Z2-Index Lets you specify the z2-index of the working point.

Z3-Index Lets you specify the z3-index of the working point.

Visible Lets you specify whether the working point is visible.

Related instruments These properties are available for the following instruments:
§ Table Editor on page 379

Related topics References

Working Point Properties........................................................................................................ 569

570
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Instrument-Related Commands
Where to go from here Information in this section

2-D View............................................................................................... 582


To configure display options of the 2‑D view.

3-D View............................................................................................... 584


To configure display options of the 3-D view.

Add Category........................................................................................ 585


To add a new category to the Instrument Selector.
Not available in operator mode.

Add to Favorites.................................................................................... 585


To add the selected instrument to the Favorites category of the
Instrument Selector.
Not available in operator mode.

Adjust Value(s)....................................................................................... 586


To enter a value as the operand to change the parameter value.

Always Show List................................................................................... 589


To show an instrument list when you drag a variable from the
Variables pane to a layout.
Not available in operator mode.

Append Variable.................................................................................... 589


To append a row with the selected variable to the currently selected row
in the Variable Array.
Not available in operator mode.

Assign Properties................................................................................... 590


To assign the property settings of one instrument to another for all
shared properties.

Assign Recent Value.............................................................................. 591


To display the most recent scalar values of a variable and to reset the
variable to one of them.

Assign Reference Value(s)...................................................................... 591


To set the values in the selected cells to the corresponding values of the
reference data set (reference values).

Available Raster (XY Plotter)................................................................... 592


To select a measurement raster for the curve.
Not available in operator mode.

Best Fit.................................................................................................. 593


To adjust the column width of the selected legend column automatically.

Best Fit (All Columns)............................................................................. 593


To adjust the column width of all legend columns automatically.

Bin (Source)........................................................................................... 594


To display a value in bin (source) mode.

571
May 2024 ControlDesk Instrument Handling
Reference Information

Bitmask................................................................................................. 595
To specify the bitmask for the currently selected variable.
Not available in operator mode.

Bottom.................................................................................................. 596
To display the plotter legend below the chart.
Not available in operator mode.

Cancel (Diagnostics Instrument)............................................................. 596


To stop the execution of a diagnostic communication object.

Cell - Change To.................................................................................... 597


To change the type of the selected cell.

Cell - Delete.......................................................................................... 598


To delete the selected cell.

Cell Properties....................................................................................... 598


To specify properties of the selected cell.
Not available in operator mode.

Change Icon.......................................................................................... 599


To change the icon of the currently selected custom instrument.
Not available in operator mode.

Change To/Variables - Change To........................................................... 600


To connect the variables to a different instrument.

Clear All DTCs....................................................................................... 601


To delete all trouble code entries from the fault memory.

Clear Display......................................................................................... 601


To remove all entries from the instrument's output field.

Clear Selected DTC................................................................................ 602


To delete the selected trouble code entry from the fault memory.

Clear Sorting......................................................................................... 603


To clear the alphabetical sorting of the legend rows.
Not available in operator mode.

Code Editor Dialog................................................................................ 604


To assign Python code to an event of the selected instrument or layout.

Collapse All........................................................................................... 606


To collapse all rows in the instrument.
Not available in operator mode.

Collapse Subordinate Rows................................................................... 606


To collapse only the subordinate rows below a header row.
Not available in operator mode.

Column Chooser (Time Plotter/Index Plotter)................................. ........ 607


To add/remove columns to/from the legend.

Columns - Customize............................................................................ 609


To configure the columns of the Variable Array.
Not available in operator mode.

572
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Columns - Delete................................................................................... 611


To delete the selected column.
Not available in operator mode.

Columns - Insert ................................................................................... 611


To add a column to the Variable Array.
Not available in operator mode.

Columns (Diagnostics Instrument).......................................................... 613


To add a column to or remove it from the Diagnostics Instrument.

Columns (Fault Memory Instrument)...................................................... 614


To add a column to or remove it from the Fault Memory Instrument.

Compu Tab Items Sorted....................................................................... 616


To sort the string list of a value with verbal conversion (CompuVTab,
CompuVTabRange) alphabetically.

Configure Connection Assignment........................................................ 617


To configure the connection assignment of the variable(s) in the selected
instrument(s).

Connect as Additional Write Variable(s)................................................. 618


To connect the selected variable to the instrument for calibration as an
additional write variable.
Not available in operator mode.

Connect as Main Variable / Connect Variable(s)..................................... 619


To connect the selected variable to the instrument as the main variable.
Not available in operator mode.

Connect as Pitch.................................................................................... 620


To connect the selected variable to the Artificial Horizon as the pitch
variable.
Not available in operator mode.

Connect as Roll..................................................................................... 620


To connect the selected variable to the Artificial Horizon as the roll
variable.
Not available in operator mode.

Connect to New Instrument.................................................................. 621


To connect selected variables to a new instrument.
Not available in operator mode.

Copy (Diagnostics Instrument)............................................................... 622


To copy the current selection or specific information belonging to
the element(s) currently selected in the Diagnostics Instrument to the
Clipboard.

Copy (Fault Memory Instrument)........................................................... 624


To copy the current selection or specific information belonging to the
element(s) currently selected in the Fault Memory Instrument to the
Clipboard.

Copy (Instrument).................................................................................. 626


To copy the selected instruments to the Clipboard.

573
May 2024 ControlDesk Instrument Handling
Reference Information

Copy / Variables - Copy......................................................................... 626


To copy the selected variables to the Clipboard.

Copy Here............................................................................................. 627


To copy an instrument with its variable connections.
Not available in operator mode.

Copy Here Without Connections........................................................... 628


To copy an instrument without its variable connections.
Not available in operator mode.

Copy Value (Instruments)....................................................................... 629


To copy the value that is displayed in the instrument.

Copy Value(s)........................................................................................ 630


To copy the selected cells to the Clipboard.

Create XML Configuration..................................................................... 630


To create service configurations for handling fault memory entries based
on the parameter settings specified in the Diagnostics Instrument for use
in an XML configuration file. You can copy the service configurations to
the Clipboard or save them to a file.

Cut (Instrument).................................................................................... 633


To cut the selected instruments to the Clipboard.
Not available in operator mode.

DAQ - Available Raster (Time Plotter/Index Plotter)................................. 633


To select a measurement raster for a signal.
Not available in operator mode.

DAQ – Leading Raster (Time Plotter/Index Plotter).................................. 634


To select one of the measurement rasters of the displayed signals as the
leading raster for the plotter display. The list contains all the rasters that
are currently used.

DAQ – Mode (Time Plotter/Index Plotter)............................................... 635


To switch between triggered and untriggered display of plotter data.

DAQ - Trigger (Time Plotter/Index Plotter).............................................. 637


To switch between automatic and interactive setting of the signal's
measurement trigger.
Not available in operator mode.

Dec (Source).......................................................................................... 638


To display a value in dec (source) mode.

Delete (Instrument)................................................................................ 639


To delete the selected instruments.
Not available in operator mode.

Delete (Y-Axis Time Plotter/Index Plotter)....................................... ........ 639


To delete the selected y-axis.
Not available in operator mode.

Delete Active Tab................................................................................... 640


To delete the currently active tab in the Table Editor.
Not available in operator mode.

574
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Delete Axis Point(s)................................................................................ 641


To delete the selected axis points.
Not available in operator mode.

Delete Curve (XY Plotter)....................................................................... 642


To delete the selected curve.
Not available in operator mode.

Delete Disconnected Tabs...................................................................... 643


To delete all tabbed pages without a connected controller device from a
Steering Controller.
Not available in operator mode.

Delete Signal (Time Plotter/Index Plotter)....................................... ........ 644


To delete the selected signal.
Not available in operator mode.

Display Format Page.............................................................................. 645


To select predefined numeric data display formats for the numerical
output in the Variable Array.
Not available in operator mode.

Display Formats..................................................................................... 647


To specify the display format for the selected variable.
Not available in operator mode.

Display Output – Clear Output on Execution.......................................... 647


To specify whether to clear the output field before another
communication object is executed.

Display Output – Display Results Only.................................................... 648


To specify whether to show only the results in the output field.

Display Values........................................................................................ 648


To select an option for displaying the values in the table cells of the Table
Editor's grid view.

Edit Bookmarks..................................................................................... 649


To edit bookmarks.

Enable Move Mode (XY Plotter)............................................................. 650


To move the displayed area of the axis via mouse pointer.
Not available in operator mode.

Execute / Execute Cyclically (Diagnostics Instrument).............................. 651


To execute a diagnostic communication object.

Expand All............................................................................................. 652


To expand all rows in the instrument.
Not available in operator mode.

Expand Subordinate Rows..................................................................... 652


To expand only the subordinate rows below a header row.
Not available in operator mode.

575
May 2024 ControlDesk Instrument Handling
Reference Information

Export (Instrument Selector)................................................................... 653


To export an instrument category and its sub categories with the custom
instruments they contain to an instrument library (ILX) file.
Not available in operator mode.

Export Value(s)....................................................................................... 653


To export the values of the variable that is currently displayed in the Table
Editor.

Filter Editor............................................................................................ 654


To filter the signals that are displayed in a plotter by filter rules.
Not available in operator mode.

Find Bookmarks..................................................................................... 655


To find bookmarks.

Grid View.............................................................................................. 656


To configure display options of the grid view.

Group by This Column........................................................................... 656


To group the signals in the legend according to the entries of the
column.
Not available in operator mode.

Hex (Source).......................................................................................... 657


To display a value in hex (source) mode.

Hide Auto Filter Row............................................................................. 658


To close the filter row above the legend columns.

Hide Expand Button............................................................................... 658


To hide the legend's expand button in the instrument.
Not available in operator mode.

Hide Group By Box................................................................................ 659


To hide the group by box. The group by box lets you group the signals in
the legend via drag & drop.

Hide Search Panel.................................................................................. 660


To hide the find panel. The find panel lets you filter the signals to be
displayed in the plotter by a search string.
Not available in operator mode.

Import (Instrument Selector).................................................................. 660


To import an instrument category with its sub categories from an
instrument library (ILX) file.
Not available in operator mode.

Import Library........................................................................................ 661


To import an instrument library from the file system to the Instrument
Selector.
Not available in operator mode.

Import Value(s)...................................................................................... 661


To import table values.
Not available in operator mode.

576
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Increments............................................................................................ 662
To specify the increments for the selected variable.
Not available in operator mode.

Indicators - Reset Max........................................................................... 663


To reset the maximum indicator to the current value of the instrument.

Indicators - Reset Min............................................................................ 664


To reset the minimum indicator to the current value of the instrument.

Insert Axis Point(s)................................................................................. 664


To define new axis points on the x- or y-axis.
Not available in operator mode.

Insert Before.......................................................................................... 665


To insert a row with the selected variable before the currently selected
row in the Variable Array.
Not available in operator mode.

Instrument Properties............................................................................ 666


To view and edit the properties of an instrument.

Instrument Script................................................................................... 667


To extend the functionality of an instrument by adding Python code to it.

Instrument Selector............................................................................... 668


To show the Instrument Selector.

Instruments Page................................................................................... 672


To specify global color, fonts, and header settings for instruments.
Not available in operator mode.

Items..................................................................................................... 674
To add items and configure their properties.

Label..................................................................................................... 674
To specify the properties of the label cell.
Not available in operator mode.

Left....................................................................................................... 675
To display the plotter legend on the left side of the chart.
Not available in operator mode.

Line Style (Time Plotter/Index Plotter)..................................................... 676


To specify whether to connect the points of a line graphically by a
straight line.
Not available in operator mode.

Line Style (XY Plotter)............................................................................ 676


To specify whether to connect the points of a line graphically by a
straight line.
Not available in operator mode.

Lock Update.......................................................................................... 677


To 'freeze' the instrument display.

Maximize Column Width....................................................................... 678


To maximize the width of the selected column.
Not available in operator mode.

577
May 2024 ControlDesk Instrument Handling
Reference Information

Move Here............................................................................................ 679


To move an instrument to a new new position on a layout.
Not available in operator mode.

Navigation – Enable/Disable Move Mode (Time Plotter/Index


Plotter).................................................................................................. 679
To enable or disable the move mode. The move mode lets you move the
displayed area of the axis via mouse pointer.

Navigation – Move Mode (Time Plotter/Index Plotter)............................. 680


To move the displayed area of the chart via the pointer.

Navigation – Rescale (Time Plotter/Index Plotter).................................... 681


To rescale one or all axes.

Navigation – Zoom Mode (Time Plotter/Index Plotter).................... ........ 681


To zoom the displayed area of the chart via the pointer.

On/Off Values / On Value....................................................................... 682


To specify the properties of the following buttons: Check button, On/Off
button, Push button.
Not available in operator mode.

Optimize............................................................................................... 683
To let ControlDesk specify the optimum width and/or heigth of the
selected instrument.
Not available in operator mode.

Overlay Element - Delete....................................................................... 684


To delete the selected overlay element.
Not available in operator mode.

Overlay Element - Move Down.............................................................. 684


To move the selected overlay element in the instrument one layer down.
Not available in operator mode.

Overlay Element - Move to Bottom........................................................ 685


To move the selected overlay element to the bottom layer of the
instrument.
Not available in operator mode.

Overlay Element - Move to Top.............................................................. 686


To move the selected overlay element to the top layer of the instrument.
Not available in operator mode.

Overlay Element - Move Up................................................................... 687


To move the selected overlay element in the instrument one layer up.
Not available in operator mode.

Parameter – Assign Default Value(s) to Selected Service......................... 688


To assign default values to the parameters of a communication object.

Paste Value(s)........................................................................................ 688


To insert copied values into the table.
Not available in operator mode.

Physical (Converted).............................................................................. 689


To display a value in the instrument in physical (converted) mode.

578
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Point Style (Time Plotter/Index Plotter)........................................... ........ 690


To select the style of the signal's points.
Not available in operator mode.

Point Style (XY Plotter)........................................................................... 691


To select the style of the curve's points.
Not available in operator mode.

Preview Signal Visible............................................................................ 692


To show or hide the measured signal as a preview in the scroll bar.

Remove (Instrument Selector)................................................................ 692


To remove the selected instrument or category.
Not available in operator mode.

Remove This Column............................................................................. 693


To remove the selected column from the legend.
Not available in operator mode.

Rename (Custom Instrument)................................................................ 694


To rename the selected custom instrument.
Not available in operator mode.

Replace Variable.................................................................................... 695


To replace the connected main variable of the selected row in the
Variable Array.
Not available in operator mode.

Rescale.................................................................................................. 696
To rescale one or both axes of a plot.
Not available in operator mode.

Rescale Data Axis................................................................................... 696


To adjust the size of the 2-D view to the range of the data axis values.

Resize to Image..................................................................................... 697


To adjust the instrument size to the size of the background image.

Right..................................................................................................... 698
To display the plotter legend on the right side of the chart.
Not available in operator mode.

Row - Cells............................................................................................ 698


To open the Cells dialog.

Row - Delete......................................................................................... 699


To delete the selected row.
Not available in operator mode.

Row - Highlighted - Color...................................................................... 700


To specify the highlight color of the currently selected row.
Not available in operator mode.

Row - Highlighted - Enabled.................................................................. 700


To highlight the currently selected row.
Not available in operator mode.

579
May 2024 ControlDesk Instrument Handling
Reference Information

Save Displayed Data as New Measurement............................................ 701


To save the data that is displayed in a Time Plotter as a new
measurement.

Save to File............................................................................................ 702


To save the content of the instrument to a file.

Scale Range........................................................................................... 703


To specify the scale range properties of the Bar or Slider Cell.
Not available in operator mode.

Scaling Mode........................................................................................ 703


To select the scaling mode of the axis.
Not available in operator mode.

Select in Bus Navigator.......................................................................... 705


To select the associated element in the Bus Navigator.
Not available in operator mode.

Select in Instrument Navigator............................................................... 705


To change the focus to the associated instrument node in the
Instrument Navigator.

Set as Default for................................................................................... 706


To set the selected instrument as the default instrument for a certain
variable type.
Not available in operator mode.

Show Auto Filter Row............................................................................ 707


To display a filter row above the legend columns.

Show Bookmarks................................................................................... 708


To show or hide bookmark symbols at the x-axis.

Show Column Headers (Time Plotter/Index Plotter)................................ 709


To show/hide the column headers in the legend.

Show Current/Reference........................................................................ 710


To specify whether to display the current value or the reference value in
the current instrument.

Show Expand Button............................................................................. 711


To display the legend's expand button in the instrument.
Not available in operator mode.

Show Find Panel.................................................................................... 711


To filter the signals to be displayed in the plotter by a search string.
Not available in operator mode.

Show Group By Panel............................................................................ 712


To group the signals in the legend via drag & drop.

Show Legend........................................................................................ 713


To show/hide the legend.

Show Libraries....................................................................................... 714


To open a pane showing the predefined instrument libraries, and to copy
selected instruments or libraries to the Instrument Selector.
Not available in operator mode.

580
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Show Scroll Bar (Time Plotter/Index Plotter)............................................ 715


To show or hide the instrument's scroll bar.

Show Toolbar........................................................................................ 715


To show/hide the instrument's toolbar.

Sort Ascending...................................................................................... 718


To sort the rows of the legend alphabetically in ascending order by the
selected column.
Not available in operator mode.

Sort Descending.................................................................................... 719


To sort the rows of the legend alphabetically in descending order by the
selected column.
Not available in operator mode.

Sort Items.............................................................................................. 720


To sort the list displayed in the selection box.
Not available in operator mode.

Switch to Move Mode / Switch to Zoom Mode (XY Plotter).................... 721


To zoom or move the displayed area of the chart via mouse pointer.
Not available in operator mode.

Switch Variable (XY Plotter)................................................................... 721


To interchange the variables that are connected to the x- and y-axis.
Not available in operator mode.

Tic Format............................................................................................. 722


To select the format used to label the axis tics.
Not available in operator mode.

Toggle Bits............................................................................................. 723


To toggle selected bits of the connected variable.

Top........................................................................................................ 724
To display the plotter legend above the chart.
Not available in operator mode.

Tree Mode - Hierarchical View............................................................... 725


To toggle between hierarchy view and flat view of the diagnostic
communication objects.

Ungroup................................................................................................ 725
To revoke grouping the signals according to the entries of the selected
column.

Update All LLs....................................................................................... 726


To update the information on all the logical links in the Fault Memory
Instrument(s).

Update Selected LLs............................................................................... 727


To update the information on the selected logical links in the Fault
Memory Instrument(s).

Variable - Converted (Plotter Instruments).............................................. 728


To display the signal values in converted (physical) mode.

581
May 2024 ControlDesk Instrument Handling
Reference Information

Variable - Delete Variable (Time Plotter/Index Plotter)............................. 729


To delete the selected variable leaving an unconnected signal.

Variable - Source (Time Plotter/Index Plotter).......................................... 729


To display the signal values in source (dec) mode.

Variable(s) - Add.................................................................................... 730


To connect a variable to an instrument.
Not available in operator mode.

Variable(s) - Select in Variables/Mappings Pane...................................... 731


To select and highlight variables in the Variables pane, or framework
labels in the Mappings pane.

Variable(s) Properties............................................................................. 732


To show the Properties dialog of a connected variable.

Variables – Copy to Instrument.............................................................. 733


To add a new instrument to the layout and copy the selected variables to
it.

Variables - Cut....................................................................................... 733


To cut the selected variables in the current instrument.

Variables - Delete................................................................................... 734


To delete the selected variables.

Variables - Paste/Paste Variables............................................................. 735


To paste variables from the Clipboard to an instrument.
Not available in operator mode.

Y-Axes View – Horizontal Stacked.......................................................... 735


To arrange the y-axes horizontally one below the other.

Y-Axes View – Rescale All Axes.............................................................. 736


To rescale all y-axes in one step.

Y-Axes View – Settings.......................................................................... 737


To set the width of the y-axes to optimum, maximum, or fixed size.

Y-Axes View – Vertical Fixed................................................................... 738


To align the y-axes vertically. All y-axes are visible.

Y-Axes View – Vertical Scroll.................................................................. 738


To align the y-axes vertically in a scroll area.

2-D View

Access You can access this command via:

Ribbon None
Context menu of Table Editor – Views
Shortcut key None

582
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To configure display options of the 2‑D view.

Description The 2‑D view is not available for maps that contain variables that use conversion
tables (with the exception of verbal conversion tables).

The most options are only available if the 2-D view displays a 2-D projection of
3-dimensional data:

Menu Entry Shortcut Keys Description


Visible None To show/hide the 2‑D view.
XZ Projection None (Available only for projections) To
show/hide the xz projection axis.
YZ Projection None (Available only for projections) To
show/hide the yz projection axis.
One Pane None (Available only for projections) To show
only one pane.
Three Panes None (Available only for projections) To show
Centered three panes with the edit point on the
second pane.
Three Panes None (Available only for projections) To show
Following three panes with the edit point on the first
pane.
All Panes None (Available only for projections) To show all
panes.
Use all Values for Ctrl+Shift+Z (Available only for projections) To use the
Data Axis Scaling same data axis scaling for all available
panes.
Reset Ctrl+R To reset the view to the default settings.

Related topics Basics

Basics of Handling the Table Editor......................................................................................... 188

HowTos

How to Set Up a View of the Table Editor............................................................................... 211

583
May 2024 ControlDesk Instrument Handling
Reference Information

3-D View

Access You can access this command via:

Ribbon None
Context menu of Table Editor – Views
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To configure display options of the 3-D view.

Description The 3‑D view is not available for maps that contain variables that use conversion
tables (with the exception of verbal conversion tables).

Menu Entry Shortcut Keys Description


Visible None To show/hide the 3‑D view.
Set Default Ctrl+Shift+U To save the current settings of the Table
Editor's 3-D view (zoom and rotation) as user
default settings.
Restore Ctrl+U To restore the user default settings for the
Default Table Editor's 3‑D view.
Reset Ctrl+R To reset the view to the Table Editor's default
settings.

Related topics Basics

Basics of Handling the Table Editor......................................................................................... 188

HowTos

How to Set Up a View of the Table Editor............................................................................... 211

584
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Add Category

Access You can access this command via:

Ribbon None
Context menu of Instrument Selector
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To add a new category to the Instrument Selector.

Description In the Instrument Selector, you can use categories to structure the instrument
tree. Nested categories are possible.

Result A new category is added to the Instrument Selector.

Tip

To change the name of a category, click it and press F2.

Related topics HowTos

How to Configure the Instrument Selector................................................................................ 44

Add to Favorites

Access You can access this command via:

Ribbon None
Context menu of Instrument Selector - selected instrument

585
May 2024 ControlDesk Instrument Handling
Reference Information

Shortcut key None


Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To add the selected instrument to the Favorites category of the Instrument
Selector.

Result The selected instrument is added to the Favorites category of the Instrument
Selector and is visible in the list when you place a variable on a layout via the
Variables pane.

Related topics HowTos

How to Define Default and Favorite Instruments....................................................................... 47

Adjust Value(s)

Access You can access this command via:

Ribbon None
Context menu of Instruments (Variable Array: instrument rows) that are
used for calibration
Shortcut key +, *, /, or =
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To enter a value as the operand to change the parameter value.

586
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Description You can change the values of one or more selected instrument rows or table
cells.

The following options are available:

Menu Entry Shortcut Key Description


Add + To enter a value to add to the
current value. Use a negative
number to subtract a value.
Multiply * To enter a value to multiply the
current value by.
Divide / To enter a value to divide the
current value by.
Assign Alt+E To enter a new value for the
variable.

ControlDesk ignores values that violate hard limits and indicates this by a beep.
An error entry is shown in the Message Viewer.

If limits are defined for a scalar variable and the entered value lies between the
weak and the hard limits, ControlDesk opens the Exceeded Limits dialog that
lets you specify how to handle the entered value.

Exceeded Limits dialog The dialog lets you specify how to handle the entered value when limits are
exceeded. For details, refer to Handling Parameter Range Limits (ControlDesk
Calibration and Data Set Management ).

Do not change value(s) Leaves value(s) unchanged.

Limit value(s) to relevant weak limit(s) Sets value(s) to relevant weak


limit(s).

Limit value(s) to relevant hard limit(s) Sets value(s) to relevant hard limit(s).

List of parameters (and their limits) Displays all parameters that are to
be changed. Parameters whose weak limits are exceeded are displayed in blue.
Parameters whose hard limits are exceeded are displayed in red.

Only show this dialog if Shift key is down Specifies that this dialog is only
shown if the Shift key is down. When the dialog is not shown, the procedure
defined in it is used for all further limit violations.

Editing Axis Points If you change the value of an axis point in the Table Editor, the following dialogs
might open.

You can preview the new axis value in the table cell, but it is not written to the
variable until you press OK in the last dialog that opens.

Interpolation dialog Lets you specify whether the function values should be interpolated or not. You
can disable this dialog and specify a default setting on the Axes properties of the
instrument's Properties pane.

587
May 2024 ControlDesk Instrument Handling
Reference Information

No Leaves all function values unchanged.

Yes Interpolates the function values in linear form to keep the gradient of the
straight line.

Edit Common Axis dialog If you have changed an axis point of a common axis, the Edit Common Axis
dialog opens.

Variable Properties Opens the Properties dialog of the variable, which shows
you the references of the common axis.

OK Opens the Move Axis Points dialog, see above.

Cancel Cancels the changing of the axis point.

Axis Monotony Violation If the changed axis point value violates the monotony of axis points, the Axis
dialog Monotony Violation dialog opens (if enabled on the Axes properties in the
instrument’s Properties pane) and prompts you to write the value(s).

Yes Ignores the monotony violation and writes the changed value(s). The
Table Editor no longer displays a chart but tells you which axis is inconsistent.
Additionally, in the grid view the corresponding cells of the inconsistent axis
are marked by a red frame. As soon as you have reestablished monotony, the
corresponding chart appears in the 2-D/3-D view and the red frame in the grid
view disappears.

No Cancels the changing of the value(s).

Related topics Basics

Handling Parameter Range Limits (ControlDesk Calibration and Data Set


Management )

HowTos

How to Change Function Values in the Table Editor................................................................ 203


How to Change Values with the Knob.................................................................................... 146
How to Change Values with the Slider.................................................................................... 165
How to Change Values with the Variable Array (Alphanumeric Input Value Cell Type)............. 246
How to Change Values with the Variable Array (Bitfield Editor Value Cell Type)....................... 249

References

Instrument-Related Commands.............................................................................................. 571

588
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Always Show List

Access You can access this command via:

Ribbon None
Context menu of Instrument Selector
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To show an instrument list when you drag a variable from the Variables pane to
a layout.

Result You can select an instrument from a list.

Related topics Basics

Connecting Variables and Framework Labels to Instruments (ControlDesk


Layouting )

Append Variable

Access This command is available only when you drag a variable to a row in the Variable
Array with the right mouse button. You can access this command via:

Ribbon None
Context menu of Variable Array
Shortcut key None
Icon None

589
May 2024 ControlDesk Instrument Handling
Reference Information

Tool automation § Layout- and Instrument-Related Interfaces on


page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To append a row with the selected variable to the currently selected row in the
Variable Array.

Result A new row is appended to the currently selected row in the Variable Array and
the selected Variable is connected to the new row.

Related topics References

Connect as Additional Write Variable(s).................................................................................. 618


Connect as Main Variable / Connect Variable(s)...................................................................... 619
Connect to New Instrument................................................................................................... 621
Copy Here.............................................................................................................................. 627
Copy Here Without Connections............................................................................................ 628
Insert Before........................................................................................................................... 665
Move Here............................................................................................................................. 679
Replace Variable..................................................................................................................... 695

Assign Properties

Access You can access this command via:

Ribbon Layouting – Instruments


Context menu of None
Shortcut key None
Icon

Tool automation § Layout- and Instrument-Related Interfaces on


page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

590
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Purpose To assign the property settings of one instrument to another for all shared
properties.

Description The property settings of common properties are assigned from the currently
selected instrument to the next one you select.

Assign Recent Value

Access You can access this command via:

Ribbon None
Context menu of Instruments (Variable Array: instrument rows) that are
used for calibration - Adjust Value(s)
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To display the most recent scalar values of a variable and to reset the variable to
one of them.

Related topics References

Adjust Value(s)........................................................................................................................ 586

Assign Reference Value(s)

Access You can access this command via:

Ribbon None
Context menu of Instruments (Variable Array: instrument rows) that are
used for calibration - Adjust Value(s), Table Editor
Shortcut key Ctrl+Shift+R
Icon None

591
May 2024 ControlDesk Instrument Handling
Reference Information

Tool automation § Layout- and Instrument-Related Interfaces on


page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To set the values in the selected cells to the corresponding values of the
reference data set (reference values).

Related topics Basics

Basics of Handling the Table Editor......................................................................................... 188

References

Instrument-Related Commands.............................................................................................. 571

Available Raster (XY Plotter)

Access You can access this command via:

Ribbon None
Context menu of § Curve symbol
§ Curve (Signal - Available Raster)
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To select a measurement raster for the curve.

Description If the variables of a curve share more than one measurement raster, you
can select a raster from the list. For more information on measurement
rasters, refer to Basics on Measurement Rasters (ControlDesk Measurement and
Recording ).

592
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Related topics HowTos

How to Configure the XY Plotter............................................................................................ 260

References

Instrument-Related Commands.............................................................................................. 571

Best Fit

Access You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter – legend (column header)
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To adjust the column width of the selected legend column automatically.

Related topics References

Best Fit (All Columns).............................................................................................................. 593

Best Fit (All Columns)

Access You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter – legend (column header)

593
May 2024 ControlDesk Instrument Handling
Reference Information

Shortcut key None


Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To adjust the column width of all legend columns automatically.

Related topics References

Best Fit................................................................................................................................... 593

Bin (Source)

Access This command is not available for ASCII variables. For variables that contain
numerical values and allow conversion you can access it via:

Ribbon None
Context menu of Instruments for measurement and calibration - Display
Value(s)
Shortcut key Ctrl+Alt+B
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To display a value in bin (source) mode.

Description The value is preceded by a 0b. You can enter the value in a cell in any supported
numeric format (DEC, HEX, or BIN) independently of the current conversion
mode selected. A hexadecimal value must be prefixed by 0x or followed by h, a
binary value must be prefixed by 0b.

594
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Related topics HowTos

How to Display a Value in Converted or Source Mode (ControlDesk Variable


Management )

References

Instrument-Related Commands.............................................................................................. 571

Bitmask

Access You can access this command via:

Ribbon None
Context menu of Instruments that are used for measurement and
calibration (except for plotters and Table Editor) -
Display Value(s)
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To specify the bitmask for the currently selected variable.

Result Opens a dialog and lets you specify the properties of the selected item. Refer to
Bitmask Properties on page 436.

595
May 2024 ControlDesk Instrument Handling
Reference Information

Bottom

Access You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter:
§ Splitter
§ Expand button
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To display the plotter legend below the chart.

Related topics References

Left........................................................................................................................................ 675
Legend Properties (Time Plotter/Index Plotter)......................................................................... 492
Right...................................................................................................................................... 698
Top......................................................................................................................................... 724

Cancel (Diagnostics Instrument)

Access This command is available only if online calibration has been started. The
execution of a diagnostic service or job must be running. You can access this
command via:

Ribbon None
Context menu of None
Shortcut key Ctrl+N
Icon None
Button In the button area of the Diagnostics Instrument

596
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Tool automation § Layout- and Instrument-Related Interfaces on


page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To stop the execution of a diagnostic communication object.

Description To communicate with an ECU via the Diagnostics Instrument, you select a
communication object in the object tree, configure it via the parameter list, and
then execute it. You cannot stop the execution of a service or a job, that has
been already sent to the ECU.

Related topics HowTos

How to Configure and Execute Diagnostic Communication Objects (ControlDesk


ECU Diagnostics )

References

Instrument-Related Commands.............................................................................................. 571

Cell - Change To

Access You can access this command via:

Ribbon None
Context menu of Cells in the Hierarchy Array
Shortcut key None
Icon None

Note

This command is not available in operator mode.

Purpose To change the type of the selected cell.

Result ControlDesk changes the cell type according to your selection.

597
May 2024 ControlDesk Instrument Handling
Reference Information

Related topics References

Hierarchy Array....................................................................................................................... 336

Cell - Delete

Access You can access this command via:

Ribbon None
Context menu of Cells in the Hierarchy Array
Shortcut key None
Icon None
Tool automation HierarchyArrayCells / IViHierarchyArrayCells
<<Collection>> (ControlDesk Automation )

Note

This command is not available in operator mode.

Purpose To delete the selected cell.

Result ControlDesk deletes the selected cell.

Related topics References

Hierarchy Array....................................................................................................................... 336

Cell Properties

Access You can access this command via:

Ribbon None
Context menu of § Variable Array (various instrument cell types)
§ Bus Instrument
Shortcut key None
Icon None

598
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Tool automation § Layout- and Instrument-Related Interfaces on


page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To specify properties of the selected cell.

Description Depending on the type of the selected instrument cell, ControlDesk opens a
dialog for you to specify cell properties. For an overview of the properties,
refer to Variable Array on page 389 or Bus Instruments (ControlDesk Bus
Navigator ).

Related topics Basics

Basics of Handling the Variable Array...................................................................................... 241

Change Icon

Access You can access this command via:

Ribbon None
Context menu of Custom instrument (Instrument Selector)
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To change the icon of the currently selected custom instrument.

599
May 2024 ControlDesk Instrument Handling
Reference Information

Result A list opens to let you choose an icon for the selected instrument. Click OK to
use an icon from the list or use the Browse button to browse in the file system
for an icon file. To exit the dialog without selecting an icon, click Cancel or click
outside the dialog.

Related topics HowTos

How to Make an Instrument Reusable...................................................................................... 50

Change To/Variables - Change To

Access You can access this command via:

Ribbon None
Context menu of Variables in an instrument
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To connect the variables to a different instrument.

Result Depending on the type(s) of the selected variable(s), ControlDesk lets you select
one of the favorite instruments to be used to visualize the variable(s). The
variable(s) is/are connected to the instrument that you select.

Related topics References

Instrument-Related Commands.............................................................................................. 571

600
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Clear All DTCs

Access This command is available only if online calibration has been started. You can
access this command via:

Ribbon None
Context menu of None
Shortcut key Ctrl+L
Icon None
Button In the button area of the Fault Memory Instrument
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To delete all trouble code entries from the fault memory.

Description ControlDesk first executes the fault clear service to delete all trouble code
entries from the fault memory of the ECUs referenced by the logical links in
the Fault Memory Instrument. It then executes the fault read service to display
the updated data in the instrument.

Depending on the ECU and its state, some DTCs might not be deleted and are
still displayed.

Related topics HowTos

How to Display Fault Memory Entries (ControlDesk ECU Diagnostics )

References

Instrument-Related Commands.............................................................................................. 571

Clear Display

Access You can access this command via:

Ribbon None
Context menu of None
Shortcut key Ctrl+R

601
May 2024 ControlDesk Instrument Handling
Reference Information

Icon None
Button In the button area of the Diagnostics Instrument
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To remove all entries from the instrument's output field.

Description You can specify general settings for displaying entries in the output field in the
instrument's Properties pane.

Related topics HowTos

How to Configure and Execute Diagnostic Communication Objects (ControlDesk


ECU Diagnostics )

References

Instrument-Related Commands.............................................................................................. 571

Clear Selected DTC

Access This command is available only if online calibration has been started. The
instrument must contain at least one logical link and one logical link update
must have been performed. You can access this command via:

Ribbon None
Context menu of None
Shortcut key Ctrl+S
Icon None
Button In the button area of the Fault Memory Instrument
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To delete the selected trouble code entry from the fault memory.

602
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Description ControlDesk first executes the fault clear service to delete the selected trouble
code entry from the fault memory. It then executes the fault read service to
display the updated data in the instrument.

Depending on the ECU and its state, a DTC might not be deleted and is still
displayed.

Related topics HowTos

How to Display Fault Memory Entries (ControlDesk ECU Diagnostics )

References

Instrument-Related Commands.............................................................................................. 571

Clear Sorting

Access You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter – legend (column header)
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To clear the alphabetical sorting of the legend rows.

Related topics References

Sort Ascending....................................................................................................................... 718


Sort Descending..................................................................................................................... 719

603
May 2024 ControlDesk Instrument Handling
Reference Information

Code Editor Dialog

Access This dialog opens when you select the following command or property:
§ Instrument Script
§ Script Property
§ Layout Properties ‑ Script Property

Purpose To assign Python code to an event of the selected instrument or layout.

Code Editor dialog The Code Editor lets you enter Python code to be stored with the
instrument/layout. The script template contains event handlers for the selected
instrument/layout.

Commands The following buttons are available in the dialog:

Command Button Shortcut Purpose


Run Ctrl+R To run the Python script.

New Ctrl+N To create a new Python script, starting with a script


template for the instrument.
Import Ctrl+I To import a Python script.

Export Ctrl+E To export the Python script.

Cut Ctrl+X To cut the current selection to the Clipboard.

Copy Ctrl+C To copy the selection to the Clipboard.

Paste Ctrl+V To paste the Clipboard content into the code.

Undo Ctrl+Z To undo the most recent edit command or action.

604
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Command Button Shortcut Purpose


Redo Ctrl+Y To redo the most recent edit command or action.

List of available event handlers The editor provides a list with the event
handlers in the script if Show Function Browser is selected on the Python
Editor (refer to Python Editor Page (ControlDesk Automation )) page of the
ControlDesk Options dialog.

Modifying scripts The Code Editor provides context menu commands to facilitate script
modifications.

Comment You can set comment characters in a selection of code lines.


These lines will be ignored by the Interpreter. Commented code lines can be
uncommented again.

Tabify You can use spaces or tabulators to indent. You can replace a
sequence of four spaces by one tabulator, or one tabulator by four spaces. By
default, if you enter a tabulator it is replaced by four spaces.

Upper case / lower case You can unify your Python code with regard to
upper-case and lower-case letters.

Check syntax You can check the syntax of the code in the selected Python
script by using the Check Syntax command. A dialog informs you whether the
check is successfully finished.

Find You can use the Find (ControlDesk Automation ) command to search
for text in your Python code.

Related topics Basics

Adding a Python Script to an Instrument or Layout (ControlDesk Customization )


Python: Choosing Between Different Code and Script Types (ControlDesk
Automation )
Working with the Python Editor (ControlDesk Automation )

References

Check Syntax (ControlDesk Automation )

605
May 2024 ControlDesk Instrument Handling
Reference Information

Collapse All

Access You can access this command via:

Ribbon None
Context menu of Hierarchy Array on a layout
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To collapse all rows in the instrument.

Result All rows in the instrument are collapsed.

Collapse Subordinate Rows

Access You can access this command via:

Ribbon None
Context menu of Header row of a Hierarchy Array on a layout
Shortcut key Enter
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To collapse only the subordinate rows below a header row.

Result All rows subordinate to the selected header row are collapsed.

606
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Column Chooser (Time Plotter/Index Plotter)

Access You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter – Legend
Shortcut key None
Icon None

Purpose To add/remove columns to/from the legend.

Result The Customization dialog opens for you to add/remove columns to/from the
Plotter legend.

Customization dialog The Customization dialog provides all the columns that can be displayed in the
legend. Select the column you want to display in the Plotter legend and drag it
to the legend.

The following columns are available:

Column Description
Address Displays the base address of the variable on the hardware
or VPU.
Block Displays the name of the block that contains the variable
(real-time model).
Conversion Mode Displays the representation format of the variable.
Description Displays the comment that is assigned to the variable in
the variable description.
Downsampling Displays the visualization downsampling settings.
Hard Limits Displays the hard limits of the variable.
Icon Icon with signal color (placed in the first column of the
legend).
Leading Raster Displays if the signal is associated with the leading
raster. The leading raster is the measurement raster that
specifies the trigger settings of the plotter display. You can
change the leading raster by double-clicking an empty cell
in this column.
Maximum Displays the maximum value of the signal in relation
to the displayed area of the measurement (a running
measurement must be stopped).
Mean Displays the mean value of the signal in relation to
the displayed area of the measurement (a running
measurement must be stopped).

607
May 2024 ControlDesk Instrument Handling
Reference Information

Column Description
Minimum Displays the minimum value of the signal in relation
to the displayed area of the measurement (a running
measurement must be stopped).
Name Displays the name of the variable.
Path Displays the path of the variable.
Platform Displays the platform/device name.
Raster Displays the measurement raster of the variable.
Signal Color Displays the color of the signal.
Signal Name Displays the name of the signal.
Standard Deviation Displays the standard deviation of the signal in relation
to the displayed area of the measurement (a running
measurement must be stopped).
Type Displays the data type of the variable.
Unit Displays the unit of the variable.
Value Displays the value of the variable.
Weak Limits Displays the weak limits of the variable.
X Delta Displays the difference between the two x values of the
delta cursor (the visualization of a running measurement
must be stopped).
X Left Displays the x value of the left delta cursor or single
cursor (the visualization of a running measurement must
be stopped).
X Right Displays the x value of the right delta cursor (the
visualization of a running measurement must be stopped).
X-Axis Offset (Available only for recordings) Lets you specify an offset
(in seconds) to the time stamps in the recorded data.
By adding an offset, you can move the signals of a
recording to the left or right in the plotter's display to
synchronize the data with other recordings or (stopped)
measurements.
Y Delta Displays the difference between the two y values of the
delta cursor (the visualization of a running measurement
must be stopped).
Y Left Displays the y value of the left delta cursor or single
cursor (the visualization of a running measurement must
be stopped).
Y Right Displays the y value of the right delta cursor (the
visualization of a running measurement must be stopped).

Related topics References

Index Plotter........................................................................................................................... 341

608
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Columns - Customize

Access You can access this command via:

Ribbon None
Context menu of Variable Array - Columns
Shortcut key Ctrl+Shift+L
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To configure the columns of the Variable Array.

Result Opens the Customize Columns dialog.

Description You can configure the information to be displayed in the Variable Array.
ControlDesk displays the most frequently used columns by default. You can add
more columns and change their order via the Customize Columns dialog.

The following predefined columns are available:

Column Type Description


Bar (Value) Lets you display the value of the
connected variable with a Bar value cell.
Bitfield (Value) Lets you edit the value of the connected
variable with a Bitfield value cell.
Check button (Value) Lets you edit the value of the connected
variable with a CheckButton value cell.
Display (Value) Lets you display the value of the
connected variable with a Display value
cell.
Multistate LED (Value) Lets you display the value of the
connected variable with an LED value cell.
Numeric Input (Value) Lets you edit the value of the connected
variable with Numeric Input value cell.
On/Off Button (Value) Lets you edit the value of the connected
variable with an On/Off Button value cell.

609
May 2024 ControlDesk Instrument Handling
Reference Information

Column Type Description


Push button (Value) Lets you edit the value of the connected
variable with a PushButton value cell.
Slider (Value) Lets you edit the value of the connected
variable with a Slider value cell.
Indicator Displays the status of the connected
variables.
Label Lets you insert a label column with empty
cells. You can add text and predefined
macros to each cell of the column via the
cell properties later on.
Min./Max. Displays the maximum or minimum of the
measured value.
Range Check Displays above and below symbols
according to your range check
configuration.

Customize Columns Dialog Lets you configure the columns that are displayed in the Variable Array.

Append New Column Appends the selected column of the Column Type to
the end of the Current Column Configuration list.

Column Types Displays the available column types.

Current Column Configuration Displays the current configuration of the


columns to be displayed in the Variable Array.

Delete Deletes the selected column from the Current Column


Configuration.

Down Moves the selected column down in the list of the Current Column
Configuration.

Insert New Column Inserts the selected column of the Column Type list
above the currently selected column in the Current Column Configuration list
(or at the top of the list if no column is currently selected).

OK Confirms the configuration and closes the dialog.

Up Moves the selected column up in the list of the Current Column


Configuration.

Tip

The current column configuration displays all columns of the Variable Array.
Some of them can only be added via the Insert Column command. Refer to
Insert Column.

610
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Related topics Basics

Basics of Handling the Variable Array...................................................................................... 241

References

Columns - Insert .................................................................................................................... 611

Columns - Delete

Access You can access this command via:

Ribbon None
Context menu of Variable Array - Columns
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To delete the selected column.

Related topics Basics

Basics of Handling the Variable Array...................................................................................... 241

Columns - Insert

Access You can access this command via:

Ribbon None
Context menu of Variable Array - Columns

611
May 2024 ControlDesk Instrument Handling
Reference Information

Shortcut key None


Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To add a column to the Variable Array.

Description You can add the following predefined columns:

Column Description
Block Name (label column with Lets you display the block name of the variable.
predefined macro)
Conversion Mode (label column with Lets you display the conversion mode of the variable.
predefined macro)
Data Type (label column with predefined Lets you display the data type of the variable.
macro)
Device Name (label column with Lets you display the name of the connected device or platform.
predefined macro)
Display Mode (label column with Lets you display the display mode of the variable.
predefined macro)
Indicator Lets you display the status of the connected variables.
Label (label column without predefined Lets you insert a label column with empty cells. You can add text and predefined
macro) macros to each cell of the column via the cell properties later on. Refer to Label
Properties (Label Cell) on page 488.
Min/Max Lets you display the maximum or minimum of the measured value.
Range Check Lets you display above and below symbols according to your range check
configuration.
Value Lets you display or edit the value of the connected variable.
Variable Limits Lets you display the weak limits of the variable.
Variable Name (label column with Lets you display the name of the variable.
predefined macro)
Variable Origin Path (label column with Lets you display the path of the variable that was originally connected to the
predefined macro) instrument. This lets you identify the originally connected variable if it was replaced
by the variable it references.
Variable Path (label column with Lets you display the path of the variable.
predefined macro)
Variable Unit (label column with Lets you display the unit of the variable.
predefined macro)
Variable Unit/Display Mode (label column Lets you display the unit and display mode of the variable.
with predefined macros)

612
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

The new column is added to the left of the selected column.

Related topics Basics

Basics of Handling the Variable Array...................................................................................... 241

References

Columns - Customize............................................................................................................. 609

Columns (Diagnostics Instrument)

Access You can access this command via:

Ribbon None
Context menu of § Diagnostics Instrument – parameter list
§ Diagnostics Instrument – output field
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To add a column to or remove it from the Diagnostics Instrument.

Result The added column is shown in the section of the Diagnostics Instrument in
which the Columns command is invoked, the removed column is hidden.

Description The following commands are available for customizing the columns of the
Diagnostics Instrument:

Note

Not all commands are always available. Their availability depends on where
the Columns command is invoked.

Command Description
Name To add/remove the column for the parameter name to/from the
Diagnostics Instrument.

613
May 2024 ControlDesk Instrument Handling
Reference Information

Command Description
Type To add/remove the column for the parameter data type to/from
the Diagnostics Instrument.
Unit To add/remove the column for the parameter unit to/from the
Diagnostics Instrument.
Validity To add/remove the column for the validity information of the
parameter to/from the Diagnostics Instrument.
Value To add/remove the column for the parameter value to/from the
Diagnostics Instrument.
Value Range To add/remove the column for the parameter value range to/from
the Diagnostics Instrument.

You cannot hide all the columns of a section of the Diagnostics Instrument. At
least one column must be displayed in each section.

When showing a column in the instrument again, ControlDesk tries to re-


establish its position and width.

To change the order of columns within a section of the Diagnostics Instrument,


drag the column headers left or right. To change the column width, drag the
column header border left or right.

Related topics HowTos

How to Display Fault Memory Entries (ControlDesk ECU Diagnostics )

References

Diagnostics Instrument........................................................................................................... 321


Instrument-Related Commands.............................................................................................. 571

Columns (Fault Memory Instrument)

Access You can access this command via:

Ribbon None
Context menu of § Fault Memory Instrument – Logical link table
§ Fault Memory Instrument – DTC table
§ Fault Memory Instrument – DTC Data table
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

614
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Purpose To add a column to or remove it from the Fault Memory Instrument.

Result The added column is shown in the section of the Fault Memory Instrument in
which the Columns command is invoked, the removed column is hidden.

Description The following commands are available for customizing the columns of the Fault
Memory Instrument:

Note

Not all commands are always available. Their availability depends on where
the Columns command is invoked.

Command Description
#DTCs To add/remove the column for the number of available
diagnostic trouble codes to/from the Fault Memory
Instrument.
Description To add/remove the column for the description text of the DTC
to/from the Fault Memory Instrument.
Display DTC To add/remove the column for the Display DTC value to/from
the Fault Memory Instrument. If no Display DTC value is
specified in the ODX, the number of the DTC is displayed
instead.
DTC # To add/remove the column for the number of the diagnostic
trouble code to/from the Fault Memory Instrument.
Last Update To add/remove the column for the time of the last update of
the information on the logical links to/from the Fault Memory
Instrument.
Level To add/remove the column for the DTC level to/from the Fault
Memory Instrument.
Logical Link To add/remove the column for the logical link name to/from
the Fault Memory Instrument.
New To add/remove the column for indicating new diagnostic
trouble codes to/from the Fault Memory Instrument.
Parameter To add/remove the column for the parameter names to/from
the Fault Memory Instrument.
Read DTC Data To add/remove the column for specifying whether to read
environment data of a diagnostic trouble code to/from the
Fault Memory Instrument.
Read Service To add/remove the column for the service used to read the
fault memory to/from the Fault Memory Instrument.
Status To add/remove the column for the connection status of the
logical link to/from the Fault Memory Instrument.

615
May 2024 ControlDesk Instrument Handling
Reference Information

Command Description
Unit To add/remove the column for the unit of the parameters
to/from the Fault Memory Instrument.
Update Rate [s] To add/remove the column for specifying the update rate for
refreshing the information on the logical link to/from the Fault
Memory Instrument.
Value To add/remove the column for the parameter values to/from
the Fault Memory Instrument.

You cannot hide all the columns of a section of the Fault Memory Instrument. At
least one column must be displayed in each section.

When showing a column in the instrument again, ControlDesk tries to re-


establish its position and width.

To change the order of columns within a section of the Fault Memory


Instrument, drag the column headers left or right. To change the column width,
drag the column header border left or right.

Related topics HowTos

How to Display Fault Memory Entries (ControlDesk ECU Diagnostics )

References

Instrument-Related Commands.............................................................................................. 571

Compu Tab Items Sorted

Access You can access this command via:

Ribbon None
Context menu of Variable Array (Alphanumeric Input value cell) -
Display Value(s)
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To sort the string list of a value with verbal conversion (CompuVTab,
CompuVTabRange) alphabetically.

616
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Result The string list is sorted alphabetically.

Related topics Basics

Basics of Handling the Variable Array...................................................................................... 241

Configure Connection Assignment

Access You can access this command via:

Ribbon None
Context menu of Instrument Navigator - instrument
Shortcut key None
Icon

Tool automation § Layout- and Instrument-Related Interfaces on


page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To configure the connection assignment of the variable(s) in the selected


instrument(s).

Result Opens the Configure Connection Assignment dialog that lets you specify
the Connection Assignment properties for the selected instrument(s). Refer to
Connection Assignment Properties on page 454.

Related topics HowTos

How to Customize the Connection Assignment of Variables and Framework Labels


to Instruments (ControlDesk Layouting )

617
May 2024 ControlDesk Instrument Handling
Reference Information

References

Connection Assignment Properties......................................................................................... 454

Connect as Additional Write Variable(s)

Access This command is available only when you drag a scalar variable from the
Variables pane to the calibration instrument with the right mouse button. You
can access this command via:

Ribbon None
Context menu of Instruments for calibration except Table Editor
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To connect the selected variable to the instrument for calibration as an additional
write variable.

Description You can connect a scalar variable (parameter or writable measurement variable)
to an instrument for calibration as an additional write variable. When you
calibrate the main variable, the changed value is also applied to all the additional
write variables connected to this instrument.

Related topics HowTos

How to Write the Same Value to Several Parameters (ControlDesk Calibration and
Data Set Management )

References

Connect as Main Variable / Connect Variable(s)...................................................................... 619


Instrument-Related Commands.............................................................................................. 571

618
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Connect as Main Variable / Connect Variable(s)

Access This command is available only when you drag one or more variables from the
Variables pane to an instrument with the right mouse button. You can access
this command via:

Ribbon None
Context menu of Instruments for measurement and calibration except
for the Table Editor (Connect as Main Variable)
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To connect the selected variable to the instrument as the main variable.

Description A main variable is a scalar parameter that is visualized in an instrument. 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.

Related topics References

Append Variable..................................................................................................................... 589


Connect as Additional Write Variable(s).................................................................................. 618
Connect to New Instrument................................................................................................... 621
Copy Here.............................................................................................................................. 627
Copy Here Without Connections............................................................................................ 628
Insert Before........................................................................................................................... 665
Move Here............................................................................................................................. 679
Replace Variable..................................................................................................................... 695

619
May 2024 ControlDesk Instrument Handling
Reference Information

Connect as Pitch

Access This command is available only when you drag a variable from the
Variables pane to the Artificial Horizon with the right mouse button. You can
access this command via:

Ribbon None
Context menu of Artificial Horizon
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To connect the selected variable to the Artificial Horizon as the pitch variable.

Description You can connect a measurement variable or a scalar parameter as the pitch
variable in the Artificial Horizon.

Related topics References

Instrument-Related Commands.............................................................................................. 571

Connect as Roll

Access This command is available only when you drag a variable from the
Variables pane to the Artificial Horizon with the right mouse button. You can
access this command via:

Ribbon None
Context menu of Artificial Horizon
Shortcut key None
Icon None

620
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Tool automation § Layout- and Instrument-Related Interfaces on


page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To connect the selected variable to the Artificial Horizon as the roll variable.

Description The roll variable is a scalar measurement variable or scalar parameter that is
visualized in the Artificial Horizon.

Related topics References

Instrument-Related Commands.............................................................................................. 571

Connect to New Instrument

Access This command is available only when you drag instruments or variables to a free
area on a layout with the right mouse button. You can access this command via:

Ribbon None
Context menu of Instrument(s) or variable(s) dragged with right mouse
button
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To connect selected variables to a new instrument.

621
May 2024 ControlDesk Instrument Handling
Reference Information

Result ControlDesk opens a list for you to select an instrument. The selected instrument
is added to the layout and the variables are connected to it.

Related topics References

Append Variable..................................................................................................................... 589


Connect as Additional Write Variable(s).................................................................................. 618
Connect as Main Variable / Connect Variable(s)...................................................................... 619
Copy Here.............................................................................................................................. 627
Copy Here Without Connections............................................................................................ 628
Insert Before........................................................................................................................... 665
Move Here............................................................................................................................. 679
Replace Variable..................................................................................................................... 695

Copy (Diagnostics Instrument)

Access You can access this command via:

Ribbon None
Context menu of § Diagnostics Instrument – communication object
tree – node
§ Diagnostics Instrument – parameter list
§ Diagnostics Instrument – request PDU field
§ Diagnostics Instrument – output field
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To copy the current selection or specific information belonging to the element(s)
currently selected in the Diagnostics Instrument to the Clipboard.

Result The selected element(s) or the information belonging to the selected element(s)
is/are copied and placed on the Clipboard.

622
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Description The following commands are available for copying elements from the Diagnostics
Instrument to the Clipboard:

Note

Not all commands are always available. Their availability depends on where
the Copy command is invoked and on whether the elements to be copied
are currently displayed in the Diagnostics Instrument. Values of hidden
columns cannot be copied.

Command Description
AutomationDesk Format To copy the request parameters to the Clipboard for further use
in AutomationDesk's Remote Diagnostics (COM) library. Copying
with the AutomationDesk format includes the writable parameters
only. The parameters are copied to the Clipboard in the data
format suitable for AutomationDesk, and can be pasted directly in
AutomationDesk.
Display Name(s) To copy the display name of the selected functional class (if invoked
from the communication object tree) or the display name(s) of the
selected parameter(s) (if invoked from the parameter list or the
output field) to the Clipboard.
Entire Output Field To copy all the entries in the instrument's output field to the
Clipboard.
Entire Parameter List To copy the contents of the parameter list (i.e., all the parameters
that are available for the selected communication object and their
properties) to the Clipboard.
Long Name To copy the long name of the selected logical link or diagnostic
communication object to the Clipboard.
Request PDU To copy the request PDU resulting from the selected communication
object and its parameters to the Clipboard.
Selected Row(s) To copy the selected row(s) to the Clipboard.
Service ID To copy the service ID of the selected diagnostic communication
object to the Clipboard.
Short Name To copy the short name of the selected logical link or diagnostic
communication object to the Clipboard.
Short Name Path(s) To copy the short name path(s) of the selected parameter(s), if
available, to the Clipboard.
A short name path consists of the short path followed by the short
name. Short name paths are required for automation purposes (via
ControlDesk tool automation or AutomationDesk). They are used to
uniquely identify the request and response parameters.
Tool Automation Format To copy the request parameters to the Clipboard for further use in
(Python) tool automation. Copying with the tool automation format includes
the writable parameters only. The parameters are copied to the
Clipboard as Python code, and can be used in the tool automation
with a logical link later on.
Type To copy the data type of the selected parameter to the Clipboard.

623
May 2024 ControlDesk Instrument Handling
Reference Information

Command Description
Unit(s) To copy the unit(s) of the selected parameter(s), if available, to the
Clipboard.
Validity(ies) To copy the validity information of the selected parameter(s) to the
Clipboard.
Value(s) To copy the value(s) of the selected parameter(s) to the Clipboard.
Value Range(s) To copy the value range(s) of the selected parameter(s) to the
Clipboard.

Related topics HowTos

How to Configure and Execute Diagnostic Communication Objects (ControlDesk


ECU Diagnostics )

References

Columns (Diagnostics Instrument)........................................................................................... 613


Diagnostics Instrument........................................................................................................... 321
Instrument-Related Commands.............................................................................................. 571

Copy (Fault Memory Instrument)

Access You can access this command via:

Ribbon None
Context menu of § Fault Memory Instrument – Logical link table
§ Fault Memory Instrument – DTC table
§ Fault Memory Instrument – DTC Data table
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To copy the current selection or specific information belonging to the element(s)
currently selected in the Fault Memory Instrument to the Clipboard.

Result The selected element(s) or the information belonging to the selected element(s)
is/are copied and placed on the Clipboard.

624
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Description The following commands are available for copying elements from the Fault
Memory Instrument to the Clipboard:

Note

Not all commands are always available. Their availability depends on where
the Copy command is invoked and whether the elements to be copied
are currently displayed in the Fault Memory Instrument. Values of hidden
columns cannot be copied.

Command Description
Description To copy the description text of the selected DTC to the Clipboard.
Display Trouble Code To copy the Display Trouble Code of the selected DTC to the
Clipboard. The Display Trouble Code is the diagnostic trouble code
as specified by the referenced diagnostic data object property (DOP)
in the ODX database. It is displayed in the Display DTC column in
the DTC table.
Entire DTC Data Table To copy the contents of the DTC Data table (i.e., all the status and
environment data of the DTC that is currently selected in the DTC
table) to the Clipboard.
Entire DTC Table To copy the contents of the DTC table (i.e., all the diagnostic
trouble codes that have been received for all the logical links in
the instrument and their properties) to the Clipboard.
Entire Logical Link Table To copy the contents of the Logical Link table (i.e., properties and
settings for all the logical links that are activated for the instrument
in the Properties pane) to the Clipboard.
Logical Link Long Names(s) To copy the long name(s) of the selected logical link(s) to the
Clipboard.
Logical Link Short Names(s) To copy the short name(s) of the selected logical link(s) to the
Clipboard.
Parameter To copy the name of the selected parameter to the Clipboard.
Read Service Display To copy the display name(s) of the service(s) used to read the fault
Name(s) memory to the Clipboard.
Read Service Unique To copy the unique name(s) of the service(s) used to read the fault
Name(s) memory to the Clipboard.
Selected Row(s) To copy the selected row(s) to the Clipboard.
Trouble Code To copy the DTC number to the Clipboard in hexadecimal notation.
Unit To copy the unit of the selected parameter to the Clipboard.
Value To copy the value of the selected parameter to the Clipboard.

Related topics HowTos

How to Display Fault Memory Entries (ControlDesk ECU Diagnostics )

625
May 2024 ControlDesk Instrument Handling
Reference Information

References

Columns (Fault Memory Instrument)....................................................................................... 614


Fault Memory Instrument....................................................................................................... 326
Instrument-Related Commands.............................................................................................. 571

Copy (Instrument)

Access You can access this command via:

Ribbon None
Context menu of § All instruments
§ User functions output viewer
§ Instrument Navigator - instrument node
Shortcut key Ctrl+C
Icon

Tool automation § Layout- and Instrument-Related Interfaces on


page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To copy the selected instruments to the Clipboard.

Result The selected instrument(s) is/are copied and placed on the Clipboard.

Related topics References

Instrument-Related Commands.............................................................................................. 571

Copy / Variables - Copy

Access You can access this command via:

Ribbon None
Context menu of § Variable(s) in an instrument
§ Instrument Navigator - variable item
Shortcut key None

626
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To copy the selected variables to the Clipboard.

Result The selected variable(s) is/are copied and placed on the Clipboard.

Related topics References

Instrument-Related Commands.............................................................................................. 571

Copy Here

Access This command is available only when you drag an instrument to a free area on a
layout with the right mouse button. You can access this command via:

Ribbon None
Context menu of Instrument dragged with right mouse button
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To copy an instrument with its variable connections.

Result The instrument is copied to the selected place on the layout with all its settings
and variable connections.

627
May 2024 ControlDesk Instrument Handling
Reference Information

Related topics References

Append Variable..................................................................................................................... 589


Connect as Additional Write Variable(s).................................................................................. 618
Connect as Main Variable / Connect Variable(s)...................................................................... 619
Connect to New Instrument................................................................................................... 621
Copy Here Without Connections............................................................................................ 628
Insert Before........................................................................................................................... 665
Move Here............................................................................................................................. 679
Replace Variable..................................................................................................................... 695

Copy Here Without Connections

Access This command is available only when you drag an instrument with the right
mouse button. You can access this command via:

Ribbon None
Context menu of Instrument dragged with right mouse button
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To copy an instrument without its variable connections.

Result The instrument is copied to the selected place on the layout with all its property
settings but without its variable connections.

628
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Related topics References

Append Variable..................................................................................................................... 589


Connect as Additional Write Variable(s).................................................................................. 618
Connect as Main Variable / Connect Variable(s)...................................................................... 619
Connect to New Instrument................................................................................................... 621
Copy Here.............................................................................................................................. 627
Insert Before........................................................................................................................... 665
Move Here............................................................................................................................. 679
Replace Variable..................................................................................................................... 695

Copy Value (Instruments)

Access You can access this command via:

Ribbon None
Context menu of § Instrument or instrument value cell
§ Instrument Navigator – instrument node or
connection node
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To copy the value that is displayed in the instrument.

Description If an instrument contains multiple values, they are separated by a tabulator in the
Clipboard. In the Instrument Navigator, you can also select multiple values from
different instruments or connection nodes.

Result The value is copied to the Clipboard as it is displayed in the instrument.

Related topics References

Copy (Instrument)................................................................................................................... 626


Copy Value(s)......................................................................................................................... 630

629
May 2024 ControlDesk Instrument Handling
Reference Information

Copy Value(s)

Access You can access this command via:

Ribbon None
Context menu of Table Editor
Shortcut key Ctrl+Shift+C
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To copy the selected cells to the Clipboard.

Related topics Basics

Basics of Handling the Table Editor......................................................................................... 188

HowTos

How to Change Function Values in the Table Editor................................................................ 203

References

Instrument-Related Commands.............................................................................................. 571

Create XML Configuration

Access You can access this command via:

Ribbon None
Context menu of § Diagnostics Instrument – communication object
tree – node
§ Diagnostics Instrument – parameter list
§ Diagnostics Instrument – request PDU field
Shortcut key None
Icon None

630
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Tool automation § Layout- and Instrument-Related Interfaces on


page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To create service configurations for handling fault memory entries based on the
parameter settings specified in the Diagnostics Instrument for use in an XML
configuration file. You can copy the service configurations to the Clipboard or
save them to a file.

Result Opens the XML Configuration dialog for you to specify configuration settings
that are relevant for the content and usage of the created XML configuration.

Description The following commands are available for creating configured service XML
configurations based on the request parameters currently specified in the
Diagnostics Instrument for the selected service:

Note

Not all commands are always available. Their availability depends on the
type of the selected diagnostic service.

Command Description
Fault Read To create an XML service configuration for reading the fault
memory.
Environment Data To create an XML service configuration for reading environment
data.
Fault Clear Single To create an XML service configuration for clearing single fault
memory entries.
Fault Clear All To create an XML service configuration for clearing all fault memory
entries.

XML Configuration dialog To make a fault memory service that is parameterized in the Diagnostics
Instrument available as XML configuration for being used in an
XML configuration file in ControlDesk projects.

Display name Lets you specify a value for the optional displayName
attribute. The attribute specifies the name to be displayed in the Fault Memory
instrument for the service. The default is the short name.

DTC parameter (Available only if you create a service XML configuration


for reading environment data or clearing single fault memory entries) Lets you
select the DTC parameter to be used with the service configuration. The DTC
parameter is necessary for using the XML configuration.

631
May 2024 ControlDesk Instrument Handling
Reference Information

Show only service element Lets you select whether to create the XML
configuration for the appropriate service element only or for a ready-to-use
XML configuration file containing the service XML configuration.
§ If the checkbox is selected, ControlDesk creates the SERVICE element
containing the required configuration elements. You can then copy the
SERVICE element to the Clipboard (via the Copy to Clipboard button) and
paste it into an existing XML configuration file.
§ If the checkbox is cleared, ControlDesk creates the SERVICE element
containing the required configuration elements and also all the other structure
elements that are required in an XML configuration file to be used in
ControlDesk. You can then save the created XML configuration to a file
(using the Save to File button) and use the file as a global or local
XML configuration file in ControlDesk projects.

Information area Displays the XML service configuration created


appropriately to the request parameter settings currently specified in the
Diagnostics Instrument.

Save to File Lets you save the content of the information area to an XML file.
The XML File dialog opens for you to specify the file name. Due to the naming
requirements of XML configuration files to be used with ControlDesk, the file
name always begins with DS_Service_Config.
The Save to File button is enabled only if the Show only service element
option is disabled.

Copy to Clipboard Lets you copy the displayed XML service configuration to
the Clipboard for further use.

Related topics Basics

Identifying Services and Parameters for ControlDesk Functions (ControlDesk ECU


Diagnostics )
Workflow for Creating an XML Configuration via the Diagnostics Instrument
(ControlDesk ECU Diagnostics )

HowTos

How to Configure and Execute Diagnostic Communication Objects (ControlDesk


ECU Diagnostics )

References

Diagnostics Instrument........................................................................................................... 321

632
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Cut (Instrument)

Access You can access this command via:

Ribbon None
Context menu of § All instruments
§ User functions output viewer
§ Instrument Navigator - instrument node
Shortcut key Ctrl+X
Icon

Tool automation § Layout- and Instrument-Related Interfaces on


page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To cut the selected instruments to the Clipboard.

Result The selected instrument(s) is/are removed and placed in the Clipboard.

Description This can be applied to instruments on a layout.

Related topics References

Instrument-Related Commands.............................................................................................. 571

DAQ - Available Raster (Time Plotter/Index Plotter)

Access You can access this command via:

Ribbon None
Context menu of § Legend (Signal)
§ Signal symbol
§ Curve (Active signal)
Shortcut key None

633
May 2024 ControlDesk Instrument Handling
Reference Information

Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To select a measurement raster for a signal.

Description You can select a raster from the list. For more information on measurement
rasters, refer to Basics on Measurement Rasters (ControlDesk Measurement and
Recording ).

Related topics HowTos

How to Change Trigger Settings via the Index Plotter.............................................................. 136


How to Change Trigger Settings via the Time Plotter.............................................................. 236
How to Specify a Trigger for the Index Plotter Visualization..................................................... 132
How to Specify a Trigger for the Time Plotter Visualization...................................................... 232

References

Index Plotter........................................................................................................................... 341

DAQ – Leading Raster (Time Plotter/Index Plotter)

Access This command is available only for platforms. You can access it via:

Ribbon None
Context menu of Time Plotter/Index Plotter – chart
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

634
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Note

This command is not available in operator mode.

Purpose To select one of the measurement rasters of the displayed signals as the leading
raster for the plotter display. The list contains all the rasters that are currently
used.

Description You can specify a start and a stop trigger for the Index Plotter display. This
is especially useful if the data acquisition of connected signals was already
triggered on the hardware or on VEOS.

If the plotter display is triggered (using the same trigger rules for the display as
for the measurement raster that is associated to the selected signal), only that
part of the data stream that meets the trigger conditions is displayed. The time
stamps on the x-axis begin with 0.

Related topics HowTos

How to Change Trigger Settings via the Index Plotter.............................................................. 136


How to Specify a Trigger for the Index Plotter Visualization..................................................... 132

References

Index Plotter........................................................................................................................... 341

DAQ – Mode (Time Plotter/Index Plotter)

Access This command is available only for platforms. You can access it via:

Ribbon None
Context menu of Time Plotter/Index Plotter – chart
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

635
May 2024 ControlDesk Instrument Handling
Reference Information

Purpose To switch between triggered and untriggered display of plotter data.

Description Mode Description


Trigger mode Lets you enable the triggered display of plotter
data. The plotter uses the trigger settings of
the leading measurement raster for its display
settings.
Only signals with a triggered measurement are
displayed. Continuously measured signals show a
warning symbol in their icons.
The displayed x-axis area starts with the delay of
the start trigger. The number of displayed data
points depends on the selected trigger:
§ Sample count trigger: sample count value (x-
axis scaling is set to fixed mode)
§ Duration trigger: number of samples measured
in the specified duration (x-axis scaling is set to
fixed mode)
§ Platform trigger: number of samples measured
until the stop trigger is reached (x-axis scaling is
set to extended mode)
Continuous Lets you enable the untriggered display of
mode plotter data. The plotter displays the data stream
continuously.
Only continuously measured signals are displayed.
Signals with a triggered measurement show a
warning symbol in their icons.

Related topics HowTos

How to Change Trigger Settings via the Index Plotter.............................................................. 136


How to Specify a Trigger for the Index Plotter Visualization..................................................... 132

References

Index Plotter........................................................................................................................... 341

636
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

DAQ - Trigger (Time Plotter/Index Plotter)

Access You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter:
§ Legend (Signal)
§ Signal symbol
§ Curve (Active signal)
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To switch between automatic and interactive setting of the signal's measurement
trigger.

Description Autoset trigger configures the triggers and display area automatically to
optimize the visualization of a periodic signal.

If you select Autoset Trigger ControlDesk analyses the signal to set the trigger
settings in the measurement configuration automatically. You can change the
number of analyzed data points and the number of displayed periods via the
plotter's properties. Refer to Advanced Settings Properties (Time Plotter/Index
Plotter) on page 416.

637
May 2024 ControlDesk Instrument Handling
Reference Information

If you select Interactive Trigger ControlDesk displays marks on the x-and y-axis.
You can move these marks with the pointer to set the trigger settings in the
measurement configuration interactively.

Related topics HowTos

How to Change Trigger Settings via the Index Plotter.............................................................. 136


How to Specify a Trigger for the Index Plotter Visualization..................................................... 132

References

Index Plotter........................................................................................................................... 341

Dec (Source)

Access This command is not available for ASCII variables. For variables that contain
numerical values and allow conversion, you can access the command via:

Ribbon None
Context menu of Instruments for measurement and calibration - Display
Value(s)
Shortcut key Ctrl+Alt+D
Icon None

Purpose To display a value in dec (source) mode.

638
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Related topics HowTos

How to Display a Value in Converted or Source Mode (ControlDesk Variable


Management )

References

Instrument-Related Commands.............................................................................................. 571

Delete (Instrument)

Access You can access this command via:

Ribbon None
Context menu of § All instruments
§ Instrument Navigator - instrument node
Shortcut key Ctrl+Delete
Icon

Note

This command is not available in operator mode.

Purpose To delete the selected instruments.

Result The selected instrument(s) is/are removed.

Related topics References

Instrument-Related Commands.............................................................................................. 571

Delete (Y-Axis Time Plotter/Index Plotter)

Access Available only if more than one y-axis exists. You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter – y-axis

639
May 2024 ControlDesk Instrument Handling
Reference Information

Shortcut key None


Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To delete the selected y-axis.

Description If you delete a signal that will be left as an unused signal in the measurement
configuration, the Remove Unused Signals dialog opens.

Remove Unused Signals If you delete a signal that is not used by any other resource, such as another
dialog instrument or a recorder, ControlDesk asks you whether you also want to delete
this signal from the measurement signal list.

Use this setting as the default and do not ask again Lets you specify
the selected setting as the default. You can change this default setting in
the ControlDesk Options dialog. Refer to Visualization Page (ControlDesk
Layouting ).

Related topics HowTos

How to Configure the XY Plotter............................................................................................ 260

References

Instrument-Related Commands.............................................................................................. 571

Delete Active Tab

Access You can access this command via:

Ribbon None
Context menu of Table Editor (tab)
Shortcut key None
Icon None

640
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Note

This command is not available in operator mode.

Purpose To delete the currently active tab in the Table Editor.

Result The currently selected tab is deleted.

Related topics Basics

Basics of Handling the Table Editor......................................................................................... 188

Delete Axis Point(s)

Access You can access this command via:

Ribbon None
Context menu of Table Editor
Shortcut key Ctrl+Shift+Delete
Icon None

Note

This command is not available in operator mode.

Purpose To delete the selected axis points.

Related topics Basics

Basics of Handling the Table Editor......................................................................................... 188

HowTos

How to Insert or Delete Axis Points......................................................................................... 209

References

Instrument-Related Commands.............................................................................................. 571

641
May 2024 ControlDesk Instrument Handling
Reference Information

Delete Curve (XY Plotter)

Access You can access this command via:

Ribbon None
Context menu of § Curve symbol
§ Curve (Signal - Delete Curve)
Shortcut key None
Icon None

Note

This command is not available in operator mode.

Purpose To delete the selected curve.

Description If you delete a signal that will be left as an unused signal in the measurement
configuration, the Remove Unused Signals dialog opens.

Remove Unused Signals If you delete a signal that is not used by any other resource, such as another
dialog instrument or a recorder, ControlDesk asks you whether you also want to delete
this signal from the measurement signal list.

Use this setting as the default and do not ask again Lets you specify
the selected setting as the default. You can change this default setting in
the ControlDesk Options dialog. Refer to Visualization Page (ControlDesk
Layouting ).

Related topics HowTos

How to Configure the XY Plotter............................................................................................ 260

References

Instrument-Related Commands.............................................................................................. 571

642
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Delete Disconnected Tabs

Access This command is not available for ASCII variables. For variables that contain
numerical values and allow conversion, you can access it via:

Ribbon None
Context menu of Steering Controller
Shortcut key None
Icon None

Note

This command is not available in operator mode.

Purpose To delete all tabbed pages without a connected controller device from a Steering
Controller.

Description Each new game controller you connect to the host PC is displayed on a new
tabbed page in the Steering Controller. The tabbed page resides in the Steering
Controller even if the game controller is disconnected. The page is used again for
this game controller when it is reconnected.

Related topics Basics

Basics of Handling the Steering Controller.............................................................................. 175

643
May 2024 ControlDesk Instrument Handling
Reference Information

Delete Signal (Time Plotter/Index Plotter)

Access You can access this command via:

Ribbon None
Context menu of § Legend (Signal)
§ Signal symbol
§ Displayed signal (Active signal)
Shortcut key None
Icon None

Note

This command is not available in operator mode.

Purpose To delete the selected signal.

Description If you delete a signal that will be left as an unused signal in the measurement
configuration, the Remove Unused Signals dialog opens.

Remove Unused Signals If you delete a signal that is not used by any other resource, such as another
dialog instrument or a recorder, ControlDesk asks you whether you also want to delete
this signal from the measurement signal list.

Use this setting as the default and do not ask again Lets you specify
the selected setting as the default. You can change this default setting in
the ControlDesk Options dialog. Refer to Visualization Page (ControlDesk
Layouting ).

Related topics Basics

Basics of Handling the Index Plotter........................................................................................ 120


Basics of Handling the Time Plotter......................................................................................... 216

References

Instrument-Related Commands.............................................................................................. 571

644
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Display Format Page

Access This page is part of the ControlDesk Options dialog.

The dialog can be opened via the Options Command (ControlDesk User
Interface Handling ).

Note

This page is not available in the operator mode.

Purpose To select predefined numeric data display formats for the numerical output in the
Variable Array.

Description In ControlDesk, variable values can be displayed in three different source modes:
binary values (Bin), hexadecimal values (Hex), and decimal values (Dec). If
a conversion formula for the variable is defined in the variable description,
ControlDesk can also display the converted decimal or string value (Physical).
§ Binary and hexadecimal source values, as well as converted string values have
a fixed display format that cannot be changed.
§ You can select a predefined display format for source and converted decimal
values.

The following table shows the modes you can define display formats for:

Conversion Mode Numerical Display


Format Format
Definable
Source BIN Binary –
HEX Hexadecimal –
DEC Decimal ✓
Physical Computation formula Decimal ✓
(converted) Tabular conversion Decimal ✓
with interpolation
Tabular conversion Decimal ✓
without interpolation
Verbal conversion String –
Verbal conversion String –
range

645
May 2024 ControlDesk Instrument Handling
Reference Information

Dialog settings Decimal format Lets you select one of the following decimal formats.

Decimal Format Description


Float To display decimal values as floating point
values.
Engineering To display decimal values as exponential values.
The exponent is always an integer multiple of 3.
Exponential To display decimal values as exponential values.
UnsignedInt To display decimal values as unsigned integer
values.
SignedInt To display decimal values as signed integer
values.

Decimal Places Lets you specify a fixed number of fractional digits displayed
after the decimal point. Use the edit field to specify the number of displayed
fractional digits. If a value has more than the selected number of fractional
digits, the last displayed digit is rounded.

Promote source settings Lets you activate the source display settings for
already connected variables. Otherwise (if you click OK or Apply) the settings are
subsequently used for all the variables that are connected to an instrument.

Promote converted settings Lets you activate the converted display settings
for already connected variables. Otherwise (if you click OK or Apply) the settings
are subsequently used for all variables that are connected to an instrument.

Use variable format Lets you specify whether to use the display format that
is defined in the variable description. You can check this display format in the
Properties dialog of the variable (name of the property: format string).

Promote variable settings Activates the display format in the variable


description for already connected variables. Otherwise (if you click OK or Apply)
these settings are subsequently used for all the variables that are connected to
an instrument.

OK Closes the dialog and activates the settings for all the variables that are
subsequently connected to an instrument.

Apply Activates the settings for all the variables that are subsequently
connected to an instrument. The dialog remains open.

Related topics References

Options Command (ControlDesk User Interface Handling )

646
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Display Formats

Access You can access this command via:

Ribbon None
Context menu of Instruments for measurement and calibration - Display
Value(s)
Shortcut key None
Icon None

Note

This command is not available in operator mode.

Purpose To specify the display format for the selected variable.

Result Opens a dialog and lets you specify the properties of the selected item. Refer to
Display Formats Properties on page 465.

Display Output – Clear Output on Execution

Access You can access this command via:

Ribbon None
Context menu of Diagnostics Instrument – output field
Shortcut key None
Icon None

Purpose To specify whether to clear the output field before another communication
object is executed.

Description If disabled, the information in the output field is not cleared but extended by
adding the new information at the end.

You can alternatively specify settings for displaying entries in the output field in
the instrument's properties dialog. Refer to Output Properties on page 507.

647
May 2024 ControlDesk Instrument Handling
Reference Information

Related topics HowTos

How to Configure and Execute Diagnostic Communication Objects (ControlDesk


ECU Diagnostics )

References

Instrument-Related Commands.............................................................................................. 571

Display Output – Display Results Only

Access You can access this command via:

Ribbon None
Context menu of Diagnostics Instrument – output field
Shortcut key None
Icon None

Purpose To specify whether to show only the results in the output field.

You can alternatively specify settings for displaying entries in the output field in
the instrument's properties dialog. Refer to Output Properties on page 507.

Related topics HowTos

How to Configure and Execute Diagnostic Communication Objects (ControlDesk


ECU Diagnostics )

References

Instrument-Related Commands.............................................................................................. 571

Display Values

Access You can access this command via:

Ribbon None
Context menu of Table Editor
Shortcut key None

648
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To select an option for displaying the values in the table cells of the Table Editor's
grid view.

Description You can specify whether the value is displayed in source or converted mode.

Mode Description
Bin (Source) on To display a value in bin (source) mode.
page 594
Dec (Source) on To display a value in dec (source) mode.
page 638
Hex (Source) on To display a value in hex (source) mode.
page 657
Physical (Converted) To display a value in the instrument in
on page 689 physical (converted) mode.

In addition, you have the following options to display values.


§ The current values only
§ The current values and the corresponding reference values
§ The current values and their memory addresses

Related topics Basics

Basics of Handling the Table Editor......................................................................................... 188

References

Instrument-Related Commands.............................................................................................. 571

Edit Bookmarks

Access You can access this command via:

Ribbon Home – Bookmark


Context menu of None
Shortcut key None

649
May 2024 ControlDesk Instrument Handling
Reference Information

Icon

Mouse Double-click a bookmark symbol in a Time Plotter or


in the Measurement Data Pool
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To edit bookmarks.

Description Bookmarks can be edited in the Edit Bookmarks dialog. Refer to Edit
Bookmarks (ControlDesk Measurement and Recording ).

Related topics HowTos

How to Edit a Bookmark (ControlDesk Measurement and Recording )

Enable Move Mode (XY Plotter)

Access You can access this command via:

Ribbon None
Context menu of Axis of an XY Plotter
Shortcut key None
Icon None

Note

This command is not available in operator mode.

Purpose To move the displayed area of the axis via mouse pointer.

Related topics Basics

Zooming and Moving the Chart (XY Plotter)........................................................................... 257

650
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Execute / Execute Cyclically (Diagnostics Instrument)

Access This command is available only if online calibration has been started. You can
access this command via:

Ribbon None
Context menu of None
Shortcut key § Ctrl+E (Execute)
§ Ctrl+L (Execute cyclically)
Icon None
Button In the button area of the Diagnostics Instrument

Purpose To execute a diagnostic communication object.

Description To communicate with an ECU, you select a communication object in the object
tree, optionally configure it via the parameter list, and then execute it.

During execution the background color of the communication object tree is set
to gray and you cannot select another object.

Execute cyclically Diagnostic services can be executed at time intervals.


Activate Execute cyclically and select an interval (in seconds). If you change
a parameter value during execution, the change takes effect with the next
execution cycle.
To stop the repeated execution of a diagnostic service, deactivate Execute
cyclically.
To abort the execution of a communication object, click Cancel (see Cancel
(Diagnostics Instrument) on page 596).

Related topics HowTos

How to Configure and Execute Diagnostic Communication Objects (ControlDesk


ECU Diagnostics )

References

Instrument-Related Commands.............................................................................................. 571

651
May 2024 ControlDesk Instrument Handling
Reference Information

Expand All

Access You can access this command via:

Ribbon None
Context menu of Hierarchy Array on a layout
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To expand all rows in the instrument.

Result All rows in the instrument are expanded.

Expand Subordinate Rows

Access You can access this command via:

Ribbon None
Context menu of Header row of a Hierarchy Array on a layout
Shortcut key Enter
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To expand only the subordinate rows below a header row.

Result All rows subordinate to the selected header row are expanded.

652
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Export (Instrument Selector)

Access You can access this command via:

Ribbon None
Context menu of Instrument category in the Instrument Selector
Shortcut key None
Icon None

Note

This command is not available in operator mode.

Purpose To export an instrument category and its sub categories with the custom
instruments they contain to an instrument library (ILX) file.

Result Opens a Save As dialog to specify the path and file name.

Related topics References

Import (Instrument Selector)................................................................................................... 660


Instrument Selector................................................................................................................ 668

Export Value(s)

Access You can access this command via:

Ribbon None
Context menu of Table Editor – Import/Export
Shortcut key None
Icon None

Purpose To export the values of the variable that is currently displayed in the Table Editor.
ControlDesk always exports and imports all the axes and function values of the
(multidimensional) variable.

653
May 2024 ControlDesk Instrument Handling
Reference Information

Description You can choose between two file formats for exporting table data:
§ Comma-separated values file (CSV)

Note

The Table Editor uses the vertical x-axis orientation by default.


When you export table data to a CSV file, the x-axis orientation in the
CSV file is horizontal.

§ MATLAB file format (MAT)

Related topics Basics

Basics of Handling the Table Editor......................................................................................... 188

HowTos

How to Export and Import Values........................................................................................... 214

References

Instrument-Related Commands.............................................................................................. 571

Filter Editor

Access You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter – legend (column header)
Shortcut key None
Icon None

Note

This command is not available in operator mode.

Purpose To filter the signals that are displayed in a plotter by filter rules.

Description If a filter is active, a status bar at the bottom of the legend shows you the
current settings. You can use this status bar to activate/deactivate the filter, or
edit and clear it. The last defined filters are also available in a list.

654
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Tip

Filter symbols in the column headers can be used for quick filtering. They
are permanently displayed if a column is used for filtering. They appear in
each column header when you move the pointer on it. Click the symbol to
select filter settings: .

Related topics References

Show Find Panel..................................................................................................................... 711

Find Bookmarks

Access You can access this command via:

Ribbon Home – Bookmark


Context menu of None
Shortcut key None
Icon

Tool automation § Layout- and Instrument-Related Interfaces on


page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To find bookmarks.

Description All files, including the current measurement, which contain signals that are used
in a Time Plotter are searched for bookmarks.

For more information, refer to Find Bookmarks (ControlDesk Measurement and


Recording ).

Related topics HowTos

How to Find a Bookmark (ControlDesk Measurement and Recording )

655
May 2024 ControlDesk Instrument Handling
Reference Information

References

Edit Bookmarks...................................................................................................................... 649


Instrument-Related Commands.............................................................................................. 571

Grid View

Access You can access this command via:

Ribbon None
Context menu of Table Editor – Views
Shortcut key None
Icon None

Purpose To configure display options of the grid view.

Description The grid view displays a table with the values of the connected variables.

Menu Entry Shortcut Keys Description


Visible None To show/hide the grid view.
Horizontal X-Axis None To display the x-axis horizontally.
Vertical X-Axis None To display the x-axis vertically.

Related topics Basics

Basics of Handling the Table Editor......................................................................................... 188

Group by This Column

Access You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter – legend (column header)
Shortcut key None
Icon None

656
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Note

This command is not available in operator mode.

Purpose To group the signals in the legend according to the entries of the column.

Description You can create nested groups. If you have selected a column for grouping, you
can unselect it via Ungroup in the context menu of the group by box. If the
group by box is not visible, you can open it via the context menu of the legend
header.

Related topics References

Show Group By Panel............................................................................................................. 712


Ungroup................................................................................................................................. 725

Hex (Source)

Access This command is not available for ASCII variables. For variables that contain
numerical values and allow conversion, you can access it via:

Ribbon None
Context menu of Variable Array/Display/Frame/Numeric Input/Table
Editor - Display Value(s)
Shortcut key Ctrl+Alt+H
Icon None

Purpose To display a value in hex (source) mode.

Description The value is preceded by a 0x, and characters are written in upper case letters.
You can enter the value in a cell in any supported numeric format (Dec, Hex,
or Bin) independently of the current conversion mode selected. A hexadecimal
value must be prefixed by 0x or followed by h, a binary value must be prefixed
by 0b.

657
May 2024 ControlDesk Instrument Handling
Reference Information

Related topics HowTos

How to Display a Value in Converted or Source Mode (ControlDesk Variable


Management )

References

Instrument-Related Commands.............................................................................................. 571

Hide Auto Filter Row

Access This command is available only if the auto filter row above the columns is
displayed. You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter – legend (column header)
Shortcut key None
Icon None

Note

This command is not available in operator mode.

Purpose To close the filter row above the legend columns.

Related topics References

Show Group By Panel............................................................................................................. 712

Hide Expand Button

Access You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter:
§ Splitter
§ Expand button

658
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Shortcut key None


Icon None

Note

This command is not available in operator mode.

Purpose To hide the legend's expand button in the instrument.

Related topics References

Legend Properties (Time Plotter/Index Plotter)......................................................................... 492

Hide Group By Box

Access This command is available only if the group by box is displayed. You can access
this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter – legend (column header)
Shortcut key None
Icon None

Note

This command is not available in operator mode.

Purpose To hide the group by box. The group by box lets you group the signals in the
legend via drag & drop.

Related topics References

Show Group By Panel............................................................................................................. 712

659
May 2024 ControlDesk Instrument Handling
Reference Information

Hide Search Panel

Access You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter – legend (column header)
Shortcut key None
Icon None

Note

This command is not available in operator mode.

Purpose To hide the find panel. The find panel lets you filter the signals to be displayed in
the plotter by a search string.

Related topics References

Filter Editor............................................................................................................................. 654


Show Find Panel..................................................................................................................... 711

Import (Instrument Selector)

Access You can access this command via:

Ribbon None
Context menu of Instrument Selector
Shortcut key None
Icon None

Note

This command is not available in operator mode.

Purpose To import an instrument category with its sub categories from an instrument
library (ILX) file.

Result ControlDesk opens a standard dialog to browse for an instrument library file.

660
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Related topics References

Export (Instrument Selector).................................................................................................... 653


Instrument Selector................................................................................................................ 668

Import Library

Access You can access this command via:

Ribbon None
Context menu of Instrument Selector
Shortcut key None
Icon None

Note

This command is not available in operator mode.

Purpose To import an instrument library from the file system to the Instrument Selector.

Result ControlDesk opens a standard dialog for you to browse to an instrument library
file (ILX) and imports the selected library to the Instrument Selector as a new
instrument category. Multiple selection is possible.

Related topics References

Add Category......................................................................................................................... 585

Import Value(s)

Access You can access this command via:

Ribbon None
Context menu of Table Editor – Import/ Export
Shortcut key None
Icon None

661
May 2024 ControlDesk Instrument Handling
Reference Information

Note

This command is not available in operator mode.

Purpose To import table values.

Description You can choose between two file formats for importing table data:
§ Comma separated values file (CSV)
§ MATLAB file format (MAT)

Note

Imported values are written directly to the connected variable. Values that
make no sense are ignored. For example, if a Table Editor is connected to a
curve, the y-axis values are ignored and the x-axis values are written.

Related topics Basics

Basics of Handling the Table Editor......................................................................................... 188

HowTos

How to Export and Import Values........................................................................................... 214

References

Instrument-Related Commands.............................................................................................. 571

Increments

Access You can access this command via:

Ribbon None
Context menu of Instruments (Variable Array: instrument rows) that are
used for calibration - Adjust Value(s)
Shortcut key None
Icon None

Note

This command is not available in operator mode.

662
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Purpose To specify the increments for the selected variable.

Description You can use the following keyboard shortcuts to apply increment values:

Shortcut Key Description


Page Up/Page Down Lets you apply a small increment.
Ctrl + Page Up/Page Down Lets you apply a big increment.

For instruments with a scale, snapping to tics must be disabled.

Result Opens a dialog and lets you specify the properties of the selected item. Refer to
Increments Properties on page 479.

Indicators - Reset Max

Access You can access this command via:

Ribbon None
Context menu of Scale using instruments – Indicators
Shortcut key Alt+R
Icon None

Purpose To reset the maximum indicator to the current value of the instrument.

Description You can use indicators to visualize the minimum and maximum measured
values in the instrument. The indicators must be enabled via the instrument's
Properties pane, refer to Scale Properties on page 522.

Related topics HowTos

How to Configure the Gauge................................................................................................. 112

References

Instrument-Related Commands.............................................................................................. 571


Scale Properties...................................................................................................................... 522

663
May 2024 ControlDesk Instrument Handling
Reference Information

Indicators - Reset Min

Access You can access this command via:

Ribbon None
Context menu of Scale using instruments – Indicators
Shortcut key R
Icon None

Purpose To reset the minimum indicator to the current value of the instrument.

Description You can use indicators to visualize the minimum and maximum measured
values in the instrument. The indicators must be enabled via the instrument's
Properties pane, refer to Scale Properties on page 522.

Related topics HowTos

How to Configure the Gauge................................................................................................. 112

References

Instrument-Related Commands.............................................................................................. 571


Scale Properties...................................................................................................................... 522

Insert Axis Point(s)

Access You can access this command via:

Ribbon None
Context menu of Table Editor
Shortcut key Ctrl+Shift+Insert
Icon None

Note

This command is not available in operator mode.

Purpose To define new axis points on the x- or y-axis.

664
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Result Opens the Insert Axis Point(s) dialog to enter the new axis point(s).

Insert Axis Point(s) dialog To insert new axis points to an axis.

Current axis points Displays the current number of axis points.

Maximum axis points Displays the maximum number of axis points. It is


defined in the variable description.

Left/Top Lets you specify whether to insert the new axis point(s) on the left
side the selected axis point or above it.

Right/Bottom Lets you specify whether to insert the new axis point(s) on the
right side of the selected axis point or below it.

Count Lets you specify the number of axis points to be inserted.

Step Width Lets you specify the step width of the new axis points.

Related topics Basics

Basics of Handling the Table Editor......................................................................................... 188

HowTos

How to Insert or Delete Axis Points......................................................................................... 209

References

Instrument-Related Commands.............................................................................................. 571

Insert Before

Access This command is available only when you drag a variable to a row in Variable
Array with the right mouse button. You can access this command via:

Ribbon None
Context menu of Variable Array
Shortcut key None
Icon None

Note

This command is not available in operator mode.

665
May 2024 ControlDesk Instrument Handling
Reference Information

Purpose To insert a row with the selected variable before the currently selected row in the
Variable Array.

Result A new row is inserted in the currently selected row in the Variable Array and the
selected variable is connected to the new row.

Related topics References

Append Variable..................................................................................................................... 589


Connect as Additional Write Variable(s).................................................................................. 618
Connect as Main Variable / Connect Variable(s)...................................................................... 619
Connect to New Instrument................................................................................................... 621
Copy Here.............................................................................................................................. 627
Copy Here Without Connections............................................................................................ 628
Move Here............................................................................................................................. 679
Replace Variable..................................................................................................................... 695

Instrument Properties

Access You can access this command via:

Ribbon None
Context menu of § Instruments and layouts
§ Instrument Navigator – instrument node
Shortcut key Alt+Enter
Icon None

Purpose To view and edit the properties of an instrument.

Result Opens the Properties pane and displays the properties of the selected
instrument(s).

Description The Properties pane lets you view and edit the properties of the selected
element. Refer to Properties (Pane) (ControlDesk User Interface Handling ).

666
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Instrument Script

Access You can access this command via:

Ribbon None
Context menu of § All instruments
§ Instrument Navigator – instrument node
Shortcut key None
Icon None

Purpose To extend the functionality of an instrument by adding Python code to it.

Description You can add one Python script to each instrument and assign Python code to
the events of the selected instrument. This allows you to extend the instrument's
functionality via automation.

Result Opens the Code Editor dialog for you to edit the instrument script .

The script is executed automatically each time the instrument is initialized, for
example, when you open the containing layout.

The script is stored together with the instrument. So when you copy the
instrument, the copied instrument contains the same functionality extension as
the original one.

Refer to Code Editor Dialog on page 604.

Related topics Basics

Adding a Python Script to an Instrument or Layout (ControlDesk Customization )

Examples

Example of Adding a Python Script to an Instrument (ControlDesk


Customization )

Videos

Adding Python Code (4:03) in dSPACE Help


Changing the Camera Distance via an Instrument Script (2:24) in dSPACE Help
Stopwatches (4:06) in dSPACE Help

667
May 2024 ControlDesk Instrument Handling
Reference Information

Instrument Selector

Access You can access this command via:

Ribbon Layouting – Instruments – Insert Instrument


Context menu of None
Shortcut key None
Icon None

Purpose To display the Instrument Selector.

Result The Instrument Selector opens.

Description A pane that provides access to ControlDesk's instruments. The instruments can
be placed on a layout via double-click or drag & drop.

Instrument categories The Instrument Selector provides access to the


following instrument categories:
§ Automotive Controls on page 267
§ Avionics Instruments on page 268
§ Browser Samples on page 276
§ Custom Instruments
This is the default category for adding custom instruments.
For instructions on creating custom instruments, refer to How to Make an
Instrument Reusable on page 50.
However, you are not limited to the Custom Instruments category. You can
add your own categories and subcategories to the Instrument Selector and
add default instruments or custom instruments to them.
§ Favorites
You can specify frequently used instruments as favorite instruments: When you
drag a variable on a layout, the favorite instruments are displayed below the
default instrument in the instrument type selection box.

668
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

For instructions, refer to How to Define Default and Favorite Instruments on


page 47.
The Favorites category is the only one that cannot be removed from the
Instrument Selector.
§ FPGA Instruments on page 280
§ Gauges Automotive on page 295
§ LEDs Automotive on page 296
§ Measurement on page 298
§ Standard Instruments on page 300
§ Stopwatches on page 399
To display all the predefined instrument libraries, you can open an additional
pane on the left side of the Instrument Selector. From there you can copy
entire libraries or selected instruments to the Instrument Selector. Refer to
Show Libraries on page 714.

Default instruments You can specify a default instrument for each variable
type. In the Instrument Selector, default instruments are underscored.
For example, you can specify ControlDesk’s Time Plotter as the default
instrument for measurement variables. When you drag a measurement variable
on a layout, the Time Plotter is at the top of the instrument type selection box.

669
May 2024 ControlDesk Instrument Handling
Reference Information

When you place a measurement variable on a layout by using the Visualize


Variables (ControlDesk Layouting ) command, the variable is connected to its
default instrument.

Instruments and the variable types they can visualize The table below
lists all the ControlDesk instruments, and shows for which variable type an
instrument can be specified as the default instrument.

Instrument Variable Types

1)

2)

3)
4) 5) 6) 7) 8) 9) 10) 11)

3-D Viewer12) ✓ ✓ ✓ – – – ✓ ✓ ✓ – –
Airspeed Indicator ✓ – ✓ – – – – – ✓ – –
Altimeter ✓ – ✓ – – – – – ✓ – –
Animated Needle ✓ – ✓ – – – – – ✓ – –
Artificial Horizon ✓ – ✓ – – – – – ✓ – –
Bar ✓ – ✓ – – – – – ✓ – –
Check Button ✓ – ✓ – – – – – ✓ – –
Diagnostics Instrument – – – – – – – – – – –
Display ✓ – ✓ – – – – ✓ ✓ – –
Fault Memory Instrument – – – – – – – – – – –
Frame ✓ – ✓ – – – – ✓ ✓ – –
Gauge ✓ – ✓ – – – – – ✓ – –
Heading Indicator ✓ – ✓ – – – – – ✓ – –
Hierarchy Array ✓ – ✓ – – – – ✓ ✓ – –
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 (single connection) – ✓ – ✓ ✓ ✓ ✓ – – – –
Table Editor (multiple connections) ✓ ✓ ✓ ✓ – – ✓ – ✓ – –
Time Plotter ✓ – ✓ – – – – – ✓ – –
Variable Array ✓ ✓ ✓ – – – ✓ ✓ ✓ (✓)13) (✓)13)
XY Plotter ✓ ✓14) ✓ – – – – – ✓ – –
1) Measurement
2) Measurement array

670
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

3) Value (Float, Int)


4) Common axis
5) Curve
6) Map
7) Value block
8) String
9) Calculated variable
10) Struct
11) Struct array
12) You can connect variables to properties of the 3-D Viewer as well as properties of
items displayed in the 3-D Viewer. For more information, refer to Overview of Possible
Variable Connections on page 67.
13) You can connect the contained variables to different instruments in one step by
customizing the connection assignment. Refer to How to Customize the Connection
Assignment of Variables and Framework Labels to Instruments (ControlDesk
Layouting ).
14)
You can connect one-dimensional measurement arrays to the x‑ and y‑axis if they have
the same length.
For instructions, refer to How to Define Default and Favorite Instruments on
page 47.
For details on the instruments, refer to Instrument Descriptions on page 266.

Positioning the pane By default, the Instrument Selector is located at the


right side of ControlDesk working area.
You can shift panes to any position inside the working area or dock them at the
border of the working area. For instructions on positioning panes, refer to How
to Customize the Screen Arrangement (ControlDesk User Interface Handling ).

Related commands The Instrument Selector provides the following commands:

Command Purpose
Add Category on page 585 To add a new category to the Instrument Selector.
Add to Favorites on page 585 To add the selected instrument to the Favorites category of the Instrument
Selector.
Change Icon on page 599 To change the icon of the currently selected custom instrument.
Export (Instrument Selector) on page 653 To export and save the current configuration of custom instruments as an
instrument library file.
Import (Instrument Selector) on page 660 To import an instrument category with its sub categories from an instrument
library (ILX) file.
Import Library on page 661 To import an instrument library from the file system to the Instrument
Selector.
Remove (Instrument Selector) on page 692 To remove the selected instrument or category.
Rename (Custom Instrument) on page 694 To rename the selected custom instrument.
Set as Default for on page 706 To set the selected instrument as the default instrument for a certain variable
type.
Always Show List on page 589 To show an instrument list when you drag a variable from the
Variables pane to a layout.
Show Libraries on page 714 To open a pane showing the predefined instrument libraries, and to copy
selected instruments or libraries to the Instrument Selector.

671
May 2024 ControlDesk Instrument Handling
Reference Information

Related topics Basics

Basics on Variable Types (ControlDesk Variable Management )

HowTos

How to Configure the Instrument Selector................................................................................ 44


How to Connect Variables and Framework Labels to Instruments (ControlDesk
Layouting )
How to Define Default and Favorite Instruments....................................................................... 47

Instruments Page

Access This page is part of the ControlDesk Options dialog.

The dialog can be opened via the Options Command (ControlDesk User
Interface Handling ).

Note

This page is not available in the operator mode.

Purpose To specify global color, fonts, and header settings for instruments.

Dialog settings Colors – Up Color Lets you select a color for tendency up visualization, for
example, for the tendency up symbols in the Variable Array or the value color
in the Table Editor. Choose one of the predefined colors in the box or use the
Browse button to open the standard Windows Color dialog.
Tendency colors or symbols are used only for parameters that are connected to a
device that has a reference data set.

Tendency Up Symbol Description


The working data set is active and the value of the variable
in the working data set is higher than the value in the
reference data set.

Colors – Down Color Lets you select a color for tendency down visualization,
for example, for the tendency down symbols in the Variable Array or the value
color in the Table Editor. Choose one of the predefined colors in the box or use
the Browse button to open the standard Windows Color dialog.

672
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Tendency colors or symbols are used only for parameters that are connected to a
device that has a reference data set.

Tendency Down Symbol Description


The working data set is active and the value of the variable
in the working data set is lower than the value in the
reference data set.

Colors – Plotter Background Lets you select a color for the background of
a plotter instrument. Choose one of the predefined colors in the box or use the
Browse button to open the standard Windows Color dialog.

Colors – Plotter Foreground Lets you select a color for elements in the
foreground of a plotter instrument, such as labels and tics. Choose one of the
predefined colors in the box or use the Browse button to open the standard
Windows Color dialog.

Fonts – Text Lets you specify the font for text appearing on instruments via a
standard Font dialog. To use the selected global font in an instrument, deactivate
the "Use custom fonts" instrument property.

Fonts – Numeric Output Lets you specify the font for the numerical values
displayed on instruments via a standard Font dialog. To use the selected global
font in an instrument, deactivate the "Use custom fonts" instrument property.

Header – Header Visible Lets you specify whether an instrument header is


displayed. The instrument header contains the instrument's title and, if enabled,
information on the connected variable(s).

Header – Display Variable Info Lets you specify whether information about
the connected variable is displayed in the instrument header of a Variable
Array. The information displayed depends on the variable type. You can use
the instrument properties to define the amount of information displayed by the
Variable Array.

Selection Border – Style Lets you select the selection border style globally
for all instruments.
You can change the setting individually for each instrument via the Selection
Border Style instrument property.

Related topics Basics

Selection Border Style Property............................................................................................... 531

HowTos

How to Configure the Properties of Instruments....................................................................... 51

References

Options Command (ControlDesk User Interface Handling )

673
May 2024 ControlDesk Instrument Handling
Reference Information

Items

Access You can access this command via:

Ribbon None
Context menu of 3-D Viewer
Shortcut key M
Icon None
Button Browse button of the Items property

Purpose To add items and configure their properties.

Result Opens the Items dialog.

Description The Items dialog lets you add or delete items. You can also configure the
properties of every item. Refer to Items and Templates Properties on page 481.

Related topics HowTos

How to Add an Item and Configure the Item Properties ........................................................... 79

References

Items and Templates Properties............................................................................................... 481

Label

Access You can access this command via:

Ribbon None
Context menu of Variable Array (Label cell)
Shortcut key None
Icon None

Note

This command is not available in operator mode.

674
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Purpose To specify the properties of the label cell.

Result Opens a dialog and lets you specify the properties of the selected item. Refer to
Label Properties (Label Cell) on page 488.

Related topics Basics

Basics of Handling the Variable Array...................................................................................... 241

Left

Access You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter:
§ Splitter
§ Expand button
Shortcut key None
Icon None

Note

This command is not available in operator mode.

Purpose To display the plotter legend on the left side of the chart.

Related topics References

Bottom................................................................................................................................... 596
Legend Properties (Time Plotter/Index Plotter)......................................................................... 492
Right...................................................................................................................................... 698
Top......................................................................................................................................... 724

675
May 2024 ControlDesk Instrument Handling
Reference Information

Line Style (Time Plotter/Index Plotter)

Access You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter:
§ Legend (Signal)
§ Signal symbol
§ Curve (Active signal)
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To specify whether to connect the points of a line graphically by a straight line.

Line Style (XY Plotter)

Access You can access this command via:

Ribbon None
Context menu of § Curve symbol
§ Curve (Signal - Line Style)
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

676
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Purpose To specify whether to connect the points of a line graphically by a straight line.

Related topics HowTos

How to Configure the XY Plotter............................................................................................ 260

References

Instrument-Related Commands.............................................................................................. 571

Lock Update

Access You can access this command via:

Ribbon None
Context menu of None
Shortcut key Ctrl+D
Icon None
Button In the button area of the Fault Memory Instrument
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To 'freeze' the instrument display.

Description The fault memory information is automatically synchronized for each logical link.
If you update the information on a logical link in one Fault Memory Instrument
it is also updated in all other Fault Memory Instruments that reference the same
logical link and use the same read service.

If you lock updates for an instrument, the instrument background color is set to
gray. ControlDesk does not show updated fault entries of the available logical
links in this instrument, until you unlock it.

Related topics HowTos

How to Display Fault Memory Entries (ControlDesk ECU Diagnostics )

677
May 2024 ControlDesk Instrument Handling
Reference Information

References

Instrument-Related Commands.............................................................................................. 571

Maximize Column Width

Access You can access this command via:

Ribbon None
Context menu of Variable Array (column header)
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To maximize the width of the selected column.

Result The width of the selected column is maximized. If the width of the instrument
does not allow the selected column to be enlarged, all the instrument columns
are adjusted to fit into the instrument.

Related topics Basics

Basics of Handling the Variable Array...................................................................................... 241

678
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Move Here

Access This command is available only when you drag an instrument to a free area on a
layout with the right mouse button. You can access this command via:

Ribbon None
Context menu of Instrument dragged with right mouse button
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To move an instrument to a new new position on a layout.

Result The instrument is moved to the selected place on the layout.

Related topics References

Append Variable..................................................................................................................... 589


Connect as Additional Write Variable(s).................................................................................. 618
Connect as Main Variable / Connect Variable(s)...................................................................... 619
Connect to New Instrument................................................................................................... 621
Copy Here.............................................................................................................................. 627
Copy Here Without Connections............................................................................................ 628
Insert Before........................................................................................................................... 665
Replace Variable..................................................................................................................... 695

Navigation – Enable/Disable Move Mode (Time Plotter/Index Plotter)

Access You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter – Y-axis
Shortcut key None
Icon None

679
May 2024 ControlDesk Instrument Handling
Reference Information

Tool automation § Layout- and Instrument-Related Interfaces on


page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To enable or disable the move mode. The move mode lets you move the
displayed area of the axis via mouse pointer.

Related topics Basics

Zooming and Moving the Chart (Index Plotter)....................................................................... 124


Zooming and Moving the Chart (Time Plotter)........................................................................ 224

Navigation – Move Mode (Time Plotter/Index Plotter)

Access This command is available after you have zoomed into the chart. You can access
this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter – chart
Shortcut key M
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To move the displayed area of the chart via the pointer.

680
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Related topics Basics

Zooming and Moving the Chart (Index Plotter)....................................................................... 124


Zooming and Moving the Chart (Time Plotter)........................................................................ 224

Navigation – Rescale (Time Plotter/Index Plotter)

Access This command is available after you have zoomed into the chart. You can access
this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter:
§ X-axis or y-axis (rescales the selected axis)
§ Chart of an Index Plotter (rescales all axes)
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To rescale one or all axes.

Navigation – Zoom Mode (Time Plotter/Index Plotter)

Access This command is available after you have zoomed into the chart. You can access
this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter – chart
Shortcut key Z
Icon None

681
May 2024 ControlDesk Instrument Handling
Reference Information

Tool automation § Layout- and Instrument-Related Interfaces on


page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To zoom the displayed area of the chart via the pointer.

Related topics Basics

Zooming and Moving the Chart (Index Plotter)....................................................................... 124


Zooming and Moving the Chart (Time Plotter)........................................................................ 224

On/Off Values / On Value

Access You can access this command via:

Ribbon None
Context menu of Variable Array (button cell)
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To specify the properties of the following buttons: Check button, On/Off button,
Push button.

Result Opens a dialog and lets you specify the properties of the selected item. Refer to
Button Cell Properties (Value Cell – Button) on page 438.

682
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Related topics Basics

Basics of Handling the Variable Array...................................................................................... 241

Optimize

Access You can access this command via:

Ribbon None
Context menu of § Hierarchy Array
§ Variable Array
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To let ControlDesk specify the optimum width and/or heigth of the selected
instrument.

Result Depending on your selection, ControlDesk optimizes one of the following:


§ Width of the selected instrument
§ Height of the selected instrument
§ Width and height of the selected instrument

ControlDesk optimizes the width and/or height according to the width and/or
height of the instrument rows and columns.

Related topics Basics

Basics of Handling the Hierarchy Array.................................................................................... 114


Basics of Handling the Variable Array...................................................................................... 241

683
May 2024 ControlDesk Instrument Handling
Reference Information

Overlay Element - Delete

Access You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter – overlay element
Shortcut key None
Icon

Tool automation § Layout- and Instrument-Related Interfaces on


page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To delete the selected overlay element.

Related topics Basics

Basics of Handling the Index Plotter........................................................................................ 120


Basics of Handling the Time Plotter......................................................................................... 216

References

Overlay Elements Properties (Time Plotter/Index Plotter).......................................................... 508

Overlay Element - Move Down

Access You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter – overlay element
Shortcut key None
Icon

684
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Tool automation § Layout- and Instrument-Related Interfaces on


page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To move the selected overlay element in the instrument one layer down.

Result The selected overlay element is covered by other overlay elements or signals on
higher layers.

Related topics Basics

Basics of Handling the Index Plotter........................................................................................ 120


Basics of Handling the Time Plotter......................................................................................... 216

References

Overlay Elements Properties (Time Plotter/Index Plotter).......................................................... 508

Overlay Element - Move to Bottom

Access You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter – overlay element
Shortcut key None
Icon

Tool automation § Layout- and Instrument-Related Interfaces on


page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

685
May 2024 ControlDesk Instrument Handling
Reference Information

Purpose To move the selected overlay element to the bottom layer of the instrument.

Result The selected overlay element is covered by all other overlay elements or signals if
they overlap.

Related topics Basics

Basics of Handling the Index Plotter........................................................................................ 120


Basics of Handling the Time Plotter......................................................................................... 216

References

Overlay Elements Properties (Time Plotter/Index Plotter).......................................................... 508

Overlay Element - Move to Top

Access You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter – overlay element
Shortcut key None
Icon

Tool automation § Layout- and Instrument-Related Interfaces on


page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To move the selected overlay element to the top layer of the instrument.

Result The selected overlay element covers other overlay elements or signals if they
overlap.

686
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Related topics Basics

Basics of Handling the Index Plotter........................................................................................ 120


Basics of Handling the Time Plotter......................................................................................... 216

References

Overlay Elements Properties (Time Plotter/Index Plotter).......................................................... 508

Overlay Element - Move Up

Access You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter – overlay element
Shortcut key None
Icon

Tool automation § Layout- and Instrument-Related Interfaces on


page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To move the selected overlay element in the instrument one layer up.

Result The selected overlay element covers other overlay elements or signals on lower
layers.

Related topics Basics

Basics of Handling the Index Plotter........................................................................................ 120


Basics of Handling the Time Plotter......................................................................................... 216

References

Overlay Elements Properties (Time Plotter/Index Plotter).......................................................... 508

687
May 2024 ControlDesk Instrument Handling
Reference Information

Parameter – Assign Default Value(s) to Selected Service

Access You can access this command via:

Ribbon None
Context menu of § Diagnostics Instrument – parameter list
§ Diagnostics Instrument – request PDU field
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To assign default values to the parameters of a communication object.

Related topics HowTos

How to Configure and Execute Diagnostic Communication Objects (ControlDesk


ECU Diagnostics )

References

Instrument-Related Commands.............................................................................................. 571

Paste Value(s)

Access You can access this command via:

Ribbon None
Context menu of Table Editor
Shortcut key Shift+Ctrl+V
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

688
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Purpose To insert copied values into the table.

Description The copied values are pasted into the table starting at the Edit Point. If the table
contains fewer cells than values to be inserted, the values for which there is no
cell available are ignored. You do not get a message about values being ignored.

Related topics Basics

Basics of Handling the Table Editor......................................................................................... 188

Physical (Converted)

Access This command is not available for ASCII variables. For variables that contain
numerical values and allow conversion, you can access it via:

Ribbon None
Context menu of Instruments for measurement and calibration - Display
Value(s)
Shortcut key Ctrl+Alt+C
Icon None

Purpose To display a value in the instrument in physical (converted) mode.

Description Converted values have the Floating Point data type. The conversion formula or
conversion table is defined in the variable description. If it is not defined you
cannot use the converted mode.

The following kinds of conversion are supported.

Variable Source Value Converted


Value
COMPU_TAB_INTP (variable using integer double
tabular conversion with
interpolation)
COMPU_TAB_NOINTP (variable integer double
using tabular conversion without
interpolation)

689
May 2024 ControlDesk Instrument Handling
Reference Information

Variable Source Value Converted


Value
COMPU_VTAB (variable using verbal integer string
conversion)
COMPU_VTAB_RANGE (variable double string
using verbal conversion range) interval

Tip

You can also define custom conversion formulas in the Properties dialog of
an instrument. Refer to Custom Value Conversion Properties on page 461.

Note

The Bitfield Editor in Variable Array displays variables only in source mode,
even if Physical is selected.

Related topics HowTos

How to Display a Value in Converted or Source Mode (ControlDesk Variable


Management )

References

Instrument-Related Commands.............................................................................................. 571

Point Style (Time Plotter/Index Plotter)

Access You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter:
§ Legend (Signal)
§ Signal symbol
§ Curve (Active signal)
Shortcut key § P: Next point style
§ Ctrl+P: Previous point style
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

690
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Note

This command is not available in operator mode.

Purpose To select the style of the signal's points.

Description If you select user defined, you can define an image for the point style via the
Point style image property in the Properties list. Refer to Axes and Signals
Properties (Time Plotter/Index Plotter) on page 422.

Point Style (XY Plotter)

Access You can access this command via:

Ribbon None
Context menu of § Curve symbol
§ Curve (Signal - Point Style)
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To select the style of the curve's points.

Related topics HowTos

How to Configure the XY Plotter............................................................................................ 260

References

Instrument-Related Commands.............................................................................................. 571

691
May 2024 ControlDesk Instrument Handling
Reference Information

Preview Signal Visible

Access You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter – scroll bar – scroll box
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To show or hide the measured signal as a preview in the scroll bar.

Description In a Time Plotter or an Index Plotter, a scroll bar can be displayed via the
Properties pane. Refer to Scroll Bar Properties (Time Plotter/Index Plotter) on
page 527.

Related topics Basics

Zooming and Moving the Chart (Index Plotter)....................................................................... 124


Zooming and Moving the Chart (Time Plotter)........................................................................ 224

References

Scroll Bar Properties (Time Plotter/Index Plotter)...................................................................... 527

Remove (Instrument Selector)

Access You can access this command via:

Ribbon None
Context menu of Instrument Selector - instrument or category
Shortcut key Delete
Icon None

692
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Tool automation § Layout- and Instrument-Related Interfaces on


page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To remove the selected instrument or category.

Result The selected instrument or category is removed from the Instrument Selector.

Note

You cannot remove the Favorites category.

Related topics References

Instrument Selector................................................................................................................ 668

Remove This Column

Access You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter - legend (column header)
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

693
May 2024 ControlDesk Instrument Handling
Reference Information

Purpose To remove the selected column from the legend.

Result The selected column is removed from the legend. If you want to add it again,
open the column chooser via the context menu of the legend header.

Related topics Basics

Basics of Handling the Time Plotter......................................................................................... 216

Rename (Custom Instrument)

Access You can access this command via:

Ribbon None
Context menu of Custom instrument (Instrument Selector)
Shortcut key F2
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To rename the selected custom instrument.

Description When you create a custom instrument, it is placed in the Instrument Selector
and in the Custom Instruments library. A custom instrument can only be
renamed in the Instrument Selector.

Result An edit field opens to let you type the name of the selected custom instrument.

694
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Related topics HowTos

How to Make an Instrument Reusable...................................................................................... 50

Replace Variable

Access This command is available only when you drag a variable from the
Variables pane to a selected row in the Variable Array with the right mouse
button. You can access this command via:

Ribbon None
Context menu of Variable Array
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To replace the connected main variable of the selected row in the Variable Array.

Result The existing variable assigned to the selected row in the Variable Array is
replaced by the new variable.

Related topics References

Append Variable..................................................................................................................... 589


Connect as Additional Write Variable(s).................................................................................. 618
Connect as Main Variable / Connect Variable(s)...................................................................... 619
Connect to New Instrument................................................................................................... 621
Copy Here.............................................................................................................................. 627
Copy Here Without Connections............................................................................................ 628
Insert Before........................................................................................................................... 665
Move Here............................................................................................................................. 679

695
May 2024 ControlDesk Instrument Handling
Reference Information

Rescale

Access This command is available after you have zoomed into the chart of a Time
Plotter/Index Plotter/XY Plotter. You can access this command via:

Ribbon None
Context menu of § X-axis or y-axis (rescales the selected axis)
§ Chart (rescales both axes)
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To rescale one or both axes of a plot.

Description The axes are rescaled to display the currently available curves.

Related topics Basics

Zooming and Moving the Chart (Index Plotter)....................................................................... 124


Zooming and Moving the Chart (Time Plotter)........................................................................ 224
Zooming and Moving the Chart (XY Plotter)........................................................................... 257

Rescale Data Axis

Access You can access this command via:

Ribbon None
Context menu of Table Editor – Views
Shortcut key None
Icon None

696
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Tool automation § Layout- and Instrument-Related Interfaces on


page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To adjust the size of the 2-D view to the range of the data axis values.

Related topics Basics

Basics of Handling the Table Editor......................................................................................... 188

HowTos

How to Set Up a View of the Table Editor............................................................................... 211

Resize to Image

Access You can access this command via:

Ribbon None
Context menu of Instrument with enabled background image
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To adjust the instrument size to the size of the background image.

Related topics References

Background Properties............................................................................................................ 433


Instrument-Related Commands.............................................................................................. 571
Picture Properties.................................................................................................................... 512

697
May 2024 ControlDesk Instrument Handling
Reference Information

Right

Access You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter:
§ Splitter
§ Expand button
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To display the plotter legend on the right side of the chart.

Related topics References

Bottom................................................................................................................................... 596
Left........................................................................................................................................ 675
Legend Properties (Time Plotter/Index Plotter)......................................................................... 492
Top......................................................................................................................................... 724

Row - Cells

Access You can access this command via:

Ribbon None
Context menu of Hierarchy Array - Row
Hierarchy Array - Header Row
Shortcut key -
Icon None

Note

This command is not available in operator mode.

698
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Purpose To open the Cells dialog.

Related topics References

Hierarchy Array....................................................................................................................... 336

Row - Delete

Access You can access this command via:

Ribbon None
Context menu of Variable Array - Row
Hierarchy Array - Row
Hierarchy Array - Header Row
Shortcut key Delete
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To delete the selected row.

Tip

If a deleted variable is no longer used on any opened layout, you can


specify to automatically remove the signal from the measurement signal
list. Activate Automatically remove unused signals from measurement
signal list on the Visualization (refer to Visualization Page (ControlDesk
Layouting )) page of the ControlDesk Options dialog.

Related topics Basics

Basics of Handling the Variable Array...................................................................................... 241

699
May 2024 ControlDesk Instrument Handling
Reference Information

Row - Highlighted - Color

Access You can access this command via:

Ribbon None
Context menu of Variable Array - Row
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To specify the highlight color of the currently selected row.

Related topics Basics

Basics of Handling the Variable Array...................................................................................... 241

Row - Highlighted - Enabled

Access You can access this command via:

Ribbon None
Context menu of Variable Array - Row
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

700
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Purpose To highlight the currently selected row.

Related topics Basics

Basics of Handling the Variable Array...................................................................................... 241

Save Displayed Data as New Measurement

Access You can access this command via:

Ribbon None
Context menu of Time Plotter
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To save the data that is displayed in a Time Plotter as a new measurement.

Description You can save the data that is displayed in a Time Plotter in a new measurement
file. You can specify the time interval to be saved.

The data is saved to a measurement data file using the storage settings
defined via the properties of the Acquisition element on the Measurement
Configuration pane. Refer to Acquisition Properties (ControlDesk Measurement
and Recording ).

Generate Measurement Lets you configure the time interval for saving the displayed Time Plotter data.
dialog
Start time Lets you specify the start time of the saved data. The start time of
the displayed data is the default value.

Stop time Lets you specify the stop time of the saved data. The stop time of
the displayed data is the default value.

701
May 2024 ControlDesk Instrument Handling
Reference Information

Related topics Basics

Basics on the Measurement Buffer (ControlDesk Measurement and Recording )

HowTos

How to Save Time Plotter Data as a New Measurement (ControlDesk Measurement


and Recording )

Save to File

Access You can access this command via:

Ribbon None
Context menu of None
Shortcut key Ctrl+F
Icon None
Button In the button area of the Fault Memory Instrument
and the Diagnostics Instrument
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To save the content of the instrument to a file.

Description The Fault Memory Instrument not only saves the displayed data, but information
on its whole content: all logical links, all DTCs, and (if activated) all environment
data. It supports ASCII text files and XML files.

The Diagnostics Instrument saves all the information contained in the output
field to an ASCII text file.

Related topics HowTos

How to Configure and Execute Diagnostic Communication Objects (ControlDesk


ECU Diagnostics )
How to Display Fault Memory Entries (ControlDesk ECU Diagnostics )

702
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

References

Instrument-Related Commands.............................................................................................. 571

Scale Range

Access You can access this command via:

Ribbon None
Context menu of Variable Array (Bar/Slider cell)
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To specify the scale range properties of the Bar or Slider Cell.

Result Opens a dialog and lets you specify the properties of the selected item. Refer to
Scale Range Properties (Value Cell – Bar/Slider) on page 526.

Related topics Basics

Basics of Handling the Variable Array...................................................................................... 241

Scaling Mode

Access You can access this command via:

Ribbon None
Context menu of Axis of an XY Plotter/Time Plotter/Index Plotter
Shortcut key None

703
May 2024 ControlDesk Instrument Handling
Reference Information

Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To select the scaling mode of the axis.

Description The following scaling modes are available.

Scaling Description
Mode
Floating The axis range always shows the current range of the displayed
data. It can grow and shrink during measurement.
Extended The axis range always shows the current range of the displayed
(Default data. It can only grow during measurement. To rescale a signal
mode) axis to display the currently available curves, double‑click it.
Fixed The dimensions of the signal axis are set to the values of
the Minimum and Maximum axis properties. These limits are
kept independently of data curves.

Fixed from current axis Lets you specify the Minimum and Maximum axis
properties according to the currently visible axis area and sets the scaling mode
to Fixed.

Related topics HowTos

How to Configure the Index Plotter........................................................................................ 128


How to Configure the XY Plotter............................................................................................ 260

References

Instrument-Related Commands.............................................................................................. 571

704
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Select in Bus Navigator

Access You can access this command via:

Ribbon None
Context menu of Hierarchy Array on page 336 on a layout
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To select the associated element in the Bus Navigator.

Result The element for which the instrument was generated is highlighted in the Bus
Navigator.

Related topics References

Bus Navigator (ControlDesk Bus Navigator )


Hierarchy Array....................................................................................................................... 336

Select in Instrument Navigator

Access You can access this command via:

Ribbon None
Context menu of Instrument on a layout
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To change the focus to the associated instrument node in the Instrument
Navigator.

705
May 2024 ControlDesk Instrument Handling
Reference Information

Result The instrument node gets the focus. If you now press a shortcut key, for
example, it belongs to the instrument node in the Instrument Navigator and
not to the instrument on the layout.

Related topics References

Instrument Navigator (ControlDesk Layouting )

Set as Default for

Access You can access this command via:

Ribbon None
Context menu of Instrument Selector - selected instrument
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To set the selected instrument as the default instrument for a certain variable
type.

Result The instrument is set as the default instrument for the selected variable type.

Description When you drag the variable from the Variables pane to a layout, the default
instrument of this variable is displayed at the top of a list or automatically
placed on the layout if the list is disabled. In the Instrument Selector, default
instruments are underscored.

You can select a variable type from a list that shows the variable types that are
available for the selected instrument.

706
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

The following list shows all the variable types:


§ String
§ Axis Points
§ Curve
§ Map
§ Measurement
§ Measurement Array
§ Parameter - Int
§ Parameter - Float
§ Value Block
§ Calculated

Related topics HowTos

How to Define Default and Favorite Instruments....................................................................... 47

Show Auto Filter Row

Access You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter – legend (column header)
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To display a filter row above the legend columns.

Description You can enter a filter string in each edit field above a column.

If a filter is active, a status bar at the bottom of the legend shows you the
current settings. You can use this status bar to activate/deactivate the filter, or
edit and clear it. The last defined filters are also available in a list.

707
May 2024 ControlDesk Instrument Handling
Reference Information

Tip

Filter symbols in the column headers can be used for quick filtering. They
are permanently displayed if a column is used for filtering. They appear in
each column header when you move the pointer on it. Click the symbol to
select filter settings: .

Related topics References

Show Group By Panel............................................................................................................. 712

Show Bookmarks

Access You can access this command via:

Ribbon None
Context menu of Time Plotter - chart
Shortcut key B
Icon

Tool automation § Layout- and Instrument-Related Interfaces on


page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To show or hide bookmark symbols at the x-axis.

Description During a measurement or recording you can set bookmarks manually or let
ControlDesk set them automatically to mark certain measurement points.

708
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Related topics Basics

Basics on Bookmarks (ControlDesk Measurement and Recording )

Show Column Headers (Time Plotter/Index Plotter)

Access You can access this command via:

Ribbon None
Context menu of Legend
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To show/hide the column headers in the legend.

Description The legend displays the signals that are connected to the instrument. Via the
context menu of the column headers, you can sort, group, and filter the signals.

Related topics References

Filter Editor............................................................................................................................. 654


Group by This Column............................................................................................................ 656
Show Find Panel..................................................................................................................... 711
Show Group By Panel............................................................................................................. 712
Show Legend......................................................................................................................... 713
Sort Ascending....................................................................................................................... 718
Sort Descending..................................................................................................................... 719

709
May 2024 ControlDesk Instrument Handling
Reference Information

Show Current/Reference

Access You can access this command via:

Ribbon None
Context menu of Instruments for measurement and calibration - Display
Value(s), working data set is activated
Shortcut key § Ctrl+U for current value
§ Ctrl+F for reference value
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To specify whether to display the current value or the reference value in the
current instrument.

Description This command only changes the display of the value, it does not switch the data
set. It enables you to show the parameter’s value of the reference data set (for
platforms: initial value read from the SDF file) although the working data set is
activated.

Tip

You can use the reference value also in connection with platforms, although
platforms do not a have a reference data set at all. In this case the initial
values that were read from the SDF file are displayed as reference values.
A prerequisite for this is, that initial values are available: As of dSPACE
Release 4.1, you can configure the RTI build process to include initial
parameter values in the SDF file to be generated. Refer to the RTI
variable description file options category on the Code Generation Dialog
(Model Configuration Parameters Dialogs) (RTI and RTI-MP Implementation
Reference ).

Result If you select the reference value for display, the edit field of the row is set to
read-only with a gray background color. The symbol in the row is changed to .

Related topics References

Instrument-Related Commands.............................................................................................. 571

710
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Show Expand Button

Access You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter – Splitter
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To display the legend's expand button in the instrument.

Related topics References

Legend Properties (Time Plotter/Index Plotter)......................................................................... 492

Show Find Panel

Access You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter – legend (column header)
Shortcut key Ctrl+F
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

711
May 2024 ControlDesk Instrument Handling
Reference Information

Purpose To filter the signals to be displayed in the plotter by a search string.

Description The find panel lets you enter the search string the signals are filtered by. The
filter is cleared when you close the search panel.

The search string can contain the following inline parameters:

Parameter Description
+<string> The search string must be contained in the result (logical AND)
-<string> The search string must not be contained in the result (logical NOT)
<column>: To search in a specific column

Related topics References

Filter Editor............................................................................................................................. 654


Hide Search Panel................................................................................................................... 660

Show Group By Panel

Access You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter – legend (column header)
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To group the signals in the legend via drag & drop.

712
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Related topics References

Group by This Column............................................................................................................ 656


Hide Group By Box................................................................................................................. 659

Show Legend

Access You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter - chart
Shortcut key L
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To show/hide the legend.

Description The legend displays the signals that are connected to the instrument. Via the
context menu of the column headers, you can sort, group, and filter the signals.

Related topics References

Filter Editor............................................................................................................................. 654


Group by This Column............................................................................................................ 656
Show Column Headers (Time Plotter/Index Plotter)................................................................. 709
Show Find Panel..................................................................................................................... 711
Show Group By Panel............................................................................................................. 712
Sort Ascending....................................................................................................................... 718
Sort Descending..................................................................................................................... 719

713
May 2024 ControlDesk Instrument Handling
Reference Information

Show Libraries

Access You can access this command via:

Ribbon None
Context menu of Instrument Selector
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To open a pane showing the predefined instrument libraries, and to copy
selected instruments or libraries to the Instrument Selector.

Description ControlDesk opens a pane listing the predefined instrument libraries. You can
select an instrument or an instrument library.

Copy Copies the selected instrument or instrument library to the Instrument


Selector.

Close Closes the pane.

Result The selected instrument or instrument library is copied to the Instrument


Selector.

Related topics HowTos

How to Configure the Instrument Selector................................................................................ 44

References

Add Category......................................................................................................................... 585

714
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Show Scroll Bar (Time Plotter/Index Plotter)

Access You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter - chart
Shortcut key O
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To show or hide the instrument's scroll bar.

Description Via the instrument's scrollbar, you can navigate through the measurement and
change the zoom settings. Refer to Scroll Bar Properties (Time Plotter/Index
Plotter) on page 527.

Related topics Basics

Zooming and Moving the Chart (Index Plotter)....................................................................... 124


Zooming and Moving the Chart (Time Plotter)........................................................................ 224

References

Scroll Bar Properties (Time Plotter/Index Plotter)...................................................................... 527

Show Toolbar

Access You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter - chart
Shortcut key T
Icon None

715
May 2024 ControlDesk Instrument Handling
Reference Information

Tool automation § Layout- and Instrument-Related Interfaces on


page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To show/hide the instrument's toolbar.

Description Via the instrument's toolbar, you can easily change frequently used DAQ (display
trigger) and data cursor settings.

Refer to:
§ DAQ toolbar
§ Cursor toolbar

DAQ toolbar The DAQ type of the instrument's toolbar lets you change display trigger
settings.

Button Description Refer to


To show/hide the toolbar. Toolbar Properties (Time Plotter/Index
Plotter) on page 559
To select the toolbar type. Toolbar Properties (Time Plotter/Index
Plotter) on page 559
To set the DAQ mode to Continuous mode. Enables the DAQ Properties (Time Plotter/Index
untriggered display of plotter data. Plotter) on page 462
To set the DAQ mode to Triggered mode. Enables the DAQ Properties (Time Plotter/Index
triggered display of plotter data. Plotter) on page 462
To adjust the plotter display to the selected signal by DAQ – Leading Raster (Time
switching to the associated leading raster. Plotter/Index Plotter) on page 634
To select the leading raster. DAQ – Leading Raster (Time
Plotter/Index Plotter) on page 634
To select Interactive Trigger for trigger setting. DAQ - Trigger (Time Plotter/Index
ControlDesk displays marks on the x-and y-axis. You can Plotter) on page 637
move these marks with the pointer to set the trigger settings
in the measurement configuration interactively.
To select Autoset Trigger for trigger setting. ControlDesk DAQ - Trigger (Time Plotter/Index
analyses the signal to set the trigger settings in the Plotter) on page 637
measurement configuration automatically.
To increment the number of displayed periods if Autoset Advanced Settings Properties (Time
Trigger is activated for a periodic signal. Plotter/Index Plotter) on page 416
To decrement the number of displayed periods if Autoset Advanced Settings Properties (Time
Trigger is activated for a periodic signal. Plotter/Index Plotter) on page 416
To set the drawing mode to On new capture. The signal DAQ Properties (Time Plotter/Index
trace is drawn when a triggered capture is complete. If Plotter) on page 462

716
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Button Description Refer to


the data values arrive at random intervals, you can use this
mode to prevent the displayed signal from flickering.
To set the drawing mode to On new value. The signal trace DAQ Properties (Time Plotter/Index
is drawn each time a new data value is available. Plotter) on page 462
To display plotter DAQ information in the instrument. DAQ Properties (Time Plotter/Index
Plotter) on page 462

Cursor toolbar The Cursor type of the instrument's toolbar lets you change data cursor settings.

Button Description Corresponding Property/Command


To show/hide the toolbar. Toolbar Properties (Time Plotter/Index Plotter) on page 559

To select the toolbar type. Toolbar Properties (Time Plotter/Index Plotter) on page 559

To select the single mode for the data cursor. Displays Data Cursor Properties (Time Plotter/Index Plotter) on
one cursor to specify a position in the chart. The x- and page 463
y-values of the cursor position are displayed at the cursor
info position.
To select the delta mode for the data cursor. Displays two Data Cursor Properties (Time Plotter/Index Plotter) on
cursors to specify two independent positions in the chart. page 463
The x- and y-values of the two cursor positions and the
differences between them are displayed at the cursor info
position.
To move the data cursor on the data points of the signal Data Cursor Properties (Time Plotter/Index Plotter) on
next to the pointer (stick on curve). page 463
To keep the cursor(s) always visible inside the chart area, for Data Cursor Properties (Time Plotter/Index Plotter) on
example, when you move a chart or zoom into it. page 463
To zoom into the interval of a delta cursor. –

To display the cursor information at a fixed position in the Data Cursor Properties (Time Plotter/Index Plotter) on
chart. page 463
To display the cursor information next to the cursor. Data Cursor Properties (Time Plotter/Index Plotter) on
page 463
To display the cursor information at the axes. Data Cursor Properties (Time Plotter/Index Plotter) on
page 463
To set the data cursor type to Point. Data Cursor Properties (Time Plotter/Index Plotter) on
page 463
To set the data cursor type to X-line. Data Cursor Properties (Time Plotter/Index Plotter) on
page 463
To set the data cursor type to Y-line. Data Cursor Properties (Time Plotter/Index Plotter) on
page 463
To show or hide the time cursor . Time Cursor Properties on page 558

To activate a tooltip that displays the signal value at the Time Cursor Properties on page 558
position of the time cursor.
To activate a tooltip that displays the position of the time Time Cursor Properties on page 558
cursor (in seconds).

717
May 2024 ControlDesk Instrument Handling
Reference Information

Button Description Corresponding Property/Command


To move the time cursor to the data points of the signal next Time Cursor Properties on page 558
to the mouse pointer.
To keep the cursor inside the chart area. For example, when Time Cursor Properties on page 558
you move a chart or zoom into it.
To undo the most recent zooming or moving action. § Zooming and Moving the Chart (Time Plotter) on
page 224
§ Zooming and Moving the Chart (Index Plotter) on
page 124
To redo the most recent undone zooming or moving action. § Zooming and Moving the Chart (Time Plotter) on
page 224
§ Zooming and Moving the Chart (Index Plotter) on
page 124
To activate or deactivate the zoom. § Zooming and Moving the Chart (Time Plotter) on
page 224
§ Zooming and Moving the Chart (Index Plotter) on
page 124
To display bookmark symbols at the x-axis. View Properties (Time Plotter/Index Plotter) on page 566

Related topics Basics

Zooming and Moving the Chart (Index Plotter)....................................................................... 124


Zooming and Moving the Chart (Time Plotter)........................................................................ 224

References

Toolbar Properties (Time Plotter/Index Plotter)......................................................................... 559

Sort Ascending

Access You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter – legend (column header)
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

718
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Note

This command is not available in operator mode.

Purpose To sort the rows of the legend alphabetically in ascending order by the selected
column.

Related topics References

Clear Sorting.......................................................................................................................... 603


Sort Descending..................................................................................................................... 719

Sort Descending

Access You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter – legend (column header)
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To sort the rows of the legend alphabetically in descending order by the selected
column.

Related topics References

Clear Sorting.......................................................................................................................... 603


Sort Ascending....................................................................................................................... 718

719
May 2024 ControlDesk Instrument Handling
Reference Information

Sort Items

Access You can access this command via:

Ribbon None
Context menu of Selection Box
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To sort the list displayed in the selection box.

Description You can change the sort order of the text strings displayed in the list.

The following options are available:

Menu Entry Description


Ascending by Text The list is sorted by text strings alphabetically in
ascending order.
Descending by Text The list is sorted by text strings alphabetically in
descending order.
Ascending by Value The list is sorted by the numerical parameter values
related to the text strings in ascending order.
Descending by Value The list is sorted by the numerical parameter values
related to the text strings in descending order.

Related topics References

Instrument-Related Commands.............................................................................................. 571

720
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Switch to Move Mode / Switch to Zoom Mode (XY Plotter)

Access You can access this command via:

Ribbon None
Context menu of Chart of an XY Plotter
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To zoom or move the displayed area of the chart via mouse pointer.

Related topics Basics

Zooming and Moving the Chart (XY Plotter)........................................................................... 257

Switch Variable (XY Plotter)

Access You can access this command via:

Ribbon None
Context menu of § Curve symbol
§ Curve (Signal - Switch Variable)
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

721
May 2024 ControlDesk Instrument Handling
Reference Information

Purpose To interchange the variables that are connected to the x- and y-axis.

Tip

Check the axis labels after you have switched the variables. They are not
switched together with the variables.

Related topics HowTos

How to Configure the XY Plotter............................................................................................ 260

References

Instrument-Related Commands.............................................................................................. 571

Tic Format

Access You can access this command via:

Ribbon None
Context menu of Axis (Time Plotter/Index Plotter/XY Plotter)
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To select the format used to label the axis tics.

722
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Description The following options are available.

Tic Format Description


Standard The values on the axis are shown without an
(Default format) exponent.
Exponential The values on the axis are shown in exponential
format.
Scientific/Engineering The values on the axis are shown in exponential
format. The exponent is always an integer multiple
of 3.
SIPrefix (Available only for the Time Plotter and the Index
Plotter) The values on the x-axis are shown with
prefixes for the SI units: milli (m), kilo (k), etc.
Hours (Available only for the Time Plotter) The values on the
x-axis are shown as hours in the format hh:mm:ss.

Related topics HowTos

How to Configure the XY Plotter............................................................................................ 260

References

Instrument-Related Commands.............................................................................................. 571

Toggle Bits

Access This command is available only if the selected variable is displayed in source
format. You can access this command via:

Ribbon None
Context menu of Instruments for calibration - Adjust Value(s)
Shortcut key Ctrl+Shift+T
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To toggle selected bits of the connected variable.

723
May 2024 ControlDesk Instrument Handling
Reference Information

Result Opens the Enter Bits to Be Toggled dialog.

Enter Bits to Be Toggled Lets you enter the numbers of the bits that you want to toggle.
dialog

Related topics References

Adjust Value(s)........................................................................................................................ 586

Top

Access You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter:
§ Splitter
§ Expand button
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To display the plotter legend above the chart.

Related topics References

Bottom................................................................................................................................... 596
Left........................................................................................................................................ 675
Legend Properties (Time Plotter/Index Plotter)......................................................................... 492
Right...................................................................................................................................... 698

724
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Tree Mode - Hierarchical View

Access You can access this command via:

Ribbon None
Context menu of Diagnostics Instrument – communication object tree
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To toggle between hierarchy view and flat view of the diagnostic communication
objects.

Result Opens or closes a tree view, which displays the diagnostic communication
objects hierarchically.

Description In the hierarchical view, additional nodes are displayed for functional classes
of diagnostic services, for ECU jobs, and for control primitives. The diagnostic
services are arranged under the functional class they are assigned to.

In the flat view, the communication objects are arranged directly under the
logical link they belong to.

Related topics References

Tree View Properties............................................................................................................... 560

Ungroup

Access This command is available only for columns that are used for grouping. You can
access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter – legend (column header)
Shortcut key None
Icon None

725
May 2024 ControlDesk Instrument Handling
Reference Information

Tool automation § Layout- and Instrument-Related Interfaces on


page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To revoke grouping the signals according to the entries of the selected column.

Description If you have created nested groups, you must ungroup each group separately.

Related topics References

Group by This Column............................................................................................................ 656


Show Group By Panel............................................................................................................. 712

Update All LLs

Access This command is available only if online calibration has been started. You can
access this command via:

Ribbon None
Context menu of None
Shortcut key Ctrl+U
Icon None
Button In the button area of the Fault Memory Instrument
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To update the information on all the logical links in the Fault Memory
Instrument(s).

Description For all the logical links in the instrument, ControlDesk executes the selected
service for reading the ECU's fault memory. If the Read DTC Data checkbox is

726
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

selected, it also executes the service for reading the environment data for each
DTC.

The Configure Read Services dialog displays or lets you select the service
to be used for reading the environment data. You can reach the dialog via
the Properties pane of the Fault Memory Instrument. Refer to Logical Links
Properties on page 493.

Related topics HowTos

How to Display Fault Memory Entries (ControlDesk ECU Diagnostics )

References

Instrument-Related Commands.............................................................................................. 571

Update Selected LLs

Access This command is available only if online calibration has been started. You can
access this command via:

Ribbon None
Context menu of None
Shortcut key Ctrl+E
Icon None
Button In the button area of the Fault Memory Instrument
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To update the information on the selected logical links in the Fault Memory
Instrument(s).

Description For the currently selected logical links, ControlDesk executes the selected service
for reading the ECU's fault memory. If the Read DTC Data checkbox is selected,
it also executes the service for reading the environment data for each DTC.

The Configure Read Services dialog displays or lets you select the service
to be used for reading the environment data. You can reach the dialog via
the Properties pane of the Fault Memory Instrument. Refer to Logical Links
Properties on page 493.

727
May 2024 ControlDesk Instrument Handling
Reference Information

Related topics HowTos

How to Display Fault Memory Entries (ControlDesk ECU Diagnostics )

References

Instrument-Related Commands.............................................................................................. 571

Variable - Converted (Plotter Instruments)

Access You can access this command via:

Ribbon None
Context menu of Time Plotter, Index Plotter:
§ Legend (selected signal(s))
§ Signal symbol (variable)
§ Displayed signal (active signal)
XY Plotter:
§ Curve symbol (x‑variable, y‑variable)
§ Displayed curve (signal - x‑variable or y‑variable)
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To display the signal values in converted (physical) mode.

Related topics Basics

Basics of Handling the Index Plotter........................................................................................ 120


Basics of Handling the Time Plotter......................................................................................... 216
Basics of Handling the XY Plotter............................................................................................ 253

728
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Variable - Delete Variable (Time Plotter/Index Plotter)

Access You can access this command via:

Ribbon None
Context menu of § Legend (Selected Signal(s))
§ Signal symbol (Variable)
§ Displayed signal (Active signal)
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To delete the selected variable leaving an unconnected signal.

Related topics References

Delete Signal (Time Plotter/Index Plotter)................................................................................. 644

Variable - Source (Time Plotter/Index Plotter)

Access You can access this command via:

Ribbon None
Context menu of Time Plotter, Index Plotter:
§ Legend (Selected Signal(s))
§ Signal symbol (Variable)
§ Displayed signal (Active signal)
XY Plotter:
§ Curve symbol (x‑variable, y‑variable)
§ Displayed curve (signal - x‑variable or y‑variable)
Shortcut key None
Icon None

729
May 2024 ControlDesk Instrument Handling
Reference Information

Tool automation § Layout- and Instrument-Related Interfaces on


page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To display the signal values in source (dec) mode.

Related topics Basics

Basics of Handling the Index Plotter........................................................................................ 120


Basics of Handling the Time Plotter......................................................................................... 216
Basics of Handling the XY Plotter............................................................................................ 253

Variable(s) - Add

Access You can access this command via:

Ribbon None
Context menu of § All Instruments
§ Instrument Navigator – instrument nodes or
connection nodes
Shortcut key Ctrl++
Icon

Tool automation § Layout- and Instrument-Related Interfaces on


page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To connect a variable to an instrument.

730
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Description Opens the Select Variable dialog for you to select a variable and connect it to
the instrument. Multiple selection is possible by pressing Ctrl or Shift when
clicking a variable. The variable list in the dialog is filtered and shows only
variables that can be connected to the instrument.

Tip

You can select more than one instrument on a layout or in the Instrument
Navigator to connect the same variables to the selected instruments in one
step.

Result The selected variables are connected to the instrument.

Related topics References

Variables - Cut........................................................................................................................ 733


Variables - Delete.................................................................................................................... 734
Variables - Paste/Paste Variables.............................................................................................. 735

Variable(s) - Select in Variables/Mappings Pane

Access You can access this command via:

Ribbon None
Context menu of § Instruments with connection(s) to variables or
framework labels
§ Variable in the Measurement Configuration
Time Plotter, Index Plotter:
§ Legend (Selected Signal(s))
§ Signal symbol (Variable)
§ Displayed signal (Active signal)
XY Plotter:
§ Curve symbol (x‑variable, y‑variable)
§ Displayed curve (signal - x‑variable or y‑variable)
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

731
May 2024 ControlDesk Instrument Handling
Reference Information

Purpose To select and highlight variables in the Variables pane, or framework labels in the
Mappings pane.

Result In the variable list of the Variables pane, the variable connected to the
instrument is highlighted. In the group view of the Variables pane, the node
in which the variable is located is selected.

In the Mappings pane, the framework label connected to the instrument is


highlighted.

Variable(s) Properties

Access You can access this command via:

Ribbon None
Context menu of All instruments except Diagnostics Instrument and
Fault Memory Instrument
Shortcut key Ctrl+I
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To show the Properties dialog of a connected variable.

Description For more information on the dialog, refer to Variable Properties / Properties
(ControlDesk Variable Management ).

Related topics References

Instrument-Related Commands.............................................................................................. 571

732
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Variables – Copy to Instrument

Access You can access this command via:

Ribbon None
Context menu of Instruments with variable connections
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To add a new instrument to the layout and copy the selected variables to it.

Result The variable(s) are copied and connected to the new instrument.

Variables - Cut

Access You can access this command via:

Ribbon None
Context menu of § Variables in an instrument
§ Instrument Navigator - variable item
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Purpose To cut the selected variables in the current instrument.

Result The selected variable is removed and placed in the Clipboard.

733
May 2024 ControlDesk Instrument Handling
Reference Information

Related topics References

Instrument-Related Commands.............................................................................................. 571


Variables - Delete.................................................................................................................... 734
Variables - Paste/Paste Variables.............................................................................................. 735

Variables - Delete

Access You can access this command via:

Ribbon None
Context menu of § Variables in an instrument
§ Instrument Navigator - variable item
Shortcut key Delete1)
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )
1) If the last variable has been removed, Delete removes the empty instrument.

Note

This command is not available in operator mode.

Purpose To delete the selected variables.

Result The selected variable(s) is/are removed from the current instrument.

Tip

If the last variable has been removed, the Delete shortcut key removes the
empty instrument. You can remove an instrument with all its variables in
one step by pressing Ctrl+Delete.

Related topics References

Variables - Cut........................................................................................................................ 733


Variables - Delete.................................................................................................................... 734
Variables - Paste/Paste Variables.............................................................................................. 735

734
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Variables - Paste/Paste Variables

Access You can access this command via:

Ribbon None
Context menu of § All instruments (Variable(s) – Paste)
§ Layout (Paste Variables)
§ Layout Navigator - Layout
§ Instrument Navigator - Variable item
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To paste variables from the Clipboard to an instrument.

Description If you paste the variable(s) to on an empty area of a layout, ControlDesk opens a
list from which you can select a new instrument for the variable(s).

Related topics References

Instrument-Related Commands.............................................................................................. 571


Variables - Cut........................................................................................................................ 733
Variables - Delete.................................................................................................................... 734

Y-Axes View – Horizontal Stacked

Access You can access this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter – x-axis or y-axis
Shortcut key S (to switch between the axis views)
Icon None

735
May 2024 ControlDesk Instrument Handling
Reference Information

Tool automation § Layout- and Instrument-Related Interfaces on


page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To arrange the y-axes horizontally one below the other.

Description The following table shows the y-axis views you can select.

Y-Axes View Description


Vertical fixed The y-axes are aligned vertically. All y-axes are visible. You
cannot change the axis width with the pointer. Use Y-Axes
View - Settings to set the width to optimum, maximum, or
fixed size.
Vertical scroll The y-axes are aligned vertically in a scroll area. One (default)
or more y-axes are visible. You can change the axis width
with the pointer.
Horizontal The y-axes are arranged horizontally one below the other.
stacked

Related topics Basics

Y-Axes View – Vertical Scroll................................................................................................... 738

References

Y-Axes View – Vertical Fixed.................................................................................................... 738

Y-Axes View – Rescale All Axes

Access This command is available after you have zoomed into the chart. You can access
this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter – x-axis or y-axis
Shortcut key None
Icon None

736
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Tool automation § Layout- and Instrument-Related Interfaces on


page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To rescale all y-axes in one step.

Y-Axes View – Settings

Access This command is available after you have zoomed into the chart. You can access
this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter – x-axis or y-axis
Shortcut key None
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To set the width of the y-axes to optimum, maximum, or fixed size.

Description The following table shows the y-axis view settings you can select.

Size Description
Optimal The width of the y-axes area is set automatically. All y-axes are
completely visible. Each y-axis has its optimum width.
Maximum The width of the y-axes area is set automatically. All y-axes are
completely visible. The width of the widest y-axis is set for each.
Fixed The width of the y-axes area is set to the value in the Axis width
edit field.

737
May 2024 ControlDesk Instrument Handling
Reference Information

Y-Axes View – Vertical Fixed

Access This command is available after you have zoomed into the chart. You can access
this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter – x-axis or y-axis
Shortcut key S (to switch between the axis views)
Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To align the y-axes vertically. All y-axes are visible.

Description The following table shows the y-axis views you can select.

Y-Axes View Description


Vertical fixed The y-axes are aligned vertically. All y-axes are visible. You
cannot change the axis width with the pointer. Use Y-Axes
View - Settings to set the width to optimum, maximum, or
fixed size.
Vertical scroll The y-axes are aligned vertically in a scroll area. One (default)
or more y-axes are visible. You can change the axis width
with the pointer.
Horizontal The y-axes are arranged horizontally one below the other.
stacked

Y-Axes View – Vertical Scroll

Access This command is available after you have zoomed into the chart. You can access
this command via:

Ribbon None
Context menu of Time Plotter/Index Plotter – x-axis or y-axis
Shortcut key S (to switch between the axis views)

738
ControlDesk Instrument Handling May 2024
Instrument-Related Commands

Icon None
Tool automation § Layout- and Instrument-Related Interfaces on
page 754
§ Bus Instrument-Related Interfaces (ControlDesk
Automation )

Note

This command is not available in operator mode.

Purpose To align the y-axes vertically in a scroll area.

Description The following table shows the y-axis views you can select.

Y-Axes View Description


Vertical fixed The y-axes are aligned vertically. All y-axes are visible. You
cannot change the axis width with the pointer. Use Y-Axes
View - Settings to set the width to optimum, maximum, or
fixed size.
Vertical scroll The y-axes are aligned vertically in a scroll area. One (default)
or more y-axes are visible. You can change the axis width
with the pointer.
Horizontal The y-axes are arranged horizontally one below the other.
stacked

739
May 2024 ControlDesk Instrument Handling
Reference Information

740
ControlDesk Instrument Handling May 2024
Automation

Automation

Where to go from here Information in this section

Programming ControlDesk Automation................................................. 742

Layout and Instrument Handling............................................................ 754

741
May 2024 ControlDesk Instrument Handling
Automation

Programming ControlDesk Automation


Where to go from here Information in this section

Automating Visualization of Variables on Layouts.................................. 742


Visualizing variables means placing variables on layouts so that they are
displayed by instruments.

Automating Parameter Calibration........................................................ 751


In ControlDesk, you can calibrate parameters by changing their values
in instruments on a layout. ControlDesk offers specialized instruments
for editing variable types, for example, the Variable Array for scalar
parameters and the Table Editor for nonscalar parameters.

Information in other sections

Tool Automation Demos (ControlDesk Automation )


Demonstrate how to automate ControlDesk and use ControlDesk
events .

Automating Visualization of Variables on Layouts

Introduction Visualizing variables means placing variables on layouts so that they are displayed
by instruments.

Unless otherwise indicated, the program listings below consist of excerpts from
the LayoutAndInstrumentHandling.py demo script.

Creating a new layout The following listing shows how to create a new layout.

class MainDemoController(object):
(...)
def AddAndRemoveLayout(self):
(...)
# Add new layout.
newLayout = self.ControlDeskApplication.LayoutManagement.Layouts.Add("NewTestLayout")

Accessing and removing an The following listing shows how to access an existing layout and then to remove
existing layout it from the project and from the hard disk. The parameter of the Remove method
specifies whether the layout is removed from the project and from the hard disk
(True) or from the project only (False).

742
ControlDesk Instrument Handling May 2024
Programming ControlDesk Automation

class MainDemoController(object):
(...)
def AddAndRemoveLayout(self):
(...)
LAYOUTNAME = "Layout1.lay"
(...)
# Check if the layout with the name "Layout1.lay" exists.
if self.ControlDeskApplication.LayoutManagement.Layouts.Contains(LAYOUTNAME):
# Get layout with the name "Layout1.lay".
layout1 = self.ControlDeskApplication.LayoutManagement.Layouts.Item(LAYOUTNAME)
# Remove layout.
layout1.Remove(True)

Accessing a layout You can access layouts in different ways:

Accessing an open layout You can access a currently open layout via
the Layouts / IXaLayouts <<Collection>> collection property of the
LayoutManagement / IXaLayoutManagement <<Interface>> interface.
Closed layouts are not included in the Layouts / IXaLayouts
<<Collection>> collection.

Accessing a closed layout You can access a currently closed layout via
the Files / IXaFiles <<Collection>> collection property of the following
interfaces:
§ LayoutManagement / IXaLayoutManagement <<Interface>>
§ ActiveExperiment / IXaActiveExperiment <<Interface>>

Note

When you use the Files / IXaFiles <<Collection>> collection


property of the ActiveExperiment / IXaActiveExperiment
<<Interface>> interface, you have access to all the files of the currently
active experiment, not only to layouts.

Configuring the properties of The following listing shows how to specify the name, grid width, grid height,
a layout and background color of a layout.

# Import: Function RGB


# Converts single values for red, green, blue to corresponding color value.
from DemoUtilities import RGB
(...)
class MainDemoController(object):
(...)
def AddAndRemoveLayout(self):
(...)
# Add new layout.
newLayout = self.ControlDeskApplication.LayoutManagement.Layouts.Add("NewTestLayout")
(...)
# Rename layout.
newLayout.Rename("RenamedTestLayout")
# Change grid width and height.
newLayout.Grid.Width *= 3
newLayout.Grid.Height *= 3
# Change background color.
newLayout.BackgroundColor = RGB(0,255,255)

743
May 2024 ControlDesk Instrument Handling
Automation

Exporting/Importing a layout The following listing shows how to export the active layout to
ExportLayout.lax and how to import it.
# Import: The os module is used for path concatenations.
import os
# Create new root path in the temporary system folder.
PROJECTROOTPATH = os.path.join(tempfile.gettempdir(), "DemoRoot")
(...)
# Path of the exported layout.
EXPORTPATH = os.path.join(PROJECTROOTPATH,"ExportLayout.lax")
(...)
class MainDemoController(object):
(...)
def ExportAndImportLayout(self):
(...)
# Export active layout.
self.ControlDeskApplication.LayoutManagement.ActiveLayout.Export(EXPORTPATH)
(...)
# Import layout.
self.ControlDeskApplication.LayoutManagement.Layouts.Import(EXPORTPATH)

Placing instruments on a The following listing shows how to place three instruments on a layout and then
layout align them.

# Name of the Knob instrument.


KNOBINSTRUMENTNAME = "TestKnob"
# Name of the Variable Array instrument.
VARIABLE_ARRAY_INSTRUMENT_NAME = "TestVariableArray"
# Name of the Time Plotter instrument.
PLOTTERINSTRUMENTNAME = "TestPlotter"
(...)

744
ControlDesk Instrument Handling May 2024
Programming ControlDesk Automation

class MainDemoController(object):
(...)
def AddLayoutWithInstruments(self):
(...)
# Add Time Plotter instrument.
plotterInstrument = self.ControlDeskApplication.LayoutManagement.ActiveLayout.\
Instruments.Add("Time Plotter", PLOTTERINSTRUMENTNAME,
0, 0, 300, 200)
# Add Knob instrument.
knobInstrument = self.ControlDeskApplication.LayoutManagement.ActiveLayout.\
Instruments.Add("Knob", KNOBINSTRUMENTNAME,
310, 100, 200, 200)
# Add Variable Array instrument.
arrayInstrument = self.ControlDeskApplication.LayoutManagement.ActiveLayout.\
Instruments.Add("Variable Array", VARIABLE_ARRAY_INSTRUMENT_NAME,
580, 200, 300, 200)
(...)
# Select all three instruments.
plotterInstrument.SelectMulti()
knobInstrument.SelectMulti()
arrayInstrument.SelectMulti()
# Get instrument selection.
instrumentSelection = self.ControlDeskApplication.LayoutManagement.ActiveLayout.Selection
# Align instruments to bottom.
instrumentSelection.AlignTop()
# Center instrument selection.
instrumentSelection.CenterInViewHorizontally()
(...)
# Deselect all instruments.
instrumentSelection.DeselectAll()

Accessing and configuring The following listing shows how to access a Time Plotter and change its position
instruments on the layout.

PLOTTERINSTRUMENTNAME = "TestPlotter"
(...)
class MainDemoController(object):
(...)
def AddLayoutWithInstruments(self):
(...)
# Get the Time Plotter instrument and increment its width.
if self.ControlDeskApplication.LayoutManagement.ActiveLayout.Instruments.Contains(PLOTTERINSTRUMENTNAME):
plotterInstrument = self.ControlDeskApplication.LayoutManagement.ActiveLayout.Instruments.\
Item(PLOTTERINSTRUMENTNAME)
# Increment the Plotter instrument's width.
plotterInstrument.Position.Width += 300
# Move the Plotter to the left.
plotterInstrument.Position.X = 0

Tip

You can get the path of an instrument by dragging it from a layout to the
Internal Interpreter or to the Python Editor.

Adding custom data to an instrument You can add custom data to


an instrument. This allows you to add layout generation information to the
instrument, such as connection strings, for example.

745
May 2024 ControlDesk Instrument Handling
Automation

The Python listing below shows how to specify custom data:


instrument = Application.LayoutManagement.ActiveLayout.Instruments.Item(0)
instrument.CustomData = "My custom data"

Note

Keep in mind, however, that custom data is available only via automation,
not via ControlDesk's Properties pane when you select the instrument.

Clearing item collections of instruments You can clear item collections of


instruments such as captions and bands via the Clear() method. This allows
you, for example, to easily clear the states of a Selection Box as shown in the
following Python listing:
instrument = Application.LayoutManagement.ActiveLayout.Instruments.Item(0)
instrument.Items.Clear()

The following list shows where the Clear() method is available:


§ instrument.Captions.Clear()
§ ScaleUsing.Bands.Clear()
§ SelectionBox.Items.Clear()
§ ButtonInstruments.Buttons.Clear()
§ MultiStateDisplay.States.Clear()
§ MultiSwitch.States.Clear()
§ VariableArray.Rows.Clear()

Getting the name of a layout The automation interface of instruments provides the LayoutName property
on which an instrument is that provides the name of the layout on which the instrument is located. The
located LayoutName property is helpful, for example, in instrument scripts and event
handlers .

Connecting variables to The following listing shows how to connect variables to instruments. In the
instruments listing, the strings for the assignment of the variable connection are stored
in the VARIABLECONNECTIONPATHTEMPLATES list. To connect a variable to an
instrument, a platform/device with a variable description (or a measurement data
file) must be available in the active experiment. Variable connections are shown
for a Knob , a Variable Array , a Time Plotter , and a Table Editor .

VARIABLECONNECTIONPATHTEMPLATES syntax To connect a variable to


an instrument, you have to define a specific connection string.
For each connection to be established, you have to specify:
§ The platform/device name (or measurement data file name)
§ The (optional) raster name in brackets, followed by ://
§ The unique name of the variable
Examples:
§ VARIABLECONNECTIONPATHTEMPLATES = ["XCP()://DummyOmega"]
§ VARIABLECONNECTIONPATHTEMPLATES = ["XCP(OnChange)://f_Ki_1"]
§ VARIABLECONNECTIONPATHTEMPLATES = ["Platform(5ms)://Model
Root/Scope/In2"]

746
ControlDesk Instrument Handling May 2024
Programming ControlDesk Automation

Tip

You can get the path or URI of a variable by selecting Copy in the variable's
context menu in the Variables pane or Measurement Data Pool, and
pasting it to the Internal Interpreter or to the Python Editor. Depending
on the Variable serialization format selected on the Variables (refer to
Variables Page (ControlDesk Variable Management )) page, either the
connection path or the uniform resource identifier is copied.

# Get the root path


SCRIPTPATH = os.path.abspath(os.path.curdir)
if len(sys.argv) > 0:
SCRIPTPATH = os.path.dirname(sys.argv[0])
# Define CalDemo .a2l image path.
A2LIMAGEPATH = os.path.abspath(os.path.join(SCRIPTPATH, "..\..\..\CalDemo\CalDemo.a2l"))
# Define CalDemo .mot image path.
MOTIMAGEPATH = os.path.abspath(os.path.join(SCRIPTPATH, "..\..\..\CalDemo\CalDemo.mot"))
# A list with string representations of some variables used in this demo.
VARIABLECONNECTIONPATHTEMPLATES = ["%s()://DummyOmega", "%s(5ms)://control_out",
"%s(OnChange)://f_Ki_1", "%s()://abs_sinp2_cosp2_table",
"%s()://airmass_x_table", "%s()://MeasureVector_MASK_0x0100[2]"]
# Name of the Knob instrument.
KNOBINSTRUMENTNAME = "TestKnob"
# Name of the Variable Array instrument.
VARIABLE_ARRAY_INSTRUMENT_NAME = "TestVariableArray"
# Name of the Time Plotter instrument.
PLOTTERINSTRUMENTNAME = "TestPlotter"
# Name of the Table Editor instrument
TABLEDITORINSTRUMENTNAME = "TestTableEditor"
(...)
class MainDemoController(object):
(...)
def AddPlatformAndConnectVariableToKnobInstrument(self):
(...)
# Get Knob instrument.
knobInstrument = self.ControlDeskApplication.LayoutManagement.ActiveLayout.Instruments.Item(
KNOBINSTRUMENTNAME)
(...)
# Add XCP on CAN platform.
self.DemoPlatform = self.ControlDeskApplication.ActiveExperiment.Platform.Add(
self.Enums.PlatformType.XCPonCAN)
# Add variable description.
self.DemoPlatform.VariableDescriptions.AddWithImage(A2LIMAGEPATH, MOTIMAGEPATH)
# Connect variable via string assignment with syntax:
# [MeasurementDataFileName:]DeviceName([RasterName])://UniqueName
knobInstrument.MainVariable = VARIABLECONNECTIONPATHTEMPLATES[0] % self.DemoPlatform.Name
(...)
def EditVariableArray(self):
(...)
# Get Variable Array instrument.
variableArrayInst = self.ControlDeskApplication.LayoutManagement.ActiveLayout.Instruments.Item(
VARIABLE_ARRAY_INSTRUMENT_NAME)
(...)
# Add new rows associated with variables.
for index in range(3):
# Add new row
newRow = variableArrayInst.Rows.Add()
# Add variable to row.
newRow.MainVariable = VARIABLECONNECTIONPATHTEMPLATES[index] % self.DemoPlatform.Name
(...)

747
May 2024 ControlDesk Instrument Handling
Automation

def EditPlotter(self):
(...)
# Get Time Plotter instrument.
plotterInstrument = self.ControlDeskApplication.LayoutManagement.ActiveLayout.Instruments.Item(
PLOTTERINSTRUMENTNAME)
(...)
# Configure x-axis.
xAxis = plotterInstrument.ActivePlot.ActiveXAxis
(...)
# Configure y-axes.
yAxes = plotterInstrument.ActivePlot.YAxes
# Add new y-axis.
newYAxis = yAxes.Add()
(...)
# Add new signal to axis.
newSignal = newYAxis.Signals.Add()
# Connect variable to signal.
newSignal.MainVariable = VARIABLECONNECTIONPATHTEMPLATES[2] % self.DemoPlatform.Name
(...)
def CreateAndEditTableEditor(self):
(...)
# Add Table Editor instrument.
tableEditorInstrument = self.ControlDeskApplication.LayoutManagement.ActiveLayout.Instruments.Add(
"Table Editor", TABLEDITORINSTRUMENTNAME, 0, 0, 500, 500)
(...)
# Add sub instrument.
tableEditorInstrument.SubInstruments.Add()
# Create the event sink for the table editor.
tableEditorInstrument = DispatchWithEvents(tableEditorInstrument, TableEditorInstrumentEvents)
# Connect common axis variable to active sub instrument
tableEditorInstrument.ActiveSubInstrument.MainVariable = VARIABLECONNECTIONPATHTEMPLATES[4] %
self.DemoPlatform.Name

Grouping layouts The following listing shows how to group layouts, including the following steps:
1. Multiple layouts are added to the Experiment Layouts folder.
2. Multiple groups are added to the Experiment Layouts folder.
3. One sub group is added to the first group.
4. One layout is added to each group.
5. One layout is added to the sub group.
class MainDemoController(object):
(...)
def GroupLayouts(self):
(...)
# Add some layouts to the experiment.
for index in range(1, 7):
# Add new layout.
newLayout = self.ControlDeskApplication.LayoutManagement.Layouts.Add("NewTestLayout_%d" % index)
newLayout.Window.State = self.Enums.WindowState.Maximized
(...)
# Get default folder for layouts.
defaultFolderLayouts = self.ControlDeskApplication.ActiveExperiment.GetDefaultFolder(self.Enums.FileType.Layout);
for index in range(1, 5):
# Add new group.
defaultFolderLayouts.Groups.Add("Group_%d" % index)

748
ControlDesk Instrument Handling May 2024
Programming ControlDesk Automation

# Add a sub group to the first group.


subGroup = defaultFolderLayouts.Groups[0].Groups.Add("SubGroup")
(...)
# Get the first three layout files.
layoutFiles = []
for currentLayoutFile in defaultFolderLayouts.Files:
layoutFiles.append(currentLayoutFile)
# Insert one layout in all groups.
for index in range(3):
# Insert the layout files.
defaultFolderLayouts.Groups[index].Files.Insert(layoutFiles[index])
# Insert last layout to the sub group.
subGroup.Files.Insert(layoutFiles[len(layoutFiles) - 1])
(...)

3-D Viewer: Adding roads via The automation interface of the 3-D Viewer lets you import complete road
MAT file import networks from MAT files created with the ModelDesk Road Generator.

Refer to Adding Roads via MAT File Import on page 82.

Table Editor: Configuring The 2D view of the Table Editor lets you display table values as a 2‑dimensional
properties of the 2D view chart.

Configuring properties of the 2D view depends on the type of the connected


variable.

Map If a map is connected, use the Projection / IViProjection


<<Interface>> interface to configure properties of the 2D view.
The following illustration shows the abs_sinp2_cosp2_table map visualized in
subinstrument 0 of a Table Editor as an example. The 2D view is visible.

The following lines show you how to make the 2D view invisible:
TE = Application.LayoutManagement.ActiveLayout.Instruments.Item(0)
TE.SubInstruments[0].Views.Projection.Visible = False

749
May 2024 ControlDesk Instrument Handling
Automation

The following illustration shows the result:

For more information on the related automation interface, refer to Projection /


IViProjection <<Interface>> (ControlDesk Automation ).

Curve If a curve is connected, use the GraphicalView2D /


IViGraphicalView2D <<Interface>> interface to configure properties of the
2D view.
The following illustration shows the throttle2percent_z_table curve
visualized in subinstrument 1 of a Table Editor as an example. The 2D view is
visible.

The following line shows you how to make the 2D view invisible:
TE.SubInstruments[1].Views.GraphicalView2D.Visible = False

750
ControlDesk Instrument Handling May 2024
Programming ControlDesk Automation

The following illustration shows the result:

For more information on the related automation interface, refer


to GraphicalView2D / IViGraphicalView2D <<Interface>> (ControlDesk
Automation ).

Related topics Basics

Basics of Connecting Variables and Framework Labels to Instruments (ControlDesk


Layouting )
Tool Automation Demos (ControlDesk Automation )

Automating Parameter Calibration

Introduction In ControlDesk, you can calibrate parameters by changing their values in


instruments on a layout. ControlDesk offers specialized instruments for editing
variable types, for example, the Variable Array for scalar parameters and the
Table Editor for nonscalar parameters.

Activating working and The following listing shows how to make the third data set of the active
reference data sets experiment the working data and the second data set the reference data set
(excerpts from the DataSetHandling.py demo script).

751
May 2024 ControlDesk Instrument Handling
Automation

class MainDemoController(object):
(...)
def Initialize(self):
(...)
# Start ControlDesk.
self.ControlDeskApplication = Dispatch("ControlDeskNG.Application")
# Define Enums object.
self.Enums = Enums(self.ControlDeskApplication)
# Add XCP on CAN platform.
self.DemoPlatform = self.ControlDeskApplication.ActiveExperiment.Platforms.Add(
self.Enums.PlatformType.XCPonCAN)
(...)
def DefineWorkingAndReferenceSet(self):
# Get the last created data set
newDataSet = self.DemoPlatform.ActiveVariableDescription.DataSets.Item(2)
# Set data set to working set
newDataSet.MakeWorking()
# Activate the working data set.
newDataSet.Activate()
# Set the second data set as the reference data set.
self.DemoPlatform.ActiveVariableDescription.DataSets.Item(1).MakeReference()

Changing parameter values The following listing shows how to change the values of parameters
that are connected to a Variable Array (excerpts from the
LayoutAndInstrumentHandling.py demo script).
# Get the root path
SCRIPTPATH = os.path.abspath(os.path.curdir)
if len(sys.argv) > 0:
SCRIPTPATH = os.path.dirname(sys.argv[0])
# Define CalDemo .a2l image path.
A2LIMAGEPATH = os.path.abspath(os.path.join(SCRIPTPATH, "..\..\..\CalDemo\CalDemo.a2l"))
# Define CalDemo .mot image path.
MOTIMAGEPATH = os.path.abspath(os.path.join(SCRIPTPATH, "..\..\..\CalDemo\CalDemo.mot"))
(...)
# A list with string representations of some variables used in this demo.
VARIABLECONNECTIONSTRINGS = ["%s()://DummyOmega", "%s(5ms)://control_out",
"%s(OnChange)://f_Ki_1", "%s()://abs_sinp2_cosp2_table",
"%s()://airmass_x_table", "%s()://MeasureVector_MASK_0x0100[2]"]
(...)
# Name of the Variable Array instrument.
VARIABLE_ARRAY_INSTRUMENT_NAME = "TestVariableArray"
(...)
class MainDemoController(object):
(...)
def AddPlatformAndConnectVariableToKnobInstrument(self):
(...)
# Add XCP on CAN platform.
self.DemoPlatform = self.ControlDeskApplication.ActiveExperiment.
Platforms.Add(self.Enums.PlatformType.XCPonCAN)
self.DemoPlatform.VariableDescriptions.AddWithImage(A2LIMAGEPATH, MOTIMAGEPATH)
(...)

752
ControlDesk Instrument Handling May 2024
Programming ControlDesk Automation

def EditVariableArray(self):
# Get Variable Array instrument.
variableArrayInstrument = self.ControlDeskApplication.LayoutManagement.ActiveLayout.Instruments.Item(
VARIABLE_ARRAY_INSTRUMENT_NAME)
(...)
# Add new rows associated with variables.
for index in range(3):
# Add new row
newRow = variableArrayInstrument.Rows.Add()
# Add variable to row.
newRow.MainVariable = VARIABLECONNECTIONSTRINGS[index] % self.DemoPlatform.Name
# Set value.
newRow.Value = 3.0 * index

Note

When you try to set the value of a parameter outside the parameter's
value range, these changes are discarded without notice. However, you can
implement a notification yourself by reading back the parameter value from
the instrument.
This applies only when you calibrate a parameter by changing its value in an
instrument on a layout. It does not apply when you use the direct variable
access feature (refer to Automating Direct Variable Access (ControlDesk
Automation )).
For information on parameter range limits, refer to Handling Parameter
Range Limits (ControlDesk Calibration and Data Set Management ).

Related topics Basics

Basics of Calibrating Parameters (ControlDesk Calibration and Data Set


Management )
Tool Automation Demos (ControlDesk Automation )

753
May 2024 ControlDesk Instrument Handling
Automation

Layout and Instrument Handling

Layout- and Instrument-Related Interfaces

Introduction The main tasks of ControlDesk’s layout and instrument handling are to create
and open layouts, create and configure instruments and connect variables to the
layouts.

Description The Layout Management object implements the IXaLayoutManagement


interface. The properties of this interface can be used to manipulate the settings
of the Layout Management.

A layout document implements the IXaLayoutDocument interface. It allows


you to get access to the properties of the layout. The Instruments property
implements the IViTopLevelInstruments interface. It allows you to get a collection
of all instruments placed on the layout.

Related interfaces

Interface Description
IXaLayoutManagement (refer to LayoutManagement / This interface is to access visualization including layouts
IXaLayoutManagement <<Interface>> (ControlDesk and instruments.
Automation ))
IXaLayoutDocument (refer to LayoutDocument / This interface is to access a single currently open layout
IXaLayoutDocument <<Interface>> (ControlDesk document.
Automation ))
IViTopLevelInstruments (refer to TopLevelInstruments / Interface for the top-level instruments collection.
IViTopLevelInstruments <<Interface>> (ControlDesk
Automation ))
IViInstrumentLibraries (refer to InstrumentLibraries / Automation interface for instrument libraries.
IViInstrumentLibraries <<Collection>> (ControlDesk
Automation ))
IViInstrumentDefaults (refer to InstrumentDefaults / Automation interface for instrument defaults.
IViInstrumentDefaults <<Interface>> (ControlDesk
Automation ))
IXaLayouts (refer to Layouts / IXaLayouts <<Collection>> This interface is to access the list of currently open layout
(ControlDesk Automation )) documents.

754
ControlDesk Instrument Handling May 2024
Layout and Instrument Handling

Related documentation

Topic Description
Automating Visualization of Variables on Layouts on Visualizing variables means placing variables on layouts
page 742 so that they are displayed by instruments.

755
May 2024 ControlDesk Instrument Handling
Automation

756
ControlDesk Instrument Handling May 2024
Troubleshooting

Troubleshooting

Where to go from here Information in this section

Repairing Variable Connections............................................................. 757


The connections between instruments and variables can be lost.

Time Plotter: No Display of Recorded Data Based on Triggered


Measurement with Sample Count Set to '1'.......................................... 758
The Time Plotter does not display recorded data resulting from a
triggered measurement if a sample count trigger is used as the
measurement's stop trigger , and if the trigger sample count is set to
'1'.

Repairing Variable Connections

Problem The connections between instruments and variables can be lost.

Description Variable connections can be lost when the hierarchy of the underlying model
changes, for example.

The following illustration shows an example of a broken variable connection:

757
May 2024 ControlDesk Instrument Handling
Troubleshooting

Solution To repair variable connections


1. Select the instrument to display its properties in the Properties pane.
2. In the Properties pane, navigate to the properties of the (unconnected)
variable to get its Path.
The following illustration shows an example:

3. In the Variables pane, navigate to the variable you want to reconnect.


The following illustration shows an example:

4. Drag the variable from the Variables pane to the instrument.


The following illustration shows the variable connection after it was
established again.

Related topics HowTos

How to Connect Variables and Framework Labels to Instruments (ControlDesk


Layouting )

Time Plotter: No Display of Recorded Data Based on Triggered Measurement


with Sample Count Set to '1'

Problem The Time Plotter does not display recorded data resulting from a triggered
measurement if a sample count trigger is used as the measurement's stop
trigger , and if the trigger sample count is set to '1'.

Description The following illustration shows the ControlDesk Measurement Configuration


pane with a raster configured for triggered measurement . The raster stop
trigger is a sample count trigger . The number of trigger samples is set to '1'.

758
ControlDesk Instrument Handling May 2024
Time Plotter: No Display of Recorded Data Based on Triggered Measurement with Sample Count Set to '1'

When you visualize a recorded signal with such a measurement configuration on


a Time Plotter , no data is displayed as shown in the following illustration.

Solution Clear the Hide points if too close property of the signal(s). The property is
checked by default.

759
May 2024 ControlDesk Instrument Handling
Troubleshooting

The Time Plotter displays the recorded signal data as shown in the following
illustration.

For information on the Hide points if too close property, rqefer to Axes and
Signals Properties (Time Plotter/Index Plotter) on page 422.

760
ControlDesk Instrument Handling May 2024
Limitations

Limitations

Limitations for Instrument Handling

Precision of 64-bit integer For some instruments, the precision of 64-bit integer variables limited to 52-bit.
variables limited to 52-bit for For more information, refer to Accessing 64-bit integer variables via ControlDesk
some instruments instruments on page 39.

Special character // in Do not use the // special character in instrument names since this causes
instrument names problems when you access the instrument via ControlDesk's tool automation
interface.

MultiState Display: Problem If you use commas in the message text of states of the MultiState Display, these
when using commas in states cannot be imported/exported from/to a CSV file.
message text

Sound Controller: ControlDesk crashes when you disconnect the output device from the
ControlDesk crashes when the ControlDesk PC when the device plays sounds from the ControlDesk Sound
output device is disconnected Controller.
during sound playback

761
May 2024 ControlDesk Instrument Handling
Limitations

762
ControlDesk Instrument Handling May 2024
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

Numerics............................................................................................... 764

A........................................................................................................... 764

B........................................................................................................... 765

C........................................................................................................... 766

D........................................................................................................... 770

E........................................................................................................... 774

F............................................................................................................ 776

G........................................................................................................... 777

H........................................................................................................... 778

I............................................................................................................ 778

K........................................................................................................... 780

L............................................................................................................ 780

M.......................................................................................................... 781

N........................................................................................................... 785

O........................................................................................................... 785

P........................................................................................................... 786

Q........................................................................................................... 788

R........................................................................................................... 789

S........................................................................................................... 790

763
May 2024 ControlDesk Instrument Handling
Glossary

T........................................................................................................... 793

U........................................................................................................... 794

V........................................................................................................... 795

W.......................................................................................................... 797

X........................................................................................................... 798

Numerics

3-D Viewer An instrument for displaying items in a 3-D environment.

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 pane 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

764
ControlDesk Instrument Handling May 2024
B

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.

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 (or a value cell type of the Variable Array ) for displaying
a numerical value as a bar deflection on a horizontal or vertical scale.

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 Web pages and different file types,
e.g., PDF, HTML and TXT files.

Bus configuration A configuration of all the controllers, communication


matrices, and messages/frames/PDUs of a specific communication bus such as
CAN. ControlDesk lets you display and experiment with bus configurations in the
Bus Navigator .

Bus connection A mode for connecting dSPACE real-time hardware to the


host PC via bus. Bus connections can be used for dSPACE real-time hardware
installed directly in the host PC.

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

765
May 2024 ControlDesk Instrument Handling
Glossary

signal-specific settings which are enabled for display and/or manipulation by


ControlDesk during run time.
For bus communication modeled with the Bus Manager, the related Bus
Instruments are based on the Hierarchy Array .

Bus Navigator
§ Bus Navigator in ControlDesk
A ControlDesk component for handling bus messages, such as CAN messages,
LIN frames, and Ethernet packets.
§ Bus Navigator (stand-alone)
A dSPACE software product for handling bus messages, such as CAN
messages, LIN frames, and Ethernet packets.
There are some restrictions when you use the Bus Navigator (stand-alone). For
example, going online and measuring is only supported for bus monitoring
devices.
Using the Bus Navigator (stand-alone) does not require a license for the
ControlDesk main version.

Bus Navigator pane A pane for handling bus messages, such as CAN
messages, LIN frames, and Ethernet packets.

Bus statistics A feature of the Bus Navigator that lets you display
and log statistical information on the bus load during monitoring (of bus
communication) .

Bypassing A method for replacing an existing ECU function by running a new


function.

Calculated variable A scalar variable that can be measured and recorded


and that is derived from one or more input signals.
The following variable types are supported as input signals:
§ Measurement variables
§ Single elements of measurement arrays or value blocks
§ Scalar parameters or existing calculated variables
§ Scalar elements of structs
ControlDesk performs the computation of calculated variable values according to
a user‑defined computation formula that uses one or more input signals.
Calculated variables are represented by the symbol.

CalDemo ECU A demo 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

766
ControlDesk Instrument Handling May 2024
C

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.
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 or


ECU applications .

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.

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 (ARXML)

CANGenerator A demo 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.

767
May 2024 ControlDesk Instrument Handling
Glossary

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.
You can start the CAN generator program by running 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) such as ControlDesk.
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 https://www.asam.net.
The following device supports ECUs with an integrated CCP service:
§ CCP device

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 registering platforms and handling


applications without using the user interface of an experiment software.

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


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

768
ControlDesk Instrument Handling May 2024
C

%PROGRAMDATA%\dSPACE\<ProductName>\<VersionNumber>

Tip

The Common Program Data folder is available


via the CommonApplicationSettingsPath property of
the ApplicationEnvironment / IAeApplicationEnvironment
<<Interface>> interface.

Computation method 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.
§ 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. 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.

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, LIN, and FlexRay
messages, frames, and PDUs and Ethernet packets.
Using the Bus Navigator does not require a license for the ControlDesk (main
version) .

769
May 2024 ControlDesk Instrument Handling
Glossary

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 SIL testing 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 /SIL 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.

Conversion table A table that specifies the value conversion 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 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 logger An object in the Measurement Configuration pane that


represents a data logging configuration.

Data logger signal list A list that contains the variables to be included in
subsequent data loggings on real-time hardware.

Data logging The recording of data on dSPACE real-time hardware that


does not require a physical connection between the host PC and the real-
time hardware. In contrast to flight recording , data logging is configured in
ControlDesk.

770
ControlDesk Instrument Handling May 2024
D

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:
§ Reference data set
§ Sub data set
§ Unassigned data set
§ Working data set

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-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-GSI2 Abbreviation of dSPACE Communication Interface - Generic Serial


Interface 2. A dSPACE-specific interface for ECU calibration, measurement and
ECU interfacing.

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-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:
§ Bus devices:
§ CAN Bus Monitoring device
§ Ethernet Bus Monitoring device
§ LIN Bus Monitoring device
§ ECU Diagnostics device
§ GNSS device
§ Measurement and calibration devices:
§ CCP device
§ DCI-GSI2 device
§ XCP on CAN device
§ XCP on Ethernet device

771
May 2024 ControlDesk Instrument Handling
Glossary

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.

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 with ControlDesk (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 https://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.
§ 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 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.

772
ControlDesk Instrument Handling May 2024
D

§ 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.

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 application‑specific files that are


used by the current user.
%USERPROFILE%\Documents\dSPACE\<ProductName>\<VersionNumber>

Tip

The Documents folder is available via the UserWorkFolder property


of the ApplicationEnvironment / IAeApplicationEnvironment
<<Interface>> interface.

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:
§ DS1202 MicroLabBox platform
§ MicroAutoBox III platform
§ MicroLabBox II platform
§ SCALEXIO platform
§ VEOS platform
§ XIL API MAPort platform

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‑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. The dSPACE Calibration and Bypassing 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

773
May 2024 ControlDesk Instrument Handling
Glossary

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 Log A collection of errors, warnings, information, questions, and


advice issued by all dSPACE products and connected systems over more than one
session.

dSPACE Python distribution A Python version installed by and configured


for a dSPACE setup/installation.

dSPACE system A hardware system such as a MicroAutoBox III or SCALEXIO


system on which the real-time application runs.

DSSIGCONV A command line tool that lets you do the following:


§ Convert MF4 files to other file formats.
§ Reduce the file content by selecting specific parts or specific signals to be
stored in the destination file.
§ Add reduction data to an MF4 file.

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 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.

774
ControlDesk Instrument Handling May 2024
E

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.
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 A pane for configuring error configurations .

Electrical error simulation Simulating electrical errors such as loose


contacts, broken cables, and short-circuits, in the wiring of an ECU. Electrical
error simulation is performed by the fault simulation hardware of an
HIL simulator.

Electrical Error Simulation port (EESPort) An Electrical Error Simulation


port (EESPort) provides access to a fault 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 fault 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 faults).

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.

775
May 2024 ControlDesk Instrument Handling
Glossary

Ethernet Bus Monitoring device A device that monitors the data stream on
an Ethernet network connected to the ControlDesk PC.
The device supports the following variable description file type:
§ AUTOSAR system description (ARXML)

Ethernet connection A mode for connecting dSPACE real-time hardware


to the host PC via Ethernet. Ethernet connections are possible with
MicroAutoBox II/III and MicroLabBox/MicroLabBox II.

Ethernet decoding A feature of the Bus Navigator that lets you view
protocol data and raw data of an Ethernet frame.

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

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 faults 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.

776
ControlDesk Instrument Handling May 2024
G

Fault Memory Instrument An instrument for reading, clearing, and saving


the content of the ECU’s fault memory .

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 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.

Flight recording The recording of data on dSPACE real-time hardware that


does not require a physical connection between the host PC and the real-time
hardware. In contrast to data logging , flight recording is not configured in
ControlDesk but via RTI and RTLib.

Frame An instrument for adding a background frame to a layout, for


example, to visualize an instrument group.

Framework label The name of a variable on the experiment level (framework


label in ASAM XIL) that is decoupled from the name of a variable on the
modeling level (testbench label in ASAM XIL). A framework label is defined
by a label name (ID) and a data type. The framework labels in a framework label
list are unique.

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.

GNSS data Positioning and timing data that is transmitted by a Global


Navigation Satellite System (GNSS), such as GPS, GLONASS, or Galileo. GNSS
receivers use this data to determine their location.

GNSS device A device that provides positioning data from a GNSS receiver
(e.g., a serial GPS mouse) in ControlDesk.
The device that supports various global navigation satellite systems.

777
May 2024 ControlDesk Instrument Handling
Glossary

GPX file An XML file that contains geodata, such as waypoints, routes, or
tracks. In ControlDesk, you can import GPX files to visualize GNSS positioning
data in a Map instrument.

Heading Indicator An instrument displaying the heading direction of a


simulated aircraft on a circular scale.

Hierarchy Array An instrument for displaying variables grouped into custom


hierarchy levels using different cell types for visualization.

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:
§ DS1104 R&D Controller Board platform
§ MicroAutoBox platform

Index Plotter A plotter instrument for displaying signals that are measured
in an event-based raster (index plots).

Input quantity A variable that is referenced by a Table Editor and that


provides the input value of the variable connected to that Table Editor.

Inspection (of bus communication) The observation of bus communication


on a bus channel by a simulator , e.g., a SCALEXIO system.

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:
§ 3-D Viewer
§ Airspeed Indicator
§ Altimeter
§ Animated Needle
§ Artificial Horizon
§ Bar
§ Browser
§ Bus Instrument
§ Check Button
§ Diagnostics Instrument

778
ControlDesk Instrument Handling May 2024
I

§ Display
§ Fault Memory Instrument
§ Frame
§ Gauge
§ Heading Indicator
§ Hierarchy Array
§ 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
§ XY Plotter

Instrument Navigator A pane 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 script A Python script used to extend the functionality of an


instrument .

Instrument Selector A pane in ControlDesk that provides access to


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

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.

Internal Interpreter ControlDesk's built-in programming interface for


editing, running and importing Python scripts. It also processes event handler
code .
The Internal Interpreter contains an Interpreter pane where the user can
enter Python commands interactively and which displays output and error
messages of Python commands.

Interpreter pane A pane that can be used to execute line-based


commands. It is used by the Internal Interpreter to print out Python standard

779
May 2024 ControlDesk Instrument Handling
Glossary

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.

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 saving
connected variables, etc.

Layout A page with instruments for visualizing, measuring, and


calibrating variables interactively.

Layout Navigator A pane that displays all opened layouts . It can be


used for switching between layouts.

Layout script A Python script used to extend the functionality of a layout .

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 (ARXML)

Load type The load type specifies the option to disturb a signal with or
without load rejection.

780
ControlDesk Instrument Handling May 2024
M

Local Program Data folder A standard folder for application-specific


program data that is used by the current user.
%USERPROFILE%\AppData\Local\dSPACE\<InstallationGUID>\
<ProductName>

Tip

The Local Program Data folder is available


via the ApplicationSettingsPath property of
the ApplicationEnvironment / IAeApplicationEnvironment
<<Interface>> interface.

Logging (of bus communication) 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 .

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 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.

Manipulation (of bus communication) The alteration of bus


communication by a simulator , e.g., a SCALEXIO system, immediately before
the bus communication is transmitted on a bus to test an ECU, for example.

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 .

781
May 2024 ControlDesk Instrument Handling
Glossary

§ 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 the build process of an ECU application .

Map instrument A customized Browser instrument. It uses an instrument


script to open a web map and connect positioning data to the map. The Map
instrument offers prepared connection nodes to connect variables with GNSS
data .

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.

Measurement buffer A ring buffer that buffers measurement data at the


start of a measurement . The measurement buffer size determines the amount
of data that can be buffered. Earlier values are overwritten by later values when
the buffer capacity is exceeded (buffer overflow).

Measurement Configuration A pane that allows you to configure


measurement , recording and data logging .

Measurement Data API Application programming interface for accessing


measurement data. The API lets the user access measurement data without
having to use ControlDesk.

Measurement Data Pool A pane 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 can be 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 recordings. The list is global for all
platforms/devices of the current experiment.

782
ControlDesk Instrument Handling May 2024
M

The measurement signal list is available in the configuration area of the


Measurement Configuration pane.

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.
§ Online calibration is possible. Parameter values can be changed directly on the
platform/device hardware.
§ A measurement (or recording) is 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, but only one of
the pages is “visible” to the microcontroller of the ECU or the real‑time processor
(RTP) of the platform hardware 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.

Messages pane A pane displaying a history of all error and warning


messages that occur during work with ControlDesk.

MicroAutoBox III platform A platform that provides access to a


MicroAutoBox III connected to the host PC for function prototyping purposes
such as bypassing .

MicroAutoBox platform A platform that provides access to a


MicroAutoBox II connected to the host PC for function prototyping purposes
such as bypassing.

MicroLabBox II platform A platform that provides access to a


MicroLabBox II connected to the host PC for function prototyping purposes.

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. 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.

783
May 2024 ControlDesk Instrument Handling
Glossary

§ 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 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 to the host PC, or downloading them
from the host PC to the hardware.
§ 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 and in the
mirrored memory. In other words, parameter values on the hardware and on
the host PC are always the same while you are performing online calibration.

Monitoring (of bus communication) 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.

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
short circuit for another channel at the same time, without deactivating the first
error.

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 and Hierarchy
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.

784
ControlDesk Instrument Handling May 2024
N

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 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 .
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 platform/device hardware 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 application (OSA) An offline simulation application


(OSA) file is an executable file for VEOS. After the build process, the OSA file
can be downloaded to VEOS.
An OSA contains one or more VPUs , such as V-ECUs and/or
environment VPUs.

785
May 2024 ControlDesk Instrument Handling
Glossary

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.
§ Online calibration is possible. Parameter values can be changed directly on the
platform/device hardware.
§ Platform/device configuration is not possible.
Before starting online calibration, ControlDesk lets you compare the memory
pages on the platform/device hardware 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 to ControlDesk, or
downloading the values from ControlDesk to the hardware. However, a page
cannot be downloaded if it is read‑only.
The 'online calibration started' platform/device state is indicated by the
symbol.

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 or writable measurement whose


memory address is used to write the computed value of a calculated
variable to.

Page An area in the ControlDesk working area to display and edit a


document, such as a layout , a Python script, or a signal description set .

Pane A separate area of the ControlDesk user interface that provides access
to a specific component, such as the Bus Navigator.

Parameter Any variable type that can be calibrated.

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.

786
ControlDesk Instrument Handling May 2024
P

§ 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.

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).
ControlDesk provides the following platforms:
§ DS1104 R&D Controller Board platform
§ DS1202 MicroLabBox platform
§ MicroAutoBox platform
§ MicroAutoBox III platform
§ MicroLabBox II 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.

Platforms/Devices pane A pane that 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 fault 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 fault
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

Preview feature A feature in an early but completely tested development


stage. It might benefit from user feedback before being finally integrated into
the regular product.
The final version of the feature might be incompatible with the preview version.

787
May 2024 ControlDesk Instrument Handling
Glossary

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.

Project pane A pane that 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 pane A pane 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 until
they are applied. This allows several parameter changes to be written to the
hardware together. 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 editing PY files.


The Python Editor is displayed in the ControlDesk working area .

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‑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.

788
ControlDesk Instrument Handling May 2024
R

Radio Button An instrument for displaying and setting the value of the
connected parameter by radio buttons.

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 A2L 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 pane that specifies


and executes the recording of variables according to a specific measurement
configuration.

Recorder signal list A list that contains the variables to be included in


subsequent recordings .

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.

789
May 2024 ControlDesk Instrument Handling
Glossary

Reference page Memory area containing the parameters of an ECU. The


reference page contains the read‑only reference data set .

Note

Some platforms/devices provide only a working page . You cannot switch


to a reference page in this case.

Replay (of bus communication) 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 .

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 .

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 simulation system consisting of at least one


processing hardware component, I/O boards, and I/O units. They communicate
with each other via the IOCNET. In a SCALEXIO system, two types of processing
hardware can be used, a DS6001 Processor Board or a SCALEXIO Processing
Unit. In hardware-in-the-loop scenario, the SCALEXIO 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 A file that describes a dSPACE simulation application , including the
contained parameters and measurement variables. SDF files are created during
the build process.

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)

790
ControlDesk Instrument Handling May 2024
S

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 Editor A software component to create, configure, display, and


manage signals in signal description sets .

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 fault 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.
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 pane of the Signal Editor to map model variables to


signals and variable aliases of a signal generator .

Signal Selector A pane of the Signal Editor . The Signal Selector provides
signals and segments for arranging and configuring signal description
sets in the working area .

SIL simulation Abbreviation of software‑in‑the‑loop simulation.


A PC-based simulation in which the simulator is not connected to a physical
system and is thus independent of the real time.

SIL testing Abbreviation of software‑in‑the‑loop testing.


Simulation and testing of individual software functions, complete virtual ECUs
(V‑ECUs ), or even V‑ECU networks on a local PC or highly parallel in the cloud
independently of real-time constraints and real hardware.

Simulation (of bus communication) The simulation of bus communication


of ECUs that are not the devices under test (restbus simulation), or the simulation
of bus communication of an individual ECU by a simulator , e.g., a SCALEXIO
system.

Simulation application The generic term for offline simulation application


(OSA) and real-time application .

791
May 2024 ControlDesk Instrument Handling
Glossary

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 A 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.

Single-shot instrument An instrument that displays an instantaneous


value of a connected variable without keeping a value history. In ControlDesk,
all instruments except for a plotter are single-shot instruments. For
platforms that support the variable observer functionality, you can use
single-shot instruments to observe variables.

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.

Sound Controller An instrument for generating sounds based on WAV


and/or MP3 sound files.

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 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.

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.

792
ControlDesk Instrument Handling May 2024
T

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 .

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:
§ Common axis ( )
§ Curve ( )
§ Map ( )
§ Measurement array ( )
§ Value block ( )

Testbench label Name of a variable on the modeling level (testbench label


in ASAM XIL) to identify model variables from the variable description . A
testbench label is defined by a label name (ID) and a data type. The testbench
labels are unique in each testbench label list with an assigned port ID.

Time cursor A cursor which is visible at the same time position in the
following instruments:
§ In all Time Plotters
§ In all XY Plotters
§ In all bus monitoring lists

793
May 2024 ControlDesk Instrument Handling
Glossary

You can use the time cursor to view signal values at a specific point in time. If
you move the time cursor, all measured signals and the respective parameters
are updated. Instruments and bus monitoring lists display the values that are
available at the selected time position.

Time Plotter A plotter instrument for displaying signals that are measured
in a time-based raster (time plots).

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.
§ 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'

794
ControlDesk Instrument Handling May 2024
V

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


ControlDesk user interface for quick and easy access during work with
ControlDesk.

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


external tools added to the Automation ribbon.

Value (variable type) A scalar parameter , as well as the individual


elements of a value block .
Values are represented by the symbol.

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 source values of variables


into the corresponding scaled converted values.

Variable Any parameter or measurement variable defined in a variable


description . ControlDesk provides various instruments to visualize variable
values.

795
May 2024 ControlDesk Instrument Handling
Glossary

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 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 Filter A variable filter contains the filter configuration of a


combined filter, which is used to filter the variable list in the Variables pane
using a combination of filter conditions.

Variable mapping A concept to decouple the names of variables on the


experiment level (framework labels ) from the names of variables on the
modeling level (testbench labels ). Mapping is achieved by the implementation
of a separate abstraction layer instead of the direct use of model variables
from a variable description (identifier mapping in ASAM XIL). For example,
layouts and instruments can be created based on framework labels,
independently of the variable description.
Mapping information is contained in an XIL mapping file .

Variables pane A pane that provides access to all the variable


descriptions and calculated variables of the currently open experiment .

V‑ECU Abbreviation of virtual ECU.


ECU software that can be executed in a software‑in‑the‑loop
(SIL) testing environment such as a local PC or highly parallel in the cloud
independently of real-time constraints and real ECU hardware.

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.

796
ControlDesk Instrument Handling May 2024
W

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 .

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.

View set A named configuration of the panes 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
panes.

Visualization The representation of variables in instruments :


§ Measurement variables can be visualized in instruments to view and analyze
their time traces.
§ Calibration parameters can be visualized in instruments to change their
values.

VPU Abbreviation of virtual processing unit. A VPU is part of an offline


simulation application in VEOS. Each VPU runs in a separate process of the PC.
VPU is also the generic term for:
§ V-ECUs
§ Environment VPUs
§ Controller VPUs
§ Bus VPUs

Working area An area of the user interface of ControlDesk where you can
edit documents, such as layouts , Python scripts, or signal description sets .
Each document is displayed on a separate page .

Working data set The data set currently residing in the memory of a
platform/device hardware. 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 or


prototyping hardware (memory page ). The working page contains the
read/write working data set .
If the platform/device also provides a reference page , ControlDesk lets you
switch between both pages.

797
May 2024 ControlDesk Instrument Handling
Glossary

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.
XCP is based on the master-slave principle:
§ The ECU is the slave.
§ The measurement and calibration system is the master.
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:
§ ECU parameter calibration (CAL)
§ Synchronous data acquisition (DAQ)
§ Synchronous data stimulation (STIM), i.e., for bypassing
§ ECU flash programming (PGM)
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 https://www.asam.net.
The following ControlDesk devices support ECUs with an integrated XCP service:
§ XCP on CAN device
§ XCP on Ethernet device

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.

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.

798
ControlDesk Instrument Handling May 2024
X

XIL mapping file An XML file according to the ASAM XIL standard
that contains, for example, all the information required for variable
mapping (identifier mapping):
§ Framework labels
§ Testbench labels
§ Label mappings
XIL mapping files can be created by different tools in the dSPACE XIL mapping
tool chain, for example, by ConfigurationDesk. In ControlDesk, framework labels
from these files can be used for variable mapping.

XY Plotter A plotter instrument for displaying signals as functions of other


signals.

799
May 2024 ControlDesk Instrument Handling
Glossary

800
ControlDesk Instrument Handling May 2024
Index
Index
configuring force feedback effects 182 instrument properties 51
Numerics configuring individual properties of an Instrument Selector 779
instrument 51 instruments
3-D Viewer 303
configuring the Artificial Horizon 108 3-D Viewer 303
adding items 79
configuring the Gauge 112 Airspeed Indicator 268
configuring item properties 79
configuring the Knob 145 Altimeter 270
connecting variables to properties 64
configuring the Multiswitch 151 Animated Needle 307
coordinate system 62
configuring the On/Off Button 159 Artificial Horizon 272
group items 89
configuring the Slider 164 Bar 309
handling 55
configuring the Steering Controller 179 Browser 312
overview of possible variable connections 67
configuring the Table Editor 199 Check Button 319
surfaces 90
configuring the Variable Array 244 configuring force feedback Effects 182
tracking distances 83
ControlDesk Options dialog configuring individual properties of an
working with item templates 86
Display Format page 645 instrument 51
Instruments page 672 configuring the Artificial Horizon 108
A custom instruments configuring the Gauge 112
Airspeed Indicator 268 automotive controls 267 configuring the Knob 145
Altimeter 270 gauges 295 configuring the Multiswitch 151
Animated Needle 307 LEDs 297 configuring the On/Off Button 159
Artificial Horizon 272 measurement 298 configuring the Slider 164
configuring 108 stopwatches 399 configuring the Steering Controller 179
horizon 105 configuring the Variable Array 244
pitch scale 104 D Diagnostics Instrument 321
roll scale 104 Display 324
Diagnostics Instrument 321
Automotive Controls Library 267 Edit Common Axis dialog 588
Display 324
Fault Memory Instrument 326
Documents folder 18, 773
FPGA Scale ADC 281
B
FPGA Scale DAC 286
Bar 309 E FPGA Scope 290
Browser 312 Frame 330
Edit Common Axis dialog 588
handling 97 Heading Indicator 275
exporting and importing table data 214
Hierarchy Array 336
C F
Index Plotter 341
instrument properties 51
calibrating parameters
Fault Memory Instrument 326 Interpolation dialog 587
changing axis point values 207
FPGA Scale ADC 281 Invisible Switch 346
changing values in the Table Editor 203
FPGA Scale DAC 286 Map 277
changing values with the Knob 146
FPGA Scope 290 Monotony Violation dialog 588
changing values with the Multiswitch 153
Frame 330 MultiState Display 352
changing values with the On/Off Button 160
Multiswitch 354
changing values with the Slider 165
changing values with the Steering G Numeric Input 357
On/Off Button 359
Controller 181 Gauge
Push Button 361
common axis 203 configuring 112
Radio Button 363
configuring force feedback effects 182 Gauges Automotive library 295
Selection Box 366
configuring the Knob 145
Slider 368
configuring the Multiswitch 151 H Sound Controller 372
configuring the On/Off Button 159
handling Static Text 374
configuring the Slider 164
3-D Viewer 55 Steering Controller 375
configuring the Steering Controller 179
Browser 97 Table Editor 379
configuring the Table Editor 199
Index Plotter 120 Time Plotter 384
configuring the Variable Array 244
Sound Controller 167 triggering the Index Plotter visualization 132
exporting and importing table data 214
Time Plotter 216 triggering the Time Plotter visualization 232
inserting and deleting axis points 209
XY Plotter 253 Variable Array 389
changing values in the Table Editor 203
Heading Indicator 275 Interpolation dialog 587
changing values with the Knob 146
Hierarchy Array 336 Invisible Switch 346
changing values with the Multiswitch 153
changing values with the On/Off Button 160
changing values with the Slider 165 I K
changing values with the Steering Index Plotter 341 Knob
Controller 181 handling 120 changing values 146
Check Button 319 mean value curves and envelopes 130 configuring 145
common axis 203 visualization downsampling 130
Common Program Data folder 18, 768 inserting and deleting axis points 209

801
May 2024 ControlDesk Instrument Handling
Index

L changing axis point value 207


changing values 203
LED’s Automotive library 297
common axis 203
Local Program Data folder 18, 781
configuring 199
Edit Common Axis dialog 588
M exporting and importing table data 214
Map 277 inserting and deleting axis points 209
measurement and recording Interpolation dialog 587
configuring the Artificial Horizon 108 Monotony Violation dialog 588
configuring the Gauge 112 Time Plotter 384
triggering the Index Plotter visualization 132 handling 216
triggering the Time Plotter visualization 232 mean value curves and envelopes 229
Measurement Data Pool 782 visualization downsampling 229
Measurement library 298 transparency 433
measuring and recording
configuring the Variable Array 244 V
Messages pane 783
Variable Array 389
Monotony Violation dialog 588
configuring 244
move mode 125, 225, 258
visualization
MultiState Display 352
configuring individual properties of an
Multiswitch 354
instrument 51
changing values 153
instrument properties 51
configuring 151

X
N
XY Plotter
Numeric Input 357
handling 253

O
Z
On/Off Button 359
zoom mode 125, 224, 257
changing values 160
configuring 159

P
Platforms/Devices pane 787
Plotter
Plotter Legend dialog 607
Plotter Legend dialog 607
Project pane 788
Properties pane 788
Push Button 361

R
Radio Button 363

S
Selection Box 366
Slider 368
changing values with the Slider 165
configuring 164
Sound Controller 372
handling 167
Static Text 374
Steering Controller 375
changing values 181
configuring 179, 182
connections 376
Stopwatches 399

T
Table Editor 379

802
ControlDesk Instrument Handling May 2024

You might also like