[python source code]

display

The display commands module.

These commands are used in the following models: DMM7510

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

Please report an issue if one is found.

Attributes and Functions 
- display.activebuffer
- display.changescreen()
- display.clear()
- display.delete()
- display.input.number()
- display.input.option()
- display.input.prompt()
- display.input.string()
- display.lightstate
- display.prompt()
- display.readingformat
- display.settext()
- display.waitevent()

Display

Bases: BaseTSPCmd

The display command tree.

Constants
  • .BUTTONS_CANCEL: Display CANCEL on dialog.
  • .BUTTONS_NONE: Display nothing on dialog.
  • .BUTTONS_OK: Display OK on dialog.
  • .BUTTONS_OKCANCEL: Display OK and CANCEL on dialog.
  • .BUTTONS_YESNO: Display YES and NO on dialog.
  • .BUTTONS_YESNOCANCEL: Display YES, NO, and CANCEL on dialog.
  • .BUTTON_CANCEL: Return if CANCEL selected.
  • .BUTTON_NO: Return if NO selected.
  • .BUTTON_OK: Return if OK selected.
  • .BUTTON_YES: Return if YES selected.
  • .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.
  • .FORMAT_EXPONENT: Use exponent format to display measurement readings on the front-panel display of the instrument.
  • .FORMAT_PREFIX: Add a prefix to the units symbol, such as k, m, or u, to display measurement readings on the front-panel display of the instrument.
  • .NFORMAT_DECIMAL: Allow decimal values.
  • .NFORMAT_EXPONENT: Display numbers in exponent format.
  • .NFORMAT_INTEGER: Allow integers (negative or positive) only.
  • .NFORMAT_PREFIX: Display numbers with prefixes before the units symbol, such as n, m, or u.
  • .SCREEN_GRAPH: Display the last selected graph screen tab.
  • .SCREEN_GRAPH_SWIPE: Display graph swipe screen.
  • .SCREEN_HISTOGRAM: Display Histogram.
  • .SCREEN_HOME: Display Home screen.
  • .SCREEN_HOME_LARGE_READING: Display Home screen with large readings.
  • .SCREEN_PROCESSING: Open a screen that uses minimal CPU resources.
  • .SCREEN_READING_TABLE: Display Reading Table screen.
  • .SCREEN_SETTINGS_SWIPE: Display SETTINGS swipe screen.
  • .SCREEN_STATS_SWIPE: Display STATISTICS swipe screen.
  • .SCREEN_USER_SWIPE: Display USER swipe screen.
  • .SFORMAT_ANY: Allow any characters.
  • .SFORMAT_BUFFER_NAME: Allow both upper- and lower-case letters (no special characters).
  • .SFORMAT_UPPER: Allow only upper-case letters.
  • .SFORMAT_UPPER_LOWER: Allow both upper- and lower-case letters (no special characters).
  • .STATE_BLACKOUT: Set display and all indicators off.
  • .STATE_LCD_100: Set display to full brightness.
  • .STATE_LCD_25: Set display to 25% brightness.
  • .STATE_LCD_50: Set display to 50% brightness.
  • .STATE_LCD_75: Set display to 75% brightness.
  • .STATE_LCD_OFF: Set display to off.
Properties and methods
  • .activebuffer: The display.activebuffer attribute.
  • .changescreen(): The display.changescreen() function.
  • .clear(): The display.clear() function.
  • .delete(): The display.delete() function.
  • .input: The display.input command tree.
  • .lightstate: The display.lightstate attribute.
  • .prompt(): The display.prompt() function.
  • .readingformat: The display.readingformat attribute.
  • .settext(): The display.settext() function.
  • .waitevent(): The display.waitevent() function.

BUTTONS_CANCEL class-attribute instance-attribute 

BUTTONS_CANCEL = 'display.BUTTONS_CANCEL'

BUTTONS_NONE class-attribute instance-attribute 

BUTTONS_NONE = 'display.BUTTONS_NONE'

BUTTONS_OK class-attribute instance-attribute 

BUTTONS_OK = 'display.BUTTONS_OK'

BUTTONS_OKCANCEL class-attribute instance-attribute 

BUTTONS_OKCANCEL = 'display.BUTTONS_OKCANCEL'

BUTTONS_YESNO class-attribute instance-attribute 

BUTTONS_YESNO = 'display.BUTTONS_YESNO'

BUTTONS_YESNOCANCEL class-attribute instance-attribute 

BUTTONS_YESNOCANCEL = 'display.BUTTONS_YESNOCANCEL'

BUTTON_CANCEL class-attribute instance-attribute 

BUTTON_CANCEL = 'display.BUTTON_CANCEL'

BUTTON_NO class-attribute instance-attribute 

BUTTON_NO = 'display.BUTTON_NO'

BUTTON_OK class-attribute instance-attribute 

BUTTON_OK = 'display.BUTTON_OK'

BUTTON_YES class-attribute instance-attribute 

BUTTON_YES = 'display.BUTTON_YES'

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'

FORMAT_EXPONENT class-attribute instance-attribute 

FORMAT_EXPONENT = 'display.FORMAT_EXPONENT'

the instrument.

FORMAT_PREFIX class-attribute instance-attribute 

FORMAT_PREFIX = 'display.FORMAT_PREFIX'

the instrument.

NFORMAT_DECIMAL class-attribute instance-attribute 

NFORMAT_DECIMAL = 'display.NFORMAT_DECIMAL'

NFORMAT_EXPONENT class-attribute instance-attribute 

NFORMAT_EXPONENT = 'display.NFORMAT_EXPONENT'

NFORMAT_INTEGER class-attribute instance-attribute 

NFORMAT_INTEGER = 'display.NFORMAT_INTEGER'

NFORMAT_PREFIX class-attribute instance-attribute 

NFORMAT_PREFIX = 'display.NFORMAT_PREFIX'

SCREEN_GRAPH class-attribute instance-attribute 

SCREEN_GRAPH = 'display.SCREEN_GRAPH'

SCREEN_GRAPH_SWIPE class-attribute instance-attribute 

SCREEN_GRAPH_SWIPE = 'display.SCREEN_GRAPH_SWIPE'

SCREEN_HISTOGRAM class-attribute instance-attribute 

SCREEN_HISTOGRAM = 'display.SCREEN_HISTOGRAM'

SCREEN_HOME class-attribute instance-attribute 

SCREEN_HOME = 'display.SCREEN_HOME'

SCREEN_HOME_LARGE_READING class-attribute instance-attribute 

SCREEN_HOME_LARGE_READING = 'display.SCREEN_HOME_LARGE_READING'

SCREEN_PROCESSING class-attribute instance-attribute 

SCREEN_PROCESSING = 'display.SCREEN_PROCESSING'

SCREEN_READING_TABLE class-attribute instance-attribute 

SCREEN_READING_TABLE = 'display.SCREEN_READING_TABLE'

SCREEN_SETTINGS_SWIPE class-attribute instance-attribute 

SCREEN_SETTINGS_SWIPE = 'display.SCREEN_SETTINGS_SWIPE'

SCREEN_STATS_SWIPE class-attribute instance-attribute 

SCREEN_STATS_SWIPE = 'display.SCREEN_STATS_SWIPE'

SCREEN_USER_SWIPE class-attribute instance-attribute 

SCREEN_USER_SWIPE = 'display.SCREEN_USER_SWIPE'

SFORMAT_ANY class-attribute instance-attribute 

SFORMAT_ANY = 'display.SFORMAT_ANY'

SFORMAT_BUFFER_NAME class-attribute instance-attribute 

SFORMAT_BUFFER_NAME = 'display.SFORMAT_BUFFER_NAME'

SFORMAT_UPPER class-attribute instance-attribute 

SFORMAT_UPPER = 'display.SFORMAT_UPPER'

SFORMAT_UPPER_LOWER class-attribute instance-attribute 

SFORMAT_UPPER_LOWER = 'display.SFORMAT_UPPER_LOWER'

STATE_BLACKOUT class-attribute instance-attribute 

STATE_BLACKOUT = 'display.STATE_BLACKOUT'

STATE_LCD_100 class-attribute instance-attribute 

STATE_LCD_100 = 'display.STATE_LCD_100'

STATE_LCD_25 class-attribute instance-attribute 

STATE_LCD_25 = 'display.STATE_LCD_25'

STATE_LCD_50 class-attribute instance-attribute 

STATE_LCD_50 = 'display.STATE_LCD_50'

STATE_LCD_75 class-attribute instance-attribute 

STATE_LCD_75 = 'display.STATE_LCD_75'

STATE_LCD_OFF class-attribute instance-attribute 

STATE_LCD_OFF = 'display.STATE_LCD_OFF'

activebuffer property writable 

activebuffer: str

Access the display.activebuffer attribute.

Description
  • This attribute determines which buffer is used for measurements that are displayed on the front panel.
Usage
  • Accessing this property will send the print(display.activebuffer) query.
  • Setting this property to a value will send the display.activebuffer = value command.
TSP Syntax 
- display.activebuffer = value
- print(display.activebuffer)
Raises:

input property 

input: DisplayInput

Return the display.input command tree.

Sub-properties and sub-methods
  • .number(): The display.input.number() function.
  • .option(): The display.input.option() function.
  • .prompt(): The display.input.prompt() function.
  • .string(): The display.input.string() function.

lightstate property writable 

lightstate: str

Access the display.lightstate attribute.

Description
  • This attribute sets the light output level of the front-panel display.
Usage
  • Accessing this property will send the print(display.lightstate) query.
  • Setting this property to a value will send the display.lightstate = value command.
TSP Syntax 
- display.lightstate = value
- print(display.lightstate)
Raises:

readingformat property writable 

readingformat: str

Access the display.readingformat attribute.

Description
  • This attribute determines the format that is used to display measurement readings on the front-panel display of the instrument.
Usage
  • Accessing this property will send the print(display.readingformat) query.
  • Setting this property to a value will send the display.readingformat = value command.
TSP Syntax 
- display.readingformat = value
- print(display.readingformat)
Info
  • format, the use exponent format: display.FORMAT_EXPONENT Add a prefix to the units symbol, such as k, m, or µ: display.FORMAT_PREFIX.
Raises:

changescreen 

changescreen(screen_name: str) -> None

Run the display.changescreen() function.

Description
  • This function changes which front-panel screen is displayed.
TSP Syntax 
- display.changescreen()
Parameters:
  • screen_name (str) –

    The screen to display.
Raises:

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:

delete 

delete(prompt_id: str) -> None

Run the display.delete() function.

Description
  • This function allows you to remove a prompt on the front-panel display that was created with display.prompt().
TSP Syntax 
- display.delete()
Parameters:
  • prompt_id (str) –

    The identifier defined by display.prompt().
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:

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:

waitevent 

waitevent(timeout: float | None = None) -> str

Run the display.waitevent() function.

Description
  • This function causes the instrument to wait for a user to respond to a prompt that was created with a prompt command.
TSP Syntax 
- display.waitevent()
Parameters:
  • timeout (optional, default: None ) –

    The amount of time to wait before timing out; time is 0 to 300 s, where the default of 0 waits indefinitely.
Returns:
  • str –

    The result of the function call.
Raises:

DisplayInput

Bases: BaseTSPCmd

The display.input command tree.

Properties and methods
  • .number(): The display.input.number() function.
  • .option(): The display.input.option() function.
  • .prompt(): The display.input.prompt() function.
  • .string(): The display.input.string() function.

number 

number(
    dialog_title: str,
    number_format: str | None = None,
    default_value: str | None = None,
    minimum_value: str | None = None,
    maximum_value: str | None = None,
) -> str

Run the display.input.number() function.

Description
  • This function allows you to create a prompt that requests a number from the user on the front-panel display.
TSP Syntax 
- display.input.number()
Parameters:
  • dialog_title (str) –

    A string that contains the text to be displayed as the title of the dialog box on the front-panel display; can be up to 32 characters.

  • number_format (optional, default: None ) –

    The format of the displayed number.

  • default_value (optional, default: None ) –

    The value that is initially displayed in the displayed keypad.

  • minimum_value (optional, default: None ) –

    The lowest value that can be entered.

  • maximum_value (optional, default: None ) –

    The highest value that can be entered.
Returns:
  • str –

    The result of the function call.
Raises:

option 

option(dialog_title: str, button_title1: str, button_title2: str) -> str

Run the display.input.option() function.

Description
  • This function allows you to create an option dialog box with customizable buttons on the front-panel display.
TSP Syntax 
- display.input.option()
Parameters:
  • dialog_title (str) –

    A string that contains the text to be displayed as the title of the dialog box on the front-panel display; up to 32 characters.

  • button_title1 (str) –

    A string that contains the name of the first button; up to 15 characters.

  • button_title2 (str) –

    A string that contains the name of the second button; up to 15 characters.
Returns:
  • str –

    The result of the function call.
Raises:

prompt 

prompt(button_set: str, dialog_title: str) -> str

Run the display.input.prompt() function.

Description
  • This function allows you to create a prompt that accepts a user response from the front-panel display.
TSP Syntax 
- display.input.prompt()
Parameters:
  • button_set (str) –

    The set of buttons to display.

  • dialog_title (str) –

    A string that contains the text to be displayed as the title of the dialog box on the front-panel display; up to 63 characters.
Returns:
  • str –

    The result of the function call.
Raises:

string 

string(dialog_title: str, text_format: str | None = None) -> str

Run the display.input.string() function.

Description
  • This function allows you to create a dialog box that requests text from the user through the front-panel display.
TSP Syntax 
- display.input.string()
Parameters:
  • dialog_title (str) –

    A string that contains the text to be displayed as the title of the dialog box on the front-panel display; up to 32 characters.

  • text_format (optional, default: None ) –

    The format of the entered text.
Returns:
  • str –

    The result of the function call.
Raises: