Command Usage; Command Details; Example Section - Keithley 2657A Reference Manual

Section 7: TSP command reference

Command usage

The Usage section of the remote command listing shows how to properly structure the command.
Each line in the Usage section is a separate variation of the command usage; all possible command
usage options are shown here.
1
Structure of command usage
User-defined
2
parameter
1. Structure of command usage: Shows how the parts of the command should be organized.
2. User-supplied parameters: Indicated by italics. For example, for the function
beeper.beep(duration, frequency), replace duration with the number of seconds and
frequency with the frequency of the tone. For example, beeper.beep(2, 2400) generates a
two-second, 2400 Hz tone.
If there are optional parameters, they must be entered in the order presented in the Usage section.
You cannot leave out any parameters that precede the optional parameter. Optional parameters are
shown as separate lines in usage, showing each permutation of the command. For example:
text = display.gettext()
text = display.gettext(embellished)
text = display.gettext(embellished, row)
text = display.gettext(embellished, row, columnStart)
text = display.gettext(embellished, row, columnStart, columnEnd)
3. Parameter value options: Descriptions of the options that are available for the user-defined
parameter.

Command details

This section lists additional information you need to know to successfully use the remote commands.
Details

Example section

The Example section of the remote command description shows some simple examples of how the
command can be used.
7-6
Model 2657A High Power System SourceMeter® Instrument Reference Manual
Figure 105: Command usage section
Usage
state = beeper.enable
beeper.enable = state
state
Figure 106: Details section of command listing
This command enables or disables the beeper. When enabled, a beep signals that a front-panel key has been
pressed. Disabling the beeper also disables front-panel key clicks.
Disable the beeper (beeper.OFF or 0)
Enable the beeper (beeper.ON or 1)
NOTE
3
Parameter value options
2657A-901-01 Rev. B/December 2012