Application Control

Setup

:SETup:LOAD

Syntax

:SETup:LOAD <file_name>|<path>

Description

Load specified setup file of the current configuration directory or an absolute path

Parameter

Name

Type

Range

Default

<file_name>

String

The filename of the setup file in the default directory (data folder)

None

<path>

String

The absolute path of the setup file to load

None

Explanation

This command loads a setup (measurement configuration) file from the current configuration location or an absolute path and applies it directly. The <file_name> does not need to include the file extension “.dms”.

Example

-> :SETup:LOAD "setup1.dms"
<- :SETup:LOAD "C:DATAsetup1.dms"

:SETup:APPLY “XML-String”

Syntax

:SETup:APPLY #<num_int><num_char><xml_setup>

Description

Upload a measurement setup to device and apply it

Parameter

Name

Type

Range

Default

<num_int>

NR1

Number of Integers following after this Integer 1 to 9

None

<num_int>

NR1

Number of Characters to be transferred 1 to 999999999

None

<xml_setup>

Arbitrary Data

Setup data (XML format)

None

Explanation

This command uploads a measurement setup to the device and applies it after transfer complete. The measurement setup is a XML-String which can be downloaded via :SETUP:READ?.

Example

-> :SETup:APPLY #41234...

Related Commands

:SETup:READ?

:SETup:SAVE “Path”

Syntax

:SETup:SAVE <file_name>|<path>

Description

Saves to current setup to the specified file in the current configuration directory or to an absolute path

Parameter

Name

Type

Range

Default

<file_name>

String

The filename of the setup file in the default directory (data folder)

None

<path>

String

The absolute path of the setup file

None

Explanation

This command loads a setup (measurement configuration) file from the current configuration location or an absolute path and applies it directly. The <file_name> does not need to include the file extension “.dms”.

Example

-> :SETup:SAVE "setup1.dms"
<- :SETup:SAVE "C:DATAsetup1.dms"

:SETup:READ?

Syntax

:SETup:READ? [<path>]

Description

Download the current measurement setup or, if a path is specified, the measurement setup referenced to path from the device

Parameter

Name

Type

Range

Default

<path>

String

The absolute path of the setup file to read (XML)

None

Explanation

Download the current measurement setup or, if a path is specified, the measurement setup referenced to path from the device.

Return Format

<Arbitrary Data>

Example

-> :SETup:READ?
<- #43432........
...
-> :SETup:READ? "C:Datatest.dms"
<- #41242........

Related Commands

:SETup:LOAD
:SETup:APPLY

: SETup:NAMe?

Syntax

:SETup:NAMe?

Description

Get name of the current loaded oxygen setup

Parameter

None

Explanation

This query returns the filename of the current loaded setup file

Return Format

<String> | NONE

Example

-> :SETup:NAMe?
<- :SET:NAM "D:/DATA/last.dms"

:SETup:ASync:LOAD “Path”

Syntax

:SETup:ASync:LOAD <file_name>|<path>

Description

Starts loading a specified setup file of the current configuration directory or an absolute path

Parameter

Name

Type

Range

Default

<file_name>

String

The filename of the setup file in the default directory (data folder)

None

<path>

String

The absolute path of the setup file to load

None

Explanation

This command asynchronously loads a setup (measurement configuration) file from the current configuration location or an absolute path and applies it. The <file_name> does not need to include the file extension “.dms”.

Since this command only starts loading, other device commands or queries could be invalid or causes problems, when the loading is not finished yet.

Use the query “:SETup:ASync:STATE?” (see next command) to acquire the state of the loading operation.

Example

-> :SETup:ASync::LOAD "setup1.dms"
<- :SETup:ASync::LOAD "C:DATAsetup1.dms"

:SETup:ASync:STATe?

Syntax

:SETup:ASync:STATe?

Description

Queries the state of the last async load configuration operation

Parameter

None

Explanation

This command queries the state of the last async config load operation. The state could be

  • IDLE

  • LOADing

Some execution errors are added, if the load operation is not finished correctly.

Return Format

<String>

Example

-> :SETup:ASync::STATe?
<- IDLE
-> :SETup:ASync::LOAD "C:DATAsetup1.dms"
-> :SETup:ASync::STATe?
<- LOAD
-> :SETup:ASync::STATe?
<- LOAD
...
-> :SETup:ASync::STATe?
<- IDLE
...
-> :SETup:ASync::LOAD "C:DATAUnknown.dms"
-> :SETup:ASync::STATe?
<- IDLE
-> :SYST:ERR:ALL?
<- -256, "File name not found"

UI Control

:SYSTem:DATE?

Syntax

:SYSTem:DATE?

Description

Queries the system date

Parameter

None

Explanation

Returns the system date in the form <year>,<month>,<day>

  • <year>: INTEGER, four digit number

  • <month>: INTEGER with the range 1 to 12

  • <day>: INTEGER with the range 1 to 31

Return Format

<NR1>,<NR1>,<NR1>

Example

-> :SYSTem:DATE?
<- 2017,07,25

Related Commands

:SYSTem:TIME?
:SYSTem:TZONE?

:SYSTem:KLOCK {ON|OFF}

Syntax

:SYSTem:KLOCK {ON|1|OFF|0}

Description

Locks/Unlocks the Screen

Parameter

Name

Type

Range

Default

{ON|1|OFF|0}

Boolean

ON|1|OFF|0

None

Explanation

Locks/Unlocks the Screen of Oxygen Software

Example

-> :SYSTem:KLOCK ON
-> :SYSTem:KLOCK OFF

Related Commands

-> :SYSTem:KLOCK?

:SYSTem:KLOCK?

Syntax

:SYSTem:KLOCK?

Description

Queries the Screen Lock status

Parameter

None

Explanation

Queries the Screen Lock status

Return Format

<Boolean>

Example

-> :SYSTem:KLOCK ON
-> :SYSTem:KLOCK?
<- 1

Related Commands

-> :SYSTem:KLOCK

:SYSTem:TIME?

Syntax

:SYSTem:TIME?

Description

Queries the system time

Parameter

None

Explanation

Returns the local system time in the form <hour>,<minute>,<second>

  • <hour>: INTEGER with the range 0 to +23

  • <minute>: INTEGER with the range 0 to 59

  • <second>: INTEGER with the range 0 to 59.99999…

If Acquisition is not running, :SYSTEM:TIME returns the last known Time

Return Format

<Boolean>

Example

-> :SYSTem:TIME?
<- 17,31,1.0237

Related Commands

:SYSTem:DATE?
:SYSTem:TZONE?

:SYSTem:TZONE?

Syntax

:SYSTem:TZONE?

Description

Queries the system time zone

Parameter

None

Explanation

Returns the system time zone offset in the form <hour>,<minute>

  • <hour>: INTEGER with the range 0 to +23

  • <minute>: INTEGER with the range 0 to 59

When each field is subtracted from the value of the TIME command, the result is the correct universal coordinated time (also known as UCT, Zulu, Greenwich Mean Time). |

Return Format

<NR1>,<NR1>

Example

-> :SYSTem:TZONE?
<- 2,0

Related Commands

:SYSTem:DATE?
:SYSTem:TIME?

:COMMunicate:HEADer {ON|OFF}

Syntax

:COMMunicate:HEADer {ON|1|OFF|0}

Description

Sets whether query responses should generate an output for the header.

Parameter

Name

Type

Range

Default

{ON|1|OFF|0}

Boolean

ON|1|OFF|0

None

Explanation

Sets whether query responses include the header.

Example

-> :COMMunicate:HEADer ON
-> :SYSTem:TIME?
<- :SYSTEM:TIME 15,14,15.7644

Related Commands

:COMMunicate:HEADer?
:COMMUNICATE:VERBOSE

:COMMunicate:HEADer?

Syntax

:COMMunicate:HEADer?

Description

Queries the communication response header setting

Parameter

None

Explanation

Queries the setting whether the response includes the header or not

Return Format

<Boolean>

Example

-> :COMMunicate:HEADer?
<- 1

Related Commands

:COMMunicate:HEADer

:COMMunicate:VERBose {ON|OFF}

Syntax

:COMMunicate:VERBose {ON|1|OFF|0}

Description

Sets whether query responses should generate the long or short form of the header

Parameter

Name

Type

Range

Default

{ON|1|OFF|0}

Boolean

ON|1|OFF|0

None

Explanation

Sets whether query responses should generate the long or short form of the header

Example

-> :COMMunicate:HEADer ON
-> :COMMunicate:VERBose OFF
-> :SYSTem:TIME?
<- :SYST:TIME 15,14,15.7644
-> :COMMunicate:VERBose ON
-> :SYSTem:TIME?
<- :SYSTEM:TIME 15,14,32.7265

Related Commands

:COMMunicate:HEADer

:COMMunicate:VERBose?

Syntax

:COMMunicate:VERBose?

Description

Queries the setting, whether the response header is short or long form

Parameter

None

Explanation

Queries the setting, whether the response header is short or long form

Return Format

<Boolean>

Example

-> :COMMunicate:VERBose?
<- 1

Related Commands

:COMMunicate:VERBose