5.4. DISPlay

The DISPlay commands are used to set the display mode, turn on or off the front panel TFT display, select main page appearance, display and clear the text sent using a controller application. DISPlay is independent of, and does not modify, how data is returned to the controller application.

 

SCPI command

Description

DISPlay

 

:BRIGhtness {<value>}

Sets the intensity of the front panel TFT display

:DATA?

Reads screen image data

:VIEW {<mode>}

Sets the front panel TFT display main page appearance

[:WINdow]

 

[:STATe] {<bool>}

Sets the front panel TFT display state

:DIALog

 

[:OPEN] {<filename>}

Displays content of the resource file

:ACTIon? [<timeout>]

Returns information about selected item

:CLOSe

Closes last opened dialog window

:DATA {<name>}, {<type>}, [{<unit>}], {<value>}

Sets the value of the dialog data item

:DLOG [<filename>]

Opens DLOG viewer

:ERRor {<message>}

Displays message box and generates error beep tone

:INPUt? {<label>}, {<type>} [, <min>, <max>, <value>]

Displays entry form and waits for input on the front panel TFT display

:SELect? {<defaultSelection>, {<optionText>}[, ...]

Displays pop-up display with multiple radio buttons

:TEXT {<message>}

Displays a message on the front panel TFT display

:CLEar

Clear a message on the front panel TFT display

5.4.1. DISPlay:BRIGhtness

Syntax

DISPlay:BRIGhtness {<value>}

DISPlay:BRIGhtness?

Description

Controls the intensity of the front panel TFT display. The range of the parameter is 1 to 20, where 20 is full intensity and 1 is fully blanked.

Parameters

Name

Type

Range

Default

<value>

NR1

1 – 20

20

Return

This query returns set front panel's TFT display brightness value.

Usage example

DISP:BRIG?

20

Related Commands

*RST

5.4.2. DISPlay:DATA?

Syntax

DISPlay:DATA?

Description

This query reads screen image data. The image is formatted as a .png file.

Use the HCOPy[:IMMediate] or HCOPy:SDUMp[:IMMediate] command to capture screen image and save it as a file on the SD card.

Return

Screen image data is returned in the IEEE-488.2 # data block format (see Section 2.10).

Usage example

DISP:DATA?

#<length-digits><length><block>

Related Commands

HCOPy[:IMMediate]

HCOPy:SDUMp[:IMMediate]

MMEMory:FEED

5.4.3. DISPlay:VIEW

Syntax

DISPlay:VIEW {<mode>}

DISPlay:VIEW?

Description

Use this command to set front panel TFT display main page appearance. The following modes are available:

  • 1 – Numerical
  • 2 – Bar graph horizontal
  • 3 – Bar graph vertical
  • 4 – YT view (scroll)
  • 5 – YT view (scan line)

Parameters

Name

Type

Range

Default

<mode>

NR1|Discrete

1 – 5|DEFault

DEFault

Return

This query returns set front panel's TFT display main page appearance numeric value (NR1).

Usage example

DISP:VIEW 2

Related Commands

*RST

5.4.4. DISPlay[:WINdow][:STATe]

Syntax

DISPlay[:WINdow][:STATe] {<bool>}

DISPlay[:WINdow][:STATe]?

Description

Turn the front panel TFT display off or on. When the display is turned off, outputs are not sent to the display and all indicators are disabled except the Event view indicator. The display state is automatically turned on when you return to the local mode.

Press and hold the display for about a second to return to the LOCal from the REMote control.

Parameters

Name

Type

Range

Default

<bool>

Boolean

ON|OFF|0|1

Return

DISPlay? query the front panel TFT display state. Returns 0 (OFF) or 1 (ON).

Usage example

DISP ON

Related Commands

SYSTem:LOCal

SYSTem:REMote

5.4.5. DISPlay[:WINdow]:DIALog[:OPEN]

Syntax

DISPlay[:WINdow]:DIALog[:OPEN] {<filename>}

Description

Use this command to draw new page defined with resource file created in EEZ Studio and contains page widgets, actions and data items. The resource file has to be located on the SD card (see MMEMory subsystem) and the full path to the file must be specified.

The new displayed page can be closed (removed) by using the DISPlay[:WINdow]:DIALog:CLOSe to close the page.

Parameters

Name

Type

Range

Default

<filename>

Quoted string

Usage example

DISP:DIAL "/Scripts/Diode Tester.res"

 

Related Commands

DISPlay[:WINdow]:DIALog:CLOSe

DISPlay[:WINdow]:DIALog:DATA

5.4.6. DISPlay[:WINdow]:DIALog:ACTIon

Syntax

DISPlay[:WINdow]:DIALog:ACTIon? [<timeout>]

Description

This command waits for timeout (in seconds) to get information about what action item is selected on the currently displayed page as defined in resource file activated with the DISPlay[:WINdow]:DIALog[:OPEN] command. The default timeout value is 0 and command will wait until user select one of the action items.

Parameters

Name

Type

Range

Default

<timeout>

NR1

0

Return

Returns name of the latest action item selected by user. 0 will be returned if currently opened page does not contain any action dialog. 1 is returned when timeout parameter is used and set time expired without user action.

Usage example

DISP:DIAL:ACTI?

"input_diode_name"

Related Commands

DISPlay[:WINdow]:DIALog[:OPEN]

5.4.7. DISPlay[:WINdow]:DIALog:CLOSe

Syntax

DISPlay[:WINdow]:DIALog:CLOSe

Description

Use this command to close last dialog window opened with the DISPlay[:WINdow]:DIALog[:OPEN] command.

Usage example

DISP:DIAL:CLOS

Related Commands

DISPlay[:WINdow]:DIALog[:OPEN]

5.4.8. DISPlay[:WINdow]:DIALog:DATA

Syntax

DISPlay[:WINdow]:DIALog:DATA {<name>}, {<type>}, [{<unit>}], {<value>}

Description

Use this command to set the value of the dialog data item defined as <name>. The list of possible data items is defined within the dialog resource file created in the EEZ Studio and specified with the DISPlay[:WINdow]:DIALog:OPEN command.

 

If <type> is FLOat then <unit> has to be specified, too.

Parameters

Name

Type

Range

Default

<name>

Quoted string

 

<type>

NR1|NR3|Quoted string

INTeger|FLOat|STRing

<unit>

Discrete

UNKNown|VOLT| AMPEr|WATT|JOULe|SECOnd|OHM|FARAd|HERTz

Usage example

DISP:DIAL:DATA "test", INT

Related Commands

DISPlay[:WINdow]:DIALog:OPEN

5.4.9. DISPlay[:WINdow]:DLOG

Syntax

DISPlay[:WINdow]:DLOG [<filename>]

Description

This command opens DLOG viewer and displays specified by filename. If filename is omitted it displays the last log file during or after recording is finished.

Usage example

DISP:DLOG "Recording/test_log.dlog"

Related Commands

INITiate:DLOG

INITiate:DLOG:TRACe

5.4.10. DISPlay[:WINdow]:ERRor

Syntax

DISPlay[:WINdow]:ERRor {<message>}

Description

Use this command to display message box and generates error beep tone.

Usage example

DISP:ERR "Test message!"

Related Commands

DISPlay[:WINdow]:TEXT

SYSTem:BEEPer[:IMMediate]

5.4.11. DISPlay[:WINdow]:INPut

Syntax

DISPlay[:WINdow]:INPut? {<label>}, {<type>} [, <min>, <max>, <value>]

Description

Use this command to define input field on the display that can returns a value of type <type> which can be TEXT | NUMBer | INTeger | MENU. The following variants are possible:

  • DISPlay[:WINdow]:INPut? {<label>}, TEXT, <min_length>, <max_length>, <value>
  • DISPlay[:WINdow]:INPut? {<label>}, NUMBer, <unit>, <min>, <max>, <value>
  • DISPlay[:WINdow]:INPut? {<label>}, INTeger, <min>, <max>, <value>
  • DISPlay[:WINdow]:INPut? {<label>}, MENU, <menu_type>, <menu_item>, [… <menu_item>]

<min> and <max> values should be defined for TEXT, NUMBer and INTeger.

For NUMBer and INTeger this is the minimum and maximum allowable value, and for STRing it is the minimum and maximum allowable text length. NUMBer should also be set to <unit> (see above which units are allowed).

If <type> is MENU then you should set <menu_type> (which can only be BUTTon) and up to max. 4 menu items (button texts) to be offered for selection.

A numeric keypad will be open for NUMBer and INTeger, and a full keypad will be open for TEXT. The default <label> (quoted string) will be displayed on the screen.

In all variants except MENU (where no need to be specified), the <value> parameter is the initial (or default) value.

Parameters

Name

Type

Range

Default

<label>

Quoted string

 

<type>

Discrete

TEXT|NUMBer|MENU

 

Return

This query returns value of defined type.

Usage example

DISP:INP? "Enter you text", TEXT, 2, 10, "Hello"

"Test"

5.4.12. DISPlay[:WINdow]:SELect?

Syntax

DISPlay[:WINdow]:SELect? {<defaultSelection>, {<optionText>}[, ...]

Description

Display pop-up display with multiple radio buttons. The <defaultSelection> specify which of the presented option will be selected by default.

Parameters

Name

Type

Range

Default

<defaultSelection>

NR1

1 to the total number of options

 

<optionText>

Quoted string

Return

The query returns NR1 value of the selected option.

Usage example

Default option is 2 and query returns 3 when "Option 3" is selected:

DISP:SEL? 2, "Option 1", "Option 2", "Option 3"

3

Related Commands

DISPlay[:WINdow]:DIALog:CLOSe

DISPlay[:WINdow]:DIALog:DATA

DISPlay[:WINdow]:INPut

5.4.13. DISPlay[:WINdow]:TEXT

Syntax

DISPlay[:WINdow]:TEXT {<text message>}

DISPlay[:WINdow]:TEXT?

Description

Display a message on the front panel TFT display. The BB3 will display up to 32 characters in a message.

Parameters

Name

Type

Range

Default

<text message>

Quoted string

Return

Query the message sent to the front panel TFT display and returns a quoted string.

Usage example

Send "Hello world" textual message:

DISP:TEXT "Hello world"

Related Commands

DISPlay[:WINdow]:TEXT:CLEar

5.4.14. DISPlay[:WINdow]:TEXT:CLEar

Syntax

DISPlay[:WINdow]:TEXT:CLEar

Description

Clear the message displayed on the front panel TFT display.

Return

None

Usage example

DISP:TEXT:CLE

Related Commands

DISPlay[:WINdow]:TEXT