Keithley 2601 Reference Manual page 290

Section 12: Instrument Control Library
display.prompt
Function Prompts the user to enter a parameter from the front panel.
Usage There are four ways to use this function:
value = display.prompt(format, units, help)
value = display.prompt(format, units, help, default)
value = display.prompt(format, units, help, default, min)
value = display.prompt(format, units, help, default, min, max)
format
units
help
default
min
max
Remarks • This function will create an editable input field at the present cursor position, and an input
prompt message on the bottom line. Example of a displayed input field and prompt:
0.00V
Input 0 to +2V
• The format configures the editable input field. Four examples for the format:
+0.0000+00.0000E+000.00000E+0
• Value field:
• + Include a "+" sign for positive/negative value entry. Not including the "+"
sign prevents negative value entry.
• 0 Defines the digit positions for the value. Up to six 0 can be used for the
value (as shown above in the third and fourth examples).
• If used, include the decimal point (.) where needed for the value.
• Exponent field (optional):
• EInclude the "E" for exponent entry.
• + Include a "+" sign for positive/negative exponent entry. Not including the "+"
sign prevents negative exponent entry.
• 0 Defines the digit positions for the exponent.
• units is a string that indicates the units (e.g., "V" or "A") for the value and help provides
a message prompt on the bottom line.
• Along with specifying the format for the input field, there are options to specify minimum
and maximum limits for the input field. When NOT using the "+" sign for the value field,
the minimum limit cannot be set to less than zero. When using the "+" sign, the minimum
limit can set to less than zero (e.g., -2).
• There is also an option to specify a
initially displayed value for the field will be the default value.
• Message prompts to instruct the operator should be displayed prior to calling this
function. Make sure to position the cursor where the edit field should appear.
• The input value is limited to ±1e37.
• After sending this command, script execution holds and waits for the operator to enter a
value and press ENTER:
• If limits are used, the operator will not be able to input values outside the minimum and
maximum limits.
• For positive and negative entry ("+" sign used for the value field and/or the exponent
field), polarity of a non-zero value or exponent can be toggled by positioning the cursor
on the polarity sign and turning the wheel. Polarity will also toggle when using the wheel
to decrease or increase the value or exponent past zero. A zero value or exponent (e.g.
+00) is always positive and cannot be toggled to negative polarity.
• After sending this command and pressing the EXIT key, value will return nil.
Details See "Parameter value
Also see display.inputvalue
12-30
Series 2600 System SourceMeter® Instruments Reference Manual
Define format string for the input field using 0,
the decimal point (.), polarity sign (+) and 'E'
for exponent.
Set units text string for top line (8 characters
maximum).
Text string to display on the bottom line (32
characters maximum).
Set the default value for the parameter.
Set the minimum input value that can be set.
Set the maximum input value that can be set.
default
value. When this command is executed, the
prompting" in Section 14.
Return to Section Topics 2600S-901-01 Rev. C / January 2008