[python source code]

display

The display commands module.

These commands are used in the following models: SMU2601B_Pulse

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

Please report an issue if one is found.

Attributes and Functions 
- display.getlastkey()
- display.screen
- display.sendkey()
- display.smuX.digits
- display.smuX.limit.func
- display.smuX.measure.func
- display.waitkey()

Display

Bases: BaseTSPCmd

The display command tree.

Constants
  • .ANNUNCIATOR_4_WIRE: 4W indicator on.
  • .ANNUNCIATOR_ARM: ARM indicator on.
  • .ANNUNCIATOR_AUTO: AUTO indicator on.
  • .ANNUNCIATOR_EDIT: EDIT indicator on.
  • .ANNUNCIATOR_ERROR: ERR indicator on.
  • .ANNUNCIATOR_FILTER: FILT indicator on.
  • .ANNUNCIATOR_LISTEN: LSTN indicator on.
  • .ANNUNCIATOR_MATH: MATH indicator on.
  • .ANNUNCIATOR_REAR: REAR indicator on.
  • .ANNUNCIATOR_REL: REL indicator on.
  • .ANNUNCIATOR_REMOTE: REM indicator on.
  • .ANNUNCIATOR_SAMPLE: SMPL indicator on.
  • .ANNUNCIATOR_SRQ: SRQ indicator on.
  • .ANNUNCIATOR_STAR: * (asterisk) indicator on.
  • .ANNUNCIATOR_TALK: TALK indicator on.
  • .ANNUNCIATOR_TRIGGER: TRIG indicator on.
  • .DIGITS_4_5: Set the front-panel display resolution to 4.5 digits.
  • .DIGITS_5_5: Set the front-panel display resolution to 5.5 digits.
  • .DIGITS_6_5: Set the front-panel display resolution to 6.5 digits.
  • .DISABLE: Disable the front-panel keys for numeric entry when entering a value.
  • .DONT_SAVE: Do not save code to nonvolatile memory.
  • .ENABLE: Enable the front-panel keys for numeric entry when entering a value.
  • .KEY_AUTO: Represents the range AUTO key.
  • .KEY_CONFIG: Represents the CONFIG key.
  • .KEY_DIGITSA: Represents the DIGITS (display resolution) key. For two-channel products, this is the DIGITS key for Channel A.
  • .KEY_DISPLAY: Represents the DISPLAY key.
  • .KEY_ENTER: Represents the ENTER key.
  • .KEY_EXIT: Represents the EXIT key.
  • .KEY_FILTERA: Represents the FILTER key. For two-channel products, this is the FILTER key for Channel A.
  • .KEY_LEFT: Represents the left CURSOR key.
  • .KEY_LIMITA: Represents the LIMIT key. For two-channel products, this is the LIMIT key for Channel A.
  • .KEY_LOAD: Represents the LOAD (load test) key.
  • .KEY_MEASA: Represents the MEAS (Measure) key. For two-channel products, this is the MEAS key for Channel A.
  • .KEY_MENU: Represents the MENU key.
  • .KEY_MODEA: Represents the MODE (meter mode) key For two-channel products, this is the MODE key for Channel A.
  • .KEY_NONE: No key was pressed.
  • .KEY_OUTPUTA: Represents the OUTPUT ON/OFF key. For two-channel products, this is the OUTPUT ON/OFF key for Channel A.
  • .KEY_RANGEDOWN: Represents the RANGE down key.
  • .KEY_RANGEUP: Represents the RANGE up key.
  • .KEY_RECALL: Represents the RECALL key.
  • .KEY_RELA: Represents the REL key. For two-channel products, this is the REL key for Channel A.
  • .KEY_RIGHT: Represents the right CURSOR key.
  • .KEY_RUN: Represents the RUN key.
  • .KEY_SPEEDA: Represents the SPEED key. For two-channel products, this is the SPEED key for Channel A.
  • .KEY_SRCA: Represents the SRC (Source) key. For two-channel products, this is the SRC key for Channel A.
  • .KEY_STORE: Represents the STORE key.
  • .KEY_TRIG: Represents the TRIG key.
  • .LIMIT_IV: Display the primary limit value.
  • .LIMIT_P: Display the power limit value.
  • .LOCK: Unlock the EXIT (LOCAL) key.
  • .MEASURE_DCAMPS: Display the current measurement function.
  • .MEASURE_DCVOLTS: Display the voltage measurement function.
  • .MEASURE_OHMS: Display the resistance measurement function.
  • .MEASURE_WATTS: Display the power measurement function.
  • .SAVE: Save code to nonvolatile memory.
  • .SMUA: Displays source-measure and compliance screen for SMU A.
  • .UNLOCK: Lock out the EXIT (LOCAL) key.
  • .USER: Displays the user screen.
  • .WHEEL_ENTER: Represents pressing the navigation wheel.
  • .WHEEL_LEFT: Represents turning the Navigation wheel left.
  • .WHEEL_RIGHT: Represents turning the Navigation wheel right.
Properties and methods
  • .getlastkey(): The display.getlastkey() function.
  • .screen: The display.screen attribute.
  • .sendkey(): The display.sendkey() function.
  • .smu: The display.smuX command tree.
  • .trigger: The display.trigger command tree.
  • .waitkey(): The display.waitkey() function.

ANNUNCIATOR_4_WIRE class-attribute instance-attribute 

ANNUNCIATOR_4_WIRE = 'display.ANNUNCIATOR_4_WIRE'

ANNUNCIATOR_ARM class-attribute instance-attribute 

ANNUNCIATOR_ARM = 'display.ANNUNCIATOR_ARM'

ANNUNCIATOR_AUTO class-attribute instance-attribute 

ANNUNCIATOR_AUTO = 'display.ANNUNCIATOR_AUTO'

ANNUNCIATOR_EDIT class-attribute instance-attribute 

ANNUNCIATOR_EDIT = 'display.ANNUNCIATOR_EDIT'

ANNUNCIATOR_ERROR class-attribute instance-attribute 

ANNUNCIATOR_ERROR = 'display.ANNUNCIATOR_ERROR'

ANNUNCIATOR_FILTER class-attribute instance-attribute 

ANNUNCIATOR_FILTER = 'display.ANNUNCIATOR_FILTER'

ANNUNCIATOR_LISTEN class-attribute instance-attribute 

ANNUNCIATOR_LISTEN = 'display.ANNUNCIATOR_LISTEN'

ANNUNCIATOR_MATH class-attribute instance-attribute 

ANNUNCIATOR_MATH = 'display.ANNUNCIATOR_MATH'

ANNUNCIATOR_REAR class-attribute instance-attribute 

ANNUNCIATOR_REAR = 'display.ANNUNCIATOR_REAR'

ANNUNCIATOR_REL class-attribute instance-attribute 

ANNUNCIATOR_REL = 'display.ANNUNCIATOR_REL'

ANNUNCIATOR_REMOTE class-attribute instance-attribute 

ANNUNCIATOR_REMOTE = 'display.ANNUNCIATOR_REMOTE'

ANNUNCIATOR_SAMPLE class-attribute instance-attribute 

ANNUNCIATOR_SAMPLE = 'display.ANNUNCIATOR_SAMPLE'

ANNUNCIATOR_SRQ class-attribute instance-attribute 

ANNUNCIATOR_SRQ = 'display.ANNUNCIATOR_SRQ'

ANNUNCIATOR_STAR class-attribute instance-attribute 

ANNUNCIATOR_STAR = 'display.ANNUNCIATOR_STAR'

ANNUNCIATOR_TALK class-attribute instance-attribute 

ANNUNCIATOR_TALK = 'display.ANNUNCIATOR_TALK'

ANNUNCIATOR_TRIGGER class-attribute instance-attribute 

ANNUNCIATOR_TRIGGER = 'display.ANNUNCIATOR_TRIGGER'

DIGITS_4_5 class-attribute instance-attribute 

DIGITS_4_5 = 'display.DIGITS_4_5'

DIGITS_5_5 class-attribute instance-attribute 

DIGITS_5_5 = 'display.DIGITS_5_5'

DIGITS_6_5 class-attribute instance-attribute 

DIGITS_6_5 = 'display.DIGITS_6_5'

DISABLE class-attribute instance-attribute 

DISABLE = 'display.DISABLE'

DONT_SAVE class-attribute instance-attribute 

DONT_SAVE = 'display.DONT_SAVE'

ENABLE class-attribute instance-attribute 

ENABLE = 'display.ENABLE'

KEY_AUTO class-attribute instance-attribute 

KEY_AUTO = 'display.KEY_AUTO'

KEY_CONFIG class-attribute instance-attribute 

KEY_CONFIG = 'display.KEY_CONFIG'

KEY_DIGITSA class-attribute instance-attribute 

KEY_DIGITSA = 'display.KEY_DIGITSA'

For two-channel products, this is the DIGITS key for Channel A.

KEY_DISPLAY class-attribute instance-attribute 

KEY_DISPLAY = 'display.KEY_DISPLAY'

KEY_ENTER class-attribute instance-attribute 

KEY_ENTER = 'display.KEY_ENTER'

KEY_EXIT class-attribute instance-attribute 

KEY_EXIT = 'display.KEY_EXIT'

KEY_FILTERA class-attribute instance-attribute 

KEY_FILTERA = 'display.KEY_FILTERA'

For two-channel products, this is the FILTER key for Channel A.

KEY_LEFT class-attribute instance-attribute 

KEY_LEFT = 'display.KEY_LEFT'

KEY_LIMITA class-attribute instance-attribute 

KEY_LIMITA = 'display.KEY_LIMITA'

For two-channel products, this is the LIMIT key for Channel A.

KEY_LOAD class-attribute instance-attribute 

KEY_LOAD = 'display.KEY_LOAD'

KEY_MEASA class-attribute instance-attribute 

KEY_MEASA = 'display.KEY_MEASA'

For two-channel products, this is the MEAS key for Channel A.

KEY_MENU class-attribute instance-attribute 

KEY_MENU = 'display.KEY_MENU'

KEY_MODEA class-attribute instance-attribute 

KEY_MODEA = 'display.KEY_MODEA'

For two-channel products, this is the MODE key for Channel A.

KEY_NONE class-attribute instance-attribute 

KEY_NONE = 'display.KEY_NONE'

KEY_OUTPUTA class-attribute instance-attribute 

KEY_OUTPUTA = 'display.KEY_OUTPUTA'

For two-channel products, this is the OUTPUT ON/OFF key for Channel A.

KEY_RANGEDOWN class-attribute instance-attribute 

KEY_RANGEDOWN = 'display.KEY_RANGEDOWN'

KEY_RANGEUP class-attribute instance-attribute 

KEY_RANGEUP = 'display.KEY_RANGEUP'

KEY_RECALL class-attribute instance-attribute 

KEY_RECALL = 'display.KEY_RECALL'

KEY_RELA class-attribute instance-attribute 

KEY_RELA = 'display.KEY_RELA'

For two-channel products, this is the REL key for Channel A.

KEY_RIGHT class-attribute instance-attribute 

KEY_RIGHT = 'display.KEY_RIGHT'

KEY_RUN class-attribute instance-attribute 

KEY_RUN = 'display.KEY_RUN'

KEY_SPEEDA class-attribute instance-attribute 

KEY_SPEEDA = 'display.KEY_SPEEDA'

For two-channel products, this is the SPEED key for Channel A.

KEY_SRCA class-attribute instance-attribute 

KEY_SRCA = 'display.KEY_SRCA'

For two-channel products, this is the SRC key for Channel A.

KEY_STORE class-attribute instance-attribute 

KEY_STORE = 'display.KEY_STORE'

KEY_TRIG class-attribute instance-attribute 

KEY_TRIG = 'display.KEY_TRIG'

LIMIT_IV class-attribute instance-attribute 

LIMIT_IV = 'display.LIMIT_IV'

LIMIT_P class-attribute instance-attribute 

LIMIT_P = 'display.LIMIT_P'

LOCK class-attribute instance-attribute 

LOCK = 'display.LOCK'

MEASURE_DCAMPS class-attribute instance-attribute 

MEASURE_DCAMPS = 'display.MEASURE_DCAMPS'

MEASURE_DCVOLTS class-attribute instance-attribute 

MEASURE_DCVOLTS = 'display.MEASURE_DCVOLTS'

MEASURE_OHMS class-attribute instance-attribute 

MEASURE_OHMS = 'display.MEASURE_OHMS'

MEASURE_WATTS class-attribute instance-attribute 

MEASURE_WATTS = 'display.MEASURE_WATTS'

SAVE class-attribute instance-attribute 

SAVE = 'display.SAVE'

SMUA class-attribute instance-attribute 

SMUA = 'display.SMUA'

UNLOCK class-attribute instance-attribute 

UNLOCK = 'display.UNLOCK'

USER class-attribute instance-attribute 

USER = 'display.USER'

WHEEL_ENTER class-attribute instance-attribute 

WHEEL_ENTER = 'display.WHEEL_ENTER'

WHEEL_LEFT class-attribute instance-attribute 

WHEEL_LEFT = 'display.WHEEL_LEFT'

WHEEL_RIGHT class-attribute instance-attribute 

WHEEL_RIGHT = 'display.WHEEL_RIGHT'

screen property writable 

screen: str

Access the display.screen attribute.

Description
  • This attribute contains the selected display screen.
Usage
  • Accessing this property will send the print(display.screen) query.
  • Setting this property to a value will send the display.screen = value command.
TSP Syntax 
- display.screen = value
- print(display.screen)
Raises:

smu property 

smu: dict[str, DisplaySmuxItem]

Return the display.smuX command tree.

Sub-properties and sub-methods
  • .digits: The display.smuX.digits attribute.
  • .limit: The display.smuX.limit command tree.
  • .measure: The display.smuX.measure command tree.

trigger property 

trigger: DisplayTrigger

Return the display.trigger command tree.

Constants
  • .EVENT_ID: Selects the event that causes a trigger to be asserted on the digital output line when the TRIG key on the front panel is pressed.

getlastkey 

getlastkey() -> str

Run the display.getlastkey() function.

Description
  • This function retrieves the key code for the last pressed key.
TSP Syntax 
- display.getlastkey()
Returns:
  • str –

    The result of the function call.
Raises:

sendkey 

sendkey(key_code: str) -> None

Run the display.sendkey() function.

Description
  • This function sends a code that simulates the action of a front-panel control.
TSP Syntax 
- display.sendkey()
Parameters:
  • key_code (str) –

    A parameter that specifies the key press to simulate; see Details for more information.
Raises:

waitkey 

waitkey() -> str

Run the display.waitkey() function.

Description
  • This function captures the key code value for the next front-panel action.
TSP Syntax 
- display.waitkey()
Returns:
  • str –

    The result of the function call.
Raises:

DisplaySmuxItem

Bases: ValidatedChannel, BaseTSPCmd

The display.smuX command tree.

Properties and methods
  • .digits: The display.smuX.digits attribute.
  • .limit: The display.smuX.limit command tree.
  • .measure: The display.smuX.measure command tree.

digits property writable 

digits: str

Access the display.smuX.digits attribute.

Description
  • This attribute sets the front-panel display resolution of the selected measurement.
Usage
  • Accessing this property will send the print(display.smuX.digits) query.
  • Setting this property to a value will send the display.smuX.digits = value command.
TSP Syntax 
- display.smuX.digits = value
- print(display.smuX.digits)
Raises:

limit property 

limit: DisplaySmuxItemLimit

Return the display.smuX.limit command tree.

Sub-properties and sub-methods
  • .func: The display.smuX.limit.func attribute.

measure property 

measure: DisplaySmuxItemMeasure

Return the display.smuX.measure command tree.

Sub-properties and sub-methods
  • .func: The display.smuX.measure.func attribute.

DisplaySmuxItemLimit

Bases: BaseTSPCmd

The display.smuX.limit command tree.

Properties and methods
  • .func: The display.smuX.limit.func attribute.

func property writable 

func: str

Access the display.smuX.limit.func attribute.

Description
  • This attribute specifies the type of limit value setting displayed for the SMU.
Usage
  • Accessing this property will send the print(display.smuX.limit.func) query.
  • Setting this property to a value will send the display.smuX.limit.func = value command.
TSP Syntax 
- display.smuX.limit.func = value
- print(display.smuX.limit.func)
Raises:

DisplaySmuxItemMeasure

Bases: BaseTSPCmd

The display.smuX.measure command tree.

Properties and methods
  • .func: The display.smuX.measure.func attribute.

func property writable 

func: str

Access the display.smuX.measure.func attribute.

Description
  • This attribute specifies the type of measurement that is being displayed.
Usage
  • Accessing this property will send the print(display.smuX.measure.func) query.
  • Setting this property to a value will send the display.smuX.measure.func = value command.
TSP Syntax 
- display.smuX.measure.func = value
- print(display.smuX.measure.func)
Raises:

DisplayTrigger

Bases: BaseTSPCmd

The display.trigger command tree.

Constants
  • .EVENT_ID: Selects the event that causes a trigger to be asserted on the digital output line when the TRIG key on the front panel is pressed.

EVENT_ID class-attribute instance-attribute 

EVENT_ID = 'display.trigger.EVENT_ID'