Command Line Arguments
Dash Design can generate test setups and convert setup files from the command line without opening a window or prompting for user input. Each command performs one operation, then exits.
Arguments
| Argument | Operation |
|---|---|
--setup-cli-help |
Show command-line usage. |
--list-display-types |
List the display names accepted by the application. |
--generate-test-setup DISPLAY OUTPUT_STEM |
Generate a rendering test setup for a display, saved as a native setup, XML and raw binary. |
--convert-setup FORMAT INPUT OUTPUT |
Convert a setup file to the specified target format: xml, setup, raw or locked. |
Use the executable for your application brand. Display names and native setup extensions follow that application’s supported display types. Quote paths and display names that contain spaces. Output directories must already exist, and existing output files are not overwritten.
Running From PowerShell
The examples below use the GEMS executable, DashDesign.exe. Substitute your
application’s executable path as required.
$app = '.DashDesign.exe'
Start-Process $app -ArgumentList '--setup-cli-help' -Wait
Start-Process $app -ArgumentList '--list-display-types' -WaitUse Start-Process -Wait -PassThru to wait for the application and inspect its
exit code in a script. The application is a Windows GUI executable, so launching
it directly from a shell may not wait for the command to finish.
Generating A Test Setup
--generate-test-setup DISPLAY OUTPUT_STEMDISPLAY is a name shown by --list-display-types. OUTPUT_STEM is the output
path without an extension. For example, with C:tests already present:
$result = Start-Process $app -ArgumentList '--generate-test-setup CD6 "C:testscd6-rendering"' -Wait -PassThru
$result.ExitCodeFor the GEMS application this creates:
| File | Contents |
|---|---|
C:testscd6-rendering.cd6.gdd |
Editable native setup. |
C:testscd6-rendering.xml |
XML setup, including embedded image and animation data. |
C:testscd6-rendering.bin |
Compiled raw display setup binary. |
The native extension depends on the selected display and application brand.
The setup includes a CAN page-select input and four variants of each supported renderable gauge type, arranged over multiple pages. The variants exercise ranges, warning thresholds, numeric formats, text alignment, gradients, transparency, rotation and other gauge-specific properties. Groups contain child gauges. Internal event, logging, hidden and physical LED gauges remain in the normal control-page setup rather than being duplicated as visual gauges.
Depending on display support, channels include signed and unsigned CAN inputs, constant scalar values, maths, logic, bit-string text, image selectors and colour gradients. Test images and animations do not require external asset files.
CAN Inputs
| Purpose | CAN Input |
|---|---|
| Page selection | Bus 1, standard ID 0x400, unsigned byte 0. Send the one-based page number. |
| Numeric test value | Standard ID 0x401, signed 13-bit Motorola signal at Vector bit offset 3. Uses bus 2 when available, otherwise bus 1. |
Sweep the numeric input through negative and positive values, including values
below, at and above gauge ranges and warning thresholds. Suggested values are
-120, -40, 0, 20, 42, 100, 101, 160, 900 and 1024.
Use current display firmware: the setup may exercise capabilities introduced in newer firmware. Camera and file-browser gauges require the corresponding hardware or media to exercise their live content. Generated setups are test fixtures, not automatic visual pass/fail tests; inspect or compare the rendered results on the simulator or display.
Converting Setup Files
--convert-setup FORMAT INPUT OUTPUTThe target format is specified explicitly; it is not inferred from the output filename.
| Format | Input | Output |
|---|---|---|
xml |
Native setup | XML setup. |
setup |
XML setup | Editable native setup. |
raw |
Native setup | Compiled raw display setup binary. |
locked |
Native setup | Locked setup package. |
For example:
Start-Process $app -ArgumentList '--convert-setup xml "C:testssource.cd6.gdd" "C:testssource.xml"' -Wait
Start-Process $app -ArgumentList '--convert-setup setup "C:testssource.xml" "C:testsimported.cd6.gdd"' -Wait
Start-Process $app -ArgumentList '--convert-setup raw "C:testssource.cd6.gdd" "C:testssource.bin"' -Wait
Start-Process $app -ArgumentList '--convert-setup locked "C:testssource.cd6.gdd" "C:testssource.locked"' -WaitThe locked package contains compiled display data, thumbnails, export metadata and source hashes. It does not embed an editable source setup. XML conversion errors fail the command rather than producing a partially imported setup.
Exit Codes
| Code | Meaning |
|---|---|
0 |
The operation completed successfully. |
1 |
The operation failed. |
Progress messages are written to standard output and errors to standard error.
Invalid arguments, unknown display types, missing input files, existing output
files and conversion or export errors return code 1 without prompting for user
input.