2600AS-901-01 Rev. B / September 2008 Return to Section Topics 19-41
Series 2600A System SourceMeter® Instruments Reference Manual Section 19: Remote Commands
display.gettext
Function Reads the text presently displayed.
TSP-Link
accessibility
This function can be accessed from a remote TSP-Link node.
Usage There are five ways to use this function:
text = display.gettext()
text = display.gettext(embellished)
text = display.gettext(embellished, row)
text = display.gettext(embellished, row, column_start)
text = display.gettext(embellished, row, column_start, column_end)
embellished Set to false to return text as a simple character
string. Set to true to include all character codes.
row Set to 1 or 2 to select which row to read text. If not
included, text from both rows are read.
column_start Set to starting column for reading text. Default is 1.
column_end Set to ending column for reading text. Default is 20
(Row 1) or 32 (Row 2).
Remarks • The range of valid column numbers depends on which row is specified. For Row 1, valid
column numbers are 1 to 20. For Row 2, valid column numbers are 1 to 32.
• Sending the command without any parameters returns both lines of the display. The $N
character code will be included to show where the top line ends and the bottom line begins.
•With embellished set to true, all other character codes will be returned along with the
message. With embellished set to false, only the message and the $N character code will be
returned. See the
display.settext function for details on the character codes.
• The display will not be switched to the user screen. Text will be read from the active screen.
Details See Displaying text messages in Section 11.
Also see display.getcursor, display.setcursor, display.settext
Example Returns all text in both lines of the display:
text = display.gettext()
print(text)
Output: User Screen $N
The above output indicates that the message “User Screen” is on the top line. The bottom line is
blank.
To Next Page
Loading...
Need help?
General
