Measurement Screen Commands¶

:SCReen:COUNt?¶

Syntax	:SCReen:COUNt? <instrument_identifier>
Description	Queries the number of measurement screens in the oxygen.
Return Format	<integer> \| NONE
Example	-> :SCR:COUN? <- 1 -> :SCReen:COUNt? <- 1

:SCReen:ADD¶

Syntax	:SCReen:ADD
Description	Add a new screen
Explanation	Appends a new empty screen to the existing Oxygen measurement screen.
Example	-> :SCR:COUN? <- 3 -> :SCR:ADD -> :SCR:COUN? <- 4

:SCReen:SELect?¶

Syntax	:SCReen:SELect?
Description	Queries the selected screen.
Explanation	Returns the screen number of the selected Oxygen screen.
Return Format	<integer> \| NONE
Example	-> :SCR:SEL? <- 2 -> :SCReen:SELect? <- 2

:SCReen:ITEM<screen_number>:SELect¶

Syntax	:SCReen:ITEM<screen_number>:SEL
Description	Switches the current Oxygen screen window to the screen with <screen_number>.
Example	-> :SCR:SEL? <- 3 -> :SCR2:SEL <- :SCR:SEL? -> 2

:SCReen:SAVE “PATH”¶

Syntax

:SCReen:SAVE [<path>]

Description

Saves the current screen to a PNG file.

Parameter

Name	Type	Range	Default
<path>	String	A valid filename for the PNG file. If no absolute path is specified, the file is stored in the Oxygen export folder.	A file starting with ‘screenshot’ and including the screen number and the current timestamp is generated in the Oxygen export folder.

Explanation

Saves the current Oxygen instruments screen to a PNG file.

Example

-> :SCReen:SAVE               //stores the current screen with number to file (e.g. "c:/export/screenshot_1_20230713_120948.png")
...
-> :SCReen:SAVE "xyz"         //stores the current screen to file (e.g. "c:/export/xyz.png")
...
-> :SCReen:SAVE "c:/temp/xyz" //stores the current screen to "c:/temp/xyz.png"

:SCReen:ITEM<screen_number>:SAVE “PATH”¶

Syntax

:SCReen:ITEM<screen_number>:SAVE [<path>]

Description

Saves the screen to a PNG file.

Parameter

Name	Type	Range	Default
<path>	String	A valid filename for the PNG file. If no absolute path is specified, the file is stored in the Oxygen export folder.	A file starting with ‘screenshot’ and including the screen number and the current timestamp is generated in the Oxygen export folder.

Explanation

Saves the Oxygen instruments screen with the given <screen_number> to a PNG file. The <screen_number> should be a valid Oxygen instrument screen (1 - 32768)

Example

-> :SCReen:ITEM1:SAVE               //stores screen number 1 to file (e.g. "c:/export/screenshot_1_20230713_120948.png")
...
-> :SCReen:ITEM2:SAVE "xyz"         //stores screen number 2 to file (e.g. "c:/export/xyz.png")
...
-> :SCReen:ITEM3:SAVE "c:/temp/xyz" //stores screen number 3 to "c:/temp/xyz.png"

Screen Instrument Subsystem¶

Some commands and queries are screen-specific and cannot be accessed through the ‘INSTRuments’ root subsystem. These operations require a valid screen number for execution.

SCReen:ITEM<screen_nr>:INSTRuments:COUNt?¶

Syntax	:SCReen:ITEM<screen_number>:INSTRuments:COUNt?
Description	Queries the number of instruments on the measurement screen with index <screen_number>.
Return Format	<integer>> \| NONE
Example	-> :SCR2:INSTR:COUN? <- 1 -> :SCReen:ITEM1:INSTRuments:COUNt? //equivalent long form <- 1

:SCReen:ITEM<screen_number>:INSTRuments:GET?¶

Syntax	:SCReen:ITEM<screen_number>:INSTRuments:GET?
Description	Queries all instruments on the measurement screen by index.
Explanation	Returns a list of all instruments contained on the screen with index <screen_number>.
Return Format	(<instrument_number>,<type>,<key>)[,(<instrument_number>,<type>,<key>)[,…]] \| NONE <instrument_number>: <integer> index number of the instrument on the screen <type>: instrument type as <String> <key>: alphanumeric key <String> of the instrument. Note: The instrument key serves as a unique identifier within the root subsystem “:INSTRuments”, allowing the identification of a specific instrument regardless of its owner.
Example	-> :SCR1:INSTR:GET? <- (1,"recorder","rec01"),(2,"analog","ana01"),(3,"saturation_meter","sat") ... -> :SCReen:ITEM1:INSTRuments:GET? <- (1,"recorder","rec01"),(2,"analog","ana01"),(3,"saturation_meter","sat")

:SCReen:ITEM<screen_number>:INSTRuments:ITEM<instrument_number>:IDEntifier?¶

Syntax	:SCReen:ITEM<screen_number>:INSTRuments:ITEM<instrument_number>:IDEentifier?
Description	Queries the identification of an instrument on the screen.
Explanation	Returns the instrument_identifier of the instrument at index <instrument_number> on the screen <screen_number> The index number is required to identify an instrument on a specified screen. Note: The instrument key serves as a unique identifier within the root subsystem “:INSTRuments”, allowing the identification of a specific instrument regardless of its owner.
Return Format	(STRING,<String>) \| NONE
Example	-> :SCR1:INSTR1:IDE? <- (STRING,"rec01") ... -> :SCR1:INSTR1:IDE? <- NONE

:SCReen:ITEM<screen_number>:INSTRuments:ADD [<type>[,<identification>[,<x-position>,<y-position>]]]¶

Syntax

:SCReen:ITEM<screen_number>:INSTRuments:ADD [<type>[,<identification>[,<x-position>,<y-position>]]]

Description

Creates a new instrument on screen <screen_number> of type <type>.

Parameter

Name	Type	Range	Default
Instrument Type	ASCII String	valid instrument types are: “analog”, “digital”, “bar”, “indicator”, “array”, “image_display”, “recorder”, “chart_recorder”, “3d_plot”, “audioplayer”, “control”, “gpsplot”, “gpsquality”, “intensity_diagram”, “modal_test”, “nyqist”, “orbitplot”, “output_channel”, “PolarPlot”, “saturation_meter”, “scope”, “spectrogram”, “spectrum_analyzer”, “table”, “tablepreview”, “tabular”, “text_display”
Instrument Identifier (optional)	Alphanumeric Ascci String	A-Z,a-z,0-9
X-Position (optional)	numeric	0.0 - 1.0	0.0
Y-Position (optional)	numeric	0.0 - 1.0	0.0

Explanation

Creates a new instrument <type> on screen <screen_number> at position <x-position> and <y-position>.

The specified instrument <identification> is forwarded to the target instrument. The <identification> can be used to reference the created instrument in serveral commands and queries, regardless of which screen, report or group contains this created instrument. If no <identification> is specified a new unique identification is generated.

The <x-position> and <y-position> are the positions of the top-left edge of the created instrument on the screen.

Example

-> :SCR1:INSTR:ADD "digital"
-> ...
-> :SCR1:INSTR:ADD "analog","ANALOG1"
-> ...
-> :SCR1:INSTR:ADD "saturation_meter","Sat002",0.5,0.5

:SCReen:ITEM<screen_number>:INSTRuments:SELect?¶

Syntax	:SCReen:ITEM<screen_number>:INSTRuments:SELect?
Description	Queries the index number of the selected instrument.
Return Format	<integer> \| NONE
Example	-> :SCR1:INSTR:SEL? <- 1 -> :SCReen:ITEM1:INSTRuments:SELect? //equivalent long form <- 1 -> :SCR2:INSTR:SEL? <- NONE

:SCReen:ITEM<screen_nr>:INSTRuments:SELect [<integer> | <literal>]¶

Syntax

:SCReen:ITEM<screen_nr>:INSTRuments:SELect [<integer> | <literal>]

Description

Add a single instrument to the instrument selection list.

Parameter

Name	Type	Range	Default
<integer>		>= 0	None
<literal>		NONE

Explanation

This command is used to add an instrument to the instrument selection list. Note: NONE clears the instrument selection (see example below).

Example

-> :SCR1:INSTR:SEL?
<- 1
-> :SCR1:INSTR:SEL NONE
-> :SCR1:INSTR:SEL?
-> NONE

Screen Output Instrument Subsystem¶

Since instruments are now directly accessible through this screen subsystem, the following commands and queries are deprecated. A command like

:SCR:INSTR:OUT:STAR

refers to

:SCR1:INSTR1:OUT:STAR

which is the first instrument on screen 1.

For backward compatibility, the deprecated algorithm remains functional if the first instrument on screen 1 is not an output instrument.

:SCReen:INSTRuments:OUTputchannel:STARt (deprecated)¶

Syntax	:SCReen:INSTRuments:OUTputchannel:STARt
Description	Start streaming to analog out channels.
Parameter	None
Explanation	Starts streaming on the default stream output instrument if it is in the Paused or Stopped states. The default instrument is the oldest output channel instrument instance, on the measurement screen with the lowest index, that is configured for replay mode. Note: For backward compatibility, the algorithm remains functional if the first instrument on Screen 1 is not an output instrument.
Example	-> :SCReen:INSTRuments:OUTputchannel:STARt

:SCReen:INSTRuments:OUTputchannel:PAUSE (deprecated)¶

Syntax	:SCReen:INSTRuments:OUTputchannel:PAUSE
Description	Stop streaming to analog out channels.
Parameter	None
Explanation	Stop sending data on the default stream output instrument that is in the Started state. Note: For backward compatibility, the algorithm remains functional if the first instrument on Screen 1 is not an output instrument.
Example	-> :SCReen:INSTRuments:OUTputchannel:PAUSE

:SCReen:INSTRuments:OUTputchannel:STOP (deprecated)¶

Syntax	:SCReen:INSTRuments:OUTputchannel:STOP
Description	Stop streaming to analog out channels.
Parameter	None
Explanation	Stop sending data on the default stream output instrument that is in the Started state. Then reset the playback cursor to the start position. Note: For backward compatibility, the algorithm remains functional if the first instrument on Screen 1 is not an output instrument.
Example	-> :SCReen:INSTRuments:OUTputchannel:STOP

:SCReen:INSTRuments:OUTputchannel:STATe? (deprecated)¶

Syntax	:SCReen:INSTRuments:OUTputchannel:STATe?
Description	Query the current state of the output channel instrument.
Parameter	None
Explanation	Returns the instrument state as a string: Not_found -> no stream output instrument found on the measurement screens Configuration_error -> instrument is not correctly set up and cannot be used Blocked -> another instrument instance is currently playing Started -> the instrument is streaming dmd data Paused -> the instrument does not stream Stopped -> the instrument does not stream, stream will start at the beginning Active -> the instrument continuously sends data; not used for stream output Error Note: For backward compatibility, the algorithm remains functional if the first instrument on Screen 1 is not an output instrument.
Return format	<String>
Example	-> :SCReen:INSTRuments:OUTputchannel:STARt -> :SCReen:INSTRuments:OUTputchannel:STATe? <- Started