[python source code]

pilogger

The pilogger commands module.

These commands are used in the following models: DPO7AX, LPD6, MSO4, MSO4B, MSO5, MSO5B, MSO5LP, MSO6, MSO6B

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

Please report an issue if one is found.

Commands and Queries 
- PILOGger:FILEName <QString>
- PILOGger:FILEName?
- PILOGger:STATE {ON|OFF|<NR1>}
- PILOGger:STATE?

Pilogger

Bases: SCPICmdRead

The PILOGger command tree.

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

filename property 

filename: PiloggerFilename

Return the PILOGger:FILEName command.

Description
  • This command sets or queries the location where the programmatic interface command log will be saved.
Usage
  • Using the .query() method will send the PILOGger:FILEName? query.
  • Using the .verify(value) method will send the PILOGger:FILEName? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the PILOGger:FILEName value command.
SCPI Syntax 
- PILOGger:FILEName <QString>
- PILOGger:FILEName?
Info
  • <QString> is a quoted string that defines the file path that specifies the location to save the command log, in the format ‘[]‘. Specifying a path is optional. If no path is entered, the instrument will search in the current working directory as set in FILESystem:CWD.

state property 

state: PiloggerState

Return the PILOGger:STATE command.

Description
  • This command sets or queries the state of the programmatic interface command log. If the location specified by PILOGger:FILEName does not exist or is not writable, attempts to turn the PI command logger ON will fail, and the state will be set to 0 (OFF).
Usage
  • Using the .query() method will send the PILOGger:STATE? query.
  • Using the .verify(value) method will send the PILOGger:STATE? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the PILOGger:STATE value command.
SCPI Syntax 
- PILOGger:STATE {ON|OFF|<NR1>}
- PILOGger:STATE?
Info
  • <NR1> = 0 disables the PI command logger; any other value turns the PI command logger on.
  • OFF disables the PI command logger.
  • ON enables the PI command logger.

PiloggerFilename

Bases: SCPICmdWrite, SCPICmdRead

The PILOGger:FILEName command.

Description
  • This command sets or queries the location where the programmatic interface command log will be saved.
Usage
  • Using the .query() method will send the PILOGger:FILEName? query.
  • Using the .verify(value) method will send the PILOGger:FILEName? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the PILOGger:FILEName value command.
SCPI Syntax 
- PILOGger:FILEName <QString>
- PILOGger:FILEName?
Info
  • <QString> is a quoted string that defines the file path that specifies the location to save the command log, in the format ‘[]‘. Specifying a path is optional. If no path is entered, the instrument will search in the current working directory as set in FILESystem:CWD.

PiloggerState

Bases: SCPICmdWrite, SCPICmdRead

The PILOGger:STATE command.

Description
  • This command sets or queries the state of the programmatic interface command log. If the location specified by PILOGger:FILEName does not exist or is not writable, attempts to turn the PI command logger ON will fail, and the state will be set to 0 (OFF).
Usage
  • Using the .query() method will send the PILOGger:STATE? query.
  • Using the .verify(value) method will send the PILOGger:STATE? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the PILOGger:STATE value command.
SCPI Syntax 
- PILOGger:STATE {ON|OFF|<NR1>}
- PILOGger:STATE?
Info
  • <NR1> = 0 disables the PI command logger; any other value turns the PI command logger on.
  • OFF disables the PI command logger.
  • ON enables the PI command logger.