[python source code]

display

The display commands module.

These commands are used in the following models: SMU2604B, SMU2614B, SMU2634B

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

Please report an issue if one is found.

Attributes and Functions 
- display.clear()
- display.getannunciators()
- display.getcursor()
- display.getlastkey()
- display.gettext()
- display.inputvalue()
- display.loadmenu.add()
- display.loadmenu.delete()
- display.locallockout
- display.menu()
- display.numpad
- display.prompt()
- display.screen
- display.sendkey()
- display.setcursor()
- display.settext()
- display.smuX.digits
- display.smuX.limit.func
- display.smuX.measure.func
- display.trigger.clear()
- display.trigger.overrun
- display.trigger.wait()
- 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_DIGITSB: Represents the DIGITS (display resolution) key for Channel B.
  • .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_FILTERB: Represents the FILTER key for Channel B.
  • .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_LIMITB: Represents the LIMIT key. For two-channel products, this is the LIMIT key for Channel B.
  • .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_MEASB: Represents the MEAS (Measure) key for Channel B.
  • .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_MODEB: Represents the MODE (meter mode) key for Channel B.
  • .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_OUTPUTB: Represents the OUTPUT ON/OFF key. For two-channel products, this is the OUTPUT ON/OFF key for Channel B.
  • .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_RELB: Represents the REL key for Channel B.
  • .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_SPEEDB: Represents the SPEED key. For two-channel products, this is the SPEED key for Channel B.
  • .KEY_SRCA: Represents the SRC (Source) key. For two-channel products, this is the SRC key for Channel A.
  • .KEY_SRCB: Represents the SRC (Source) key for Channel B.
  • .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_SMUB: Displays source-measure screen for SMU A and SMU B.
  • .SMUB: Displays source-measure and compliance screen for SMU B.
  • .UNLOCK: Lock out the EXIT (LOCAL) key.
  • .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
  • .clear(): The display.clear() function.
  • .getannunciators(): The display.getannunciators() function.
  • .getcursor(): The display.getcursor() function.
  • .getlastkey(): The display.getlastkey() function.
  • .gettext(): The display.gettext() function.
  • .inputvalue(): The display.inputvalue() function.
  • .loadmenu: The display.loadmenu command tree.
  • .locallockout: The display.locallockout attribute.
  • .menu(): The display.menu() function.
  • .numpad: The display.numpad attribute.
  • .prompt(): The display.prompt() function.
  • .screen: The display.screen attribute.
  • .sendkey(): The display.sendkey() function.
  • .setcursor(): The display.setcursor() function.
  • .settext(): The display.settext() 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_DIGITSB class-attribute instance-attribute 

KEY_DIGITSB = 'display.KEY_DIGITSB'

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_FILTERB class-attribute instance-attribute 

KEY_FILTERB = 'display.KEY_FILTERB'

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_LIMITB class-attribute instance-attribute 

KEY_LIMITB = 'display.KEY_LIMITB'

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

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_MEASB class-attribute instance-attribute 

KEY_MEASB = 'display.KEY_MEASB'

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_MODEB class-attribute instance-attribute 

KEY_MODEB = 'display.KEY_MODEB'

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_OUTPUTB class-attribute instance-attribute 

KEY_OUTPUTB = 'display.KEY_OUTPUTB'

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

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_RELB class-attribute instance-attribute 

KEY_RELB = 'display.KEY_RELB'

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_SPEEDB class-attribute instance-attribute 

KEY_SPEEDB = 'display.KEY_SPEEDB'

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

KEY_SRCA class-attribute instance-attribute 

KEY_SRCA = 'display.KEY_SRCA'

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

KEY_SRCB class-attribute instance-attribute 

KEY_SRCB = 'display.KEY_SRCB'

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_SMUB class-attribute instance-attribute 

SMUA_SMUB = 'display.SMUA_SMUB'

SMUB class-attribute instance-attribute 

SMUB = 'display.SMUB'

UNLOCK class-attribute instance-attribute 

UNLOCK = 'display.UNLOCK'

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'

loadmenu property 

loadmenu: DisplayLoadmenu

Return the display.loadmenu command tree.

Sub-properties and sub-methods
  • .add(): The display.loadmenu.add() function.
  • .delete(): The display.loadmenu.delete() function.

locallockout property writable 

locallockout: str

Access the display.locallockout attribute.

Description
  • This attribute describes whether or not the EXIT (LOCAL) key on the instrument front panel is enabled.
Usage
  • Accessing this property will send the print(display.locallockout) query.
  • Setting this property to a value will send the display.locallockout = value command.
TSP Syntax 
- display.locallockout = value
- print(display.locallockout)
Info
  • lockout, the 0 or display.UNLOCK: Unlocks EXIT (LOCAL) key 1 or display.LOCK: Locks out EXIT (LOCAL) key.
Raises:

numpad property writable 

numpad: str

Access the display.numpad attribute.

Description
  • This attribute controls whether the front panel keys act as a numeric keypad during value entry.
Usage
  • Accessing this property will send the print(display.numpad) query.
  • Setting this property to a value will send the display.numpad = value command.
TSP Syntax 
- display.numpad = value
- print(display.numpad)
Raises:

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.

Info
  • X, the source-measure unit (SMU) channel (for example, display.smua.digits applies to SMU channel A).
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: The event ID of the event generated when the front-panel TRIG key is pressed.
Sub-properties and sub-methods
  • .clear(): The display.trigger.clear() function.
  • .overrun: The display.trigger.overrun attribute.
  • .wait(): The display.trigger.wait() function.

clear 

clear() -> None

Run the display.clear() function.

Description
  • This function clears all lines of the front-panel display.
TSP Syntax 
- display.clear()
Raises:

getannunciators 

getannunciators() -> str

Run the display.getannunciators() function.

Description
  • This function reads the annunciators (indicators) that are presently turned on.
TSP Syntax 
- display.getannunciators()
Returns:
  • str –

    The result of the function call.
Raises:

getcursor 

getcursor() -> str

Run the display.getcursor() function.

Description
  • This function reads the present position of the cursor on the front-panel display.
TSP Syntax 
- display.getcursor()
Returns:
  • str –

    The result of the function call.
Raises:

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:

gettext 

gettext(
    embellished: str | None = None,
    row: str | None = None,
    column_start: str | None = None,
    column_end: int | None = None,
) -> str

Run the display.gettext() function.

Description
  • This function reads the text displayed on the front panel.
TSP Syntax 
- display.gettext()
Parameters:
  • embellished (optional, default: None ) –

    Indicates type of returned text.

  • row (optional, default: None ) –

    Selects the row from which to read the text.

  • column_start (optional, default: None ) –

    Selects the first column from which to read text; for row 1, the valid column numbers are 1 to 20; for row 2, the valid column numbers are 1 to 32; if nothing is selected, 1 is used.

  • column_end (optional, default: None ) –

    Selects the last column from which to read text; for row 1, the valid column numbers are 1 to 20; for row 2, the valid column numbers are 1 to 32; the default is 20 for row 1, and 32 for row 2.
Returns:
  • str –

    The result of the function call.
Raises:

inputvalue 

inputvalue(
    format_: str, default: str | None = None, minimum: str | None = None, maximum: str | None = None
) -> None

Run the display.inputvalue() function.

Description
  • This function displays a formatted input field on the front-panel display that the operator can edit.
TSP Syntax 
- display.inputvalue()
Parameters:
  • format_ (str) –

    A string that defines how the input field is formatted; see Details for more information.

  • default (optional, default: None ) –

    The default value for the input value.

  • minimum (optional, default: None ) –

    The minimum input value.

  • maximum (optional, default: None ) –

    The maximum input value.
Raises:

menu 

menu(name: str, items: str) -> str

Run the display.menu() function.

Description
  • This function presents a menu on the front-panel display.
TSP Syntax 
- display.menu()
Parameters:
  • name (str) –

    Menu name to display on the top line.

  • items (str) –

    Menu items to display on the bottom line.
Returns:
  • str –

    The result of the function call.
Raises:

prompt 

prompt(
    format_: str,
    units: str,
    help_: str,
    default: str | None = None,
    minimum: str | None = None,
    maximum: str | None = None,
) -> None

Run the display.prompt() function.

Description
  • This function prompts the user to enter a parameter from the front panel of the instrument.
TSP Syntax 
- display.prompt()
Parameters:
  • format_ (str) –

    A string that defines how the input field is formatted; see Details for more information.

  • units (str) –

    Set the units text string for the top line (eight characters maximum); this indicates the units (for example, ‘V’ or ‘A’) for the value.

  • help_ (str) –

    Text string to display on the bottom line (32 characters maximum).

  • default (optional, default: None ) –

    The value that is shown when the value is first displayed.

  • minimum (optional, default: None ) –

    The minimum input value that can be entered.

  • maximum (optional, default: None ) –

    The maximum input value that can be entered (must be more than minimum).
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:

setcursor 

setcursor(row: str, column: str, style: str | None = None) -> None

Run the display.setcursor() function.

Description
  • This function sets the position of the cursor.
TSP Syntax 
- display.setcursor()
Parameters:
  • row (str) –

    The row number for the cursor (1 or 2).

  • column (str) –

    The active column position to set; row 1 has columns 1 to 20, row 2 has columns 1 to 32.

  • style (optional, default: None ) –

    Set the cursor to invisible (0, default) or blinking (1).
Raises:

settext 

settext(text: str) -> None

Run the display.settext() function.

Description
  • This function displays text on the front-panel user screen.
TSP Syntax 
- display.settext()
Parameters:
  • text (str) –

    Text message to be displayed, with optional character codes.
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:

DisplayLoadmenu

Bases: BaseTSPCmd

The display.loadmenu command tree.

Properties and methods
  • .add(): The display.loadmenu.add() function.
  • .delete(): The display.loadmenu.delete() function.

add 

add(display_name: str, code: str, memory: str | None = None) -> None

Run the display.loadmenu.add() function.

Description
  • This function adds an entry to the USER menu, which can be accessed by pressing the LOAD key on the front panel.
TSP Syntax 
- display.loadmenu.add()
Parameters:
  • display_name (str) –

    The name that is added to the USER menu.

  • code (str) –

    The code that is run from the USER menu.

  • memory (optional, default: None ) –

    Determines if code is saved to nonvolatile memory.
Raises:

delete 

delete(display_name: str) -> None

Run the display.loadmenu.delete() function.

Description
  • This function removes an entry from the USER menu, which can be accessed using the LOAD key on the front panel.
TSP Syntax 
- display.loadmenu.delete()
Parameters:
  • display_name (str) –

    The name to be deleted from the USER menu.
Raises:

DisplaySmuxItem

Bases: ValidatedChannel, BaseTSPCmd

The display.smuX command tree.

Info
  • X, the source-measure unit (SMU) channel (for example, display.smua.digits applies to SMU channel A).
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)
Info
  • X, the source-measure unit (SMU) channel (for example, display.smua.digits applies to SMU channel A).
Raises:

limit property 

limit: DisplaySmuxItemLimit

Return the display.smuX.limit command tree.

Info
  • X, the source-measure unit (SMU) channel (for example, display.smua.limit.func applies to SMU channel A).
Sub-properties and sub-methods
  • .func: The display.smuX.limit.func attribute.

measure property 

measure: DisplaySmuxItemMeasure

Return the display.smuX.measure command tree.

Info
  • X, the source-measure unit (SMU) channel (for example, display.smua.measure.func applies to SMU channel A).
Sub-properties and sub-methods
  • .func: The display.smuX.measure.func attribute.

DisplaySmuxItemLimit

Bases: BaseTSPCmd

The display.smuX.limit command tree.

Info
  • X, the source-measure unit (SMU) channel (for example, display.smua.limit.func applies to SMU channel A).
Properties and methods
  • .func: The display.smuX.limit.func attribute.

func property writable 

func: str

Access the display.smuX.limit.func attribute.

Description
  • If you are using a display mode that shows a single channel, this attribute specifies the type of limit value setting displayed.
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)
Info
  • X, the source-measure unit (SMU) channel (for example, display.smua.limit.func applies to SMU channel A).
Raises:

DisplaySmuxItemMeasure

Bases: BaseTSPCmd

The display.smuX.measure command tree.

Info
  • X, the source-measure unit (SMU) channel (for example, display.smua.measure.func applies to SMU channel A).
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)
Info
  • X, the source-measure unit (SMU) channel (for example, display.smua.measure.func applies to SMU channel A).
Raises:

DisplayTrigger

Bases: BaseTSPCmd

The display.trigger command tree.

Constants
  • .EVENT_ID: The event ID of the event generated when the front-panel TRIG key is pressed.
Properties and methods
  • .clear(): The display.trigger.clear() function.
  • .overrun: The display.trigger.overrun attribute.
  • .wait(): The display.trigger.wait() function.

EVENT_ID class-attribute instance-attribute 

EVENT_ID = 'display.trigger.EVENT_ID'

overrun property 

overrun: str

Access the display.trigger.overrun attribute.

Description
  • This attribute contains the event detector overrun status.
Usage
  • Accessing this property will send the print(display.trigger.overrun) query.
TSP Syntax 
- print(display.trigger.overrun)
Raises:

clear 

clear() -> None

Run the display.trigger.clear() function.

Description
  • This function clears the front-panel trigger event detector.
TSP Syntax 
- display.trigger.clear()
Raises:

wait 

wait(timeout: float) -> str

Run the display.trigger.wait() function.

Description
  • This function waits for the TRIG key on the front panel to be pressed.
TSP Syntax 
- display.trigger.wait()
Parameters:
  • timeout (float) –

    Timeout in seconds.
Returns:
  • str –

    The result of the function call.
Raises: