[python source code]

system

The system commands module.

These commands are used in the following models: AFG3K, AFG3KB, AFG3KC

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

Please report an issue if one is found.

Commands and Queries 
- SYSTem:BEEPer:IMMediate
- SYSTem:BEEPer:STATe {ON|OFF|<NR1>}
- SYSTem:BEEPer:STATe?
- SYSTem:ERRor:NEXT?
- SYSTem:KCLick:STATe {ON|OFF|<NR1>}
- SYSTem:KCLick:STATe?
- SYSTem:KLOCk:STATe {ON|OFF|<NR1>}
- SYSTem:KLOCk:STATe?
- SYSTem:PASSword:CDISable <password>
- SYSTem:PASSword:CENable <password>
- SYSTem:PASSword:CENable:STATe?
- SYSTem:PASSword:NEW <current_password>,<new_password>
- SYSTem:SECurity:IMMediate
- SYSTem:ULANguage {ENGLish|FRENch|GERMan|JAPanese|KORean|SCHinese|TCHinese|RUSSian}
- SYSTem:ULANguage?
- 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
  • .beeper: The SYSTem:BEEPer command tree.
  • .error: The SYSTem:ERRor command tree.
  • .kclick: The SYSTem:KCLick command tree.
  • .klock: The SYSTem:KLOCk command tree.
  • .password: The SYSTem:PASSword command tree.
  • .security: The SYSTem:SECurity command tree.
  • .ulanguage: The SYSTem:ULANguage command.
  • .version: The SYSTem:VERSion command.

beeper property 

beeper: SystemBeeper

Return the SYSTem:BEEPer command tree.

Usage
  • Using the .query() method will send the SYSTem:BEEPer? query.
  • Using the .verify(value) method will send the SYSTem:BEEPer? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .state: The SYSTem:BEEPer:STATe command.
  • .immediate: The SYSTem:BEEPer:IMMediate command.

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
  • .next: The SYSTem:ERRor:NEXT command.

kclick property 

kclick: SystemKclick

Return the SYSTem:KCLick command tree.

Usage
  • Using the .query() method will send the SYSTem:KCLick? query.
  • Using the .verify(value) method will send the SYSTem:KCLick? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .state: The SYSTem:KCLick:STATe command.

klock property 

klock: SystemKlock

Return the SYSTem:KLOCk command tree.

Usage
  • Using the .query() method will send the SYSTem:KLOCk? query.
  • Using the .verify(value) method will send the SYSTem:KLOCk? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .state: The SYSTem:KLOCk:STATe command.

password property 

password: SystemPassword

Return the SYSTem:PASSword command tree.

Usage
  • Using the .query() method will send the SYSTem:PASSword? query.
  • Using the .verify(value) method will send the SYSTem:PASSword? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .cdisable: The SYSTem:PASSword:CDISable command.
  • .new: The SYSTem:PASSword:NEW command.
  • .cenable: The SYSTem:PASSword:CENable command.

security property 

security: SystemSecurity

Return the SYSTem:SECurity command tree.

Usage
  • Using the .query() method will send the SYSTem:SECurity? query.
  • Using the .verify(value) method will send the SYSTem:SECurity? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .immediate: The SYSTem:SECurity:IMMediate command.

ulanguage property 

ulanguage: SystemUlanguage

Return the SYSTem:ULANguage command.

Description
  • This command sets or queries the language that the instrument uses to display information on the screen.
Usage
  • Using the .query() method will send the SYSTem:ULANguage? query.
  • Using the .verify(value) method will send the SYSTem:ULANguage? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the SYSTem:ULANguage value command.
SCPI Syntax 
- SYSTem:ULANguage {ENGLish|FRENch|GERMan|JAPanese|KORean|SCHinese|TCHinese|RUSSian}
- SYSTem:ULANguage?

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?

SystemBeeper

Bases: SCPICmdRead

The SYSTem:BEEPer command tree.

Usage
  • Using the .query() method will send the SYSTem:BEEPer? query.
  • Using the .verify(value) method will send the SYSTem:BEEPer? query and raise an AssertionError if the returned value does not match value.
Properties
  • .state: The SYSTem:BEEPer:STATe command.
  • .immediate: The SYSTem:BEEPer:IMMediate command.

immediate property 

immediate: SystemBeeperImmediate

Return the SYSTem:BEEPer:IMMediate command.

Description
  • This command causes the instrument to beep immediately.
Usage
  • Using the .write() method will send the SYSTem:BEEPer:IMMediate command.
SCPI Syntax 
- SYSTem:BEEPer:IMMediate

state property 

state: SystemBeeperState

Return the SYSTem:BEEPer:STATe command.

Description
  • The SYSTem:BEEPer:STATe command sets the beeper ON or OFF. The SYSTem:BEEPer:STATe? command returns ‘0’ (OFF) or ‘1’ (ON). When the beeper is set to ON, the instrument will beep when an error message or a warning message is displayed on the screen. The instrument does not beep when an error or warning caused by remote command execution.
Usage
  • Using the .query() method will send the SYSTem:BEEPer:STATe? query.
  • Using the .verify(value) method will send the SYSTem:BEEPer:STATe? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the SYSTem:BEEPer:STATe value command.
SCPI Syntax 
- SYSTem:BEEPer:STATe {ON|OFF|<NR1>}
- SYSTem:BEEPer:STATe?

SystemBeeperImmediate

Bases: SCPICmdWriteNoArguments

The SYSTem:BEEPer:IMMediate command.

Description
  • This command causes the instrument to beep immediately.
Usage
  • Using the .write() method will send the SYSTem:BEEPer:IMMediate command.
SCPI Syntax 
- SYSTem:BEEPer:IMMediate

SystemBeeperState

Bases: SCPICmdWrite, SCPICmdRead

The SYSTem:BEEPer:STATe command.

Description
  • The SYSTem:BEEPer:STATe command sets the beeper ON or OFF. The SYSTem:BEEPer:STATe? command returns ‘0’ (OFF) or ‘1’ (ON). When the beeper is set to ON, the instrument will beep when an error message or a warning message is displayed on the screen. The instrument does not beep when an error or warning caused by remote command execution.
Usage
  • Using the .query() method will send the SYSTem:BEEPer:STATe? query.
  • Using the .verify(value) method will send the SYSTem:BEEPer:STATe? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the SYSTem:BEEPer:STATe value command.
SCPI Syntax 
- SYSTem:BEEPer:STATe {ON|OFF|<NR1>}
- SYSTem:BEEPer:STATe?

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
  • .next: The SYSTem:ERRor:NEXT command.

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?

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?

SystemKclick

Bases: SCPICmdRead

The SYSTem:KCLick command tree.

Usage
  • Using the .query() method will send the SYSTem:KCLick? query.
  • Using the .verify(value) method will send the SYSTem:KCLick? query and raise an AssertionError if the returned value does not match value.
Properties
  • .state: The SYSTem:KCLick:STATe command.

state property 

state: SystemKclickState

Return the SYSTem:KCLick:STATe command.

Description
  • This command enables or disables the click sound when you push the front panel buttons or turn the general purpose knob. The query command returns ‘0’ (OFF) or ‘1’ (ON).
Usage
  • Using the .query() method will send the SYSTem:KCLick:STATe? query.
  • Using the .verify(value) method will send the SYSTem:KCLick:STATe? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the SYSTem:KCLick:STATe value command.
SCPI Syntax 
- SYSTem:KCLick:STATe {ON|OFF|<NR1>}
- SYSTem:KCLick:STATe?

SystemKclickState

Bases: SCPICmdWrite, SCPICmdRead

The SYSTem:KCLick:STATe command.

Description
  • This command enables or disables the click sound when you push the front panel buttons or turn the general purpose knob. The query command returns ‘0’ (OFF) or ‘1’ (ON).
Usage
  • Using the .query() method will send the SYSTem:KCLick:STATe? query.
  • Using the .verify(value) method will send the SYSTem:KCLick:STATe? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the SYSTem:KCLick:STATe value command.
SCPI Syntax 
- SYSTem:KCLick:STATe {ON|OFF|<NR1>}
- SYSTem:KCLick:STATe?

SystemKlock

Bases: SCPICmdRead

The SYSTem:KLOCk command tree.

Usage
  • Using the .query() method will send the SYSTem:KLOCk? query.
  • Using the .verify(value) method will send the SYSTem:KLOCk? query and raise an AssertionError if the returned value does not match value.
Properties
  • .state: The SYSTem:KLOCk:STATe command.

state property 

state: SystemKlockState

Return the SYSTem:KLOCk:STATe command.

Description
  • This command locks or unlocks the instrument front panel controls. The query command returns ‘0’ (OFF) or ‘1’ (ON).
Usage
  • Using the .query() method will send the SYSTem:KLOCk:STATe? query.
  • Using the .verify(value) method will send the SYSTem:KLOCk:STATe? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the SYSTem:KLOCk:STATe value command.
SCPI Syntax 
- SYSTem:KLOCk:STATe {ON|OFF|<NR1>}
- SYSTem:KLOCk:STATe?

SystemKlockState

Bases: SCPICmdWrite, SCPICmdRead

The SYSTem:KLOCk:STATe command.

Description
  • This command locks or unlocks the instrument front panel controls. The query command returns ‘0’ (OFF) or ‘1’ (ON).
Usage
  • Using the .query() method will send the SYSTem:KLOCk:STATe? query.
  • Using the .verify(value) method will send the SYSTem:KLOCk:STATe? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the SYSTem:KLOCk:STATe value command.
SCPI Syntax 
- SYSTem:KLOCk:STATe {ON|OFF|<NR1>}
- SYSTem:KLOCk:STATe?

SystemPassword

Bases: SCPICmdRead

The SYSTem:PASSword command tree.

Usage
  • Using the .query() method will send the SYSTem:PASSword? query.
  • Using the .verify(value) method will send the SYSTem:PASSword? query and raise an AssertionError if the returned value does not match value.
Properties
  • .cdisable: The SYSTem:PASSword:CDISable command.
  • .new: The SYSTem:PASSword:NEW command.
  • .cenable: The SYSTem:PASSword:CENable command.

cdisable property 

cdisable: SystemPasswordCdisable

Return the SYSTem:PASSword:CDISable command.

Description
  • This command disables protected commands. The instrument security protection is activated. In the AFG3000 Series Arbitrary Function Generators, no remote commands are under the control of SYSTem:PASSword commands.
Usage
  • Using the .write(value) method will send the SYSTem:PASSword:CDISable value command.
SCPI Syntax 
- SYSTem:PASSword:CDISable <password>

cenable property 

cenable: SystemPasswordCenable

Return the SYSTem:PASSword:CENable command.

Description
  • This command enables protected commands to function. The instrument security protection is deactivated. In the AFG3000 Series Arbitrary Function Generators, no remote commands are under the control of SYSTem:PASSword commands.
Usage
  • Using the .write(value) method will send the SYSTem:PASSword:CENable value command.
SCPI Syntax 
- SYSTem:PASSword:CENable <password>
Sub-properties
  • .state: The SYSTem:PASSword:CENable:STATe command.

new property 

new: SystemPasswordNew

Return the SYSTem:PASSword:NEW command.

Description
  • This command changes the password.
Usage
  • Using the .write(value) method will send the SYSTem:PASSword:NEW value command.
SCPI Syntax 
- SYSTem:PASSword:NEW <current_password>,<new_password>

SystemPasswordCdisable

Bases: SCPICmdWrite

The SYSTem:PASSword:CDISable command.

Description
  • This command disables protected commands. The instrument security protection is activated. In the AFG3000 Series Arbitrary Function Generators, no remote commands are under the control of SYSTem:PASSword commands.
Usage
  • Using the .write(value) method will send the SYSTem:PASSword:CDISable value command.
SCPI Syntax 
- SYSTem:PASSword:CDISable <password>

SystemPasswordCenable

Bases: SCPICmdWrite, SCPICmdRead

The SYSTem:PASSword:CENable command.

Description
  • This command enables protected commands to function. The instrument security protection is deactivated. In the AFG3000 Series Arbitrary Function Generators, no remote commands are under the control of SYSTem:PASSword commands.
Usage
  • Using the .write(value) method will send the SYSTem:PASSword:CENable value command.
SCPI Syntax 
- SYSTem:PASSword:CENable <password>
Properties
  • .state: The SYSTem:PASSword:CENable:STATe command.

state property 

state: SystemPasswordCenableState

Return the SYSTem:PASSword:CENable:STATe command.

Description
  • This query-only command returns the security protection state.
Usage
  • Using the .query() method will send the SYSTem:PASSword:CENable:STATe? query.
  • Using the .verify(value) method will send the SYSTem:PASSword:CENable:STATe? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- SYSTem:PASSword:CENable:STATe?

SystemPasswordCenableState

Bases: SCPICmdRead

The SYSTem:PASSword:CENable:STATe command.

Description
  • This query-only command returns the security protection state.
Usage
  • Using the .query() method will send the SYSTem:PASSword:CENable:STATe? query.
  • Using the .verify(value) method will send the SYSTem:PASSword:CENable:STATe? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- SYSTem:PASSword:CENable:STATe?

SystemPasswordNew

Bases: SCPICmdWrite

The SYSTem:PASSword:NEW command.

Description
  • This command changes the password.
Usage
  • Using the .write(value) method will send the SYSTem:PASSword:NEW value command.
SCPI Syntax 
- SYSTem:PASSword:NEW <current_password>,<new_password>

SystemSecurity

Bases: SCPICmdRead

The SYSTem:SECurity command tree.

Usage
  • Using the .query() method will send the SYSTem:SECurity? query.
  • Using the .verify(value) method will send the SYSTem:SECurity? query and raise an AssertionError if the returned value does not match value.
Properties
  • .immediate: The SYSTem:SECurity:IMMediate command.

immediate property 

immediate: SystemSecurityImmediate

Return the SYSTem:SECurity:IMMediate command.

Description
  • This command erases all the current instrument setups, setup memory, last setup memory, user waveform memory, and log content, and recalls the factory default settings. Calibration data is not erased. The communication settings are initialized to the factory default settings. This might cause a remote communication error.
Usage
  • Using the .write() method will send the SYSTem:SECurity:IMMediate command.
SCPI Syntax 
- SYSTem:SECurity:IMMediate

SystemSecurityImmediate

Bases: SCPICmdWriteNoArguments

The SYSTem:SECurity:IMMediate command.

Description
  • This command erases all the current instrument setups, setup memory, last setup memory, user waveform memory, and log content, and recalls the factory default settings. Calibration data is not erased. The communication settings are initialized to the factory default settings. This might cause a remote communication error.
Usage
  • Using the .write() method will send the SYSTem:SECurity:IMMediate command.
SCPI Syntax 
- SYSTem:SECurity:IMMediate

SystemUlanguage

Bases: SCPICmdWrite, SCPICmdRead

The SYSTem:ULANguage command.

Description
  • This command sets or queries the language that the instrument uses to display information on the screen.
Usage
  • Using the .query() method will send the SYSTem:ULANguage? query.
  • Using the .verify(value) method will send the SYSTem:ULANguage? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the SYSTem:ULANguage value command.
SCPI Syntax 
- SYSTem:ULANguage {ENGLish|FRENch|GERMan|JAPanese|KORean|SCHinese|TCHinese|RUSSian}
- SYSTem:ULANguage?

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?