User manual

Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL)
3700S-901-01 Rev. C / July 2008 13-107
display.settext()
Remarks
This function selects the user display screen, and displays the given text. The first
write to the display after power-on will clear the user screen.
The text starts at the present cursor position. After the text is displayed, the cursor will
be located after the last character in the display message.
Top line text will not wrap to the bottom line of the display automatically. Any text that
does not fit on the current line will be truncated. If the text is truncated, the cursor will
be left at the end of the line.
The text remains on the display until replaced or cleared.
The following character codes can be also be included in the text string:
$N Newline: Starts text on the next line. If the cursor is already on line 2, text will
be ignored after the $N is received. $R Sets text to Normal.
$B: Sets text to blink.
$D: Sets text to dim intensity.
$F: Sets text to background blink.
$$: Escape sequence to display a single "$".
The display.clear (on page 13-93), display.setcursor (on page 13-105), and
display.settext functions are overlapped, non-blocking commands. That is, the
script will NOT wait for one of these commands to complete. These non-blocking
functions do not immediately update the display. For performance considerations, they
write to a shadow and will update the display as soon as processing time becomes
available.
Also see
display.clear() (on page 13-93)
display.getcursor() (on page 13-95)
display.gettext() (on page 13-97)
display.setcursor() (on page 13-105)
Example
Displays a message on the user screen:
To display "Message Test" on the top line and the bottom line displays the blinking
message "with Row 2 Blinking":
display.clear()
display.settext("Message Test $N$Bwith Row 2 Blinking")
To display the unit's serial number on the top line:
display.clear()
display.settext(localnode.serialno)
(see localnode.serialno (on page 13-214))
display.waitkey()
Function
Captures the key code value for the next key press.
Usage
key = display.waitkey()