[python source code]

system

The system commands module.

These commands are used in the following models: AWG70KA, AWG70KB

THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED.

Please report an issue if one is found.

Commands and Queries 
- SYSTem:DATE <year>,<month>,<day>
- SYSTem:DATE?
- SYSTem:ERRor:ALL?
- SYSTem:ERRor:CODE:ALL?
- SYSTem:ERRor:CODE:NEXT?
- SYSTem:ERRor:COUNt?
- SYSTem:ERRor:DIALog <show_dialog>
- SYSTem:ERRor:DIALog?
- SYSTem:ERRor:NEXT?
- SYSTem:SID:GATeway <address>
- SYSTem:SID:GATeway?
- SYSTem:SID:IP <address>
- SYSTem:SID:IP?
- SYSTem:SID:MAC?
- SYSTem:TIME <hour>,<minute>,<second>
- SYSTem:TIME?
- SYSTem:VERSion?

System

Bases: SCPICmdRead

The SYSTem command tree.

Usage
  • Using the .query() method will send the SYSTem? query.
  • Using the .verify(value) method will send the SYSTem? query and raise an AssertionError if the returned value does not match value.
Properties
  • .date: The SYSTem:DATE command.
  • .error: The SYSTem:ERRor command tree.
  • .sid: The SYSTem:SID command tree.
  • .time: The SYSTem:TIME command.
  • .version: The SYSTem:VERSion command.

date property 

date: SystemDate

Return the SYSTem:DATE command.

Description
  • This command sets or returns the system date. When the values are nonintegers, they are rounded off to nearest integral values.
Usage
  • Using the .query() method will send the SYSTem:DATE? query.
  • Using the .verify(value) method will send the SYSTem:DATE? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the SYSTem:DATE value command.
SCPI Syntax 
- SYSTem:DATE <year>,<month>,<day>
- SYSTem:DATE?

error property 

error: SystemError

Return the SYSTem:ERRor command tree.

Usage
  • Using the .query() method will send the SYSTem:ERRor? query.
  • Using the .verify(value) method will send the SYSTem:ERRor? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .all: The SYSTem:ERRor:ALL command.
  • .code: The SYSTem:ERRor:CODE command tree.
  • .count: The SYSTem:ERRor:COUNt command.
  • .dialog: The SYSTem:ERRor:DIALog command.
  • .next: The SYSTem:ERRor:NEXT command.

sid property 

sid: SystemSid

Return the SYSTem:SID command tree.

Usage
  • Using the .query() method will send the SYSTem:SID? query.
  • Using the .verify(value) method will send the SYSTem:SID? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .gateway: The SYSTem:SID:GATeway command.
  • .ip: The SYSTem:SID:IP command.
  • .mac: The SYSTem:SID:MAC command.

time property 

time: SystemTime

Return the SYSTem:TIME command.

Description
  • This command sets or returns the system time (hours, minutes and seconds). This command is equivalent to the time setting through the Windows Control Panel.
Usage
  • Using the .query() method will send the SYSTem:TIME? query.
  • Using the .verify(value) method will send the SYSTem:TIME? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the SYSTem:TIME value command.
SCPI Syntax 
- SYSTem:TIME <hour>,<minute>,<second>
- SYSTem:TIME?

version property 

version: SystemVersion

Return the SYSTem:VERSion command.

Description
  • This query-only command returns the conformed SCPI version of the instrument.
Usage
  • Using the .query() method will send the SYSTem:VERSion? query.
  • Using the .verify(value) method will send the SYSTem:VERSion? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- SYSTem:VERSion?

SystemDate

Bases: SCPICmdWrite, SCPICmdRead

The SYSTem:DATE command.

Description
  • This command sets or returns the system date. When the values are nonintegers, they are rounded off to nearest integral values.
Usage
  • Using the .query() method will send the SYSTem:DATE? query.
  • Using the .verify(value) method will send the SYSTem:DATE? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the SYSTem:DATE value command.
SCPI Syntax 
- SYSTem:DATE <year>,<month>,<day>
- SYSTem:DATE?

SystemErrorAll

Bases: SCPICmdRead

The SYSTem:ERRor:ALL command.

Description
  • This command returns the error and event queue for all the unread items and removes them from the queue.
Usage
  • Using the .query() method will send the SYSTem:ERRor:ALL? query.
  • Using the .verify(value) method will send the SYSTem:ERRor:ALL? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- SYSTem:ERRor:ALL?

SystemErrorCmd

Bases: SCPICmdRead

The SYSTem:ERRor command tree.

Usage
  • Using the .query() method will send the SYSTem:ERRor? query.
  • Using the .verify(value) method will send the SYSTem:ERRor? query and raise an AssertionError if the returned value does not match value.
Properties
  • .all: The SYSTem:ERRor:ALL command.
  • .code: The SYSTem:ERRor:CODE command tree.
  • .count: The SYSTem:ERRor:COUNt command.
  • .dialog: The SYSTem:ERRor:DIALog command.
  • .next: The SYSTem:ERRor:NEXT command.

all property 

all: SystemErrorAll

Return the SYSTem:ERRor:ALL command.

Description
  • This command returns the error and event queue for all the unread items and removes them from the queue.
Usage
  • Using the .query() method will send the SYSTem:ERRor:ALL? query.
  • Using the .verify(value) method will send the SYSTem:ERRor:ALL? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- SYSTem:ERRor:ALL?

code property 

code: SystemErrorCode

Return the SYSTem:ERRor:CODE command tree.

Usage
  • Using the .query() method will send the SYSTem:ERRor:CODE? query.
  • Using the .verify(value) method will send the SYSTem:ERRor:CODE? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .all: The SYSTem:ERRor:CODE:ALL command.
  • .next: The SYSTem:ERRor:CODE:NEXT command.

count property 

count: SystemErrorCount

Return the SYSTem:ERRor:COUNt command.

Description
  • This command returns the error and event queue for the number of unread items.
Usage
  • Using the .query() method will send the SYSTem:ERRor:COUNt? query.
  • Using the .verify(value) method will send the SYSTem:ERRor:COUNt? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- SYSTem:ERRor:COUNt?

dialog property 

dialog: SystemErrorDialog

Return the SYSTem:ERRor:DIALog command.

Description
  • This command enables or disables error dialogs from displaying on the UI when an error condition occurs on the AWG.
Usage
  • Using the .query() method will send the SYSTem:ERRor:DIALog? query.
  • Using the .verify(value) method will send the SYSTem:ERRor:DIALog? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the SYSTem:ERRor:DIALog value command.
SCPI Syntax 
- SYSTem:ERRor:DIALog <show_dialog>
- SYSTem:ERRor:DIALog?
Info
  • *RST sets this value to 1.

next property 

next: SystemErrorNext

Return the SYSTem:ERRor:NEXT command.

Description
  • This query-only command returns the contents of the Error/Event queue.
Usage
  • Using the .query() method will send the SYSTem:ERRor:NEXT? query.
  • Using the .verify(value) method will send the SYSTem:ERRor:NEXT? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- SYSTem:ERRor:NEXT?

SystemErrorCode

Bases: SCPICmdRead

The SYSTem:ERRor:CODE command tree.

Usage
  • Using the .query() method will send the SYSTem:ERRor:CODE? query.
  • Using the .verify(value) method will send the SYSTem:ERRor:CODE? query and raise an AssertionError if the returned value does not match value.
Properties
  • .all: The SYSTem:ERRor:CODE:ALL command.
  • .next: The SYSTem:ERRor:CODE:NEXT command.

all property 

all: SystemErrorCodeAll

Return the SYSTem:ERRor:CODE:ALL command.

Description
  • This command returns the error and event queue for the codes of all the unread items and removes them from the queue.
Usage
  • Using the .query() method will send the SYSTem:ERRor:CODE:ALL? query.
  • Using the .verify(value) method will send the SYSTem:ERRor:CODE:ALL? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- SYSTem:ERRor:CODE:ALL?

next property 

next: SystemErrorCodeNext

Return the SYSTem:ERRor:CODE:NEXT command.

Description
  • This command returns the error and event queue for the next item and removes it from the queue.
Usage
  • Using the .query() method will send the SYSTem:ERRor:CODE:NEXT? query.
  • Using the .verify(value) method will send the SYSTem:ERRor:CODE:NEXT? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- SYSTem:ERRor:CODE:NEXT?

SystemErrorCodeAll

Bases: SCPICmdRead

The SYSTem:ERRor:CODE:ALL command.

Description
  • This command returns the error and event queue for the codes of all the unread items and removes them from the queue.
Usage
  • Using the .query() method will send the SYSTem:ERRor:CODE:ALL? query.
  • Using the .verify(value) method will send the SYSTem:ERRor:CODE:ALL? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- SYSTem:ERRor:CODE:ALL?

SystemErrorCodeNext

Bases: SCPICmdRead

The SYSTem:ERRor:CODE:NEXT command.

Description
  • This command returns the error and event queue for the next item and removes it from the queue.
Usage
  • Using the .query() method will send the SYSTem:ERRor:CODE:NEXT? query.
  • Using the .verify(value) method will send the SYSTem:ERRor:CODE:NEXT? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- SYSTem:ERRor:CODE:NEXT?

SystemErrorCount

Bases: SCPICmdRead

The SYSTem:ERRor:COUNt command.

Description
  • This command returns the error and event queue for the number of unread items.
Usage
  • Using the .query() method will send the SYSTem:ERRor:COUNt? query.
  • Using the .verify(value) method will send the SYSTem:ERRor:COUNt? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- SYSTem:ERRor:COUNt?

SystemErrorDialog

Bases: SCPICmdWrite, SCPICmdRead

The SYSTem:ERRor:DIALog command.

Description
  • This command enables or disables error dialogs from displaying on the UI when an error condition occurs on the AWG.
Usage
  • Using the .query() method will send the SYSTem:ERRor:DIALog? query.
  • Using the .verify(value) method will send the SYSTem:ERRor:DIALog? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the SYSTem:ERRor:DIALog value command.
SCPI Syntax 
- SYSTem:ERRor:DIALog <show_dialog>
- SYSTem:ERRor:DIALog?
Info
  • *RST sets this value to 1.

SystemErrorNext

Bases: SCPICmdRead

The SYSTem:ERRor:NEXT command.

Description
  • This query-only command returns the contents of the Error/Event queue.
Usage
  • Using the .query() method will send the SYSTem:ERRor:NEXT? query.
  • Using the .verify(value) method will send the SYSTem:ERRor:NEXT? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- SYSTem:ERRor:NEXT?

SystemSid

Bases: SCPICmdRead

The SYSTem:SID command tree.

Usage
  • Using the .query() method will send the SYSTem:SID? query.
  • Using the .verify(value) method will send the SYSTem:SID? query and raise an AssertionError if the returned value does not match value.
Properties
  • .gateway: The SYSTem:SID:GATeway command.
  • .ip: The SYSTem:SID:IP command.
  • .mac: The SYSTem:SID:MAC command.

gateway property 

gateway: SystemSidGateway

Return the SYSTem:SID:GATeway command.

Description
  • This command sets or returns the gateway address of the Streaming ID Ethernet port.
Usage
  • Using the .query() method will send the SYSTem:SID:GATeway? query.
  • Using the .verify(value) method will send the SYSTem:SID:GATeway? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the SYSTem:SID:GATeway value command.
SCPI Syntax 
- SYSTem:SID:GATeway <address>
- SYSTem:SID:GATeway?

ip property 

ip: SystemSidIp

Return the SYSTem:SID:IP command.

Description
  • This command sets or returns the IP address of the Streaming ID Ethernet port.
Usage
  • Using the .query() method will send the SYSTem:SID:IP? query.
  • Using the .verify(value) method will send the SYSTem:SID:IP? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the SYSTem:SID:IP value command.
SCPI Syntax 
- SYSTem:SID:IP <address>
- SYSTem:SID:IP?

mac property 

mac: SystemSidMac

Return the SYSTem:SID:MAC command.

Description
  • This command returns the MAC address of the Streaming ID port.
Usage
  • Using the .query() method will send the SYSTem:SID:MAC? query.
  • Using the .verify(value) method will send the SYSTem:SID:MAC? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- SYSTem:SID:MAC?

SystemSidGateway

Bases: SCPICmdWrite, SCPICmdRead

The SYSTem:SID:GATeway command.

Description
  • This command sets or returns the gateway address of the Streaming ID Ethernet port.
Usage
  • Using the .query() method will send the SYSTem:SID:GATeway? query.
  • Using the .verify(value) method will send the SYSTem:SID:GATeway? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the SYSTem:SID:GATeway value command.
SCPI Syntax 
- SYSTem:SID:GATeway <address>
- SYSTem:SID:GATeway?

SystemSidIp

Bases: SCPICmdWrite, SCPICmdRead

The SYSTem:SID:IP command.

Description
  • This command sets or returns the IP address of the Streaming ID Ethernet port.
Usage
  • Using the .query() method will send the SYSTem:SID:IP? query.
  • Using the .verify(value) method will send the SYSTem:SID:IP? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the SYSTem:SID:IP value command.
SCPI Syntax 
- SYSTem:SID:IP <address>
- SYSTem:SID:IP?

SystemSidMac

Bases: SCPICmdRead

The SYSTem:SID:MAC command.

Description
  • This command returns the MAC address of the Streaming ID port.
Usage
  • Using the .query() method will send the SYSTem:SID:MAC? query.
  • Using the .verify(value) method will send the SYSTem:SID:MAC? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- SYSTem:SID:MAC?

SystemTime

Bases: SCPICmdWrite, SCPICmdRead

The SYSTem:TIME command.

Description
  • This command sets or returns the system time (hours, minutes and seconds). This command is equivalent to the time setting through the Windows Control Panel.
Usage
  • Using the .query() method will send the SYSTem:TIME? query.
  • Using the .verify(value) method will send the SYSTem:TIME? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the SYSTem:TIME value command.
SCPI Syntax 
- SYSTem:TIME <hour>,<minute>,<second>
- SYSTem:TIME?

SystemVersion

Bases: SCPICmdRead

The SYSTem:VERSion command.

Description
  • This query-only command returns the conformed SCPI version of the instrument.
Usage
  • Using the .query() method will send the SYSTem:VERSion? query.
  • Using the .verify(value) method will send the SYSTem:VERSion? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- SYSTem:VERSion?