[python source code]

display

The display commands module.

These commands are used in the following models: SS3706A

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.prompt()
- display.screen
- display.sendkey()
- display.setcursor()
- display.settext()
- display.waitkey()

Display

Bases: BaseTSPCmd

The display command tree.

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.
  • .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.
  • .trigger: The display.trigger command tree.
  • .waitkey(): The display.waitkey() function.

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 virtualfront 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:

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:

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.

clear 

clear() -> None

Run the display.clear() function.

Description
  • This function clears the text from the front-panel USER swipe screen.
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 virtualfront-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 virtualfront 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 virtualfront-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 virtualfront-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(button_id: str, prompt_text: str) -> None

Run the display.prompt() function.

Description
  • This function allows you to create an interactive dialog prompt that displays a custom message on the front-panel display.
TSP Syntax 
- display.prompt()
Parameters:
  • button_id (str) –

    The type of prompt to display; choose one of the following options.

  • prompt_text (str) –

    A string that contains the text that is displayed above the prompts.
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(user_display_text1: str | None = None, user_display_text2: str | None = None) -> None

Run the display.settext() function.

Description
  • This function defines the text that is displayed on the front-panel USER swipe screen.
TSP Syntax 
- display.settext()
Parameters:
  • user_display_text1 (optional, default: None ) –

    String that contains the message for the top line of the USER swipe screen (up to 20 characters).

  • user_display_text2 (optional, default: None ) –

    String that contains the message for the bottom line of the USER swipe screen (up to 32 characters).
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 TESTS 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 TESTS menu.

  • code (str) –

    The code that is run from the USER TESTS 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 TESTS 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 TESTS menu.
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.

EVENT_ID class-attribute instance-attribute 

EVENT_ID = 'display.trigger.EVENT_ID'